Changes for page MQTT Forward Instruction

Last modified by Kilight Cao on 2024/08/31 16:26
<
From version < 37.8 >
edited by Xiaoling
on 2022/06/01 10:44
To version < 44.6 >
edited by Xiaoling
on 2022/07/14 15:57
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,15 +1,17 @@
1 -**~ Contents：**
1 +**~ Table of Contents：**
2 2  
3 3  {{toc/}}
4 4  
5 5  
6 -= 1. Introduction =
6 += 1.  Introduction =
7 7  
8 +
8 8  Dragino LoRa/LoRaWAN gateway support MQTT forwarding. It can forward the sensor data from LoRa network to MQTT server , and vice verse.
9 9  
10 10  
11 -== 1.1 Support Devices ==
12 +== 1.1  Support Devices ==
12 12  
14 +
13 13  This MQTT forward instruction is for below devices:
14 14  
15 15  * Firmware Version > LG02_LG08-5.3.1580178039 [[Firmware Download>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]]
... ... @@ -22,8 +22,9 @@
22 22  
23 23  
24 24  
25 -= 2. Firmware Change Log for MQTT feature =
27 += 2.  Firmware Change Log for MQTT feature =
26 26  
29 +
27 27  (((
28 28  This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware.
29 29  )))
... ... @@ -33,14 +33,16 @@
33 33  
34 34  
35 35  
36 -= 3. MQTT forward operating principle =
39 += 3.  MQTT forward operating principle =
37 37  
38 -== 3.1 Network Structure ==
39 39  
42 +== 3.1  Network Structure ==
43 +
44 +
40 40  Below shows the network structure for MQTT forwarding.
41 41  
42 -* For Uplink: The sensor sends data to LoRa Gateway via LoRa wireless, The gateway will process these data and forward to remote MQTT Broker via Internet.
43 -* For Downlink: The gateway subscribe a topic in the MQTT broker, when there is update on the topic, the gateway will know and broadcast the data to Local LoRa network,
47 +* **For Uplink:**  The sensor sends data to LoRa Gateway via LoRa wireless, The gateway will process these data and forward to remote MQTT Broker via Internet.
48 +* **For Downlink:** The gateway subscribe a topic in the MQTT broker, when there is update on the topic, the gateway will know and broadcast the data to Local LoRa network,
44 44  
45 45  [[image:image-20220527133547-1.png]]
46 46  
... ... @@ -47,12 +47,13 @@
47 47  General MQTT structure
48 48  
49 49  
50 -== 3.2 How sensor data is forwarded ==
55 +== 3.2  How sensor data is forwarded ==
51 51  
57 +
52 52  In this MQTT forward feature, the key point is how the gateway process the sensor data.
53 53  
54 54  
55 -=== 3.2.1 Upstream ===
61 +=== 3.2.1  Upstream ===
56 56  
57 57  Assume there are two sensor nodes, their ID are Node1 ID: 6734 , Node2 ID: 7456. In the remote MQTT broker there are two topics: Topic1: /channel/765800, Topic2: /channel/367860. We can set up in the gateway to map Node1 to Topic1 and Node2 to Topic2. So when there is a sensor data from Node1, the gateway will forward the data to Topic1, when there is sensor data from Node2, the gateway will forward to Topic2.
58 58  
... ... @@ -64,10 +64,12 @@
64 64  
65 65  (((
66 66  Upstream path
73 +
74 +
67 67  )))
68 68  
69 69  (((
70 -Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span>
78 +(% style="color:red" %)**Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span>**
71 71  )))
72 72  
73 73  (((
... ... @@ -74,8 +74,9 @@
74 74  
75 75  )))
76 76  
77 -=== 3.2.2 Downstream ===
85 +=== 3.2.2  Downstream ===
78 78  
87 +
79 79  The gateway subscribes to a topic of the remote MQTT broker topic. When there is some one publish a value on this topic. The gateway will get it and broadcast to local LoRa Network.
80 80  
81 81  (((
... ... @@ -87,8 +87,9 @@
87 87  Downstream path
88 88  
89 89  
90 -== 3.3 Macro Definition ==
99 +== 3.3  Macro Definition ==
91 91  
101 +
92 92  The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish.
93 93  
94 94  (((
... ... @@ -97,8 +97,9 @@
97 97  
98 98  )))
99 99  
100 -=== 3.3.1 -t topic macro ===
110 +=== 3.3.1  -t topic macro ===
101 101  
112 +
102 102  * CHANNEL: Remote Channel ID
103 103  * CLIENTID: Client ID , Same as -i
104 104  * WRITE_API: Remote Channel Write API
... ... @@ -105,8 +105,12 @@
105 105  * USERNAME: User ID (-u)
106 106  * HOSTNAME: Device Hostname
107 107  
108 -=== 3.3.2 -m message macro ===
109 109  
120 +
121 +
122 +=== 3.3.2  -m message macro ===
123 +
124 +
110 110  * HOSTNAME: Device Hostname
111 111  * CHANNEL: Remote Channel ID
112 112  * DATA: Sensor Data without time stamp and rssi
... ... @@ -113,14 +113,19 @@
113 113  * META: Completely sensor data with time stamp and rssi
114 114  * JSON: Convert META to json format.
115 115  
116 -=== 3.3.3 Example for Macro ===
117 117  
132 +
133 +
134 +=== 3.3.3  Example for Macro ===
135 +
136 +
118 118  [[image:image-20220527134251-4.png]]
119 119  
120 120  MQTT Publish configure
121 121  
122 -Above screen shots shows below format:
123 123  
142 +**Above screen shots shows below format:**
143 +
124 124  * -t: CLIENTID/CHANNEL/data
125 125  * -m: DATA
126 126  
... ... @@ -130,13 +130,16 @@
130 130  
131 131  Sensor Data
132 132  
153 +
133 133  (((
134 134  According to above macro. Gateway will publish (% style="color:#4f81bd" %)**field1=22.0&field2=49.0**(%%) to topic: (% style="color:#4f81bd" %)**dragino-1b7060/78901/data**(%%), where 78901 is the remote channel for this node ID.
135 135  )))
136 136  
137 137  
138 -== 3.4 Modify the MQTT to support more options ==
139 139  
160 +== 3.4  Modify the MQTT to support more options ==
161 +
162 +
140 140  The MQTT Client Utility used in Dragino is **mosquitto_pub** and **mosquitto_sub**. User can add more options to the mqtt commands. User can check the valid options by command mosquitto_pub ~-~-help. as below:
141 141  
142 142  (% class="box" %)
... ... @@ -154,9 +154,9 @@
154 154   [-u username [-P password]]
155 155   [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]]
156 156   [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file]
157 - [~-~-ciphers ciphers] [~-~-insecure]
158 - [~-~-tls-alpn protocol]
159 - [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]
180 + [~-~-ciphers ciphers] [~-~-insecure]
181 + [~-~-tls-alpn protocol]
182 + [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]
160 160   [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]]
161 161   [~-~-proxy socks-url]
162 162   [~-~-property command identifier value]
... ... @@ -261,15 +261,19 @@
261 261  )))
262 262  
263 263  
264 -= 4. Example to communicate to a simple MQTT server =
265 265  
266 -== 4.1 Overview ==
288 += 4.  Example to communicate to a simple MQTT server =
267 267  
290 +
291 +== 4.1  Overview ==
292 +
293 +
268 268  This section is an example to show how to set up LG01-N to communicate with a MQTT server. The MQTT server is a simple utility set up in a local PC. Note: User can set up same server via [[this instruction>>url:http://www.steves-internet-guide.com/install-mosquitto-broker/]].
269 269  
270 270  
271 -== 4.2 Simulate via MQTT.fx utility ==
297 +== 4.2  Simulate via MQTT.fx utility ==
272 272  
299 +
273 273  The [[MQTT.fx>>url:http://mqttfx.jensd.de/index.php/download]] is a MQTT client tool. We can use this to simulate a MQTT connection to our MQTT broker first to make sure the MQTT broker works. This will also help us understand how it works.
274 274  
275 275  (((
... ... @@ -295,14 +295,15 @@
295 295  Downstream: Subscribe a topic to get downstream
296 296  
297 297  
298 -== 4.3 Simulate via Dragino Command Line ==
299 299  
326 +== 4.3  Simulate via Dragino Command Line ==
327 +
300 300  For first try of MQTT connection, simulate via command line is recommend, there are many servers / connection type for MQTT. They are using different connection parameters. Simulating the connection via command line will help us rapidly connect to server and debug.
301 301  
302 302  In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection.
303 303  
304 304  
305 -(% style="color:#4f81bd" %)**For Upstream**
333 +(% style="color:blue" %)**For Upstream**
306 306  
307 307  command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]]
308 308  
... ... @@ -315,8 +315,9 @@
315 315  mosquitto_pub
316 316  
317 317  
318 -(% style="color:#4f81bd" %)**For Downstream**
319 319  
347 +(% style="color:blue" %)**For Downstream**
348 +
320 320  Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic.
321 321  
322 322  [[image:image-20220527135440-10.png]]
... ... @@ -336,6 +336,7 @@
336 336  
337 337  go to mqtt configure menu
338 338  
368 +
339 339  (((
340 340  Select (% style="color:#4f81bd" %)**Forward to MQTT server**. (% style="color:red" %)**Notice**(%%): This option is removed from the latest firmware, in the latest firmware, if user submit "SAVE & APPLY" in MQTT page, the gateway will use MQTT service.
341 341  )))
... ... @@ -453,6 +453,7 @@
453 453  LoRa Parameter should match
454 454  
455 455  
486 +
456 456  Below is the test result after the Arduino Sketch is running.
457 457  
458 458  [[image:image-20220527140459-19.png]]
... ... @@ -460,6 +460,7 @@
460 460  Upstream Data Flow
461 461  
462 462  
494 +
463 463  [[image:image-20220527140542-20.png]]
464 464  
465 465  Downstream Data Flow
... ... @@ -491,20 +491,18 @@
491 491  
492 492  (((
493 493  (((
494 -(% style="color:#4f81bd" %)**Step 3**(%%): Set up publish format and MQTT channel. The LG308 will store the Data from End node in (% style="color:#4f81bd" %)**HEX format**(%%) in the file. And we need to config the format to (% style="color:#4f81bd" %)**META**
526 +(% style="color:#4f81bd" %)**Step 3**(%%): Set up publish format and MQTT channel. The LG308 will store the Data from End node in (% style="color:#4f81bd" %)**HEX format**(%%) in the file.
495 495  )))
496 496  )))
497 497  
498 -[[image:image-20220527141450-22.png]]
530 +[[image:image-20220613191345-4.png]]
499 499  
500 -Publish mush use META as data format for LG308
501 501  
502 502  
503 503  (% style="color:#4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
504 504  
505 -[[image:image-20220527141727-23.png]]
536 +[[image:image-20220613190635-2.png]]
506 506  
507 -Map Dev Addr to remote ID
508 508  
509 509  
510 510  (% style="color:#4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
... ... @@ -511,24 +511,25 @@
511 511  
512 512  [[image:image-20220527141843-24.png]]
513 513  
514 -Upstream Process
515 515  
516 516  
546 +
517 517  [[image:image-20220527141933-25.png]]
518 518  
519 519  Choose ASCII Format
520 520  
521 521  
552 +
522 522  [[image:image-20220527142028-26.png]]
523 523  
524 524  LHT65 Decoder
525 525  
526 526  
558 +
527 527  (% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
528 528  
529 -[[image:image-20220527142115-27.png]]
561 +[[image:image-20220613191426-5.png]]
530 530  
531 -Subscribe to a topic
532 532  
533 533  
534 534  (% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
... ... @@ -535,10 +535,32 @@
535 535  
536 536  [[image:image-20220527142239-28.png]]
537 537  
538 -Downstream Flow
539 539  
570 +
571 +=== MQTT Downstream format ===
572 +
573 +
574 +mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**"
575 +
576 +(% class="box infomessage" %)
577 +(((
578 +mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"
579 +)))
580 +
581 +mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**"
582 +
583 +(% class="box infomessage" %)
584 +(((
585 +mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello,20,1,SF12,923300000,2 > /var/iot/push/test"
586 +)))
587 +
588 +Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]]
589 +
590 +[[image:image-20220613192816-6.png||height="440" width="1056"]]
591 +
540 540  (% style="color:red" %)**Notice: The text use for Downstream must meet the requirement from [[LG308 Downstream Payload>>Communicate with ABP End Node without LoRaWAN Network Server --- LG308||anchor="H2.2Downstream"]]**
541 541  
594 +Check out this link for more mosquito-related directives [[https:~~/~~/mosquitto.org/man/mosquitto_pub-1.html>>https://mosquitto.org/man/mosquitto_pub-1.html]]
542 542  
543 543  = 5. How to Debug =
544 544  
image-20220613190254-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +55.7 KB
Content
image-20220613190635-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +44.1 KB
Content
image-20220613191154-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +56.1 KB
Content
image-20220613191345-4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +55.4 KB
Content
image-20220613191426-5.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +55.8 KB
Content
image-20220613192816-6.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +22.1 KB
Content

Applications

Navigation

Copyright ©2010-2022 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0