Template:Networking rutos manual input output: Difference between revisions

  }}

}}

==Summary==

This chapter of the user manual provides an overview of the Input/Output section for {{{name}}} devices.

==Physical characteristics and I/O pin mapping==

{{Template:Networking_rutos_manual_input_output_pinout

| series        = {{{series}}}

| configurableio = {{{configurableio}}}

| input_volts    = {{{input_volts}}}

}}

{{#switch: {{{name}}}  

}}

<table class="nd-mantable">

     <tr>

     </tr>

     <tr>

     </tr>

     <tr>

     </tr>

     <tr>

     </tr>

     <tr>

     </tr>

     <tr>

     </tr>

</table>

     <tr>

     </tr>

     <tr>

     </tr>

     <tr>

     </tr>

     <tr>

     </tr>

     <tr>

     </tr>

----

==Scheduler==

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

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:

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

<table class="nd-mantable">

     <tr>

       <td>Pin</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>

</table>

==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:

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

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>|}}:

{{#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====

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:

<table class="nd-mantable">

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.

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'):

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

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.

<table class="nd-mantable">

       <th>Value</th>

       <th>Description</th>

     </tr>

     <tr>

         <td>Subject</td>

         <td>string; default: <b>none</b></td>

     </tr>

     <tr>

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

     <tr>

         <td>Modem</td>

     </tr>|}}

     <tr>

         <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; default: <b>none</b></td>

         <td>Email address(es) of the message's receiver(s).</td>

     </tr>

</table>

Changes the state of a selected output pin.

<table class="nd-mantable">

       <th>Value</th>

       <th>Description</th>

     </tr>

     <tr>

     <tr>

         <td>Control</td>

     </tr>

     <tr>

     <tr>

         <td>Maintain</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>

         <td>Invert</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>

         <td>State copying</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>

         <td>State</td>

         <td>Specifies the state of the output pin that will be set by this Action.</td>

     </tr>

</table>

Executes a HTTP POST/GET request.

<table class="nd-mantable">

       <th>Value</th>

       <th>Description</th>

     </tr>

     <tr>

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

     </tr>

</table>

Executes a custom, user-written shell script.

<table class="nd-mantable">

       <th>Value</th>

       <th>Description</th>

     </tr>

     <tr>

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

     </tr>

</table>

Reboots the device.

<table class="nd-mantable">

       <th>Value</th>

       <th>Description</th>

     </tr>

     <tr>

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

     </tr>

</table>

Switches to using a specified Configuration Profile.

<table class="nd-mantable">

       <th>Value</th>

       <th>Description</th>

     </tr>

     <tr>

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

     </tr>

</table>

Enables or disables RMS service.

<table class="nd-mantable">

       <th>Value</th>

       <th>Description</th>

     </tr>

     <tr>

         <td>off {{!}} on; default: <b>off</b> </td>

         <td>Specifies whether RMS service will be enabled or disabled with this action.</td>

     </tr>

</table>

Executes a MQTT action.

<table class="nd-mantable">

       <th>Value</th>

       <th>Description</th>

     </tr>

     <tr>

     </tr>

</table>

{{#ifeq: {{{dualsim}}} | 1 |

Switches to using the specified SIM card.

<table class="nd-mantable">

       <th>Value</th>

       <th>Description</th>

     </tr>

     <tr>

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

     </tr>

</table>

Sends an SMS message to specified recipients.

<table class="nd-mantable">

       <th>Value</th>

       <th>Description</th>

     </tr>

     <tr>

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

     </tr>

</table>

Sends an SMS message to specified recipients.

<table class="nd-mantable">

       <th>Value</th>

       <th>Description</th>

     </tr>

     <tr>

         <td>off {{!}} on; default: <b>off</b></td>

         <td>Specifies whether all WiFi interfaces will be enabled/disabled with this action.</td>

     </tr>

</table>

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.

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.

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.

<table class="nd-mantable">

       <th>Value</th>

       <th>Description</th>

     </tr>

     <tr>

         <td>I/O</td>

     </tr>

     <tr>

         <td>State</td>

         <td>Specifies in what state the pin has to be in in order for the Condition to be met.</td>

     </tr>

</table>

{{#ifeq: {{{analog}}} | 1 |

----

<table class="nd-mantable">

       <th>Value</th>

       <th>Description</th>

     </tr>

     <tr>

         <td>Condition</td>

         <td>Whether to evaluate the condition as true inside or outside the specified range.</td>

     </tr>

     <tr>

     </tr>

     <tr>

         <td>Specifies magimum voltage of range.</td>

     </tr>

====Condition type: Boolean group====

----

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

<table class="nd-mantable">

         <td>Add conditions</td>

         <td>conditions; default: <b>none</b> </td>

     </tr>

</table>

====Condition types: Date/Time====

</ul>

Each type can be configured in two distinct ways:

     </li>

</ol>

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