Template:Networking rutos manual modbus: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
No edit summary
No edit summary
Line 1: Line 1:
{{Template:Networking_rutos_manual_fw_disclosure
{{Template:Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.04.1
| fw_version = {{{series}}}_R_00.02.05
| series    = {{{series}}}
| series    = {{{series}}}
}}
}}
Line 20: Line 20:
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]]
[[File:Networking_rutos_manual_modbus_modbus_tcp_slave.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 30: Line 30:
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enable</td>
       <td>yes | no; default: <b>none</b></td>
       <td>off | on; default: <b>none</b></td>
       <td>Turns Modbus TCP on or off.</td>
       <td>Turns Modbus TCP on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Port</td>
       <td>Port</td>
       <td>integer [0..65535]; default: '''502'''</td>
       <td>integer [0..65535]; default: <b>502</b></td>
       <td>TCP port used for Modbus communications.</td>
       <td>TCP port used for Modbus communications.</td>
     </tr>
     </tr>
Line 45: Line 45:
     <tr>
     <tr>
     <td>Allow Remote Access</td>
     <td>Allow Remote Access</td>
         <td>yes | no; default: <b>no</b></td>
         <td>off | on; default: <b>off</b></td>
         <td>Allows remote Modbus connections by adding an exception to the device's firewall on the port specified in the field above.</td>
         <td>Allows remote Modbus connections by adding an exception to the device's firewall on the port specified in the field above.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Keep persistent connection</td>
     <td>Keep persistent connection</td>
         <td>yes | no; default: <b>no</b></td>
         <td>off | on; default: <b>off</b></td>
         <td>Allows keep the connection open after responding a Modbus TCP master request.</td>
         <td>Allows keep the connection open after responding a Modbus TCP master request.</td>
     </tr>
     </tr>
Line 60: Line 60:
     <tr>
     <tr>
     <td>Enable custom register block</td>
     <td>Enable custom register block</td>
         <td>yes | no; default: <b>no</b></td>
         <td>off | on; default: <b>off</b></td>
         <td>Allow custom register block.</td>
         <td>Allows the usage of custom register block.</td>
     </tr>
     </tr>
</table>
</table>
Line 81: Line 81:
==Modbus TCP Master==
==Modbus TCP Master==


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


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


To add a new slave, simply click the 'Add' button.
After clicking 'Add' you will be redirected to the newly added slave's configuration page.


You can create a maximum of 10 slave configurations.
You can create a maximum of 10 slave configurations.
Line 388: Line 388:
     <tr>
     <tr>
         <th>Enabled</th>
         <th>Enabled</th>
         <th>off | on; Default: <b>off</b></th>
         <th>off | on; default: <b>off</b></th>
         <th>Turns the data sender ON or OFF</th>
         <th>Turns the data sender ON or OFF</th>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Name</td>
         <td>Name</td>
         <td>string; Default: <b>none</b></td>
         <td>string; default: <b>none</b></td>
         <td>Data sender's name. used for easier management purposes</td>
         <td>Data sender's name. used for easier management purposes</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Protocol</td>
         <td>Protocol</td>
         <td>HTTP; Default: <b>HTTP</b></td>
         <td>HTTP; default: <b>HTTP</b></td>
         <td>Data sending protocol</td>
         <td>Data sending protocol</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>JSON format</td>
         <td>JSON format</td>
         <td>json string; Default: <b>{"ID":"%i", "TS":"%t","ST":"%s","VR":"%a"}</b></td>
         <td>json string; default: <b>{"ID":"%i", "TS":"%t","ST":"%s","VR":"%a"}</b></td>
         <td>Provides the possibility to fully customize the JSON segment</td>
         <td>Provides the possibility to fully customize the JSON segment</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Segment count</td>
         <td>Segment count</td>
         <td>1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10; Default: <b>1</b></td>
         <td>1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10; default: <b>1</b></td>
         <td>Max segment count in one JSON string sent to server</td>
         <td>Max segment count in one JSON string sent to server</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>URL</td>
         <td>URL</td>
         <td>host | ip; Default: <b>none</b></td>
         <td>host | ip; default: <b>none</b></td>
         <td>Address of the server to which the data will be sent.</td>
         <td>Address of the server to which the data will be sent.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Period</td>
         <td>Period</td>
         <td>integer [1..6400]; Default: <b>60</b></td>
         <td>integer [1..6400]; default: <b>60</b></td>
         <td>Data sending frequency (in seconds)</td>
         <td>Data sending frequency (in seconds)</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Data filtering</td>
         <td>Data filtering</td>
         <td>All data | By slave ID | By slave IP; Default: <b>All data</b></td>
         <td>All data | By slave ID | By slave IP; default: <b>All data</b></td>
         <td>Which data this sender will transfer to the server</td>
         <td>Which data this sender will transfer to the server</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Retry on fail</td>
         <td>Retry on fail</td>
         <td>off | on; Default: <b>no</b></td>
         <td>off | on; default: <b>off</b></td>
         <td>Specifies whether the data sender should retry failed attempts (Retry until successful)</td>
         <td>Specifies whether the data sender should retry failed attempts (Retry until successful)</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Custom header</td>
         <td>Custom header</td>
         <td>string; Default: <b>no</b></td>
         <td>string; default: <b>off</b></td>
         <td>Adds a custom header(s) to HTTP requests</td>
         <td>Adds a custom header(s) to HTTP requests</td>
     </tr>
     </tr>
</table>
</table>
-->
-->

Revision as of 11:07, 25 August 2020

Template:Networking rutos manual fw disclosure

Summary

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

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

If you're having trouble finding this page or some of the parameters described here on your device's WebUI, you should turn on "Advanced WebUI" mode. You can do that by clicking the "Advanced" button, located at the top of the WebUI.

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.

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:

Field Value Description
Enable off | on; default: none Turns Modbus TCP on or off.
Port integer [0..65535]; default: 502 TCP port used for Modbus communications.
Device ID integer [0..255]; default: 1 The device's Modbus slave ID. When set to 0, it will respond to requests addressed to any ID.
Allow Remote Access off | on; default: off Allows remote Modbus connections by adding an exception to the device's firewall on the port specified in the field above.
Keep persistent connection off | on; default: off Allows keep the connection open after responding a Modbus TCP master request.
Connection timeout integer; default: 0 Sets TCP timeout in seconds after which the connection is forcefully closed.
Enable custom register block off | on; default: off Allows the usage of custom register block.

Get Parameters

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

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

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

Set Parameters

The Modbus daemon can also set some device parameters.

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

Modbus TCP Master

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

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

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 configuration v1.png

Field Value Description
Enabled off | on; default: off Turns communication with the slave device on or off.
Name string; default: none Slave device's name, used for easier management purposes.
Slave ID integer [0..255]; default: none Slave ID. Each slave in a network is assigned a unique identifier ranging from 1 to 255. When the master requests data from a slave, the first byte it sends is the Slave ID. When set to 0, the slave will respond to requests addressed to any ID.
IP address ip; default: none Slave device's IP address.
Port integer [0..65535]; default: none Slave device's Modbus TCP port.
Period integer [1..86400]; default: 60 Interval at which requests are sent to the slave device.
Timeout integer [1..30]; default: 5 Maximum response wait time.

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.

The figure below is an example of the Requests configuration section and the table below provides information contained in the fields of that section:

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

After having configured a request, you should see a new 'Testing' section appear. It is used to check whether the configuration works correctly. Simply press the 'Test' button and a response should appear in the box below.

File:Networking rutos manual modbus modbus tcp master requests configuration testing v1.png

Alarms Configuration

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

It is empty by default. So, to begin editing click the 'Add' button and you should be redirected to a page such as this:

File:Networking rutos manual modbus modbus tcp master alarms configuration alarm configuration v1.png

Field Value Description
Enabled off | on; default: off Turns the alarm on or off.
Function code Read Coil Status (1) | Read Input Status (2) | Read Holding Registers (3) | Read Input Registers (4); default: Read Coil Status (1) Modbus function used for this alarm's Modbus request.
Register integer [1..65536]; default: none Number of the Modbus coil/input/holding-register/input-register to read from.
Condition More than | Less than | Equal to | Not Equal to; default: Equal to 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.
Value various; default: none The value against which the read data will be compared.
Value integer [0..65535]; default: none The value against which the read data will be compared.
Action frequency Every trigger | First trigger; default: Every trigger Describes how frequently the specified action will be taken.
Redundancy protection off | on; default: off Protection against executing a configured action too often.
Redundancy protection period integer [1..86400]; default: none Duration to activate redundancy protection for, measured in seconds. This field becomes visible only when 'Redundancy protection' is turned on.
Action SMS | MODBUS Write Request; default: MODBUS Write Request Action that will be taken if the condition is met. Possible actions:
  • SMS - sends and SMS message to a specified recipient(s).
  • Modbus Request - sends a Modbus Write request to a specified slave.
SMS: Message string; default: none SMS message text.
SMS: Phone number phone number; default: none Recipient's phone number.
MODBUS Write Request: IP address ip | host; default: none Modbus slave's IP address.
MODBUS Write Request: Port integer [0..65535]; default: none Modbus slave's port.
MODBUS Write Request: Timeout integer [1..30]; default: 5 Maximum time to wait for a response.
MODBUS Write Request: ID integer [1..255]; default: none Modbus slave ID.
MODBUS Write Request: Modbus function Read Force Single Coil (5) | Preset Single Register (6) | Force Multiple Coils (15) | Force Multiple Registers (16); default: Force Single Coil (5) A function code specifies the type of register being addressed by a Modbus request.
MODBUS Write Request: First register integer [0..65535]; default: none Begins reading from the register specified in this field.
MODBUS Write Request: Values integer [0..65535]; default: none Register/Coil values to be written (multiple values must be separated by space character).

MQTT Gateway

The MQTT Gateway function is used to transfer Modbus data over MQTT. Refer to the table for information on MQTT gateway configuration fields.

Field Value Description
Enable off | on; default: off Turns MQTT gateway on or off.
Host ip | host; default: 127.0.0.1 IP address or hostname of an MQTT broker.
Port integer [0..65535]; default: 1883 Port number of the MQTT broker.
Request topic alphanumeric string; default: request .
Response topic alphanumeric string; default: response .
Username string; default: none Username for authentication to the MQTT broker.
Password string; default: none Password for authentication to the MQTT broker.

See also

Template:Networking device modbus see also

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

Retrieved from "https://wiki.teltonika-networks.com/index.php?title=Template:Networking_rutos_manual_modbus&oldid=69903"