Template:Networking rutos manual modbus: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
No edit summary
Line 183: Line 183:
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Enabled</td>
         <td>No Brackets</td>
         <td>off | on; default: <b>off</b></td>
         <td>off | on; default: <b>off</b></td>
         <td>Turns the request on or off.</td>
         <td>Removes the starting and ending brackets from the request (only for read requests).</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 192: Line 192:
         <td>Deletes the request.</td>
         <td>Deletes the request.</td>
     </tr>
     </tr>
 
    <tr>
        <td>off/on slider</td>
        <td>off | on; default: <b>off</b></td>
        <td>Turns the request on or off.</td>
    </tr>
</table>
</table>


Line 346: Line 350:
     <tr>
     <tr>
         <td>Baud rate</td>
         <td>Baud rate</td>
         <td>300 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400 | 57600 | 115200; default: <b>115200</b></td>
         <td>300 <nowiki>|</nowiki> 1200 <nowiki>|</nowiki> 2400 <nowiki>|</nowiki> 4800 <nowiki>|</nowiki> 9600 <nowiki>|</nowiki> 19200 <nowiki>|</nowiki> 38400 <nowiki>|</nowiki> 57600 <nowiki>|</nowiki> 115200; default: <b>115200</b></td>
         <td>Serial data transmission rate (in bits per second).</td>
         <td>Serial data transmission rate (in bits per second).</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Data bits</td>
         <td>Data bits</td>
         <td>5 | 6 | 7 | 8; default: <b>8</b></td>
         <td>5 <nowiki>|</nowiki> 6 <nowiki>|</nowiki> 7 <nowiki>|</nowiki> 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>
     <tr>
     <tr>
         <td>Parity</td>
         <td>Parity</td>
         <td>None | Even | Odd; default: <b>None</b></td>
         <td>None <nowiki>|</nowiki> Even <nowiki>|</nowiki> 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.
         <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>
             <ul>
Line 367: Line 371:
     <tr>
     <tr>
         <td>Stop bits</td>
         <td>Stop bits</td>
         <td>1 | 2; default: <b>1</b></td>
         <td>1 <nowiki>|</nowiki> 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>
         <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>
     <tr>
     <tr>
         <td>Flow control</td>
         <td>Flow control</td>
         <td>None | RTS/CTS | Xon/Xoff; default: <b>None</b></td>
         <td>None <nowiki>|</nowiki> RTS/CTS <nowiki>|</nowiki> 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.
         <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>
             <ul>
Line 388: Line 392:
The list is empty by default. In order to create a new slave device configuration, click the 'Add' button.
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]]
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs232_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
Then click the 'Edit' button next to the newly added slave device in order to begin configuration.
 
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs232_slave_devices_list_edit_button.png|border|class=tlt-border]]
 
=====RS232 Slave Device Configuration=====
----
The <b>RS232 Slave Device Configuration</b> 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:
 
[[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: <b>off</b></td>
        <td>Turns communication with the slave device on or off.</td>
    </tr>
    <tr>
        <td>Name</td>
        <td>string; default: <b>none</b></td>
        <td>Slave device's name, used for easier management purposes.</td>
    </tr>
    <tr>
        <td>Slave ID</td>
        <td>integer [0..255]; default: <b>none</b></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>Period</td>
        <td>integer [1..86400]; default: <b>60</b></td>
        <td>Interval at which requests are sent to the slave device.</td>
    </tr>
    <tr>
        <td>Timeout</td>
        <td>integer [1..30]; default: <b>5</b></td>
        <td>Maximum response wait time.</td>
    </tr>
</table>
====Requests Configuration====
----
A Modbus <b>request</b> 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.


[[File:Networking_rutos_manual_modbus_modbus_serial_master_slave_devices_list_edit_button.png|border|class=tlt-border]]
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]]
==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 new Request Configuration should become visible in the list:


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


<table class="nd-mantable">
<table class="nd-mantable">
Line 408: Line 455:
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Enable</td>
         <td>Name</td>
         <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
         <td>string; default: <b>Unnamed</b></td>
         <td>Turns MQTT gateway on or off.</td>
        <td>Name of this Request Configuration. Used for easier management purposes.</td>
    </tr>
    <tr>
        <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, 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: <b>16bit INT, high byte first</b></td>
         <td>Defines how read data will be stored.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Host</td>
         <td>Function</td>
         <td>ip <nowiki>|</nowiki> host; default: <b>127.0.0.1</b></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: <b>Read holding registers (3)</b></td>
         <td>IP address or hostname of an MQTT broker.</td>
         <td>Specifies the type of register being addressed by a Modbus request.  
        </td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Port</td>
         <td>First Register</td>
         <td>integer [0..65535]; default: <b>1883</b></td>
         <td>integer [0..65535]; default: <b>1</b></td>
         <td>Port number of the MQTT broker.</td>
         <td>First Modbus register from which data will be read.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Request topic</td>
         <td>Register Count / Values</td>
         <td>alphanumeric string; default: <b>request</b></td>
         <td>integer [1..2000]; default: <b>1</b></td>
         <td>.</td>
         <td>Number of Modbus registers that will be read during the request.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Response topic</td>
         <td>No Brackets</td>
         <td>alphanumeric string; default: <b>response</b></td>
         <td>off | on; default: <b>off</b></td>
         <td>.</td>
         <td>Removes the starting and ending brackets from the request (only for read requests).</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Username</td>
         <td>Delete [ X ]</td>
         <td>string; default: <b>none</b></td>
         <td>- (interactive button)</td>
         <td>Username for authentication to the MQTT broker.</td>
         <td>Deletes the request.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Password</td>
         <td>off/on slider</td>
         <td>string; default: <b>none</b></td>
         <td>off | on; default: <b>off</b></td>
         <td>Password for authentication to the MQTT broker.</td>
         <td>Turns the request on or off.</td>
     </tr>
     </tr>
</table>
</table>


==See also==
<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:


{{Template: Networking_device_modbus_see_also}}
[[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:


[[Category:{{{name}}} Services section]]
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_testing.png|border|class=tlt-border]]
<!--


====Alarms Configuration====
----
<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]]


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


==Modbus Data to Server==
<table class="nd-mantable">
    <tr>
        <th>Field</th>
        <th>Value</th>
        <th>Description</th>
    </tr>
    <tr>
        <td>Enabled</td>
        <td>off | on; default: <b>off</b></td>
        <td>Turns the alarm on or off.</td>
    </tr>
    <tr>
        <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>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>
    </tr>
    <tr>
        <td>Register</td>
        <td>integer [1..65536]; default: <b>none</b></td>
        <td>Number of the Modbus coil/input/holding-register/input-register to read from.</td>
    </tr>
    <tr>
        <td>Condition</td>
        <td>More than | Less than | Equal to | Not Equal to; default: <b>Equal to</b></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: <b>none</b></td>
        <td>The value against which the read data will be compared.</td>
    </tr>
    <tr>
        <td>Value</td>
        <td>integer [0..65535]; default: <b>none</b></td>
        <td>The value against which the read data will be compared.</td>
    </tr>
    <tr>
        <td>Action frequency</td>
        <td>Every trigger | First trigger; default: <b>Every trigger</b></td>
        <td>Describes how frequently the specified action will be taken.</td>
    </tr>
    <tr>
        <td>Redundancy protection</td>
        <td>off | on; default: <b>off</b></td>
        <td>Protection against executing a configured action too often.</td>
    </tr>
    <tr>
        <td>Redundancy protection period</td>
        <td>integer [1..86400]; default: <b>none</b></td>
        <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>SMS | MODBUS Write Request; default: <b>MODBUS Write Request</b></td>
        <td>Action that will be taken if the condition is met. Possible actions:
            <ul>
                <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 slave.</li>
            </ul>
        </td>
    </tr>
    <tr>
        <td><span style="color: #0054a6;">SMS: Message</span></td>
        <td>string; default: <b>none</b></td>
        <td>SMS message text.</td>
    </tr>
    <tr>
        <td><span style="color: #0054a6;">SMS: Phone number</span></td>
        <td>phone number; default: <b>none</b></td>
        <td>Recipient's phone number.</td>
    </tr>
    <tr>
        <td><span style="color: purple;">MODBUS Write Request: IP address</span></td>
        <td>ip | host; default: <b>none</b></td>
        <td>Modbus slave's IP address.</td>
    </tr>
    <tr>
        <td><span style="color: purple;">MODBUS Write Request: Port</span></td>
        <td>integer [0..65535]; default: <b>none</b></td>
        <td>Modbus slave's port.</td>
    </tr>
    <tr>
        <td><span style="color: purple;">MODBUS Write Request: Timeout</span></td>
        <td>integer [1..30]; default: <b>5</b></td>
        <td>Maximum time to wait for a response.</td>
    </tr>
    <tr>
        <td><span style="color: purple;">MODBUS Write Request: ID</span></td>
        <td>integer [1..255]; default: <b>none</b></td>
        <td>Modbus slave ID.</td>
    </tr>
    <tr>
        <td><span style="color: purple;">MODBUS Write Request: Modbus function</span></td>
        <td>Read Force Single Coil (5) | Preset Single Register (6) | Force Multiple Coils (15) | Force Multiple Registers (16); default: <b>Force Single Coil (5)</b></td>
        <td>A function code specifies the type of register being addressed by a Modbus request.</td>
    </tr>
    <tr>
        <td><span style="color: purple;">MODBUS Write Request: First register</span></td>
        <td>integer [0..65535]; default: <b>none</b></td>
        <td>Begins reading from the register specified in this field.</td>
    </tr>
    <tr>
        <td><span style="color: purple;">MODBUS Write Request: Values</span></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>
    </tr>
</table>
|}}|}}{{#ifeq: {{{rs485}}} | 1 |
===RS485===
----
This section is used to configure the Modbus Serial Master's <b>RS485</b> serial interface settings. Refer to the figure and table below for information on RS485 configuration.


The Modbus <b>Data to Server</b> function provides you with the possibility to set up senders that transfer data collected from Modbus slaves to remote servers. To add a new data sender, enter the server's address, specify the data sending period and click the "Add" button:
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs485_configuration.png|border|class=tlt-border]]


[[File:Networking_rutx_manual_modbus_add_new_data_sender_v1.png]]
<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 <nowiki>|</nowiki> 1200 <nowiki>|</nowiki> 2400 <nowiki>|</nowiki> 4800 <nowiki>|</nowiki> 9600 <nowiki>|</nowiki> 19200 <nowiki>|</nowiki> 38400 <nowiki>|</nowiki> 57600 <nowiki>|</nowiki> 115200; default: <b>115200</b></td>
        <td>Serial data transmission rate (in bits per second).</td>
    </tr>
    <tr>
        <td>Data bits</td>
        <td>5 <nowiki>|</nowiki> 6 <nowiki>|</nowiki> 7 <nowiki>|</nowiki> 8; default: <b>8</b></td>
        <td>Number of data bits for each character.</td>
    </tr>
    <tr>
        <td>Parity</td>
        <td>None <nowiki>|</nowiki> Even <nowiki>|</nowiki> 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 <nowiki>|</nowiki> 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 <nowiki>|</nowiki> RTS/CTS <nowiki>|</nowiki> 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>


===Data sender configuration===
====RS485 Slave Devices List====
----
----
When you add a new data sender, you will be redirected to its configuration window. The figure below is an example of that window and the table below provides information on the fields that it contains:
The <b>RS485 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_rutx_manual_modbus_data_sender_configuration_v1.png]]
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs485_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 configuration.
 
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs485_slave_devices_list_edit_button.png|border|class=tlt-border]]
 
=====RS485 Slave Device Configuration=====
----
The <b>RS485 Slave Device Configuration</b> 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:
 
[[File:Networking_rutos_manual_modbus_modbus_serial_master_rs485_slave_device_configuration.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Enabled</th>
         <th>Field</th>
         <th>off | on; default: <b>off</b></th>
        <th>Value</th>
         <th>Turns the data sender ON or OFF</th>
         <th>Description</th>
    </tr>
    <tr>
        <td>Enabled</td>
        <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
         <td>Turns communication with the slave device on or off.</td>
     </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>Slave device's name, used for easier management purposes.</td>
    </tr>
    <tr>
        <td>Slave ID</td>
        <td>integer [0..255]; default: <b>none</b></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>Period</td>
        <td>integer [1..86400]; default: <b>60</b></td>
        <td>Interval at which requests are sent to the slave device.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Protocol</td>
         <td>Timeout</td>
         <td>HTTP; default: <b>HTTP</b></td>
         <td>integer [1..30]; default: <b>5</b></td>
         <td>Data sending protocol</td>
         <td>Maximum response wait time.</td>
    </tr>
</table>
====Requests Configuration====
----
A Modbus <b>request</b> 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 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>
        <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>JSON format</td>
         <td>Name</td>
         <td>json string; default: <b>{"ID":"%i", "TS":"%t","ST":"%s","VR":"%a"}</b></td>
         <td>string; default: <b>Unnamed</b></td>
         <td>Provides the possibility to fully customize the JSON segment</td>
         <td>Name of this Request Configuration. Used for easier management purposes.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Segment count</td>
         <td>Data type</td>
         <td>1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10; default: <b>1</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, 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: <b>16bit INT, high byte first</b></td>
         <td>Max segment count in one JSON string sent to server</td>
         <td>Defines how read data will be stored.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>URL</td>
         <td>Function</td>
         <td>host | ip; default: <b>none</b></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: <b>Read holding registers (3)</b></td>
         <td>Address of the server to which the data will be sent.</td>
         <td>Specifies the type of register being addressed by a Modbus request.  
        </td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Period</td>
         <td>First Register</td>
         <td>integer [1..6400]; default: <b>60</b></td>
         <td>integer [0..65535]; default: <b>1</b></td>
         <td>Data sending frequency (in seconds)</td>
         <td>First Modbus register from which data will be read.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Data filtering</td>
         <td>Register Count / Values</td>
         <td>All data | By slave ID | By slave IP; default: <b>All data</b></td>
         <td>integer [1..2000]; default: <b>1</b></td>
         <td>Which data this sender will transfer to the server</td>
         <td>Number of Modbus registers that will be read during the request.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Retry on fail</td>
         <td>No Brackets</td>
         <td>off | on; default: <b>off</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>Removes the starting and ending brackets from the request (only for read requests).</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Custom header</td>
         <td>Delete [ X ]</td>
         <td>string; default: <b>off</b></td>
         <td>- (interactive button)</td>
         <td>Adds a custom header(s) to HTTP requests</td>
        <td>Deletes the request.</td>
    </tr>
    <tr>
        <td>off/on slider</td>
        <td>off | on; default: <b>off</b></td>
         <td>Turns the request on or off.</td>
     </tr>
     </tr>
</table>
</table>
-->
 
<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]]
----
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:
 
[[File:Networking_rutos_manual_modbus_modbus_tcp_master_requests_configuration_testing.png|border|class=tlt-border]]
 
====Alarms Configuration====
----
<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]]
 
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">
    <tr>
        <th>Field</th>
        <th>Value</th>
        <th>Description</th>
    </tr>
    <tr>
        <td>Enabled</td>
        <td>off | on; default: <b>off</b></td>
        <td>Turns the alarm on or off.</td>
    </tr>
    <tr>
        <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>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>
    </tr>
    <tr>
        <td>Register</td>
        <td>integer [1..65536]; default: <b>none</b></td>
        <td>Number of the Modbus coil/input/holding-register/input-register to read from.</td>
    </tr>
    <tr>
        <td>Condition</td>
        <td>More than | Less than | Equal to | Not Equal to; default: <b>Equal to</b></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: <b>none</b></td>
        <td>The value against which the read data will be compared.</td>
    </tr>
    <tr>
        <td>Value</td>
        <td>integer [0..65535]; default: <b>none</b></td>
        <td>The value against which the read data will be compared.</td>
    </tr>
    <tr>
        <td>Action frequency</td>
        <td>Every trigger | First trigger; default: <b>Every trigger</b></td>
        <td>Describes how frequently the specified action will be taken.</td>
    </tr>
    <tr>
        <td>Redundancy protection</td>
        <td>off | on; default: <b>off</b></td>
        <td>Protection against executing a configured action too often.</td>
    </tr>
    <tr>
        <td>Redundancy protection period</td>
        <td>integer [1..86400]; default: <b>none</b></td>
        <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>SMS | MODBUS Write Request; default: <b>MODBUS Write Request</b></td>
        <td>Action that will be taken if the condition is met. Possible actions:
            <ul>
                <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 slave.</li>
            </ul>
        </td>
    </tr>
    <tr>
        <td><span style="color: #0054a6;">SMS: Message</span></td>
        <td>string; default: <b>none</b></td>
        <td>SMS message text.</td>
    </tr>
    <tr>
        <td><span style="color: #0054a6;">SMS: Phone number</span></td>
        <td>phone number; default: <b>none</b></td>
        <td>Recipient's phone number.</td>
    </tr>
    <tr>
        <td><span style="color: purple;">MODBUS Write Request: IP address</span></td>
        <td>ip | host; default: <b>none</b></td>
        <td>Modbus slave's IP address.</td>
    </tr>
    <tr>
        <td><span style="color: purple;">MODBUS Write Request: Port</span></td>
        <td>integer [0..65535]; default: <b>none</b></td>
        <td>Modbus slave's port.</td>
    </tr>
    <tr>
        <td><span style="color: purple;">MODBUS Write Request: Timeout</span></td>
        <td>integer [1..30]; default: <b>5</b></td>
        <td>Maximum time to wait for a response.</td>
    </tr>
    <tr>
        <td><span style="color: purple;">MODBUS Write Request: ID</span></td>
        <td>integer [1..255]; default: <b>none</b></td>
        <td>Modbus slave ID.</td>
    </tr>
    <tr>
        <td><span style="color: purple;">MODBUS Write Request: Modbus function</span></td>
        <td>Read Force Single Coil (5) | Preset Single Register (6) | Force Multiple Coils (15) | Force Multiple Registers (16); default: <b>Force Single Coil (5)</b></td>
        <td>A function code specifies the type of register being addressed by a Modbus request.</td>
    </tr>
    <tr>
        <td><span style="color: purple;">MODBUS Write Request: First register</span></td>
        <td>integer [0..65535]; default: <b>none</b></td>
        <td>Begins reading from the register specified in this field.</td>
    </tr>
    <tr>
        <td><span style="color: purple;">MODBUS Write Request: Values</span></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>
    </tr>
</table>
|}}|}}
==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.
 
[[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: <b>off</b></td>
        <td>Turns MQTT gateway on or off.</td>
    </tr>
    <tr>
        <td>Host</td>
        <td>ip <nowiki>|</nowiki> host; default: <b>127.0.0.1</b></td>
        <td>IP address or hostname of an MQTT broker.</td>
    </tr>
    <tr>
        <td>Port</td>
        <td>integer [0..65535]; default: <b>1883</b></td>
        <td>Port number of the MQTT broker.</td>
    </tr>
    <tr>
        <td>Request topic</td>
        <td>alphanumeric string; default: <b>request</b></td>
        <td>.</td>
    </tr>
    <tr>
        <td>Response topic</td>
        <td>alphanumeric string; default: <b>response</b></td>
        <td>.</td>
    </tr>
    <tr>
        <td>Username</td>
        <td>string; default: <b>none</b></td>
        <td>Username for authentication to the MQTT broker.</td>
    </tr>
    <tr>
        <td>Password</td>
        <td>string; default: <b>none</b></td>
        <td>Password for authentication to the MQTT broker.</td>
    </tr>
</table>
 
==See also==
 
{{Template: Networking_device_modbus_see_also}}
 
[[Category:{{{name}}} Services section]]

Revision as of 15:05, 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 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:

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 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 new Request Configuration should become visible in the list:

Field Value Description
Name string; default: Unnamed Name of this Request Configuration. 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 Defines 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.
No Brackets off | on; default: off Removes the starting and ending brackets from the request (only for read requests).
Delete [ X ] - (interactive button) Deletes the request.
off/on slider off | on; default: off Turns the request on or off.

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:

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:

Alarms Configuration

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

After adding the Alarm you should be redirected to its configuration page which should look similar to this:

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. The Modbus TCP Master (this {{{name}}} device) perform this request as often as specified in the 'Period' field in Slave Device Configuration.
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).

8bit UINT|}}

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