Domnev: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
No edit summary
No edit summary
 
(21 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, Modbus TCP master MQTT Gateway function will be configured with two different types of MQTT Brokers. First using third-party MQTT Broker services (in this example ''Flespi.io''). Second, using another router as MQTT Broker. Two RUT955 routers will be used as Modbus TCP Master and Slave, and the PC acts as MQTT Publisher and Subscriber.
This article contains instructions on how to send M-Bus data to the server using various protocols.


==Configuration overview & prerequisites==
==Configuration overview & prerequisites==
*Two RUT955 routers - one acts as Modbus TCP Master, another as Modbus TCP 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)
*RUT with a Public IP address to act as MQTT Broker (for second configuration example)
*An end device (PC, Laptop) to act as MQTT Subscriber/Publisher (for second configuration example)


==Configuration using flespi.io as MQTT Broker==
'''Prerequisites''':
[[File:Networking Topology MQTT MODBUS flespi configuration v1.png|center|class=tlt-border|800x800px]]
* TRB143;
* M-Bus device;
* Server;
* An end device (PC, Laptop, Tablet, Smartphone) for configuration;


===Configuring RUT955 MQTT Gateway===
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
| series = RUTX
}}
 
==Adding M-Bus devices==
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 → MQTT Gateway''' and there:
You will be granted to a new window. Configure your M-Bus device accordingly:


# '''Enable''' the '''instance''';
# '''Name''': Enter the desired name of the M-Bus device
# '''Enter Host''' (copied from flespi connection settings without 'wss://' and port);
# '''Address type''': select which M-Bus address will be used
# '''Enter Username''' (Copied from flespi Connection settings generated '''token''');
# '''Primary/Secondary address''': specify M-Bus address
# '''Enter Password'''.


[[File:MQTT Gateway config.png|border|center|class=tlt-border|862x412px]]
[[File:Mbus adding new device configuration v3.png|border|class=tlt-border]]


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


===Configuring RUT955 Serial Gateway===
* If you have specified correct primary/secondary address, you will receive:
----
[[File:Mbus device pingable v2.png|border|class=tlt-border|300px]]
Under the MQTT Gateway configuration, create the Serial Gateway:
 
# Enter the desired device ID;
* 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:
# Select the desired serial interface.
[[File:Mbus device not pingable v2.png|border|class=tlt-border|300px]]


[[File:Serial gateway config.png|border|center|class=tlt-border|868x308px]]
Once finished, save the configuration by clicking [[File:Savenapply button.png|Savenapply button.png]].


===Configuring Flespi.io MQTT Broker===
===Scanning for available M-Bus devices===
----
----


'''Log in''' or '''create an account''' on '''https://flespi.io''';
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.


#Navigate to '''MQTT Board''' on the '''left side''' menu;                                       
====Scan settings====
#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;
You will be granted to a new window. Configure scan settings accordingly:
#Enter the Client name;
#Copy the Host address;
#Copy Username;
#Create a password.


Once done, save all the changes
# '''Scan type''': select which M-Bus address will be scanned
[[File:Flespi board.png|border|center|class=tlt-border|1102x729px]]
# '''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.


===Message format for MQTT publisher===
====Found devices====
----
----
  <b>1 <COOKIE> <SERIAL_DEVICE_ID> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <FIRST_REGISTER> <REGISTER_COUNT/VALUES></b>
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]]


The format is in the text - heavier and slower, but less difficult to edit.
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.
{| 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].
|-
|9.register count
|register count</u> (in range [1..123]); must not exceed the boundary (first register number + register count <= 65537); and <u>register 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 register count); each value must be in the range of [0..65535].
|}


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


====Examples====
===Data collecting groups===
----
----
{| class="wikitable"
To reach data collecting groups configuration press [[File:Pencil2.png]] button. [[File:Add Button.png|60x90px]] button lets you to create a new instance.
|Setting relay (on) (Relay address is 202, which means 'Number of first register will be 203)
 
|'''0 65432 0 192.168.1.1 502 5 1 6 203 1'''
[[File:Mbus data collect overview.png|border|class=tlt-border]]
|-
|Getting uptime
|'''0 65432 0 192.168.1.1 502 5 1 3 2 2'''
|}


===Testing MQTT Publisher and Subscriber on flespi.io===
====Data collecting group instance====
----
----
Log in and navigate to MQTT Board on https://flespi.io


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


#Press '''''<nowiki/>'+'''''' button on the top right corner
# '''Enabled''': on
#Select '''''<nowiki/>'Subscriber''''''
# '''Name''': desired name of the instance
# In the topic field enter '''''<nowiki/>'response''''''
# '''Period''': desired time duration between data retrievals
#Press '''''<nowiki/>'Subscribe'''''' button
# '''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:Networking MQTT Modbus flespi subscriber config1 v1.png|border|class=tlt-border]]            [[File:Networking MQTT Modbus flespi subscriber config2 v1.png|border|class=tlt-border]]
[[File:Mbus data collect group v2.png|border|class=tlt-border]]


Add a Publisher:
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:


#Press '''''<nowiki/>'+'''''' button on the top right corner
[[File:Mbus TEST output.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 uptime'''''' is used
#Press '''''<nowiki/>'Publish'''''' button


[[File:Networking MQTT Modbus flespi publisher config1 v1.png|border|class=tlt-border|434x434px]]          [[File:Networking MQTT Modbus flespi publisher config2 v1.png|border|class=tlt-border|365x365px]]
====Group values====
----
To reach group values configuration press [[File:Pencil2.png]] button:


[[File:Mbus edit group values.png|border|class=tlt-border]]


Check the response in the '''''<nowiki/>'Subscriber'''''' tab, you should receive a message similar to the one below.
There you can adjust additional settings:


# '''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'''


[[File:Networking MQTT Modbus flespi Response v2.png|border|class=tlt-border|931x931px]]
[[File:Mbus device groupsa.png|border|class=tlt-border]]


When the value climbs over 65535 the counter resets and the value held by the first register increases by '''1'''. So one way to interpret the results would be to multiply the value in the first register by '''2<sup>16</sup>''' and add it to the value of the second register. In this example: '''9 * 65536 + 3502 = 593326s''' or '''6 days 20 hours 48 minutes and 46 seconds.'''


''This Means that MQTT Gateway on Modbus TCP Master router is working correctly and Modbus TCP Slave receives requests.''
==Sending data to the server==
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.


==Configuration using a router as MQTT Broker==
===Data to Server configuration===
----
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.


[[File:Networking Topology MQTT MODBUS RUTbroker configuration v1.png|987x987px]]
[[File:Mbus data to server create.png|border|class=tlt-border]]


===Configuring Modbus TCP Master, MQTT Gateway MQTT Broker on RUT240, and MQTT Publisher/Subscriber on PC===
===Data configuration===
----
----
''The same configuration will be used for Modbus TCP Master and Slave RUT955 routers as in the previous example, only settings in Modbus TCP Master router RUT955 will be changed to match MQTT Broker on RUT240 router''


Navigate to '''Services → Modbus  MQTT Gateway'''
Each data collection group contains the following information. Configure device accordingly:
 
# '''Name''': desired name of the instance
# '''Type''': M-Bus data
# '''Format''': custom or JSON depending on a need.
 
[[File:Mbus data to server configuration.png|border|class=tlt-border]]


#'''Enable'''
# Host: '''Enter Public IP address of MQTT Broker (RUT240)'''
#Username: '''N/A'''
#Password: '''N/A'''
#Press '''Save & Apply'''


[[File:Networking MQTT Modbus MQTT gateway config v1.png|border|class=tlt-border|1090x1090px]]
Once finished configuring Data configuration tab click on [[File:Mbus data to server collection edit.png|160x160px]] button.


===Configuring RUT MQTT Broker===
===Collection configuration===
----
----


Navigate to '''Services → MQTT → Broker'''
[[File:Mbus data to server collection configuration.png|border|class=tlt-border]]


#Select '''Enable'''
Once finished configuring Collection configuration tab click on [[File:Mbus data to server server button.png|160x160px]] button.
#Check '''Enable Remote Access'''
#Press '''Save & Apply'''


[[File:Networking MQTT Modbus MQTT Broker RUTos config v1.png|border|class=tlt-border|1079x1079px]]
===Server configuration===
----
This section contains information on how to configure MQTT and HTTP servers information.


===Testing MQTT Gateway===
====HTTP configuration====
----
----


For testing purposes, two terminal windows will be used on the same PC.  
# '''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]]


''To get Ubuntu terminal  on Windows 10/11, refer to the following link for instructions:'' https://tutorials.ubuntu.com/tutorial/tutorial-ubuntu-on-windows#0
====MQTT configuration====
----


*Open first terminal, which will act as '''Subscriber'''. Type in:
# '''Type''': MQTT
# '''Server address''': desired server address
# '''Topic''': MQTT topic to be used for publishing the data.


<blockquote>''mosquitto_sub -h [Host_address] -p [Port] -t [Topic]''</blockquote>[[File:Networking MQTT Modbus Subscriber in terminal v1.png|border|class=tlt-border]]
'''Note''': not specified fields are optional.


*Open second terminal, which will act as '''Publisher.''' Type in:
[[File:Mbus data to server MQTT configuration.png|border|class=tlt-border]]


<blockquote>''mosquitto_pub -h [Host_address] -p [Port] -m [‘Message’] -t [Topic]''</blockquote>[[File:Networking MQTT Modbus Publisher testing v1.png|border|class=tlt-border]]
Once finished configuring Server configuration tab click on [[File:Savenapply button.png|Savenapply button.png]] button.


*On the first window - '''Subscriber''', a response should appear
===Results===
----


[[File:Networking MQTT Modbus Subscriber response ubuntu v1.png|border|class=tlt-border]]
[[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.
*[[Modbus Master RutOS configuration example]]
*[[RUT955 Monitoring via Modbus#Get Parameters]]

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"