Jump to content
  • EN

Template:Networking rutos manual input output: Difference between revisions

From Teltonika Networks Wiki
← Older edit
VisualWikitext
No edit summary
No edit summary
 
(22 intermediate revisions by 2 users not shown)
Line 31: Line 31:


{{#switch: {{{name}}}  
{{#switch: {{{name}}}  
| TRB141 = [[File:Networking_trb141_manual_input_output_status_v5.png|border|class=tlt-border]]
| TRB141 = [[File:Networking_trb141_manual_input_output_status_v6.png|border|class=tlt-border]]
| RUTM55 = [[File:Networking rutm55 manual input output status.png|border|class=tlt-border]]
| RUTM55 = [[File:Networking rutm55 manual input output status_v1.png|border|class=tlt-border]]
| RUT955|RUT956|RUT906|RUT976 = [[File:Networking_RUT955_manual_input_output_status_v5.png|border|class=tlt-border]]
| RUT955|RUT956|RUT906|RUT976 = [[File:Networking_RUT956_manual_input_output_status_v1.png|border|class=tlt-border]]
| TRB245|TRB246|TRB255|TRB256 = [[File:Networking_trb2_manual_input_output_status_v4.png|border|class=tlt-border]]
| TRB245|TRB246|TRB255|TRB256|TRB247 = [[File:Networking_trb2_manual_input_output_status_v5.png|border|class=tlt-border]]
| RUTM30|RUTM31 = [[File:Networking_rut301_manual_input_output_status_v2.png|border|class=tlt-border]]
| RUTM30|RUTM31 = [[File:Networking_rut301_manual_input_output_status_v3.png|border|class=tlt-border]]
| #default = [[File:Networking_{{lc:{{{series}}}}}_manual_input_output_status_v2.png|border|class=tlt-border]]
| #default = [[File:Networking_{{lc:{{{series}}}}}_manual_input_output_status_v3.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.
{{#ifeq: {{{powersocket}}}|1|
 
  {{#ifeq: {{{configurableio}}}|1|
User can <b> Rename </b> Input/Output interface by clicking on the "Edit" button.
You can invert an Input pin or switch the state of an Output pin and change I/O direction by clicking on edit button in the "Actions" column. Also user can <b>Rename</b> Input/Output interface:
[[File:Networking_manual_configurable_input_output_configuration.png|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Custom name</td>
      <td>string; default: <b>none</b></td>
      <td>Sets custom name for this I/O.</td>
    </tr>
    <tr>
      <td>Custom names for</td>
      <td><b>Low state</b> (Sets custom low state name); <b>High state</b> (Sets custom high state name)</td>
      <td>Sets custom state names.</td>
    </tr>
    <tr>
      <td>I/O direction</td>
      <td>Input {{!}} <span style="color:blue">Output</span>; default: <b>none</b></td>
      <td>Sets custom state names.</td>
    </tr>
    <tr>
      <td>Invert input</td>
      <td>on {{!}} off; default: <b>off</b></td>
      <td>Inverts the input signal.</td>
    </tr>
    <tr>
      <td><span style="color:blue">Output state</span></td>
      <td>Low level {{!}} High level; default: <b>Low level</b></td>
      <td>Sets the state of the output.</td>
    </tr>
</table>
|You can invert an Input pin or switch the state of an Output pin by clicking on edit button in the "Actions" column. Also user can <b>Rename</b> Input/Output interface:
[[File:Networking_manual_input_output_configuration.png|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Custom name</td>
      <td>string; default: <b>none</b></td>
      <td>Sets custom name for this I/O.</td>
    </tr>
    <tr>
      <td>Custom names for</td>
      <td><b>Low state</b> (Sets custom low state name); <b>High state (Sets custom high state name)</b></td>
      <td>Sets custom state names.</td>
    </tr>
    <tr>
      <td><b>Iput pin:</b> Invert input</td>
      <td>on {{!}} off; default: <b>off</b></td>
      <td>Inverts the input signal.</td>
    </tr>
    <tr>
      <td><b>Output pin:</b>Output state</td>
      <td>Low level {{!}} High level; default: <b>Low level</b></td>
      <td>Sets the state of the output.</td>
    </tr>
</table>}}||}}


{{#switch: {{{name}}}  
{{#switch: {{{name}}}  
| TRB141 = '''Note:''' When dry/wet input is not connected to anything - the state of level is undetermined.
| TRB141 = '''Note:''' When dry/wet input is not connected to anything - the state of level is undetermined.
| #default =}}
| #default =}}
{{#switch: {{{name}}}|RUT955|RUT956|RUT906|TRB245|TRB246|TRB255|TRB141|TRB256|RUT976 =   
{{#switch: {{{name}}}|RUT955|RUT956|RUT906|TRB245|TRB246|TRB255|TRB141|TRB256|RUT976|TRB247|RUTM55 =   
'''Note:''' You can edit the adc/acl formula to customize values.
'''Note:''' You can edit the ADC/ACL formula to customize values and other Input/Output inversions, relays closures, if supported by the device, by clicking the edit button in the "Actions" column.


Custom I/O status labels for "Analog input":
<b>Example</b> - Custom I/O status labels for "Analog input":
[[File:Networking_manual_input_output_status_formula_adc0.png|border|class=tlt-border]]
[[File:Networking_manual_input_output_status_formula_adc0_v1.png|border|class=tlt-border]]


Custom I/O status labels for "Analog current loop":
<b>Example</b> - Custom I/O status labels for "Analog current loop":
[[File:Networking_manual_input_output_status_formula_acl0.png|border|class=tlt-border]]
[[File:Networking_manual_input_output_status_formula_acl0_v1.png|border|class=tlt-border]]
| #default =}}
| #default =}}


Line 82: Line 144:
<b>Note:</b> I/O Scheduler is additional software on some devices that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.
<b>Note:</b> I/O Scheduler is additional software on some devices that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.


[[File:Networking_rutos_manual_input_output_scheduler_general_configuration.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_scheduler_general_configuration_v1.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:
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]]
[[File:Networking_rutos_manual_input_output_scheduler_add_button_v1.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:
After this you should be redirected to the configuration page for the newly added Instance which should look similar to this:


{{#ifeq:{{{name}}}|RUTM55|[[File:Networking_rutos_manual_input_output_scheduler_instance_configuration_rutm55.png|border|class=tlt-border]]|[[File:Networking_rutos_manual_input_output_scheduler_instance_configuration_configurableio_{{{configurableio}}}.png|border|class=tlt-border]]}}
[[File:Networking_rutos_manual_input_output_scheduler_instance_configuration.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 103: Line 165:
       <td>Turns the Scheduler Instance on or off.</td>
       <td>Turns the Scheduler Instance on or off.</td>
     </tr>
     </tr>
    {{#ifeq:{{{name}}}|RUTM55|
     <tr>
     <tr>
       <td>Pin</td>
       <td>Pin</td>
       <td>Isolated Output (3,4,11) {{!}} Relay (5,13); default: Isolated Output (3,4,11) <b></b></td>
       <td>output pin; default: <b>P. S. Different devices have different output settings.</b></td>
      <td>Pin whose output will be enabled for the selected interval.</td>
    </tr>|
    <tr>
      <td>Pin</td>
      <td>output pin; default: <b>{{#ifeq:{{{configurableio}}}|1|Configurable Input/Output (3)|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>
       <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>
     <tr>
     <tr>
       <td>Interval Type</td>
       <td>Interval Type</td>
Line 146: Line 202:
</table>
</table>


A Scheduler Instance will not work unless you turn both the the Scheduler service and the individual instance on:
<b>Note:</b> 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==


The <b>I/O Juggler</b> is a feature that provides the possibility to create automated rules that perform certain actions based on Input state changes and other conditions. The operating sequence of I/O Juggler can be visualized as such:
The <b>I/O Juggler</b> is a feature that provides the possibility to create automated rules that perform certain actions based on Input state changes and other conditions. The operating sequence of I/O Juggler can be visualized as such:
<b>Note:</b> I/O Juggler is additional software on some devices that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.


[[File:Networking_rutos_manual_input_output_io_juggler_scheme_condition_mobile_{{{mobile}}}.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_scheme_condition_mobile_{{{mobile}}}.png|border|class=tlt-border]]
Line 188: Line 244:
Before you can use the I/O Juggler, you must turn it on first (off by default). This can be done by setting the 'Enable' slider to "on"{{#ifeq:{{{configurableio}}}|1|<span class="asterisk">*</span>|}}:
Before you can use the I/O Juggler, you must turn it on first (off by default). This can be done by setting the 'Enable' slider to "on"{{#ifeq:{{{configurableio}}}|1|<span class="asterisk">*</span>|}}:


[[File:Networking_rutos_manual_input_output_io_juggler_general_enabled.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_general_enabled_v1.png|border|class=tlt-border]]
{{#ifeq:{{{configurableio}}}|1|<span class="asterisk">*</span> Input rules for Configurable I/O will work only when the type of the pin is set to "input"|}}
{{#ifeq:{{{configurableio}}}|1|<span class="asterisk">*</span> Input rules for Configurable I/O will work only when the type of the pin is set to "input"|}}
====Input====
====Input====
Line 196: Line 252:
The Input list is empty by default. To create a new Input Rule, look to the Add Input section at the bottom of the page; select an input and click the 'Add' button:
The Input list is empty by default. To create a new Input Rule, look to the Add Input section at the bottom of the page; select an input and click the 'Add' button:


[[File:Networking_rutos_manual_input_output_io_juggler_general_input_add_button_juggler_input_{{{juggler_input}}}.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_general_input_add_button_juggler_input.png|border|class=tlt-border]]


After this you will be redirected to the configuration page for the newly added Rule, which should look similar to this:
After this you will be redirected to the configuration page for the newly added Rule, which should look similar to this:


[[File:Networking_rutos_manual_input_output_io_juggler_general_input_configuration_juggler_input_{{{juggler_input}}}.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_general_input_configuration_juggler_input.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 239: Line 295:
The <b>Actions</b> section is used to manage and create new Actions that can be executed by the I/O Juggler Rules. The figure below is an example of the Actions section, which is empty by default.
The <b>Actions</b> section is used to manage and create new Actions that can be executed by the I/O Juggler Rules. The figure below is an example of the Actions section, which is empty by default.


[[File:Networking_rutos_manual_input_output_io_juggler_actions_actions.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_actions_actions_v1.png|border|class=tlt-border]]


To create a new Action, look to the Add an Action section at the bottom of the page; enter a custom name, select an action type and click the 'Add' button:
To create a new Action, click the 'Add' button.
 
[[File:Networking_rutos_manual_input_output_io_juggler_actions_add_button.png|border|class=tlt-border]]


After this you will be redirected to the configuration page for the newly added Action, which should look similar to this (example for action 'Type: Reboot'):
After this you will be redirected to the configuration page for the newly added Action, which should look similar to this (example for action 'Type: Reboot'):


[[File:Networking_rutos_manual_input_output_io_juggler_actions_configuration_reboot.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_actions_configuration_reboot_v1.png|border|class=tlt-border]]


<b>Action configuration</b> depends on the selected action 'Type'. Each Action can have one or multiple user-defined [[#Conditions|Conditions]] assigned to it. Actions that have Conditions assigned to them are executed only if the Conditions are met (a trigger occurrence is not enough to set off these actions). Assigning to Actions is optional.
<b>Action configuration</b> depends on the selected action 'Type'. Each Action can have one or multiple user-defined [[#Conditions|Conditions]] assigned to it. Actions that have Conditions assigned to them are executed only if the Conditions are met (a trigger occurrence is not enough to set off these actions). Assigning to Actions is optional.
Line 257: Line 311:
Sends an email to specified recipients. Requires an existing email account configuration on the device. Email accounts can be configured in the System → Administration → Recipients → [[{{{name}}}_Administration#Email_Accounts|Email Accounts]] page.
Sends an email to specified recipients. Requires an existing email account configuration on the device. Email accounts can be configured in the System → Administration → Recipients → [[{{{name}}}_Administration#Email_Accounts|Email Accounts]] page.


{{#switch: {{{name}}}
[[File:Networking rutos manual input output io juggler actions email v3.png|border|class=tlt-border]]
| RUTX12| RUTM12 =  [[File:Networking rutos manual input output io juggler actions email rutx12 v2.png|border|class=tlt-border]]
| RUTX10 = [[File:Networking_rutos_manual_input_output_io_juggler_actions_email_rutx10_v2.png|border|class=tlt-border]]
| #default = [[File:Networking rutos manual input output io juggler actions email v2.png|border|class=tlt-border]]
}}


<table class="nd-mantable">
<table class="nd-mantable">
Line 268: Line 318:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
        <td>Name</td>
        <td>string; default: <b>none</b></td>
        <td>Name of action.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Subject</td>
         <td>Subject</td>
         <td>string; default: <b>none</b></td>
         <td>string; default: <b>none</b></td>
         <td>Subject of email.</td>
         <td>Subject of an email.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 283: Line 338:
         <td>positive integer; default: <b>none</b></td>
         <td>positive integer; default: <b>none</b></td>
         <td>A period of time (in seconds) which has to pass after a trigger event before the action is executed.</td>
         <td>A period of time (in seconds) which has to pass after a trigger event before the action is executed.</td>
     </tr>{{#switch: {{{name}}}
     </tr>{{#ifeq: {{{dualmodem}}}| 1 |
| RUTX12| RUTM12 =
     <tr>
     <tr>
         <td>Modem</td>
         <td>Modem</td>
Line 291: Line 345:
     </tr>|}}
     </tr>|}}
     <tr>
     <tr>
         <td>Email account</td>
         <td>Sender's email account</td>
         <td>email account; default: <b>none</b></td>
         <td>email account; default: <b>none</b></td>
         <td>Email account used to send the email. Email accounts can be configured in the System → Administration → Recipients → [[{{{name}}}_Administration#Email_Accounts|Email Accounts]] page.</td>
         <td>Email account used to send the email. Email accounts can be configured in the System → Administration → Recipients → [[{{{name}}}_Administration#Email_Accounts|Email Accounts]] page.</td>
Line 299: Line 353:
         <td>email; default: <b>none</b></td>
         <td>email; default: <b>none</b></td>
         <td>Email address(es) of the message's receiver(s).</td>
         <td>Email address(es) of the message's receiver(s).</td>
    </tr>
    <tr>
        <td>Add conditions</td>
        <td>list; default: <b>none</b></td>
        <td>Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.</td>
     </tr>
     </tr>
</table>
</table>
Line 306: Line 365:
Changes the state of a selected output pin.
Changes the state of a selected output pin.


[[File:Networking_rutos_manual_input_output_io_juggler_actions_output_configurableio_{{{configurableio}}}.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_actions_output.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 313: Line 372:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
        <td>Name</td>
        <td>string; default: <b>none</b></td>
        <td>Name of action.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 321: Line 385:
     <tr>
     <tr>
         <td>Control</td>
         <td>Control</td>
         <td>output; default: <b>{{#ifeq:{{{configurableio}}}|1|Configurable Input/Output (3)|Output (4)}}</b></td>
         <td>output pin; default: <b>P. S. Different devices have different output settings.</b></td>
         <td>Selects the output controlled by this Action.</td>
         <td>Specifies the output/relay of which the state will be changed.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 331: Line 395:
     <tr>
     <tr>
         <td>Maintain</td>
         <td>Maintain</td>
         <td>off | on; default: <b>on</b></td>
         <td>off {{!}} on; default: <b>on</b></td>
         <td>When set to 'on', the output maintains its new state after reboot (the state is changed in the config file as well).</td>
         <td>When set to 'on', the output maintains its new state after reboot (the state is changed in the config file as well).</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Invert</td>
         <td>Invert</td>
         <td>off | on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Inverts the state of the selected output, i.e., switches the output pin to a state that is opposite to its current one (high-to-low or low-to-high). This can be used instead of specifying a static state.</td>
         <td>Inverts the state of the selected output, i.e., switches the output pin to a state that is opposite to its current one (high-to-low or low-to-high). This can be used instead of specifying a static state.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>State copying</td>
         <td>State copying</td>
         <td>off | on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Copies the state from the selected input and applies it to the selected output. This can be used instead of specifying a static state.</td>
         <td>Copies the state from the selected input and applies it to the selected output. This can be used instead of specifying a static state.</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 the state of the output pin that will be set by this Action.</td>
         <td>Specifies the state of the output pin that will be set by this Action.</td>
    </tr>
    <tr>
        <td>Add conditions</td>
        <td>list; default: <b>none</b></td>
        <td>Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.</td>
     </tr>
     </tr>
</table>
</table>
Line 355: Line 424:
Executes a HTTP POST/GET request.
Executes a HTTP POST/GET request.


[[File:Networking_rutos_manual_input_output_io_juggler_actions_http_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_actions_http_v3.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 362: Line 431:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
        <td>Name</td>
        <td>string; default: <b>none</b></td>
        <td>Name of action.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 402: Line 476:
         <td>positive integer; default: <b>none</b></td>
         <td>positive integer; default: <b>none</b></td>
         <td>A period of time (in seconds) which has to pass after a trigger event before this Action is executed.</td>
         <td>A period of time (in seconds) which has to pass after a trigger event before this Action is executed.</td>
    </tr>
    <tr>
        <td>Add conditions</td>
        <td>list; default: <b>none</b></td>
        <td>Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.</td>
     </tr>
     </tr>
</table>
</table>
Line 409: Line 488:
Executes a custom, user-written shell script.
Executes a custom, user-written shell script.


{{#switch: {{{name}}}
[[File:Networking_rutos_manual_input_output_io_juggler_actions_script_v1.png|border|class=tlt-border]]
| RUTX10 = [[File:Networking_rutos_manual_input_output_io_juggler_actions_script_rutx10_v1.png|border|class=tlt-border]]
| #default = [[File:Networking_rutos_manual_input_output_io_juggler_actions_script.png|border|class=tlt-border]]
}}
 


<table class="nd-mantable">
<table class="nd-mantable">
Line 420: Line 495:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
        <td>Name</td>
        <td>string; default: <b>none</b></td>
        <td>Name of action.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 440: Line 520:
         <td>string; default: <b>none</b></td>
         <td>string; default: <b>none</b></td>
         <td>Optional arguments which can be provided for the script. You can include device information with values given below this input field.</td>
         <td>Optional arguments which can be provided for the script. You can include device information with values given below this input field.</td>
    </tr>
    <tr>
        <td>Add conditions</td>
        <td>list; default: <b>none</b></td>
        <td>Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.</td>
     </tr>
     </tr>
</table>
</table>
Line 447: Line 532:
Reboots the device.
Reboots the device.


[[File:Networking_rutos_manual_input_output_io_juggler_actions_reboot.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_actions_reboot_v1.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 454: Line 539:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
        <td>Name</td>
        <td>string; default: <b>none</b></td>
        <td>Name of action.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 459: Line 549:
         <td>positive integer; default: <b>none</b></td>
         <td>positive integer; default: <b>none</b></td>
         <td>A period of time (in seconds) which has to pass after a trigger event before this Action is executed.</td>
         <td>A period of time (in seconds) which has to pass after a trigger event before this Action is executed.</td>
    </tr>
    <tr>
        <td>Add conditions</td>
        <td>list; default: <b>none</b></td>
        <td>Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.</td>
     </tr>
     </tr>
</table>
</table>
Line 466: Line 561:
Switches to using a specified Configuration Profile.
Switches to using a specified Configuration Profile.


[[File:Networking_rutos_manual_input_output_io_juggler_actions_profile.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_actions_profile_v1.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 473: Line 568:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
        <td>Name</td>
        <td>string; default: <b>none</b></td>
        <td>Name of action.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 483: Line 583:
         <td>profile; default: <b>default</b> </td>
         <td>profile; default: <b>default</b> </td>
         <td>Configuration Profile that will be applied by this Action. Configuration Profiles can be defined in the System → [[{{{name}}}_Profiles|Profiles]] page.</td>
         <td>Configuration Profile that will be applied by this Action. Configuration Profiles can be defined in the System → [[{{{name}}}_Profiles|Profiles]] page.</td>
    </tr>
    <tr>
        <td>Add conditions</td>
        <td>list; default: <b>none</b></td>
        <td>Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.</td>
     </tr>
     </tr>
</table>
</table>
Line 490: Line 595:
Enables or disables RMS service.
Enables or disables RMS service.


[[File:Networking_rutos_manual_input_output_io_juggler_actions_rms_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_actions_rms_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 497: Line 602:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
        <td>Name</td>
        <td>string; default: <b>none</b></td>
        <td>Name of action.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 507: Line 617:
         <td>off {{!}} on; default: <b>off</b> </td>
         <td>off {{!}} on; default: <b>off</b> </td>
         <td>Specifies whether RMS service will be enabled or disabled with this action.</td>
         <td>Specifies whether RMS service will be enabled or disabled with this action.</td>
    </tr>
    <tr>
        <td>Add conditions</td>
        <td>list; default: <b>none</b></td>
        <td>Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.</td>
     </tr>
     </tr>
</table>
</table>
Line 514: Line 629:
Executes a MQTT action.
Executes a MQTT action.


{{#switch: {{{name}}}
[[File:Networking rutos manual input output io juggler actions mqtt_v2.png|border|class=tlt-border]]
| RUTX10 = [[File:Networking_rutos_manual_input_output_io_juggler_actions_mqtt_rutx10_v1.png|border|class=tlt-border]]
| #default = [[File:Networking rutos manual input output io juggler actions mqtt_v1.png|border|class=tlt-border]]
}}


<table class="nd-mantable">
<table class="nd-mantable">
Line 524: Line 636:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
        <td>Name</td>
        <td>string; default: <b>none</b></td>
        <td>Name of action.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 623: Line 740:
Switches to using the specified SIM card.
Switches to using the specified SIM card.


[[File:Networking_rutos_manual_input_output_io_juggler_actions_change_sim_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_actions_change_sim_v3.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 630: Line 747:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
        <td>Name</td>
        <td>string; default: <b>none</b></td>
        <td>Name of action.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 650: Line 772:
         <td>SIM1 {{!}} SIM2; default: <b>SIM1</b></td>
         <td>SIM1 {{!}} SIM2; default: <b>SIM1</b></td>
         <td>Selects a SIM card to switch to. This field is visible only when the 'Flip' field is set to 'off'.</td>
         <td>Selects a SIM card to switch to. This field is visible only when the 'Flip' field is set to 'off'.</td>
    </tr>
    <tr>
        <td>Add conditions</td>
        <td>list; default: <b>none</b></td>
        <td>Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.</td>
     </tr>
     </tr>
</table>
</table>
Line 658: Line 785:
Sends an SMS message to specified recipients.
Sends an SMS message to specified recipients.


[[File:Networking_rutos_manual_input_output_io_juggler_actions_sms.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_actions_sms_v1.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 665: Line 792:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
        <td>Name</td>
        <td>string; default: <b>none</b></td>
        <td>Name of action.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 685: Line 817:
         <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>
        <td>Add conditions</td>
        <td>list; default: <b>none</b></td>
        <td>Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.</td>
     </tr>
     </tr>
</table>
</table>
Line 693: Line 830:
Sends an SMS message to specified recipients.
Sends an SMS message to specified recipients.


[[File:Networking_rutos_manual_input_output_io_juggler_actions_wifi_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_actions_wifi_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 700: Line 837:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
        <td>Name</td>
        <td>string; default: <b>none</b></td>
        <td>Name of action.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 710: Line 852:
         <td>off {{!}} on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Specifies whether all WiFi interfaces will be enabled/disabled with this action.</td>
         <td>Specifies whether all WiFi interfaces will be enabled/disabled with this action.</td>
    </tr>
    <tr>
        <td>Add conditions</td>
        <td>list; default: <b>none</b></td>
        <td>Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.</td>
     </tr>
     </tr>
</table>
</table>
Line 718: Line 865:
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.
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_rutos_manual_input_output_io_juggler_conditions.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_conditions_v1.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.
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_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.
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.
Line 730: Line 875:
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.
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]]
[[File:Networking_rutos_manual_input_output_io_juggler_conditions_io.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 737: Line 882:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
        <td>Name</td>
        <td>string; default: <b>none</b></td>
        <td>Name of condition.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>I/O</td>
         <td>I/O</td>
         <td>inputs/outputs; default: <b>Output(3)</b></td>
         <td>inputs/outputs; default: <b>P. S. Different devices have different output settings.</b></td>
         <td>Specifies the I/O pin to which this Condition is listening to.</td>
         <td>Specifies the I/O to which the 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 in in order for the Condition to be met.</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 |
{{#ifeq: {{{analog}}} | 1 |
====Condition type: Analog voltage====
====Condition type: ADC/ACL====
----
----
Analog voltage Condition type measures the value of the Analog input and checks whether it inside or outside the user-specified range.
Analog voltage/current 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]]
[[File:Networking_rutos_manual_input_output_io_juggler_conditions_analog_voltage_v1.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 761: Line 912:
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
    </tr>
    <tr>
        <td>Name</td>
        <td>string; default: <b>none</b></td>
        <td>Name of condition.</td>
    </tr>
    <tr>
        <td>Input</td>
        <td><span style="color:blue">Analog Current Loop</span> {{!}} Analog Input; default: <b>Analog Current Loop</b></td>
        <td>Specifies the analog input to which the condition is listening to.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Condition</td>
         <td>Condition</td>
         <td>Inside voltage {{!}} Outside voltage; default: <b>Inside voltage</b> </td>
         <td>Inside range {{!}} Outside range; default: <b>Inside range</b> </td>
         <td>Whether to evaluate the condition as true inside or outside the specified range.</td>
         <td>Whether to evaluate the condition as true inside or outside the specified range.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Input</td>
         <td><span style="color:blue">ACL Property</span></td>
         <td>inputs; default: <b>none</b></td>
        <td>Current {{!}} Percent; default: <b>Current</b> </td>
         <td>Specifies the analog input to which the condition is listening to.</td>
        <td>Select which property - ampere or percentage the condition listens to.</td>
    </tr>
    <tr>
        <td><span style="color:blue">Min current/percent</span></td>
        <td>positive float; default: <b>none</b></td>
        <td>Specifies minimum current of the range. Values between 4-20mA / Specifies minimum percent of the range.</td>
    </tr>
    <tr>
         <td><span style="color:blue">Max current/percent</span></td>
        <td>positive float; default: <b>none</b></td>
         <td>Specifies maximum current of the range. Values between 4-20mA. / Specifies maximum percent of the range.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 782: Line 953:
         <td>Specifies magimum voltage of range.</td>
         <td>Specifies magimum voltage of range.</td>
     </tr>
     </tr>
</table>
</table>|}}
|}}
 
====Condition type: Boolean group====
====Condition type: Boolean group====
----
----
Line 805: Line 976:
Below is an example of Condition type: Boolean group configuration.
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]]
[[File:Networking_rutos_manual_input_output_io_juggler_conditions_boolean_group_v1.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 821: Line 992:
         <td>Add conditions</td>
         <td>Add conditions</td>
         <td>conditions; default: <b>none</b> </td>
         <td>conditions; default: <b>none</b> </td>
         <td>Specifies conditions which have to be met for action to occur.</td>
         <td>Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.</td>
     </tr>
     </tr>
</table>
</table>
Line 837: Line 1,008:
</ul>
</ul>


[[File:Networking_rutos_manual_input_output_io_juggler_conditions_date_time.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_conditions_date_time_v1.png|border|class=tlt-border]]


Each type can be configured in two distinct ways:
Each type can be configured in two distinct ways:
Line 924: Line 1,095:
     <tr>
     <tr>
         <td>GPIO pin</td>
         <td>GPIO pin</td>
         <td>{{#ifeq: {{{configurableio}}} | 1 | Configurable Input/Output (3) {{!}} Configurable Input/Output (4) | Input (3)}}; default: <b>{{#ifeq: {{{configurableio}}} | 1 | Configurable Input/Output (3) | Input (3)}}</b></td>
         <td>{{#ifeq: {{{configurableio}}} | 1 | Configurable Input/Output (3) {{!}} Configurable Input/Output (4) | Input (3)}}{{#ifeq: {{{isolated}}} | 1 | {{!}} Isolated Input (2,7)|}} {{#ifeq: {{{digitalpassive}}} | 1 | {{!}} Digital Input (1)|}}; default: <b>{{#ifeq: {{{configurableio}}} | 1 | Configurable Input/Output (3) | Input (3)}}</b></td>
         <td>Select GPIO pin for input configuration.</td>
         <td>Select GPIO pin for input configuration.</td>
     </tr>
     </tr>

Latest revision as of 15:18, 21 November 2025

The information in this page is updated in accordance with firmware version .


Summary

Inputs and outputs are used for monitoring and controlling 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 section for {{{name}}} devices.

Physical characteristics and I/O pin mapping

Electrical characteristics and I/O pin mapping information are presented below.

Power Socket Pinout

[[File:Networking_rutos_manual_input_output_power_socket_pinout_configurableio_{{{configurableio}}}.png]]

  • Power: {{{input_volts}}} VDC positive (+).
  • Ground: negative/ground (-).
  • Input: digital non-isolated input.
    • logical low level: 0 - 6 VDC;
    • logical high level: 8 - <Power supply> VDC.
  • Output: digital open collector (OC) output; 30 VDC, 300 mA.


Status

The Status page displays the current states of the device's input and output pins:

[[File:Networking_{{{series}}}_manual_input_output_status_v3.png|border|class=tlt-border]]




Status from command line

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:

{{Template:Networking_{{{series}}}_manual_input_output_status|name={{{name}}}}}


Scheduler

The output Scheduler 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.

Note: I/O Scheduler is additional software on some devices that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.

The Scheduler is configured in the form of Instances. 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:

After this you should be redirected to the configuration page for the newly added Instance which should look similar to this:

Field Value Description
Enable off | on; default: off Turns the Scheduler Instance on or off.
Pin output pin; default: P. S. Different devices have different output settings. Output pin. The state of the selected output will be set to "High" during the time interval defined in the fields below.
Interval Type Weekdays | Month Days; default: Weekdays Selects the interval type for scheduler to use.
Start Day [Monday..Sunday] | [1..31]; default: Monday | 1 The day that marks the start of the time interval.
Start Time hh:mm ([00..23]:[00..59]); default: 12:00 The hour and minute that mark the start of the time interval.
End Day [Monday..Sunday] | [1..31]; default: Tuesday | 1 The day that marks the end of the time interval.
End Time hh:mm ([00..23]:[00..59]); default: 12:00 The hour and minute that mark the end of the time interval.
Force Last Day off | on; default: off 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 Month Days.

Note: A Scheduler Instance will not work unless you turn both the the Scheduler service and the individual instance on.

I/O Juggler

The I/O Juggler is a feature that provides the possibility to create automated rules that perform certain actions based on Input state changes and other conditions. The operating sequence of I/O Juggler can be visualized as such:

Note: I/O Juggler is additional software on some devices that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.

[[File:Networking_rutos_manual_input_output_io_juggler_scheme_condition_mobile_{{{mobile}}}.png|border|class=tlt-border]]

When an Input Trigger occurs, the Input check to see if user-specified conditions are also met. If so, it executes a user-specified action.

For example, if we configure the I/O Juggler like this:

  • Trigger - input state rising.
  • Condition - 8:00 AM - 5:00 PM.
  • Action - send email.

The operating sequence would look like this:

  1. A connected device raises the input state.
  2. This {{{name}}} device checks whether the current time is between 8:00 AM and 5:00 PM.
    • Yes - {{{name}}} sends an email.
    • No - {{{name}}} doesn't send an email.

You can specify multiple actions and multiple conditions for any I/O Juggler rule. Selecting conditions is optional. If there are no set or configured I/O Juggler conditions, the operating sequence is as such:

[[File:Networking_rutos_manual_input_output_io_juggler_scheme_mobile_{{{mobile}}}.png]]

General

The General section is used to Input Trigger rules, which can perform a specified user-configured action when the Input state changes and when certain other user-configured conditions are met (conditions are optional).

Before you can use the I/O Juggler, you must turn it on first (off by default). This can be done by setting the 'Enable' slider to "on":

Input

The Input is used to create Input Rules. An Input Rule is triggered by a user-specified input state change. When this trigger occurs, the device executes a specified command if certain specified conditions are met (conditions are optional).

The Input list is empty by default. To create a new Input Rule, look to the Add Input section at the bottom of the page; select an input and click the 'Add' button:

After this you will be redirected to the configuration page for the newly added Rule, which should look similar to this:

Field Value Description
Enabled off | on; default: off Changes current profile to specified one when action triggers.
Trigger interval integer [0..99999999]; default: 1 The shortest amount of time (in seconds) between two triggers. If the input is triggered more than once in a time period shorter than the value specified in this field, the device will react to the first trigger.
Trigger Rising | Falling | Both; default: Rising Input state change that will trigger this rule.
Add actions i/o juggler action(s); default: none Actions that will be executed by this rule when the specified trigger and conditions (optional) occur.
Add conditions i/o juggler conditions; default: none Conditions that have to be met for the rule to take action. Conditions are optional.

Actions

The Actions section is used to manage and create new Actions that can be executed by the I/O Juggler Rules. The figure below is an example of the Actions section, which is empty by default.

To create a new Action, click the 'Add' button.

After this you will be redirected to the configuration page for the newly added Action, which should look similar to this (example for action 'Type: Reboot'):

Action configuration depends on the selected action 'Type'. Each Action can have one or multiple user-defined Conditions assigned to it. Actions that have Conditions assigned to them are executed only if the Conditions are met (a trigger occurrence is not enough to set off these actions). Assigning to Actions is optional.

You will find descriptions of each different action Type described on the sections below.

Type: Email

Sends an email to specified recipients. Requires an existing email account configuration on the device. Email accounts can be configured in the System → Administration → Recipients → [[{{{name}}}_Administration#Email_Accounts|Email Accounts]] page.

Field Value Description
Name string; default: none Name of action.
Subject string; default: none Subject of an email.
Text message string; default: none Email body text. Below this field you can find special codes that begin with the '%' sign. Each code represents a piece information related to the status of the device. Include these codes in the Text message for dynamic information reports.
Execution delay positive integer; default: none A period of time (in seconds) which has to pass after a trigger event before the action is executed.
Sender's email account email account; default: none Email account used to send the email. Email accounts can be configured in the System → Administration → Recipients → [[{{{name}}}_Administration#Email_Accounts|Email Accounts]] page.
Recipient's email address email; default: none Email address(es) of the message's receiver(s).
Add conditions list; default: none Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.

Type: Output

Changes the state of a selected output pin.

Field Value Description
Name string; default: none Name of action.
Execution delay positive integer; default: none A period of time (in seconds) which has to pass after a trigger event before this Action is executed.
Control output pin; default: P. S. Different devices have different output settings. Specifies the output/relay of which the state will be changed.
Revert integer; default: 0 After how many seconds the state will revert. If left as 0 or empty the state will not revert.
Maintain off | on; default: on When set to 'on', the output maintains its new state after reboot (the state is changed in the config file as well).
Invert off | on; default: off Inverts the state of the selected output, i.e., switches the output pin to a state that is opposite to its current one (high-to-low or low-to-high). This can be used instead of specifying a static state.
State copying off | on; default: off Copies the state from the selected input and applies it to the selected output. This can be used instead of specifying a static state.
State High | Low; default: High Specifies the state of the output pin that will be set by this Action.
Add conditions list; default: none Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.

Type: HTTP

Executes a HTTP POST/GET request.

Field Value Description
Name string; default: none Name of action.
Method Get | Post; default: Get HTTP method to be used by this Action.
URL string; default: none URL to send the HTTP Post/Get request to.
Verify off | on; default: off Verifies the validity of certificates; only used with HTTPS.
Alt. parameters mode off | on; default: off Choose a different way to pass parameters. If method is POST parameters are passed in request body. If method is GET parameters are passed throught the URL.
Parameters string; default: none Parameters that are to be included the Post/Get request. Select a parameter (right drop-down box) and enter a custom name for it (left text box).
Text message default: Device name - %rn; Time stamp - %ts Message to send.
Custom headers string; default: none Allows to add custom headers to the HTTP requests.
Execution delay positive integer; default: none A period of time (in seconds) which has to pass after a trigger event before this Action is executed.
Add conditions list; default: none Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.

Type: Script

Executes a custom, user-written shell script.

Field Value Description
Name string; default: none Name of action.
Execution delay positive integer; default: none A period of time (in seconds) which has to pass after a trigger event before this Action is executed.
Specify path Upload a script |Specify path; default: Upload a script Specifies whether the script should be uploaded from an external file or a path to an internal (on this device) script file should be specified.
Custom script | Script file -(interactive button) | filepath 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.
Arguments string; default: none Optional arguments which can be provided for the script. You can include device information with values given below this input field.
Add conditions list; default: none Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.

Type: Reboot

Reboots the device.

Field Value Description
Name string; default: none Name of action.
Execution delay positive integer; default: none A period of time (in seconds) which has to pass after a trigger event before this Action is executed.
Add conditions list; default: none Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.

Type: Profile

Switches to using a specified Configuration Profile.

Field Value Description
Name string; default: none Name of action.
Execution delay positive integer; default: none A period of time (in seconds) which has to pass after a trigger event before this Action is executed.
Profile profile; default: default Configuration Profile that will be applied by this Action. Configuration Profiles can be defined in the System → [[{{{name}}}_Profiles|Profiles]] page.
Add conditions list; default: none Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.

Type: RMS

Enables or disables RMS service.

Field Value Description
Name string; default: none Name of action.
Execution delay positive integer; default: none A period of time (in seconds) which has to pass after a trigger event before this Action is executed.
Enable RMS off | on; default: off Specifies whether RMS service will be enabled or disabled with this action.
Add conditions list; default: none Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.

Type: MQTT

Executes a MQTT action.

Field Value Description
Name string; default: none Name of action.
Text message string; default: none Below this field you can find special codes that begin with the '%' sign. Each code represents a piece information related to the status of the device. Include these codes in the Text message for dynamic information reports.
Topic string; default: none The name of the topic that the broker will subscribe to.
Client ID string; default: none Client ID to send with the data. If empty, a random client ID will be generated.
Hostname host | ip; default: none Broker’s IP address or hostname.
Port integer [0..65535]; default: 1883 Broker's port number.
Keepalive positive integer; default: none The number of seconds after which the broker should send a PING message to the client if no other messages have been exchanged in that time
Qos At most once (0) | At least once (1) | Exactly once (2); default: At most once (0) A period of time (in seconds) which has to pass after a trigger event before this Action is executed.
Username string; default: none Username used for authentication to the Broker.
Password string; default: none Password used for authentication to the Broker.
TLS off | on; default: off Select to enable TLS encryption.
TLS Type Certificate based | Pre-Shared-Key based; default: Certificate based Type of TLS encryption.
Certificate based:Allow insecure connection off | on; default: off Allow not verifying server authenticity.
Certificate based:Certificate files from device off | on; default: off Choose this option if you want to select certificate files from device.
Certificate based:CA file .crt file; default: none Upload CA file.
Certificate based:Certificate file .crt file; default: none TLS client or server certificate file.
Certificate based:Key file .key file; default: none TLS client or server key file.
Pre-Shared-Key based:Pre-Shared-Key string; default: none The pre-shared-key in hex format with no leading “0x”.
Pre-Shared-Key based:Identity string; default: none Specify the Identity.



Conditions

The Conditions 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.

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.

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.

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.

Field Value Description
Name string; default: none Name of condition.
I/O inputs/outputs; default: P. S. Different devices have different output settings. Specifies the I/O to which the condition is listening to..
State High | Low; default: High Specifies in what state the pin has to be in in order for the Condition to be met.


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:

  • AND - all selected conditions evaluate as TRUE.
  • NAND - at least one selected condition evaluates as FALSE.
  • OR - at least one selected condition evaluates as TRUE.
  • NOR - none of the selected conditions evaluate as TRUE.

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.

In this case, if at least one condition is no longer met, the Boolean group: AND Condition is evaluated as FALSE.

Below is an example of Condition type: Boolean group configuration.

Field Value Description
Boolean type AND | NAND | OR | NOR; default: AND Type of boolean condition.
Add conditions conditions; default: none Specifies global conditions for this pin. Actions will trigger only if the conditions are met. Conditions are optional.

Condition types: Date/Time

Lastly, you can configure Conditions based on date and time. Date/time Conditions can be configured based on:

  • Minute of the hour
  • Hour of the day
  • Day of the Week
  • Day of the Month
  • Day of the Year

Each type can be configured in two distinct ways:

  1. Specific time - configured as a single value which defines the exact time when the Condition is considered as TRUE. e.g.:
    • Hour: 8
    • Day of Month: 1
  2. Time interval - configured with a start and an end value which define a window of time during which the Condition is considered as TRUE. e.g.:
    • Hours: 8-12
    • Days of Month: 1-12

Impulse Counter

Impulse Counter service can register chages in the `Input` state of a Power socket when a value is transitioned from low to high, from high to low, or both.

Configuration

The configuration page is used to enable impulse counter and select GPIO pins for input configuration.

Impulse counter configuration

Field Value Description
Status Status of service, whether it is currently running.
Enabled off | on; default: off Enable impulse counter.
Count store duration Hour | Day | Week | Month; default: Day Define for how long the impulse counts are retained, in seconds, before being reset.
Reset counts -(interactive buttom) Reset collected impulse counts.

Input configuration

A Input configuration defines which `Inputs` will be used for impulse counting. Input configuration list is empty by default. Click the 'Add' button in order to create a new Input instance:

You will then be taken to the configuration page for the newly added input:

Field Value Description
Enable off | on; default: on Enable input configuration.
Name string; default: none Name of input configuration.
GPIO pin Input (3) ; default: Input (3) Select GPIO pin for input configuration.
Edge Rising | Falling | Both; default: Rising Select the edge option to have the impulse counter increment on the signal`s transition from low to high, high to low, or both.
Debounce integer; default: 0 Debounce filters out rapid, unintended signals. Set between 0-1000 ms to ensure only stable inputs are registered.

Statistics

Statistics page displays PIN statistics in routers local time.

[[Category:{{{name}}} Services section]]

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