1,108
edits
Changes
no edit summary
__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.
In this guide, the MQTT Serial Gateway function will be configured using third-party MQTT Broker services (in this example, ''Flespi.io'').
==Configuration overview & prerequisites==
==Configuration overview & prerequisites==
*Two RUT955 routers - one acts as Modbus TCP Master, another as Modbus TCP Slave
*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)
*Flespi.io account to act as an MQTT Broker/Publisher/Subscriber (for first configuration example);
==Configuration using flespi.io as MQTT Broker==
==Configuration using flespi.io as MQTT Broker==
[[File:Networking Topology MQTT MODBUS flespi configuration v1.png|center|class=tlt-border|800x800px]]
[[File:MQTT Serial gateway topology.png|border|center|class=tlt-border|847x279px]]
===Configuring RUT955 MQTT Gateway===
===Configuring RUT955 MQTT Gateway===
# '''Enter Password'''.
# '''Enter Password'''.
[[File:MQTT Gateway config.png|border|center|class=tlt-border|862x412px]]
[[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.''
'''Note''': ''Everything else can be left as default or changed according to your needs.''
----
----
Under the MQTT Gateway configuration, create the Serial Gateway:
Under the MQTT Gateway configuration, create the Serial Gateway:
# Enter the desired device ID;
# Enter the '''desired device ID''';
# Select the desired serial interface.
# Select the '''desired serial interface'''.
[[File:Serial gateway config.png|border|center|class=tlt-border|868x308px]]
[[File:Serial gateway config.png|border|center|class=tlt-border|868×308px]]
===Configuring Flespi.io MQTT Broker===
===Configuring Flespi.io MQTT Broker===
----
----
'''Log in''' or '''create an account''' on '''https://flespi.io''';
'''Log in''' or '''create an account''' on '''https://flespi.io''';
#Navigate to '''MQTT Board''' on the '''left side''' menu;
#Navigate to '''MQTT Board''' on the '''left side''' menu;
#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'';
#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;
#In the opened window, press '''"Get flespi token"''' to generate a username;
#Enter the Client name;
#Enter the '''Client name''';
#Copy the Host address;
#Copy the Host address;
#Copy Username;
#Copy '''Username''';
#Create a password.
#Create a '''password'''.
Once done, save all the changes
Once done, save all the changes.
[[File:Flespi board.png|border|center|class=tlt-border|1102x729px]]
[[File:Flespi board.png|border|center|class=tlt-border|1102x729px]]
===Message format for MQTT publisher===
===Message format for MQTT publisher===
----
----
Modbus request data sent in the MQTT payload should be generated in accordance with the following format:
<pre>1 <COOKIE> <SERIAL_DEVICE_ID> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <FIRST_REGISTER> <REGISTER_COUNT/VALUES> </pre>
The table below explains what each option means:
{| class="wikitable"
{| class="wikitable"
|1. Format version
|1. Format version
<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].
<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====
====Examples====
----
----
{| class="wikitable"
{| class="wikitable"
|Setting relay (on) (Relay address is 202, which means 'Number of first register will be 203)
|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'''
|'''1 1 1 1 1 6 203 1'''
|-
|-
|Getting uptime
|Getting temperature
|'''0 65432 0 192.168.1.1 502 5 1 3 2 2'''
|'''1 1 1 1 1 3 6 2'''
|}
|}
===Testing MQTT Publisher and Subscriber on flespi.io===
===Testing MQTT Publisher and Subscriber on flespi.io===
----
----
====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
#Press '''''<nowiki/>'+'''''' button on the top right corner
#Press '''''<nowiki/>'Subscribe'''''' button
#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]]
[[File:Flespi subscriber.png|border|class=tlt-border|496x204px]] [[File:Flespi subscriber setup.png|border|class=tlt-border|496x205px]]
====Adding Flespi Subscriber====
----
Also, you will need to '''add a Publisher''':
#Press '''''<nowiki/>'+'''''' button on the top right corner
#Press '''''<nowiki/>'+'''''' button on the top right corner
#Select '''''<nowiki/>'Publisher''''''
#Select '''''<nowiki/>'Publisher''''''
# In the topic field enter '''''<nowiki/>'request''''''
#In the topic field enter '''''<nowiki/>'request''''''
#In the message field enter message, for this example '''''<nowiki/>'Getting uptime'''''' is used
#In the message field enter message, for this example '''''<nowiki/>'Getting temperature'''''' is used
#Press '''''<nowiki/>'Publish'''''' button
#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]]
[[File:Flespi publisher.png|border|class=tlt-border|495x238px]] [[File:Flespi publisher setup.png|border|class=tlt-border|494x239px]]
====Flespi Subscriber output====
----
Check the response in the '''''<nowiki/>'Subscriber'''''' tab, you should receive a message similar to the one below.
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:Flespi response.png|border|center|class=tlt-border|500x305px]]
In the output, we can see that router's '''temperature''' is '''44 degrees Celsius'''.
==See Also==
==See Also==
*[[Modbus Master RutOS configuration example]]
*[[Modbus Master RutOS configuration example]]
*[[RUT955 Monitoring via Modbus#Get Parameters]]
*[[RUT955_Modbus#MQTT_Gateway|MQTT Gateway]]
==External links==
[https://flespi.io/#/ Flespi.io]
