Changes

Template:Networking rutos manual modbus (view source)

Revision as of 10:04, 23 November 2022

14,281 bytes added , 10:04, 23 November 2022

no edit summary

Line 25: Line 25:

}}

−

==Modbus TCP ~~slave~~==

+

==Modbus TCP Slave==

−

A Modbus TCP ~~slave~~ 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 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:

−

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

Line 55: Line 55:

</tr>

<tr>

−

<td>Allow ~~Remote Access~~</td>

+

<td>Mobile Data type</td>

+

<td>Bytes | Kilobytes | Megabytes; default: Bytes</td>

+

<td>Selects mobile data unit representation type.</td>

+

</tr>

+

<tr>

+

<td>Allow remote access</td>

<td>off | on; default: off</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 61: Line 66:

<tr>

<td>Keep persistent connection</td>

−

<td>off | on; default: ~~off~~</td>

+

<td>off | on; default: onn</td>

<td>Allows keep the connection open after responding a Modbus TCP master request.</td>

</tr>

<tr>

<td>Connection timeout</td>

−

<td> integer; default: 0</td>

+

<td>integer [0..60]; default: 0</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 | on; default: off</td>

+

<td>Allows the usage of custom register block.</td>

+

</tr>

+

<tr>

+

<td>Register file path</td>

+

<td>path; default: /tmp/regfile</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>First register number</td>

+

<td>integer [1025..65536]; default: 1025</td>

+

<td>First register in custom register block</td>

+

</tr>

+

<tr>

+

<td>Register count</td>

+

<td>integer [1..64512]; default: 128</td>

+

<td>Register count in custom register block </td>

+

</tr>

+

</table>

+

{{#ifeq: {{{serial}}} | 1 |

+

==Modbus Serial Slave==

+

A Modbus Serial Slave 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 Modbus Serial Slave Configuration 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]]

+

+

<tr>

+

<th>Field</th>

+

<th>Value</th>

+

<th>Description</th>

+

</tr>

+

<tr>

+

<td>Enable</td>

+

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

+

<td>Enables this Modbus Serial Slave instance configuration.</td>

+

</tr>

+

<tr>

+

+

<td>string; default: none</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: {{Template: Networking rutos manual default serial port| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}</td>

+

<td>Specifies which serial port will be used for serial communication.</td>

+

</tr>

+

<tr>

+

<td>Device ID</td>

+

<td>integer [0..255]; default: 1</td>

+

<td>Specifies which serial port will be used for serial communication.</td>

+

</tr>

+

<tr>

+

+

<td>300 {{!}} 1200 {{!}} 2400 {{!}} 4800 {{!}} 9600 {{!}} 19200 {{!}} 38400 {{!}} 57600 {{!}} 115200{{#ifeq: {{{rs485}}} | 1 | {{!}} 230400 {{!}} 460800 {{!}} 921600 {{!}} 1000000 {{!}} 3000000|}}; default: 9600</td>

+

<td>Serial data transmission rate (in bits per second).</td>

</tr>

+

<tr>

+

+

<td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: 8</td>

+

<td>Number of data bits for each character.</td>

+

</tr>

+

<tr>

+

+

<td>1{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} 2|}}; default: 1</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: None</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>None (N) - no parity method is used.</li>

+

<li>Odd (O) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.</li>

+

<li>Even (E) - 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>Space (s) - the parity bit will always be a binary 0.</li>

+

<li>Mark (M) - 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: None</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>RTS/CTS - 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>Xon/Xoff - 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>RS485: Full Duplex</td>

+

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

+

<td>Enables RS485 full duplex.</td>

+

</tr>|}}

<tr>

<td>Enable custom register block</td>

−

<td>off | on; default: off</td>

+

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

<td>Allows the usage of custom register block.</td>

+

</tr>

+

<tr>

+

<td>Register file path</td>

+

<td>path; default: /tmp/regfile</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>First register number</td>

+

<td>integer [1025..65536]; default: 1025</td>

+

<td>First register in custom register block</td>

+

</tr>

+

<tr>

+

<td>Register count</td>

+

<td>integer [1..64512]; default: 128</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>

</table>

+

|}}

+

==Modbus Registers==

{{Template:Networking_rutos_manual_modbus_modbus_tcp_get_parameters_table

Line 99: Line 227:

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

Line 106: Line 232:

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:

−

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

Line 131: Line 257:

<tr>

<td>IP address</td>

−

<td>ip; default: none</td>

+

<td>ip4; default: none</td>

<td>Slave device's IP address.</td>

</tr>

Line 148: Line 274:

<td>integer [1..30]; default: '''5'''</td>

<td>Maximum response wait time.</td>

+

</tr>

+

<tr>

+

<td>Always reconnect</td>

+

<td>off | on; default: off</td>

+

<td>Create new connection after every Modbus request.</td>

+

</tr>

+

<tr>

+

<td>Number of timeouts</td>

+

<td>integer [0..10]; default: 1</td>

+

<td>Skip pending request and reset connection after number of request failures.</td>

+

</tr>

+

<tr>

+

<td>Frequency</td>

+

<td>Period {{!}} Schedule; default: Period</td>

+

+

</tr>

+

<tr>

+

<td>Delay</td>

+

<td>integer [0..999]; default: 0</td>

+

<td>Wait in milliseconds after connection initialization.</td>

+

</tr>

+

<tr>

+

<td>Period</td>

+

<td>integer [1..99999]; default: none</td>

+

<td>Interval in seconds for sending requests to this device</td>

</tr>

</table>

Line 153: Line 304:

===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~~. You can create a maximum of 64 request configurations for each slave device~~.

+

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.

Line 163: Line 314:

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

Line 178: Line 329:

<tr>

−

+

<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: 16bit INT, high byte first</td>

<td>Defines how read data will be stored.</td>

</tr>

Line 198: Line 349:

</tr>

<tr>

−

<td>No Brackets</td>

+

<td>Remove Brackets</td>

<td>off | on; default: off</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: off</td>

+

<td>Turns the request on or off.</td>

</tr>

<tr>

Line 206: Line 362:

<td>- (interactive button)</td>

<td>Deletes the request.</td>

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>off/on slider</td>~~

−

~~<td>off | on; default: off</td>~~

−

~~<td>Turns the request on or off.</td>~~

</tr>

</table>

Line 232: Line 383:

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

Line 251: Line 402:

</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: 16bit INT, high byte first</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: none</td>

<td>Number of the Modbus coil/input/holding-register/input-register to read from.</td>

</tr>

<tr>

−

<td>~~Condition</td>~~

+

<td>Values</td>

−

~~<td>More than | Less than | Equal to | Not Equal to; default: Equal to</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: none</td>

<td>The value against which the read data will be compared.</td>

</tr>

<tr>

−

<td>~~Value~~</td>

+

<td>Condition</td>

−

<td>~~integer [0..65535]~~; default: ~~none~~</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>

Line 277: Line 428:

<tr>

<td>Redundancy protection</td>

−

<td>off | on; default: off</td>

+

<td>off | on; default: off</td>

<td>Protection against executing a configured action too often.</td>

</tr>

<tr>

−

<td>Redundancy protection period</td>

+

<td>Redundancy protection period</td>

<td>integer [1..86400]; default: none</td>

<td>Duration to activate redundancy protection for, measured in seconds. This field becomes visible only when 'Redundancy protection' is turned on.</td>

Line 292: Line 443:

<li>SMS - sends and SMS message to a specified recipient(s).</li>|}}

<li>Modbus Request - sends a Modbus Write request to a specified slave.</li>

+

{{#switch:{{{series}}}|TCR1=|TRB2=|#default=<li>Trigger output - changes state of selected I/O output pin.</li>}}

</ul>

</td>

Line 327: Line 479:

<tr>

<td>MODBUS Write Request: Modbus function</td>

−

<td>~~Read Force~~ Single Coil (5) | ~~Preset~~ Single Register (6) | ~~Force~~ Multiple Coils (15) | ~~Force~~ Multiple Registers (16); default: ~~Force~~ Single Coil (5)</td>

+

<td>Set Single Coil (5) | Set Single Register (6) | Set Multiple Coils (15) | Set Multiple Registers (16); default: Set Single Coil (5)</td>

<td>A function code specifies the type of register being addressed by a Modbus request.</td>

</tr>

<tr>

−

<td>MODBUS Write Request: First register</td>

+

<td>MODBUS Write Request: Executed action data type</td>

+

+

<td>Select data type that will be used for executing action.</td>

+

</tr>

+

<tr>

+

<td>MODBUS Write Request: First register number</td>

<td>integer [0..65535]; default: none</td>

<td>Begins reading from the register specified in this field.</td>

Line 358: Line 515:

The Modbus Serial Master 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.

−

Note: Modbus Serial Master is additional software that can be installed from the Services → [[{{{name}}} Package Manager|Package Manager]] page.

+

−

{{#ifeq: {{{rs232}}} | 1 |

+

−

===~~RS232~~===

+

===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 ~~RS232 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]]

Line 373: Line 542:

</tr>

<tr>

−

<td>~~Enabled~~</td>

+

<td>Enable</td>

−

<td>off <~~nowiki~~>|</~~nowiki~~> on; default: ~~off~~</td>

+

<td>off {{!}} on; default: off</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>string; default: none</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: {{Template: Networking rutos manual default serial port| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}</td>

+

<td>Specifies which serial port will be used for serial communication.</td>

</tr>

<tr>

−

+

<td>300 {{!}} 1200 {{!}} 2400 {{!}} 4800 {{!}} 9600 {{!}} 19200 {{!}} 38400 {{!}} 57600 {{!}} 115200{{#ifeq: {{{rs485}}} | 1 | {{!}} 230400 {{!}} 460800 {{!}} 921600 {{!}} 1000000 {{!}} 3000000|}}; default: 9600</td>

<td>Serial data transmission rate (in bits per second).</td>

</tr>

<tr>

−

<td>5 ~~<nowiki>|</nowiki>~~ 6 ~~<nowiki>|</nowiki>~~ 7 ~~<nowiki>~~|~~</nowiki>~~ 8; default: 8</td>

+

<td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: 8</td>

<td>Number of data bits for each character.</td>

+

</tr>

+

<tr>

+

+

<td>1{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} 2|}}; default: 1</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>~~None <nowiki>~~|~~</nowiki> Even <nowiki>~~|~~</nowiki> Odd~~; default: None</td>

+

<td>Even {{!}} Odd{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} Mark {{!}} Space|}} {{!}} None; default: None</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>None (N) - no parity method is used.</li>

<li>Odd (O) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.</li>

−

<li>Even (E) - the parity bit is set so that the number of "logical ones (1s)" has to be even.</li>

+

<li>Even (E) - 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>Space (s) - the parity bit will always be a binary 0.</li>

+

<li>Mark (M) - the parity bit will always be a binary 1.</li>|}}

</ul>

</td>

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>Stop bits</td>~~

−

~~<td>1 <nowiki>|</nowiki> 2; default: 1</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>Flow control</td>

−

<td>None ~~<nowiki>~~|~~</nowiki>~~ RTS/CTS ~~<nowiki>|</nowiki>~~ Xon/Xoff; default: None</td>

+

<td>None {{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} RTS/CTS {{!}} Xon/Xoff|}}; default: None</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.

−

<ul>

+

{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|<ul>

<li>RTS/CTS - 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>Xon/Xoff - 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>

−

</tr>

+

</tr>{{#ifeq: {{{rs485}}} | 1 |

+

<tr>

+

<td>RS485: Full Duplex</td>

+

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

+

<td>Enables RS485 full duplex.</td>

+

</tr>|}}

</table>

−

===~~=RS232~~ Slave ~~Devices List=~~===

+

===Modbus Slave Device Configuration===

----

−

~~The RS232 Slave Devices List~~ section is used to ~~configure the parameters of Modbus RTU 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. ~~A new configuration window should pop up~~.

+

[[File:Networking_rutos_manual_modbus_modbus_serial_master_modbus_slave_device_configuration_v1.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.

+

[[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_add_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 ~~RS232~~ Slave Device Configuration 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 Slave Device Configuration 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]]

Line 437: Line 626:

<tr>

<td>Enabled</td>

−

<td>off ~~<nowiki>|</nowiki>~~ on; default: off</td>

+

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

<td>Turns communication with the slave device on or off.</td>

</tr>

Line 444: Line 633:

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

<td>Slave device's name, used for easier management purposes.</td>

+

</tr>

+

<tr>

+

<td>Slave device</td>

+

<td>slave device instance; default: none</td>

+

<td>Specifies which serial device will be used on this slave.</td>

</tr>

<tr>

Line 449: Line 643:

<td>integer [0..255]; default: none</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: off</td>

+

<td>Create new connection after every Modbus request.</td>

+

</tr>

+

<tr>

+

<td>Number of timeouts</td>

+

<td>integer [0..10]; default: 1</td>

+

<td>Skip pending request and reset connection after number of request failures.</td>

+

</tr>

+

<tr>

+

<td>Frequency</td>

+

<td>Period {{!}} Schedule; default: Period</td>

+

+

</tr>

+

<tr>

+

<td>Delay</td>

+

<td>integer [0..999]; default: 0</td>

+

<td>Wait in milliseconds after connection initialization.</td>

</tr>

<tr>

<td>Period</td>

−

<td>integer [1..~~86400~~]; default: 60</td>

+

<td>integer [1..99999]; default: none</td>

<td>Interval at which requests are sent to the slave device.</td>

</tr>

<tr>

<td>Timeout</td>

−

<td>integer [1..30]; default: 5</td>

+

<td>integer [1..60]; default: 1</td>

<td>Maximum response wait time.</td>

</tr>

</table>

+

=====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~~. You can create a maximum of 64 request configurations for each slave device~~.

+

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

Line 473: Line 688:

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

Line 488: Line 703:

<tr>

−

<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: 16bit INT, high byte first</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: 16bit INT, high byte first</td>

<td>Defines how read data will be stored.</td>

</tr>

<tr>

<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: Read holding registers (3)</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: Read holding registers (3)</td>

<td>Specifies the type of register being addressed by a Modbus request.

</td>

Line 508: Line 723:

</tr>

<tr>

−

<td>No Brackets</td>

+

<td>Remove Brackets</td>

−

<td>off ~~<nowiki>|</nowiki>~~ on; default: off</td>

+

<td>off {{!}} on; default: off</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: off</td>

+

<td>Turns the request on or off.</td>

</tr>

<tr>

Line 516: Line 736:

<td>- (interactive button)</td>

<td>Deletes the request.</td>

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>off/on slider</td>~~

−

~~<td>off <nowiki>|</nowiki> on; default: off</td>~~

−

~~<td>Turns the request on or off.</td>~~

</tr>

</table>

Line 542: Line 757:

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

Line 552: Line 767:

<tr>

<td>Enabled</td>

−

<td>off ~~<nowiki>|</nowiki>~~ on; default: off</td>

+

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

<td>Turns the alarm on or off.</td>

</tr>

<tr>

<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: Read Coil Status (1)</td>

+

<td>Read Coil Status (1) {{!}} Read Input Status (2) {{!}} Read Holding Registers (3) {{!}} Read Input Registers (4); default: Read Coil Status (1)</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 [[#~~RS232_Slave_Device_Configuration~~|~~RS232~~ 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>

−

<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: 16bit INT, high byte first</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: none</td>

<td>Number of the Modbus coil/input/holding-register/input-register to read from.</td>

</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: Equal to</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: none</td>

<td>The value against which the read data will be compared.</td>

</tr>

<tr>

−

<td>~~Value~~</td>

+

<td>Condition</td>

−

<td>~~integer [0..65535]~~; default: ~~none~~</td>

+

<td>More than {{!}} Less than {{!}} Equal to {{!}} Not Equal to {{!}} Less or equal {{!}} More or equal; default: More than</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>

<td>Action frequency</td>

−

<td>Every trigger ~~<nowiki>|</nowiki>~~ First trigger; default: Every trigger</td>

+

<td>Every trigger {{!}} First trigger; default: Every trigger</td>

<td>Describes how frequently the specified action will be taken.</td>

</tr>

<tr>

<td>Redundancy protection</td>

−

<td>off <~~nowiki~~>|</~~nowiki~~> on; default: off</td>

+

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

<td>Protection against executing a configured action too often.</td>

</tr>

<tr>

−

<td>Redundancy protection period</td>

+

<td>Redundancy protection period</td>

<td>integer [1..86400]; default: none</td>

<td>Duration to activate redundancy protection for, measured in seconds. This field becomes visible only when 'Redundancy protection' is turned on.</td>

Line 597: Line 812:

<tr>

<td>Action</td>

−

<td>{{#ifeq:{{{mobile}}}|1|SMS {{!}}|}} MODBUS Write Request; default: MODBUS Write Request</td>

+

<td>{{#ifeq:{{{mobile}}}|1|SMS {{!}}|}} MODBUS Write Request{{#switch:{{{series}}}|TCR1=|TRB2=|#default= {{!}} Trigger output}}; default: MODBUS Write Request</td>

<td>Action that will be taken if the condition is met. Possible actions:

<ul>{{#ifeq: {{{mobile}}} | 1 |

<li>SMS - sends and SMS message to a specified recipient(s).</li>|}}

<li>Modbus Request - sends a Modbus Write request to a specified slave.</li>

+

{{#switch:{{{series}}}|TCR1=|TRB2=|#default=<li>Trigger output - changes state of selected I/O output pin.</li>}}

</ul>

</td>

Line 627: Line 843:

<tr>

<td>MODBUS Write Request: Modbus function</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: ~~Force~~ Single Coil (5)</td>

+

<td>Read Single Coil (5) {{!}} Set Single Register (6) {{!}} Set Multiple Coils (15) {{!}} Set Multiple Registers (16); default: Set Single Coil (5)</td>

<td>A function code specifies the type of register being addressed by a Modbus request.</td>

</tr>

<tr>

−

<td>MODBUS Write Request: First register</td>

+

<td>MODBUS Write Request: Executed action 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 UNIT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool; default: Bool</td>

+

<td>Select data type that will be used for executing action.</td>

+

</tr>

+

<tr>

+

<td>MODBUS Write Request: First register number</td>

<td>integer [0..65535]; default: none</td>

<td>Begins reading from the register specified in this field.</td>

Line 639: Line 860:

<td>integer [0..65535]; default: none</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>Trigger output: Output</td>{{#switch:{{{series}}}

+

| RUTX|RUT2 =<td>4PIN output; default: 4PIN output</td>

+

| TRB1|RUT3 =<td>Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: Configurable Input/Output (3)</td>

+

| RUT9 =<td>Open collector output {{!}} Relay output {{!}} 4PIN output; default: Open collector output</td>}}

+

<td>Selects which output will be triggered.</td>

</tr>

+

<tr>

+

<td>Trigger output: I/O Action</td>

+

<td>Turn On {{!}} Turn Off {{!}} Invert; default: Turn On</td>

+

<td>Selects the action performed on the output.</td>

+

</tr>}}

</table>

−

|}}~~|}}~~{{#ifeq: {{{~~rs485~~}}} | 1 |

+

|}}

−

~~<h3>RS485</h3>~~

+

{{#ifeq: {{{console}}} | 1 |

+

===Console===

----

−

This section is used to configure the Modbus Serial Master's ~~RS485~~ 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 Console 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]]

Line 656: Line 890:

<tr>

<td>Enabled</td>

−

<td>off ~~<nowiki>|</nowiki>~~ on; default: off</td>

+

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

−

<td>Turns Modbus Serial Master configuration via ~~RS485~~ on or off. Both this and ~~RS485~~ from Services → [[{{{name}}} ~~RS485~~|~~RS485~~]] 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>

−

+

<td>300 {{!}} 1200 {{!}} 2400 {{!}} 4800 {{!}} 9600 {{!}} 19200 {{!}} 38400 {{!}} 57600 {{!}} 115200 {{!}} 1000000; default: 115200</td>

<td>Serial data transmission rate (in bits per second).</td>

</tr>

<tr>

−

<td>5 ~~<nowiki>|</nowiki>~~ 6 ~~<nowiki>|</nowiki>~~ 7 ~~<nowiki>|</nowiki>~~ 8; default: 8</td>

+

<td>5 {{!}} 6 {{!}} 7 {{!}} 8; default: 8</td>

<td>Number of data bits for each character.</td>

</tr>

<tr>

<td>Parity</td>

−

<td>None ~~<nowiki>|</nowiki>~~ Even ~~<nowiki>|</nowiki>~~ Odd; default: None</td>

+

<td>None {{!}} Even {{!}} Odd; default: None</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>

Line 682: Line 916:

<tr>

−

<td>1 ~~<nowiki>|</nowiki>~~ 2; default: 1</td>

+

<td>1 {{!}} 2; default: 1</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>Flow control</td>

−

<td>None ~~<nowiki>|</nowiki>~~ RTS/CTS ~~<nowiki>|</nowiki>~~ Xon/Xoff; default: None</td>

+

<td>None {{!}} RTS/CTS {{!}} Xon/Xoff; default: None</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.

<ul>

Line 697: Line 931:

</table>

−

====~~RS485~~ Slave Devices List====

+

====Console Slave Devices List====

----

−

The ~~RS485~~ Slave Devices List section is used to configure the parameters of Modbus RTU slaves that the Master (this {{{name}}} device) will be querying with requests.

+

The Console Slave Devices List 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. A new configuration window should pop up.

−

[[File:~~Networking_rutos_manual_modbus_modbus_serial_master_rs485_slave_devices_list_add_button~~.png|border|class=tlt-border]]

+

[[File:Networking_rutos_manual_modbus_modbus_serial_master_console_slave_devices_list_add_button.png|border|class=tlt-border]]

−

=====~~RS485~~ Slave Device Configuration=====

+

=====Slave Device Configuration=====

----

−

The ~~RS485~~ Slave Device Configuration 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 Slave Device Configuration 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]]

Line 719: Line 953:

<tr>

<td>Enabled</td>

−

<td>off ~~<nowiki>|</nowiki>~~ on; default: off</td>

+

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

<td>Turns communication with the slave device on or off.</td>

</tr>

Line 745: Line 979:

=====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~~. You can create a maximum of 64 request configurations for each slave device~~.

+

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

Line 755: Line 989:

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

Line 770: Line 1,004:

<tr>

−

<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: 16bit INT, high byte first</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: 16bit INT, high byte first</td>

<td>Defines how read data will be stored.</td>

</tr>

<tr>

<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: Read holding registers (3)</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: Read holding registers (3)</td>

<td>Specifies the type of register being addressed by a Modbus request.

</td>

Line 790: Line 1,024:

</tr>

<tr>

−

<td>No Brackets</td>

+

<td>Remove Brackets</td>

−

<td>off ~~<nowiki>|</nowiki>~~ on; default: off</td>

+

<td>off {{!}} on; default: off</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: off</td>

+

<td>Turns the request on or off.</td>

</tr>

<tr>

Line 798: Line 1,037:

<td>- (interactive button)</td>

<td>Deletes the request.</td>

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>off/on slider</td>~~

−

~~<td>off <nowiki>|</nowiki> on; default: off</td>~~

−

~~<td>Turns the request on or off.</td>~~

</tr>

</table>

Line 824: Line 1,058:

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

Line 834: Line 1,068:

<tr>

<td>Enabled</td>

−

<td>off ~~<nowiki>|</nowiki>~~ on; default: off</td>

+

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

<td>Turns the alarm on or off.</td>

</tr>

<tr>

<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: Read Coil Status (1)</td>

+

<td>Read Coil Status (1) {{!}} Read Input Status (2) {{!}} Read Holding Registers (3) {{!}} Read Input Registers (4); default: Read Coil Status (1)</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>

+

<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: 16bit INT, high byte first</td>

+

<td>Select data type that will be used for checking conditions.</td>

</tr>

<tr>

−

<td>~~Register~~</td>

+

<td>First register number</td>

<td>integer [1..65536]; default: none</td>

<td>Number of the Modbus coil/input/holding-register/input-register to read from.</td>

</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: Equal to</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: none</td>

<td>The value against which the read data will be compared.</td>

</tr>

<tr>

−

<td>~~Value~~</td>

+

<td>Condition</td>

−

<td>~~integer [0..65535]~~; default: ~~none~~</td>

+

<td>More than {{!}} Less than {{!}} Equal to {{!}} Not Equal to {{!}} Less or equal {{!}} More or equal; default: More than</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>

<td>Action frequency</td>

−

<td>Every trigger ~~<nowiki>|</nowiki>~~ First trigger; default: Every trigger</td>

+

<td>Every trigger {{!}} First trigger; default: Every trigger</td>

<td>Describes how frequently the specified action will be taken.</td>

</tr>

<tr>

<td>Redundancy protection</td>

−

<td>off <~~nowiki~~>|</~~nowiki~~> on; default: off</td>

+

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

<td>Protection against executing a configured action too often.</td>

</tr>

<tr>

−

<td>Redundancy protection period</td>

+

<td>Redundancy protection period</td>

<td>integer [1..86400]; default: none</td>

<td>Duration to activate redundancy protection for, measured in seconds. This field becomes visible only when 'Redundancy protection' is turned on.</td>

Line 879: Line 1,113:

<tr>

<td>Action</td>

−

<td>SMS ~~<nowiki>~~|~~</nowiki>~~ MODBUS Write Request; default: MODBUS Write Request</td>

+

<td>{{#ifeq:{{{mobile}}}|1|SMS {{!}}|}} MODBUS Write Request; default: MODBUS Write Request</td>

<td>Action that will be taken if the condition is met. Possible actions:

−

<ul>

+

<ul>{{#ifeq: {{{mobile}}} | 1 |

−

<li>SMS - sends and SMS message to a specified recipient(s).</li>

+

<li>SMS - sends and SMS message to a specified recipient(s).</li>|}}

<li>Modbus Request - sends a Modbus Write request to a specified slave.</li>

</ul>

</td>

−

</tr>

+

</tr>{{#ifeq: {{{mobile}}} | 1 |

<tr>

<td>SMS: Message</td>

Line 896: Line 1,130:

<td>phone number; default: none</td>

<td>Recipient's phone number.</td>

−

</tr>

+

</tr>|}}

<tr>

<td>MODBUS Write Request: Timeout</td>

Line 909: Line 1,143:

<tr>

<td>MODBUS Write Request: Modbus function</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: ~~Force~~ Single Coil (5)</td>

+

<td>Read Single Coil (5) {{!}} Set Single Register (6) {{!}} Set Multiple Coils (15) {{!}} Set Multiple Registers (16); default: Set Single Coil (5)</td>

<td>A function code specifies the type of register being addressed by a Modbus request.</td>

</tr>

<tr>

−

<td>MODBUS Write Request: First register</td>

+

<td>MODBUS Write Request: Executed action 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 UNIT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool; default: Bool</td>

+

<td>Select data type that will be used for executing action.</td>

+

</tr>

+

<tr>

+

<td>MODBUS Write Request: First register number</td>

<td>integer [0..65535]; default: none</td>

<td>Begins reading from the register specified in this field.</td>

Line 925: Line 1,164:

|}}

−

~~{{#ifeq: {{{console}}} | 1 |~~

+

==MQTT Gateway==

−

===~~Console=~~==

+

−

~~----~~

+

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.

−

~~This section is used to configure the Modbus Serial Master's~~ ~~Console~~ ~~serial interface settings~~. Refer to the ~~figure and~~ table ~~below~~ for information on ~~Console~~ configuration.

+

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_modbus_serial_master_console_configuration~~.png|border|class=tlt-border]]

+

[[File:Networking_rutos_manual_modbus_mqtt_gateway_v1.png|border|class=tlt-border]]

Line 939: Line 1,183:

</tr>

<tr>

−

<td>~~Enabled~~</td>

+

<td>Enable</td>

−

<td>off ~~<nowiki>|</nowiki>~~ on; default: off</td>

+

<td>off {{!}} on; default: off</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 MQTT gateway on or off.</td>

</tr>

<tr>

−

+

−

+

<td>ip {{!}} host; default: 127.0.0.1</td>

−

<td>~~Serial data transmission rate (in bits per second)~~.</td>

+

<td>IP address or hostname of an MQTT broker.</td>

</tr>

<tr>

−

+

−

<td>~~5 <nowiki>|</nowiki> 6 <nowiki>|</nowiki> 7 <nowiki>|</nowiki> 8~~; default: 8</td>

+

<td>integer [0..65535]; default: 1883</td>

−

<td>~~Number~~ of ~~data bits for each character~~.</td>

+

<td>Port number of the MQTT broker.</td>

</tr>

<tr>

−

<td>~~Parity~~</td>

+

<td>Request topic</td>

−

<td>~~None <nowiki>|</nowiki> Even <nowiki>|</nowiki> Odd~~; default: ~~None~~</td>

+

<td>alphanumeric string; default: request</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>MQTT topic for sending requests.</td>

−

~~<ul>~~

−

~~<li>None (N) - no parity method is used.</li>~~

−

~~<li>Odd (O) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.</li>~~

−

~~<li>Even (E) - the parity bit is set so that the number of "logical ones (1s)" has to be even.</li>~~

−

~~</ul>~~

−

</td>

</tr>

<tr>

−

+

<td>Response topic</td>

−

<td>~~1 <nowiki>|</nowiki> 2; default: 1</td>~~

+

<td>alphanumeric string; default: response</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>MQTT topic for subscribing to responses.</td>

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>Flow control</td>~~

−

~~<td>None <nowiki>|</nowiki> RTS/CTS <nowiki>|</nowiki> Xon/Xoff~~; default: ~~None~~</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.

−

~~<ul>~~

−

~~<li>RTS/CTS - 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>Xon/Xoff - 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>~~

−

~~</table>~~

−

~~====Console Slave Devices List====~~

−

~~----~~

−

~~The Console Slave Devices List 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. A new configuration window should pop up.~~

−

~~[[File:Networking_rutos_manual_modbus_modbus_serial_master_console_slave_devices_list_add_button.png|border|class=tlt-border]]~~

−

~~=====Slave Device Configuration=====~~

−

~~----~~

−

The Slave Device Configuration 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]]~~

−

~~<table class="nd-mantable">~~

−

~~<tr>~~

−

~~<th>Field</th>~~

−

~~<th>Value</th>~~

−

~~<th>Description</th~~>

</tr>

<tr>

−

<td>~~Enabled~~</td>

+

−

<td>~~off <nowiki>|</nowiki> on~~; default: ~~off~~</td>

+

<td>At most once (0) {{!}} At least once (1) {{!}} Exactly once (2); default: Exactly once (2)</td>

−

<td>~~Turns communication with the slave device on or off~~.</td>

+

<td>Specifies quality of service.</td>

</tr>

<tr>

−

+

<td>Username</td>

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

−

<td>~~Slave device's name, used~~ for ~~easier management purposes~~.</td>

+

<td>Username for authentication to the MQTT broker.</td>

</tr>

<tr>

−

<td>~~Slave ID~~</td>

+

<td>Password</td>

−

<td>~~integer [0..255]~~; default: none</td>

+

<td>string; default: none</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>Password for authentication to the MQTT broker.</td>

</tr>

<tr>

−

<td>~~Period~~</td>

+

<td>Client ID</td>

−

<td>integer ~~[1..86400]~~; default: 60</td>

+

<td>integer; default: none</td>

−

<td>~~Interval at which requests are sent to the slave device~~.</td>

+

<td>Specifies client ID for MQTT broker.</td>

</tr>

<tr>

−

<td>~~Timeout~~</td>

+

<td>Keepalive</td>

−

<td>integer ~~[1..30]~~; default: 5</td>

+

<td>integer; default: 5</td>

−

<td>~~Maximum response wait time.~~</td>

+

<td>Keepalive message to MQTT broker (seconds)</td>

</tr>

−

~~</table>~~

−

~~=====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. You can create a maximum of 64 request configurations for each slave device.

−

Note: Modbus Serial 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:~~

−

~~[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_add_new_instance.png|border|class=tlt-border]]~~

−

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

−

~~<table class="nd-mantable">~~

<tr>

−

<th>~~Field~~</th>

+

−

<th>~~Value~~</th>

+

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

−

<th>~~Description~~</th>

+

<td>Turns TLS support on or off</td>

</tr>

<tr>

−

+

−

<td>~~string~~; default: ~~Unnamed~~</td>

+

<td>cert {{!}} psk; default: cert</td>

−

<td>~~Name~~ of ~~this Request Configuration. Used for easier management purposes.~~</td>

+

<td>Selects the type of TLS encryption</td>

</tr>

<tr>

−

+

<td>TLS insecure</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: ~~16bit INT, high byte first~~</td>

+

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

−

<td>~~Defines how read data will be stored.~~</td>

+

<td>Disables TLS security</td>

</tr>

<tr>

−

<td>~~Function~~<~~/td~~>

+

<td>Certificate files from device</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: ~~Read holding registers (3)~~</td>

+

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

−

<td>~~Specifies the type of register being addressed by a Modbus request~~.

+

<td>Choose this option if you want to use certificate files generated on device.</td>

−

</td>

</tr>

<tr>

−

<td>~~First Register~~</td>

+

−

<td>~~integer [0..65535]~~; default: 1</td>

+

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

−

<td>~~First Modbus register from which data will be read~~.</td>

+

<td>Upload/select certificate authority file.</td>

</tr>

<tr>

−

<td>~~Register Count~~ / ~~Values~~</td>

+

<td>Certificates file</td>

−

<td>~~integer [1..2000]~~; default: 1</td>

+

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

−

<td>~~Number of Modbus registers that will be read during the request~~.</td>

+

<td>Upload/select certificate file.</td>

</tr>

<tr>

−

<td>~~No Brackets~~</td>

+

−

<td>~~off <nowiki>|</nowiki> on~~; default: ~~off~~</td>

+

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

−

<td>~~Removes the starting and ending brackets from the request (only for read requests)~~.</td>

+

<td>Upload/select certificate key file.</td>

</tr>

<tr>

−

<td>~~Delete [ X ]~~</td>

+

−

<td>~~- (interactive button)~~</td>

+

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

−

<td>~~Deletes~~ the ~~request~~.</td>

+

<td>Specifies the pre-shared key.</td>

</tr>

<tr>

−

<td>~~off~~/~~on slider~~</td>

+

<td>Identity</td>

−

<td>~~off <nowiki>|</nowiki> on~~; default: ~~off~~</td>

+

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

−

<td>~~Turns the request on or off~~.</td>

+

<td>Specifies identity.</td>

</tr>

</table>

−

+

{{#ifeq:{{{serial}}}|1|

−

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

+

===Serial Gateway Configuration===

−

~~[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_on_off_slider.png~~|~~border~~|~~class~~=~~tlt-border]]~~

----

−

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

+

Serial Gateway Configuration section displays Serial gateway instances currently existing on the router.

−

~~[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_testing~~.~~png|border|class=tlt-border]]~~

+

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.

−

~~=====Modbus Master Alarms=====~~

+

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

−

~~----~~

−

~~Alarms are a way of setting up automated actions when some Modbus values meet user-defined conditions. When the Modbus Serial 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 Modbus Master Alarms list. To create a new Alarm, click the~~ '~~Add' button.~~

+

After this you should be redirected to instance's configuration page which should look similar to this:

−

[[File:~~Networking_rutos_manual_modbus_modbus_serial_master_modbus_master_alarms_add_button.png~~|~~border~~|~~class=tlt-border]]~~

+

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

−

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

Line 1,117: Line 1,298:

</tr>

<tr>

−

<td>~~Enabled~~</td>

+

<td>Enable</td>

−

<td>off ~~<nowiki>|</nowiki>~~ on; default: off</td>

+

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

−

<td>~~Turns the alarm on or off~~.</td>

+

<td>Enables this Serial Gateway instance configuration.</td>

</tr>

<tr>

−

<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: ~~Read Coil Status (1)~~</td>

+

<td>string; default: none</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>Name of the gateway instance. Used for management purposes only.</td>

</tr>

<tr>

−

<td>~~Register~~</td>

+

<td>Device</td>

−

<td>~~integer [1..65536]~~; default: ~~none~~</td>

+

<td>{{Template: Networking rutos manual serial ports| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}; default: {{Template: Networking rutos manual default serial port| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}</td>

−

<td>~~Number of the Modbus coil/input/holding-register/input-register to read from~~.</td>

+

<td>Specifies which serial port will be used for serial communication.</td>

</tr>

<tr>

−

<td>~~Condition~~</td>

+

−

<td>~~More than <nowiki>~~|~~</nowiki> Less than <nowiki>~~|~~</nowiki> Equal to <nowiki>~~|~~</nowiki> Not Equal to~~; default: ~~Equal to~~</td>

+

<td>300 {{!}} 1200 {{!}} 2400 {{!}} 4800 {{!}} 9600 {{!}} 19200 {{!}} 38400 {{!}} 57600 {{!}} 115200{{#ifeq: {{{rs485}}} | 1 | {{!}} 230400 {{!}} 460800 {{!}} 921600 {{!}} 1000000 {{!}} 3000000|}}; default: 9600</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>

+

<td>Serial data transmission rate (in bits per second).</td>

</tr>

<tr>

−

<td>~~Value~~</td>

+

−

<td>~~various~~; default: ~~none~~</td>

+

<td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: 8</td>

−

<td>~~The value against which the read~~ data ~~will be compared~~.</td>

+

<td>Number of data bits for each character.</td>

</tr>

<tr>

−

<td>~~Value~~</td>

+

−

<td>~~integer [0..65535]~~; default: ~~none~~</td>

+

<td>1{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} 2|}}; default: 1</td>

−

<td>~~The value against which~~ the ~~read data will be compared~~.</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>~~Action frequency~~</td>

+

<td>Parity</td>

−

<td>~~Every trigger <nowiki>~~|~~</nowiki> First trigger~~; default: ~~Every trigger~~</td>

+

<td>Even {{!}} Odd{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} Mark {{!}} Space|}} {{!}} None; default: None</td>

−

<td>~~Describes how frequently~~ the ~~specified action~~ will be ~~taken~~.</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>None (N) - no parity method is used.</li>

+

<li>Odd (O) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.</li>

+

<li>Even (E) - 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>Space (s) - the parity bit will always be a binary 0.</li>

+

<li>Mark (M) - the parity bit will always be a binary 1.</li>|}}

+

</ul>

+

</td>

</tr>

<tr>

−

<td>~~Redundancy protection~~</td>

+

<td>Flow control</td>

−

<td>~~off <nowiki>|</nowiki> on; default: off</td>~~

+

<td>None {{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} RTS/CTS {{!}} Xon/Xoff|}}; default: None</td>

−

~~<td>Protection against executing a configured action too often.</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.

−

~~</tr>~~

+

{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|<ul>

−

~~<tr>~~

+

<li>RTS/CTS - 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>

−

~~<td>Redundancy protection period</td>~~

+

<li>Xon/Xoff - 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>

−

~~<td>integer [1..86400]; default~~: ~~none</td>~~

+

</ul>|}}

−

~~<td>Duration to activate redundancy protection for, measured in seconds. This field becomes visible only when 'Redundancy protection' is turned on.</td>~~

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>Action</td>~~

−

~~<td>~~{{#~~ifeq~~:{{{~~mobile~~}}}|1|~~SMS~~ {{!}}|}} ~~MODBUS Write Request~~; default: ~~MODBUS Write Request~~</td>

−

<td>~~Action that will~~ be ~~taken if~~ the ~~condition~~ is ~~met~~. ~~Possible actions:~~

−

~~<ul>~~{{#ifeq: {{{~~mobile~~}}} | 1 |

−

<li>~~SMS~~ - ~~sends~~ and ~~SMS message~~ to a ~~specified recipient(s)~~.</li>~~|}}~~

−

<li>~~Modbus Request~~ - sends ~~a Modbus Write request~~ to ~~a specified slave~~.</li>

−

</ul>

</td>

−

</tr>{{#ifeq: {{{~~mobile~~}}} | 1 |

+

</tr>{{#ifeq: {{{rs485}}} | 1 |

<tr>

−

<td>SMS: Message</td>

+

<td>RS485: Full Duplex</td>

−

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

+

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

−

~~<td>SMS message text.</td>~~

+

<td>Enables RS485 full duplex.</td>

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>~~SMS~~: ~~Phone number</td>

−

<td>~~phone number~~; default: ~~none~~</td>

−

<td>~~Recipient's phone number~~.</td>

</tr>|}}

−

~~<tr>~~

−

~~<td>MODBUS Write Request: Timeout</td>~~

−

~~<td>integer [1..30]; default: 5</td>~~

−

~~<td>Maximum time to wait for a response.</td>~~

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>MODBUS Write Request: ID</td>~~

−

~~<td>integer [1..255]; default: none</td>~~

−

~~<td>Modbus slave ID.</td>~~

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>MODBUS Write Request: Modbus function</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: Force Single Coil (5)</td>

−

~~<td>A function code specifies the type of register being addressed by a Modbus request.</td>~~

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>MODBUS Write Request: First register</td>~~

−

~~<td>integer [0..65535]; default: none</td>~~

−

~~<td>Begins reading from the register specified in this field.</td>~~

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>MODBUS Write Request: Values</td>~~

−

~~<td>integer [0..65535]; default: none</td>~~

−

~~<td>Register/Coil values to be written (multiple values must be separated by space character).</td>~~

−

~~</tr>~~

</table>

|}}

−

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

−

~~[[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.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 <nowiki>|</nowiki> on; default: off</td>~~

−

~~<td>Turns MQTT gateway on or off.</td>~~

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>Host</td>~~

−

~~<td>ip <nowiki>|</nowiki> host; default: 127.0.0.1</td>~~

−

~~<td>IP address or hostname of an MQTT broker.</td>~~

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>Port</td>~~

−

~~<td>integer [0..65535]; default: 1883</td>~~

−

~~<td>Port number of the MQTT broker.</td>~~

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>Request topic</td>~~

−

~~<td>alphanumeric string; default: request</td>~~

−

~~<td>MQTT topic for sending requests.</td>~~

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>Response topic</td>~~

−

~~<td>alphanumeric string; default: response</td>~~

−

~~<td>MQTT topic for subscribing to responses.</td>~~

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>Username</td>~~

−

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

−

~~<td>Username for authentication to the MQTT broker.</td>~~

−

~~</tr>~~

−

~~<tr>~~

−

~~<td>Password</td>~~

−

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

−

~~<td>Password for authentication to the MQTT broker.</td>~~

−

~~</tr>~~

−

~~</table>~~

−

===Request messages===

----

Line 1,337: Line 1,429:

65432 OK 0 5590</pre></li>

</ul>

+

{{#ifeq: {{{serial}}} | 1 |

+

==Modbus TCP over Serial Gateway==

+

The Modbus TCP over Serial gateway 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===

+

----

+

Modbus TCP over Serial Gateway Configuration 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]]

+

+

<tr>

+

<th>Field</th>

+

<th>Value</th>

+

<th>Description</th>

+

</tr>

+

<tr>

+

<td>Enable</td>

+

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

+

<td>Enables this Modbus TCP over Serial Gateway instance configuration.</td>

+

</tr>

+

<tr>

+

+

<td>string; default: none</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: {{Template: Networking rutos manual default serial port| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}</td>

+

<td>Specifies which serial port will be used for serial communication.</td>

+

</tr>

+

<tr>

+

+

<td>300 {{!}} 1200 {{!}} 2400 {{!}} 4800 {{!}} 9600 {{!}} 19200 {{!}} 38400 {{!}} 57600 {{!}} 115200{{#ifeq: {{{rs485}}} | 1 | {{!}} 230400 {{!}} 460800 {{!}} 921600 {{!}} 1000000 {{!}} 3000000|}}; default: 9600</td>

+

<td>Serial data transmission rate (in bits per second).</td>

+

</tr>

+

<tr>

+

+

<td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: 8</td>

+

<td>Number of data bits for each character.</td>

+

</tr>

+

<tr>

+

+

<td>1{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} 2|}}; default: 1</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: None</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>None (N) - no parity method is used.</li>

+

<li>Odd (O) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.</li>

+

<li>Even (E) - 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>Space (s) - the parity bit will always be a binary 0.</li>

+

<li>Mark (M) - 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: None</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>RTS/CTS - 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>Xon/Xoff - 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: none</td>

+

<td>IP address to listen for incoming connections. (0.0.0.0) value may be used to listen for incoming connections on any interface or IP address.</td>

+

</tr>

+

<tr>

+

+

<td>integer [0..65535]; default: none</td>

+

<td>Port number to listen for incoming connections.</td>

+

</tr>

+

<tr>

+

<td>Slave ID configuration type</td>

+

<td>User defined {{!}} Obtained from TCP; default: User defined</td>

+

<td>Specifies whether slave IDs are user defined or automatically obtained from TCP.</td>

+

</tr>

+

<tr>

+

<td>Slave ID</td>

+

<td>integer; default: none</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. A range of IDs can be specified by placing a hyphen (-) between two integer numbers. For example, if you permit slave IDs in the range of 10 to 20, you would specify it as: 10-20 You can also specify multiple values that are not connected in a range using commas (,). For example, to specify 6, 50 and 100 as permitted slave IDs, you would have to use: 6,50,100</td>

+

</tr>

+

<tr>

+

<td>Permitted slave IDs</td>

+

<td>range of integers; default: 1-247</td>

+

<td>Read Slave ID field description.</td>

+

</tr>

+

<tr>

+

<td>CRC verification</td>

+

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

+

<td>Checks if sent serial message is not disturbed.</td>

+

</tr>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|

+

<tr>

+

+

<td>off {{!}} on; default: off</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>RS485: Full Duplex</td>

+

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

+

<td>Enables RS485 full duplex.</td>

+

</tr>|}}

+

</table>

+

===IP Filter===

+

----

+

The IP Filter 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==

Gytispieze

Bureaucrats, Interface administrators, Administrators

9,312

edits

Namespaces

Variants

Views

More

Search

Changes

Template:Networking rutos manual modbus (view source)

Revision as of 10:04, 23 November 2022

Navigation menu

Personal tools

NAVIGATION

Tools

Categories