|
|
| (12 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===
| |
| − | ----
| |
| − | Go to '''Services → Modbus → MQTT Gateway''' and there:
| |
| | | | |
| − | # '''Enable''' the '''instance''';
| + | {{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer |
| − | # '''Enter Host''' (copied from flespi connection settings without 'wss://' and port);
| + | | series = RUTX |
| − | # '''Enter Username''' (Copied from flespi Connection settings generated '''token''');
| + | }} |
| − | # '''Enter Password'''.
| + | |
| | | | |
| − | [[File:MQTT Gateway config.png|border|center|class=tlt-border|862x412px]] | + | ==Adding M-Bus devices== |
| | + | To add a new device to the configuration press [[File:Add Button.png|60x90px]] button which is shown below. |
| | | | |
| − | '''Note''': ''Everything else can be left as default or changed according to your needs.''
| + | [[File:Mbus adding new device.png||border|class=tlt-border]] |
| | | | |
| − | ===Configuring RUT955 Serial Gateway=== | + | ===Device configuration=== |
| | ---- | | ---- |
| − | Under the MQTT Gateway configuration, create the Serial Gateway:
| + | You will be granted to a new window. Configure your M-Bus device accordingly: |
| − | # Enter the desired device ID;
| |
| − | # Select the desired serial interface.
| |
| | | | |
| − | [[File:Serial gateway config.png|border|center|class=tlt-border|868x308px]]
| + | # '''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 |
| | | | |
| − | ===Configuring Flespi.io MQTT Broker===
| + | [[File:Mbus adding new device configuration v3.png|border|class=tlt-border]] |
| − | ----
| |
| | | | |
| − | '''Log in''' or '''create an account''' on '''https://flespi.io''';
| + | 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: |
| | | | |
| − | #Navigate to '''MQTT Board''' on the '''left side''' menu;
| + | * If you have specified correct primary/secondary address, you will receive: |
| − | #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'';
| + | [[File:Mbus device pingable v2.png|border|class=tlt-border|300px]] |
| − | #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
| + | * 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:Flespi board.png|border|center|class=tlt-border|1102x729px]] | + | [[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]]. |
| | | | |
| − | ===Message format for MQTT publisher=== | + | ===Scanning for available M-Bus devices=== |
| | ---- | | ---- |
| − | <b>1 <COOKIE> <SERIAL_DEVICE_ID> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <FIRST_REGISTER> <REGISTER_COUNT/VALUES></b>
| |
| | | | |
| − | The format is in the text - heavier and slower, but less difficult to edit.
| + | 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. |
| − | {| 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].
| |
| − | |}
| |
| | | | |
| | + | ====Scan settings==== |
| | + | ---- |
| | + | 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. |
| | | | |
| − | ====Examples==== | + | ====Found devices==== |
| | ---- | | ---- |
| − | {| class="wikitable"
| + | Once the scan is finished you should see the list of M-Bus devices that TRB143 were able to find: |
| − | |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'''
| |
| − | |-
| |
| − | |Getting uptime
| |
| − | |'''0 65432 0 192.168.1.1 502 5 1 3 2 2'''
| |
| − | |}
| |
| − | | |
| − | ===Testing MQTT Publisher and Subscriber on flespi.io===
| |
| − | ----
| |
| − | Log in and navigate to MQTT Board on https://flespi.io
| |
| − | | |
| − | 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: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]]
| |
| − | | |
| − | 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 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]]
| |
| − | | |
| − | | |
| − | Check the response in the '''''<nowiki/>'Subscriber'''''' tab, you should receive a message similar to the one below.
| |
| − | | |
| | | | |
| − | [[File:Networking MQTT Modbus flespi Response v2.png|border|class=tlt-border|931x931px]] | + | [[File:Mbus scanned devices add.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.'''
| + | 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. |
| | | | |
| − | ''This Means that MQTT Gateway on Modbus TCP Master router is working correctly and Modbus TCP Slave receives requests.''
| + | ==Gathering M-Bus data== |
| | | | |
| − | ==Configuration using a router as MQTT Broker== | + | 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:Networking Topology MQTT MODBUS RUTbroker configuration v1.png|987x987px]] | + | [[File:Mbus status active v2.png|border|class=tlt-border]] |
| | | | |
| − | ===Configuring Modbus TCP Master, MQTT Gateway MQTT Broker on RUT240, and MQTT Publisher/Subscriber on PC=== | + | ===Data collecting groups=== |
| | ---- | | ---- |
| − | ''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''
| + | To reach data collecting groups configuration press [[File:Pencil2.png]] button. [[File:Add Button.png|60x90px]] button lets you to create a new instance. |
| − | | |
| − | Navigate to '''Services → Modbus MQTT Gateway'''
| |
| | | | |
| − | #'''Enable'''
| + | [[File:Mbus data collect overview.png|border|class=tlt-border]] |
| − | # 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]]
| + | ====Data collecting group instance==== |
| − | | |
| − | ===Configuring RUT MQTT Broker=== | |
| | ---- | | ---- |
| | | | |
| − | Navigate to '''Services → MQTT → Broker'''
| + | Each data collection group contains the following information. Configure device accordingly: |
| | | | |
| − | #Select '''Enable''' | + | # '''Enabled''': on |
| − | #Check '''Enable Remote Access''' | + | # '''Name''': desired name of the instance |
| − | #Press '''Save & Apply''' | + | # '''Period''': desired time duration between data retrievals |
| | + | # '''Data type''': desired data type to process the received data. You can choose from JSON, XML, ASCII, Hexadecimal and Binary formats. |
| | | | |
| − | [[File:Networking MQTT Modbus MQTT Broker RUTos config v1.png|border|class=tlt-border|1079x1079px]] | + | 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. |
| | | | |
| − | ===Testing MQTT Gateway=== | + | [[File:Mbus data collect group v2.png|border|class=tlt-border]] |
| − | ----
| |
| | | | |
| − | For testing purposes, two terminal windows will be used on the same PC.
| |
| | | | |
| − | ''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
| + | ==See Also== |
| | | | |
| − | *Open first terminal, which will act as '''Subscriber'''. Type in:
| + | ==External links== |
| − | | + | [https://flespi.io/#/ Flespi.io] |
| − | <blockquote>''mosquitto_sub -h [Host_address] -p [Port] -t [Topic]''</blockquote>[[File:Networking MQTT Modbus Subscriber in terminal v1.png|border|class=tlt-border]]
| |
| − | | |
| − | *Open second terminal, which will act as '''Publisher.''' Type in:
| |
| − | | |
| − | <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]]
| |
| − | | |
| − | *On the first window - '''Subscriber''', a response should appear
| |
| − | | |
| − | [[File:Networking MQTT Modbus Subscriber response ubuntu v1.png|border|class=tlt-border]] | |
| − | | |
| − | ==See Also==
| |
| − | *[[Modbus Master RutOS configuration example]]
| |
| − | *[[RUT955 Monitoring via Modbus#Get Parameters]]
| |
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
To 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:
- 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
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 
.
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:
- 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.
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:
- 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. You can choose from JSON, XML, ASCII, Hexadecimal and Binary formats.
You can check if your configuration works accordingly by pressing the 
button. You should see the data in a pop-up field.
See Also
External links
Flespi.io
button which is shown below.
. You might get on of two outputs:
.
button.
button.
(1) M-Bus devices primary address or 
button. You should see the data in a pop-up field.
