Teltonika Networks Wiki

Changes

Template:Networking rut manual input output (view source)

Revision as of 12:10, 24 October 2023

1,290 bytes removed ,  12:10, 24 October 2023
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}}} }} }}"
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|{{{series}}}|{{{name}}}}}_manual_input_output_characteristics}}
+
{{Template:Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_characteristics|name={{{name}}}}}
    
==Status==
 
==Status==
   −
The <b>Status</b> section 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</b>. 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 31: Line 38:  
===Status and control from command line===
 
===Status and control from command line===
 
----
 
----
−
{{Template: rut955_webui_services_input_output_status_cli_io}}
+
{{Template: Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_cli}}
−
----
  −
{{Template: rut955_webui_services_input_output_status_cli_io_analog}}
      
==Input==
 
==Input==
   −
The '''Input''' section is used to configure Input rules and set Analog Input value check interval:
+
The <b>Input</b> tab is used to configure the router's input {{#ifeq:{{{name}}}|RUT955|pins|pin}}.
−
 
+
{{#ifeq:{{{name}}}|RUT955|
−
[[File:Services inputoutput input check v2.png]]
+
===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===
 
===Input Rules===
 
----
 
----
−
'''Input Rules''' provides you with the possibility to set up rules that execute specified actions after specified triggers occur.
+
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:Services inputoutput input configuration v2.png]]
+
[[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.
   −
<table class="nd-mantable">
+
{{#ifeq:{{{name}}}|RUT955
−
    <tr>
+
|[[File:{{{file_input_config}}}|border|class=tlt-border]]
−
        <th>field name</th>
+
|[[File:{{{file_input_config}}}|border|class=tlt-border]]}}
−
      <th>value</th>
  −
      <th>description</th>
  −
    </tr>
  −
    <tr>
  −
      <td>Enable</td>
  −
      <td>yes | no; Default: '''yes'''</td>
  −
      <td>Toggles the Input rule ON or OFF</td>
  −
    </tr>
  −
    <tr>
  −
      <td>Input type</td>
  −
      <td>Digital | Digital isolated | Analog; Default: '''Digital'''</td>
  −
      <td>Selects which Input is tied to the rule</td>
  −
    </tr>
  −
    <tr>
  −
    <td>Trigger</td>
  −
        <td>Input open | Input shorted | Both; Default: '''Input open'''</td>
  −
        <td>Specifies the Trigger after which the rule will take effect</td>
  −
    </tr>
  −
    <tr>
  −
    <td>Action</td>
  −
        <td>Send SMS | Change SIM card | Send email | Change profile | Turn on WiFi | Turn off WiFi | Reboot | Activate output | HTTP POST/GET; Default: '''Send SMS'''</td>
  −
        <td>Action to be taken after the Trigger takes place
     −
'''Send SMS''' - sends an SMS message to a specified number(s). The message text is custom
+
{{Template:Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_input_rule_table|name={{{name}}}}}
−
 
  −
'''Change SIM card''' - switches the SIM card that is currently in use
  −
 
  −
'''Send email''' - sends an email to the specified address. You will be prompted to enter your email account's authentication information
  −
 
  −
'''Change profile''' - switches the profile in use to the specified profile
  −
 
  −
'''Turn on WiFi/Turn off WiFi''' - turns WiFi ON or OFF
  −
 
  −
'''Reboot''' - reboots the router after a specified amount of time
  −
 
  −
'''Activate output''' - activates specified output
  −
 
  −
'''HTTP POST/GET''' - gets or posts data to HTTP</td>
  −
    </tr>
  −
</table>
      
==Output==
 
==Output==
   −
The '''Output''' section is used to configure the router's outputs: '''Relay''' Output and '''Open Collector''' ('''OC''') Output.
+
The <b>Output</b> tab is used to configure the router's output {{#ifeq:{{{name}}}|RUT955|pins|pin}}.
    
===Output Configuration===
 
===Output Configuration===
 
----
 
----
−
The '''Output Configuration''' tab is used to change the default states of the router's outputs.
+
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:Services inputoutput output configuration v2.png]]
+
{{#ifeq:{{{series}}}|RUT9XX
 +
|[[File:{{{file_output_config}}}|border|class=tlt-border]]
 +
|[[File:{{{file_output_config}}}]]
 +
}}
    
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
−
         <th>field name</th>
+
         <th>Field</th>
−
       <th>value</th>
+
       <th>Value</th>
−
       <th>description</th>
+
       <th>Description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Open collector output</td>
 
       <td>Open collector output</td>
−
       <td>High level | Low level; Default: '''Low level'''</td>
+
       <td>Low level | High level; default: <b>Low level</b></td>
−
       <td>Changes the default<span style="color:#0054A6;">'''*'''</span> state of the Open collector (OC) output</td>
+
       <td>Changes the default<span class="asterisk">*</span> state of the open collector (OC) output pin.</td>
−
     </tr>
+
     </tr>{{#ifeq:{{{name}}}RUT955|
 
     <tr>
 
     <tr>
 
       <td>Relay output</td>
 
       <td>Relay output</td>
−
       <td>Contacts open | Contacts closed; Default: '''Contacts closed'''</td>
+
       <td>Contacts open <nowiki>|</nowiki> Contacts closed; default: <b>Contacts closed</b></td>
−
       <td>Relay Output default state</td>
+
       <td>Changes the default<span class="asterisk">*</span> state of the relay output pin.</td>
−
     </tr>
+
     </tr>|}}
 
</table>
 
</table>
   −
<span style="color:#0054A6;">'''*'''</span> Changing the default state of an output means that the changes will be written into the input/output config and saved, therefore making the change permanent. This means that, unless some other related change occurs, the state of the output will remain as set in this section. Therefore, if the input/output service restarts or the device reboots, it will have no effect on the state of the output.
+
<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===
 
----
 
----
−
The '''ON/OFF''' section is used to turn Outputs ON or OFF, but it doesn't save the state permanently, meaning that after a reboot the states 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:Services inputoutput output onoff v2.png]]
+
[[File:{{{file_output_on_off}}}|border|class=tlt-border]]
   −
===Post/Get Configuration===
+
===Periodic control===
 
----
 
----
−
'''Post/Get Configuration''' allows you to perform action requests by writing them in the URL field after your device’s IP address.
+
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:Services inputoutput output post get v2.png]]
+
[[File:{{{file_output_periodic}}}|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
−
         <th>field name</th>
+
         <th>Field</th>
−
       <th>value</th>
+
       <th>Value</th>
−
       <th>description</th>
+
       <th>Description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Enable</td>
 
       <td>Enable</td>
−
       <td>yes | no; Default: '''no'''</td>
+
       <td>yes | no; default: <b>no</b></td>
−
       <td>Toggles POST/GET ON or OFF</td>
+
       <td>Turns the rule on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td>Username</td>
+
       <td>Output</td>
−
       <td>string; Default: " "</td>
+
       <td>Digital OC Output{{#ifeq:{{{name}}}|RUT955| {{!}} Digital 4PIN {{!}} Digital relay output|}}; default: <b>Digital OC Output</b> </td>
−
       <td>Username used for authentication in POST/GET queries</td>
+
       <td>The output pin that will be effected by the rule.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
     <td>Password</td>
+
     <td>Action</td>
−
         <td>string; Default: " "</td>
+
         <td>On | Off; default: <b>On</b></td>
−
         <td>Password used for authentication in POST/GET queries</td>
+
         <td>The action that will be performed on the output.</td>
 
     </tr>
 
     </tr>
−
</table>
  −
  −
====Post/Get usage====
  −
----
  −
{{Template: webui_services_input_output_post_get_configuration_usage}}
  −
  −
<table class="nd-othertables">
   
     <tr>
 
     <tr>
−
         <th style="width: 500px">ACTION</th>
+
    <td>Action timeout</td>
−
      <th style="width: 900px">POST/GET URL EXAMPLE</th>
+
         <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>
 
     <tr>
 
     <tr>
−
      <td>Turn Relay Output ON</td>
+
    <td>Mode</td>
−
      <td>http://192.168.1.1/cgi-bin/output?username=user1&password=user1&action=on&pin=relay</td>
+
        <td>Fixed | Interval; default: <b>Fixed</b></td>
−
    </tr>
+
        <td>When the rule will be triggered.
−
    <tr>
+
            <ul>
−
      <td>Turn Relay Output ON after a 10 second delay</td>
+
                <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>
−
      <td>http://192.168.1.1/cgi-bin/output?username=user1&password=user1&action=on&pin=relay&delay=10</td>
+
                <li><b>Interval</b> - performs the action at an interval. For example, every 1 hour during Mondays.</li>
−
    </tr>
+
            </ul>
−
    <tr>
+
         </td>
−
    <td>Turn Relay Output ON for 5 seconds</td>
  −
        <td>http://192.168.1.1/cgi-bin/output?username=user1&password=user1&action=on&pin=relay&time=5</td>
  −
    </tr>
  −
    <tr>
  −
    <td>Turn Relay Output ON for 5 seconds after a 15 second delay</td>
  −
        <td>http://192.168.1.1/cgi-bin/output?username=user1&password=user1&action=on&pin=relay&delay=15&time=5</td>
  −
    </tr>
  −
    <tr>
  −
      <td>Turn Relay Output OFF for 5 seconds after a 15 second delay</td>
  −
      <td>http://192.168.1.1/cgi-bin/output?username=user1&password=user1&action=off&pin=relay&delay=15&time=5</td>
  −
    </tr>
  −
    <tr>
  −
    <td>Turn Open Collector Output ON</td>
  −
        <td>http://192.168.1.1/cgi-bin/output?username=user1&password=user1&action=on&pin=oc</td>
  −
    </tr>
  −
    <tr>
  −
    <td>Turn Open Collector Output OFF</td>
  −
         <td>http://192.168.1.1/cgi-bin/output?username=user1&password=user1&action=off&pin=oc</td>
   
     </tr>
 
     </tr>
 
</table>
 
</table>
   −
'''Overview''':
+
===Scheduler===
−
* '''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
+
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.  
−
* '''password''' - password from Post/Get Configuration
  −
* '''action''' - the action that is to be performed on the specified Output (can be '''on''' or '''off''')
  −
* '''pin''' - specifies on which Output the action will be applied (can be '''oc''' or '''relay''')
  −
* '''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 for an output while specifying '''time=5''', that 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 ON), then after 5 more seconds it will switch to OFF state. In this case, the overall command execution time is 15 seconds.
+
[[File:{{{file_output_scheduler}}}|border|class=tlt-border]]
   −
Actions ON and OFF depend on setting „Output configuration in active state“ (ON is active state), which can be set via [[Input/Output#Output|Services → Input/Output → Output]]
+
==Post/Get==
   −
===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 and the table below provides information on the fields contained in that section:
−
----
  −
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]]
+
[[File:{{{file_output_post_get}}}|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
−
         <th>field name</th>
+
         <th>Field</th>
−
       <th>value</th>
+
       <th>Value</th>
−
       <th>description</th>
+
       <th>Description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Enable</td>
 
       <td>Enable</td>
−
       <td>yes | no; Default: '''no'''</td>
+
       <td>yes | no; default: <b>no</b></td>
−
       <td>Toggles the rule ON or OFF</td>
+
       <td>Turns Post/Get on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td>Output</td>
+
       <td>Username</td>
−
       <td>Digital OC output | Digital Relay output; Default: '''Digital OC output'''</td>
+
       <td>string; default: <b>none</b></td>
−
       <td>To which output the rule pertains </td>
+
       <td>Username used for authentication in POST/GET queries.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
     <td>Action</td>
+
     <td>Password</td>
−
         <td>On | Off; Default: '''On'''</td>
+
         <td>string; default: <b>none</b></td>
−
        <td>Periodic action to be taken</td>
+
         <td>Password used for authentication in POST/GET queries.</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>
 
     </tr>
 
</table>
 
</table>
   −
===Scheduler===
+
===Post/Get examples===
 
----
 
----
−
The '''Scheduler''' lets you configure a schedule of when certain outputs are to be enabled or disabled.
+
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:
   −
[[File:Services inputoutput output scheduler v2.png]]
+
{{Template:Networking_{{#ifeq:{{{name}}}|RUT955|{{lc:{{{name}}}}}|{{lc:{{{series}}}}}}}_manual_input_output_post_get_examples_table|name={{{name}}}}}
   −
==Additional Information==
+
<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>
   −
* Input/Output hardware application examples:
+
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.
−
** '''[[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]]'''
      +
{{#ifeq: {{{series}}} | RUT9XX ||
 +
==Additional Information==
   −
Hardware Application Examples:
+
<b>Input/Output hardware application examples:</b>
−
* '''[[RUT2xx_Connecting_relay_to_open_collector_output|Connecting relay to open collector output]]'''
     −
[[Category:{{{name}}} WebUI]]
+
<ul>
 +
    <li><b>[[{{{name}}} Relay to Open Collector Output|Relay to Open Collector Output]]</b></li>
 +
</ul>
 +
}}[[Category:{{{name}}} Services section]]
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/41318...115148"