Template:Networking rut manual input output: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
No edit summary
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
 
(41 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Template: Networking_device_manual_fw_disclosure
| series = {{{series}}}
| name  = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name  = {{{name}}}
}}
}}
==Summary==
==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 is overview on the Input/Output section for {{{name}}} routers.
<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.


{{Template: Networking_rutxxx_manual_fw_disclosure
This chapter of the user manual provides an overview of the Input/Output page for {{{name}}} devices.
| fw_version = {{{fw_version}}}
}}


==Characteristics==
==Characteristics==


{{Template:Networking_{{#ifeq:{{{series}}}|RUT2xx|{{lc:{{{series}}}}}|{{lc:{{{name}}}}}}}_manual_input_output_characteristics|name={{{name}}}}}
{{Template:Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_characteristics|name={{{name}}}}}


==Status==
==Status==


The <b>Status</b> tab displays the current states the router’s {{#ifeq:{{{series}}}|RUT9xx|inputs and outputs|input and output}}:
The <b>Status</b> tab displays the current states the router’s {{#ifeq:{{{series}}}|RUT9XX|inputs and outputs|input and output}}:


[[File:{{{file_status}}}]]
{{#ifeq:{{{name}}}|RUT955
|[[File:{{{file_status}}}|border|class=tlt-border]]
|[[File:{{{file_status}}}|border|class=tlt-border]]}}


===Custom Labels===
===Custom Labels===
Line 21: 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.
{{#ifeq:{{{series}}}|RUT9xx|----
{{#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.
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.


Line 30: Line 38:
===Status and control from command line===
===Status and control from command line===
----
----
{{Template: Networking_{{#ifeq:{{{series}}}|RUT2xx|{{lc:{{{series}}}}}|{{lc:{{{name}}}}}}}_manual_input_output_cli}}
{{Template: Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_cli}}


==Input==
==Input==
Line 38: Line 46:
===Check Analog===
===Check Analog===
----
----
The <b>Check Analog</b> section is used to set how often the router checks the value of the analog input. This 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.
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}}}]]|}}
[[File:{{{file_input_analog}}}]]|}}
Line 45: 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.


[[File:{{{file_input_config}}}]]
{{#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}}}}}
{{Template:Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_input_rule_table|name={{{name}}}}}
Line 55: Line 65:
==Output==
==Output==


The <b>Output</b> tab is used to configure the router's output {{ifeq:{{{name}}}|RUT955|pins|pin}}.
The <b>Output</b> tab is used to configure the router's output {{#ifeq:{{{name}}}|RUT955|pins|pin}}.


===Output Configuration===
===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}}.
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}}.


[[File:{{{file_output_config}}}]]
{{#ifeq:{{{series}}}|RUT9XX
|[[File:{{{file_output_config}}}|border|class=tlt-border]]
|[[File:{{{file_output_config}}}]]
}}


<table class="nd-mantable">
<table class="nd-mantable">
Line 71: Line 84:
     <tr>
     <tr>
       <td>Open collector output</td>
       <td>Open collector output</td>
       <td>Low level | High level; default: <b>High level</b></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>
       <td>Changes the default<span class="asterisk">*</span> state of the open collector (OC) output pin.</td>
     </tr>{{#ifeq:{{{name}}}RUT955|
     </tr>{{#ifeq:{{{name}}}RUT955|
Line 81: Line 94:
</table>
</table>


<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 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===
===ON/OFF===
Line 87: 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]]


===Post/Get configuration===
===Periodic control===
----
----
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 an the table below provides information on the fields contained in that section:
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_post_get}}}]]
[[File:{{{file_output_periodic}}}|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 104: Line 117:
       <td>Enable</td>
       <td>Enable</td>
       <td>yes | no; default: <b>no</b></td>
       <td>yes | no; default: <b>no</b></td>
       <td>Turns Post/Get on or off.</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>
     <tr>
     <tr>
      <td>Username</td>
    <td>Action timeout</td>
      <td>string; default: <b>none</b></td>
        <td>yes | no; default: <b>no</b></td>
      <td>Username used for authentication in POST/GET queries.</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>
     <tr>
     <tr>
     <td>Password</td>
     <td>Mode</td>
         <td>string; default: <b>none</b></td>
         <td>Fixed | Interval; default: <b>Fixed</b></td>
         <td>Password used for authentication in POST/GET queries.</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>
     </tr>
</table>
</table>


====Post/Get examples====
===Scheduler===
----
----
It is possible to turn the {{#ifeq:{{{name}}}|RUT955|outputs|output}} on and off by using a valid HTTP POST/GET syntax. Use a web browser or any other compatible software to submit HTTP POST/GET strings to the device.
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.  


Below is a table containing syntax examples of this usage:  
[[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-othertables_2">
<table class="nd-mantable">
     <tr>
     <tr>
         <th style="width: 500px">Action</th>
         <th>Field</th>
       <th style="width: 900px">POST/GET URL</th>
       <th>Value</th>
      <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Turn output on</td>
       <td>Enable</td>
       <td><nowiki>http://192.168.1.1/cgi-bin/output?username=user1&password=user1&</nowiki><span style="color: #0054a6;><b>action=on</b></span><nowiki>&pin=pin2</nowiki></td>
       <td>yes | no; default: <b>no</b></td>
      <td>Turns Post/Get on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Turn output off</td>
       <td>Username</td>
       <td><nowiki>http://192.168.1.1/cgi-bin/output?username=user1&password=user1&</nowiki><span style="color: #0054a6;><b>action=off</b></span><nowiki>&pin=pin2</nowiki></td>
       <td>string; default: <b>none</b></td>
      <td>Username used for authentication in POST/GET queries.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Turn output on after a 10 second delay</td>
     <td>Password</td>
      <td><nowiki>http://192.168.1.1/cgi-bin/output?username=user1&password=user1&action=on&pin=pin2&</nowiki><span style="color: #0054a6;><b>delay=10</b></span></td>
         <td>string; default: <b>none</b></td>
    </tr>
        <td>Password used for authentication in POST/GET queries.</td>
    <tr>
     <td>Turn output on for 5 seconds</td>
         <td><nowiki>http://192.168.1.1/cgi-bin/output?username=user1&password=user1&action=on&pin=pin2&</nowiki><span style="color: #0054a6;><b>time=5</b></span></td>
    </tr>
    <tr>
    <td>Turn output on for 5 seconds after a 10 second delay</td>
        <td><nowiki>http://192.168.1.1/cgi-bin/output?username=user1&password=user1&action=on&pin=pin2&</nowiki><span style="color: #0054a6;><b>delay=10&time=5</b></span></td>
     </tr>
     </tr>
</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.
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>:
<b>Overview</b>:
Line 157: Line 195:
     <li>password- password 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>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>pin2</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>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>
     <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>
Line 163: Line 201:


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.
<!--
===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.
[[File:Services inputoutput output periodic v2.png]]
<table class="nd-mantable">
    <tr>
        <th>field name</th>
      <th>value</th>
      <th>description</th>
    </tr>
    <tr>
      <td>Enable</td>
      <td>yes | no; Default: '''no'''</td>
      <td>Toggles the rule ON or OFF</td>
    </tr>
    <tr>
      <td>Output</td>
      <td>Digital OC output | Digital Relay output; Default: '''Digital OC output'''</td>
      <td>To which output the rule pertains </td>
    </tr>
    <tr>
    <td>Action</td>
        <td>On | Off; Default: '''On'''</td>
        <td>Periodic action to be taken</td>
    </tr>
    <tr>
    <td>Action timeout</td>
        <td>yes | no; Default: '''no'''</td>
        <td>Activates action timeout. Action timeout specifies whether an action should end after some time. For example, if the specified Action is to turn Digital OC output On and the action triggers, the Action timeout then turns Digital OC output back off after a specified amount of time in seconds specified in this field </td>
    </tr>
    <tr>
    <td>Timeout (sec)</td>
        <td>integer; Default: " "</td>
        <td>Specifies how long the Action timeout is</td>
    </tr>
    <tr>
    <td>Mode</td>
        <td>Fixed | Interval; Default: '''Fixed'''</td>
        <td>'''Fixed''' mode triggers the specified action on a specified day(s), hour and minute. For example, every Sunday at 8:30 AM<br>
'''Interval''' provides you with the possibility to set up an interval after which the same action takes place</td>
    </tr>
</table>
===Scheduler===
----
The '''Scheduler''' lets you configure a schedule of when certain outputs are to be enabled or disabled.
[[File:Services inputoutput output scheduler v2.png]]


{{#ifeq: {{{series}}} | RUT9XX ||
==Additional Information==
==Additional Information==


* Input/Output hardware application examples:
<b>Input/Output hardware application examples:</b>
** '''[[RUT955 Connecting relay to open collector output|Connecting relay to open collector output]]'''
** '''[[Inverting RUT955 relay output polarity|Inverting relay output polarity]]'''
** '''[[Using RUT955 Inputs for security applications|Using Inputs for security applications]]'''
** '''[[Current measurement with RUT955 analog input|Current measurement with analog input]]'''


 
<ul>
Hardware Application Examples:
    <li><b>[[{{{name}}} Relay to Open Collector Output|Relay to Open Collector Output]]</b></li>
* '''[[RUT2xx_Connecting_relay_to_open_collector_output|Connecting relay to open collector output]]'''
</ul>
-->
}}[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} WebUI]]

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.
  • Fixed - triggers the specified action on a specified day(s), hour and minute. For example, every Sunday at 8:30 AM.
  • Interval - performs the action at an interval. For example, every 1 hour during Mondays.

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]]

Retrieved from "https://wiki.teltonika-networks.com/index.php?title=Template:Networking_rut_manual_input_output&oldid=115148"