Domnev: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
No edit summary
No edit summary
 
(13 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 v2.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
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
| series = RUTX
}}


==RUT2 configuration==
==Adding M-Bus devices==
===Configuring Modbus RTU Slave===
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 → Client'''. 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'''.
# '''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
 
[[File:Mbus adding new device configuration v3.png|border|class=tlt-border]]
 
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]]


[[File:Modbus RTU Slave.png|border|center|class=tlt-border|855 × 308px]]
* 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]]


==RUT1 configuration==
Once finished, save the configuration by clicking [[File:Savenapply button.png|Savenapply button.png]].
===Configuring MQTT Gateway===
 
===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''');
# '''Enter Password'''.


[[File:MQTT Gateway config.png|border|center|class=tlt-border|862 × 412px]]
====Scan settings====
----
You will be granted to a new window. Configure scan settings accordingly:


'''Note''': ''Everything else can be left as default or changed according to your needs.''
# '''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]]


===Configuring Serial Gateway===
To start the scan click on [[File:Start scan button.png]] button.
 
====Found devices====
----
----
Under the MQTT Gateway configuration, create the Serial Gateway:
Once the scan is finished you should see the list of M-Bus devices that TRB143 were able to find:
# Enter the '''desired device ID''';
# Select the '''desired serial interface'''.


[[File:Serial gateway config.png|border|center|class=tlt-border|868×308px]]
[[File:Mbus scanned devices add.png|border|class=tlt-border]]


===Configuring Flespi.io MQTT Broker===
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==
 
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>.
 
[[File:Mbus status active v2.png|border|class=tlt-border]]
 
===Data collecting groups===
----
----
'''Log in''' or '''create an account''' on '''https://flespi.io''';
To reach data collecting groups configuration press [[File:Pencil2.png]] button. [[File:Add Button.png|60x90px]] button lets you to create a new instance.
 
[[File:Mbus data collect overview.png|border|class=tlt-border]]
 
====Data collecting group instance====
----
 
Each data collection group contains the following information. Configure device accordingly:
 
# '''Enabled''': on
# '''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'''.
 
[[File:Mbus data collect group v2.png|border|class=tlt-border]]


#Navigate to '''MQTT Board''' on the '''left side''' menu;                                       
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:
#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.
[[File:Mbus TEST output.png|border|class=tlt-border]]
[[File:Flespi board.png|border|center|class=tlt-border|1102x729px]]


===Message format for MQTT publisher===
====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:
 
[[File:Mbus edit group values.png|border|class=tlt-border]]


<pre>1 <COOKIE> <SERIAL_DEVICE_ID> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <FIRST_REGISTER> <REGISTER_COUNT> </pre>
There you can adjust additional settings:


The table below explains what each option means:
# '''Enable''': Enable/disable data group value.
# '''FCB toggle''': FCB (Frame Count-Bit), one-bit counter for reliable server-client communication.
# '''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'''


{| class="wikitable"
[[File:Mbus device groupsa.png|border|class=tlt-border]]
|1.  Format version
 
|'''1'''
 
|-
==Sending data to the server==
|2. Cookie
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 desired HTTP or MQTT server.
|from '''0''' to '''2<sup>64</sup> -1'''
 
|-
===Data to Server configuration===
|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"
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'''
[[File:Mbus data to server create.png|border|class=tlt-border]]
|-
|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==
===Data configuration===
====Adding Flespi Subscriber====
----
----
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
Each data collection group contains the following information. Configure device accordingly:
#Select '''''<nowiki/>'Subscriber''''''
 
# In the topic field enter '''''<nowiki/>'response''''''
# '''Name''': desired name of the instance
#Press '''''<nowiki/>'Subscribe'''''' button
# '''Type''': M-Bus data
# '''Format''': custom or JSON depending on a need.


[[File:Flespi subscriber.png|border|class=tlt-border|496x204px]]           [[File:Flespi subscriber setup.png|border|class=tlt-border|496x205px]]
[[File:Mbus data to server configuration.png|border|class=tlt-border]]
====Adding Flespi Subscriber====
 
 
Once finished configuring Data configuration tab click on [[File:Mbus data to server collection edit.png|160x160px]] button.
 
===Collection configuration===
----
----


Also, you will need to '''add a Publisher''':
[[File:Mbus data to server collection configuration.png|border|class=tlt-border]]


#Press '''''<nowiki/>'+'''''' button on the top right corner
Once finished configuring Collection configuration tab click on [[File:Mbus data to server server button.png|160x160px]] button.
#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]]
===Server configuration===
====Flespi Subscriber output====
----
----
Check the response in the '''''<nowiki/>'Subscriber'''''' tab, you should receive a message similar to the one below.
This section contains information on how to configure MQTT and HTTP servers information.


====HTTP configuration====
----


[[File:Flespi response.png|border|center|class=tlt-border|500x305px]]
# '''Type''': HTTP
# '''Server address''': desired server address


'''Note''': not specified fields are optional.
[[File:Mbus data to server HTTP configuration.png|border|class=tlt-border]]
====MQTT configuration====
----
# '''Type''': MQTT
# '''Server address''': desired server address
# '''Topic''': MQTT topic to be used for publishing the data.
'''Note''': not specified fields are optional.
[[File:Mbus data to server MQTT configuration.png|border|class=tlt-border]]
Once finished configuring Server configuration tab click on [[File:Savenapply button.png|Savenapply button.png]] button.
===Results===
----


In the output, we can see that router's '''temperature''' is '''44 degrees Celsius'''.
[[File:Mbus data received v2.png|border|class=tlt-border]]


==See Also==
'''Note''': received data formating depends on the settings you apply under Data to Server and M-Bus configurations.
*[[RUT955 Monitoring via Modbus#Get Parameters]]
*[[RUT955_Modbus#MQTT_Gateway|MQTT Gateway and Modbus]]
==External links==
[https://flespi.io/#/ Flespi.io]

Latest revision as of 07:20, 25 October 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.

Adding M-Bus devices

The 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 → Client. Add a new device to the configuration press button which is shown below.

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

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

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

  • 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:

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

To start the scan click on button.

Found devices

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

You can either (1) M-Bus devices primary address or (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.

Data collecting groups

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

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.

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

Group values

To reach group values configuration press button:

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


Sending data to the server

The 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 desired HTTP or MQTT server.

Data to Server configuration

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

Data configuration

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

  1. Name: desired name of the instance
  2. Type: M-Bus data
  3. Format: custom or JSON depending on a need.


Once finished configuring Data configuration tab click on button.

Collection configuration

Once finished configuring Collection configuration tab click on button.

Server configuration

This section contains information on how to configure MQTT and HTTP servers information.

HTTP configuration

  1. Type: HTTP
  2. Server address: desired server address

Note: not specified fields are optional.

MQTT configuration

  1. Type: MQTT
  2. Server address: desired server address
  3. Topic: MQTT topic to be used for publishing the data.

Note: not specified fields are optional.

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

Results

Note: received data formating depends on the settings you apply under Data to Server and M-Bus configurations.

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