Difference between revisions of "Domnev"

From Teltonika Networks Wiki
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
<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>
+
<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.08'''] firmware version .</p>
 
__TOC__
 
__TOC__
 
==Summary==
 
==Summary==
−
In this guide, the MQTT Serial Gateway function will be configured using third-party MQTT Broker services (in this example, ''Flespi.io'').
+
This article contains instructions on how to send M-Bus data to the server using various protocols.
  
 
==Configuration overview & prerequisites==
 
==Configuration overview & prerequisites==
−
*Two devices with serials ports - one acts as Modbus RTU Master, another as Modbus RTU Slave;
+
Before we begin, let's take a look at the configuration that we are attempting to achieve and the prerequisites that make it possible.
−
*Flespi.io account to act as an MQTT Broker/Publisher/Subscriber (for first configuration example);
 
  
−
[[File:MQTT Serial gateway topology.png|border|center|class=tlt-border|847x279px]]
+
'''Prerequisites''':
 +
* TRB143;
 +
* M-Bus device;
 +
* Server;
 +
* An end device (PC, Laptop, Tablet, Smartphone) for configuration;
  
−
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==
+
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
−
===Configuring Modbus RTU Slave===
+
| series = RUTX
 +
}}
 +
 
 +
 
 +
==Adding M-Bus devices==
 +
To add a new device to the configuration press [[File:Add Button.png|60x90px]] button which is shown below.
 +
 
 +
[[File:Mbus adding new device.png||border|class=tlt-border]]
 +
 
 +
===Device configuration===
 
----
 
----
−
Go to Services → Modbus → Modbus RTU Slave and create a new instance.
+
You will be granted to a new window. Configure your M-Bus device accordingly:
−
* Enter the '''desired instance name''';
 
−
* Select the '''desired serial interface'''.
 
  
−
[[File:Modbus RTU Slave.png|border|center|class=tlt-border|855 × 308px]]
+
# '''Name''': Enter the desired name of the M-Bus device
 +
# '''Address type''': select which M-Bus address will be used
 +
# '''Primary/Secondary address''': specify M-Bus address
  
−
==RUT1 configuration==
+
[[File:Mbus adding new device configuration v3.png|border|class=tlt-border]]
−
===Configuring MQTT Gateway===
+
 
 +
Test if the M-Bus device is reachable by a specified primary/secondary address. To do so click on [[File:Ping_device_option_mbus.png|110x110px]]. You might get on of two outputs:
 +
 
 +
* If you have specified correct primary/secondary address, you will receive:
 +
[[File:Mbus device pingable v2.png|border|class=tlt-border|300px]]
 +
 
 +
* If you have specified incorrect primary/secondary address, you will receive (if you do not know what address should be used, refer to the Scanning for available M-Bus devices (PRIDET URL) secion:
 +
[[File:Mbus device not pingable v2.png|border|class=tlt-border|300px]]
 +
 
 +
Once finished, save the configuration by clicking [[File:Savenapply button.png|Savenapply button.png]].
 +
 
 +
===Scanning for available M-Bus devices===
 
----
 
----
−
Go to '''Services → Modbus → MQTT Gateway''' and there:
 
  
−
# '''Enable''' the '''instance''';
+
If you are not sure what address your M-Bus devices have, you can try scanning for the available M-Bus devices. To do so click on [[File:Scan button.png]] button.
−
# '''Enter Host''' (copied from flespi connection settings without 'wss://' and port);
+
 
−
# '''Enter Username''' (Copied from flespi Connection settings generated '''token''');
+
====Scan settings====
−
# '''Enter Password'''.
+
----
 +
You will be granted to a new window. Configure scan settings accordingly:
 +
 
 +
# '''Scan type''': select which M-Bus address will be scanned
 +
# '''Scan range''': From what M-Bus address scanning will start and M-Bus address until scanning will be performed.
 +
[[File:Mbus scan.png|border|class=tlt-border]]
 +
 
 +
To start the scan click on [[File:Start scan button.png]] button.
 +
 
 +
====Found devices====
 +
----
 +
Once the scan is finished you should see the list of M-Bus devices that TRB143 were able to find:
 +
 
 +
[[File:Mbus scanned devices add.png|border|class=tlt-border]]
 +
 
 +
You can either [[File:Pencil2.png]] '''(1)''' M-Bus devices primary address or [[File:Add Button.png|60x90px]] '''(2)''' to the M-Bus devices list.
 +
 
 +
==Gathering M-Bus data==
  
−
[[File:MQTT Gateway config.png|border|center|class=tlt-border|862 × 412px]]
+
If the device successfully added to the list, under the General settings you should see that the Status changes to <span style="color:green">Active</span>.
  
−
'''Note''': ''Everything else can be left as default or changed according to your needs.''
+
[[File:Mbus status active v2.png|border|class=tlt-border]]
  
−
===Configuring Serial Gateway===
+
===Data collecting groups===
 
----
 
----
−
Under the MQTT Gateway configuration, create the Serial Gateway:
+
To reach data collecting groups configuration press [[File:Pencil2.png]] button. [[File:Add Button.png|60x90px]] button lets you to create a new instance.
−
# Enter the '''desired device ID''';
 
−
# Select the '''desired serial interface'''.
 
  
−
[[File:Serial gateway config.png|border|center|class=tlt-border|868×308px]]
+
[[File:Mbus data collect overview.png|border|class=tlt-border]]
  
−
===Configuring Flespi.io MQTT Broker===
+
====Data collecting group instance====
 
----
 
----
−
'''Log in''' or '''create an account''' on '''https://flespi.io''';
 
  
−
#Navigate to '''MQTT Board''' on the '''left side''' menu;                                       
+
Each data collection group contains the following information. Configure device accordingly:
−
#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'';
 
−
#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'''.
 
  
−
Once done, save all the changes.
+
# '''Enabled''': on
−
[[File:Flespi board.png|border|center|class=tlt-border|1102x729px]]
+
# '''Name''': desired name of the instance
 +
# '''Period''': desired time duration between data retrievals
 +
# '''Data type''': desired data type to process the received data. Depending on your needs you can select between 5 different data types: '''JSON, XML, ASCII, Hexadecimal''' and '''Binary'''.
  
−
===Message format for MQTT publisher===
+
[[File:Mbus data collect group v2.png|border|class=tlt-border]]
 +
 
 +
You can check if your configuration works accordingly by pressing the [[File:Mbus test button.png]] button. You should see the data in a pop-up field:
 +
 
 +
[[File:Mbus TEST output.png|border|class=tlt-border]]
 +
 
 +
====Group values====
 
----
 
----
−
Modbus request data sent in the MQTT payload should be generated in accordance with the following format:
+
To reach group values configuration press [[File:Pencil2.png]] button:
  
−
<pre>1 <COOKIE> <SERIAL_DEVICE_ID> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <FIRST_REGISTER> <REGISTER_COUNT> </pre>
+
[[File:Mbus edit group values.png|border|class=tlt-border]]
  
−
The table below explains what each option means:
+
There you can adjust additional settings:
  
−
{| class="wikitable"
+
# '''Enable''': Enable/disable data group value.
−
|1. Format version
+
# '''FCB toggle''': FCB (Frame Count-Bit), one-bit counter for reliable server-client communication.
−
|'''1'''
+
# '''Manufacturer information''': Select to include manufacturer information in the payload.
−
|-
+
# '''Selected parameters''': Select to include the all parameters saved from device, or a custom subset of them. If the custom is selected you can specify '''frame''', '''record''' numbers and also a '''paramater'''
−
|2. Cookie
+
 
−
|from '''0''' to '''2<sup>64</sup> -1'''
+
[[File:Mbus device groupsa.png|border|class=tlt-border]]
−
|-
+
 
−
|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
+
==Sending data to the server==
−
|-
+
This section contains information on how to send M-Bus data to the server using MQTT and HTTP protocols.
−
|4. Timeout
+
 
−
|timeout for Modbus connection, in seconds. Range [1..999].
+
===Data to Server configuration===
−
|-
 
−
|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"
+
To set up Data to Server, navigate to Services → Data to Server. Enter desired name of the instnace and hit [[File:Add Button.png|60x90px]] button which is shown below.
−
|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''']].
 
  
−
==Testing MQTT Publisher and Subscriber on flespi.io==
+
[[File:Mbus data to server create.png|border|class=tlt-border]]
 +
 
 +
===Data configuration===
 
----
 
----
−
====Adding Flespi Subscriber====
+
 
 +
[[File:Mbus data to server configuration.png|border|class=tlt-border]]
 +
 
 +
 
 +
Once finished configuring Data configuration tab click on [[File:Mbus data to server collection edit.png|160x160px]] button.
 +
 
 +
===Collection 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
+
[[File:Mbus data to server collection configuration.png|border|class=tlt-border]]
−
#Select '''''<nowiki/>'Subscriber''''''
+
 
−
# In the topic field enter '''''<nowiki/>'response''''''
+
Once finished configuring Collection configuration tab click on [[File:Mbus data to server server button.png|160x160px]] button.
−
#Press '''''<nowiki/>'Subscribe'''''' button
 
  
−
[[File:Flespi subscriber.png|border|class=tlt-border|496x204px]]          [[File:Flespi subscriber setup.png|border|class=tlt-border|496x205px]]
+
===Server configuration===
−
====Adding Flespi Subscriber====
 
 
----
 
----
  
−
Also, you will need to '''add a Publisher''':
+
====HTTP configuration====
 +
----
  
−
#Press '''''<nowiki/>'+'''''' button on the top right corner
+
[[File:Mbus data to server HTTP configuration.png|border|class=tlt-border]]
−
#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
 
  
−
[[File:Flespi publisher.png|border|class=tlt-border|495x238px]]  [[File:Flespi publisher setup.png|border|class=tlt-border|494x239px]]
+
====MQTT configuration====
−
====Flespi Subscriber output====
 
 
----
 
----
−
Check the response in the '''''<nowiki/>'Subscriber'''''' tab, you should receive a message similar to the one below.
 
  
 +
[[File:Mbus data to server MQTT configuration.png|border|class=tlt-border]]
  
−
[[File:Flespi response.png|border|center|class=tlt-border|500x305px]]
+
Once finished configuring Server configuration tab click on [[File:Savenapply button.png|Savenapply button.png]] button.
  
  
−
In the output, we can see that router's '''temperature''' is '''44 degrees Celsius'''.
+
==See Also==
  
−
==See Also==
 
−
*[[RUT955 Monitoring via Modbus#Get Parameters]]
 
−
*[[RUT955_Modbus#MQTT_Gateway|MQTT Gateway and Modbus]]
 
 
==External links==
 
==External links==
 
[https://flespi.io/#/ Flespi.io]
 
[https://flespi.io/#/ Flespi.io]

Latest revision as of 09:32, 22 August 2024

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

Summary

This article contains instructions on how to send M-Bus data to the server using various protocols.

Configuration overview & prerequisites

Before we begin, let's take a look at the configuration that we are attempting to achieve and the prerequisites that make it possible.

Prerequisites:

  • TRB143;
  • M-Bus device;
  • Server;
  • An end device (PC, Laptop, Tablet, Smartphone) for configuration;


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.

Networking rutos manual webui basic advanced mode 75.gif


Adding M-Bus devices

To add a new device to the configuration press Add Button.png button which is shown below.

Mbus adding new device.png

Device configuration

You will be granted to a new window. Configure your M-Bus device accordingly:

  1. Name: Enter the desired name of the M-Bus device
  2. Address type: select which M-Bus address will be used
  3. Primary/Secondary address: specify M-Bus address

Mbus adding new device configuration v3.png

Test if the M-Bus device is reachable by a specified primary/secondary address. To do so click on Ping device option mbus.png. You might get on of two outputs:

  • If you have specified correct primary/secondary address, you will receive:

Mbus device pingable v2.png

  • If you have specified incorrect primary/secondary address, you will receive (if you do not know what address should be used, refer to the Scanning for available M-Bus devices (PRIDET URL) secion:

Mbus device not pingable v2.png

Once finished, save the configuration by clicking Savenapply button.png.

Scanning for available M-Bus devices

If you are not sure what address your M-Bus devices have, you can try scanning for the available M-Bus devices. To do so click on Scan button.png button.

Scan settings

You will be granted to a new window. Configure scan settings accordingly:

  1. Scan type: select which M-Bus address will be scanned
  2. Scan range: From what M-Bus address scanning will start and M-Bus address until scanning will be performed.

Mbus scan.png

To start the scan click on Start scan button.png button.

Found devices

Once the scan is finished you should see the list of M-Bus devices that TRB143 were able to find:

Mbus scanned devices add.png

You can either Pencil2.png (1) M-Bus devices primary address or Add Button.png (2) to the M-Bus devices list.

Gathering M-Bus data

If the device successfully added to the list, under the General settings you should see that the Status changes to Active.

Mbus status active v2.png

Data collecting groups

To reach data collecting groups configuration press Pencil2.png button. Add Button.png button lets you to create a new instance.

Mbus data collect overview.png

Data collecting group instance

Each data collection group contains the following information. Configure device accordingly:

  1. Enabled: on
  2. Name: desired name of the instance
  3. Period: desired time duration between data retrievals
  4. Data type: desired data type to process the received data. Depending on your needs you can select between 5 different data types: JSON, XML, ASCII, Hexadecimal and Binary.

Mbus data collect group v2.png

You can check if your configuration works accordingly by pressing the Mbus test button.png button. You should see the data in a pop-up field:

Mbus TEST output.png

Group values

To reach group values configuration press Pencil2.png button:

Mbus edit group values.png

There you can adjust additional settings:

  1. Enable: Enable/disable data group value.
  2. FCB toggle: FCB (Frame Count-Bit), one-bit counter for reliable server-client communication.
  3. Manufacturer information: Select to include manufacturer information in the payload.
  4. Selected parameters: Select to include the all parameters saved from device, or a custom subset of them. If the custom is selected you can specify frame, record numbers and also a paramater

Mbus device groupsa.png


Sending data to the server

This section contains information on how to send M-Bus data to the server using MQTT and HTTP protocols.

Data to Server configuration

To set up Data to Server, navigate to Services → Data to Server. Enter desired name of the instnace and hit Add Button.png button which is shown below.

Mbus data to server create.png

Data configuration

Mbus data to server configuration.png


Once finished configuring Data configuration tab click on Mbus data to server collection edit.png button.

Collection configuration

Mbus data to server collection configuration.png

Once finished configuring Collection configuration tab click on Mbus data to server server button.png button.

Server configuration

HTTP configuration

Mbus data to server HTTP configuration.png

MQTT configuration

Mbus data to server MQTT configuration.png

Once finished configuring Server configuration tab click on Savenapply button.png button.


See Also

External links

Flespi.io

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