Changes for page MQTT Forward Instruction

Last modified by Kilight Cao on 2024/08/31 16:26
<
From version < 37.10 >
edited by Xiaoling
on 2022/06/01 10:45
To version < 51.1 >
edited by Xiaoling
on 2024/08/19 15:00
>
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>>doc:Through MQTT to upload data.WebHome]])
18 +* LG01N, OLG01N ((% style="color:red" %)**Warning**(%%): LG01-P LG01-S use another instruction: [[MQTT for LG01-P/LG01S>>doc:Main.Through MQTT to upload data.WebHome]])
17 17  * LG02, OLG02
18 18  * LG308, DLOS8
19 19  * LPS8
... ... @@ -21,8 +21,8 @@
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 23  
26 += 2.  Firmware Change Log for MQTT feature =
24 24  
25 -= 2. Firmware Change Log for MQTT feature =
26 26  
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.
... ... @@ -32,15 +32,15 @@
32 32  ** Initiate version
33 33  
34 34  
37 += 3.  MQTT forward operating principle =
35 35  
36 -= 3. MQTT forward operating principle =
39 +== 3.1  Network Structure ==
37 37  
38 -== 3.1 Network Structure ==
39 39  
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,
44 +* **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.
45 +* **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,13 +47,15 @@
47 47  General MQTT structure
48 48  
49 49  
50 -== 3.2 How sensor data is forwarded ==
52 +== 3.2  How sensor data is forwarded ==
51 51  
54 +
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 ===
58 +=== 3.2.1  Upstream ===
56 56  
60 +
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  
59 59  (((
... ... @@ -64,10 +64,12 @@
64 64  
65 65  (((
66 66  Upstream path
71 +
72 +
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>
76 +(% 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 ===
83 +=== 3.2.2  Downstream ===
78 78  
85 +
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 ==
97 +== 3.3  Macro Definition ==
91 91  
99 +
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 ===
108 +=== 3.3.1  -t topic macro ===
101 101  
110 +
102 102  * CHANNEL: Remote Channel ID
103 103  * CLIENTID: Client ID , Same as -i
104 104  * WRITE_API: Remote Channel Write API
... ... @@ -106,8 +106,8 @@
106 106  * HOSTNAME: Device Hostname
107 107  
108 108  
118 +=== 3.3.2  -m message macro ===
109 109  
110 -=== 3.3.2 -m message macro ===
111 111  
112 112  * HOSTNAME: Device Hostname
113 113  * CHANNEL: Remote Channel ID
... ... @@ -116,15 +116,16 @@
116 116  * JSON: Convert META to json format.
117 117  
118 118  
128 +=== 3.3.3  Example for Macro ===
119 119  
120 -=== 3.3.3 Example for Macro ===
121 121  
122 122  [[image:image-20220527134251-4.png]]
123 123  
124 124  MQTT Publish configure
125 125  
126 -Above screen shots shows below format:
127 127  
136 +**Above screen shots shows below format:**
137 +
128 128  * -t: CLIENTID/CHANNEL/data
129 129  * -m: DATA
130 130  
... ... @@ -134,13 +134,15 @@
134 134  
135 135  Sensor Data
136 136  
147 +
137 137  (((
138 138  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.
139 139  )))
140 140  
141 141  
142 -== 3.4 Modify the MQTT to support more options ==
153 +== 3.4  Modify the MQTT to support more options ==
143 143  
155 +
144 144  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:
145 145  
146 146  (% class="box" %)
... ... @@ -158,9 +158,9 @@
158 158   [-u username [-P password]]
159 159   [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]]
160 160   [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file]
161 - [~-~-ciphers ciphers] [~-~-insecure]
162 - [~-~-tls-alpn protocol]
163 - [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]
173 + [~-~-ciphers ciphers] [~-~-insecure]
174 + [~-~-tls-alpn protocol]
175 + [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]
164 164   [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]]
165 165   [~-~-proxy socks-url]
166 166   [~-~-property command identifier value]
... ... @@ -265,15 +265,17 @@
265 265  )))
266 266  
267 267  
268 -= 4. Example to communicate to a simple MQTT server =
280 += 4.  Example to communicate to a simple MQTT server =
269 269  
270 -== 4.1 Overview ==
282 +== 4.1  Overview ==
271 271  
284 +
272 272  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/]].
273 273  
274 274  
275 -== 4.2 Simulate via MQTT.fx utility ==
288 +== 4.2  Simulate via MQTT.fx utility ==
276 276  
290 +
277 277  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.
278 278  
279 279  (((
... ... @@ -299,14 +299,15 @@
299 299  Downstream: Subscribe a topic to get downstream
300 300  
301 301  
302 -== 4.3 Simulate via Dragino Command Line ==
316 +== 4.3  Simulate via Dragino Command Line ==
303 303  
318 +
304 304  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.
305 305  
306 306  In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection.
307 307  
308 308  
309 -(% style="color:#4f81bd" %)**For Upstream**
324 +(% style="color:blue" %)**For Upstream**
310 310  
311 311  command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]]
312 312  
... ... @@ -319,7 +319,7 @@
319 319  mosquitto_pub
320 320  
321 321  
322 -(% style="color:#4f81bd" %)**For Downstream**
337 +(% style="color:blue" %)**For Downstream**
323 323  
324 324  Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic.
325 325  
... ... @@ -328,8 +328,9 @@
328 328  mosquitto_sub
329 329  
330 330  
331 -== 4.4 Configure Dragino UI for MQTT connection ==
346 +== 4.4  Configure Dragino UI for MQTT connection ==
332 332  
348 +
333 333  This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection.
334 334  
335 335  (((
... ... @@ -336,10 +336,11 @@
336 336  Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client**
337 337  )))
338 338  
339 -[[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]]
355 +[[image:image-20220714155901-1.png]]
340 340  
341 341  go to mqtt configure menu
342 342  
359 +
343 343  (((
344 344  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.
345 345  )))
... ... @@ -349,19 +349,21 @@
349 349  forward to MQTT
350 350  
351 351  
352 -=== 4.4.1 Configure the MQTT Client for Upstream ===
369 +=== 4.4.1  Configure the MQTT Client for Upstream ===
353 353  
354 -Below screenshot is same as the publish command:
355 355  
372 +**Below screenshot is same as the publish command:**
373 +
356 356  (% class="box" %)
357 357  (((
358 -mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA
376 +**mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA
359 359  ~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for
360 360  ~/~/CLIENTID: dragino-1b7060
361 361  ~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456
362 -~/~/DATA: The data stores in /var/iot/channels/
380 +~/~/DATA: The data stores in /var/iot/channels/**
363 363  )))
364 364  
383 +
365 365  [[image:image-20220527135828-12.png]]
366 366  
367 367  MQTT Publish configure
... ... @@ -395,8 +395,9 @@
395 395  MQTT Publish
396 396  
397 397  
398 -=== 4.4.2 Configure the MQTT Client for Downstream ===
417 +=== 4.4.2  Configure the MQTT Client for Downstream ===
399 399  
419 +
400 400  Below screen shot equal to this subscribe command:
401 401  
402 402  (% class="box" %)
... ... @@ -425,13 +425,16 @@
425 425  downstream simulation
426 426  
427 427  
428 -== 4.5 Add LoRa support to communicate with remote sensor ==
448 +== 4.5  Add LoRa support to communicate with remote sensor ==
429 429  
450 +
430 430  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.
431 431  
432 432  
433 -=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
434 434  
455 +=== 4.5.1  Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
456 +
457 +
435 435  (((
436 436  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.
437 437  )))
... ... @@ -442,6 +442,8 @@
442 442  
443 443  (((
444 444  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.
468 +
469 +
445 445  )))
446 446  
447 447  (((
... ... @@ -469,8 +469,9 @@
469 469  Downstream Data Flow
470 470  
471 471  
472 -=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
497 +=== 4.5.2  Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
473 473  
499 +
474 474  (((
475 475  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.
476 476  )))
... ... @@ -477,15 +477,17 @@
477 477  
478 478  (((
479 479  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.
480 -(% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
506 +
507 +
508 +(% style="color:blue" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
481 481  )))
482 482  
483 483  (((
484 -(% 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.
512 +(% style="color:blue" %)**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.
485 485  )))
486 486  
487 487  (((
488 -(% style="color:#4f81bd" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
516 +(% style="color:blue" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
489 489  )))
490 490  
491 491  [[image:image-20220527141235-21.png]]
... ... @@ -495,29 +495,23 @@
495 495  
496 496  (((
497 497  (((
498 -(% 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: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.
499 499  )))
500 500  )))
501 501  
502 -[[image:image-20220527141450-22.png]]
530 +[[image:image-20220613191345-4.png]]
503 503  
504 -Publish mush use META as data format for LG308
505 505  
533 +(% style="color:blue" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
506 506  
507 -(% style="color:#4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
535 +[[image:image-20220613190635-2.png]]
508 508  
509 -[[image:image-20220527141727-23.png]]
510 510  
511 -Map Dev Addr to remote ID
538 +(% style="color:blue" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
512 512  
513 -
514 -(% style="color:#4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
515 -
516 516  [[image:image-20220527141843-24.png]]
517 517  
518 -Upstream Process
519 519  
520 -
521 521  [[image:image-20220527141933-25.png]]
522 522  
523 523  Choose ASCII Format
... ... @@ -528,29 +528,53 @@
528 528  LHT65 Decoder
529 529  
530 530  
531 -(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
553 +(% style="color:blue" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
532 532  
533 -[[image:image-20220527142115-27.png]]
555 +[[image:image-20220613191426-5.png]]
534 534  
535 -Subscribe to a topic
536 536  
558 +(% style="color:blue" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
537 537  
538 -(% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
539 -
540 540  [[image:image-20220527142239-28.png]]
541 541  
542 -Downstream Flow
543 543  
563 +=== 4.5.3 MQTT Downstream format ===
564 +
565 +
566 +mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**"
567 +
568 +(% class="box infomessage" %)
569 +(((
570 +**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"**
571 +)))
572 +
573 +mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**"
574 +
575 +(% class="box infomessage" %)
576 +(((
577 +**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello,20,1,SF12,923300000,2"**
578 +)))
579 +
580 +Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]]
581 +
582 +[[image:image-20220613192816-6.png||height="440" width="1056"]]
583 +
584 +
544 544  (% 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"]]**
545 545  
546 546  
547 -= 5. How to Debug =
588 +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]]
548 548  
590 +
591 += 5.  How to Debug =
592 +
593 +
549 549  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.
550 550  
551 551  
552 -= 6. How to ask for Support =
597 += 6.  How to ask for Support =
553 553  
599 +
554 554  If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info:
555 555  
556 556  * 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