31,703
edits
Changes
Template:Networking rutos manual modbus (view source)
Revision as of 15:01, 25 August 2020
, 15:01, 25 August 2020→Modbus TCP Master
===Slave Device Configuration===
===Slave Device Configuration===
----
----
The <b>Slave Device Configuration</b> section is used to configure the parameters or Modbus TCP slaves that the Master (this {{{name}}} device) will 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.png|border|class=tlt-border]]
===Alarms Configuration===
===Alarms Configuration===
----
----
<b>Alarms</b> are a way of setting up automated actions when some Modbus values meet user specified conditions. The figure below is an example of the Alarms Configuration list.
<b>Alarms</b> 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.
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_alarms_configuration_add_button.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_alarms_configuration_alarm_configuration_v1.png|border|class=tlt-border]]
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]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>Function code</td>
<td>Function code</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>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.</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>
</tr>
</tr>
</table>
</table>
{{#ifeq: {{{series}}} | RUTX ||
{{#ifeq: {{{serial}}} | 1 |
==Modbus Serial Master==
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===
----
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.
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs232_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: <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>
</tr>
<tr>
<td>Baud rate</td>
<td>300 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400 | 57600 | 115200; default: <b>115200</b></td>
<td>Serial data transmission rate (in bits per second).</td>
</tr>
<tr>
<td>Data bits</td>
<td>5 | 6 | 7 | 8; default: <b>8</b></td>
<td>Number of data bits for each character.</td>
</tr>
<tr>
<td>Parity</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.
<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>
</ul>
</td>
</tr>
<tr>
<td>Stop bits</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>
</tr>
<tr>
<td>Flow control</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.
<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>
</table>
====RS232 Slave Devices List====
----
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.
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_slave_devices_list_add_button.png|border|class=tlt-border]]
Then click the 'Edit' button next to the newly added slave device in order to begin conifguration
[[File:Networking_rutos_manual_modbus_modbus_serial_master_slave_devices_list_edit_button.png|border|class=tlt-border]]
|}}|}}
==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 over MQTT. Refer to the table for information on MQTT Gateway configuration fields.
[[File:Networking_rutos_manual_modbus_mqtt_gateway_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_modbus_mqtt_gateway.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>Password for authentication to the MQTT broker.</td>
<td>Password for authentication to the MQTT broker.</td>
</tr>
</tr>
</table>|}}
</table>
==See also==
==See also==
