Teltonika Networks Wiki

Changes

Domnev (view source)

Revision as of 08:14, 13 September 2023

3,285 bytes added ,  08:14, 13 September 2023
no edit summary
Line 1: Line 1: −
<p style="color:red">The information in this page is updated in accordance with 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===
 +
----
 +
Go to Services → Modbus → Modbus RTU Slave and create a new instance.
 +
# Enter the '''desired instance name''';
 +
# Select the '''desired serial interface'''.
   −
==Configuration==
+
[[File:Modbus RTU Slave.png|border|center|class=tlt-border|855 × 308px]]
   −
===Data to server===
+
==RUT1 configuration==
−
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.
+
===Configuring MQTT Gateway===
 
----
 
----
−
====Via MQTT====
+
Go to '''Services → Modbus → MQTT Gateway''' and there:
−
This sections contains information on how to send M-Bus data to the server on Node-RED 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''');
−
'''[[File:Mbus data to server MQTT.png|border|class=tlt-border|954x954px]]'''
+
# '''Enter Password'''.
 +
 
 +
[[File:MQTT Gateway config.png|border|center|class=tlt-border|862 × 412px]]
 +
 
 +
'''Note''': ''Everything else can be left as default or changed according to your needs.''
   −
# '''Enable''' instance;
+
===Configuring Serial Gateway===
−
# '''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;
  −
=====M-Bus configuration=====
   
----
 
----
−
[[File:M bus configuration correct.png|border|class=tlt-border|954x954px]]
+
Under the MQTT Gateway configuration, create the Serial Gateway:
 +
# Enter the '''desired device ID''';
 +
# Select the '''desired serial interface'''.
   −
# '''Enable''' M-Bus;
+
[[File:Serial gateway config.png|border|center|class=tlt-border|868×308px]]
−
# Enter desired '''instance name''';
  −
# '''Add''';
     −
[[File:M bus instance configuration.png|border|class=tlt-border|954x954px]]
+
===Configuring Flespi.io MQTT Broker===
 +
----
 +
'''Log in''' or '''create an account''' on '''https://flespi.io''';
   −
# '''Enable''' instance;
+
#Navigate to '''MQTT Board''' on the '''left side''' menu;                                        
−
# '''Period''': enter desired period;
+
#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'';
−
# BLOGAS - NAME NEREIKIA
+
#In the opened window, press '''"Get flespi token"''' to generate a username;
 +
#Enter the '''Client name''';
 +
#Copy the Host address;
 +
#Copy '''Username''';
 +
#Create a '''password'''.
   −
[[File:M bus slave configuration.png|border|class=tlt-border|954x954px]]
+
Once done, save all the changes.
 +
[[File:Flespi board.png|border|center|class=tlt-border|1102x729px]]
   −
# '''Enable''' request configuration;
+
===Message format for MQTT publisher===
−
# '''Slave address:''' enter desired slave address;
  −
# '''Data type:''' select desired data type (this time we will be using '''XML''');
  −
# '''Save & apply''' changes.
  −
=====Node-RED configuration=====
   
----
 
----
−
[[File:Node-red-broker-configuration.png|border|left|class=tlt-border|554x554px]]
+
Modbus request data sent in the MQTT payload should be generated in accordance with the following format:
−
[[File:Node-red-subscriber-configuration.png|border|class=tlt-border|1054x1054px]]
+
 
 +
<pre>1 <COOKIE> <SERIAL_DEVICE_ID> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <FIRST_REGISTER> <REGISTER_COUNT> </pre>
    +
The table below explains what each option means:
   −
=====Results=====
+
{| class="wikitable"
 +
|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====
 
----
 
----
 +
{| 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''']].
   −
====Via HTTP====
+
==Testing MQTT Publisher and Subscriber on flespi.io==
−
This sections contains information on how to send M-Bus data to the server on Node-RED using HTTP protocol.
+
====Adding Flespi Subscriber====
 
----
 
----
−
=====Data to Server configuration=====
+
To test the Modbus Serial Gateway functionality, '''log into''' your '''Flespi account''' → '''MQTT Board''' and '''add a Subscriber''':
 +
 
 +
#Press '''''<nowiki/>'+'''''' button on the top right corner
 +
#Select '''''<nowiki/>'Subscriber''''''
 +
# In the topic field enter '''''<nowiki/>'response''''''
 +
#Press '''''<nowiki/>'Subscribe'''''' button
 +
 
 +
[[File:Flespi subscriber.png|border|class=tlt-border|496x204px]]          [[File:Flespi subscriber setup.png|border|class=tlt-border|496x205px]]
 +
====Adding Flespi Subscriber====
 
----
 
----
−
[[File:mbus data to server http.png|border|class=tlt-border|954x954px]]
      +
Also, you will need to '''add a Publisher''':
    +
#Press '''''<nowiki/>'+'''''' button on the top right corner
 +
#Select '''''<nowiki/>'Publisher''''''
 +
#In the topic field enter '''''<nowiki/>'request''''''
 +
#In the message field enter message, for this example '''''<nowiki/>'Getting temperature'''''' is used
 +
#Press '''''<nowiki/>'Publish'''''' button
   −
# '''Enable''' instance;
+
[[File:Flespi publisher.png|border|class=tlt-border|495x238px]]  [[File:Flespi publisher setup.png|border|class=tlt-border|494x239px]]
−
# '''Name:''' enter desired instance name;
+
====Flespi Subscriber output====
−
# '''Data source:''' M-bus;
  −
# '''Protocol:''' HTTP;
  −
# '''JSON format:''' enter what data you would like to send;
  −
# '''URL/Host/Connection string:''' enter address of server;
  −
 
  −
=====M-Bus configuration=====
   
----
 
----
−
[[File:Mbus config HEX data.png|border|class=tlt-border|954x954px]]
+
Check the response in the '''''<nowiki/>'Subscriber'''''' tab, you should receive a message similar to the one below.
   −
# '''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=====
+
[[File:Flespi response.png|border|center|class=tlt-border|500x305px]]
−
----
     −
=====Results=====
  −
----
     −
===MQTT broker===
+
In the output, we can see that router's '''temperature''' is '''44 degrees Celsius'''.
−
MQTT Broker is an entity that listens for connections on the specified port and relays received messages to MQTT client.
  −
----
  −
=====MQTT broker configuration=====
  −
----
  −
[[File:Mbus MQTT Broker.png|border|class=tlt-border|954x954px]]
  −
=====M-Bus configuration=====
  −
----
  −
=====Node-RED configuration=====
  −
----
  −
=====Results=====
  −
----
      
==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://flespi.io/#/ Flespi.io]
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/102202...111434"