Template:Networking rut manual input output: Difference between revisions
No edit summary |
Gytispieze (talk | contribs) m (Text replacement - "\{\{Template: Networking_rutos_manual_fw_disclosure (.*) (.*) (.*) (.*) \}\}" to "{{Template: Networking_device_manual_fw_disclosure | series = {{{series}}} | name = {{{name}}} | fw_version ={{Template: Networking_device_manual_latest_fw | series = {{{series}}} | name = {{{name}}} }} }}") Tags: Mobile edit Mobile web edit |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template: | {{Template: Networking_device_manual_fw_disclosure | ||
| | | series = {{{series}}} | ||
| name = {{{name}}} | |||
| fw_version ={{Template: Networking_device_manual_latest_fw | |||
| | | series = {{{series}}} | ||
| name = {{{name}}} | |||
}} | |||
}} | }} | ||
==Summary== | ==Summary== | ||
| Line 21: | Line 23: | ||
{{#ifeq:{{{name}}}|RUT955 | {{#ifeq:{{{name}}}|RUT955 | ||
|[[File:{{{file_status}}}|border|class=tlt-border]] | |[[File:{{{file_status}}}|border|class=tlt-border]] | ||
|[[File:{{{file_status}}}]]}} | |[[File:{{{file_status}}}|border|class=tlt-border]]}} | ||
===Custom Labels=== | ===Custom Labels=== | ||
| Line 27: | Line 29: | ||
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: | 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}}}]] | [[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. | 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. | ||
| Line 51: | Line 53: | ||
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: | 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}}}]] | [[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. | 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. | ||
| Line 57: | Line 59: | ||
{{#ifeq:{{{name}}}|RUT955 | {{#ifeq:{{{name}}}|RUT955 | ||
|[[File:{{{file_input_config}}}|border|class=tlt-border]] | |[[File:{{{file_input_config}}}|border|class=tlt-border]] | ||
|[[File:{{{file_input_config}}}]]}} | |[[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}}}}} | {{Template:Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_input_rule_table|name={{{name}}}}} | ||
| Line 98: | Line 100: | ||
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. | 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}}}]] | [[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{{#ifeq:{{{name}}}|RUT955| {{!}} 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: | 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}}}]] | [[File:{{{file_output_post_get}}}|border|class=tlt-border]] | ||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
| Line 129: | Line 181: | ||
</table> | </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. | 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. | ||
| Line 150: | Line 202: | ||
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. | 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 || | {{#ifeq: {{{series}}} | RUT9XX || | ||
==Additional Information== | ==Additional Information== | ||
Latest revision as of 11:10, 24 October 2023
The information in this page is updated in accordance with firmware version .
Summary
Inputs and Outputs 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_{{{series}}}_manual_input_output_characteristics|name={{{name}}}}}
Status
The Status tab displays the current states the router’s input and output:
[[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 Custom Labels 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 Digital Input. 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.
Status and control from command line
{{Template: Networking_{{{series}}}_manual_input_output_cli}}
Input
The Input tab is used to configure the router's input pin.
Input Rules
The Input Rules 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.
[[File:{{{file_input_config}}}|border|class=tlt-border]]
{{Template:Networking_{{{series}}}_manual_input_output_input_rule_table|name={{{name}}}}}
Output
The Output tab is used to configure the router's output pin.
Output Configuration
The Output Configuration section is used to change the default state of the router's output pin.
[[File:{{{file_output_config}}}]]
| Field | Value | Description |
|---|---|---|
| Open collector output | Low level | High level; default: Low level | Changes the default* state of the open collector (OC) output pin. |
* 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.
ON/OFF
The ON/OFF section is used to turn the router's output on or off. This action does not save the state permanently, meaning that after a reboot the state will revert back to their default values.
[[File:{{{file_output_on_off}}}|border|class=tlt-border]]
Periodic control
The Periodic control 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]]
| Field | Value | Description |
|---|---|---|
| Enable | yes | no; default: no | Turns the rule on or off. |
| Output | Digital OC Output; default: Digital OC Output | The output pin that will be effected by the rule. |
| Action | On | Off; default: On | The action that will be performed on the output. |
| Action timeout | yes | no; default: no | Action timeout specifies whether an action should end after some time. For example, if action is set to on and timeout is set to 10, when the trigger occurs the output will turn on for 10 seconds before turning off. |
| Mode | Fixed | Interval; default: Fixed | When the rule will be triggered.
|
Scheduler
With the help of the output Scheduler you can configure a timetable of when the output should be enabled or disabled based on time.
[[File:{{{file_output_scheduler}}}|border|class=tlt-border]]
Post/Get
Enabling Post/Get 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]]
| Field | Value | Description |
|---|---|---|
| Enable | yes | no; default: no | Turns Post/Get on or off. |
| Username | string; default: none | Username used for authentication in POST/GET queries. |
| Password | string; default: none | Password used for authentication in POST/GET queries. |
Post/Get examples
It is possible to turn the 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_{{{series}}}_manual_input_output_post_get_examples_table|name={{{name}}}}}
Overview:
- 192.168.1.1 - router's default LAN IP address; replace it in accordance with your own configuration.
- username - login name from Post/Get configuration.
- password- password from Post/Get configuration.
- action- the action that will be performed on the output (can be on or off).
- pin - specifies the output (use oc).
- delay - defines a delay (in seconds) after which the specified action will be performed.
- 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.
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 on (or stay in on state if it was already that way), then after 5 more seconds it will switch to off state. In this case the overall command execution time is 15 seconds.
Additional Information
Input/Output hardware application examples:
- [[{{{name}}} Relay to Open Collector Output|Relay to Open Collector Output]]
[[Category:{{{name}}} Services section]]