9,312
edits
Changes
Template:Networking rutos manual input output (view source)
Revision as of 18:05, 22 November 2021
, 18:05, 22 November 2021no edit summary
{{Template:Networking_rutos_manual_fw_disclosure
{{Template:Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.05.1
| fw_version = {{{series}}}{{#ifeq:{{{name}}}|RUT241|M|}}_R_00.07.01{{#ifeq:{{{series}}}|RUT9|.1|}}
| series = {{{series}}}
| series = {{{series}}}
}}
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} Input/Output (legacy WebUI)|click here]]</b> for the old style WebUI (FW version RUT9XX_R_00.06.08.5 and earlier) user manual page.</i>
<p style="color:red">Warning: From 7.0 version I/O parameters and controls have changed compared to RUT9XX_R_00.06.08.3 and earlier legacy versions.</p>|}}
{{#ifeq: {{{series}}} | RUT2 |
{{#switch: {{{name}}}
| RUT241 =
| #default =
<br><i><b>Note</b>: <b>[[{{{name}}} System (legacy WebUI)|click here]]</b> for the old style WebUI (FW version RUT2XX_R_00.01.14.4 and earlier) user manual page.</i>}}
<p style="color:red">Warning: From 7.1 version I/O parameters and controls have changed compared to RUT2XX_R_00.01.14.1 and earlier legacy versions.</p>|}}
==Summary==
==Summary==
| series = {{{series}}}
| series = {{{series}}}
}}
}}
==Physical characteristics and I/O pin mapping==
Electrical characteristics and I/O pin mapping information are presented below.
{{Template:Networking_rutos_manual_input_output_pinout
| series = {{{series}}}
| configurableio = {{{configurableio}}}
| input_volts = {{{input_volts}}}
}}{{#ifeq: {{{name}}} | TRB141 |
<h3>Input/Output Connector Pinout</h3>
----
[[File:Networking_trb141_manual_input_output_input_output_connector_pinout.png]]
<ul>
<ul>
<li><b>Power</b>: 9-50 VDC positive (+).</li>
<li><b>DI<sub>1</sub></b> & <b>DI<sub>2</sub></b> - DRY/WET configurable inputs:
<ul>
<ul>
<li><i>logical low level:</i> 0 - 5 V;</li>
<li><b>WET</b>: 0-1.9 V is detected as logical "0"; 1.9-3.8 V is detected as logical "1"</li>
<li><i>logical high level:</i> 8 - 40 V.</li>
<li><b>DRY</b>: is detected as logical "0" when the input is shorted to GND; otherwise is detected as logical "1"</li>
</ul>
</ul>
</li>
</li>
<li><b>Output</b>: digital open collector (OC) output; 30 V, 300 mA.</li>
<li><b>NC<sub>1</sub></b>, <b>C<sub>1</sub></b> & <b>NO<sub>1</sub></b> - Normally Closed, Common and Normally Open contacts of the internal Non-Latching Relay respectively.<br>Maximum relay ratings: 0.5 A at 60 VDC/70 VAC, 1 A at 30 VDC/VAC.</li>
</ul>
<li><b>NC<sub>2</sub></b>, <b>C<sub>2</sub></b> & <b>NO<sub>2</sub></b> - Normally Closed, Common and Normally Open contacts of the internal Latching Relay respectively.<br>Maximum relay ratings: 0.8 A at 70 VDC, 0.9 A at 70 VAC, 2 A at 30 VDC/VAC.</li>
<li><b>A</b> - ADC input. Analog voltage range: 0-30 V. The input can be configured for 4-20 mA sensor protocol as current measurement (ACL) of 0-30 mA.</li>
<li><b>l</b> and <b>⏚</b> - isolated input contacts.
<ul>
<li><b>Power</b>: 9-30 VDC positive (+).</li>
<li><b>Ground</b>: negative/ground (-).</li>
<li><b>I/O</b>: programmable input/output pins; can be set to:
<ul>
<ul>
<li><i>open collector (OC) output;</i> max 30 V;</li>
<li>0-7.3 V is detected as logical "0"</li>
<li>7.3-71 V is detected as logical "1"</li>
</ul>
</ul>
</li>
</li>
</ul>
<li><b>+</b> - a power output connected directly to gateway's power supply input pin. This Output can be used to power an external 4-20 mA current sensor.</li>
<li><b>3.8</b> is a 3.8 V power output that can be used to power 1-Wire sensors.</li>
<li><b>1W</b> - 1-Wire protocol input/output.</li>
<li><b>⏚</b> - GND contact.</li>
</ul>|}}
| TRB2XX =
}}
==Status==
==Status==
The <b>Status</b> page displays the current states of the device's input and output pins:
The <b>Status</b> page displays the current states of the device configurable inputs and outputs:
{{#switch: {{{name}}}
| TRB141 = [[File:Networking_trb141_manual_input_output_status.png|border|class=tlt-border]]
| RUT950 = [[File:Networking_RUT950_manual_input_output_status.png|border|class=tlt-border]]
| RUT955 = [[File:Networking_RUT955_manual_input_output_status.png|border|class=tlt-border]]
| [[File:Networking_{{lc:{{{series}}}}}_manual_input_output_status.png|border|class=tlt-border]]
===Reading I/O values from directory===
====ADC (Analog Input)====
====One-wire====
| <!-- for other TRB1 -->
[[File:Networking_trb14x_manual_input_output_status_v1.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.
You can invert Input pin by clicking on slider in <b>Inversion</b> column and switch Output pin state by clicking on slider in <b>State</b> column.
===Status from command line===
===Status from command line===
----
----
You can also obtain the status of the input or output from the command line. List of ubus possible <b>values</b> in {{{name}}} devices:
You can also obtain the status of input and output pins via the command line (CLI or SSH). List of possible ubus values in {{{name}}} devices:
{{#switch: {{{series}}}
| TRB1 ={{#ifeq:{{{name}}}
| TRB141 | {{Template:Networking_trb141_manual_input_output_status}}
| {{Template:Networking_{{lc:{{{series}}}}}_manual_input_output_status|name={{{name}}}}}
}}
| #default = {{Template:Networking_{{lc:{{{series}}}}}_manual_input_output_status|name={{{name}}}}}
}}
}}
==Post/Get==
==Post/Get==
Enabling <b>Post/Get</b> 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 on or off and to set authentication parameters.
Enabling <b>Post/Get</b> 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.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_post_get_auth_settings.png|border|class=tlt-border]]
===Post/Get examples===
===Post/Get examples===
----
----
Use a web browser or any other compatible software to send HTTP POST/GET requests to the device.
Below is a table containing syntax examples of this usage:
Below is a table containing syntax examples of this usage:
<tr>
<tr>
<td>Change Configurable Input/Output with pin3 to Output</td>
<td>Change Configurable Input/Output with pin3 to Output</td>
<td><nowiki>http://192.168.</nowiki>{{#ifeq:{{{series}}}|TRB1|2|1}}.1/cgi-bin/<span style="color: #0054a6;"><b>io_type</b></span><nowiki>?username=user1&password=user1&</nowiki><span style="color: #0054a6;"><b>pin=dio1</b></span><span style="color: #3232ff;"><b><nowiki>&type=out</nowiki></b></span></td>
<td><nowiki>http://192.168.</nowiki>{{#ifeq:{{{series}}}|TRB1|2|1}}.1/cgi-bin/<span style="color: #0054a6;"><b>io_type</b></span><nowiki>?username=user1&password=user1&</nowiki><span style="color: #0054a6;"><b>pin=dio0</b></span><span style="color: #3232ff;"><b><nowiki>&type=out</nowiki></b></span></td>
</tr>
</tr>
|
|
==Scheduler==
==Scheduler==
The output <b>Scheduler</b> can be used to configure a timetable of when an output should be turned on or off, based on days of the week and hours of the day. Below is an example of the Scheduler section.
The output <b>Scheduler</b> can be used to configure a timetable of when an output should be turned on or off, based on days of the week or month and hours of the day. The General Configuration section is used to turn the Output Scheduler on or off.
[[File:Networking_rutos_manual_input_output_scheduler_configure_scheduler_configurableio_{{{configurableio}}}.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_scheduler_general_configuration.png|border|class=tlt-border]]
The Scheduler is configured in the form of <b>Instances</b>. A Scheduler Instance defines a time interval during which the state of an output associated with the instance will be set to "High". The Output Scheduler Instances list is empty by default. Click the 'Add' button in order to create a new Scheduler Instance:
[[File:Networking_rutos_manual_input_output_scheduler_add_button.png|border|class=tlt-border]]
After this you should be redirected to the configuration page for the newly added Instance which should look similar to this:
[[File:Networking_rutos_manual_input_output_scheduler_instance_configuration_configurableio_{{{configurableio}}}.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>off | on; default: <b>off</b></td>
<td>Turns the Scheduler Instance on or off.</td>
</tr>
<tr>
<td>Pin</td>
<td>output pin; default: <b>{{#ifeq:{{{configurableio}}}|1|Configurable Input/Output (2)|Output (4)}}</b></td>
<td>Output pin. The state of the selected output will be set to "High" during the time interval defined in the fields below.</td>
</tr>
<tr>
<td>Interval Type</td>
<td>Weekdays | <span style="color: red;">Month Days</span>; default: <b>Weekdays</b></td>
<td>Selects the interval type for scheduler to use.</td>
</tr>
<tr>
<td>Start Day</td>
<td>[Monday..Sunday] | [1..31]; default: <b>Monday | 1</b></td>
<td>The day that marks the start of the time interval.</td>
</tr>
<tr>
<td>Start Time</td>
<td>hh:mm ([00..23]:[00..59]); default: <b>12:00</b></td>
<td>The hour and minute that mark the start of the time interval.</td>
</tr>
<tr>
<td>End Day</td>
<td>[Monday..Sunday] | [1..31]; default: <b>Tuesday | 1</b></td>
<td>The day that marks the end of the time interval.</td>
</tr>
<tr>
<td>End Time</td>
<td>hh:mm ([00..23]:[00..59]); default: <b>12:00</b></td>
<td>The hour and minute that mark the end of the time interval.</td>
</tr>
<tr>
<td><span style="color: red;">Force Last Day</span></td>
<td>off | on; default: <b>off</b></td>
<td>Forces intervals to accept last day of month as a valid option if selected day does not exist during ongoing month. This field becomes visible only when 'Interval Type' is set to <i>Month Days</i>.</td>
</tr>
</table>
A Scheduler Instance will not work unless you turn both the the Scheduler service and the individual instance on:
[[File:Networking_rutos_manual_input_output_scheduler_on_off_slider_configurableio_{{{configurableio}}}.png|border|class=tlt-border]]
==I/O Juggler==
==I/O Juggler==
</tr>
</tr>
<tr>
<tr>
<td>Recipient's phone number/Phone group</td>
<td>Recipient's phone number {{!}} Phone group</td>
<td>phone number | phone group; default: <b>none</b></td>
<td>phone number {{!}} phone group; default: <b>none</b></td>
<td>Phone number of a single recipient or a Phone group of multiple recipients. The name and selection type of this field depends on the value set in the 'Recipients' field.</td>
<td>Phone number of a single recipient or a Phone group of multiple recipients. The name and selection type of this field depends on the value set in the 'Recipients' field.</td>
</tr>
</tr>
====HTTP====
====HTTP====
----
----
Executes at HTTP Post/Get action.
Executes a HTTP POST/GET request.
[[File:Networking_rutos_manual_input_output_io_juggler_actions_http.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_actions_http.png|border|class=tlt-border]]
</tr>
</tr>
<tr>
<tr>
<td>Custom script/Script file</td>
<td>Custom script {{!}} Script file</td>
<td>-(interactive button) | filepath</td>
<td>-(interactive button) | filepath</td>
<td>Shows file upload window on click or provides the possibility to specify a path to an internal script file. The name and selection type of this field depends on the value set in the 'Specify path' field.</td>
<td>Shows file upload window on click or provides the possibility to specify a path to an internal script file. The name and selection type of this field depends on the value set in the 'Specify path' field.</td>
Switches to using a specified Configuration Profile.
Switches to using a specified Configuration Profile.
[[File:Networking_rutos_manual_input_output_io_juggler_actions_script.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_actions_profile.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</table>
</table>
{{#ifeq: {{{dualsim}}} | 1 |
{{#ifeq: {{{dualsim}}} | 1 |
====Type: Change SIM====
----
----
Switches to using the specified SIM card.
Switches to using the specified SIM card.
</table>
</table>
|}}
|}}
===Conditions===
===Conditions===
----
----
The <b>Conditions</b> section lets you manage your created Conditions for I/O Juggler Actions. The figure below is an example of Conditions section.
The <b>Conditions</b> section is used to manage and created Conditions for I/O Juggler Actions. The figure below is an example of the Conditions section, which is empty by default.
[[File:Networking_rutx_manual_input_output_iojuggler_conditions_v1.png]]
[[File:Networking_rutos_manual_input_output_io_juggler_conditions.png|border|class=tlt-border]]
To create a new Condition, look to the Add a Condition section; enter a custom name, select the Type of the Condition and click the 'Add' button.
[[File:Networking_rutx_manual_input_output_iojuggler_conditions_modify_v1.png]]
[[File:Networking_rutos_manual_input_output_io_juggler_conditions_add_button.png|border|class=tlt-border]]
After this you should be redirected to the configuration page of the newly added Condition. You will find descriptions of each different Condition type described on the sections below.
will not be provided, since the structures, syntax and the overall look of the configuration windows for each condition
=====Boolean group=====
====Condition type: I/O====
----
----
I/O Condition type tracks the state of a selected input or output pin and considers the Condition as MET if that pin is in a user-specified state.
[[File:Networking_rutos_manual_input_output_io_juggler_conditions_io_configurableio_{{{configurableio}}}.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<th>Value</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>I/O</td>
<td>I/O</td>
<td>inputs/outputs; default: <b>Output(4)</b></td>
<td>inputs/outputs; default: <b>Output(4)</b></td>
<td>Specifies the I/O to which the condition is listening to.</td>
<td>Specifies the I/O pin to which this Condition is listening to.</td>
</tr>
</tr>
<tr>
<tr>
<td>State</td>
<td>State</td>
<td>High {{!}} Low; default: <b>High</b> </td>
<td>High | Low; default: <b>High</b></td>
<td>Specifies in what state the pin has to be.</td>
<td>Specifies in what state the pin has to be in in order for the Condition to be met.</td>
</tr>
</tr>
</table>
</table>
{{#ifeq: {{{analog}}} | 1 |
====Condition type: Analog voltage====
----
Analog voltage Condition type measures the value of the Analog input and checks whether it inside or outside the user-specified range.
[[File:Networking_rutos_manual_input_output_io_juggler_conditions_analog_voltage.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<th>Value</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
</table>
</table>
|}}
|}}
====Condition type: Boolean group====
----
Boolean Group will evaluate two or more existing conditions based on selected Boolean type. A Boolean Group condition will considered as MET based on the outcome of the evaluation performed along with one of the available Boolean types:
<ul>
<li><b>AND</b> - all selected conditions evaluate as TRUE.</li>
<li><b>NAND</b> - at least one selected condition evaluates as FALSE.</li>
<li><b>OR</b> - at least one selected condition evaluates as TRUE.</li>
<li><b>NOR</b> - none of the selected conditions evaluate as TRUE.</li>
</ul>
For example, if we have two time Conditions (hour and minute) and a third Condition of Boolean group: AND, both Conditions 1 & 2 have to be met for Condition 3 to be evaluated as TRUE.
[[File:Networking_rutos_manual_input_output_io_juggler_boolean_group_scheme_true.png|border|class=tlt-border]]
In this case, if at least one condition is no longer met, the Boolean group: AND Condition is evaluated as FALSE.
=====Hour=====
[[File:Networking_rutos_manual_input_output_io_juggler_boolean_group_scheme_false.png|border|class=tlt-border]]
----
----
Below is an example of Condition type: Boolean group configuration.
[[File:Networking_rutos_manual_input_output_io_juggler_conditions_boolean_group.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
</tr>
</tr>
<tr>
<tr>
<td>Condition type</td>
<td>Boolean type</td>
<td>Weekday</td>
<td>AND | NAND | OR | NOR; default: <b>AND</b></td>
<td>A type of condition.</td>
<td>Type of boolean condition.</td>
</tr>
</tr>
<tr>
<tr>
<td>Inverted function</td>
<td>Add conditions</td>
<td>off {{!}} on; default: <b>off</b> </td>
<td>conditions; default: <b>none</b> </td>
<td>Specifies conditions which have to be met for action to occur.</td>
<td>Specifies ending weekday of the interval at which the action can occur.</td>
</tr>
</tr>
</table>
</table>
=====Month day=====
====Condition types: Date/Time====
----
----
Lastly, you can configure Conditions based on date and time. Date/time Conditions can be configured based on:
<ul>
<li><b>Minute</b> of the hour</li>
<li><b>Hour</b> of the day</li>
</tr>
<li><b>Day</b> of the <b>Week</b></li>
<li><b>Day</b> of the <b>Month</b></li>
<li><b>Day</b> of the <b>Year</b></li>
</ul>
<tr>
</tr>
</tr>
</tr>
</table>
[[File:Networking_rutos_manual_input_output_io_juggler_conditions_date_time.png|border|class=tlt-border]]
Each type can be configured in two distinct ways:
<b>Note</b>: this table has coloring scheme to indicate which fields can be seen with different configuration.
<ol>
<li><b>Specific time</b> - configured as a single value which defines the exact time when the Condition is considered as TRUE. e.g.:
<ul>
<li>Hour: <b>8</b></li>
<li>Day of Month: <b>1</b></li>
</ul>
</li>
<li><b>Time interval</b> - configured with a start and an end value which define a window of time during which the Condition is considered as TRUE. e.g.:
<ul>
<li>Hours: <b>8-12</b></li>
<li>Days of Month: <b>1-12</b></li>
</ul>
</li>
</ol>
[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]
