31,703
edits
Changes
Template:Networking rutos manual input output (view source)
Revision as of 12:14, 28 October 2020
, 12:14, 28 October 2020→I/O Juggler
===Actions===
===Actions===
----
----
The <b>Actions</b> section is used to manage existing and create new Actions that 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.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_input_output_io_juggler_actions_add_button.png|border|class=tlt-border]]
[[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 the 'Reboot' action only):
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.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.
You will find descriptions of each different action Type described on the sections below.
====Type: Email====
=====Profile=====
----
----
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.
[[File:Networking_rutos_manual_input_output_io_juggler_actions_email.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<th>Value</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Text message</td>
<td>Text message</td>
<td>string; default: <b>none</b> </td>
<td>string; default: <b>none</b> </td>
<td>Text message to be sent in email. Below this field you can find device information and
<td>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.</td>
</tr>
</tr>
<tr>
<tr>
<td>Execution delay</td>
<td>Execution delay</td>
<td>positive integer; default: <b>none</b></td>
<td>positive integer; default: <b>none</b></td>
<td>How many seconds will pass before the action is excecuted after it's triggered.</td>
<td>A period of time (in seconds) which has to pass after a trigger event before the action is executed.</td>
</tr>
</tr>
<tr>
<tr>
<td>Email user</td>
<td>Email account</td>
<td>email user; default: <b>none</b></td>
<td>email account; default: <b>none</b></td>
<td>Configured email user.</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>
</tr>
</tr>
<tr>
<tr>
<td>Recipient's email address</td>
<td>Recipient's email address</td>
<td>string; default: <b>none</b></td>
<td>email; default: <b>none</b></td>
<td>Email receiver(s).</td>
<td>Email address(es) of the message's receiver(s).</td>
</tr>
</tr>
</table>
</table>
{{#ifeq: {{{mobile}}} | 1 |
====Type: SMS====
----
Sends an SMS message to specified recipients.
[[File:Networking_rutos_manual_input_output_io_juggler_actions_sms.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<th>Value</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Text message</td>
<td>Text message</td>
<td>string; default: <b>none</b> </td>
<td>string; default: <b>none</b> </td>
<td>Text message to be sent in sms. Below this field you can find device information and
<td>SMS 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.</td>
</tr>
</tr>
<tr>
<tr>
<td>Execution delay</td>
<td>Execution delay</td>
<td>positive integer; default: <b>none</b></td>
<td>positive integer; default: <b>none</b></td>
<td>How many seconds will pass before the action is excecuted after it's triggered.</td>
<td>A period of time (in seconds) which has to pass after a trigger event before the action is executed.</td>
</tr>
</tr>
<tr>
<tr>
<td>Recipients</td>
<td>Recipients</td>
<td><span style="color:red;">Single number</span> {{!}} <span style="color:blue;">Group</span>; default: <b>Single number</b></td>
<td>Single number {{!}} Group; default: <b>Single number</b></td>
<td>How many recipients will get the message.</td>
<td>Defines whether the SMS message will be sent to a single number or multiple numbers included in a user-configured Phone group. Phone groups can be configured in the System → Administration → Recipients → [[{{{name}}}_Administration#Phone_Groups|Phone Groups]] page.</td>
</tr>
</tr>
<tr>
<tr>
<td>Add conditions</td>
<td>Recipient's phone number/Phone group</td>
<td>conditions; default: <b>none</b> </td>
<td>phone number | phone group; default: <b>none</b></td>
<td>Specifies conditions which have to be met for action to occur. Conditions are optional.</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>
</table>
</table>
|}}
====Type: Output====
----
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]]
}}
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<th>Value</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Execution delay</td>
<td>Execution delay</td>
<td>positive integer; default: <b>none</b></td>
<td>positive integer; default: <b>none</b></td>
<td>How many seconds will pass before the action is excecuted after it's triggered.</td>
<td>A period of time (in seconds) which has to pass after a trigger event before this Action is executed.</td>
</tr>
</tr>
<tr>
<tr>
<td>Control</td>
<td>Control</td>
<td>output; default: <b>Output(4)</b></td>
<td>output; default: <b>{{#ifeq:{{{configurableio}}}|1|Configurable Input/Output (2)|Output (4)}}</b></td>
<td>Specifies the output of which the state will be changed.</td>
<td>Selects the output controlled by this Action.</td>
</tr>
</tr>
<tr>
<tr>
<td>Revert</td>
<td>Revert</td>
<td>integer; default: <b>0</b> </td>
<td>integer; default: <b>0</b></td>
<td>After how many seconds the state will revert. If left 0 or empty the state will not revert.</td>
<td>After how many seconds the state will revert. If left as 0 or empty the state will not revert.</td>
</tr>
</tr>
<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>Maintain this IO state after reboot.</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>On action inverts pin 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 selected input to selected output.</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 what state the output pin will be set to.</td>
<td>Specifies the state of the output pin that will be set by this Action.</td>
</tr>
</tr>
</table>
</table>
====HTTP====
----
Executes at HTTP Post/Get action.
[[File:Networking_rutos_manual_input_output_io_juggler_actions_http.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<th>Value</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Execution delay</td>
<td>Execution delay</td>
<td>positive integer; default: <b>none</b></td>
<td>positive integer; default: <b>none</b></td>
<td>How many seconds will pass before the action is excecuted after it's triggered.</td>
<td>A period of time (in seconds) which has to pass after a trigger event before this Action is executed.</td>
</tr>
</tr>
<tr>
<tr>
<td>Method</td>
<td>Method</td>
<td>Get {{!}} Post; default: <b>Get</b></td>
<td>Get | Post; default: <b>Get</b></td>
<td>Specifies the output of which the state will be changed.</td>
<td>HTTP method to be used by this Action.</td>
</tr>
</tr>
<tr>
<tr>
<td>URL</td>
<td>URL</td>
<td>string; default: <b>none</b> </td>
<td>string; default: <b>none</b> </td>
<td>URL to send request to.</td>
<td>URL to send the HTTP Post/Get request to.</td>
</tr>
</tr>
<tr>
<tr>
<td>Verify</td>
<td>Verify</td>
<td>off | on; default: <b>off</b></td>
<td>off | on; default: <b>off</b></td>
<td>Verifies the validity of certificates, only works for https.</td>
<td>Verifies the validity of certificates; only used with HTTPS.</td>
</tr>
</tr>
<tr>
<tr>
<td>Parameters</td>
<td>Parameters</td>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Parameters and their value from device for usage in Post or Get requests.
<td>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).</td>
</tr>
</tr>
</table>
</table>
====Type: Script====
----
Executes a custom, user-written shell script.
[[File:Networking_rutos_manual_input_output_io_juggler_actions_script.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<th>Value</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Execution delay</td>
<td>Execution delay</td>
<td>positive integer; default: <b>none</b></td>
<td>positive integer; default: <b>none</b></td>
<td>How many seconds will pass before the action is excecuted after it's triggered.</td>
<td>A period of time (in seconds) which has to pass after a trigger event before this Action is executed.</td>
</tr>
</tr>
<tr>
<tr>
<td>Specify path</td>
<td>Specify path</td>
<td><span style="color:red;">Upload a script</span> {{!}} <span style="color:blue;">Specify path</span>; default: <b>Upload a script</b></td>
<td>Upload a script |Specify path; default: <b>Upload a script</b></td>
<td>Selection to upload a script or specify its absolute path in device.</td>
<td>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.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:red;">Upload a script:</span> Custom script</td>
<td>Custom script/Script file</td>
<td>-(interactive button)</td>
<td>-(interactive button) | filepath</td>
<td>Shows file upload window on click.</td>
<td>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.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:blue;">Specify path:</span> Script file</td>
<td>Arguments</td>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Absolute path to script file in device.</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>
</table>
====Type: Reboot====
----
Reboots the device.
[[File:Networking_rutos_manual_input_output_io_juggler_actions_reboot.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<tr>
<td>Arguments</td>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Add conditions</td>
<td>Execution delay</td>
<td>conditions; default: <b>none</b> </td>
<td>positive integer; default: <b>none</b></td>
<td>Specifies conditions which have to be met for action to occur. Conditions are optional.</td>
<td>A period of time (in seconds) which has to pass after a trigger event before this Action is executed.</td>
</tr>
</tr>
</table>
</table>
====Type: Profile====
----
Switches to using a specified Configuration Profile.
[[File:Networking_rutos_manual_input_output_io_juggler_actions_script.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<th>Value</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Execution delay</td>
<td>Execution delay</td>
<td>positive integer; default: <b>none</b></td>
<td>positive integer; default: <b>none</b></td>
<td>How many seconds will pass before the action is excecuted after it's triggered.</td>
<td>A period of time (in seconds) which has to pass after a trigger event before this Action is executed.</td>
</tr>
</tr>
<tr>
<tr>
<td>Add conditions</td>
<td>Profile</td>
<td>conditions; default: <b>none</b> </td>
<td>profile; default: <b>default</b> </td>
<td>Specifies conditions which have to be met for action to occur. Conditions are optional.</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>
</table>
</table>
{{#ifeq: {{{dualsim}}} | 1 |
=====Type: Change SIM=====
----
Switches to using the specified SIM card.
[[File:Networking_rutos_manual_input_output_io_juggler_actions_change_sim.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<th>Value</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
</tr>
</tr>
<tr>
<tr>
<td>Execution delay</td>
<td>Execution delay</td>
<td>positive integer; default: <b>none</b></td>
<td>positive integer; default: <b>none</b></td>
<td>How many seconds will pass before the action is excecuted after it's triggered.</td>
<td>A period of time (in seconds) which has to pass after a trigger event before this Action is executed.</td>
</tr>
</tr>
<tr>
<tr>
<td>Flip</td>
<td>Flip</td>
<td><span style="color:red;">off</span> {{!}} on; default: <b>off</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Switches to a different sim card.</td>
<td>When set to 'on', switches to the opposite SIM card (the that is currently NOT in use). This can be used instead of selecting a specific SIM card to switch to.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:red;">Off:</span> Target</td>
<td>Target</td>
<td>Sim1 {{!}} Sim2; default: <b>Sim1</b></td>
<td>SIM1 {{!}} SIM2; default: <b>SIM1</b></td>
<td>Switches to a selected sim card.</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>
</table>
</table>
|}}
}}
===Conditions===
===Conditions===
----
----
The <b>Conditions</b> section lets you manage your created Conditions for I/O Juggler Actions. The figure below is an example of Conditions section.
The <b>Conditions</b> section lets you manage your created Conditions for I/O Juggler Actions.
The figure below is an example of Conditions section.
[[File:Networking_rutx_manual_input_output_iojuggler_conditions_v1.png]]
[[File:Networking_rutx_manual_input_output_iojuggler_conditions_v1.png]]
