Teltonika Networks Wiki

Changes

Domnev (view source)

Revision as of 08:14, 13 September 2023

3,528 bytes added ,  08:14, 13 September 2023
no edit summary
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>
 +
__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 chapter is a guide on configuring cobot.me provider '''hotspot''' instance on RUTX routers.
+
==Configuration overview & prerequisites==
 +
*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);
    +
[[File:MQTT Serial gateway topology v2.png|border|center|class=tlt-border|847x279px]]
   −
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 "Basic" button under "Mode", which is located at the top-right corner of the WebUI.
+
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
   −
==Step 1: cobot.me configuration ==
+
==RUT2 configuration==
−
===Login===
+
===Configuring Modbus RTU Slave===
 
----
 
----
−
First, login into '''cobot.me''' system using our credentials (click '''LOG IN''' in the top right corner). If you don't have a registered account then you need to create one - instead of clicking '''LOG IN''', click '''SIGN UP'''.
+
Go to Services → Modbus → Modbus RTU Slave and create a new instance.
 +
# Enter the '''desired instance name''';
 +
# Select the '''desired serial interface'''.
   −
[[File:LoginCobot.png]]
+
[[File:Modbus RTU Slave.png|border|center|class=tlt-border|855 × 308px]]
   −
====Sign Up====
+
==RUT1 configuration==
 +
===Configuring MQTT Gateway===
 +
----
 +
Go to '''Services → Modbus → MQTT Gateway''' and there:
   −
After clicking '''SIGN UP''' you will be redirected to register page. Enter you account information and click '''Next'''.
+
# '''Enable''' the '''instance''';
 +
# '''Enter Host''' (copied from flespi connection settings without 'wss://' and port);
 +
# '''Enter Username''' (Copied from flespi Connection settings generated '''token''');
 +
# '''Enter Password'''.
   −
[[File:Register1Cobot.png]]
+
[[File:MQTT Gateway config.png|border|center|class=tlt-border|862 × 412px]]
   −
Next step is to enter further information of your account. After entering it click '''Add Space'''.
+
'''Note''': ''Everything else can be left as default or changed according to your needs.''
−
 
  −
[[File:Register2Cobot.png]]
      +
===Configuring Serial Gateway===
 +
----
 +
Under the MQTT Gateway configuration, create the Serial Gateway:
 +
# Enter the '''desired device ID''';
 +
# Select the '''desired serial interface'''.
    +
[[File:Serial gateway config.png|border|center|class=tlt-border|868×308px]]
   −
===Set Up new radius server===
+
===Configuring Flespi.io MQTT Broker===
 
----
 
----
−
In the opened window click '''SETUP''' icon, then - '''Wifi Integration'''. You will be prompted to '''Radius Wifi Integration''' window.
+
'''Log in''' or '''create an account''' on '''https://flespi.io''';
   −
[[File:ClickWifi.png]]
+
#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'';
 +
#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'''.
   −
Click the '''Set up Radius Server''' button in the bottom right corner.
+
Once done, save all the changes.
 +
[[File:Flespi board.png|border|center|class=tlt-border|1102x729px]]
   −
[[File:ClickRadius.png]]
+
===Message format for MQTT publisher===
 +
----
 +
Modbus request data sent in the MQTT payload should be generated in accordance with the following format:
   −
===Network details===
+
<pre>1 <COOKIE> <SERIAL_DEVICE_ID> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <FIRST_REGISTER> <REGISTER_COUNT> </pre>
   −
You will be given your Radius server configuration data that you will need in the next step.
+
The table below explains what each option means:
   −
[[File:RadiusDetails.png]]
+
{| 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].
 +
|}
 +
====Examples====
 +
----
 +
{| class="wikitable"
 +
|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''']].
   −
===Add Wifi Guest Accounts===
+
==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''':
   −
Click '''Wifi Guest Accounts''' in the bottom of the page to add accounts to let users access your wifi.
+
#Press '''''<nowiki/>'+'''''' button on the top right corner
 +
#Select '''''<nowiki/>'Subscriber''''''
 +
# In the topic field enter '''''<nowiki/>'response''''''
 +
#Press '''''<nowiki/>'Subscribe'''''' button
   −
[[File:ClickUsersAcc.png]]
+
[[File:Flespi subscriber.png|border|class=tlt-border|496x204px]]           [[File:Flespi subscriber setup.png|border|class=tlt-border|496x205px]]
 +
====Adding Flespi Subscriber====
 +
----
   −
Type user account information and click '''Add Account'''.
+
Also, you will need to '''add a Publisher''':
   −
[[File:ClickAddUser.png]]
+
#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 temperature'''''' is used
 +
#Press '''''<nowiki/>'Publish'''''' button
   −
At the bottom of the page you can see all your created users.
+
[[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.
   −
[[File:AllUsers.png]]
     −
==Step 2: Router configuration ==
+
[[File:Flespi response.png|border|center|class=tlt-border|500x305px]]
   −
===Log in===
     −
Open your RUT9XX homepage. That can be done by entering 192.168.1.1 in your internet browser's URL bar and log in with your credentials - the default credentials are '''admin''' as Username and '''admin01''' as Password (the address can different - depending if you changed it or not).
+
In the output, we can see that router's '''temperature''' is '''44 degrees Celsius'''.
−
 
  −
===Set up wireless===
  −
 
  −
If you have already set up your wireless access point - skip this step.
  −
 
  −
Open the wireless configuration panel by clicking '''Network → Wireless'''
  −
 
  −
[[File:ClickWireless.png]]
  −
 
  −
Click '''Add'''
  −
 
  −
[[File:ClickAddWireless.png]]
  −
 
  −
Check the '''Enable wireless''' checkbox, enter router's '''SSID''' and for the safety purpose click '''Wireless Security'''.
  −
 
  −
[[File:SetUp1Wireless.png]]
  −
 
  −
Choose your '''Encryption''', enter the '''Key''' and click '''Save'''.
  −
 
  −
[[File:SetUp2Wireless.png]]
  −
 
  −
===Set up hotspot===
  −
 
  −
Open the hotspot configuration panel by clicking '''Services → Hotspot'''
  −
 
  −
[[File:ClickHotspot.png]]
  −
 
  −
Click '''Edit'''
  −
 
  −
[[File:ClickHotspotEdit.png]]
  −
 
  −
Use configuration details from '''Step 1'''.
  −
 
  −
Check '''enable''' box
  −
 
  −
Select '''External radius''' from '''Authentication mode''' dropbox
  −
 
  −
Select '''PAP''' from '''Authentication protocol''' dropbox
  −
 
  −
Type configuration details '''RADIUS Server''', '''Authentication port''', '''Accounting port''' and '''Radius secret key'''
  −
 
  −
And click '''Save'''
  −
 
  −
[[File:HotspotSettings.png]]
  −
 
  −
==Test your Hotspot==
  −
 
  −
Try connecting to your router using computer or mobile phone.
  −
 
  −
Select your router.
  −
 
  −
[[File:FindRouters.png|400px]]
  −
 
  −
After successful connection visit any website. You should be redirected to hotspot login page.
  −
 
  −
Type your username and password.
  −
 
  −
Click '''Login'''
  −
 
  −
[[File:LoginToYourRouter.png|400px]]
  −
 
  −
You should see a message '''Authorization Successful'''
  −
 
  −
[[File:HotspotSuccesss.png|400px]]
      +
==See Also==
 +
*[[RUT955 Monitoring via Modbus#Get Parameters]]
 +
*[[RUT955_Modbus#MQTT_Gateway|MQTT Gateway and Modbus]]
 
==External links==
 
==External links==
−
http://www.cobot.me
+
[https://flespi.io/#/ Flespi.io]
−
 
  −
[[Category:IoT]]
 
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/95539...111434"