Difference between revisions of "Template:Networking rutos manual modbus"

From Teltonika Networks Wiki
(34 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:Networking_rutos_manual_fw_disclosure
+
{{Template: Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.05
+
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series    = {{{series}}}
+
| series = {{{series}}}
 +
| name  = {{{name}}}
 +
}}
 
}}
 
}}
 
+
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
 +
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
 
==Summary==
 
==Summary==
  
Line 9: Line 12:
  
 
This manual page provides an overview of the Modbus functionality in {{{name}}} devices.
 
This manual page provides an overview of the Modbus functionality in {{{name}}} devices.
 +
{{#switch: {{{series}}}
 +
| RUTX =
 +
| TRB1 =
 +
| TRB2 =
 +
| RUT9|RUT9M =
 +
| #default =
 +
<u><b>
  
 +
Note:</b> On {{{name}}}, Modbus TCP Slave/Master and MQTT Gateway is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u><br>}}
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
 
| series = {{{series}}}
 
| series = {{{series}}}
 
}}
 
}}
  
==Modbus TCP slave==
+
==Modbus TCP Slave==
  
A <b>Modbus TCP slave</b> listens for connections from a master (client) and sends out a response or sets some system related parameter in accordance with the given query. This provides the user with the possibility to set or get system parameters.  
+
A <b>Modbus TCP Slave</b> listens for connections from a TCP master (client) and sends out a response or sets some system related parameter in accordance with the given query. This provides the user with the possibility to set or get system parameters.  
  
 
The figure below is an example of the Modbus TCP window section and the table below provides information on the fields contained in that window:
 
The figure below is an example of the Modbus TCP window section and the table below provides information on the fields contained in that window:
  
[[File:Networking_rutos_manual_modbus_modbus_tcp_slave.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_tcp_slave_v2.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 30: Line 41:
 
     <tr>
 
     <tr>
 
       <td>Enable</td>
 
       <td>Enable</td>
       <td>off | on; default: <b>none</b></td>
+
       <td>off | on; default: <b>off</b></td>
 
       <td>Turns Modbus TCP on or off.</td>
 
       <td>Turns Modbus TCP on or off.</td>
 
     </tr>
 
     </tr>
Line 44: Line 55:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
     <td>Allow Remote Access</td>
+
    <td>Mobile Data type</td>
 +
        <td>Bytes | Kilobytes | Megabytes; default: <b>Bytes</b></td>
 +
        <td>Selects mobile data unit representation type.</td>
 +
    </tr>
 +
    <tr>
 +
     <td>Allow remote access</td>
 
         <td>off | on; default: <b>off</b></td>
 
         <td>off | on; default: <b>off</b></td>
 
         <td>Allows remote Modbus connections by adding an exception to the device's firewall on the port specified in the field above.</td>
 
         <td>Allows remote Modbus connections by adding an exception to the device's firewall on the port specified in the field above.</td>
Line 50: Line 66:
 
     <tr>
 
     <tr>
 
     <td>Keep persistent connection</td>
 
     <td>Keep persistent connection</td>
         <td>off | on; default: <b>off</b></td>
+
         <td>off | on; default: <b>onn</b></td>
 
         <td>Allows keep the connection open after responding a Modbus TCP master request.</td>
 
         <td>Allows keep the connection open after responding a Modbus TCP master request.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>Connection timeout</td>
 
     <td>Connection timeout</td>
         <td> integer; default: <b>0</b></td>
+
         <td>integer [0..60]; default: <b>0</b></td>
         <td> Sets TCP timeout in seconds after which the connection is forcefully closed.</td>
+
         <td>Sets TCP timeout in seconds after which the connection is forcefully closed.</td>
 +
    </tr>
 +
    <tr>
 +
    <td>Enable custom register block</td>
 +
        <td>off | <span style="color:blue">on</span>; default: <b>off</b></td>
 +
        <td>Allows the usage of custom register block.</td>
 +
    </tr>
 +
    <tr>
 +
    <td><span style="color:blue">Register file path</span></td>
 +
        <td>path; default: <b>/tmp/regfile</b></td>
 +
        <td>Path to file in which the custom register block will be stored. Files inside /tmp or /var are stored in RAM. They vanish after reboot, but do not degrade flash memory. Files elsewhere are stored in flash memory. They remain after reboot, but degrade flash memory (severely, if operations are frequent).</td>
 +
    </tr>
 +
    <tr>
 +
    <td><span style="color:blue">First register number</span></td>
 +
        <td>integer [1025..65536]; default: <b>1025</b></td>
 +
        <td>First register in custom register block</td>
 +
    </tr>
 +
    <tr>
 +
    <td><span style="color:blue">Register count</span></td>
 +
        <td>integer [1..64512]; default: <b>128</b></td>
 +
        <td>Register count in custom register block </td>
 +
    </tr>
 +
</table>
 +
 
 +
{{#ifeq: {{{serial}}} | 1 |
 +
==Modbus Serial Slave==
 +
A <b>Modbus Serial Slave</b> listens for connections from a serial master (client) and sends out a response or sets some system related parameter in accordance with the given query. This provides the user with the possibility to set or get system parameters.
 +
 
 +
===Modbus Serial Slave Configuration===
 +
----
 +
The <b>Modbus Serial Slave Configuration</b> section is used to configure serial slaves. By default, the list is empty. To add a new slave instance, enter the instance name, select serial interface and click the 'Add' button.
 +
 
 +
[[File:Networking_rutos_manual_modbus_modbus_serial_slave_add_button_rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}_v1.png|border|class=tlt-border]]
 +
 
 +
After clicking 'Add' you will be redirected to the newly added slave instance configuration page.
 +
 
 +
[[File:Networking_rutos_manual_modbus_modbus_serial_slave_configuration_rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}_v1.png|border|class=tlt-border]]
 +
 
 +
<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>Enables this Modbus Serial Slave instance configuration.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Name</td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>Name of the serial slave instance. Used for management purposes only.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Device</td>
 +
        <td>{{Template: Networking rutos manual serial ports| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}; default: <b>{{Template: Networking rutos manual default serial port| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}</b></td>
 +
        <td>Specifies which serial port will be used for serial communication.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Device ID</td>
 +
        <td>integer [0..255]; default: <b>1</b></td>
 +
        <td>Specifies which serial port will be used for serial communication.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Baud rate</td>
 +
        <td>300 {{!}} 1200 {{!}} 2400 {{!}} 4800 {{!}} 9600 {{!}} 19200 {{!}} 38400 {{!}} 57600 {{!}} 115200{{#ifeq: {{{rs485}}} | 1 | {{!}} 230400 {{!}} 460800 {{!}} 921600 {{!}} 1000000 {{!}} 3000000|}}; default: <b>9600</b></td>
 +
        <td>Serial data transmission rate (in bits per second).</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Data bits</td>
 +
        <td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
 +
        <td>Number of data bits for each character.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Stop bits</td>
 +
        <td>1{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} 2|}}; default: <b>1</b></td>
 +
        <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td>
 
     </tr>
 
     </tr>
 +
    <tr>
 +
        <td>Parity</td>
 +
        <td>Even {{!}} Odd{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} Mark {{!}} Space|}} {{!}} None; default: <b>None</b></td>
 +
        <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
 +
            <ul>
 +
                <li><b>None</b> (<b>N</b>) - no parity method is used.</li>
 +
                <li><b>Odd</b> (<b>O</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.</li>
 +
                <li><b>Even</b> (<b>E</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be even.</li>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|<li><b>Space</b> (<b>s</b>) - the parity bit will always be a binary 0.</li>
 +
                <li><b>Mark</b> (<b>M</b>) - the parity bit will always be a binary 1.</li>|}}
 +
            </ul>
 +
        </td>
 +
    </tr>
 +
    <tr>
 +
        <td>Flow control</td>
 +
        <td>None {{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} RTS/CTS {{!}} Xon/Xoff|}}; default: <b>None</b></td>
 +
        <td>In many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking.
 +
{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|<ul>
 +
                <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li>
 +
                <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.</li>
 +
            </ul>|}}
 +
        </td>
 +
    </tr>{{#ifeq: {{{rs485}}} | 1 |
 +
    <tr>
 +
        <td><span style="color:blue">RS485:</span> Full Duplex</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Enables RS485 full duplex.</td>
 +
    </tr>|}}
 
     <tr>
 
     <tr>
 
     <td>Enable custom register block</td>
 
     <td>Enable custom register block</td>
         <td>off | on; default: <b>off</b></td>
+
         <td>off {{!}} <span style="color:blue">on</span>; default: <b>off</b></td>
 
         <td>Allows the usage of custom register block.</td>
 
         <td>Allows the usage of custom register block.</td>
 +
    </tr>
 +
    <tr>
 +
    <td><span style="color:blue">Register file path</span></td>
 +
        <td>path; default: <b>/tmp/regfile</b></td>
 +
        <td>Path to file in which the custom register block will be stored. Files inside /tmp or /var are stored in RAM. They vanish after reboot, but do not degrade flash memory. Files elsewhere are stored in flash memory. They remain after reboot, but degrade flash memory (severely, if operations are frequent).</td>
 +
    </tr>
 +
    <tr>
 +
    <td><span style="color:blue">First register number</span></td>
 +
        <td>integer [1025..65536]; default: <b>1025</b></td>
 +
        <td>First register in custom register block</td>
 +
    </tr>
 +
    <tr>
 +
    <td><span style="color:blue">Register count</span></td>
 +
        <td>integer [1..64512]; default: <b>128</b></td>
 +
        <td>Path to file in which the custom register block will be stored. Files inside /tmp or /var are stored in RAM. They vanish after reboot, but do not degrade flash memory. Files elsewhere are stored in flash memory. They remain after reboot, but degrade flash memory (severely, if operations are frequent).</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
 +
 +
|}}
 +
 +
==Modbus Registers==
  
 
{{Template:Networking_rutos_manual_modbus_modbus_tcp_get_parameters_table  
 
{{Template:Networking_rutos_manual_modbus_modbus_tcp_get_parameters_table  
Line 71: Line 210:
 
|analog = {{{analog}}}
 
|analog = {{{analog}}}
 
|gps = {{{gps}}}
 
|gps = {{{gps}}}
 +
|dualsim = {{{dualsim}}}
 
}}
 
}}
  
 
{{Template:Networking_rutos_manual_modbus_modbus_tcp_set_parameters_table  
 
{{Template:Networking_rutos_manual_modbus_modbus_tcp_set_parameters_table  
|wifi={{{wifi}}}
+
|wifi = {{{wifi}}}
|mobile={{{mobile}}}
+
|mobile = {{{mobile}}}
|series={{{series}}}
+
|series = {{{series}}}
|name={{{name}}}
+
|name = {{{name}}}
 +
|dualsim = {{{dualsim}}}
 
}}
 
}}
 
==Modbus TCP Master==
 
==Modbus TCP Master==
Line 86: Line 227:
  
 
After clicking 'Add' you will be redirected to the newly added slave's configuration page.
 
After clicking 'Add' you will be redirected to the newly added slave's configuration page.
 
You can create a maximum of 10 slave configurations.
 
  
 
===Slave Device Configuration===
 
===Slave Device Configuration===
Line 93: Line 232:
 
The <b>Slave Device Configuration</b> section is used to configure the parameters of Modbus TCP slaves that the Master (this {{{name}}} device) will be querying with requests. The figure below is an example of the Slave Device Configuration and the table below provides information on the fields contained in that section:
 
The <b>Slave Device Configuration</b> section is used to configure the parameters of Modbus TCP slaves that the Master (this {{{name}}} device) will be querying with requests. The figure below is an example of the Slave Device Configuration and the table below provides information on the fields contained in that section:
  
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_slave_device_configuration.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_slave_device_configuration_v2.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 118: Line 257:
 
     <tr>
 
     <tr>
 
         <td>IP address</td>
 
         <td>IP address</td>
         <td>ip; default: <b>none</b></td>
+
         <td>ip4; default: <b>none</b></td>
 
         <td>Slave device's IP address.</td>
 
         <td>Slave device's IP address.</td>
 
     </tr>
 
     </tr>
Line 135: Line 274:
 
         <td>integer [1..30]; default: '''5'''</td>
 
         <td>integer [1..30]; default: '''5'''</td>
 
         <td>Maximum response wait time.</td>
 
         <td>Maximum response wait time.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Always reconnect</td>
 +
        <td>off | on; default: <b>off</b></td>
 +
        <td>Create new connection after every Modbus request.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Number of timeouts</td>
 +
        <td>integer [0..10]; default: <b>1</b></td>
 +
        <td>Skip pending request and reset connection after number of request failures.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Frequency</td>
 +
        <td>Period {{!}} Schedule; default: <b>Period</b></td>
 +
        <td></td>
 +
    </tr>
 +
    <tr>
 +
        <td>Delay</td>
 +
        <td>integer [0..999]; default: <b>0</b></td>
 +
        <td>Wait in milliseconds after connection initialization.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Period</td>
 +
        <td>integer [1..99999]; default: <b>none</b></td>
 +
        <td>Interval in seconds for sending requests to this device</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 140: Line 304:
 
===Requests Configuration===
 
===Requests Configuration===
 
----
 
----
A Modbus <b>request</b> is a way of obtaining data from Modbus slaves. The master sends a request to a slave specifying the function code to be performed. The slave then sends the requested data back to the Modbus master. You can create a maximum of 64 request configurations for each slave device.
+
A Modbus <b>request</b> is a way of obtaining data from Modbus slaves. The master sends a request to a slave specifying the function code to be performed. The slave then sends the requested data back to the Modbus master.
 +
 
 +
<span style="color:red"> <b>Note: </b></span> Modbus TCP Master uses <i>Register Number</i> instead of <i>Register Address</i> for pointing to a register. For example, to request the <i>Uptime</i> of a device, you must use <b>2</b> in the <i>First Register</i> field.
  
 
The Request Configuration list is empty by default. To add a new Request Configuration loon to the Add New Instance section. Enter a custom name into the 'Name' field and click the 'Add' button:
 
The Request Configuration list is empty by default. To add a new Request Configuration loon to the Add New Instance section. Enter a custom name into the 'Name' field and click the 'Add' button:
Line 148: Line 314:
 
The new Request Configuration should become visible in the list:
 
The new Request Configuration should become visible in the list:
  
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_v1.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 163: Line 329:
 
     <tr>
 
     <tr>
 
         <td>Data type</td>
 
         <td>Data type</td>
         <td>8bit INT | 8bit UINT | 16bit INT, high byte first | 16bit INT, low byte first | 16bit UINT, high byte first | 16bit UINT, low byte first | 32bit float, Byte order 1,2,3,4 | 32bit float, Byte order 4,3,2,1 | 32bit float, Byte order 2,1,4,3 | 32bit float, Byte order 3,4,1,2; default: <b>16bit INT, high byte first</b></td>
+
         <td>8bit INT {{!}} 8bit UINT {{!}} 16bit INT, high byte first {{!}} 16bit INT, low byte first {{!}} 16bit UINT, high byte first {{!}} 16bit UINT, low byte first {{!}} 32bit float (various Byte order) {{!}} 32bit INT (various Byte order) {{!}} 32bit UINT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool; default: <b>16bit INT, high byte first</b></td>
 
         <td>Defines how read data will be stored.</td>
 
         <td>Defines how read data will be stored.</td>
 
     </tr>
 
     </tr>
Line 183: Line 349:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>No Brackets</td>
+
         <td>Remove Brackets</td>
 
         <td>off | on; default: <b>off</b></td>
 
         <td>off | on; default: <b>off</b></td>
 
         <td>Removes the starting and ending brackets from the request (only for read requests).</td>
 
         <td>Removes the starting and ending brackets from the request (only for read requests).</td>
 +
    </tr>
 +
    <tr>
 +
        <td>off/on slider</td>
 +
        <td>off | on; default: <b>off</b></td>
 +
        <td>Turns the request on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 191: Line 362:
 
         <td>- (interactive button)</td>
 
         <td>- (interactive button)</td>
 
         <td>Deletes the request.</td>
 
         <td>Deletes the request.</td>
    </tr>
 
    <tr>
 
        <td>off/on slider</td>
 
        <td>off | on; default: <b>off</b></td>
 
        <td>Turns the request on or off.</td>
 
 
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 217: Line 383:
 
After adding the Alarm you should be redirected to its configuration page which should look similar to this:
 
After adding the Alarm you should be redirected to its configuration page which should look similar to this:
  
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_alarms_configuration.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_alarms_configuration_v1.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 236: Line 402:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Register</td>
+
         <td>Compared condition data type</td>
 +
        <td>8bit INT {{!}} 8bit UINT {{!}} 16bit INT, high byte first {{!}} 16bit INT, low byte first {{!}} 16bit UINT, high byte first {{!}} 16bit UINT, low byte first {{!}} 32bit float (various Byte order) {{!}} 32bit INT (various Byte order) {{!}} 32bit UINT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool; default: <b>16bit INT, high byte first</b></td>
 +
        <td>Select data type that will be used for checking conditions.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>First register number</td>
 
         <td>integer [1..65536]; default: <b>none</b></td>
 
         <td>integer [1..65536]; default: <b>none</b></td>
 
         <td>Number of the Modbus coil/input/holding-register/input-register to read from.</td>
 
         <td>Number of the Modbus coil/input/holding-register/input-register to read from.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Condition</td>
+
         <td>Values</td>
        <td>More than | Less than | Equal to | Not Equal to; default: <b>Equal to</b></td>
 
        <td>When a value is obtained it will be compared against the value specified in the following field. The comparison will be made in accordance with the condition specified in this field.</td>
 
    </tr>
 
    <tr>
 
        <td>Value</td>
 
 
         <td>various; default: <b>none</b></td>
 
         <td>various; default: <b>none</b></td>
 
         <td>The value against which the read data will be compared.</td>
 
         <td>The value against which the read data will be compared.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Value</td>
+
         <td>Condition</td>
         <td>integer [0..65535]; default: <b>none</b></td>
+
         <td>More than | Less than | Equal to | Not Equal to | Less or equal | More or equal; default: <b>More than</b></td>
         <td>The value against which the read data will be compared.</td>
+
         <td>When a value is obtained it will be compared against the value specified in the following field. The comparison will be made in accordance with the condition specified in this field.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 262: Line 428:
 
     <tr>
 
     <tr>
 
         <td>Redundancy protection</td>
 
         <td>Redundancy protection</td>
         <td>off | on; default: <b>off</b></td>
+
         <td>off | <span style="color:blue">on</span>; default: <b>off</b></td>
 
         <td>Protection against executing a configured action too often.</td>
 
         <td>Protection against executing a configured action too often.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Redundancy protection period</td>
+
         <td><span style="color:blue">Redundancy protection period</span></td>
 
         <td>integer [1..86400]; default: <b>none</b></td>
 
         <td>integer [1..86400]; default: <b>none</b></td>
 
         <td>Duration to activate redundancy protection for, measured in seconds. This field becomes visible only when 'Redundancy protection' is turned on.</td>
 
         <td>Duration to activate redundancy protection for, measured in seconds. This field becomes visible only when 'Redundancy protection' is turned on.</td>
Line 272: Line 438:
 
     <tr>
 
     <tr>
 
         <td>Action</td>
 
         <td>Action</td>
         <td>SMS | MODBUS Write Request; default: <b>MODBUS Write Request</b></td>
+
         <td>{{#ifeq:{{{mobile}}}|1|SMS {{!}}|}} MODBUS Write Request{{#switch:{{{series}}}|TCR1=|TRB2=|#default= {{!}} Trigger output}}; default: <b>MODBUS Write Request</b></td>
 
         <td>Action that will be taken if the condition is met. Possible actions:
 
         <td>Action that will be taken if the condition is met. Possible actions:
             <ul>
+
             <ul>{{#ifeq: {{{mobile}}} | 1 |
                 <li><b>SMS</b> - sends and SMS message to a specified recipient(s).</li>
+
                 <li><b>SMS</b> - sends and SMS message to a specified recipient(s).</li>|}}
 
                 <li><b>Modbus Request</b> - sends a Modbus Write request to a specified slave.</li>
 
                 <li><b>Modbus Request</b> - sends a Modbus Write request to a specified slave.</li>
 +
{{#switch:{{{series}}}|TCR1=|TRB2=|#default=<li><b>Trigger output</b> - changes state of selected I/O output pin.</li>}}
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
     </tr>
+
     </tr>{{#ifeq: {{{mobile}}} | 1 |
 
     <tr>
 
     <tr>
 
         <td><span style="color: #0054a6;">SMS: Message</span></td>
 
         <td><span style="color: #0054a6;">SMS: Message</span></td>
Line 289: Line 456:
 
         <td>phone number; default: <b>none</b></td>
 
         <td>phone number; default: <b>none</b></td>
 
         <td>Recipient's phone number.</td>
 
         <td>Recipient's phone number.</td>
     </tr>
+
     </tr>|}}
 
     <tr>
 
     <tr>
 
         <td><span style="color: purple;">MODBUS Write Request: IP address</span></td>
 
         <td><span style="color: purple;">MODBUS Write Request: IP address</span></td>
Line 312: Line 479:
 
     <tr>
 
     <tr>
 
         <td><span style="color: purple;">MODBUS Write Request: Modbus function</span></td>
 
         <td><span style="color: purple;">MODBUS Write Request: Modbus function</span></td>
         <td>Read Force Single Coil (5) | Preset Single Register (6) | Force Multiple Coils (15) | Force Multiple Registers (16); default: <b>Force Single Coil (5)</b></td>
+
         <td>Set Single Coil (5) | Set Single Register (6) | Set Multiple Coils (15) | Set Multiple Registers (16); default: <b>Set Single Coil (5)</b></td>
 
         <td>A function code specifies the type of register being addressed by a Modbus request.</td>
 
         <td>A function code specifies the type of register being addressed by a Modbus request.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td><span style="color: purple;">MODBUS Write Request: First register</span></td>
+
        <td><span style="color: purple;">MODBUS Write Request: Executed action data type</span></td>
 +
        <td>8bit INT | 8bit UINT | 16bit INT, high byte first | 16bit INT, low byte first | 16bit UINT, high byte first | 16bit UINT, low byte first | 32bit float (various Byte order) | 32bit INT (various Byte order) | 32bit UNIT (various Byte order) | ASCII | Hex | Bool; default: <b>Bool</b></td>
 +
        <td>Select data type that will be used for executing action.</td>
 +
    </tr>
 +
    <tr>
 +
         <td><span style="color: purple;">MODBUS Write Request: First register number</span></td>
 
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>Begins reading from the register specified in this field.</td>
 
         <td>Begins reading from the register specified in this field.</td>
Line 324: Line 496:
 
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>Register/Coil values to be written (multiple values must be separated by space character).</td>
 
         <td>Register/Coil values to be written (multiple values must be separated by space character).</td>
 +
    </tr>{{#switch:{{{series}}}|TCR1=|TRB2=|#default=
 +
    <tr>
 +
        <td><span style="color: green;">Trigger output: Output</span></td>{{#switch:{{{series}}}
 +
| RUTX|RUT2 =<td>4PIN output; default: <b>4PIN output</b></td>
 +
| TRB1|RUT3 =<td>Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: <b>Configurable Input/Output (3)</b></td>
 +
| RUT9 =<td>Open collector output {{!}} Relay output {{!}} 4PIN output; default: <b>Open collector output</b></td>}}
 +
        <td>Selects which output will be triggered.</td>
 
     </tr>
 
     </tr>
 +
    <tr>
 +
        <td><span style="color: green;">Trigger output: I/O Action</span></td>
 +
        <td>Turn On {{!}} Turn Off {{!}} Invert; default: <b>Turn On</b></td>
 +
        <td>Selects the action performed on the output.</td>
 +
    </tr>}}
 
</table>
 
</table>
 
{{#ifeq: {{{serial}}} | 1 |
 
{{#ifeq: {{{serial}}} | 1 |
Line 330: Line 514:
  
 
The <b>Modbus Serial Master</b> page is used to configure the device as a Modbus RTU Master. Modbus RTU (remote terminal unit) is a serial communication protocol mainly used in communication via serial interfaces.
 
The <b>Modbus Serial Master</b> page is used to configure the device as a Modbus RTU Master. Modbus RTU (remote terminal unit) is a serial communication protocol mainly used in communication via serial interfaces.
{{#ifeq: {{{rs232}}} | 1 |
+
 
===RS232===
+
<!--<u><b>Note:</b> Modbus Serial Master is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>-->
 +
 
 +
===Modbus Serial Device Configuration===
 +
----
 +
This section is used to create Modbus Serial Master's slave device instances. You may create a Serial Device instance for each supported serial interface.
 +
 
 +
[[File:Networking_rutos_manual_modbus_modbus_serial_master_device_configuration.png|border|class=tlt-border]]
 +
 
 +
By default there are no instances created. To add a new serial device configuration, enter an instance name and click the 'Add' button.
 +
 
 +
[[File:Networking_rutos_manual_modbus_modbus_serial_master_device_configuration_add_button_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}.png|border|class=tlt-border]]
 +
 
 +
After clicking 'Add' you will be redirected to the newly added device's configuration page.
 +
 
 +
====RS Device Modbus Master Configuration====
 
----
 
----
This section is used to configure the Modbus Serial Master's <b>RS232</b> serial interface settings. Refer to the figure and table below for information on RS232 configuration.
+
This section is used to configure the Modbus Serial Master's slave device interface settings.
  
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs232_configuration.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_serial_master_device_configuration_rs_device_modbus_master_configuration_v1_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 344: Line 542:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Enabled</td>
+
         <td>Enable</td>
         <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
+
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Turns Modbus Serial Master configuration via RS232 on or off. Both this and RS232 from Services → [[{{{name}}} RS232|RS232]] cannot be enabled at the same time.</td>
+
        <td>Enables this Modbus Serial Device instance configuration.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Name</td>
 +
        <td>string; default: <b>none</b></td>
 +
         <td>Name of the serial device instance. Used for management purposes only.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Device</td>
 +
        <td>{{Template: Networking rutos manual serial ports| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}; default: <b>{{Template: Networking rutos manual default serial port| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}</b></td>
 +
        <td>Specifies which serial port will be used for serial communication.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Baud rate</td>
 
         <td>Baud rate</td>
         <td>300 <nowiki>|</nowiki> 1200 <nowiki>|</nowiki> 2400 <nowiki>|</nowiki> 4800 <nowiki>|</nowiki> 9600 <nowiki>|</nowiki> 19200 <nowiki>|</nowiki> 38400 <nowiki>|</nowiki> 57600 <nowiki>|</nowiki> 115200; default: <b>115200</b></td>
+
         <td>300 {{!}} 1200 {{!}} 2400 {{!}} 4800 {{!}} 9600 {{!}} 19200 {{!}} 38400 {{!}} 57600 {{!}} 115200{{#ifeq: {{{rs485}}} | 1 | {{!}} 230400 {{!}} 460800 {{!}} 921600 {{!}} 1000000 {{!}} 3000000|}}; default: <b>9600</b></td>
 
         <td>Serial data transmission rate (in bits per second).</td>
 
         <td>Serial data transmission rate (in bits per second).</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Data bits</td>
 
         <td>Data bits</td>
         <td>5 <nowiki>|</nowiki> 6 <nowiki>|</nowiki> 7 <nowiki>|</nowiki> 8; default: <b>8</b></td>
+
         <td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
 
         <td>Number of data bits for each character.</td>
 
         <td>Number of data bits for each character.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Stop bits</td>
 +
        <td>1{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} 2|}}; default: <b>1</b></td>
 +
        <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Parity</td>
 
         <td>Parity</td>
         <td>None <nowiki>|</nowiki> Even <nowiki>|</nowiki> Odd; default: <b>None</b></td>
+
         <td>Even {{!}} Odd{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} Mark {{!}} Space|}} {{!}} None; default: <b>None</b></td>
 
         <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
 
         <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
 
             <ul>
 
             <ul>
 
                 <li><b>None</b> (<b>N</b>) - no parity method is used.</li>
 
                 <li><b>None</b> (<b>N</b>) - no parity method is used.</li>
 
                 <li><b>Odd</b> (<b>O</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.</li>
 
                 <li><b>Odd</b> (<b>O</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.</li>
                 <li><b>Even</b> (<b>E</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be even.</li>
+
                 <li><b>Even</b> (<b>E</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be even.</li>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|<li><b>Space</b> (<b>s</b>) - the parity bit will always be a binary 0.</li>
 +
                <li><b>Mark</b> (<b>M</b>) - the parity bit will always be a binary 1.</li>|}}
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
    </tr>
 
    <tr>
 
        <td>Stop bits</td>
 
        <td>1 <nowiki>|</nowiki> 2; default: <b>1</b></td>
 
        <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Flow control</td>
 
         <td>Flow control</td>
         <td>None <nowiki>|</nowiki> RTS/CTS <nowiki>|</nowiki> Xon/Xoff; default: <b>None</b></td>
+
         <td>None {{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} RTS/CTS {{!}} Xon/Xoff|}}; default: <b>None</b></td>
 
         <td>In many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking.
 
         <td>In many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking.
            <ul>
+
{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|<ul>
 
                 <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li>
 
                 <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li>
 
                 <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.</li>
 
                 <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.</li>
             </ul>
+
             </ul>|}}
 
         </td>
 
         </td>
     </tr>
+
     </tr>{{#ifeq: {{{rs485}}} | 1 |
 +
    <tr>
 +
        <td><span style="color:blue">RS485:</span> Full Duplex</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Enables RS485 full duplex.</td>
 +
    </tr>|}}
 
</table>
 
</table>
  
====RS232 Slave Devices List====
+
===Modbus Slave Device Configuration===
 
----
 
----
The <b>RS232 Slave Devices List</b> section is used to configure the parameters of Modbus RUT slaves that the Master (this {{{name}}} device) will be querying with requests.
+
This section is used to create slave instances that the Master (this {{{name}}} device) will be querying with requests.
  
The list is empty by default. In order to create a new slave device configuration, click the 'Add' button.
+
[[File:Networking_rutos_manual_modbus_modbus_serial_master_modbus_slave_device_configuration_v1.png|border|class=tlt-border]]
  
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs232_slave_devices_list_add_button.png|border|class=tlt-border]]
+
By default there are no instances created. To add a new slave configuration, enter an instance name, select a serial device instance and click the 'Add' button.
  
Then click the 'Edit' button next to the newly added slave device in order to begin configuration.
+
[[File:Networking_rutos_manual_modbus_modbus_serial_master_modbus_slave_device_configuration_add_button_v1.png|border|class=tlt-border]]
  
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs232_slave_devices_list_edit_button.png|border|class=tlt-border]]
+
After clicking 'Add' you will be redirected to the newly added slave's configuration page.
  
=====RS232 Slave Device Configuration=====
+
====Slave Device Configuration====
 
----
 
----
The <b>RS232 Slave Device Configuration</b> section is used to configure the parameters of Modbus RTU slaves that the Master (this {{{name}}} device) will be querying with requests. The figure below is an example of the RS232 Slave Device Configuration and the table below provides information on the fields contained in that section:
+
The <b>Slave Device Configuration</b> section is used to configure the parameters of Modbus RTU slaves that the Master (this {{{name}}} device) will be querying with requests. The figure below is an example of the Slave Device Configuration and the table below provides information on the fields contained in that section:
  
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs232_slave_device_configuration.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_serial_master_slave_device_configuration_v1.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 412: Line 626:
 
     <tr>
 
     <tr>
 
         <td>Enabled</td>
 
         <td>Enabled</td>
         <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
+
         <td>off {{!}} on; default: <b>off</b></td>
 
         <td>Turns communication with the slave device on or off.</td>
 
         <td>Turns communication with the slave device on or off.</td>
 
     </tr>
 
     </tr>
Line 419: Line 633:
 
         <td>string; default: <b>none</b></td>
 
         <td>string; default: <b>none</b></td>
 
         <td>Slave device's name, used for easier management purposes.</td>
 
         <td>Slave device's name, used for easier management purposes.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Slave device</td>
 +
        <td><i>slave device instance</i>; default: <b>none</b></td>
 +
        <td>Specifies which serial device will be used on this slave.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 424: Line 643:
 
         <td>integer [0..255]; default: <b>none</b></td>
 
         <td>integer [0..255]; default: <b>none</b></td>
 
         <td>Slave ID. Each slave in a network is assigned a unique identifier ranging from 1 to 255. When the master requests data from a slave, the first byte it sends is the Slave ID. When set to 0, the slave will respond to requests addressed to any ID.</td>
 
         <td>Slave ID. Each slave in a network is assigned a unique identifier ranging from 1 to 255. When the master requests data from a slave, the first byte it sends is the Slave ID. When set to 0, the slave will respond to requests addressed to any ID.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Always reconnect</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Create new connection after every Modbus request.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Number of timeouts</td>
 +
        <td>integer [0..10]; default: <b>1</b></td>
 +
        <td>Skip pending request and reset connection after number of request failures.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Frequency</td>
 +
        <td>Period {{!}} Schedule; default: <b>Period</b></td>
 +
        <td></td>
 +
    </tr>
 +
    <tr>
 +
        <td>Delay</td>
 +
        <td>integer [0..999]; default: <b>0</b></td>
 +
        <td>Wait in milliseconds after connection initialization.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Period</td>
 
         <td>Period</td>
         <td>integer [1..86400]; default: <b>60</b></td>
+
         <td>integer [1..99999]; default: <b>none</b></td>
 
         <td>Interval at which requests are sent to the slave device.</td>
 
         <td>Interval at which requests are sent to the slave device.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Timeout</td>
 
         <td>Timeout</td>
         <td>integer [1..30]; default: <b>5</b></td>
+
         <td>integer [1..60]; default: <b>1</b></td>
 
         <td>Maximum response wait time.</td>
 
         <td>Maximum response wait time.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
 +
 
=====Requests Configuration=====
 
=====Requests Configuration=====
 
----
 
----
A Modbus <b>request</b> is a way of obtaining data from Modbus slaves. The master sends a request to a slave specifying the function code to be performed. The slave then sends the requested data back to the Modbus master. You can create a maximum of 64 request configurations for each slave device.
+
A Modbus <b>request</b> is a way of obtaining data from Modbus slaves. The master sends a request to a slave specifying the function code to be performed. The slave then sends the requested data back to the Modbus master.  
 +
 
 +
<span style="color:red"> <b>Note: </b></span> Modbus Serial Master uses <i>Register Number</i> instead of <i>Register Address</i> for pointing to a register. For example, to request the <i>Uptime</i> of a device, you must use <b>2</b> in the <i>First Register</i> field.
  
 
The Request Configuration list is empty by default. To add a new Request Configuration loon to the Add New Instance section. Enter a custom name into the 'Name' field and click the 'Add' button:
 
The Request Configuration list is empty by default. To add a new Request Configuration loon to the Add New Instance section. Enter a custom name into the 'Name' field and click the 'Add' button:
Line 446: Line 688:
 
The new Request Configuration should become visible in the list:
 
The new Request Configuration should become visible in the list:
  
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_v1.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 461: Line 703:
 
     <tr>
 
     <tr>
 
         <td>Data type</td>
 
         <td>Data type</td>
         <td>8bit INT <nowiki>|</nowiki> 8bit UINT <nowiki>|</nowiki> 16bit INT, high byte first <nowiki>|</nowiki> 16bit INT, low byte first <nowiki>|</nowiki> 16bit UINT, high byte first <nowiki>|</nowiki> 16bit UINT, low byte first <nowiki>|</nowiki> 32bit float, Byte order 1,2,3,4 <nowiki>|</nowiki> 32bit float, Byte order 4,3,2,1 <nowiki>|</nowiki> 32bit float, Byte order 2,1,4,3 <nowiki>|</nowiki> 32bit float, Byte order 3,4,1,2; default: <b>16bit INT, high byte first</b></td>
+
         <td>8bit INT {{!}} 8bit UINT {{!}} 16bit INT, high byte first {{!}} 16bit INT, low byte first {{!}} 16bit UINT, high byte first {{!}} 16bit UINT, low byte first {{!}} 32bit float (various Byte order) {{!}} 32bit INT (various Byte order) {{!}} 32bit UINT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool; default: <b>16bit INT, high byte first</b></td>
 
         <td>Defines how read data will be stored.</td>
 
         <td>Defines how read data will be stored.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Function</td>
 
         <td>Function</td>
         <td>Read coils (1) <nowiki>|</nowiki> Read input coils (2) <nowiki>|</nowiki> Read holding registers (3) <nowiki>|</nowiki> Read input registers (4) <nowiki>|</nowiki> Set single coil (5) <nowiki>|</nowiki> Set single coil register (6) <nowiki>|</nowiki> Set multiple coils (15) <nowiki>|</nowiki> Set multiple holding registers (16); default: <b>Read holding registers (3)</b></td>
+
         <td>Read coils (1) {{!}} Read input coils (2) {{!}} Read holding registers (3) {{!}} Read input registers (4) {{!}} Set single coil (5) {{!}} Set single coil register (6) {{!}} Set multiple coils (15) {{!}} Set multiple holding registers (16); default: <b>Read holding registers (3)</b></td>
 
         <td>Specifies the type of register being addressed by a Modbus request.  
 
         <td>Specifies the type of register being addressed by a Modbus request.  
 
         </td>
 
         </td>
Line 481: Line 723:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>No Brackets</td>
+
         <td>Remove Brackets</td>
         <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
+
         <td>off {{!}} on; default: <b>off</b></td>
 
         <td>Removes the starting and ending brackets from the request (only for read requests).</td>
 
         <td>Removes the starting and ending brackets from the request (only for read requests).</td>
 +
    </tr>
 +
    <tr>
 +
        <td>off/on slider</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Turns the request on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 489: Line 736:
 
         <td>- (interactive button)</td>
 
         <td>- (interactive button)</td>
 
         <td>Deletes the request.</td>
 
         <td>Deletes the request.</td>
    </tr>
 
    <tr>
 
        <td>off/on slider</td>
 
        <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
 
        <td>Turns the request on or off.</td>
 
 
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 512: Line 754:
  
 
[[File:Networking_rutos_manual_modbus_modbus_serial_master_modbus_master_alarms_add_button.png|border|class=tlt-border]]
 
[[File:Networking_rutos_manual_modbus_modbus_serial_master_modbus_master_alarms_add_button.png|border|class=tlt-border]]
 
Then click the 'Edit' button next to the newly created Alarm to configuration.
 
 
[[File:Networking_rutos_manual_modbus_modbus_serial_master_modbus_master_alarms_edit_button.png|border|class=tlt-border]]
 
  
 
After this you should be redirected to that Alarm's configuration page which should look similar to this:
 
After this you should be redirected to that Alarm's configuration page which should look similar to this:
  
[[File:Networking_rutos_manual_modbus_modbus_serial_master_modbus_master_alarms_alarm_configuration.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_alarms_configuration_v1.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 529: Line 767:
 
     <tr>
 
     <tr>
 
         <td>Enabled</td>
 
         <td>Enabled</td>
         <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
+
         <td>off {{!}} on; default: <b>off</b></td>
 
         <td>Turns the alarm on or off.</td>
 
         <td>Turns the alarm on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Function code</td>
 
         <td>Function code</td>
         <td>Read Coil Status (1) <nowiki>|</nowiki> Read Input Status (2) <nowiki>|</nowiki> Read Holding Registers (3) <nowiki>|</nowiki> Read Input Registers (4); default: <b>Read Coil Status (1)</b></td>
+
         <td>Read Coil Status (1) {{!}} Read Input Status (2) {{!}} Read Holding Registers (3) {{!}} Read Input Registers (4); default: <b>Read Coil Status (1)</b></td>
         <td>Modbus function used for this alarm's Modbus request. The Modbus TCP Master (this {{{name}}} device) perform this request as often as specified in the 'Period' field in [[#RS485_Slave_Device_Configuration|RS485 Slave Device Configuration]].</td>
+
         <td>Modbus function used for this alarm's Modbus request. The Modbus TCP Master (this {{{name}}} device) perform this request as often as specified in the 'Period' field in [[#Slave_Device_Configuration|Slave Device Configuration]].</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Register</td>
+
         <td>Compared condition data type</td>
 +
        <td>8bit INT {{!}} 8bit UINT {{!}} 16bit INT, high byte first {{!}} 16bit INT, low byte first {{!}} 16bit UINT, high byte first {{!}} 16bit UINT, low byte first {{!}} 32bit float (various Byte order) {{!}} 32bit INT (various Byte order) {{!}} 32bit UINT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool; default: <b>16bit INT, high byte first</b></td>
 +
        <td>Select data type that will be used for checking conditions.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>First register number</td>
 
         <td>integer [1..65536]; default: <b>none</b></td>
 
         <td>integer [1..65536]; default: <b>none</b></td>
 
         <td>Number of the Modbus coil/input/holding-register/input-register to read from.</td>
 
         <td>Number of the Modbus coil/input/holding-register/input-register to read from.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Condition</td>
+
         <td>Values</td>
        <td>More than <nowiki>|</nowiki> Less than <nowiki>|</nowiki> Equal to <nowiki>|</nowiki> Not Equal to; default: <b>Equal to</b></td>
 
        <td>When a value is obtained it will be compared against the value specified in the following field. The comparison will be made in accordance with the condition specified in this field.</td>
 
    </tr>
 
    <tr>
 
        <td>Value</td>
 
 
         <td>various; default: <b>none</b></td>
 
         <td>various; default: <b>none</b></td>
 
         <td>The value against which the read data will be compared.</td>
 
         <td>The value against which the read data will be compared.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Value</td>
+
         <td>Condition</td>
         <td>integer [0..65535]; default: <b>none</b></td>
+
         <td>More than {{!}} Less than {{!}} Equal to {{!}} Not Equal to {{!}} Less or equal {{!}} More or equal; default: <b>More than</b></td>
         <td>The value against which the read data will be compared.</td>
+
         <td>When a value is obtained it will be compared against the value specified in the following field. The comparison will be made in accordance with the condition specified in this field.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Action frequency</td>
 
         <td>Action frequency</td>
         <td>Every trigger <nowiki>|</nowiki> First trigger; default: <b>Every trigger</b></td>
+
         <td>Every trigger {{!}} First trigger; default: <b>Every trigger</b></td>
 
         <td>Describes how frequently the specified action will be taken.</td>
 
         <td>Describes how frequently the specified action will be taken.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Redundancy protection</td>
 
         <td>Redundancy protection</td>
         <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
+
         <td>off {{!}} <span style="color:blue">on</span>; default: <b>off</b></td>
 
         <td>Protection against executing a configured action too often.</td>
 
         <td>Protection against executing a configured action too often.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Redundancy protection period</td>
+
         <td><span style="color:blue">Redundancy protection period</span></td>
 
         <td>integer [1..86400]; default: <b>none</b></td>
 
         <td>integer [1..86400]; default: <b>none</b></td>
 
         <td>Duration to activate redundancy protection for, measured in seconds. This field becomes visible only when 'Redundancy protection' is turned on.</td>
 
         <td>Duration to activate redundancy protection for, measured in seconds. This field becomes visible only when 'Redundancy protection' is turned on.</td>
Line 574: Line 812:
 
     <tr>
 
     <tr>
 
         <td>Action</td>
 
         <td>Action</td>
         <td>SMS <nowiki>|</nowiki> MODBUS Write Request; default: <b>MODBUS Write Request</b></td>
+
         <td>{{#ifeq:{{{mobile}}}|1|SMS {{!}}|}} MODBUS Write Request{{#switch:{{{series}}}|TCR1=|TRB2=|#default= {{!}} Trigger output}}; default: <b>MODBUS Write Request</b></td>
 
         <td>Action that will be taken if the condition is met. Possible actions:
 
         <td>Action that will be taken if the condition is met. Possible actions:
             <ul>
+
             <ul>{{#ifeq: {{{mobile}}} | 1 |
                 <li><b>SMS</b> - sends and SMS message to a specified recipient(s).</li>
+
                 <li><b>SMS</b> - sends and SMS message to a specified recipient(s).</li>|}}
 
                 <li><b>Modbus Request</b> - sends a Modbus Write request to a specified slave.</li>
 
                 <li><b>Modbus Request</b> - sends a Modbus Write request to a specified slave.</li>
 +
{{#switch:{{{series}}}|TCR1=|TRB2=|#default=<li><b>Trigger output</b> - changes state of selected I/O output pin.</li>}}
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
     </tr>
+
     </tr>{{#ifeq: {{{mobile}}} | 1 |
 
     <tr>
 
     <tr>
 
         <td><span style="color: #0054a6;">SMS: Message</span></td>
 
         <td><span style="color: #0054a6;">SMS: Message</span></td>
Line 591: Line 830:
 
         <td>phone number; default: <b>none</b></td>
 
         <td>phone number; default: <b>none</b></td>
 
         <td>Recipient's phone number.</td>
 
         <td>Recipient's phone number.</td>
     </tr>
+
     </tr>|}}
 
     <tr>
 
     <tr>
 
         <td><span style="color: purple;">MODBUS Write Request: Timeout</span></td>
 
         <td><span style="color: purple;">MODBUS Write Request: Timeout</span></td>
Line 604: Line 843:
 
     <tr>
 
     <tr>
 
         <td><span style="color: purple;">MODBUS Write Request: Modbus function</span></td>
 
         <td><span style="color: purple;">MODBUS Write Request: Modbus function</span></td>
         <td>Read Force Single Coil (5) <nowiki>|</nowiki> Preset Single Register (6) <nowiki>|</nowiki> Force Multiple Coils (15) <nowiki>|</nowiki> Force Multiple Registers (16); default: <b>Force Single Coil (5)</b></td>
+
         <td>Read Single Coil (5) {{!}} Set Single Register (6) {{!}} Set Multiple Coils (15) {{!}} Set Multiple Registers (16); default: <b>Set Single Coil (5)</b></td>
 
         <td>A function code specifies the type of register being addressed by a Modbus request.</td>
 
         <td>A function code specifies the type of register being addressed by a Modbus request.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td><span style="color: purple;">MODBUS Write Request: First register</span></td>
+
        <td><span style="color: purple;">MODBUS Write Request: Executed action data type</span></td>
 +
        <td>8bit INT {{!}} 8bit UINT {{!}} 16bit INT, high byte first {{!}} 16bit INT, low byte first {{!}} 16bit UINT, high byte first {{!}} 16bit UINT, low byte first {{!}} 32bit float (various Byte order) {{!}} 32bit INT (various Byte order) {{!}} 32bit UNIT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool; default: <b>Bool</b></td>
 +
        <td>Select data type that will be used for executing action.</td>
 +
    </tr>
 +
    <tr>
 +
         <td><span style="color: purple;">MODBUS Write Request: First register number</span></td>
 
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>Begins reading from the register specified in this field.</td>
 
         <td>Begins reading from the register specified in this field.</td>
Line 616: Line 860:
 
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>Register/Coil values to be written (multiple values must be separated by space character).</td>
 
         <td>Register/Coil values to be written (multiple values must be separated by space character).</td>
 +
    </tr>{{#switch:{{{series}}}|TCR1=|TRB2=|#default=
 +
    <tr>
 +
        <td><span style="color: green;">Trigger output: Output</span></td>{{#switch:{{{series}}}
 +
| RUTX|RUT2 =<td>4PIN output; default: <b>4PIN output</b></td>
 +
| TRB1|RUT3 =<td>Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: <b>Configurable Input/Output (3)</b></td>
 +
| RUT9 =<td>Open collector output {{!}} Relay output {{!}} 4PIN output; default: <b>Open collector output</b></td>}}
 +
        <td>Selects which output will be triggered.</td>
 
     </tr>
 
     </tr>
 +
    <tr>
 +
        <td><span style="color: green;">Trigger output: I/O Action</span></td>
 +
        <td>Turn On {{!}} Turn Off {{!}} Invert; default: <b>Turn On</b></td>
 +
        <td>Selects the action performed on the output.</td>
 +
    </tr>}}
 
</table>
 
</table>
|}}|}}{{#ifeq: {{{rs485}}} | 1 |
+
|}}
<h3>RS485</h3>
+
{{#ifeq: {{{console}}} | 1 |
 +
===Console===
 
----
 
----
This section is used to configure the Modbus Serial Master's <b>RS485</b> serial interface settings. Refer to the figure and table below for information on RS485 configuration.
+
This section is used to configure the Modbus Serial Master's <b>Console</b> serial interface settings. Refer to the figure and table below for information on Console configuration.
  
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs485_configuration.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_serial_master_console_configuration.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 633: Line 890:
 
     <tr>
 
     <tr>
 
         <td>Enabled</td>
 
         <td>Enabled</td>
         <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
+
         <td>off {{!}} on; default: <b>off</b></td>
 
         <td>Turns Modbus Serial Master configuration via RS232 on or off. Both this and RS232 from Services → [[{{{name}}} RS232|RS232]] cannot be enabled at the same time.</td>
 
         <td>Turns Modbus Serial Master configuration via RS232 on or off. Both this and RS232 from Services → [[{{{name}}} RS232|RS232]] cannot be enabled at the same time.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Baud rate</td>
 
         <td>Baud rate</td>
         <td>300 <nowiki>|</nowiki> 1200 <nowiki>|</nowiki> 2400 <nowiki>|</nowiki> 4800 <nowiki>|</nowiki> 9600 <nowiki>|</nowiki> 19200 <nowiki>|</nowiki> 38400 <nowiki>|</nowiki> 57600 <nowiki>|</nowiki> 115200; default: <b>115200</b></td>
+
         <td>300 {{!}} 1200 {{!}} 2400 {{!}} 4800 {{!}} 9600 {{!}} 19200 {{!}} 38400 {{!}} 57600 {{!}} 115200 {{!}} 1000000; default: <b>115200</b></td>
 
         <td>Serial data transmission rate (in bits per second).</td>
 
         <td>Serial data transmission rate (in bits per second).</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Data bits</td>
 
         <td>Data bits</td>
         <td>5 <nowiki>|</nowiki> 6 <nowiki>|</nowiki> 7 <nowiki>|</nowiki> 8; default: <b>8</b></td>
+
         <td>5 {{!}} 6 {{!}} 7 {{!}} 8; default: <b>8</b></td>
 
         <td>Number of data bits for each character.</td>
 
         <td>Number of data bits for each character.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Parity</td>
 
         <td>Parity</td>
         <td>None <nowiki>|</nowiki> Even <nowiki>|</nowiki> Odd; default: <b>None</b></td>
+
         <td>None {{!}} Even {{!}} Odd; default: <b>None</b></td>
 
         <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
 
         <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
 
             <ul>
 
             <ul>
Line 659: Line 916:
 
     <tr>
 
     <tr>
 
         <td>Stop bits</td>
 
         <td>Stop bits</td>
         <td>1 <nowiki>|</nowiki> 2; default: <b>1</b></td>
+
         <td>1 {{!}} 2; default: <b>1</b></td>
 
         <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td>
 
         <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Flow control</td>
 
         <td>Flow control</td>
         <td>None <nowiki>|</nowiki> RTS/CTS <nowiki>|</nowiki> Xon/Xoff; default: <b>None</b></td>
+
         <td>None {{!}} RTS/CTS {{!}} Xon/Xoff; default: <b>None</b></td>
 
         <td>In many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking.
 
         <td>In many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking.
 
             <ul>
 
             <ul>
Line 674: Line 931:
 
</table>
 
</table>
  
====RS485 Slave Devices List====
+
====Console Slave Devices List====
 
----
 
----
The <b>RS485 Slave Devices List</b> section is used to configure the parameters of Modbus RUT slaves that the Master (this {{{name}}} device) will be querying with requests.
+
The <b>Console Slave Devices List</b> section is used to configure the parameters of Modbus RTU slaves that the Master (this {{{name}}} device) will be querying with requests.
 
 
The list is empty by default. In order to create a new slave device configuration, click the 'Add' button.
 
  
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs485_slave_devices_list_add_button.png|border|class=tlt-border]]
+
The list is empty by default. In order to create a new slave device configuration, click the 'Add' button. A new configuration window should pop up.
  
Then click the 'Edit' button next to the newly added slave device in order to begin configuration.
+
[[File:Networking_rutos_manual_modbus_modbus_serial_master_console_slave_devices_list_add_button.png|border|class=tlt-border]]
  
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs485_slave_devices_list_edit_button.png|border|class=tlt-border]]
+
=====Slave Device Configuration=====
 
 
=====RS485 Slave Device Configuration=====
 
 
----
 
----
The <b>RS485 Slave Device Configuration</b> section is used to configure the parameters of Modbus RTU slaves that the Master (this {{{name}}} device) will be querying with requests. The figure below is an example of the RS485 Slave Device Configuration and the table below provides information on the fields contained in that section:
+
The <b>Slave Device Configuration</b> section is used to configure the parameters of Modbus RTU slaves that the Master (this {{{name}}} device) will be querying with requests. The figure below is an example of the Slave Device Configuration and the table below provides information on the fields contained in that section:
  
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs485_slave_device_configuration.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs232_slave_device_configuration.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 700: Line 953:
 
     <tr>
 
     <tr>
 
         <td>Enabled</td>
 
         <td>Enabled</td>
         <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
+
         <td>off {{!}} on; default: <b>off</b></td>
 
         <td>Turns communication with the slave device on or off.</td>
 
         <td>Turns communication with the slave device on or off.</td>
 
     </tr>
 
     </tr>
Line 726: Line 979:
 
=====Requests Configuration=====
 
=====Requests Configuration=====
 
----
 
----
A Modbus <b>request</b> is a way of obtaining data from Modbus slaves. The master sends a request to a slave specifying the function code to be performed. The slave then sends the requested data back to the Modbus master. You can create a maximum of 64 request configurations for each slave device.
+
A Modbus <b>request</b> is a way of obtaining data from Modbus slaves. The master sends a request to a slave specifying the function code to be performed. The slave then sends the requested data back to the Modbus master.
 +
 
 +
<span style="color:red"> <b>Note: </b></span> Modbus Serial Master uses <i>Register Number</i> instead of <i>Register Address</i> for pointing to a register. For example, to request the <i>Uptime</i> of a device, you must use <b>2</b> in the <i>First Register</i> field.
  
 
The Request Configuration list is empty by default. To add a new Request Configuration loon to the Add New Instance section. Enter a custom name into the 'Name' field and click the 'Add' button:
 
The Request Configuration list is empty by default. To add a new Request Configuration loon to the Add New Instance section. Enter a custom name into the 'Name' field and click the 'Add' button:
Line 734: Line 989:
 
The new Request Configuration should become visible in the list:
 
The new Request Configuration should become visible in the list:
  
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_v1.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 749: Line 1,004:
 
     <tr>
 
     <tr>
 
         <td>Data type</td>
 
         <td>Data type</td>
         <td>8bit INT <nowiki>|</nowiki> 8bit UINT <nowiki>|</nowiki> 16bit INT, high byte first <nowiki>|</nowiki> 16bit INT, low byte first <nowiki>|</nowiki> 16bit UINT, high byte first <nowiki>|</nowiki> 16bit UINT, low byte first <nowiki>|</nowiki> 32bit float, Byte order 1,2,3,4 <nowiki>|</nowiki> 32bit float, Byte order 4,3,2,1 <nowiki>|</nowiki> 32bit float, Byte order 2,1,4,3 <nowiki>|</nowiki> 32bit float, Byte order 3,4,1,2; default: <b>16bit INT, high byte first</b></td>
+
         <td>8bit INT {{!}} 8bit UINT {{!}} 16bit INT, high byte first {{!}} 16bit INT, low byte first {{!}} 16bit UINT, high byte first {{!}} 16bit UINT, low byte first {{!}} 32bit float (various Byte order) {{!}} 32bit INT (various Byte order) {{!}} 32bit UINT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool; default: <b>16bit INT, high byte first</b></td>
 
         <td>Defines how read data will be stored.</td>
 
         <td>Defines how read data will be stored.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Function</td>
 
         <td>Function</td>
         <td>Read coils (1) <nowiki>|</nowiki> Read input coils (2) <nowiki>|</nowiki> Read holding registers (3) <nowiki>|</nowiki> Read input registers (4) <nowiki>|</nowiki> Set single coil (5) <nowiki>|</nowiki> Set single coil register (6) <nowiki>|</nowiki> Set multiple coils (15) <nowiki>|</nowiki> Set multiple holding registers (16); default: <b>Read holding registers (3)</b></td>
+
         <td>Read coils (1) {{!}} Read input coils (2) {{!}} Read holding registers (3) {{!}} Read input registers (4) {{!}} Set single coil (5) {{!}} Set single coil register (6) {{!}} Set multiple coils (15) {{!}} Set multiple holding registers (16); default: <b>Read holding registers (3)</b></td>
 
         <td>Specifies the type of register being addressed by a Modbus request.  
 
         <td>Specifies the type of register being addressed by a Modbus request.  
 
         </td>
 
         </td>
Line 769: Line 1,024:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>No Brackets</td>
+
         <td>Remove Brackets</td>
         <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
+
         <td>off {{!}} on; default: <b>off</b></td>
 
         <td>Removes the starting and ending brackets from the request (only for read requests).</td>
 
         <td>Removes the starting and ending brackets from the request (only for read requests).</td>
 +
    </tr>
 +
    <tr>
 +
        <td>off/on slider</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Turns the request on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 777: Line 1,037:
 
         <td>- (interactive button)</td>
 
         <td>- (interactive button)</td>
 
         <td>Deletes the request.</td>
 
         <td>Deletes the request.</td>
    </tr>
 
    <tr>
 
        <td>off/on slider</td>
 
        <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
 
        <td>Turns the request on or off.</td>
 
 
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 800: Line 1,055:
  
 
[[File:Networking_rutos_manual_modbus_modbus_serial_master_modbus_master_alarms_add_button.png|border|class=tlt-border]]
 
[[File:Networking_rutos_manual_modbus_modbus_serial_master_modbus_master_alarms_add_button.png|border|class=tlt-border]]
 
Then click the 'Edit' button next to the newly created Alarm to configuration.
 
 
[[File:Networking_rutos_manual_modbus_modbus_serial_master_modbus_master_alarms_edit_button.png|border|class=tlt-border]]
 
  
 
After this you should be redirected to that Alarm's configuration page which should look similar to this:
 
After this you should be redirected to that Alarm's configuration page which should look similar to this:
  
[[File:Networking_rutos_manual_modbus_modbus_serial_master_modbus_master_alarms_alarm_configuration.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_alarms_configuration_v1.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 817: Line 1,068:
 
     <tr>
 
     <tr>
 
         <td>Enabled</td>
 
         <td>Enabled</td>
         <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
+
         <td>off {{!}} on; default: <b>off</b></td>
 
         <td>Turns the alarm on or off.</td>
 
         <td>Turns the alarm on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Function code</td>
 
         <td>Function code</td>
         <td>Read Coil Status (1) <nowiki>|</nowiki> Read Input Status (2) <nowiki>|</nowiki> Read Holding Registers (3) <nowiki>|</nowiki> Read Input Registers (4); default: <b>Read Coil Status (1)</b></td>
+
         <td>Read Coil Status (1) {{!}} Read Input Status (2) {{!}} Read Holding Registers (3) {{!}} Read Input Registers (4); default: <b>Read Coil Status (1)</b></td>
         <td>Modbus function used for this alarm's Modbus request. The Modbus TCP Master (this {{{name}}} device) perform this request as often as specified in the 'Period' field in [[#RS485_Slave_Device_Configuration|RS485 Slave Device Configuration]].</td>
+
         <td>Modbus function used for this alarm's Modbus request. The Modbus TCP Master (this {{{name}}} device) perform this request as often as specified in the 'Period' field in [[#Slave_Device_Configuration|Slave Device Configuration]].</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Register</td>
+
         <td>Compared condition data type</td>
 +
        <td>8bit INT {{!}} 8bit UINT {{!}} 16bit INT, high byte first {{!}} 16bit INT, low byte first {{!}} 16bit UINT, high byte first {{!}} 16bit UINT, low byte first {{!}} 32bit float (various Byte order) {{!}} 32bit INT (various Byte order) {{!}} 32bit UINT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool; default: <b>16bit INT, high byte first</b></td>
 +
        <td>Select data type that will be used for checking conditions.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>First register number</td>
 
         <td>integer [1..65536]; default: <b>none</b></td>
 
         <td>integer [1..65536]; default: <b>none</b></td>
 
         <td>Number of the Modbus coil/input/holding-register/input-register to read from.</td>
 
         <td>Number of the Modbus coil/input/holding-register/input-register to read from.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Condition</td>
+
         <td>Values</td>
        <td>More than <nowiki>|</nowiki> Less than <nowiki>|</nowiki> Equal to <nowiki>|</nowiki> Not Equal to; default: <b>Equal to</b></td>
 
        <td>When a value is obtained it will be compared against the value specified in the following field. The comparison will be made in accordance with the condition specified in this field.</td>
 
    </tr>
 
    <tr>
 
        <td>Value</td>
 
 
         <td>various; default: <b>none</b></td>
 
         <td>various; default: <b>none</b></td>
 
         <td>The value against which the read data will be compared.</td>
 
         <td>The value against which the read data will be compared.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Value</td>
+
         <td>Condition</td>
         <td>integer [0..65535]; default: <b>none</b></td>
+
         <td>More than {{!}} Less than {{!}} Equal to {{!}} Not Equal to {{!}} Less or equal {{!}} More or equal; default: <b>More than</b></td>
         <td>The value against which the read data will be compared.</td>
+
         <td>When a value is obtained it will be compared against the value specified in the following field. The comparison will be made in accordance with the condition specified in this field.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Action frequency</td>
 
         <td>Action frequency</td>
         <td>Every trigger <nowiki>|</nowiki> First trigger; default: <b>Every trigger</b></td>
+
         <td>Every trigger {{!}} First trigger; default: <b>Every trigger</b></td>
 
         <td>Describes how frequently the specified action will be taken.</td>
 
         <td>Describes how frequently the specified action will be taken.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Redundancy protection</td>
 
         <td>Redundancy protection</td>
         <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
+
         <td>off {{!}} <span style="color:blue">on</span>; default: <b>off</b></td>
 
         <td>Protection against executing a configured action too often.</td>
 
         <td>Protection against executing a configured action too often.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Redundancy protection period</td>
+
         <td><span style="color:blue">Redundancy protection period</span></td>
 
         <td>integer [1..86400]; default: <b>none</b></td>
 
         <td>integer [1..86400]; default: <b>none</b></td>
 
         <td>Duration to activate redundancy protection for, measured in seconds. This field becomes visible only when 'Redundancy protection' is turned on.</td>
 
         <td>Duration to activate redundancy protection for, measured in seconds. This field becomes visible only when 'Redundancy protection' is turned on.</td>
Line 862: Line 1,113:
 
     <tr>
 
     <tr>
 
         <td>Action</td>
 
         <td>Action</td>
         <td>SMS <nowiki>|</nowiki> MODBUS Write Request; default: <b>MODBUS Write Request</b></td>
+
         <td>{{#ifeq:{{{mobile}}}|1|SMS {{!}}|}} MODBUS Write Request; default: <b>MODBUS Write Request</b></td>
 
         <td>Action that will be taken if the condition is met. Possible actions:
 
         <td>Action that will be taken if the condition is met. Possible actions:
             <ul>
+
             <ul>{{#ifeq: {{{mobile}}} | 1 |
                 <li><b>SMS</b> - sends and SMS message to a specified recipient(s).</li>
+
                 <li><b>SMS</b> - sends and SMS message to a specified recipient(s).</li>|}}
 
                 <li><b>Modbus Request</b> - sends a Modbus Write request to a specified slave.</li>
 
                 <li><b>Modbus Request</b> - sends a Modbus Write request to a specified slave.</li>
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
     </tr>
+
     </tr>{{#ifeq: {{{mobile}}} | 1 |
 
     <tr>
 
     <tr>
 
         <td><span style="color: #0054a6;">SMS: Message</span></td>
 
         <td><span style="color: #0054a6;">SMS: Message</span></td>
Line 879: Line 1,130:
 
         <td>phone number; default: <b>none</b></td>
 
         <td>phone number; default: <b>none</b></td>
 
         <td>Recipient's phone number.</td>
 
         <td>Recipient's phone number.</td>
     </tr>
+
     </tr>|}}
 
     <tr>
 
     <tr>
 
         <td><span style="color: purple;">MODBUS Write Request: Timeout</span></td>
 
         <td><span style="color: purple;">MODBUS Write Request: Timeout</span></td>
Line 892: Line 1,143:
 
     <tr>
 
     <tr>
 
         <td><span style="color: purple;">MODBUS Write Request: Modbus function</span></td>
 
         <td><span style="color: purple;">MODBUS Write Request: Modbus function</span></td>
         <td>Read Force Single Coil (5) <nowiki>|</nowiki> Preset Single Register (6) <nowiki>|</nowiki> Force Multiple Coils (15) <nowiki>|</nowiki> Force Multiple Registers (16); default: <b>Force Single Coil (5)</b></td>
+
         <td>Read Single Coil (5) {{!}} Set Single Register (6) {{!}} Set Multiple Coils (15) {{!}} Set Multiple Registers (16); default: <b>Set Single Coil (5)</b></td>
 
         <td>A function code specifies the type of register being addressed by a Modbus request.</td>
 
         <td>A function code specifies the type of register being addressed by a Modbus request.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td><span style="color: purple;">MODBUS Write Request: First register</span></td>
+
        <td><span style="color: purple;">MODBUS Write Request: Executed action data type</span></td>
 +
        <td>8bit INT {{!}} 8bit UINT {{!}} 16bit INT, high byte first {{!}} 16bit INT, low byte first {{!}} 16bit UINT, high byte first {{!}} 16bit UINT, low byte first {{!}} 32bit float (various Byte order) {{!}} 32bit INT (various Byte order) {{!}} 32bit UNIT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool; default: <b>Bool</b></td>
 +
        <td>Select data type that will be used for executing action.</td>
 +
    </tr>
 +
    <tr>
 +
         <td><span style="color: purple;">MODBUS Write Request: First register number</span></td>
 
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>Begins reading from the register specified in this field.</td>
 
         <td>Begins reading from the register specified in this field.</td>
Line 907: Line 1,163:
 
</table>
 
</table>
 
|}}
 
|}}
 +
 
==MQTT Gateway==
 
==MQTT Gateway==
  
The <b>MQTT Gateway</b> function is used to transfer Modbus data over MQTT. Refer to the table for information on MQTT Gateway configuration fields.
+
The <b>MQTT Gateway</b> function is used to transfer Modbus data (send requests, receive responses) over MQTT. When it is enabled, the device (this {{{name}}}) subscribes to a REQUEST topic and publishes on a RESPONSE topic on a specified MQTT broker. It translates received MQTT message payload to a Modbus request and relays it to the specified Modbus TCP slave.
  
[[File:Networking_rutos_manual_modbus_mqtt_gateway.png|border|class=tlt-border]]
+
When the MQTT Gateway receives a response from the slave, it translates it to an MQTT message and publishes it on the RESPONSE topic.
 +
 
 +
[[File:Networking_rutos_manual_modbus_mqtt_gateway_scheme.png]]
 +
 
 +
Below is an example of the MQTT Gateway page. Refer to the table for information on MQTT Gateway configuration fields.
 +
 
 +
[[File:Networking_rutos_manual_modbus_mqtt_gateway_v1.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 921: Line 1,184:
 
     <tr>
 
     <tr>
 
         <td>Enable</td>
 
         <td>Enable</td>
         <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
+
         <td>off {{!}} on; default: <b>off</b></td>
 
         <td>Turns MQTT gateway on or off.</td>
 
         <td>Turns MQTT gateway on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Host</td>
 
         <td>Host</td>
         <td>ip <nowiki>|</nowiki> host; default: <b>127.0.0.1</b></td>
+
         <td>ip {{!}} host; default: <b>127.0.0.1</b></td>
 
         <td>IP address or hostname of an MQTT broker.</td>
 
         <td>IP address or hostname of an MQTT broker.</td>
 
     </tr>
 
     </tr>
Line 943: Line 1,206:
 
         <td>alphanumeric string; default: <b>response</b></td>
 
         <td>alphanumeric string; default: <b>response</b></td>
 
         <td>MQTT topic for subscribing to responses.</td>
 
         <td>MQTT topic for subscribing to responses.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>QoS</td>
 +
        <td>At most once (0) {{!}} At least once (1) {{!}} Exactly once (2); default: <b>Exactly once (2)</b></td>
 +
        <td>Specifies quality of service.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 953: Line 1,221:
 
         <td>string; default: <b>none</b></td>
 
         <td>string; default: <b>none</b></td>
 
         <td>Password for authentication to the MQTT broker.</td>
 
         <td>Password for authentication to the MQTT broker.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Client ID</td>
 +
        <td>integer; default: <b>none</b></td>
 +
        <td>Specifies client ID for MQTT broker.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Keepalive</td>
 +
        <td>integer; default: <b>5</b></td>
 +
        <td>Keepalive message to MQTT broker (seconds)</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Use TLS/SSL</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Turns TLS support on or off</td>
 +
    </tr>
 +
    <tr>
 +
        <td>TLS type</td>
 +
        <td><span style="color:blue">cert</span> {{!}} <span style="color:red">psk</span>; default: <b>cert</b></td>
 +
        <td>Selects the type of TLS encryption</td>
 +
    </tr>
 +
    <tr>
 +
        <td>TLS insecure</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Disables TLS security</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color:blue">Certificate files from device</span></td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Choose this option if you want to use certificate files generated on device.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color:blue">CA file</span></td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>Upload/select certificate authority file.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color:blue">Certificates file</span></td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>Upload/select certificate file.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color:blue">Key file</span></td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>Upload/select certificate key file.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color:red">PSK</span></td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>Specifies the pre-shared key.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color:red">Identity</span></td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>Specifies identity.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
 +
{{#ifeq:{{{serial}}}|1|
 +
===Serial Gateway Configuration===
 +
----
 +
<b>Serial Gateway Configuration</b> section displays Serial gateway instances currently existing on the router.
  
 +
By default the list is empty. To create a new gateway instance, enter the ID of serial device, select serial interface and click the 'Add' button.
 +
 +
[[File:Networking_rutos_manual_modbus_mqtt_gateway_serial_gateway_configuration_add_button_v1_rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}.png|border|class=tlt-border]]
 +
 +
After this you should be redirected to instance's configuration page which should look similar to this:
 +
 +
[[File:Networking_rutos_manual_modbus_mqtt_gateway_serial_gateway_configuration_rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}_v1.png|border|class=tlt-border]]
 +
 +
<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>Enables this Serial Gateway instance configuration.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Name</td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>Name of the gateway instance. Used for management purposes only.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Device</td>
 +
        <td>{{Template: Networking rutos manual serial ports| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}; default: <b>{{Template: Networking rutos manual default serial port| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}</b></td>
 +
        <td>Specifies which serial port will be used for serial communication.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Baud rate</td>
 +
        <td>300 {{!}} 1200 {{!}} 2400 {{!}} 4800 {{!}} 9600 {{!}} 19200 {{!}} 38400 {{!}} 57600 {{!}} 115200{{#ifeq: {{{rs485}}} | 1 | {{!}} 230400 {{!}} 460800 {{!}} 921600 {{!}} 1000000 {{!}} 3000000|}}; default: <b>9600</b></td>
 +
        <td>Serial data transmission rate (in bits per second).</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Data bits</td>
 +
        <td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
 +
        <td>Number of data bits for each character.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Stop bits</td>
 +
        <td>1{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} 2|}}; default: <b>1</b></td>
 +
        <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Parity</td>
 +
        <td>Even {{!}} Odd{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} Mark {{!}} Space|}} {{!}} None; default: <b>None</b></td>
 +
        <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
 +
            <ul>
 +
                <li><b>None</b> (<b>N</b>) - no parity method is used.</li>
 +
                <li><b>Odd</b> (<b>O</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.</li>
 +
                <li><b>Even</b> (<b>E</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be even.</li>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|<li><b>Space</b> (<b>s</b>) - the parity bit will always be a binary 0.</li>
 +
                <li><b>Mark</b> (<b>M</b>) - the parity bit will always be a binary 1.</li>|}}
 +
            </ul>
 +
        </td>
 +
    </tr>
 +
    <tr>
 +
        <td>Flow control</td>
 +
        <td>None {{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} RTS/CTS {{!}} Xon/Xoff|}}; default: <b>None</b></td>
 +
        <td>In many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking.
 +
{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|<ul>
 +
                <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li>
 +
                <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.</li>
 +
            </ul>|}}
 +
        </td>
 +
    </tr>{{#ifeq: {{{rs485}}} | 1 |
 +
    <tr>
 +
        <td><span style="color:blue">RS485:</span> Full Duplex</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Enables RS485 full duplex.</td>
 +
    </tr>|}}
 +
</table>
 +
|}}
 +
===Request messages===
 +
----
 +
<span style="color:red"> <b>Note: </b></span>MQTT Gateway uses <i>Register Number</i> instead of <i>Register Address</i> for pointing to a register. For example, to request the <i>Uptime</i> of a device, you must use <b>2</b> in the <i>Register Number</i> field.
 +
 +
Modbus request data sent in the MQTT payload should be generated in accordance with the following format:
 +
 +
<b>0 <COOKIE> <IP_TYPE> <IP> <PORT> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <REGISTER_NUMBER> <REGISTER_COUNT/VALUE></b>
 +
 +
Explanation:
 +
 +
<ul>
 +
    <li><b>0</b> - must be 0, which signifies a textual format (currently the only one implemented).</li>
 +
    <li><b>Cookie</b> - a 64-bit unsigned integer in range [0..2<sup>64</sup>]). A cookie is used in order to distinguish which response belongs to which request, each request and the corresponding response contain a matching cookie: a 64-bit unsigned integer.</li>
 +
    <li><b>IP type</b> - host IP address type. Possible values:
 +
        <ul>
 +
            <li><b>0</b> - IPv4 address;</li>
 +
            <li><b>1</b> - IPv6 address;</li>
 +
            <li><b>2</b> - hostname that will be resolved to an IP address.</li>
 +
        </ul></li>
 +
    <li><b>IP</b> - IP address of a Modbus TCP slave. IPv6 must be presented in full form (e.g., <i>2001:0db8:0000:0000:0000:8a2e:0370:7334</i>).</li>
 +
    <li><b>Port</b> - port number of the Modbus TCP slave.</li>
 +
    <li><b>Timeout</b> - timeout for Modbus TCP connection, in seconds. Range [1..999].</li>
 +
    <li><b>Slave ID</b> - Modbus TCP slave ID. Range [1..255].</li>
 +
    <li><b>Modbus function</b> - Modbus task type that will be executed. Possible values are:
 +
        <ul>
 +
            <li><b>3</b> - read holding registers;</li>
 +
            <li><b>6</b> - write to a single holding register;</li>
 +
            <li><b>16</b> - write to multiple holding registers.</li>
 +
        </ul></li>
 +
    <li><b>Register number</b> - number (not address) of the first register (in range [1..65536]) from which the registers will be read/written to.
 +
    <li><b>Register count/value</b> - this value depends on the Modbus function:
 +
        <ul>
 +
            <li><b>3</b> - <u>register count</u> (in range [1..125]); must not exceed the boundary (first register number + register count <= 65537);</li>
 +
            <li><b>6</b> - <u>register value</u> (in range [0..65535]);</li>
 +
            <li><b>16</b> - <u>register count</u> (in range [1..123]); must not exceed the boundary (first register number + register count <= 65537); and <u>register values</u> separated with commas, without spaces (e.g., <i>1,2,3,654,21,789</i>); there must be exactly as many values as specified (with register count); each value must be in the range of [0..65535].</li>
 +
        </ul></li>
 +
</ul>
 +
 +
===Response messages===
 +
----
 +
A special response message can take one of the following forms:
 +
 +
<COOKIE> OK                              - <i>for functions 6 and 16</i>
 +
<COOKIE> OK <VALUE> <VALUE> <VALUE>...  - <i>for function 3, where <VALUE> <VALUE> <VALUE>... are read register values</i>
 +
<COOKIE> ERROR: ...                      - <i>for failures, where ... is the error description</i>
 +
 +
===Examples===
 +
----
 +
Below are a few <b>examples</b> of controlling/monitoring the internal Modbus TCP Slave on {{{name}}}.
 +
----
 +
<b>Reboot the device</b>
 +
 +
<ul>
 +
    <li>Request:<br><pre>0 65432 0 192.168.1.1 502 5 1 6 206 1</pre></li>
 +
    <li>Response:<br><pre>65432 OK</pre></li>
 +
</ul>
 +
----
 +
<b>Retrieve uptime</b>
 +
 +
<ul>
 +
    <li>Request:<br><pre>0 65432 0 192.168.1.1 502 5 1 3 2 2</pre></li>
 +
    <li>Response:<br><pre>65432 OK 0 5590</pre></li>
 +
</ul>
 +
----
 +
If you're using Eclipse Mosquitto (MQTT implementation used on {{{name}}}), Publish/Subscribe commands may look something like this:
 +
 +
<b>Retrieve uptime</b>
 +
 +
<ul>
 +
    <li>Request:<br><pre>mosquitto_pub -h 192.168.1.1 -p 1883 -t request -m "0 65432 0 192.168.1.1 502 5 1 3 2 2"</pre></li>
 +
    <li>Response:<br><pre>mosquitto_sub -h 192.168.1.1 -p 1883 -t response
 +
65432 OK 0 5590</pre></li>
 +
</ul>
 +
{{#ifeq: {{{serial}}} | 1 |
 +
==Modbus TCP over Serial Gateway==
 +
The <b>Modbus TCP over Serial gateway</b> serial type allows redirecting TCP data coming to a specified port to an RTU specified by the Slave ID. The Slave ID can be specified by the user or be obtained directly from the Modbus header.
 +
 +
===Modbus TCP over Serial Gateway Configuration===
 +
----
 +
<b>Modbus TCP over Serial Gateway Configuration</b> section displays gateway instances currently existing on the router.
 +
 +
By default the list is empty. To create a new gateway instance, enter the name of instance, select serial interface and click the 'Add' button.
 +
 +
[[File:Networking_rutos_manual_modbus_modbus_tcp_over_serial_gateway_add_button_rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}_v1.png|border|class=tlt-border]]
 +
 +
After this you should be redirected to instance's configuration page which should look similar to this:
 +
 +
[[File:Networking_rutos_manual_modbus_modbus_tcp_over_serial_gateway_configuration_rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}_v1.png|border|class=tlt-border]]
 +
 +
<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>Enables this Modbus TCP over Serial Gateway instance configuration.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Name</td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>Name of the gateway instance. Used for management purposes only.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Device</td>
 +
        <td>{{Template: Networking rutos manual serial ports| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}; default: <b>{{Template: Networking rutos manual default serial port| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}</b></td>
 +
        <td>Specifies which serial port will be used for serial communication.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Baud rate</td>
 +
        <td>300 {{!}} 1200 {{!}} 2400 {{!}} 4800 {{!}} 9600 {{!}} 19200 {{!}} 38400 {{!}} 57600 {{!}} 115200{{#ifeq: {{{rs485}}} | 1 | {{!}} 230400 {{!}} 460800 {{!}} 921600 {{!}} 1000000 {{!}} 3000000|}}; default: <b>9600</b></td>
 +
        <td>Serial data transmission rate (in bits per second).</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Data bits</td>
 +
        <td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
 +
        <td>Number of data bits for each character.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Stop bits</td>
 +
        <td>1{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} 2|}}; default: <b>1</b></td>
 +
        <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Parity</td>
 +
        <td>Even {{!}} Odd{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} Mark {{!}} Space|}} {{!}} None; default: <b>None</b></td>
 +
        <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
 +
            <ul>
 +
                <li><b>None</b> (<b>N</b>) - no parity method is used.</li>
 +
                <li><b>Odd</b> (<b>O</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.</li>
 +
                <li><b>Even</b> (<b>E</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be even.</li>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|<li><b>Space</b> (<b>s</b>) - the parity bit will always be a binary 0.</li>
 +
                <li><b>Mark</b> (<b>M</b>) - the parity bit will always be a binary 1.</li>|}}
 +
            </ul>
 +
        </td>
 +
    </tr>
 +
    <tr>
 +
        <td>Flow control</td>
 +
        <td>None{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} RTS/CTS {{!}} Xon/Xoff|}}; default: <b>None</b></td>
 +
        <td>In many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking.
 +
{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|<ul>
 +
                <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li>
 +
                <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.</li>
 +
            </ul>|}}
 +
        </td>
 +
    </tr>
 +
    <tr>
 +
      <td>Listening IP</td>
 +
      <td>ip; default: <b>none</b></td>
 +
      <td>IP address to listen for incoming connections. (<i>0.0.0.0</i>) value may be used to listen for incoming connections on any interface or IP address.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Port</td>
 +
      <td>integer [0..65535]; default: <b>none</b></td>
 +
      <td>Port number to listen for incoming connections.</td>
 +
    </tr>
 +
    <tr>
 +
    <td>Slave ID configuration type</td>
 +
        <td><span style="color: green;">User defined</span> {{!}} <span style="color: purple;">Obtained from TCP</span>; default: <b>User defined</b></td>
 +
        <td>Specifies whether slave IDs are user defined or automatically obtained from TCP.</td>
 +
    </tr>
 +
    <tr>
 +
    <td><span style="color: green;">Slave ID</span></td>
 +
        <td><span style="color: green;">integer</span>; default: <b>none</span></td>
 +
        <td>Specifies the slave ID of range of permitted slave IDs. The way this field is named and its function depends on the value of the ''Slave ID configuration'' field. <br> A range of IDs can be specified by placing a hyphen (<i>-</i>) between two integer numbers. For example, if you permit slave IDs in the range of 10 to 20, you would specify it as: <i>10-20</i><br>You can also specify multiple values that are not connected in a range using commas (<i>,</i>). For example, to specify 6, 50 and 100 as permitted slave IDs, you would have to use: <i>6,50,100</i></td>
 +
    </tr>
 +
    <tr>
 +
    <td><span style="color: purple;">Permitted slave IDs</span></td>
 +
        <td><span style="color: purple;">range of integers</span>; default: <b>1-247</b></td>
 +
        <td>Read <i>Slave ID</i> field description.</td>
 +
    </tr>
 +
    <tr>
 +
    <td>CRC verification</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Checks if sent serial message is not disturbed.</td>
 +
    </tr>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|
 +
    <tr>
 +
    <td>Echo</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Turns RS232 echo on or off. RS232 echo is a loopback test usually used to check whether the RS232 cable is working properly.</td>
 +
    </tr>|}}{{#ifeq: {{{rs485}}} | 1 |
 +
    <tr>
 +
        <td><span style="color:blue">RS485:</span> Full Duplex</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Enables RS485 full duplex.</td>
 +
    </tr>|}}
 +
</table>
 +
 +
===IP Filter===
 +
----
 +
The <b>IP Filter</b> section is used for configuring which network is allowed to communicate with the device. You may add a new instance by selecting the Interface and pressing Add.
 +
 +
[[File:Networking_rutos_manual_console_ip_filter.png|border|class=tlt-border]]
 +
 +
Then enter the IP address and save.
 +
 +
[[File:Networking_rutos_manual_console_ip_filter_instance.png|border|class=tlt-border]]
 +
|}}
 
==See also==
 
==See also==
  
{{Template: Networking_device_modbus_see_also}}
+
<ul>
 +
    <li><b>[[{{{name}}} Monitoring via Modbus|Monitoring via Modbus]]</b> - detailed examples on how to use Modbus TCP</li>
 +
</ul>
  
 
[[Category:{{{name}}} Services section]]
 
[[Category:{{{name}}} Services section]]

Revision as of 09:04, 23 November 2022

Template:Networking rutos manual fw disclosure


Summary

Modbus is a serial communications protocol. Simple and robust, it has become a de facto standard communication protocol and is now a commonly available means of connecting industrial electronic devices.

This manual page provides an overview of the Modbus functionality in {{{name}}} devices.

Note: On {{{name}}}, Modbus TCP Slave/Master and MQTT Gateway is additional software that can be installed from the Services → [[{{{name}}} Package Manager|Package Manager]] page.
If you're having trouble finding this page or some of the parameters described here on your device's WebUI, you should turn on "Advanced WebUI" mode. You can do that by clicking the "Advanced" button, located at the top of the WebUI.

Networking rutos manual webui basic advanced mode 75.gif

Modbus TCP Slave

A Modbus TCP Slave listens for connections from a TCP master (client) and sends out a response or sets some system related parameter in accordance with the given query. This provides the user with the possibility to set or get system parameters.

The figure below is an example of the Modbus TCP window section and the table below provides information on the fields contained in that window:

Networking rutos manual modbus modbus tcp slave v2.png

Field Value Description
Enable off | on; default: off Turns Modbus TCP on or off.
Port integer [0..65535]; default: 502 TCP port used for Modbus communications.
Device ID integer [0..255]; default: 1 The device's Modbus slave ID. When set to 0, it will respond to requests addressed to any ID.
Mobile Data type Bytes | Kilobytes | Megabytes; default: Bytes Selects mobile data unit representation type.
Allow remote access off | on; default: off Allows remote Modbus connections by adding an exception to the device's firewall on the port specified in the field above.
Keep persistent connection off | on; default: onn Allows keep the connection open after responding a Modbus TCP master request.
Connection timeout integer [0..60]; default: 0 Sets TCP timeout in seconds after which the connection is forcefully closed.
Enable custom register block off | on; default: off Allows the usage of custom register block.
Register file path path; default: /tmp/regfile Path to file in which the custom register block will be stored. Files inside /tmp or /var are stored in RAM. They vanish after reboot, but do not degrade flash memory. Files elsewhere are stored in flash memory. They remain after reboot, but degrade flash memory (severely, if operations are frequent).
First register number integer [1025..65536]; default: 1025 First register in custom register block
Register count integer [1..64512]; default: 128 Register count in custom register block


Modbus Registers

Get Parameters


Modbus parameters are held within registers. Each register contains 2 bytes of information. For simplification, the number of registers for storing numbers is 2 (4 bytes), while the number of registers for storing text information is 16 (32 bytes).

The register numbers and corresponding system values are described in the table below:

required value register address register number number of registers representation
System uptime 1 2 2 32 bit unsigned integer
System hostname 7 8 16 Text
Router serial number 39 40 16 Text
LAN MAC address 55 56 16 Text
Router name 71 72 16 Text
Current WAN IP address 139 140 2 8 bit unsigned integer
Digital non-isolated input 324 325 1 16 bit unsigned integer
Digital open collector output 325 326 1 16 bit unsigned integer
PIN 3 direction 326 327 1 16 bit unsigned integer
PIN 4 direction 327 328 1 16 bit unsigned integer
Unix timestamp 364 365 2 32 bit unsigned integer
Local ISO time 366 367 12 Text
UTC time 378 389 12 Text
LAN IP 394 395 2 8 bit unsigned integer

Set Parameters


The Modbus daemon can also set some device parameters.

value to set register address register number register value description
Hostname 7 8 Hostname (in decimal form) Changes hostname
Device name 71 72 Device name (in decimal form) Changes device name
Reboot 206 207 1 Reboots the router
Switch PIN 3 state 324 325 1|0 Toggles PIN 3 ON or OFF, when output is selected
Switch PIN 4 state 325 326 1|0 Toggles PIN 4 ON or OFF, when output is selected
Switch PIN 3 direction 326 327 1|0 Toggles PIN 3 direction between INPUT (0) or OUTPUT (1)
Switch PIN 4 direction 327 328 1|0 Toggles PIN 4 direction between INPUT (0) or OUTPUT (1)
Change LAN IP 394 395 IPv4 (in decimal form) Changes device LAN IP

Modbus TCP Master

A Modbus Master device can request data from Modbus slaves. The Modbus TCP Master section is used to configure Modbus TCP slaves. By default, the slave list is empty. To add a new slave, click the 'Add' button

Networking rutos manual modbus modbus tcp master modbus tcp slave devices add button.png

After clicking 'Add' you will be redirected to the newly added slave's configuration page.

Slave Device Configuration


The Slave Device Configuration section is used to configure the parameters of Modbus TCP slaves that the Master (this {{{name}}} device) will be querying with requests. The figure below is an example of the Slave Device Configuration and the table below provides information on the fields contained in that section:

Networking rutos manual modbus modbus tcp master slave device configuration v2.png

Field Value Description
Enabled off | on; default: off Turns communication with the slave device on or off.
Name string; default: none Slave device's name, used for easier management purposes.
Slave ID integer [0..255]; default: none Slave ID. Each slave in a network is assigned a unique identifier ranging from 1 to 255. When the master requests data from a slave, the first byte it sends is the Slave ID. When set to 0, the slave will respond to requests addressed to any ID.
IP address ip4; default: none Slave device's IP address.
Port integer [0..65535]; default: none Slave device's Modbus TCP port.
Period integer [1..86400]; default: 60 Interval at which requests are sent to the slave device.
Timeout integer [1..30]; default: 5 Maximum response wait time.
Always reconnect off | on; default: off Create new connection after every Modbus request.
Number of timeouts integer [0..10]; default: 1 Skip pending request and reset connection after number of request failures.
Frequency Period | Schedule; default: Period
Delay integer [0..999]; default: 0 Wait in milliseconds after connection initialization.
Period integer [1..99999]; default: none Interval in seconds for sending requests to this device

Requests Configuration


A Modbus request is a way of obtaining data from Modbus slaves. The master sends a request to a slave specifying the function code to be performed. The slave then sends the requested data back to the Modbus master.

Note: Modbus TCP Master uses Register Number instead of Register Address for pointing to a register. For example, to request the Uptime of a device, you must use 2 in the First Register field.

The Request Configuration list is empty by default. To add a new Request Configuration loon to the Add New Instance section. Enter a custom name into the 'Name' field and click the 'Add' button:

Networking rutos manual modbus modbus tcp master requests configuration add new instance.png

The new Request Configuration should become visible in the list:

Networking rutos manual modbus modbus tcp master requests configuration v1.png

Field Value Description
Name string; default: Unnamed Name of this Request Configuration. Used for easier management purposes.
Data type 8bit INT | 8bit UINT | 16bit INT, high byte first | 16bit INT, low byte first | 16bit UINT, high byte first | 16bit UINT, low byte first | 32bit float (various Byte order) | 32bit INT (various Byte order) | 32bit UINT (various Byte order) | ASCII | Hex | Bool; default: 16bit INT, high byte first Defines how read data will be stored.
Function Read coils (1) | Read input coils (2) | Read holding registers (3) | Read input registers (4) | Set single coil (5) | Set single coil register (6) | Set multiple coils (15) | Set multiple holding registers (16); default: Read holding registers (3) Specifies the type of register being addressed by a Modbus request.
First Register integer [0..65535]; default: 1 First Modbus register from which data will be read.
Register Count / Values integer [1..2000]; default: 1 Number of Modbus registers that will be read during the request.
Remove Brackets off | on; default: off Removes the starting and ending brackets from the request (only for read requests).
off/on slider off | on; default: off Turns the request on or off.
Delete [ X ] - (interactive button) Deletes the request.

Additional note: by default the newly added Request Configurations are turned off. You can use the on/off slider to the right of the Request Configuration to turn it on:

Networking rutos manual modbus modbus tcp master requests configuration on off slider.png


After having configured a request, you should see a new 'Request Configuration Testing' section appear. It is used to check whether the configuration works correctly. Simply click the 'Test' button and a response should appear in the box below. A successful response to a test may look something like this:

Networking rutos manual modbus modbus tcp master requests configuration testing.png

Alarms Configuration


Alarms are a way of setting up automated actions when some Modbus values meet user-defined conditions. When the Modbus TCP Master (this {{{name}}} device) requests some information from a slave device it compares that data to with the parameters set in an Alarm Configuration. If the comparison meets the specified condition (more than, less than, equal to, not equal to), the Master performs a user-specified action, for example, a Modbus write request or switching the state of an output.

The figure below is an example of the Alarms Configuration list. To create a new Alarm, click the 'Add' button.

Networking rutos manual modbus modbus tcp master alarms configuration add button.png

After adding the Alarm you should be redirected to its configuration page which should look similar to this:

Networking rutos manual modbus modbus tcp master alarms configuration v1.png

Field Value Description
Enabled off | on; default: off Turns the alarm on or off.
Function code Read Coil Status (1) | Read Input Status (2) | Read Holding Registers (3) | Read Input Registers (4); default: Read Coil Status (1) Modbus function used for this alarm's Modbus request. The Modbus TCP Master (this {{{name}}} device) perform this request as often as specified in the 'Period' field in Slave Device Configuration.
Compared condition data type 8bit INT | 8bit UINT | 16bit INT, high byte first | 16bit INT, low byte first | 16bit UINT, high byte first | 16bit UINT, low byte first | 32bit float (various Byte order) | 32bit INT (various Byte order) | 32bit UINT (various Byte order) | ASCII | Hex | Bool; default: 16bit INT, high byte first Select data type that will be used for checking conditions.
First register number integer [1..65536]; default: none Number of the Modbus coil/input/holding-register/input-register to read from.
Values various; default: none The value against which the read data will be compared.
Condition More than | Less than | Equal to | Not Equal to | Less or equal | More or equal; default: More than When a value is obtained it will be compared against the value specified in the following field. The comparison will be made in accordance with the condition specified in this field.
Action frequency Every trigger | First trigger; default: Every trigger Describes how frequently the specified action will be taken.
Redundancy protection off | on; default: off Protection against executing a configured action too often.
Redundancy protection period integer [1..86400]; default: none Duration to activate redundancy protection for, measured in seconds. This field becomes visible only when 'Redundancy protection' is turned on.
Action MODBUS Write Request| Trigger output; default: MODBUS Write Request Action that will be taken if the condition is met. Possible actions:
  • Modbus Request - sends a Modbus Write request to a specified slave.
  • Trigger output - changes state of selected I/O output pin.
MODBUS Write Request: IP address ip | host; default: none Modbus slave's IP address.
MODBUS Write Request: Port integer [0..65535]; default: none Modbus slave's port.
MODBUS Write Request: Timeout integer [1..30]; default: 5 Maximum time to wait for a response.
MODBUS Write Request: ID integer [1..255]; default: none Modbus slave ID.
MODBUS Write Request: Modbus function Set Single Coil (5) | Set Single Register (6) | Set Multiple Coils (15) | Set Multiple Registers (16); default: Set Single Coil (5) A function code specifies the type of register being addressed by a Modbus request.
MODBUS Write Request: Executed action data type 8bit INT | 8bit UINT | 16bit INT, high byte first | 16bit INT, low byte first | 16bit UINT, high byte first | 16bit UINT, low byte first | 32bit float (various Byte order) | 32bit INT (various Byte order) | 32bit UNIT (various Byte order) | ASCII | Hex | Bool; default: Bool Select data type that will be used for executing action.
MODBUS Write Request: First register number integer [0..65535]; default: none Begins reading from the register specified in this field.
MODBUS Write Request: Values integer [0..65535]; default: none Register/Coil values to be written (multiple values must be separated by space character).
Trigger output: Output Selects which output will be triggered.
Trigger output: I/O Action Turn On | Turn Off | Invert; default: Turn On Selects the action performed on the output.


MQTT Gateway

The MQTT Gateway function is used to transfer Modbus data (send requests, receive responses) over MQTT. When it is enabled, the device (this {{{name}}}) subscribes to a REQUEST topic and publishes on a RESPONSE topic on a specified MQTT broker. It translates received MQTT message payload to a Modbus request and relays it to the specified Modbus TCP slave.

When the MQTT Gateway receives a response from the slave, it translates it to an MQTT message and publishes it on the RESPONSE topic.

Networking rutos manual modbus mqtt gateway scheme.png

Below is an example of the MQTT Gateway page. Refer to the table for information on MQTT Gateway configuration fields.

Networking rutos manual modbus mqtt gateway v1.png

Field Value Description
Enable off | on; default: off Turns MQTT gateway on or off.
Host ip | host; default: 127.0.0.1 IP address or hostname of an MQTT broker.
Port integer [0..65535]; default: 1883 Port number of the MQTT broker.
Request topic alphanumeric string; default: request MQTT topic for sending requests.
Response topic alphanumeric string; default: response MQTT topic for subscribing to responses.
QoS At most once (0) | At least once (1) | Exactly once (2); default: Exactly once (2) Specifies quality of service.
Username string; default: none Username for authentication to the MQTT broker.
Password string; default: none Password for authentication to the MQTT broker.
Client ID integer; default: none Specifies client ID for MQTT broker.
Keepalive integer; default: 5 Keepalive message to MQTT broker (seconds)
Use TLS/SSL off | on; default: off Turns TLS support on or off
TLS type cert | psk; default: cert Selects the type of TLS encryption
TLS insecure off | on; default: off Disables TLS security
Certificate files from device off | on; default: off Choose this option if you want to use certificate files generated on device.
CA file string; default: none Upload/select certificate authority file.
Certificates file string; default: none Upload/select certificate file.
Key file string; default: none Upload/select certificate key file.
PSK string; default: none Specifies the pre-shared key.
Identity string; default: none Specifies identity.

Request messages


Note: MQTT Gateway uses Register Number instead of Register Address for pointing to a register. For example, to request the Uptime of a device, you must use 2 in the Register Number field.

Modbus request data sent in the MQTT payload should be generated in accordance with the following format:

0 <COOKIE> <IP_TYPE> <IP> <PORT> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <REGISTER_NUMBER> <REGISTER_COUNT/VALUE>

Explanation:

  • 0 - must be 0, which signifies a textual format (currently the only one implemented).
  • Cookie - a 64-bit unsigned integer in range [0..264]). A cookie is used in order to distinguish which response belongs to which request, each request and the corresponding response contain a matching cookie: a 64-bit unsigned integer.
  • IP type - host IP address type. Possible values:
    • 0 - IPv4 address;
    • 1 - IPv6 address;
    • 2 - hostname that will be resolved to an IP address.
  • IP - IP address of a Modbus TCP slave. IPv6 must be presented in full form (e.g., 2001:0db8:0000:0000:0000:8a2e:0370:7334).
  • Port - port number of the Modbus TCP slave.
  • Timeout - timeout for Modbus TCP connection, in seconds. Range [1..999].
  • Slave ID - Modbus TCP slave ID. Range [1..255].
  • Modbus function - Modbus task type that will be executed. Possible values are:
    • 3 - read holding registers;
    • 6 - write to a single holding register;
    • 16 - write to multiple holding registers.
  • Register number - number (not address) of the first register (in range [1..65536]) from which the registers will be read/written to.
  • Register count/value - this value depends on the Modbus function:
    • 3 - register count (in range [1..125]); must not exceed the boundary (first register number + register count <= 65537);
    • 6 - register value (in range [0..65535]);
    • 16 - register count (in range [1..123]); must not exceed the boundary (first register number + register count <= 65537); and register values separated with commas, without spaces (e.g., 1,2,3,654,21,789); there must be exactly as many values as specified (with register count); each value must be in the range of [0..65535].

Response messages


A special response message can take one of the following forms:

<COOKIE> OK                              - for functions 6 and 16
<COOKIE> OK <VALUE> <VALUE> <VALUE>...   - for function 3, where <VALUE> <VALUE> <VALUE>... are read register values
<COOKIE> ERROR: ...                      - for failures, where ... is the error description

Examples


Below are a few examples of controlling/monitoring the internal Modbus TCP Slave on {{{name}}}.


Reboot the device

  • Request:
    0 65432 0 192.168.1.1 502 5 1 6 206 1
  • Response:
    65432 OK

Retrieve uptime

  • Request:
    0 65432 0 192.168.1.1 502 5 1 3 2 2
  • Response:
    65432 OK 0 5590

If you're using Eclipse Mosquitto (MQTT implementation used on {{{name}}}), Publish/Subscribe commands may look something like this:

Retrieve uptime

  • Request:
    mosquitto_pub -h 192.168.1.1 -p 1883 -t request -m "0 65432 0 192.168.1.1 502 5 1 3 2 2"
  • Response:
    mosquitto_sub -h 192.168.1.1 -p 1883 -t response
    65432 OK 0 5590

See also

  • [[{{{name}}} Monitoring via Modbus|Monitoring via Modbus]] - detailed examples on how to use Modbus TCP

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