Template:Networking rut9xx manual input output

From Teltonika Networks Wiki
Revision as of 13:52, 16 October 2020 by Dziugas (talk | contribs)

(diff) ← Older revision | Approved revision (diff) | Latest revision (diff) | Newer revision → (diff)

The information in this page is updated in accordance with the [[Media:{{{series}}}_R_00.06.07_WEBUI.bin|{{{series}}}_R_00.06.07]] firmware version.

Summary[edit source]

Inputs and Outputs are used for the monitoring and controlling of a connected device or receiving signals from that device in order to trigger certain events. This chapter is overview on the Input/Output section for {{{name}}} routers.

Characteristics[edit source]

This section provides a list Input/Output electric characteristics inherent in {{{name}}} routers:

  • Digital non-isolated input (DIN1): Logic low 0 - 5 V; Logic high 8 - 40 V
  • Digital open collector output (DOUT1): 30 V, 300 mA

Status[edit source]

The Status tab displays the current states the router’s input and output:

[[File:{{{file_status}}}|border|class=tlt-border]]

Custom Labels[edit source]


If the default Input/Output labels do not suit your needs, you can always configure custom ones in the Custom Labels section. Click the 'Edit' button next to the desired Input or Output and you will be redirected to a window such as this:

[[File:{{{file_status_digital}}}|border|class=tlt-border]]

The figure above is an example of custom label configuration for Digital Input. You can change an input's/output's name, the names of their states and which state is considered as "Active". The changes are purely cosmetic and used for easier management purposes.

Status and control from command line[edit source]


You can control and monitor input and output values via a command line interface (CLI) with the gpio.sh command. You can execute this command without any additional options to get usage syntax examples:

root@Teltonika-RUT950:~# gpio.sh
GPIO control aplication
        Usage: /sbin/gpio.sh <ACTION> <NAME>
        ACTION - set, clear, get, export, invert, dirout, dirin, getpin
        NAME - SIM      DOUT1   DOUT2   DIN1    DIN2    MON     MRST    DOUT3   DIN3    RS485_R SDCS    HWRST

Where:

  • DIN1 - Digital input
  • DOUT1 - Digital output

For example, to get the status of the digital output use the following command:

root@Teltonika:~# gpio.sh get DOUT1
0

The return value 0 means that the output is in Inactive (Low level), i.e., OFF. You can turn it ON (Active (High level)) by setting its value to 1:

root@Teltonika:~# gpio.sh set DOUT1
root@Teltonika:~# gpio.sh get DOUT1
1

As seen in the example above, you can change the value of an output by using the invert command, which simply turns the current value of the specified output and turns it into its opposite state.

Input[edit source]

The Input tab is used to configure the router's input pin.

Input Rules[edit source]


The Input Rules section provides you with the possibility to set up rules that execute user specified actions after a certain trigger occurs. To add a new rule, look to the Input Configuration section that is just below. Select the input, the trigger and the action for the rule and click the 'Add' button. A new rule will appear in the Input Rules list:

[[File:{{{file_input_add}}}|border|class=tlt-border]]


To begin editing an input rule, click the 'Edit' button located next to it. Refer to the figure and table below for information on input rule configuration.

[[File:{{{file_input_config}}}|border|class=tlt-border]]

Field Value Description
Enable yes | no; default: yes Turns the input rule on or off.
Input type Digital 4PIN; default: Digital 4PIN Selects to which input pin the rule will apply.
Trigger Low level | High level | Both; default: Low level Selects which input state will trigger the rule.
Action Send SMS | Change SIM card | Send email | Change profile | Turn on WiFi | Turn off WiFi | Reboot | Activate output | HTTP POST/GET; default: Send SMS The action that will be taken when the rule is triggered.
  • Send SMS - sends an SMS message to a specified number(s) or user group. The message text is custom.
  • Change SIM card - switches to the SIM card that is not currently in use.
  • Send email - sends an email to the specified address(es). You will be prompted to enter your email account's authentication information.
  • Change profile - switches to using another configuration profile. Configuration profiles can be created via the System → [[{{{name}}} Profiles|Profiles]] page.
  • Turn on WiFi/Turn off WiFi - turns WiFi on or off.
  • Reboot - reboots the router when a specified amount of time passes or instantly after the trigger occurrence.
  • Activate output - activates the specified router output.
  • HTTP POST/GET - performs an HTTP POST or GET action.

Output[edit source]

The Output tab is used to configure the router's output pin.

Output Configuration[edit source]


The Output Configuration section is used to change the default state of the router's output pin.

[[File:{{{file_output_config}}}|border|class=tlt-border]]

Field Value Description
Digital output 4PIN Low level | High level; default: Low level Changes the default* state of the digital output pin.

* Changing the default state of an output means that the changes will be written into the input/output config and saved. This means that unless some other related change occurs the state of the output will remain as set in this section.

ON/OFF[edit source]


The ON/OFF section is used to turn the router's output on or off. This action does not save the state permanently, meaning that after a reboot the state will revert back to their default values.

[[File:{{{file_output_on_off}}}|border|class=tlt-border]]

Post/Get configuration[edit source]


Enabling Post/Get will allow you to send HTTP POST/GET requests to the router that control the state of the output. The figure below is an example of the Post/Get configuration section an the table below provides information on the fields contained in that section:

[[File:{{{file_output_post_get}}}|border|class=tlt-border]]

Field Value Description
Enable yes | no; default: no Turns Post/Get on or off.
Username string; default: user1 Username used for authentication in POST/GET queries.
Password string; default: none Password used for authentication in POST/GET queries.

Post/Get examples[edit source]


It is possible to turn the output on and off by using a valid HTTP POST/GET syntax. Use a web browser or any other compatible software to submit HTTP POST/GET strings to the device.

Below is a table containing syntax examples of this usage:

Action POST/GET URL
Turn output on http://192.168.1.1/cgi-bin/output?username=user1&password=user1&action=on&pin=4pin
Turn output off http://192.168.1.1/cgi-bin/output?username=user1&password=user1&action=off&pin=4pin
Turn output on after a 10 second delay http://192.168.1.1/cgi-bin/output?username=user1&password=user1&action=on&pin=4pin&delay=10
Turn output on for 5 seconds http://192.168.1.1/cgi-bin/output?username=user1&password=user1&action=on&pin=4pin&time=5
Turn output on for 5 seconds after a 10 second delay http://192.168.1.1/cgi-bin/output?username=user1&password=user1&action=on&pin=4pin&delay=10&time=5

Overview:

  • 192.168.1.1 - router's default LAN IP address; replace it in accordance with your own configuration.
  • username - login name from Post/Get configuration.
  • password- password from Post/Get configuration.
  • action- the action that will be performed on the output (can be on or off).
  • pin - specifies the output (use 4pin).
  • delay - defines a delay (in seconds) after which the specified action will be performed.
  • time - defines a window of time during which the action will take place. For instance, if you post an on action while specifying time=5, the output will turn on and stay on for 5 seconds before turning off.

Delay and time parameters can be used together. For example, if delay is 10, time is 5, action is on, then 10 seconds after the execution of the command, the output will switch to on (or stay in on state if it was already that way), then after 5 more seconds it will switch to off state. In this case the overall command execution time is 15 seconds.

Periodic control[edit source]


The Periodic control section allows you to set up automatic output control rules that trigger output state changes at the specified period or interval.

Click the 'Add' button to add a new periodic control rule and click the 'Edit' button next to it to begin configuration:

[[File:{{{file_output_periodic_add}}}|border|class=tlt-border]]

Refer to the figure and table below for information on configuration fields contained in that section.

[[File:{{{file_output_periodic}}}|border|class=tlt-border]]

Field Value Description
Enable yes | no; default: no Turns the rule on or off.
Output Digital 4PIN output; default: Digital 4PIN output The output pin that will be be affected by the rule.
Action On | Off; default: On The action that will be performed on the output.
Action timeout yes | no; default: no Action timeout specifies whether an action should end after some time. For example, if action is set to on and timeout is set to 10, when the trigger occurs the output will turn on for 10 seconds before turning off.
Mode Fixed | Interval; default: Fixed When the rule will be triggered.
  • Fixed - triggers the specified action on a specified day(s), hour and minute. For example, every Sunday at 8:30 AM.
  • Interval - performs the action at an interval. For example, every 1 hour during Mondays.

Scheduler[edit source]


With the help of the output Scheduler you can configure a timetable of when the output should be enabled or disabled based on time.

[[File:{{{file_output_scheduler}}}|border|class=tlt-border]]

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