Changes

no edit summary
Line 1: Line 1:  
{{Template:Networking_rutos_manual_fw_disclosure
 
{{Template:Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.05.1
+
| fw_version = {{{series}}}_R_00.02.06.1
 
| series    = {{{series}}}
 
| series    = {{{series}}}
 
}}
 
}}
Line 12: Line 12:  
| series = {{{series}}}
 
| series = {{{series}}}
 
}}
 
}}
 +
==Physical characteristics and I/O pin mapping==
   −
{{#switch: {{{series}}}
+
Electrical characteristics and I/O pin mapping information are presented below.
| RUTX =
  −
==Power Socket Pinout==
     −
The router's input/output pins can be found inside the power socket:
+
{{Template:Networking_rutos_manual_input_output_pinout
 
+
| series        = {{{series}}}
[[File:Networking_rutos_manual_input_output_power_socket_pinout_configurableio_{{{configurableio}}}.png]]
+
| configurableio = {{{configurableio}}}
 +
| input_volts    = {{{input_volts}}}
 +
}}{{#ifeq: {{{name}}} | TRB141 |
 +
<h3>Input/Output Connector Pinout</h3>
 
----
 
----
The electric characteristics for the input and output pins are as follows:
+
[[File:Networking_trb141_manual_input_output_input_output_connector_pinout.png]]
<ul>
  −
    <li><b>Power</b>: 9-50 VDC positive (+).</li>
  −
    <li><b>Ground</b>: negative/ground (-).</li>
  −
    <li><b>Input</b>: digital non-isolated input.
  −
        <ul>
  −
            <li><i>logical low level:</i> 0 - 5 V;</li>
  −
            <li><i>logical high level:</i> 8 - 40 V.</li>
  −
        </ul>
  −
    </li>
  −
    <li><b>Output</b>: digital open collector (OC) output; 30 V, 300 mA.</li>
  −
</ul>
  −
| TRB1 =
  −
{{#ifeq:{{{name}}}|TRB141
  −
|
  −
==Characteristics==
  −
 
  −
TRB141 has eighteen input/output pins, two of them can be found inside the power socket and the rest sixteen are on the side of the device. A list of Input/Output electric characteristics inherent in TRB141 devices can be found below.
  −
 
  −
===Power Socket Pinout===
  −
----
  −
[[File:Networking_rutos_manual_input_output_power_socket_pinout_configurableio_{{{configurableio}}}.png]]
      
<ul>
 
<ul>
     <li><b>Power</b>: 9-30 VDC positive (+).</li>
+
     <li><b>DI<sub>1</sub></b> & <b>DI<sub>2</sub></b> - DRY/WET configurable inputs:
    <li><b>Ground</b>: negative/ground (-).</li>
  −
    <li><b>I/O</b>: programmable input/output pins; can be set to:
   
         <ul>
 
         <ul>
             <li><i>open collector (OC) output;</i> max 30 V;</li>
+
             <li><b>WET</b>: 0-1.9 V is detected as logical "0"; 1.9-3.8 V is detected as logical "1"</li>
             <li><i>digital input;</i> 0-7.3 V is detected as logical "0"; 7.3-30 V is detected as logical "1".</li>
+
             <li><b>DRY</b>: is detected as logical "0" when the input is shorted to GND; otherwise is detected as logical "1"</li>
 
         </ul>
 
         </ul>
 
     </li>
 
     </li>
</ul>
+
    <li><b>NC<sub>1</sub></b>, <b>C<sub>1</sub></b> & <b>NO<sub>1</sub></b> - Normally Closed, Common and Normally Open contacts of the internal Non-Latching Relay respectively.<br>Maximum relay ratings: 0.5 A at 60 VDC/70 VAC, 1 A at 30 VDC/VAC.</li>
 
+
    <li><b>NC<sub>2</sub></b>, <b>C<sub>2</sub></b> & <b>NO<sub>2</sub></b> - Normally Closed, Common and Normally Open contacts of the internal Latching Relay respectively.<br>Maximum relay ratings: 0.8 A at 70 VDC, 0.9 A at 70 VAC, 2 A at 30 VDC/VAC.</li>
===Input/Output Connector Pinout===
+
    <li><b>A</b> - ADC input. Analog voltage range: 0-30 V. The input can be configured for 4-20 mA sensor protocol as current measurement (ACL) of 0-30 mA.</li>
----
+
     <li><b>l</b> and <b></b> - isolated input contacts.
[[File:Networking_trb141_manual_input_output_input_output_connector_pinout.png]]
  −
 
  −
*'''DI1''' and '''DI2''' are DRY/WET configurable inputs. WET: 0-1.9 V is detected as logical "0", 1.9-3.8 V is detected as logical "1".  DRY: Logical "0" is detected when input is shorted to GND, otherwise  input is detected as logical "1".
  −
*'''NC<sub>1</sub> C<sub>1</sub>''' and '''NO<sub>1</sub>''' are respectively Normally Closed, Common and Normally Open contacts of internal Non-Latching Relay. Maximum relay ratings: 0.5A at 60 VDC/70 VAC, 1A at 30 VDC/VAC.
  −
*'''NC<sub>2</sub> C<sub>2</sub>''' and '''NO<sub>2</sub>''' are respectively Normally Closed, Common and Normally Open contacts of internal Latching Relay. Maximum relay ratings: 0.8A at 70 VDC, 0.9A at 70 VAC, 2A at 30 VDC/VAC.
  −
*'''A''' is ADC input. Analog voltage range 0 - 30 V. Input can be configured for 4-20mA sensor protocol as current measurement of 0 - 30 mA.
  −
*'''l''' and '''⏚''' are isolated input contacts. 0-7.3 V is detected as logical "0",  7.3-71 V is detected as logical "1".
  −
*'''+''' is power output connected directly to gateway's power supply input pin.  This Output can be used for powering external 4-20 mA current sensor.
  −
*'''3.8''' is 3.8V power output which can be used to power 1-Wire sensors when needed.
  −
*'''1W''' 1-Wire protocol input/output.
  −
*'''⏚''' is GND contact.
  −
 
  −
|
  −
 
  −
==Characteristics==
  −
 
  −
{{{name}}} input/output pins can be found inside the power socket:
  −
 
  −
===Power Socket Pins===
  −
----
  −
[[File:Networking_rutos_manual_input_output_power_socket_pinout_configurableio_{{{configurableio}}}.png]]
  −
 
  −
<ul>
  −
    <li><b>Power</b>: 9-30 VDC positive (+).</li>
  −
     <li><b>Ground</b>: negative/ground (-).</li>
  −
    <li><b>I/O</b>: programmable input/output pins; can be set to:
   
         <ul>
 
         <ul>
             <li><i>open collector (OC) output;</i> max 30 V;</li>
+
             <li>0-7.3 V is detected as logical "0"</li>
             <li><i>digital input;</i> 0-5 V is detected as logical "0"; 8-40 V is detected as logical "1".</li>
+
             <li>7.3-71 V is detected as logical "1"</li>
 
         </ul>
 
         </ul>
 
     </li>
 
     </li>
</ul>
+
    <li><b>+</b> - a power output connected directly to gateway's power supply input pin. This Output can be used to power an external 4-20 mA current sensor.</li>
}}
+
    <li><b>3.8</b> is a 3.8 V power output that can be used to power 1-Wire sensors.</li>
 
+
    <li><b>1W</b> - 1-Wire protocol input/output.</li>
| TRB2XX =
+
    <li><b>⏚</b> - GND contact.</li>
 
+
</ul>|}}
|
  −
}}
  −
 
   
==Status==
 
==Status==
   −
{{#switch:{{{series}}}
+
The <b>Status</b> page displays the current states of the device's input and output pins:
| TRB2 =
  −
The <b>Status</b> page displays the current states of the device configurable inputs and outputs:
  −
 
  −
[[File:Networking_trb2_manual_input_output_status_v1.png|border|class=tlt-border]]
  −
 
  −
You can invert Input pins by clicking on slider in <b>Inversion</b> column and switch Outputs pin state by clicking on slider in <b>State</b> column.
  −
 
  −
===Status from command line===
  −
----
  −
You can also obtain the status of the input or output from the command line. List of ubus possible <b>values</b> in {{{name}}} devices:
  −
 
  −
ioman.adc.adc0
  −
ioman.gpio.dio0
  −
ioman.gpio.dio1
  −
ioman.gpio.dio2
  −
 
  −
Call command <b>ubus call <u>value</u> status </b>:
  −
root@Teltonika-{{{name}}}:~# ubus call ioman.gpio.dio0 status
  −
{
  −
        "value": "0",
  −
        "direction": "out",
  −
        "bi_dir": true,
  −
        "invert_input": false
  −
}
  −
 
  −
<ul>
  −
    <li><b>dio0</b> is configurable input / output:
  −
        <ul>
  −
            <li>"value": "<b>0</b>" means low level state.</li>
  −
            <li>"value": "<b>1</b>" means high level state.</li>
  −
        </ul>
  −
    </li>
  −
    <li><b>adc0</b> is analog input:
  −
        <ul>
  −
            <li>"value": "<b>0.54</b>" means 0.54V.</li>
  −
        </ul>
  −
    </li>
  −
</ul>
  −
| TRB1 =
  −
{{#ifeq:{{{name}}}|TRB141
  −
|
  −
The <b>Status</b> page displays the current states of the device configurable inputs and outputs:
  −
 
  −
[[File:Networking_trb1_manual_input_output_status_v2.png|border|class=tlt-border]]
  −
 
  −
You can invert Input pins by clicking on slider in <b>Inversion</b> column and switch Outputs pin state by clicking on slider in <b>State</b> column.
  −
 
  −
===Status from command line===
  −
----
  −
You can also obtain the status of the input or output from the command line. List of ubus possible <b>values</b> in {{{name}}} devices:
  −
 
  −
ioman.acl.acl0
  −
ioman.adc.adc0
  −
ioman.dwi.dwi0
  −
ioman.dwi.dwi1
  −
ioman.gpio.dio0
  −
ioman.gpio.dio1
  −
ioman.gpio.iio
  −
ioman.gpio.onewire
  −
ioman.relay.relay0
  −
ioman.relay.relay1
  −
 
  −
In order to read value use '''''status''''' command.
  −
 
  −
ubus call ioman.gpio.dio0 status
  −
ubus call ioman.relay.relay0 status
  −
 
  −
To change input settings use '''''update''''' command and write the value.
  −
 
  −
ubus call ioman.gpio.dio0 update '{"value":"0"}'
  −
ubus call ioman.gpio.dio0 update '{"value":"1"}'
  −
 
  −
To change relay settings use '''''update''''' command and write state.
  −
 
  −
ubus call ioman.relay.relay0 update '{"state":"open"}'
  −
ubus call ioman.relay.relay0 update '{"state":"closed"}'
  −
 
  −
===Reading I/O values from directory===
  −
----
  −
 
  −
You can also collect I/O values straight from directories in your device.
  −
 
  −
====Digital inputs, Relay outputs====
  −
----
  −
 
  −
Following is a list of I/O directories in '''''/sys/class/gpio/''''':
  −
 
  −
dwi1(dry wet) input 14; toggle 12 (to read value refer to gpio14, to change state dry/wet refer to gpio12)
  −
dwi2(dry wet) input 15; toggle 38 (to read value refer to gpio15, to change state dry/wet refer to gpio38)
  −
relay open 20; closed 22; (turn off gpio20 set to 0, turn on gpio22 set value to 1; and visa versa)
  −
latching relay open 23; close 21 (turn off gpio23 set to 0, turn on gpio21 set value to 1; and visa versa)
  −
dio0 (power socket) input 13; output 16 (direction can be changed, to read input use gpio13, to control output use gpio16)
  −
dio1 (power socket) input 17; output 78 (direction can be changed, to read input use gpio17, to control output use gpio78)
  −
iio (isolated input) input 1021 (to read value refer to gpio1021)
  −
 
  −
In order to read digital input value use '''''cat''''' command.
  −
 
  −
cat /sys/class/gpio/gpio14/value
  −
cat /sys/class/gpio/gpio15/value
  −
cat /sys/class/gpio/gpio1021/value
  −
 
  −
To change input state use '''''echo''''' command where "1" is "dry" state and "0" is "wet" state.
  −
 
  −
echo 0 > /sys/class/gpio/gpio12/value
  −
echo 1 > /sys/class/gpio/gpio38/value
  −
 
  −
When one Relay output is open, other one is closed, so turning on/off the output you will have to change value on both pins. For that '''''echo''''' command is used. Same principle applies to Latching Relay output.
  −
 
  −
echo 1 > /sys/class/gpio/gpio20/value & echo 0 > /sys/class/gpio/gpio22/value
  −
echo 1 > /sys/class/gpio/gpio23/value & echo 0 > /sys/class/gpio/gpio21/value
  −
 
  −
====ADC (Analog Input)====
  −
----
  −
 
  −
ADC (Analog input) can be read from different directory, '''''/sys/devices/qpnp-vadc-8/mpp4_vadc''''' also using '''''cat''''' command, but received Result value has to be divided by 126582 to get number in volts.
  −
 
  −
cat /sys/devices/qpnp-vadc-8/mpp4_vadc
  −
 
  −
====One-wire====
  −
----
  −
 
  −
To read one-wire sensor data you will need to follow these steps:
  −
 
  −
Set one-wire sensor '''''value''''' to '''''1''''' using '''''ubus''''' command.
  −
 
  −
  ubus call ioman.gpio.onewire update '{"value":"1"}'
  −
 
  −
After that list out connected one-wire devices in directory '''''/sys/bus/w1/devices''''' with '''''ls''''' command.
  −
 
  −
  ls /sys/bus/w1/devices
  −
 
  −
Choose sensor that you want to know values off and using '''''cat''''' command read them from '''''/sys/bus/w1/devices/&#60;device_name&#62;/w1_slave''''' directory.
  −
 
  −
  cat /sys/bus/w1/devices/&#60;device_name&#62;/w1_slave
  −
 
  −
 
  −
| <!--    for other TRB1    -->
  −
The <b>Status</b> page displays the current states of the device input and output:
  −
 
  −
[[File:Networking_trb14x_manual_input_output_status_v1.png|border|class=tlt-border]]
  −
 
  −
You can invert Input pin by clicking on slider in <b>Inversion</b> column and switch Output pin state by clicking on slider in <b>State</b> column.
     −
===Status from command line===
+
{{#ifeq: {{{name}}} | TRB141
----
+
  | [[File:Networking_trb141_manual_input_output_status.png|border|class=tlt-border]]
You can also obtain the status of the input or output from the command line. List of ubus possible <b>values</b> in {{{name}}} devices:
+
  | [[File:Networking_{{lc:{{{series}}}}}_manual_input_output_status.png|border|class=tlt-border]]
 
  −
ioman.gpio.din1
  −
ioman.gpio.dout1
  −
 
  −
Call command <b>ubus call <u>value</u> status </b>:
  −
root@Teltonika-{{{name}}}:~# ubus call ioman.gpio.dout1 status
  −
{
  −
        "value": "0",
  −
        "direction": "in",
  −
        "bi_dir": false,
  −
        "invert_input": false
  −
}
  −
 
  −
<ul>
  −
    <li><b>din1</b> is the input:
  −
        <ul>
  −
            <li>"value": "<b>0</b>" means low level state.</li>
  −
            <li>"value": "<b>1</b>" means high level state.</li>
  −
        </ul>
  −
    </li>
  −
    <li><b>dout1</b> is the output:
  −
        <ul>
  −
            <li>"value": "<b>0</b>" means low level state.</li>
  −
            <li>"value": "<b>1</b>" means high level state.</li>
  −
        </ul>
  −
    </li>
  −
</ul>
   
}}
 
}}
| <!--    for rutx      -->
  −
The <b>Status</b> page displays the current states of the device input and output:
     −
[[File:Networking_rutx_manual_input_output_status_v2.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.
 
  −
You can invert Input pin by clicking on slider in <b>Inversion</b> column and switch Output pin state by clicking on slider in <b>State</b> column.
      
===Status from command line===
 
===Status from command line===
 
----
 
----
You can also obtain the status of the input or output from the command line. List of ubus possible <b>values</b> in {{{name}}} devices:
+
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:
   −
ioman.gpio.dio0
+
{{#ifeq: {{{name}}} | TRB141
ioman.gpio.dio1
+
  | {{Template:Networking_trb141_manual_input_output_status}}
 
+
  | {{Template:Networking_{{lc:{{{series}}}}}_manual_input_output_status|name={{{name}}}}}
Call command <b>ubus call <u>value</u> status </b>:
  −
root@Teltonika-{{{name}}}:~# ubus call ioman.gpio.dio0 status
  −
{
  −
        "value": "0",
  −
        "direction": "in",
  −
        "bi_dir": false,
  −
        "invert_input": false
  −
}
  −
 
  −
<ul>
  −
    <li><b>din1</b> is the input:
  −
        <ul>
  −
            <li>"value": "<b>0</b>" means low level state.</li>
  −
            <li>"value": "<b>1</b>" means high level state.</li>
  −
        </ul>
  −
    </li>
  −
    <li><b>dout1</b> is the output:
  −
        <ul>
  −
            <li>"value": "<b>0</b>" means low level state.</li>
  −
            <li>"value": "<b>1</b>" means high level state.</li>
  −
        </ul>
  −
    </li>
  −
</ul>
   
}}
 
}}
    
==Post/Get==
 
==Post/Get==
   −
Enabling <b>Post/Get</b> provides the possibility to control the state of an output via HTTP POST/GET requests. The figure below is an example of the Auth Settings section of the Post/Get page. It is used to turn Post/Get on or off and to set authentication parameters.
+
Enabling <b>Post/Get</b> provides the possibility to control the state of an output via HTTP POST/GET requests. The figure below is an example of the Auth Settings section of the Post/Get page. It is used to turn Post/Get requests on or off and to set authentication parameters.
    
[[File:Networking_rutos_manual_input_output_post_get_auth_settings.png|border|class=tlt-border]]
 
[[File:Networking_rutos_manual_input_output_post_get_auth_settings.png|border|class=tlt-border]]
Line 348: Line 102:  
===Post/Get examples===
 
===Post/Get examples===
 
----
 
----
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.
+
Use a web browser or any other compatible software to send HTTP POST/GET requests to the device.
    
Below is a table containing syntax examples of this usage:  
 
Below is a table containing syntax examples of this usage:  
Line 408: Line 162:  
==Scheduler==
 
==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 and hours of the day. Below is an example of the Scheduler section.
+
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.
 +
 
 +
[[File:Networking_rutos_manual_input_output_scheduler_general_configuration.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:
 +
 
 +
[[File:Networking_rutos_manual_input_output_scheduler_add_button.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:
   −
[[File:Networking_rutos_manual_input_output_scheduler_configure_scheduler_configurableio_{{{configurableio}}}.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_input_output_scheduler_instance_configuration_configurableio_{{{configurableio}}}.png|border|class=tlt-border]]
   −
Each field represents a day of the week and an hour of the day. The Scheduler table itself is interactive; click on different fields to set the state of an output for a specific window of time. For example:
+
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
      <th>Value</th>
 +
      <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
      <td>Enable</td>
 +
      <td>off | on; default: <b>off</b></td>
 +
      <td>Turns the Scheduler Instance on or off.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Pin</td>
 +
      <td>output pin; default: <b>{{#ifeq:{{{configurableio}}}|1|Configurable Input/Output (2)|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>
 +
    </tr>
 +
    <tr>
 +
      <td>Interval Type</td>
 +
      <td>Weekdays | <span style="color: red;">Month Days</span>; default: <b>Weekdays</b></td>
 +
      <td>Turns the Scheduler Instance on or off.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Start Day</td>
 +
      <td>[Monday..Sunday] | [1..31]; default: <b>Monday | 1</b></td>
 +
      <td>The day that marks the start of the time interval.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Start Time</td>
 +
      <td>hh:mm ([00..23]:[00..59]); default: <b>12:00</b></td>
 +
      <td>The hour and minute that mark the start of the time interval.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>End Day</td>
 +
      <td>[Monday..Sunday] | [1..31]; default: <b>Tuesday | 1</b></td>
 +
      <td>The day that marks the end of the time interval.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>End Time</td>
 +
      <td>hh:mm ([00..23]:[00..59]); default: <b>12:00</b></td>
 +
      <td>The hour and minute that mark the end of the time interval.</td>
 +
    </tr>
 +
    <tr>
 +
      <td><span style="color: red;">Force Last Day</span></td>
 +
      <td>off | on; default: <b>off</b></td>
 +
      <td>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 <i>Month Days</i>.</td>
 +
    </tr>
 +
</table>
   −
[[File:Networking_rutos_manual_input_output_scheduler_configure_scheduler_example_configurableio_{{{configurableio}}}.png|border|class=tlt-border]]
+
A Scheduler Instance will not work unless you turn both the the Scheduler service and the individual instance on:
   −
The Scheduler is turned off by default. To turn it on set the 'Enable' slider to "on".
+
[[File:Networking_rutos_manual_input_output_scheduler_on_off_slider_configurableio_{{{configurableio}}}.png|border|class=tlt-border]]
    
==I/O Juggler==
 
==I/O Juggler==
Line 645: Line 453:  
====HTTP====
 
====HTTP====
 
----
 
----
Executes at HTTP Post/Get action.
+
Executes a HTTP POST/GET request.
    
[[File:Networking_rutos_manual_input_output_io_juggler_actions_http.png|border|class=tlt-border]]
 
[[File:Networking_rutos_manual_input_output_io_juggler_actions_http.png|border|class=tlt-border]]

Navigation menu