31,703
edits
Changes
Template:Networking rut manual input output legacy (view source)
Revision as of 09:13, 4 June 2021
, 09:13, 4 June 2021Created page with "{{Template: Networking_rutos_manual_fw_disclosure | fw_version = {{#switch: {{{series}}} | RUT2XX = {{{series}}}_R_00.01.14 | RUT9XX = {{{series}}}_R_00.06.08.1}} | series..."
{{Template: Networking_rutos_manual_fw_disclosure
| fw_version = {{#switch: {{{series}}}
| RUT2XX = {{{series}}}_R_00.01.14
| RUT9XX = {{{series}}}_R_00.06.08.1}}
| series = {{{series}}}
}}
<i><b>Note</b>: this user manual page is for {{{name}}}'s old WebUI style available in earlier FW versions. <b>[[{{{name}}} Input/Output|Click here]]</b> for information based on the latest FW version.</i>
==Summary==
<b>Inputs and Outputs</b> are used for the monitoring and controlling of a connected device or receiving signals from that device in order to trigger certain events.
This chapter of the user manual provides an overview of the Input/Output page for {{{name}}} devices.
==Characteristics==
{{Template:Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_characteristics|name={{{name}}}}}
==Status==
The <b>Status</b> tab displays the current states the router’s {{#ifeq:{{{series}}}|RUT9XX|inputs and outputs|input and output}}:
{{#ifeq:{{{name}}}|RUT955
|[[File:{{{file_status}}}|border|class=tlt-border]]
|[[File:{{{file_status}}}|border|class=tlt-border]]}}
===Custom Labels===
----
If the default Input/Output labels do not suit your needs, you can always configure custom ones in the <b>Custom Labels</b> section. Click the 'Edit' button next to the desired Input or Output and you will be redirected to a window such as this:
[[File:{{{file_status_digital}}}|border|class=tlt-border]]
The figure above is an example of custom label configuration for <i>Digital Input</i>. You can change an input's/output's name and the names of their states. The changes are purely cosmetic and used for easier management purposes.
{{#ifeq:{{{series}}}|RUT9XX|----
In addition to adding custom names, you can also define how the displayed value for Analog Input is calculated and displayed. The figure below represents what the configuration of custom labels for Analog Input looks like.
[[File:{{{file_status_analog}}}]]|}}
===Status and control from command line===
----
{{Template: Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_cli}}
==Input==
The <b>Input</b> tab is used to configure the router's input {{#ifeq:{{{name}}}|RUT955|pins|pin}}.
{{#ifeq:{{{name}}}|RUT955|
===Check Analog===
----
The <b>Check Analog</b> section is used to set how often the router checks the value of the analog input. This is relevant to input rules related to the analog input. For example, if you have configured an input rule that triggers a certain action when the analog input value is inside a certain range, the frequency at which the router will check this value is set in this section.
[[File:{{{file_input_analog}}}]]|}}
===Input Rules===
----
The <b>Input Rules</b> section provides you with the possibility to set up rules that execute user specified actions after a certain trigger occurs. To add a new rule, look to the Input Configuration section that is just below. Select the input, the trigger and the action for the rule and click the 'Add' button. A new rule will appear in the Input Rules list:
[[File:{{{file_input_add}}}|border|class=tlt-border]]
----
To begin editing an input rule, click the 'Edit' button located next to it. Refer to the figure and table below for information on input rule configuration.
{{#ifeq:{{{name}}}|RUT955
|[[File:{{{file_input_config}}}|border|class=tlt-border]]
|[[File:{{{file_input_config}}}|border|class=tlt-border]]}}
{{Template:Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_input_rule_table|name={{{name}}}}}
==Output==
The <b>Output</b> tab is used to configure the router's output {{#ifeq:{{{name}}}|RUT955|pins|pin}}.
===Output Configuration===
----
The <b>Output Configuration</b> section is used to change the default {{#ifeq:{{{name}}}|RUT955|states|state}} of the router's output {{#ifeq:{{{name}}}|RUT955|pins|pin}}.
{{#ifeq:{{{series}}}|RUT9XX
|[[File:{{{file_output_config}}}|border|class=tlt-border]]
|[[File:{{{file_output_config}}}]]
}}
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Open collector output</td>
<td>Low level | High level; default: <b>Low level</b></td>
<td>Changes the default<span class="asterisk">*</span> state of the open collector (OC) output pin.</td>
</tr>{{#ifeq:{{{name}}}RUT955|
<tr>
<td>Relay output</td>
<td>Contacts open <nowiki>|</nowiki> Contacts closed; default: <b>Contacts closed</b></td>
<td>Changes the default<span class="asterisk">*</span> state of the relay output pin.</td>
</tr>|}}
</table>
<font size="-1"><span class="asterisk">*</span> Changing the default state of an output means that the changes will be written into the input/output config and saved. This means that unless some other related change occurs the state of the output will remain as set in this section.</font>
===ON/OFF===
----
The <b>ON/OFF</b> section is used to turn the router's {{#ifeq:{{{name}}}|RUT955|outputs|output}} on or off. This action does not save the state permanently, meaning that after a reboot the {{#ifeq:{{{name}}}|RUT955|states|state}} will revert back to their default values.
[[File:{{{file_output_on_off}}}|border|class=tlt-border]]
===Periodic control===
----
The <b>Periodic control</b> section allows you to set up automatic output control rules that trigger output state changes at the specified period or interval. Refer to the figure and table below for information on configuration fields contained in that section.
[[File:{{{file_output_periodic}}}|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>yes | no; default: <b>no</b></td>
<td>Turns the rule on or off.</td>
</tr>
<tr>
<td>Output</td>
<td>Digital OC Output | Digital 4PIN | Digital relay output; default: <b>Digital OC Output</b> </td>
<td>The output pin that will be effected by the rule.</td>
</tr>
<tr>
<td>Action</td>
<td>On | Off; default: <b>On</b></td>
<td>The action that will be performed on the output.</td>
</tr>
<tr>
<td>Action timeout</td>
<td>yes | no; default: <b>no</b></td>
<td>Action timeout specifies whether an action should end after some time. For example, if action is set to <i>on</i> and timeout is set to 10, when the trigger occurs the output will turn on for 10 seconds before turning off.</td>
</tr>
<tr>
<td>Mode</td>
<td>Fixed | Interval; default: <b>Fixed</b></td>
<td>When the rule will be triggered.
<ul>
<li><b>Fixed</b> - triggers the specified action on a specified day(s), hour and minute. For example, every Sunday at 8:30 AM.</li>
<li><b>Interval</b> - performs the action at an interval. For example, every 1 hour during Mondays.</li>
</ul>
</td>
</tr>
</table>
===Scheduler===
----
With the help of the output <b>Scheduler</b> you can configure a timetable of when the {{#ifeq:{{{name}}}|RUT955|outputs|output}} should be enabled or disabled based on time.
[[File:{{{file_output_scheduler}}}|border|class=tlt-border]]
==Post/Get==
Enabling <b>Post/Get</b> will allow you to send HTTP POST/GET requests to the router that control the state of the output. The figure below is an example of the Post/Get configuration section and the table below provides information on the fields contained in that section:
[[File:{{{file_output_post_get}}}|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>yes | no; default: <b>no</b></td>
<td>Turns Post/Get on or off.</td>
</tr>
<tr>
<td>Username</td>
<td>string; default: <b>none</b></td>
<td>Username used for authentication in POST/GET queries.</td>
</tr>
<tr>
<td>Password</td>
<td>string; default: <b>none</b></td>
<td>Password used for authentication in POST/GET queries.</td>
</tr>
</table>
===Post/Get examples===
----
It is possible to turn the {{#ifeq:{{{name}}}|RUT955|outputs|output}} on and off by using a HTTP POST/GET requests. 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:
{{Template:Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_post_get_examples_table|name={{{name}}}}}
<b>Overview</b>:
<ul>
<li>192.168.1.1 - router's default LAN IP address; replace it in accordance with your own configuration.</li>
<li>username - login name from Post/Get configuration.</li>
<li>password- password from Post/Get configuration.</li>
<li>action- the action that will be performed on the output (can be <i>on</i> or <i>off</i>).</li>
<li>pin - specifies the output (use <i>oc</i>{{#ifeq:{{{name}}}|RUT955| or <i>relay</i>|}}).</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 <i>on</i> action while specifying <i>time=5</i>, the output will turn on and stay on for 5 seconds before turning off.</li>
</ul>
Delay and time parameters can be used together. For example, if delay is 10, time is 5, action is on, then 10 seconds after the execution of the command, the output will switch to <i>on</i> (or stay in <i>on</i> state if it was already that way), then after 5 more seconds it will switch to <i>off</i> state. In this case the overall command execution time is 15 seconds.
{{#ifeq: {{{series}}} | RUT9XX ||
==Additional Information==
<b>Input/Output hardware application examples:</b>
<ul>
<li><b>[[{{{name}}} Relay to Open Collector Output|Relay to Open Collector Output]]</b></li>
</ul>
}}[[Category:{{{name}}} Services section (legacy)]]
| fw_version = {{#switch: {{{series}}}
| RUT2XX = {{{series}}}_R_00.01.14
| RUT9XX = {{{series}}}_R_00.06.08.1}}
| series = {{{series}}}
}}
<i><b>Note</b>: this user manual page is for {{{name}}}'s old WebUI style available in earlier FW versions. <b>[[{{{name}}} Input/Output|Click here]]</b> for information based on the latest FW version.</i>
==Summary==
<b>Inputs and Outputs</b> are used for the monitoring and controlling of a connected device or receiving signals from that device in order to trigger certain events.
This chapter of the user manual provides an overview of the Input/Output page for {{{name}}} devices.
==Characteristics==
{{Template:Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_characteristics|name={{{name}}}}}
==Status==
The <b>Status</b> tab displays the current states the router’s {{#ifeq:{{{series}}}|RUT9XX|inputs and outputs|input and output}}:
{{#ifeq:{{{name}}}|RUT955
|[[File:{{{file_status}}}|border|class=tlt-border]]
|[[File:{{{file_status}}}|border|class=tlt-border]]}}
===Custom Labels===
----
If the default Input/Output labels do not suit your needs, you can always configure custom ones in the <b>Custom Labels</b> section. Click the 'Edit' button next to the desired Input or Output and you will be redirected to a window such as this:
[[File:{{{file_status_digital}}}|border|class=tlt-border]]
The figure above is an example of custom label configuration for <i>Digital Input</i>. You can change an input's/output's name and the names of their states. The changes are purely cosmetic and used for easier management purposes.
{{#ifeq:{{{series}}}|RUT9XX|----
In addition to adding custom names, you can also define how the displayed value for Analog Input is calculated and displayed. The figure below represents what the configuration of custom labels for Analog Input looks like.
[[File:{{{file_status_analog}}}]]|}}
===Status and control from command line===
----
{{Template: Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_cli}}
==Input==
The <b>Input</b> tab is used to configure the router's input {{#ifeq:{{{name}}}|RUT955|pins|pin}}.
{{#ifeq:{{{name}}}|RUT955|
===Check Analog===
----
The <b>Check Analog</b> section is used to set how often the router checks the value of the analog input. This is relevant to input rules related to the analog input. For example, if you have configured an input rule that triggers a certain action when the analog input value is inside a certain range, the frequency at which the router will check this value is set in this section.
[[File:{{{file_input_analog}}}]]|}}
===Input Rules===
----
The <b>Input Rules</b> section provides you with the possibility to set up rules that execute user specified actions after a certain trigger occurs. To add a new rule, look to the Input Configuration section that is just below. Select the input, the trigger and the action for the rule and click the 'Add' button. A new rule will appear in the Input Rules list:
[[File:{{{file_input_add}}}|border|class=tlt-border]]
----
To begin editing an input rule, click the 'Edit' button located next to it. Refer to the figure and table below for information on input rule configuration.
{{#ifeq:{{{name}}}|RUT955
|[[File:{{{file_input_config}}}|border|class=tlt-border]]
|[[File:{{{file_input_config}}}|border|class=tlt-border]]}}
{{Template:Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_input_rule_table|name={{{name}}}}}
==Output==
The <b>Output</b> tab is used to configure the router's output {{#ifeq:{{{name}}}|RUT955|pins|pin}}.
===Output Configuration===
----
The <b>Output Configuration</b> section is used to change the default {{#ifeq:{{{name}}}|RUT955|states|state}} of the router's output {{#ifeq:{{{name}}}|RUT955|pins|pin}}.
{{#ifeq:{{{series}}}|RUT9XX
|[[File:{{{file_output_config}}}|border|class=tlt-border]]
|[[File:{{{file_output_config}}}]]
}}
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Open collector output</td>
<td>Low level | High level; default: <b>Low level</b></td>
<td>Changes the default<span class="asterisk">*</span> state of the open collector (OC) output pin.</td>
</tr>{{#ifeq:{{{name}}}RUT955|
<tr>
<td>Relay output</td>
<td>Contacts open <nowiki>|</nowiki> Contacts closed; default: <b>Contacts closed</b></td>
<td>Changes the default<span class="asterisk">*</span> state of the relay output pin.</td>
</tr>|}}
</table>
<font size="-1"><span class="asterisk">*</span> Changing the default state of an output means that the changes will be written into the input/output config and saved. This means that unless some other related change occurs the state of the output will remain as set in this section.</font>
===ON/OFF===
----
The <b>ON/OFF</b> section is used to turn the router's {{#ifeq:{{{name}}}|RUT955|outputs|output}} on or off. This action does not save the state permanently, meaning that after a reboot the {{#ifeq:{{{name}}}|RUT955|states|state}} will revert back to their default values.
[[File:{{{file_output_on_off}}}|border|class=tlt-border]]
===Periodic control===
----
The <b>Periodic control</b> section allows you to set up automatic output control rules that trigger output state changes at the specified period or interval. Refer to the figure and table below for information on configuration fields contained in that section.
[[File:{{{file_output_periodic}}}|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>yes | no; default: <b>no</b></td>
<td>Turns the rule on or off.</td>
</tr>
<tr>
<td>Output</td>
<td>Digital OC Output | Digital 4PIN | Digital relay output; default: <b>Digital OC Output</b> </td>
<td>The output pin that will be effected by the rule.</td>
</tr>
<tr>
<td>Action</td>
<td>On | Off; default: <b>On</b></td>
<td>The action that will be performed on the output.</td>
</tr>
<tr>
<td>Action timeout</td>
<td>yes | no; default: <b>no</b></td>
<td>Action timeout specifies whether an action should end after some time. For example, if action is set to <i>on</i> and timeout is set to 10, when the trigger occurs the output will turn on for 10 seconds before turning off.</td>
</tr>
<tr>
<td>Mode</td>
<td>Fixed | Interval; default: <b>Fixed</b></td>
<td>When the rule will be triggered.
<ul>
<li><b>Fixed</b> - triggers the specified action on a specified day(s), hour and minute. For example, every Sunday at 8:30 AM.</li>
<li><b>Interval</b> - performs the action at an interval. For example, every 1 hour during Mondays.</li>
</ul>
</td>
</tr>
</table>
===Scheduler===
----
With the help of the output <b>Scheduler</b> you can configure a timetable of when the {{#ifeq:{{{name}}}|RUT955|outputs|output}} should be enabled or disabled based on time.
[[File:{{{file_output_scheduler}}}|border|class=tlt-border]]
==Post/Get==
Enabling <b>Post/Get</b> will allow you to send HTTP POST/GET requests to the router that control the state of the output. The figure below is an example of the Post/Get configuration section and the table below provides information on the fields contained in that section:
[[File:{{{file_output_post_get}}}|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>yes | no; default: <b>no</b></td>
<td>Turns Post/Get on or off.</td>
</tr>
<tr>
<td>Username</td>
<td>string; default: <b>none</b></td>
<td>Username used for authentication in POST/GET queries.</td>
</tr>
<tr>
<td>Password</td>
<td>string; default: <b>none</b></td>
<td>Password used for authentication in POST/GET queries.</td>
</tr>
</table>
===Post/Get examples===
----
It is possible to turn the {{#ifeq:{{{name}}}|RUT955|outputs|output}} on and off by using a HTTP POST/GET requests. 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:
{{Template:Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_post_get_examples_table|name={{{name}}}}}
<b>Overview</b>:
<ul>
<li>192.168.1.1 - router's default LAN IP address; replace it in accordance with your own configuration.</li>
<li>username - login name from Post/Get configuration.</li>
<li>password- password from Post/Get configuration.</li>
<li>action- the action that will be performed on the output (can be <i>on</i> or <i>off</i>).</li>
<li>pin - specifies the output (use <i>oc</i>{{#ifeq:{{{name}}}|RUT955| or <i>relay</i>|}}).</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 <i>on</i> action while specifying <i>time=5</i>, the output will turn on and stay on for 5 seconds before turning off.</li>
</ul>
Delay and time parameters can be used together. For example, if delay is 10, time is 5, action is on, then 10 seconds after the execution of the command, the output will switch to <i>on</i> (or stay in <i>on</i> state if it was already that way), then after 5 more seconds it will switch to <i>off</i> state. In this case the overall command execution time is 15 seconds.
{{#ifeq: {{{series}}} | RUT9XX ||
==Additional Information==
<b>Input/Output hardware application examples:</b>
<ul>
<li><b>[[{{{name}}} Relay to Open Collector Output|Relay to Open Collector Output]]</b></li>
</ul>
}}[[Category:{{{name}}} Services section (legacy)]]
