Teltonika Networks Wiki

Difference between revisions of "Domnev"
 
(77 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
<p style="color:red">The information in this page is updated in accordance with [https://wiki.teltonika-networks.com/view/FW_%26_SDK_Downloads'''00.07.03.1'''] firmware version .</p>
+
<p style="color:red">The information on this page is updated in accordance with the [https://wiki.teltonika-networks.com/view/FW_%26_SDK_Downloads'''00.07.4'''] firmware version .</p>
−
==Introduction==
+
__TOC__
−
This article contains instructions on how to send M-Bus data to the server using various protocols.
+
==Summary==
 +
In this guide, the MQTT Serial Gateway function will be configured using third-party MQTT Broker services (in this example, ''Flespi.io'').
  
−
==Configuration overview and prerequisites==
+
==Configuration overview & prerequisites==
 +
*Two devices with serials ports - one acts as Modbus RTU Master, another as Modbus RTU Slave;
 +
*Flespi.io account to act as an MQTT Broker/Publisher/Subscriber (for first configuration example);
  
−
Before we begin, let's take a look at the configuration that we are attempting to achieve and the prerequisites that make it possible.
+
[[File:MQTT Serial gateway topology v2.png|border|center|class=tlt-border|847x279px]]
  
−
'''Prerequisites''':
+
RUT2 will act as a Modbus RTU slave and RUT1 as a Modbus RTU Master. On RUT1, MQTT Serial Gateway will be configured to transfer Modbus data over MQTT. Flespi.io platform will serve as an MQTT Broker
−
* TRB143;
 
−
* M-Bus device;
 
−
* Server;
 
−
* An end device (PC, Laptop, Tablet, Smartphone) for configuration;
 
  
−
If you're having trouble finding any 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 '''"Basic"''' button '''under''' '''"Mode,"''' which is located at the top-right corner of the WebUI.
+
==RUT2 configuration==
−
[[File:TRB143 advanced.gif|border|center|class=tlt-border|1004x1004px]]
+
===Configuring Modbus RTU Slave===
−
 
 
−
==Node-RED installation and setup==
 
−
 
 
−
We are going to set up Node-RED in a Linux virtual machine. For Node-RED to work, you would need to install Node.js version 14.00 or higher. If you already have Node.js installed, verify the Node.js version using this command:
 
−
<pre>
 
−
node -v
 
−
</pre>
 
−
If you do not have Node.js installed, run these commands to install it:
 
−
<pre>
 
−
sudo apt install curl
 
−
curl -fsSL https://deb.nodesource.com/setup_14.x | sudo -E bash –
 
−
sudo apt-get install -y nodejs
 
−
</pre>
 
−
Once we have Node.js installed, we can install Node-RED. Use this command to install:
 
−
<pre>
 
−
sudo npm install -g –unsafe-perm node-red
 
−
</pre>
 
−
Use the command '''''node-red''''' to start a local server. Here is how the terminal should look like if the server starts correctly:
 
−
[[File:Server is running node red terminal.png|border|600px|class=tlt-border]]
 
 
----
 
----
−
Once you have the local server running, use the local IP and port number in your internet browser. In this case, we are using 127.0.0.1:1880:
+
Go to Services → Modbus → Modbus RTU Slave and create a new instance.
−
[[File:Use server address in web browser.png|border|500px|class=tlt-border]]
+
# Enter the '''desired instance name''';
−
 
+
# Select the '''desired serial interface'''.
−
For MQTT usage, we are going to need MQTT-specific nodes. Use the side menu to navigate to the Manage Palette section and install these nodes:
 
−
*node-red-contrib-aedes
 
−
*node-red-contrib-mqtt-broker
 
−
 
 
−
[[File:Manage palette and download these mqtt nodes.png|border|500px|class=tlt-border]]
 
  
−
==Configuration==
+
[[File:Modbus RTU Slave.png|border|center|class=tlt-border|855 × 308px]]
  
−
===M-Bus Data to Server via MQTT===
+
==RUT1 configuration==
 +
===Configuring MQTT Gateway===
 
----
 
----
−
This section contains information on how to send M-Bus data to the server on Node-RED using the MQTT protocol.
+
Go to '''Services → Modbus → MQTT Gateway''' and there:
−
 
 
−
[[File:M-bus topology.png|border|750x750px|class=tlt-border]]
 
  
−
The M-Bus meter is directly connected to TRB143. Gateway reads the M-Bus data and send it to the server using MQTT protocol.
+
# '''Enable''' the '''instance''';
−
====Data to Server configuration====
+
# '''Enter Host''' (copied from flespi connection settings without 'wss://' and port);
−
----
+
# '''Enter Username''' (Copied from flespi Connection settings generated '''token''');
−
The '''[[TRB143_Data_to_Server|Data to Server]]''' feature provides you with the possibility to set up data senders that collect data from various sources and periodically send it to remote servers. This section will walk you through configuring the Data to Server to send M-Bus data to the Node-RED server. To configure Data to Server, '''access the router's WebUI''' and navigate to '''Services''', then '''Data to Server''':
+
# '''Enter Password'''.
  
−
# '''Enable''' instance;
+
[[File:MQTT Gateway config.png|border|center|class=tlt-border|862 × 412px]]
−
# '''Name:''' Enter '''desired''' '''instance name''';
 
−
# '''Data source:''' M-bus;
 
−
# '''Protocol:''' MQTT;
 
−
# '''JSON format:''' Enter what '''data''' you would like '''to send''';
 
−
# '''URL/Host/Connection string:''' Enter '''address of server''';
 
−
# '''Port:''' Enter '''server port''';
 
−
# '''Topic''': Enter '''desired''' '''topic name'''
 
  
−
[[File:Mbus data to server MQTT renewed.png|border|class=tlt-border|1094x1094px]]
+
'''Note''': ''Everything else can be left as default or changed according to your needs.''
  
−
====M-Bus configuration====
+
===Configuring Serial Gateway===
 
----
 
----
−
The '''[[TRB143_M-Bus|M-Bus Settings]]''' section is used to configure the general service functionality. To set up a new M-Bus instance, go to '''Services → M-Bus:'''
+
Under the MQTT Gateway configuration, create the Serial Gateway:
−
 
+
# Enter the '''desired device ID''';
−
# '''Enable''' M-Bus;
+
# Select the '''desired serial interface'''.
−
# '''ID''': Enter desired '''instance name''';
 
−
# '''Add''';
 
  
−
[[File:M bus configuration correct.png|border|class=tlt-border|904x904px]]
+
[[File:Serial gateway config.png|border|center|class=tlt-border|868×308px]]
  
−
After this, you should be redirected to the configuration page for the M-Bus instance:
+
===Configuring Flespi.io MQTT Broker===
−
 
 
−
[[File:M bus instance creation.png|border|class=tlt-border|904x904px]]
 
−
 
 
−
# '''Enable''' instance;
 
−
# '''Name''': Enter your '''desired name''';
 
−
#'''Period''': Enter '''desired period''';
 
−
At the bottom of the M-Bus instance, you should see the Request Configuration section. It is used to configure requests from M-Bus devices.
 
−
 
 
−
[[File:HEX data type.png|border|class=tlt-border|904x904px]]
 
−
 
 
−
# '''Enable''' request configuration;
 
−
# '''Slave address:''' Enter '''desired slave address''';
 
−
# '''Data type:''' Select desired data type (this time we will be using '''HEX''');
 
−
# '''Save & apply''' changes.
 
−
====Node-RED configuration====
 
−
----
 
−
Below you can see the Node-Red block diagram that is used to receive data and its configuration:
 
−
* '''aedes broker block''' - Broker;
 
−
* '''MQTT in block''' - mbus;
 
−
* '''Debug''' - debug 2;
 
−
[[File:Node-rs-topology.png|border|center|class=tlt-border|654x654px]]
 
 
----
 
----
 +
'''Log in''' or '''create an account''' on '''https://flespi.io''';
  
−
[[File:Node-red-broker-new.png|border|left|class=tlt-border|474x474px|left]]
+
#Navigate to '''MQTT Board''' on the '''left side''' menu;                                        
−
[[File:Node-red-debug-new.png|border|right|class=tlt-border|474x474px|right]]
+
#On the right-hand panel, top right corner, next to the name of the MQTT board, '''press the cogwheel-looking icon''' to open ''Connection Settings'';
−
<table class="nd-othertables_2" style="display: inline-table;">
+
#In the opened window, press '''"Get flespi token"''' to generate a username;
−
    <tr>
+
#Enter the '''Client name''';
−
        <td width=755; style="border-bottom: 1px solid white;">
+
#Copy the Host address;
−
# '''MQTT Port''': 1883;
+
#Copy '''Username''';
−
# '''WS Bind''': port;
+
#Create a '''password'''.
−
# '''Done''';
 
−
</td>
 
−
<td width=755; style="border-bottom: 1px solid white;">
 
−
# '''Output''': msg. payload;
 
−
# '''To''': debug window;
 
−
# '''Done''';
 
−
</td>
 
−
    </tr>
 
−
</table>
 
  
−
----
+
Once done, save all the changes.
−
[[File:Node-red-subscriber-configuration.png|border|class=tlt-border|1094x1094px]]
+
[[File:Flespi board.png|border|center|class=tlt-border|1102x729px]]
  
−
# '''Edit:''' Configure MQTT-Broker node;
+
===Message format for MQTT publisher===
−
# '''Name''': Enter '''desired MQTT-Broker nodes name;'''
 
−
# '''Server''': '''127.0.0.1''' as we will be using '''Node-RED as MQTT-Broker''';
 
−
# '''Port''': 1883;
 
−
# '''Update''': Save the changes;
 
−
# '''Server''': Select '''MQTT-Broker''' that you have '''just created''';
 
−
# '''Action''': Subscribe to single topic;
 
−
# '''Topic''': Enter the '''topic''' that you have '''set in Data to Server configuration''';
 
−
# '''Qos''': 0;
 
−
# '''Output''': Auto-Detect;
 
−
# '''Update''': Save the changes;
 
−
====Results====
 
 
----
 
----
−
If you have taken all of the steps described above, the configuration is complete. Below you can see M-Bus data output in HEX format.
+
Modbus request data sent in the MQTT payload should be generated in accordance with the following format:
−
[[File:MQTT broker HEX data.png|border|class=tlt-border|404x404px]]
 
  
−
===M-Bus Data to Server Via HTTP===
+
<pre>1 <COOKIE> <SERIAL_DEVICE_ID> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <FIRST_REGISTER> <REGISTER_COUNT> </pre>
−
----
 
−
This section contains information on how to send M-Bus data to the server on Node-RED using the HTTP(S) protocol.
 
  
−
[[File:M-bus topology HTTP data.png|border|750x750px|class=tlt-border]]
+
The table below explains what each option means:
  
−
The M-Bus meter is directly connected to TRB143. Gateway reads the M-Bus data and send it to the server using HTTP(S) protocol.
+
{| class="wikitable"
−
====Data to Server configuration====
+
|1.  Format version
 +
|'''1'''
 +
|-
 +
|2. Cookie
 +
|from '''0''' to '''2<sup>64</sup> -1'''
 +
|-
 +
|3. Serial device ID
 +
|a string used to identify a serial device. Must match with <u>Device ID</u> field in MQTT Gateway page Serial gateway configuration section
 +
|-
 +
|4. Timeout
 +
|timeout for Modbus connection, in seconds. Range [1..999].
 +
|-
 +
|5. Slave ID
 +
|Indicates to which slave request is sent
 +
|-
 +
|6. Modbus function
 +
|Modbus task type that will be executed. Possible values are:
 +
        <ul>
 +
            <li><b>1</b> - read coils;</li>
 +
            <li><b>2</b> - read input coils;</li>
 +
            <li><b>3</b> - read holding registers;</li>
 +
            <li><b>4</b> - read input registers;</li>
 +
            <li><b>5</b> - set single coil;</li>
 +
            <li><b>6</b> - write to a single holding register;</li>
 +
            <li><b>15</b> - set multiple coils;</li>
 +
            <li><b>16</b> - write to multiple holding registers.</li>
 +
        </ul>
 +
|-
 +
|7. First register
 +
|number (not address) of the first register/coil/input (in range [1..65536]) from which the registers/coils/inputs will be read/written to.
 +
|-
 +
|8. Registry count
 +
| <li><b>1</b> - <u>coil count</u> (in range [1..2000]); must not exceed the boundary (first coil number + coil count <= 65537);</li>
 +
            <li><b>2</b> - <u>input count</u> (in range [1..2000]); must not exceed the boundary (first input number + input count <= 65537);</li>
 +
            <li><b>3</b> - <u>holding register count</u> (in range [0..125]); must not exceed the boundary (first register number + holding register count <= 65537);</li>
 +
            <li><b>4</b> - <u>input register count</u> (in range [0..125]); must not exceed the boundary (first register number + input register count <= 65537);</li>
 +
            <li><b>5</b> - <u>coil value</u> (in range [0..1]);</li>
 +
            <li><b>6</b> - <u>holding register value</u> (in range [0..65535]);</li>
 +
            <li><b>15</b> - <u>coil count</u> (in range [1..1968]); must not exceed the boundary (first coil number + coil count <= 65537); and <u>coil values</u> separated with commas, without spaces (e.g., <i>1,2,3,654,21,789</i>); there must be exactly as many values as specified (with coil count); each value must be in the range of [0..1].
 +
|}
 +
====Examples====
 
----
 
----
−
To set up Data to Server, navigate to '''Services''' '''→ Data to Server:'''
+
{| class="wikitable"
 +
|Setting relay (on) (Relay address is 202, which means 'Number of first register will be 203)
 +
|'''1 1 1 1 1 6 203 1'''
 +
|-
 +
|Getting temperature
 +
|'''1 1 1 1 1 3 6 2'''
 +
|}
 +
Modbus parameters are held within registers. The register numbers and corresponding system values can be found [[RUT955_Monitoring_via_Modbus#Get_Parameters|'''in this article''']].
  
−
[[File:Mbus HTTP data to server config.png|border|class=tlt-border|1094x1094px]]
+
==Testing MQTT Publisher and Subscriber on flespi.io==
−
# '''Enable''' instance;
+
====Adding Flespi Subscriber====
−
# '''Name:''' Enter '''desired''' '''instance name''';
 
−
# '''Data source:''' M-bus;
 
−
# '''Protocol:''' HTTP(S);
 
−
# '''JSON format:''' Enter what '''data''' you would like '''to send''';
 
−
# '''URL/Host/Connection string:''' Enter '''address of server''' and '''port''';
 
−
====M-Bus configuration====
 
 
----
 
----
−
Go to Services '''→ M-Bus →''' the '''instance''' you have created '''→ edit.''' After that, scroll down to '''Request configuration → edit.''' There you will be able to change the data type.
+
To test the Modbus Serial Gateway functionality, '''log into''' your '''Flespi account''' → '''MQTT Board''' and '''add a Subscriber''':
  
−
[[File:Mbus XML data type.png|border|class=tlt-border|954x954px]]
+
#Press '''''<nowiki/>'+'''''' button on the top right corner
 +
#Select '''''<nowiki/>'Subscriber''''''
 +
# In the topic field enter '''''<nowiki/>'response''''''
 +
#Press '''''<nowiki/>'Subscribe'''''' button
  
−
# '''Enable''' request configuration;
+
[[File:Flespi subscriber.png|border|class=tlt-border|496x204px]]           [[File:Flespi subscriber setup.png|border|class=tlt-border|496x205px]]
−
# '''Slave address:''' Enter '''desired slave address;'''
+
====Adding Flespi Subscriber====
−
# '''Data type:''' Select desired data type (this time we will be using '''XML''');
 
−
# '''Save & apply''' changes.
 
−
====Node-RED configuration====
 
−
----
 
−
Below you can see the Node-Red block diagram that is used to receive data and its configuration:
 
−
* '''TCP in block''' - tcp:8080;
 
−
* '''Debug''' - debug;
 
−
[[File:HTTP node-red.png|border|class=tlt-border|center|514x514px]]
 
−
----
 
−
[[File:HTTP node-RED block config.png|border|left|class=tlt-border|474x474px|left]]
 
−
[[File:Node-red-debug-new.png|border|right|class=tlt-border|534x534px|right]]
 
−
<table class="nd-othertables_2" style="display: inline-table;">
 
−
    <tr>
 
−
        <td width=755; style="border-bottom: 1px solid white;">
 
−
# '''Type''': Listen on;
 
−
# '''Port''': 8080;
 
−
# '''Output''': Stream of String;
 
−
# '''Done''';
 
−
</td>
 
−
<td width=755; style="border-bottom: 1px solid white;">
 
−
# '''Output''': msg. payload;
 
−
# '''To''': debug window;
 
−
# '''Done''';
 
−
</td>
 
−
    </tr>
 
−
</table>
 
−
====Results====
 
−
----
 
−
If you have taken all of the steps described above, the configuration is complete. Below you can see M-Bus data output in XML format.
 
−
[[File:XML data Mbus.png|border|class=tlt-border|304x304px]]
 
−
===MQTT broker===
 
−
This section contains information on how to send M-Bus data to the server on Node-RED using a Teltonika router as a MQTT broker.
 
−
----
 
−
====Data to Server configuration====
 
 
----
 
----
−
To set up Data to Server, navigate to '''Services''' '''→ Data to Server:'''
 
  
−
[[File:MQTT broker data to server config.png|border|class=tlt-border|1094x1094px]]
+
Also, you will need to '''add a Publisher''':
−
# '''Enable''' instance;
 
−
# '''Name:''' Enter '''desired instance name''';
 
−
# '''Data source:''' M-bus;
 
−
# '''Protocol:''' MQTT;
 
−
# '''JSON format:''' Enter what '''data''' you would like '''to send''';
 
−
# '''URL/Host/Connection string:''' Localhost IP;
 
−
# '''Port:''' enter '''server port''';
 
−
# '''Topic''': enter '''desired topic name''';
 
−
====MQTT broker configuration====
 
−
----
 
−
The '''MQTT Broker''' is an entity that listens for connections on the specified port and relays received messages to MQTT client. To set up MQTT Broker go to S'''ervices → MQTT → Broker:'''
 
  
−
[[File:Mbus MQTT Broker.png|border|class=tlt-border|954x954px]]
+
#Press '''''<nowiki/>'+'''''' button on the top right corner
−
# '''MQTT broker''': On;
+
#Select '''''<nowiki/>'Publisher''''''
−
# '''Local port''': 1883;
+
#In the topic field enter '''''<nowiki/>'request''''''
−
====M-Bus configuration====
+
#In the message field enter message, for this example '''''<nowiki/>'Getting temperature'''''' is used
−
----
+
#Press '''''<nowiki/>'Publish'''''' button
−
Go to Services '''→ M-Bus →''' the '''instance''' you have created '''→ edit.''' After that, scroll down to '''Request configuration → edit.''' There, you will be able to change the data type.
 
  
−
[[File:Mbus BIN data type.png|border|class=tlt-border|854x854px]]
+
[[File:Flespi publisher.png|border|class=tlt-border|495x238px]]   [[File:Flespi publisher setup.png|border|class=tlt-border|494x239px]]
−
# '''Enable''' request configuration;
+
====Flespi Subscriber output====
−
# '''Slave address''': Enter '''desired slave address''';
 
−
# '''Data type''': Select desired data type (this time we will be using '''BIN''');
 
−
# '''Save & apply''' changes.
 
−
====Node-RED configuration====
 
−
----
 
−
[[File:MQTT broker node-RED.png|border|center|class=tlt-border|514x514px]]
 
 
----
 
----
−
<table class="nd-othertables_2">
+
Check the response in the '''''<nowiki/>'Subscriber'''''' tab, you should receive a message similar to the one below.
−
    <tr>
 
−
        <th width=790; style="border-bottom: 1px solid white;" rowspan=2>[[File:Node-red-debug-new.png|border|left|class=tlt-border|474x474px|left]]</th>
 
−
        <th width=355; style="border-bottom: 1px solid white;></th>
 
−
    </tr>
 
−
    <tr>
 
−
<td width=755; style="border-bottom: 1px solid white;">
 
−
 
 
  
  
 +
[[File:Flespi response.png|border|center|class=tlt-border|500x305px]]
  
  
 +
In the output, we can see that router's '''temperature''' is '''44 degrees Celsius'''.
  
−
 
−
 
−
 
−
 
−
 
−
 
−
# '''Output''': msg. payload;
 
−
# '''To''': debug window;
 
−
# '''Done''';
 
−
</td>
 
−
    </tr>
 
−
</table>
 
−
----
 
−
[[File:Node-red-mqtt-in-TRBroker.png|border|class=tlt-border|1100x1100px]]
 
−
# '''Edit:''' Configure MQTT-Broker node;
 
−
# '''Name''': Enter '''desired MQTT-Broker nodes name;'''
 
−
# '''Server''': '''127.0.0.1''' as we will be using '''Node-RED as MQTT-Broker''';
 
−
# '''Port''': 1883;
 
−
# '''Update''': Save the changes;
 
−
# '''Server''': Select '''MQTT-Broker''' that you have '''just created''';
 
−
# '''Action''': Subscribe to single topic;
 
−
# '''Topic''': Enter the '''topic''' that you have '''set in Data to Server configuration''';
 
−
# '''Qos''': 0;
 
−
# '''Output''': Auto-Detect;
 
−
# '''Update''': Save the changes;
 
−
====Results====
 
−
----
 
−
If you have taken all of the steps described above, the configuration is complete. Below you can see M-Bus data output in BIN format.
 
−
[[File:MQTT BIN data.png|border|class=tlt-border|304x304px]]
 
 
==See Also==
 
==See Also==
−
* [[TRB143_M-Bus|M-Bus]]
+
*[[RUT955 Monitoring via Modbus#Get Parameters]]
−
* [[TRB143_Data_to_Server|Data to Server]]
+
*[[RUT955_Modbus#MQTT_Gateway|MQTT Gateway and Modbus]]
−
* [[TRB143_MQTT#MQTT_Broker|MQTT Broker]]
 
 
==External links==
 
==External links==
−
[https://nodered.org/docs/getting-started/ Node-RED]
+
[https://flespi.io/#/ Flespi.io]

Latest revision as of 08:14, 13 September 2023

The information on this page is updated in accordance with the 00.07.4 firmware version .

Summary

In this guide, the MQTT Serial Gateway function will be configured using third-party MQTT Broker services (in this example, Flespi.io).

Configuration overview & prerequisites

  • Two devices with serials ports - one acts as Modbus RTU Master, another as Modbus RTU Slave;
  • Flespi.io account to act as an MQTT Broker/Publisher/Subscriber (for first configuration example);
MQTT Serial gateway topology v2.png

RUT2 will act as a Modbus RTU slave and RUT1 as a Modbus RTU Master. On RUT1, MQTT Serial Gateway will be configured to transfer Modbus data over MQTT. Flespi.io platform will serve as an MQTT Broker

RUT2 configuration

Configuring Modbus RTU Slave

Go to Services → Modbus → Modbus RTU Slave and create a new instance.

  1. Enter the desired instance name;
  2. Select the desired serial interface.
855 × 308px

RUT1 configuration

Configuring MQTT Gateway

Go to Services → Modbus → MQTT Gateway and there:

  1. Enable the instance;
  2. Enter Host (copied from flespi connection settings without 'wss://' and port);
  3. Enter Username (Copied from flespi Connection settings generated token);
  4. Enter Password.
862 × 412px

Note: Everything else can be left as default or changed according to your needs.

Configuring Serial Gateway

Under the MQTT Gateway configuration, create the Serial Gateway:

  1. Enter the desired device ID;
  2. Select the desired serial interface.
868×308px

Configuring Flespi.io MQTT Broker

Log in or create an account on https://flespi.io;

  1. Navigate to MQTT Board on the left side menu;
  2. On the right-hand panel, top right corner, next to the name of the MQTT board, press the cogwheel-looking icon to open Connection Settings;
  3. In the opened window, press "Get flespi token" to generate a username;
  4. Enter the Client name;
  5. Copy the Host address;
  6. Copy Username;
  7. Create a password.

Once done, save all the changes.

Flespi board.png

Message format for MQTT publisher

Modbus request data sent in the MQTT payload should be generated in accordance with the following format: 

1 <COOKIE> <SERIAL_DEVICE_ID> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <FIRST_REGISTER> <REGISTER_COUNT>

The table below explains what each option means:

1. Format version 1
2. Cookie from 0 to 264 -1
3. Serial device ID a string used to identify a serial device. Must match with Device ID field in MQTT Gateway page Serial gateway configuration section
4. Timeout timeout for Modbus connection, in seconds. Range [1..999].
5. Slave ID Indicates to which slave request is sent
6. Modbus function Modbus task type that will be executed. Possible values are:
  • 1 - read coils;
  • 2 - read input coils;
  • 3 - read holding registers;
  • 4 - read input registers;
  • 5 - set single coil;
  • 6 - write to a single holding register;
  • 15 - set multiple coils;
  • 16 - write to multiple holding registers.
7. First register number (not address) of the first register/coil/input (in range [1..65536]) from which the registers/coils/inputs will be read/written to.
8. Registry count
  • 1 - coil count (in range [1..2000]); must not exceed the boundary (first coil number + coil count <= 65537);
  • 2 - input count (in range [1..2000]); must not exceed the boundary (first input number + input count <= 65537);
  • 3 - holding register count (in range [0..125]); must not exceed the boundary (first register number + holding register count <= 65537);
  • 4 - input register count (in range [0..125]); must not exceed the boundary (first register number + input register count <= 65537);
  • 5 - coil value (in range [0..1]);
  • 6 - holding register value (in range [0..65535]);
  • 15 - coil count (in range [1..1968]); must not exceed the boundary (first coil number + coil count <= 65537); and coil values separated with commas, without spaces (e.g., 1,2,3,654,21,789); there must be exactly as many values as specified (with coil count); each value must be in the range of [0..1].

    • Examples

    Setting relay (on) (Relay address is 202, which means 'Number of first register will be 203) 1 1 1 1 1 6 203 1
    Getting temperature 1 1 1 1 1 3 6 2

    Modbus parameters are held within registers. The register numbers and corresponding system values can be found in this article.

    Testing MQTT Publisher and Subscriber on flespi.io

    Adding Flespi Subscriber

    To test the Modbus Serial Gateway functionality, log into your Flespi account → MQTT Board and add a Subscriber:

    1. Press '+' button on the top right corner
    2. Select 'Subscriber'
    3. In the topic field enter 'response'
    4. Press 'Subscribe' button

    Flespi subscriber.png Flespi subscriber setup.png

    Adding Flespi Subscriber

    Also, you will need to add a Publisher:

    1. Press '+' button on the top right corner
    2. Select 'Publisher'
    3. In the topic field enter 'request'
    4. In the message field enter message, for this example 'Getting temperature' is used
    5. Press 'Publish' button

    Flespi publisher.png Flespi publisher setup.png

    Flespi Subscriber output

    Check the response in the 'Subscriber' tab, you should receive a message similar to the one below.


    Flespi response.png


    In the output, we can see that router's temperature is 44 degrees Celsius.

    See Also

    External links

    Flespi.io

    Retrieved from "https://wiki.teltonika-networks.com/index.php?title=Domnev&oldid=111434"