Changes

Template:Networking rutos manual input output (view source)

Revision as of 09:00, 8 May 2024

7,809 bytes added , 8 May

no edit summary

Line 1: Line 1: −

{{Template: ~~Networking_rutos_manual_fw_disclosure~~

+

{{Template: Networking_device_manual_fw_disclosure

−

| fw_version ={{Template: ~~Networking_rutos_manual_latest_fw~~

+

| series = {{{series}}}

+

| name = {{{name}}}

+

| fw_version ={{Template: Networking_device_manual_latest_fw

| series = {{{series}}}

| name = {{{name}}}

}}

−

{{#ifeq: {{{series}}} | RUT9 | Note: [[{{{name}}} Input/Output (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: ~~Networking_rutos_manual_latest_fw~~ | series = RUT9XX}} and earlier) user manual page.

+

{{#ifeq: {{{series}}} | RUT9 | Note: [[{{{name}}} Input/Output (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.

−

Warning: From 7.0 version I/O parameters and controls have changed compared to {{Template: ~~Networking_rutos_manual_latest_fw~~ | series = RUT9XX}} and earlier legacy versions.|}}

+

Warning: From 7.0 version I/O parameters and controls have changed compared to {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier legacy versions.|}}

−

{{#ifeq: {{{series}}} | RUT2 | Note: [[{{{name}}} Input/Output (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: ~~Networking_rutos_manual_latest_fw~~ | series = RUT2XX}} and earlier) user manual page.

+

{{#ifeq: {{{series}}} | RUT2 | Note: [[{{{name}}} Input/Output (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.

−

Warning: From 7.1 version I/O parameters and controls have changed compared to {{Template: ~~Networking_rutos_manual_latest_fw~~ | series = RUT2XX}} and earlier legacy versions.|}}

+

Warning: From 7.1 version I/O parameters and controls have changed compared to {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier legacy versions.|}}

==Summary==

Line 54: Line 56:

<li>1W - 1-Wire protocol input/output.</li>

<li>⏚ - GND contact.</li>

−

<li>Note: input circuit components have tolerance of +-1%.</li>

+

<li>''Note:'' input circuit components have tolerance of +-1%.</li>

</ul>

−

| RUT955|RUT956 =<h3>Input/Output Connector Pinout</h3>

+

| RUT955|RUT956|RUT906 =<h3>Input/Output Connector Pinout</h3>

----

[[File:Networking_rut955_manual_input_output_input_output_connector_pinout_v3.png]]

Line 78: Line 80:

<li>⏚2 - GND for DI2.

<li>⏚3 - GND for DO pins.

+

<li>''Note:'' input circuit components have tolerance of +-1%.</li>

</ul>

----

Line 96: Line 99:

{{#switch: {{{name}}}

−

| TRB141 = [[File:~~Networking_trb141_manual_input_output_status~~.png|border|class=tlt-border]]

+

| TRB141 = [[File:Networking_trb141_manual_input_output_status_v4.png|border|class=tlt-border]]

−

| ~~RUT950~~ = [[File:~~Networking_RUT950_manual_input_output_status~~.png|border|class=tlt-border]]

+

−

| ~~RUT955~~|~~RUT956~~ = [[File:~~Networking_RUT955_manual_input_output_status~~.png|border|class=tlt-border]]

+

| TRB245|TRB246|TRB255|TRB256 = [[File:Networking_trb2_manual_input_output_status_v3.png|border|class=tlt-border]]

| [[File:Networking_{{lc:{{{series}}}}}_manual_input_output_status.png|border|class=tlt-border]]

}}

You can invert an Input pin by clicking the on/off slider under the "Inversion" column or switch the state of an Output pin by clicking the on/off slider under the "State" column.

+

{{#switch: {{{name}}}

+

| TRB141 = '''Note:''' When dry/wet input is not connected to anything - the state of level is undetermined.

+

| #default =}}

+

{{#switch: {{{name}}}

+

| RUT955|RUT956|RUT906|TRB245|TRB246|TRB255|TRB141|TRB256 =

+

'''Note:''' You can edit the adc/acl formula to customize values.

+

Custom I/O status labels for "Analog input":

+

[[File:Networking_manual_input_output_status_formula_adc0.png|border|class=tlt-border]]

+

Custom I/O status labels for "Analog current loop":

+

[[File:Networking_manual_input_output_status_formula_acl0.png|border|class=tlt-border]]

+

| #default =

+

}}

===Status from command line===

Line 114: Line 132:

}}

| #default = {{Template:Networking_{{lc:{{{series}}}}}_manual_input_output_status|name={{{name}}}}}

+

}}

+

{{#switch: {{{name}}}

+

| RUT300|RUT301|RUT360|TRB245|TRB246|TRB255|TRB140|TRB141|TRB142|TRB143|TRB145|TRB256 = '''Note:''' Changes of configurable pin type from output to input (and reverse) could causes the issues where the specific type was set in configurations. Make sure that configurations do not contradict one another.

+

| #default =

}}

Line 120: Line 143:

Enabling Post/Get provides the possibility to control the state of an output via HTTP POST/GET requests. The figure below is an example of the Auth Settings section of the Post/Get page. It is used to turn Post/Get requests on or off and to set authentication parameters.

−

[[File:~~Networking_rutos_manual_input_output_post_get_auth_settings_v2~~.png|border|class=tlt-border]]

+

[[File:Networking_rutos_manual_input_output_post_get_auth_settings_v3.png|border|class=tlt-border]]

Line 130: Line 153:

<tr>

<td>Enable</td>

−

<td>off | on; default: off</td>

+

<td>off {{!}} on; default: off</td>

<td>Turns Post/Get on or off.</td>

</tr>

<tr>

<td>Access</td>

−

<td>io_state | io_type | io_value; default: io_state, io_type, io_value</td>

+

<td>io_state {{!}} io_type {{!}} io_value {{!}} io_invert; default: io_state, io_type, io_value, io_invert</td>

<td>Accessible methods. It is considered that all methods are allowed if this list is empty.</td>

</tr>

Line 154: Line 177:

</tr>

</table>

+

Note: password fields are required to enable POST/GET funcionallity.

===Post/Get examples===

Line 168: Line 193:

</tr>

−

~~{{#ifeq:{{{configurableio}}}|1|~~

+

<tr>

<td>Turn Output state to high</td>

−

<td><nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}.1/cgi-bin/io_state<nowiki>?username=user1&password=user1&pin=</nowiki>{{#ifeq:{{{series}}}|RUTX|dout1|dio1}}<nowiki>&state=on</nowiki></td>

+

<td><nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}.1/cgi-bin/io_state<nowiki>?username=user1&password=user1&pin=</nowiki>{{#ifeq:{{{series}}}|RUTX|dout1|<dio0/dio1{{#switch:{{{series}}}|TRB2|TRB2M=/dio2}}>}}<nowiki>&state=on</nowiki></td>

</tr>

<tr>

<td>Turn Output state to low after 5 seconds for 3 seconds</td>

−

<td><nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}.1/cgi-bin/io_state<nowiki>?username=user1&password=user1&pin=</nowiki>{{#ifeq:{{{series}}}|RUTX|dout1|dio1}}&state=on<nowiki>&delay=5</nowiki><nowiki>&time=3</nowiki></td>

+

<td><nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}.1/cgi-bin/io_state<nowiki>?username=user1&password=user1&pin=</nowiki>{{#ifeq:{{{series}}}|RUTX|dout1|<dio0/dio1{{#switch:{{{series}}}|TRB2|TRB2M=/dio2}}>}}&state=on<nowiki>&delay=5</nowiki><nowiki>&time=3</nowiki></td>

</tr>

<tr>

−

<td>~~Change Configurable Input/Output with pin3 to Output~~</td>

+

<td>Check t_time parameter - time is set in miliseconds</td>

−

<td><nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}.1/cgi-bin/~~io_type~~<nowiki>?username=user1&password=user1&</nowiki>~~pin~~=~~dio0~~<nowiki>&~~type~~=~~out~~</nowiki></td>

+

<td><nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}.1/cgi-bin/io_state<nowiki>?username=user1&password=user1&pin=</nowiki>{{#ifeq:{{{series}}}|RUTX|dout1|<dio0/dio1{{#switch:{{{series}}}|TRB2|TRB2M=/dio2}}>}}&state=on<nowiki>&t_time=msec</nowiki><nowiki>&time=5000</nowiki><nowiki>&time=1000</nowiki></td>

</tr>

−

|

<tr>

−

<td>~~Turn Output state to high~~</td>

+

<td>Invert input</td>

−

<td><nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}.1/cgi-bin/~~io_state~~?username=user1&password=user1&pin=~~dout1~~<nowiki>&~~state~~=on</nowiki></td>

+

<td><nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}.1/cgi-bin/io_invert?username=user1&password=user1&pin={{#ifeq:{{{series}}}|RUTX|din1|<dio0/dio1{{#switch:{{{series}}}|TRB2|TRB2M=/dio2}}>}}<nowiki>&invert=<0/1> (0 - disable inversion/1 - enable inversion</nowiki></td>

</tr>

+

{{#ifeq:{{{configurableio}}}|1|

<tr>

−

<td>~~Turn~~ Output ~~state~~ to ~~low after 5 seconds for 3 seconds~~</td>

+

<td>Change Configurable Input/Output with pin3 to Output</td>

−

<td><nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}.1/cgi-bin/~~io_state~~?username=user1&password=user1&~~pin=dout1&state=on~~~~<nowiki>&delay~~=~~5</nowiki>~~<nowiki>&~~time~~=3</nowiki></td>

+

<td><nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}.1/cgi-bin/io_type<nowiki>?username=user1&password=user1&</nowiki>pin=dio0<nowiki>&type=out</nowiki></td>

</tr>

−

}}

+

||}}

−

+

</table>

Line 197: Line 222:

<ul>

<li>192.168.{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}.1 - device default LAN IP address; replace it in accordance with your own configuration.</li>

−

{{#ifeq:{{{configurableio}}}|1|<li>io_state or ~~io_type~~ - allows you to change IO state or ~~type~~.</li>}}

+

{{#ifeq:{{{configurableio}}}|1|<li>io_state,io_type or io_invert- allows you to change IO state, type or invert cofigurable input.</li>}}

<li>username - login name from Post/Get configuration.</li>

<li>password- password from Post/Get configuration.</li>

<li>state - turn Output on or off.</li>

{{#ifeq:{{{configurableio}}}|1|<li>type - turn Configurable Input/Output to Input or Output.</li>}}

+

<li>invert - enables inversion on/off (only works with inputs).</li>

<li>delay - defines a delay (in seconds) after which the specified action will be performed.</li>

<li>time - defines a window of time during which the action will take place. For instance, if you post an on action while specifying time=5, the output will turn on and stay on for 5 seconds before turning off.</li>

Line 223: Line 249:

Examples:

−

{{#ifeq:{{{configurableio}}}|1|* Read state of Configurable Input/Output PIN3:

+

{{#ifeq:{{{configurableio}}}|1|* {{#switch:{{{name}}}|TRB245|TRB246|TRB255|TRB256 = Read state of Configurable Input/Output PIN2/PIN3/PIN4:

−

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=dio0</nowiki>"|

+

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=dio0</nowiki>"

−

* Read state of digital output:

+

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=dio1</nowiki>"

+

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=dio2</nowiki>" | #default = Read state of Configurable Input/Output PIN3/PIN4:

+

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=dio0</nowiki>"

+

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=dio1</nowiki>"}}|

+

* Read state of digital input/output:

+

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=din1</nowiki>"

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=dout1</nowiki>"}}

{{#ifeq:{{{analog}}}|1|* Read state of analog input (in voltage mode):

Line 231: Line 262:

{{#ifeq:{{{acl}}}|1|* Read state of analog input (in current mode):

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=acl0</nowiki>"|}}

+

{{#ifeq:{{{dry}}}|1|* Read state of Dry input PIN1:

+

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=dwi0</nowiki>"|}}

+

{{#ifeq:{{{wet}}}|1|* Read state of Wet input PIN2:

+

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=dwi1</nowiki>"|}}

+

{{#ifeq:{{{isolated}}}|1|* Read state of Isolated input:

+

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=iio</nowiki>"|}}

+

{{#ifeq:{{{onewire}}}|1|* Read state of One Wire:

+

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=onewire</nowiki>"|}}

+

{{#ifeq:{{{relay}}}|1|* Read state of Relay:

+

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=relay0</nowiki>"|}}

+

{{#ifeq:{{{latchingrelay}}}|1|* Read state of Latching Relay:

+

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=relay1</nowiki>"|}}

+

{{#ifeq:{{{galvanic}}}|1|* Read state of Galvanically isolated open collector output:

+

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=dout2</nowiki>"|}}

+

{{#ifeq:{{{digitalpassive}}}|1|* Read state of Digital input (only for passive sensors):

+

curl -X GET "<nowiki>http://192.168.</nowiki>{{#switch:{{{series}}}|TRB1|TRB5=2|#default=1}}<nowiki>.1/cgi-bin/io_value?username=user1&password=user1&pin=din2</nowiki>"|}}

==Scheduler==

Line 302: Line 349:

The I/O Juggler is a feature that provides the possibility to create automated rules that perform certain actions based on Input state changes and other conditions. The operating sequence of I/O Juggler can be visualized as such:

−

[[File:Networking_rutos_manual_input_output_io_juggler_scheme_condition_mobile_{{{mobile}}}.png]]

+

[[File:Networking_rutos_manual_input_output_io_juggler_scheme_condition_mobile_{{{mobile}}}.png|border|class=tlt-border]]

When an Input Trigger occurs, the Input check to see if user-specified conditions are also met. If so, it executes a user-specified action.

Line 405: Line 452:

Sends an email to specified recipients. Requires an existing email account configuration on the device. Email accounts can be configured in the System → Administration → Recipients → [[{{{name}}}_Administration#Email_Accounts|Email Accounts]] page.

−

[[File:~~Networking_rutos_manual_input_output_io_juggler_actions_email~~.png|border|class=tlt-border]]

+

{{#switch: {{{name}}}

+

| RUTX12| RUTM12 = [[File:Networking rutos manual input output io juggler actions email rutx12 v2.png|border|class=tlt-border]]

+

| RUTX10 = [[File:Networking_rutos_manual_input_output_io_juggler_actions_email_rutx10_v2.png|border|class=tlt-border]]

+

| #default = [[File:Networking rutos manual input output io juggler actions email v2.png|border|class=tlt-border]]

+

}}

Line 427: Line 478:

<td>positive integer; default: none</td>

<td>A period of time (in seconds) which has to pass after a trigger event before the action is executed.</td>

−

</tr>

+

</tr>{{#switch: {{{name}}}

+

| RUTX12| RUTM12 =

+

<tr>

+

<td>Modem</td>

+

<td>Primary modem {{!}} Secondary modem; default: Primary modem</td>

+

<td>Modem, which is used to get information from.</td>

+

</tr>|}}

<tr>

<td>Email account</td>

Line 547: Line 604:

Executes a custom, user-written shell script.

−

[[File:Networking_rutos_manual_input_output_io_juggler_actions_script.png|border|class=tlt-border]]

+

{{#switch: {{{name}}}

+

| RUTX10 = [[File:Networking_rutos_manual_input_output_io_juggler_actions_script_rutx10_v1.png|border|class=tlt-border]]

+

| #default = [[File:Networking_rutos_manual_input_output_io_juggler_actions_script.png|border|class=tlt-border]]

+

}}

+

Line 648: Line 709:

Executes a MQTT action.

−

[[File:Networking rutos manual input output io juggler actions ~~mqtt~~.png|border|class=tlt-border]]

+

{{#switch: {{{name}}}

+

| RUTX10 = [[File:Networking_rutos_manual_input_output_io_juggler_actions_mqtt_rutx10_v1.png|border|class=tlt-border]]

+

| #default = [[File:Networking rutos manual input output io juggler actions mqtt_v1.png|border|class=tlt-border]]

+

}}

+

Line 666: Line 732:

<td>string; default: none</td>

<td>The name of the topic that the broker will subscribe to.</td>

+

</tr>

+

<tr>

+

<td>Client ID</td>

+

<td>string; default: none</td>

+

<td>Client ID to send with the data. If empty, a random client ID will be generated.</td>

</tr>

<tr>

Line 696: Line 767:

<td>string; default: none</td>

<td>Password used for authentication to the Broker.</td>

+

</tr>

+

<tr>

+

+

<td>off {{!}} on; default: off</td>

+

<td>Select to enable TLS encryption.</td>

+

</tr>

+

<tr>

+

+

<td>Certificate based {{!}} Pre-Shared-Key based; default: Certificate based</td>

+

<td>Type of TLS encryption.</td>

+

</tr>

+

<tr>

+

<td>Certificate based:Allow insecure connection</td>

+

<td>off {{!}} on; default: off</td>

+

<td>Allow not verifying server authenticity.</td>

+

</tr>

+

<tr>

+

<td>Certificate based:Certificate files from device</td>

+

<td>off {{!}} on; default: off</td>

+

<td>Choose this option if you want to select certificate files from device.</td>

+

</tr>

+

<tr>

+

<td>Certificate based:CA file</td>

+

<td>.crt file; default: none</td>

+

<td>Upload CA file.</td>

+

</tr>

+

<tr>

+

<td>Certificate based:Certificate file</td>

+

<td>.crt file; default: none</td>

+

<td>TLS client or server certificate file.</td>

+

</tr>

+

<tr>

+

<td>Certificate based:Key file</td>

+

<td>.key file; default: none</td>

+

<td>TLS client or server key file.</td>

+

</tr>

+

<tr>

+

<td>Pre-Shared-Key based:Pre-Shared-Key</td>

+

<td>string; default: none</td>

+

<td>The pre-shared-key in hex format with no leading “0x”.</td>

+

</tr>

+

<tr>

+

<td>Pre-Shared-Key based:Identity</td>

+

<td>string; default: none</td>

+

<td>Specify the Identity.</td>

</tr>

</table>

Line 705: Line 821:

Switches to using the specified SIM card.

−

[[File:~~Networking_rutos_manual_input_output_io_juggler_actions_change_sim~~.png|border|class=tlt-border]]

+

[[File:Networking_rutos_manual_input_output_io_juggler_actions_change_sim_v2.png|border|class=tlt-border]]

Line 722: Line 838:

<td>off {{!}} on; default: off</td>

<td>When set to 'on', switches to the opposite SIM card (the that is currently NOT in use). This can be used instead of selecting a specific SIM card to switch to.</td>

+

</tr>

+

<tr>

+

<td>Enable primary option transfer</td>

+

<td>off {{!}} on; default: off</td>

+

<td>Enables simd service to change primary card while switching sims </td>

</tr>

<tr>

Lukas.Krasauskis

Administrators

43

edits