Changes

Template:Networking rutos manual modbus (view source)

Revision as of 14:10, 22 January 2024

435 bytes added , 22 January

no edit summary

Line 1: Line 1: −

{{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}}}

| name = {{{name}}}

}}

−

{{#ifeq: {{{series}}} | RUT9 | Note: [[{{{name}}} Modbus (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: ~~Networking_rutos_manual_latest_fw~~ | series = RUT9XX}} and earlier) user manual page.|}}

+

{{#ifeq: {{{series}}} | RUT9 | Note: [[{{{name}}} Modbus (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.|}}

−

{{#ifeq: {{{series}}} | RUT2 | Note: [[{{{name}}} Modbus (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: ~~Networking_rutos_manual_latest_fw~~ | series = RUT2XX}} and earlier) user manual page.|}}

+

{{#ifeq: {{{series}}} | RUT2 | Note: [[{{{name}}} Modbus (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.|}}

==Summary==

Line 16: Line 18:

| RUTM =

| TRB1 =

−

| TRB2 =

+

| TRB2 =

+

| TRB2M =

| RUT9|RUT9M =

| #default =

−

Note: On {{{name}}}, Modbus TCP Server/Client and MQTT Gateway is additional software that can be installed from the ~~Services~~ → [[{{{name}}} Package Manager|Package Manager]] page. }}

+

Note: On {{{name}}}, Modbus TCP Server/Client and MQTT Gateway is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page. }}

{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer

| series = {{{series}}}

Line 144: Line 147:

<tr>

−

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

+

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

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

</tr>

Line 225: Line 228:

A Modbus Client device can request data from Modbus servers. The Modbus TCP Client section is used to configure Modbus TCP servers and enable Client. 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~~.png|border|class=tlt-border]]

+

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

Line 265: Line 268:

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

<td>Server device's Modbus TCP port.</td>

−

~~</tr>~~

−

~~<tr>~~

−

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

−

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

−

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

</tr>

<tr>

Line 330: Line 328:

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

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

</tr>

Line 380: Line 378:

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

Line 439: Line 437:

<tr>

<td>Action</td>

−

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

+

<td>Ubus event {{!}} {{#ifeq:{{{mobile}}}|1|SMS {{!}}|}} MODBUS Write Request{{#switch:{{{series}}}|TCR1|TRB2|TRB2M=|#default= {{!}} Trigger output}} | MQTT message; 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 server.</li>

−

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

+

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

</ul>

</td>

Line 497: Line 495:

<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>{{#switch:{{{series}}}|TCR1|TRB2|TRB2M=|#default=

<tr>

<td>Trigger output: Output</td>{{#switch:{{{series}}}

Line 545: Line 543:

<td>At most once (0) | At least once (1) | Exactly once (2); default: At most once (0)</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>MQTT message: Use root CA</td>

+

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

+

<td>Use root CA for verifying the servers certificates </td>

+

</tr>

+

<tr>

+

<td>MQTT message: Use TLS</td>

+

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

+

<td>Turns the use of TLS/SSL for this MQTT connection on or off.</td>

+

</tr><tr>

+

<td>MQTT message: Use credentials</td>

+

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

+

<td>Turns the use of username and password for this MQTT connection on or off.</td>

</tr>

</table>

Line 552: Line 564:

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

−

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

+

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

−

+

===Modbus Serial Device Configuration===

Line 601: Line 613:

<tr>

−

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

+

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

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

</tr>

Line 642: Line 654:

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.

−

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

Line 654: Line 666:

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

Line 673: Line 685:

</tr>

<tr>

−

<td>~~Server~~ device</td>

+

<td>Serial device</td>

−

<td>~~server~~ device instance; default: none</td>

+

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

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

</tr>

<tr>

<td>Server ID</td>

−

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

+

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

−

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

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

</tr>

Line 696: Line 703:

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

Line 722: Line 724:

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:

Line 741: Line 743:

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

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

</tr>

Line 779: Line 781:

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:

−

[[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. Note: 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]]

Line 791: Line 793:

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:

Line 850: Line 852:

<tr>

<td>Action</td>

−

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

+

<td>{{#ifeq:{{{mobile}}}|1|SMS {{!}}|}} MODBUS Write Request{{#switch:{{{series}}}|TCR1|TRB2|TRB2M=|#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 server.</li>

−

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

+

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

</ul>

</td>

Line 898: Line 900:

<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>{{#switch:{{{series}}}|TCR1|TRB2|TRB2M=|#default=

<tr>

<td>Trigger output: Output</td>{{#switch:{{{series}}}

Line 1,202: Line 1,204:

|}}

−

==MQTT Gateway==

+

==MQTT Modbus 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 server.

+

The MQTT Modbus 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 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.

Line 1,357: Line 1,359:

<tr>

−

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

+

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

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

</tr>

Line 1,509: Line 1,511:

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

Line 1,539: Line 1,541:

<tr>

−

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

+

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

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

</tr>

Line 1,619: Line 1,621:

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

<ul>

−

<li>[[~~{{{name}}}~~ Monitoring via Modbus|Monitoring via Modbus]] - detailed examples on how to use Modbus TCP</li>

+

<li>[[Monitoring via Modbus|Monitoring via Modbus]] - detailed examples on how to use Modbus TCP</li>

</ul>

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

Vainius.l

Administrators

7,851

edits

Namespaces

Variants

Views

More

Search

Changes

Template:Networking rutos manual modbus (view source)

Revision as of 14:10, 22 January 2024

Navigation menu

Personal tools

NAVIGATION

Tools

Categories