219
edits
Changes
Template:Networking rutos manual modbus (view source)
Revision as of 17:44, 16 April 2024
, 16 Aprilno edit summary
{{Template: Networking_rutos_manual_fw_disclosure
{{Template: Networking_device_manual_fw_disclosure
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series = {{{series}}}
| name = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| series = {{{series}}}
| name = {{{name}}}
| name = {{{name}}}
}}
}}
}}
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
==Summary==
==Summary==
| RUTM =
| RUTM =
| TRB1 =
| TRB1 =
| TRB2 =
| TRB2 =
| TRB2M =
| RUT9|RUT9M =
| RUT9|RUT9M =
| RUT14X =
| #default =
| #default =
<u><b>
<u><b>
Note:</b> On {{{name}}}, Modbus TCP Server/Client and MQTT Gateway is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u><br>}}
Note:</b> On {{{name}}}, Modbus TCP Server/Client and MQTT Gateway is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u><br>}}
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
| series = {{{series}}}
| series = {{{series}}}
The figure below is an example of the Modbus TCP window section and the table below provides information on the fields contained in that window:
The figure below is an example of the Modbus TCP window section and the table below provides information on the fields contained in that window:
[[File:Networking_rutos_manual_modbus_modbus_tcp_slave_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_modbus_modbus_tcp_server.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
The <b>Modbus Serial Server Configuration</b> section is used to configure serial servers. By default, the list is empty. To add a new server instance, enter the instance name, select serial interface and click the 'Add' button.
The <b>Modbus Serial Server Configuration</b> section is used to configure serial servers. By default, the list is empty. To add a new server 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]]
[[File:Networking_rutos_manual_modbus_modbus_serial_server_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 server instance configuration page.
After clicking 'Add' you will be redirected to the newly added server 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]]
[[File:Networking_rutos_manual_modbus_modbus_serial_server_configuration_rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>integer [0..255]; default: <b>1</b></td>
<td>integer [0..255]; default: <b>1</b></td>
<td>Specifies which serial port will be used for serial communication.</td>
<td>Specifies which serial port will be used for serial communication.</td>
</tr>
<tr>
<td>Mobile Data type</td>
<td>Bytes | Kilobytes | Megabytes; default: <b>Bytes</b></td>
<td>Selects mobile data unit representation type.</td>
</tr>
</tr>
<tr>
<tr>
<tr>
<tr>
<td>Data bits</td>
<td>Data bits</td>
<td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
<td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#switch:{{{series}}}|TRB2|TRB2M=|#default=5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
<td>Number of data bits for each character.</td>
<td>Number of data bits for each character.</td>
</tr>
</tr>
==Modbus TCP Client==
==Modbus TCP Client==
A <b>Modbus Client</b> device can request data from Modbus servers. The Modbus TCP Client section is used to configure Modbus TCP servers. By default, the server list is empty. To add a new server, click the 'Add' button
A <b>Modbus Client</b> device can request data from Modbus servers. The Modbus TCP Client section is used to configure Modbus TCP servers and enable Client.
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_modbus_tcp_slave_devices_add_button.png|border|class=tlt-border]]
Notice the Global section config. It is used to outright turn the service off or on if any active configurations are present.
[[File:Networking rutos manual modbus modbus tcp client modbus tcp server devices global button v1.png|border|class=tlt-border]]
Clicking the Cog icon opens a modal window. The global configuration slider can be set and it's state saved.
[[File:Networking rutos manual modbus modbus tcp client modbus tcp server devices global config modal v1.png|border|class=tlt-border]]
By default, the server list is empty and client is disabled. To add a new server, click the 'Add' button
[[File:Networking_rutos_manual_modbus_modbus_tcp_client_modbus_tcp_server_devices_add_button_v2.png|border|class=tlt-border]]
After clicking 'Add' you will be redirected to the newly added server's configuration page.
After clicking 'Add' you will be redirected to the newly added server's configuration page.
The <b>Server Device Configuration</b> section is used to configure the parameters of Modbus TCP servers that the Client (this {{{name}}} device) will be querying with requests. The figure below is an example of the Server Device Configuration and the table below provides information on the fields contained in that section:
The <b>Server Device Configuration</b> section is used to configure the parameters of Modbus TCP servers that the Client (this {{{name}}} device) will be querying with requests. The figure below is an example of the Server 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_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_modbus_modbus_tcp_client_server_device_configuration.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>integer [0..65535]; default: <b>none</b></td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Server device's Modbus TCP port.</td>
<td>Server device's Modbus TCP port.</td>
</tr>
</tr>
<tr>
<tr>
The Request Configuration list is empty by default. To add a new Request Configuration loon to the Add New Instance section. Enter a custom name into the 'Name' field and click the 'Add' button:
The Request Configuration list is empty by default. To add a new Request Configuration loon to the Add New Instance section. Enter a custom name into the 'Name' field and click the 'Add' button:
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_add_new_instance.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_modbus_modbus_tcp_client_requests_configuration_add_new_instance.png|border|class=tlt-border]]
The new Request Configuration should become visible in the list:
The new Request Configuration should become visible in the list:
<tr>
<tr>
<td>Data type</td>
<td>Data type</td>
<td>8bit INT {{!}} 8bit UINT {{!}} 16bit INT, high byte first {{!}} 16bit INT, low byte first {{!}} 16bit UINT, high byte first {{!}} 16bit UINT, low byte first {{!}} 32bit float (various Byte order) {{!}} 32bit INT (various Byte order) {{!}} 32bit UINT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool; default: <b>16bit INT, high byte first</b></td>
<td>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 {{!}} PDU; default: <b>16bit INT, high byte first</b></td>
<td>Defines how read data will be stored.</td>
<td>Defines how read data will be stored.</td>
</tr>
</tr>
<b>Additional note:</b> 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:
<b>Additional note:</b> 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:
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_on_off_slider.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_modbus_modbus_tcp_client_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:
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. <b>Note:</b> to use test buttons, you need to enable [[#Modbus_TCP_Client|Client section]]. A successful response to a test may look something like this:
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_testing.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_testing.png|border|class=tlt-border]]
The figure below is an example of the Alarms Configuration list. To create a new Alarm, click the 'Add' button.
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_client_alarms_configuration_add_button_v2.png|border|class=tlt-border]]
After adding the Alarm you should be redirected to its configuration page which should look similar to this:
After adding the Alarm you should be redirected to its configuration page which should look similar to this:
<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. The Modbus TCP Client (this {{{name}}} device) perform this request as often as specified in the 'Period' field in [[#Slave_Device_Configuration|Server Device Configuration]].</td>
<td>Modbus function used for this alarm's Modbus request. The Modbus TCP Client (this {{{name}}} device) perform this request as often as specified in the 'Period' field in [[#Server_Device_Configuration|Server Device Configuration]].</td>
</tr>
</tr>
<tr>
<tr>
<tr>
<tr>
<td>Action</td>
<td>Action</td>
<td>{{#ifeq:{{{mobile}}}|1|<span style="color: #0054a6;">SMS</span> {{!}}|}} <span style="color: purple;">MODBUS Write Request</span>{{#switch:{{{series}}}|TCR1=|TRB2=|#default= {{!}} Trigger output}} | <span style="color: red;">MQTT message</span>; default: <b>MODBUS Write Request</b></td>
<td>Ubus event {{!}} {{#ifeq:{{{mobile}}}|1|<span style="color: #0054a6;">SMS</span> {{!}}|}} <span style="color: purple;">MODBUS Write Request</span>{{#switch:{{{series}}}|TCR1|TRB2|TRB2M=|#default= {{!}} Trigger output}} | <span style="color: red;">MQTT message</span>; default: <b>MODBUS Write Request</b></td>
<td>Action that will be taken if the condition is met. Possible actions:
<td>Action that will be taken if the condition is met. Possible actions:
<ul>{{#ifeq: {{{mobile}}} | 1 |
<ul>{{#ifeq: {{{mobile}}} | 1 |
<li><b>SMS</b> - sends and SMS message to a specified recipient(s).</li>|}}
<li><b>SMS</b> - sends and SMS message to a specified recipient(s).</li>|}}
<li><b>Modbus Request</b> - sends a Modbus Write request to a specified server.</li>
<li><b>Modbus Request</b> - sends a Modbus Write request to a specified server.</li>
{{#switch:{{{series}}}|TCR1=|TRB2=|#default=<li><b>Trigger output</b> - changes state of selected I/O output pin.</li>}}
{{#switch:{{{series}}}|TCR1|TRB2|TRB2M=|#default=<li><b>Trigger output</b> - changes state of selected I/O output pin.</li>}}
</ul>
</ul>
</td>
</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Register/Coil values to be written (multiple values must be separated by space character).</td>
<td>Register/Coil values to be written (multiple values must be separated by space character).</td>
</tr>{{#switch:{{{series}}}|TCR1=|TRB2=|#default=
</tr>{{#switch:{{{series}}}|TCR1|TRB2|TRB2M=|#default=
<tr>
<tr>
<td><span style="color: green;">Trigger output: Output</span></td>{{#switch:{{{series}}}
<td><span style="color: green;">Trigger output: Output</span></td>{{#switch:{{{series}}}
<td>At most once (0) | At least once (1) | Exactly once (2); default: <b>At most once (0)</b></td>
<td>At most once (0) | At least once (1) | Exactly once (2); default: <b>At most once (0)</b></td>
<td>A period of time (in seconds) which has to pass after a trigger event before this Action is executed.</td>
<td>A period of time (in seconds) which has to pass after a trigger event before this Action is executed.</td>
</tr>
<tr>
<td><span style="color: red;">MQTT message: Use root CA</span></td>
<td>off | on; default: <b>off</b></td>
<td>Use root CA for verifying the servers certificates </td>
</tr>
<tr>
<td><span style="color: red;">MQTT message: Use TLS</span></td>
<td>off | on; default: <b>off</b></td>
<td>Turns the use of TLS/SSL for this MQTT connection on or off.</td>
</tr><tr>
<td><span style="color: red;">MQTT message: Use credentials</span></td>
<td>off | on; default: <b>off</b></td>
<td>Turns the use of username and password for this MQTT connection on or off.</td>
</tr>
</tr>
</table>
</table>
The <b>Modbus Serial Client</b> page is used to configure the device as a Modbus RTU Client. Modbus RTU (remote terminal unit) is a serial communication protocol mainly used in communication via serial interfaces.
The <b>Modbus Serial Client</b> page is used to configure the device as a Modbus RTU Client. Modbus RTU (remote terminal unit) is a serial communication protocol mainly used in communication via serial interfaces.
<!--<u><b>Note:</b> Modbus Serial Client is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>-->
[[File:Networking_rutos_manual_modbus_modbus_serial_client_v2.png|border|class=tlt-border]]
<!--<u><b>Note:</b> Modbus Serial Client is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>-->
Notice the Global section config. It is used to outright turn the service off or on if any active configurations are present.
[[File:File:Networking rutos manual modbus modbus serial client global button v1.png|border|class=tlt-border]]
Clicking the Cog icon opens a modal window. The global configuration slider can be set and it's state saved.
[[File:Networking rutos manual modbus modbus tcp client modbus tcp server devices global config modal v1.png|border|class=tlt-border]]
===Modbus Serial Device Configuration===
===Modbus Serial Device Configuration===
This section is used to configure the Modbus Serial Client's server device interface settings.
This section is used to configure the Modbus Serial Client's server device interface settings.
[[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]]
[[File:Networking_rutos_manual_modbus_modbus_serial_client_device_configuration_rs_device_modbus_client_configuration_v1_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<td>Data bits</td>
<td>Data bits</td>
<td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
<td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#switch:{{{series}}}|TRB2|TRB2M=|#default=5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
<td>Number of data bits for each character.</td>
<td>Number of data bits for each character.</td>
</tr>
</tr>
This section is used to create server instances that the Client (this {{{name}}} device) will be querying with requests.
This section is used to create server instances that the Client (this {{{name}}} device) will be querying with requests.
[[File:Networking_rutos_manual_modbus_modbus_serial_master_modbus_slave_device_configuration_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_modbus_modbus_serial_client_modbus_server_device_configuration.png|border|class=tlt-border]]
By default there are no instances created. To add a new server configuration, enter an instance name, select a serial device instance and click the 'Add' button.
By default there are no instances created. To add a new server 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_client_modbus_server_device_configuration_add_button.png|border|class=tlt-border]]
After clicking 'Add' you will be redirected to the newly added server's configuration page.
After clicking 'Add' you will be redirected to the newly added server's configuration page.
The <b>Server Device Configuration</b> section is used to configure the parameters of Modbus RTU servers that the Client (this {{{name}}} device) will be querying with requests. The figure below is an example of the Server Device Configuration and the table below provides information on the fields contained in that section:
The <b>Server Device Configuration</b> section is used to configure the parameters of Modbus RTU servers that the Client (this {{{name}}} device) will be querying with requests. The figure below is an example of the Server Device Configuration and the table below provides information on the fields contained in that section:
[[File:Networking_rutos_manual_modbus_modbus_serial_master_slave_device_configuration_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_modbus_modbus_serial_client_server_device_configuration.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Server device</td>
<td>Serial device</td>
<td><i>server device instance</i>; default: <b>none</b></td>
<td><i>serial device instance</i>; default: <b>none</b></td>
<td>Specifies which serial device will be used on this server.</td>
<td>Specifies which serial device will be used on this server.</td>
</tr>
</tr>
<tr>
<tr>
<td>Server ID</td>
<td>Server ID</td>
<td>integer [0..255]; default: <b>none</b></td>
<td>integer [0..255]; default: <b>1</b></td>
<td>Server ID. Each server in a network is assigned a unique identifier ranging from 1 to 255. When the client requests data from a server, the first byte it sends is the Server ID. When set to 0, the server will respond to requests addressed to any ID.</td>
<td>Server ID. Each server in a network is assigned a unique identifier ranging from 1 to 255. When the client requests data from a server, the first byte it sends is the Server ID. When set to 0, the server will respond to requests addressed to any ID.</td>
</tr>
</tr>
<tr>
<tr>
<td>Number of timeouts</td>
<td>Number of timeouts</td>
<td>integer [0..10]; default: <b>1</b></td>
<td>integer [0..10]; default: <b>0</b></td>
<td>Skip pending request and reset connection after number of request failures.</td>
<td>Skip pending request and reset connection after number of request failures.</td>
</tr>
</tr>
<td>Period {{!}} Schedule; default: <b>Period</b></td>
<td>Period {{!}} Schedule; default: <b>Period</b></td>
<td></td>
<td></td>
</tr>
</tr>
<tr>
<tr>
The Request Configuration list is empty by default. To add a new Request Configuration loon to the Add New Instance section. Enter a custom name into the 'Name' field and click the 'Add' button:
The Request Configuration list is empty by default. To add a new Request Configuration loon to the Add New Instance section. Enter a custom name into the 'Name' field and click the 'Add' button:
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_add_new_instance.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_modbus_modbus_tcp_client_requests_configuration_add_new_instance.png|border|class=tlt-border]]
The new Request Configuration should become visible in the list:
The new Request Configuration should become visible in the list:
<tr>
<tr>
<td>Data type</td>
<td>Data type</td>
<td>8bit INT {{!}} 8bit UINT {{!}} 16bit INT, high byte first {{!}} 16bit INT, low byte first {{!}} 16bit UINT, high byte first {{!}} 16bit UINT, low byte first {{!}} 32bit float (various Byte order) {{!}} 32bit INT (various Byte order) {{!}} 32bit UINT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool; default: <b>16bit INT, high byte first</b></td>
<td>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 {{!}} PDU; default: <b>16bit INT, high byte first</b></td>
<td>Defines how read data will be stored.</td>
<td>Defines how read data will be stored.</td>
</tr>
</tr>
<b>Additional note:</b> 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:
<b>Additional note:</b> 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:
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_on_off_slider.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_modbus_modbus_tcp_client_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:
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. <b>Note:</b> to use test buttons, you need to enable [[#Modbus_Serial_Client|Client section]]. A successful response to a test may look something like this:
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_testing.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_testing.png|border|class=tlt-border]]
The figure below is an example of the Modbus Client Alarms list. To create a new Alarm, click the 'Add' button.
The figure below is an example of the Modbus Client Alarms list. To create a new Alarm, click the 'Add' button.
[[File:Networking_rutos_manual_modbus_modbus_serial_master_modbus_master_alarms_add_button.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_modbus_modbus_tcp_client_alarms_configuration_add_button.png|border|class=tlt-border]]
After this you should be redirected to that Alarm's configuration page which should look similar to this:
After this you should be redirected to that Alarm's configuration page which should look similar to this:
<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. The Modbus TCP Client (this {{{name}}} device) perform this request as often as specified in the 'Period' field in [[#Slave_Device_Configuration|Server Device Configuration]].</td>
<td>Modbus function used for this alarm's Modbus request. The Modbus TCP Client (this {{{name}}} device) perform this request as often as specified in the 'Period' field in [[#Server_Device_Configuration|Server Device Configuration]].</td>
</tr>
</tr>
<tr>
<tr>
<tr>
<tr>
<td>Action</td>
<td>Action</td>
<td>{{#ifeq:{{{mobile}}}|1|SMS {{!}}|}} MODBUS Write Request{{#switch:{{{series}}}|TCR1=|TRB2=|#default= {{!}} Trigger output}}; default: <b>MODBUS Write Request</b></td>
<td>{{#ifeq:{{{mobile}}}|1|SMS {{!}}|}} MODBUS Write Request{{#switch:{{{series}}}|TCR1|TRB2|TRB2M=|#default= {{!}} Trigger output}}; default: <b>MODBUS Write Request</b></td>
<td>Action that will be taken if the condition is met. Possible actions:
<td>Action that will be taken if the condition is met. Possible actions:
<ul>{{#ifeq: {{{mobile}}} | 1 |
<ul>{{#ifeq: {{{mobile}}} | 1 |
<li><b>SMS</b> - sends and SMS message to a specified recipient(s).</li>|}}
<li><b>SMS</b> - sends and SMS message to a specified recipient(s).</li>|}}
<li><b>Modbus Request</b> - sends a Modbus Write request to a specified server.</li>
<li><b>Modbus Request</b> - sends a Modbus Write request to a specified server.</li>
{{#switch:{{{series}}}|TCR1=|TRB2=|#default=<li><b>Trigger output</b> - changes state of selected I/O output pin.</li>}}
{{#switch:{{{series}}}|TCR1|TRB2|TRB2M|#default=<li><b>Trigger output</b> - changes state of selected I/O output pin.</li>}}
</ul>
</ul>
</td>
</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Register/Coil values to be written (multiple values must be separated by space character).</td>
<td>Register/Coil values to be written (multiple values must be separated by space character).</td>
</tr>{{#switch:{{{series}}}|TCR1=|TRB2=|#default=
</tr>{{#switch:{{{series}}}|TCR1|TRB2|TRB2M=|#default=
<tr>
<tr>
<td><span style="color: green;">Trigger output: Output</span></td>{{#switch:{{{series}}}
<td><span style="color: green;">Trigger output: Output</span></td>{{#switch:{{{series}}}
<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. The Modbus TCP Client (this {{{name}}} device) perform this request as often as specified in the 'Period' field in [[#Slave_Device_Configuration|Server Device Configuration]].</td>
<td>Modbus function used for this alarm's Modbus request. The Modbus TCP Client (this {{{name}}} device) perform this request as often as specified in the 'Period' field in [[#Server_Device_Configuration|Server Device Configuration]].</td>
</tr>
</tr>
<tr>
<tr>
|}}
|}}
==MQTT Gateway==
==MQTT Modbus Gateway==
The <b>MQTT Gateway</b> function is used to transfer Modbus data (send requests, receive responses) over MQTT. When it is enabled, the device (this {{{name}}}) subscribes to a REQUEST topic and publishes on a RESPONSE topic on a specified MQTT broker. It translates received MQTT message payload to a Modbus request and relays it to the specified Modbus TCP server.
The <b>MQTT Modbus Gateway</b> function is used to transfer Modbus data (send requests, receive responses) over MQTT. When it is enabled, the device (this {{{name}}}) subscribes to a REQUEST topic and publishes on a RESPONSE topic on a specified MQTT broker. It translates received MQTT message payload to a Modbus request and relays it to the specified Modbus TCP server.
When the MQTT Gateway receives a response from the server, it translates it to an MQTT message and publishes it on the RESPONSE topic.
When the MQTT Gateway receives a response from the server, it translates it to an MQTT message and publishes it on the RESPONSE topic.
<tr>
<tr>
<td>Data bits</td>
<td>Data bits</td>
<td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
<td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#switch:{{{series}}}|TRB2|TRB2M=|#default=5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
<td>Number of data bits for each character.</td>
<td>Number of data bits for each character.</td>
</tr>
</tr>
After this you should be redirected to instance's configuration page which should look similar to this:
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]]
[[File:Networking_rutos_manual_modbus_modbus_tcp_over_serial_gateway_configuration_rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<td>Data bits</td>
<td>Data bits</td>
<td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
<td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2|TRB2M=|#default=5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
<td>Number of data bits for each character.</td>
<td>Number of data bits for each character.</td>
</tr>
</tr>
Then enter the IP address and save.
Then enter the IP address and save.
[[File:Networking_rutos_manual_console_ip_filter_instance.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_console_ip_filter_instance_v2.png|border|class=tlt-border]]
|}}
|}}
==See also==
==See also==
<ul>
<ul>
<li><b>[[{{{name}}} Monitoring via Modbus|Monitoring via Modbus]]</b> - detailed examples on how to use Modbus TCP</li>
<li><b>[[Monitoring via Modbus|Monitoring via Modbus]]</b> - detailed examples on how to use Modbus TCP</li>
</ul>
</ul>
[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]
