Changes for page MQTT Forward Instruction

Last modified by Kilight Cao on 2024/08/31 16:26
<
From version < 37.5 >
edited by Xiaoling
on 2022/05/31 14:41
To version < 45.2 >
edited by Xiaoling
on 2022/07/14 16:03
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,19 +1,21 @@
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/]]
16 -* LG01N, OLG01N ((% style="color:red" %)**Warning**(%%): LG01-P LG01-S use another instruction: [[MQTT for LG01-P/LG01S>>Through MQTT to upload data]])
18 +* LG01N, OLG01N ((% style="color:red" %)**Warning**(%%): LG01-P LG01-S use another instruction: [[MQTT for LG01-P/LG01S>>doc:Through MQTT to upload data.WebHome]])
17 17  * LG02, OLG02
18 18  * LG308, DLOS8
19 19  * LPS8
... ... @@ -20,8 +20,9 @@
20 20  * LIG16
21 21  * MS14 series if installed with the same firmware. (in this case, the MQTT forward will work , but no LoRa support)
22 22  
23 -= 2. Firmware Change Log for MQTT feature =
25 += 2.  Firmware Change Log for MQTT feature =
24 24  
27 +
25 25  (((
26 26  This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware.
27 27  )))
... ... @@ -29,14 +29,16 @@
29 29  * LG02_LG08-5.3.1580178039
30 30  ** Initiate version
31 31  
32 -= 3. MQTT forward operating principle =
35 += 3.  MQTT forward operating principle =
33 33  
34 -== 3.1 Network Structure ==
35 35  
38 +== 3.1  Network Structure ==
39 +
40 +
36 36  Below shows the network structure for MQTT forwarding.
37 37  
38 -* 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.
39 -* 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,
43 +* **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.
44 +* **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,
40 40  
41 41  [[image:image-20220527133547-1.png]]
42 42  
... ... @@ -43,12 +43,13 @@
43 43  General MQTT structure
44 44  
45 45  
46 -== 3.2 How sensor data is forwarded ==
51 +== 3.2  How sensor data is forwarded ==
47 47  
53 +
48 48  In this MQTT forward feature, the key point is how the gateway process the sensor data.
49 49  
50 50  
51 -=== 3.2.1 Upstream ===
57 +=== 3.2.1  Upstream ===
52 52  
53 53  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.
54 54  
... ... @@ -60,10 +60,12 @@
60 60  
61 61  (((
62 62  Upstream path
69 +
70 +
63 63  )))
64 64  
65 65  (((
66 -Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span>
74 +(% 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>**
67 67  )))
68 68  
69 69  (((
... ... @@ -70,8 +70,9 @@
70 70  
71 71  )))
72 72  
73 -=== 3.2.2 Downstream ===
81 +=== 3.2.2  Downstream ===
74 74  
83 +
75 75  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.
76 76  
77 77  (((
... ... @@ -83,8 +83,9 @@
83 83  Downstream path
84 84  
85 85  
86 -== 3.3 Macro Definition ==
95 +== 3.3  Macro Definition ==
87 87  
97 +
88 88  The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish.
89 89  
90 90  (((
... ... @@ -93,8 +93,9 @@
93 93  
94 94  )))
95 95  
96 -=== 3.3.1 -t topic macro ===
106 +=== 3.3.1  -t topic macro ===
97 97  
108 +
98 98  * CHANNEL: Remote Channel ID
99 99  * CLIENTID: Client ID , Same as -i
100 100  * WRITE_API: Remote Channel Write API
... ... @@ -101,8 +101,10 @@
101 101  * USERNAME: User ID (-u)
102 102  * HOSTNAME: Device Hostname
103 103  
104 -=== 3.3.2 -m message macro ===
105 105  
116 +=== 3.3.2  -m message macro ===
117 +
118 +
106 106  * HOSTNAME: Device Hostname
107 107  * CHANNEL: Remote Channel ID
108 108  * DATA: Sensor Data without time stamp and rssi
... ... @@ -109,14 +109,17 @@
109 109  * META: Completely sensor data with time stamp and rssi
110 110  * JSON: Convert META to json format.
111 111  
112 -=== 3.3.3 Example for Macro ===
113 113  
126 +=== 3.3.3  Example for Macro ===
127 +
128 +
114 114  [[image:image-20220527134251-4.png]]
115 115  
116 116  MQTT Publish configure
117 117  
118 -Above screen shots shows below format:
119 119  
134 +**Above screen shots shows below format:**
135 +
120 120  * -t: CLIENTID/CHANNEL/data
121 121  * -m: DATA
122 122  
... ... @@ -126,13 +126,16 @@
126 126  
127 127  Sensor Data
128 128  
145 +
129 129  (((
130 130  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.
131 131  )))
132 132  
133 133  
134 -== 3.4 Modify the MQTT to support more options ==
135 135  
152 +== 3.4  Modify the MQTT to support more options ==
153 +
154 +
136 136  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:
137 137  
138 138  (% class="box" %)
... ... @@ -150,9 +150,9 @@
150 150   [-u username [-P password]]
151 151   [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]]
152 152   [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file]
153 - [~-~-ciphers ciphers] [~-~-insecure]
154 - [~-~-tls-alpn protocol]
155 - [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]
172 + [~-~-ciphers ciphers] [~-~-insecure]
173 + [~-~-tls-alpn protocol]
174 + [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]
156 156   [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]]
157 157   [~-~-proxy socks-url]
158 158   [~-~-property command identifier value]
... ... @@ -257,15 +257,19 @@
257 257  )))
258 258  
259 259  
260 -= 4. Example to communicate to a simple MQTT server =
261 261  
262 -== 4.1 Overview ==
280 += 4.  Example to communicate to a simple MQTT server =
263 263  
282 +
283 +== 4.1  Overview ==
284 +
285 +
264 264  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/]].
265 265  
266 266  
267 -== 4.2 Simulate via MQTT.fx utility ==
289 +== 4.2  Simulate via MQTT.fx utility ==
268 268  
291 +
269 269  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.
270 270  
271 271  (((
... ... @@ -291,14 +291,15 @@
291 291  Downstream: Subscribe a topic to get downstream
292 292  
293 293  
294 -== 4.3 Simulate via Dragino Command Line ==
295 295  
318 +== 4.3  Simulate via Dragino Command Line ==
319 +
296 296  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.
297 297  
298 298  In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection.
299 299  
300 300  
301 -(% style="color:#4f81bd" %)**For Upstream**
325 +(% style="color:blue" %)**For Upstream**
302 302  
303 303  command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]]
304 304  
... ... @@ -311,8 +311,9 @@
311 311  mosquitto_pub
312 312  
313 313  
314 -(% style="color:#4f81bd" %)**For Downstream**
315 315  
339 +(% style="color:blue" %)**For Downstream**
340 +
316 316  Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic.
317 317  
318 318  [[image:image-20220527135440-10.png]]
... ... @@ -320,7 +320,7 @@
320 320  mosquitto_sub
321 321  
322 322  
323 -== 4.4 Configure Dragino UI for MQTT connection ==
348 +== 4.4  Configure Dragino UI for MQTT connection ==
324 324  
325 325  This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection.
326 326  
... ... @@ -328,10 +328,11 @@
328 328  Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client**
329 329  )))
330 330  
331 -[[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]]
356 +[[image:image-20220714155901-1.png]]
332 332  
333 333  go to mqtt configure menu
334 334  
360 +
335 335  (((
336 336  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.
337 337  )))
... ... @@ -341,24 +341,28 @@
341 341  forward to MQTT
342 342  
343 343  
344 -=== 4.4.1 Configure the MQTT Client for Upstream ===
345 345  
346 -Below screenshot is same as the publish command:
371 +=== 4.4.1  Configure the MQTT Client for Upstream ===
347 347  
373 +
374 +**Below screenshot is same as the publish command:**
375 +
348 348  (% class="box" %)
349 349  (((
350 -mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA
378 +**mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA
351 351  ~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for
352 352  ~/~/CLIENTID: dragino-1b7060
353 353  ~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456
354 -~/~/DATA: The data stores in /var/iot/channels/
382 +~/~/DATA: The data stores in /var/iot/channels/**
355 355  )))
356 356  
385 +
357 357  [[image:image-20220527135828-12.png]]
358 358  
359 359  MQTT Publish configure
360 360  
361 361  
391 +
362 362  [[image:image-20220527135929-13.png]]
363 363  
364 364  MQTT Channel settings
... ... @@ -387,8 +387,10 @@
387 387  MQTT Publish
388 388  
389 389  
390 -=== 4.4.2 Configure the MQTT Client for Downstream ===
391 391  
421 +=== 4.4.2  Configure the MQTT Client for Downstream ===
422 +
423 +
392 392  Below screen shot equal to this subscribe command:
393 393  
394 394  (% class="box" %)
... ... @@ -417,13 +417,15 @@
417 417  downstream simulation
418 418  
419 419  
420 -== 4.5 Add LoRa support to communicate with remote sensor ==
452 +== 4.5  Add LoRa support to communicate with remote sensor ==
421 421  
454 +
422 422  In above section, we have configured the UI to support MQTT upstream and downstream. We can simulate via Linux command. In this section, we will guide how to communicate with remote LoRa End Node for upstream and downstream.
423 423  
424 424  
425 -=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
458 +=== 4.5.1  Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
426 426  
460 +
427 427  (((
428 428  We can use [[LoRa Shield>>url:http://www.dragino.com/products/lora/item/102-lora-shield.html]] to send LoRa Raw data to Gateway and receive data from gateway.
429 429  )))
... ... @@ -434,6 +434,8 @@
434 434  
435 435  (((
436 436  And this link is the required library: [[arduino-LoRa-master>>url:http://www.dragino.com/downloads/index.php?dir=LoraShield/]]. Unzip this library and put in Arduino library location.
471 +
472 +
437 437  )))
438 438  
439 439  (((
... ... @@ -449,6 +449,7 @@
449 449  LoRa Parameter should match
450 450  
451 451  
488 +
452 452  Below is the test result after the Arduino Sketch is running.
453 453  
454 454  [[image:image-20220527140459-19.png]]
... ... @@ -456,13 +456,16 @@
456 456  Upstream Data Flow
457 457  
458 458  
496 +
459 459  [[image:image-20220527140542-20.png]]
460 460  
461 461  Downstream Data Flow
462 462  
463 463  
464 -=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
465 465  
503 +=== 4.5.2  Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
504 +
505 +
466 466  (((
467 467  Since firmware (% style="color:#4f81bd" %)**LG02_LG08~-~-build-v5.3.1585192026-20200326-1109,**(%%) Dragino LoRaWAN gateways support the communication to LoRaWAN (% style="color:#4f81bd" %)**ABP end node**(%%) locally without the need of LoRaWAN server. This feature allow us to integrate MQTT in the gateway to support LoRaWAN to MQTT forwarding or visa verse.
468 468  )))
... ... @@ -469,15 +469,17 @@
469 469  
470 470  (((
471 471  When use test this feature, please use the version higher then : (% style="color:#4f81bd" %)**LG02_LG08~-~-build-v5.4.1593400722-20200629-1120**(%%), in this version, the upload format is changed and readable, which is easier for integration.
512 +
513 +
472 472  (% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
473 473  )))
474 474  
475 475  (((
476 -(% style="color:#4f81bd" %)**Step 1**(%%): Refer [[Communicate with ABP End Node>>Communicate with ABP End Node without LoRaWAN Network Server --- LG308]] to know how to set up LG308 to work with LoRaWAN End node.
518 +(% style="color:blued" %)**Step 1**(%%): Refer [[Communicate with ABP End Node>>Communicate with ABP End Node without LoRaWAN Network Server --- LG308]] to know how to set up LG308 to work with LoRaWAN End node.
477 477  )))
478 478  
479 479  (((
480 -(% style="color:#4f81bd" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
522 +(% style="color:blue" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
481 481  )))
482 482  
483 483  [[image:image-20220527141235-21.png]]
... ... @@ -487,62 +487,89 @@
487 487  
488 488  (((
489 489  (((
490 -(% 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**
532 +(% style="color:blue" %)**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.
491 491  )))
492 492  )))
493 493  
494 -[[image:image-20220527141450-22.png]]
536 +[[image:image-20220613191345-4.png]]
495 495  
496 -Publish mush use META as data format for LG308
497 497  
498 498  
499 -(% style="color:#4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
540 +(% style="color:blue" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
500 500  
501 -[[image:image-20220527141727-23.png]]
542 +[[image:image-20220613190635-2.png]]
502 502  
503 -Map Dev Addr to remote ID
504 504  
505 505  
506 -(% style="color:#4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
546 +(% style="color:blue" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
507 507  
508 508  [[image:image-20220527141843-24.png]]
509 509  
510 -Upstream Process
511 511  
512 512  
552 +
513 513  [[image:image-20220527141933-25.png]]
514 514  
515 515  Choose ASCII Format
516 516  
517 517  
558 +
518 518  [[image:image-20220527142028-26.png]]
519 519  
520 520  LHT65 Decoder
521 521  
522 522  
523 -(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
524 524  
525 -[[image:image-20220527142115-27.png]]
565 +(% style="color:blue" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
526 526  
527 -Subscribe to a topic
567 +[[image:image-20220613191426-5.png]]
528 528  
529 529  
530 -(% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
531 531  
571 +(% style="color:blue" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
572 +
532 532  [[image:image-20220527142239-28.png]]
533 533  
534 -Downstream Flow
535 535  
576 +
577 +=== 4.5.3 MQTT Downstream format ===
578 +
579 +
580 +mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**"
581 +
582 +(% class="box infomessage" %)
583 +(((
584 +**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"**
585 +)))
586 +
587 +mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**"
588 +
589 +(% class="box infomessage" %)
590 +(((
591 +**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"**
592 +)))
593 +
594 +Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]]
595 +
596 +[[image:image-20220613192816-6.png||height="440" width="1056"]]
597 +
598 +
536 536  (% 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"]]**
537 537  
538 538  
539 -= 5. How to Debug =
602 +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]]
540 540  
604 +
605 +
606 += 5.  How to Debug =
607 +
608 +
541 541  User can login the gateway's console and run (% style="color:#4f81bd" %)**logread -f**(%%). It will shows the output when there is packet arrive.User can see if it is correct.
542 542  
543 543  
544 -= 6. How to ask for Support =
612 += 6.  How to ask for Support =
545 545  
614 +
546 546  If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info:
547 547  
548 548  * Detail of your LoRaWAN end node.
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
image-20220714155901-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +75.2 KB
Content

Applications

Navigation

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