Changes for page MQTT Forward Instruction

Last modified by Kilight Cao on 2024/08/31 16:26
<
From version < 44.5 >
edited by Xiaoling
on 2022/07/14 15:55
To version < 50.1 >
edited by Xiaoling
on 2022/09/02 18:11
>
Change comment: Renamed back-links.

Summary

Details

Page properties
Content
... ... @@ -9,6 +9,7 @@
9 9  Dragino LoRa/LoRaWAN gateway support MQTT forwarding. It can forward the sensor data from LoRa network to MQTT server , and vice verse.
10 10  
11 11  
12 +
12 12  == 1.1  Support Devices ==
13 13  
14 14  
... ... @@ -15,7 +15,7 @@
15 15  This MQTT forward instruction is for below devices:
16 16  
17 17  * Firmware Version > LG02_LG08-5.3.1580178039 [[Firmware Download>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]]
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]])
19 +* 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]])
19 19  * LG02, OLG02
20 20  * LG308, DLOS8
21 21  * LPS8
... ... @@ -45,13 +45,15 @@
45 45  Below shows the network structure for MQTT forwarding.
46 46  
47 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,
49 +* **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.
49 49  
51 +
50 50  [[image:image-20220527133547-1.png]]
51 51  
52 52  General MQTT structure
53 53  
54 54  
57 +
55 55  == 3.2  How sensor data is forwarded ==
56 56  
57 57  
... ... @@ -58,12 +58,16 @@
58 58  In this MQTT forward feature, the key point is how the gateway process the sensor data.
59 59  
60 60  
64 +
61 61  === 3.2.1  Upstream ===
62 62  
67 +
63 63  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.
64 64  
65 65  (((
66 66  The data flow works as below diagram.
72 +
73 +
67 67  )))
68 68  
69 69  [[image:image-20220527134000-2.png]]
... ... @@ -80,6 +80,8 @@
80 80  
81 81  (((
82 82  
90 +
91 +
83 83  )))
84 84  
85 85  === 3.2.2  Downstream ===
... ... @@ -89,6 +89,8 @@
89 89  
90 90  (((
91 91  Below are the data flow for downstream.
101 +
102 +
92 92  )))
93 93  
94 94  [[image:image-20220527134038-3.png]]
... ... @@ -96,6 +96,7 @@
96 96  Downstream path
97 97  
98 98  
110 +
99 99  == 3.3  Macro Definition ==
100 100  
101 101  
... ... @@ -104,6 +104,7 @@
104 104  (((
105 105  Currently the (% style="color:#4f81bd" %)**-t (topic)**(%%) and (% style="color:#4f81bd" %)**-m (message)**(%%) support Macros.
106 106  
119 +
107 107  
108 108  )))
109 109  
... ... @@ -118,7 +118,6 @@
118 118  
119 119  
120 120  
121 -
122 122  === 3.3.2  -m message macro ===
123 123  
124 124  
... ... @@ -130,7 +130,6 @@
130 130  
131 131  
132 132  
133 -
134 134  === 3.3.3  Example for Macro ===
135 135  
136 136  
... ... @@ -284,15 +284,20 @@
284 284  )))
285 285  
286 286  
287 -= 4. Example to communicate to a simple MQTT server =
288 288  
289 -== 4.1 Overview ==
299 += 4.  Example to communicate to a simple MQTT server =
290 290  
301 +
302 +== 4.1  Overview ==
303 +
304 +
291 291  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/]].
292 292  
293 293  
294 -== 4.2 Simulate via MQTT.fx utility ==
295 295  
309 +== 4.2  Simulate via MQTT.fx utility ==
310 +
311 +
296 296  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.
297 297  
298 298  (((
... ... @@ -318,14 +318,16 @@
318 318  Downstream: Subscribe a topic to get downstream
319 319  
320 320  
321 -== 4.3 Simulate via Dragino Command Line ==
322 322  
338 +== 4.3  Simulate via Dragino Command Line ==
339 +
340 +
323 323  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.
324 324  
325 325  In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection.
326 326  
327 327  
328 -(% style="color:#4f81bd" %)**For Upstream**
346 +(% style="color:blue" %)**For Upstream**
329 329  
330 330  command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]]
331 331  
... ... @@ -338,8 +338,9 @@
338 338  mosquitto_pub
339 339  
340 340  
341 -(% style="color:#4f81bd" %)**For Downstream**
342 342  
360 +(% style="color:blue" %)**For Downstream**
361 +
343 343  Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic.
344 344  
345 345  [[image:image-20220527135440-10.png]]
... ... @@ -347,8 +347,10 @@
347 347  mosquitto_sub
348 348  
349 349  
350 -== 4.4 Configure Dragino UI for MQTT connection ==
351 351  
370 +== 4.4  Configure Dragino UI for MQTT connection ==
371 +
372 +
352 352  This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection.
353 353  
354 354  (((
... ... @@ -355,7 +355,7 @@
355 355  Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client**
356 356  )))
357 357  
358 -[[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]]
379 +[[image:image-20220714155901-1.png]]
359 359  
360 360  go to mqtt configure menu
361 361  
... ... @@ -369,24 +369,28 @@
369 369  forward to MQTT
370 370  
371 371  
372 -=== 4.4.1 Configure the MQTT Client for Upstream ===
373 373  
374 -Below screenshot is same as the publish command:
394 +=== 4.4.1  Configure the MQTT Client for Upstream ===
375 375  
396 +
397 +**Below screenshot is same as the publish command:**
398 +
376 376  (% class="box" %)
377 377  (((
378 -mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA
401 +**mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA
379 379  ~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for
380 380  ~/~/CLIENTID: dragino-1b7060
381 381  ~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456
382 -~/~/DATA: The data stores in /var/iot/channels/
405 +~/~/DATA: The data stores in /var/iot/channels/**
383 383  )))
384 384  
408 +
385 385  [[image:image-20220527135828-12.png]]
386 386  
387 387  MQTT Publish configure
388 388  
389 389  
414 +
390 390  [[image:image-20220527135929-13.png]]
391 391  
392 392  MQTT Channel settings
... ... @@ -415,8 +415,10 @@
415 415  MQTT Publish
416 416  
417 417  
418 -=== 4.4.2 Configure the MQTT Client for Downstream ===
419 419  
444 +=== 4.4.2  Configure the MQTT Client for Downstream ===
445 +
446 +
420 420  Below screen shot equal to this subscribe command:
421 421  
422 422  (% class="box" %)
... ... @@ -445,13 +445,16 @@
445 445  downstream simulation
446 446  
447 447  
448 -== 4.5 Add LoRa support to communicate with remote sensor ==
475 +== 4.5  Add LoRa support to communicate with remote sensor ==
449 449  
477 +
450 450  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.
451 451  
452 452  
453 -=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
454 454  
482 +=== 4.5.1  Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
483 +
484 +
455 455  (((
456 456  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.
457 457  )))
... ... @@ -462,6 +462,8 @@
462 462  
463 463  (((
464 464  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.
495 +
496 +
465 465  )))
466 466  
467 467  (((
... ... @@ -472,6 +472,7 @@
472 472  * Downstream: Listening broadcast message from gateway, and print it in console.
473 473  * The LoRa parameter settings in Arduino should match the LoRa settings in gateway, as below:
474 474  
507 +
475 475  [[image:image-20220527140354-18.png]]
476 476  
477 477  LoRa Parameter should match
... ... @@ -491,8 +491,10 @@
491 491  Downstream Data Flow
492 492  
493 493  
494 -=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
495 495  
528 +=== 4.5.2  Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
529 +
530 +
496 496  (((
497 497  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.
498 498  )))
... ... @@ -499,15 +499,17 @@
499 499  
500 500  (((
501 501  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.
502 -(% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
537 +
538 +
539 +(% style="color:blue" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
503 503  )))
504 504  
505 505  (((
506 -(% 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.
543 +(% 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.
507 507  )))
508 508  
509 509  (((
510 -(% style="color:#4f81bd" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
547 +(% style="color:blue" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
511 511  )))
512 512  
513 513  [[image:image-20220527141235-21.png]]
... ... @@ -517,7 +517,7 @@
517 517  
518 518  (((
519 519  (((
520 -(% 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.
557 +(% 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.
521 521  )))
522 522  )))
523 523  
... ... @@ -525,13 +525,13 @@
525 525  
526 526  
527 527  
528 -(% style="color:#4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
565 +(% style="color:blue" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
529 529  
530 530  [[image:image-20220613190635-2.png]]
531 531  
532 532  
533 533  
534 -(% style="color:#4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
571 +(% style="color:blue" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
535 535  
536 536  [[image:image-20220527141843-24.png]]
537 537  
... ... @@ -550,19 +550,19 @@
550 550  
551 551  
552 552  
553 -(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
590 +(% style="color:blue" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
554 554  
555 555  [[image:image-20220613191426-5.png]]
556 556  
557 557  
558 558  
559 -(% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
596 +(% style="color:blue" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
560 560  
561 561  [[image:image-20220527142239-28.png]]
562 562  
563 563  
564 564  
565 -=== MQTT Downstream format ===
602 +=== 4.5.3 MQTT Downstream format ===
566 566  
567 567  
568 568  mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**"
... ... @@ -569,7 +569,7 @@
569 569  
570 570  (% class="box infomessage" %)
571 571  (((
572 -mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"
609 +**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"**
573 573  )))
574 574  
575 575  mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**"
... ... @@ -576,7 +576,7 @@
576 576  
577 577  (% class="box infomessage" %)
578 578  (((
579 -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"
616 +**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello,20,1,SF12,923300000,2"**
580 580  )))
581 581  
582 582  Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]]
... ... @@ -583,17 +583,24 @@
583 583  
584 584  [[image:image-20220613192816-6.png||height="440" width="1056"]]
585 585  
623 +
586 586  (% 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"]]**
587 587  
626 +
588 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]]
589 589  
590 -= 5. How to Debug =
591 591  
630 +
631 += 5.  How to Debug =
632 +
633 +
592 592  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.
593 593  
594 594  
595 -= 6. How to ask for Support =
596 596  
638 += 6.  How to ask for Support =
639 +
640 +
597 597  If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info:
598 598  
599 599  * Detail of your LoRaWAN end node.
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