Changes for page MQTT Forward Instruction
Last modified by Kilight Cao on 2024/08/31 16:26
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 7 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,18 +1,15 @@ 1 -**~ Table ofContents:**1 +**~ Contents:** 2 2 3 3 {{toc/}} 4 4 5 5 6 -= 1. 6 += 1. Introduction = 7 7 8 - 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 11 +== 1.1 Support Devices == 12 12 13 -== 1.1 Support Devices == 14 - 15 - 16 16 This MQTT forward instruction is for below devices: 17 17 18 18 * Firmware Version > LG02_LG08-5.3.1580178039 [[Firmware Download>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]] ... ... @@ -25,10 +25,8 @@ 25 25 26 26 27 27 25 += 2. Firmware Change Log for MQTT feature = 28 28 29 -= 2. Firmware Change Log for MQTT feature = 30 - 31 - 32 32 ((( 33 33 This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware. 34 34 ))) ... ... @@ -38,42 +38,31 @@ 38 38 39 39 40 40 36 += 3. MQTT forward operating principle = 41 41 42 -= 3. MQTT forwardoperatingprinciple =38 +== 3.1 Network Structure == 43 43 44 - 45 -== 3.1 Network Structure == 46 - 47 - 48 48 Below shows the network structure for MQTT forwarding. 49 49 50 -* **For Uplink:**51 -* **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.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, 52 52 53 - 54 - 55 55 [[image:image-20220527133547-1.png]] 56 56 57 57 General MQTT structure 58 58 59 59 50 +== 3.2 How sensor data is forwarded == 60 60 61 -== 3.2 How sensor data is forwarded == 62 - 63 - 64 64 In this MQTT forward feature, the key point is how the gateway process the sensor data. 65 65 66 66 55 +=== 3.2.1 Upstream === 67 67 68 -=== 3.2.1 Upstream === 69 - 70 - 71 71 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. 72 72 73 73 ((( 74 74 The data flow works as below diagram. 75 - 76 - 77 77 ))) 78 78 79 79 [[image:image-20220527134000-2.png]] ... ... @@ -80,29 +80,22 @@ 80 80 81 81 ((( 82 82 Upstream path 83 - 84 - 85 85 ))) 86 86 87 87 ((( 88 - (% 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>**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> 89 89 ))) 90 90 91 91 ((( 92 92 93 - 94 - 95 95 ))) 96 96 97 -=== 3.2.2 77 +=== 3.2.2 Downstream === 98 98 99 - 100 100 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. 101 101 102 102 ((( 103 103 Below are the data flow for downstream. 104 - 105 - 106 106 ))) 107 107 108 108 [[image:image-20220527134038-3.png]] ... ... @@ -110,22 +110,18 @@ 110 110 Downstream path 111 111 112 112 90 +== 3.3 Macro Definition == 113 113 114 -== 3.3 Macro Definition == 115 - 116 - 117 117 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 118 118 119 119 ((( 120 120 Currently the (% style="color:#4f81bd" %)**-t (topic)**(%%) and (% style="color:#4f81bd" %)**-m (message)**(%%) support Macros. 121 121 122 - 123 123 124 124 ))) 125 125 126 -=== 3.3.1 100 +=== 3.3.1 -t topic macro === 127 127 128 - 129 129 * CHANNEL: Remote Channel ID 130 130 * CLIENTID: Client ID , Same as -i 131 131 * WRITE_API: Remote Channel Write API ... ... @@ -134,10 +134,8 @@ 134 134 135 135 136 136 110 +=== 3.3.2 -m message macro === 137 137 138 -=== 3.3.2 -m message macro === 139 - 140 - 141 141 * HOSTNAME: Device Hostname 142 142 * CHANNEL: Remote Channel ID 143 143 * DATA: Sensor Data without time stamp and rssi ... ... @@ -146,17 +146,14 @@ 146 146 147 147 148 148 120 +=== 3.3.3 Example for Macro === 149 149 150 -=== 3.3.3 Example for Macro === 151 - 152 - 153 153 [[image:image-20220527134251-4.png]] 154 154 155 155 MQTT Publish configure 156 156 126 +Above screen shots shows below format: 157 157 158 -**Above screen shots shows below format:** 159 - 160 160 * -t: CLIENTID/CHANNEL/data 161 161 * -m: DATA 162 162 ... ... @@ -166,16 +166,13 @@ 166 166 167 167 Sensor Data 168 168 169 - 170 170 ((( 171 171 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. 172 172 ))) 173 173 174 174 142 +== 3.4 Modify the MQTT to support more options == 175 175 176 -== 3.4 Modify the MQTT to support more options == 177 - 178 - 179 179 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: 180 180 181 181 (% class="box" %) ... ... @@ -193,9 +193,9 @@ 193 193 [-u username [-P password]] 194 194 [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]] 195 195 [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file] 196 - [~-~-ciphers ciphers] [~-~-insecure] 197 - [~-~-tls-alpn protocol] 198 - [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]] 161 + [~-~-ciphers ciphers] [~-~-insecure] 162 + [~-~-tls-alpn protocol] 163 + [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]] 199 199 [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]] 200 200 [~-~-proxy socks-url] 201 201 [~-~-property command identifier value] ... ... @@ -300,20 +300,15 @@ 300 300 ))) 301 301 302 302 268 += 4. Example to communicate to a simple MQTT server = 303 303 304 -= 4. Exampleto communicate to a simple MQTT server=270 +== 4.1 Overview == 305 305 306 - 307 -== 4.1 Overview == 308 - 309 - 310 310 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/]]. 311 311 312 312 275 +== 4.2 Simulate via MQTT.fx utility == 313 313 314 -== 4.2 Simulate via MQTT.fx utility == 315 - 316 - 317 317 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. 318 318 319 319 ((( ... ... @@ -339,16 +339,14 @@ 339 339 Downstream: Subscribe a topic to get downstream 340 340 341 341 302 +== 4.3 Simulate via Dragino Command Line == 342 342 343 -== 4.3 Simulate via Dragino Command Line == 344 - 345 - 346 346 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. 347 347 348 348 In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection. 349 349 350 350 351 -(% style="color:b lue" %)**For Upstream**309 +(% style="color:#4f81bd" %)**For Upstream** 352 352 353 353 command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]] 354 354 ... ... @@ -361,9 +361,8 @@ 361 361 mosquitto_pub 362 362 363 363 322 +(% style="color:#4f81bd" %)**For Downstream** 364 364 365 -(% style="color:blue" %)**For Downstream** 366 - 367 367 Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic. 368 368 369 369 [[image:image-20220527135440-10.png]] ... ... @@ -371,10 +371,8 @@ 371 371 mosquitto_sub 372 372 373 373 331 +== 4.4 Configure Dragino UI for MQTT connection == 374 374 375 -== 4.4 Configure Dragino UI for MQTT connection == 376 - 377 - 378 378 This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection. 379 379 380 380 ((( ... ... @@ -381,11 +381,10 @@ 381 381 Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client** 382 382 ))) 383 383 384 -[[image:image -20220714155901-1.png]]339 +[[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]] 385 385 386 386 go to mqtt configure menu 387 387 388 - 389 389 ((( 390 390 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. 391 391 ))) ... ... @@ -395,28 +395,24 @@ 395 395 forward to MQTT 396 396 397 397 352 +=== 4.4.1 Configure the MQTT Client for Upstream === 398 398 399 - === 4.4.1 Configure theMQTT Clientfor Upstream===354 +Below screenshot is same as the publish command: 400 400 401 - 402 -**Below screenshot is same as the publish command:** 403 - 404 404 (% class="box" %) 405 405 ((( 406 - **mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA358 +mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA 407 407 ~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for 408 408 ~/~/CLIENTID: dragino-1b7060 409 409 ~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456 410 -~/~/DATA: The data stores in /var/iot/channels/ **362 +~/~/DATA: The data stores in /var/iot/channels/ 411 411 ))) 412 412 413 - 414 414 [[image:image-20220527135828-12.png]] 415 415 416 416 MQTT Publish configure 417 417 418 418 419 - 420 420 [[image:image-20220527135929-13.png]] 421 421 422 422 MQTT Channel settings ... ... @@ -445,10 +445,8 @@ 445 445 MQTT Publish 446 446 447 447 398 +=== 4.4.2 Configure the MQTT Client for Downstream === 448 448 449 -=== 4.4.2 Configure the MQTT Client for Downstream === 450 - 451 - 452 452 Below screen shot equal to this subscribe command: 453 453 454 454 (% class="box" %) ... ... @@ -477,16 +477,13 @@ 477 477 downstream simulation 478 478 479 479 480 -== 4.5 428 +== 4.5 Add LoRa support to communicate with remote sensor == 481 481 482 - 483 483 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. 484 484 485 485 433 +=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 486 486 487 -=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 488 - 489 - 490 490 ((( 491 491 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. 492 492 ))) ... ... @@ -497,8 +497,6 @@ 497 497 498 498 ((( 499 499 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. 500 - 501 - 502 502 ))) 503 503 504 504 ((( ... ... @@ -509,14 +509,11 @@ 509 509 * Downstream: Listening broadcast message from gateway, and print it in console. 510 510 * The LoRa parameter settings in Arduino should match the LoRa settings in gateway, as below: 511 511 512 - 513 - 514 514 [[image:image-20220527140354-18.png]] 515 515 516 516 LoRa Parameter should match 517 517 518 518 519 - 520 520 Below is the test result after the Arduino Sketch is running. 521 521 522 522 [[image:image-20220527140459-19.png]] ... ... @@ -524,16 +524,13 @@ 524 524 Upstream Data Flow 525 525 526 526 527 - 528 528 [[image:image-20220527140542-20.png]] 529 529 530 530 Downstream Data Flow 531 531 532 532 472 +=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 533 533 534 -=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 535 - 536 - 537 537 ((( 538 538 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. 539 539 ))) ... ... @@ -540,17 +540,15 @@ 540 540 541 541 ((( 542 542 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. 543 - 544 - 545 -(% style="color:blue" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 480 +(% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 546 546 ))) 547 547 548 548 ((( 549 -(% style="color:b lue" %)**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.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. 550 550 ))) 551 551 552 552 ((( 553 -(% style="color:b lue" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.488 +(% style="color:#4f81bd" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings. 554 554 ))) 555 555 556 556 [[image:image-20220527141235-21.png]] ... ... @@ -560,90 +560,62 @@ 560 560 561 561 ((( 562 562 ((( 563 -(% style="color:b lue" %)**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.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** 564 564 ))) 565 565 ))) 566 566 567 -[[image:image-20220 613191345-4.png]]502 +[[image:image-20220527141450-22.png]] 568 568 504 +Publish mush use META as data format for LG308 569 569 570 570 571 -(% style="color:b lue" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.507 +(% style="color:#4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server. 572 572 573 -[[image:image-20220 613190635-2.png]]509 +[[image:image-20220527141727-23.png]] 574 574 511 +Map Dev Addr to remote ID 575 575 576 576 577 -(% style="color:b lue" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server514 +(% style="color:#4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server 578 578 579 579 [[image:image-20220527141843-24.png]] 580 580 518 +Upstream Process 581 581 582 582 583 - 584 584 [[image:image-20220527141933-25.png]] 585 585 586 586 Choose ASCII Format 587 587 588 588 589 - 590 590 [[image:image-20220527142028-26.png]] 591 591 592 592 LHT65 Decoder 593 593 594 594 531 +(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream. 595 595 596 - (% style="color:blue" %)**Step 6: Set up subscribe**(%%)**:** Subscribeatopci for downstream.533 +[[image:image-20220527142115-27.png]] 597 597 598 - [[image:image-20220613191426-5.png]]535 +Subscribe to a topic 599 599 600 600 538 +(% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 601 601 602 -(% style="color:blue" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 603 - 604 604 [[image:image-20220527142239-28.png]] 605 605 542 +Downstream Flow 606 606 607 - 608 -=== 4.5.3 MQTT Downstream format === 609 - 610 - 611 -mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**" 612 - 613 -(% class="box infomessage" %) 614 -((( 615 -**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"** 616 -))) 617 - 618 -mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**" 619 - 620 -(% class="box infomessage" %) 621 -((( 622 -**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello,20,1,SF12,923300000,2"** 623 -))) 624 - 625 -Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]] 626 - 627 -[[image:image-20220613192816-6.png||height="440" width="1056"]] 628 - 629 - 630 630 (% 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"]]** 631 631 632 632 633 - Checkoutthis link formore mosquito-relateddirectives [[https:~~/~~/mosquitto.org/man/mosquitto_pub-1.html>>https://mosquitto.org/man/mosquitto_pub-1.html]]547 += 5. How to Debug = 634 634 635 - 636 - 637 -= 5. How to Debug = 638 - 639 - 640 640 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. 641 641 642 642 552 += 6. How to ask for Support = 643 643 644 -= 6. How to ask for Support = 645 - 646 - 647 647 If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info: 648 648 649 649 * Detail of your LoRaWAN end node.
- image-20220613190254-1.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.Kilight - Size
-
... ... @@ -1,1 +1,0 @@ 1 -55.7 KB - Content
- image-20220613190635-2.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.Kilight - Size
-
... ... @@ -1,1 +1,0 @@ 1 -44.1 KB - Content
- image-20220613191154-3.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.Kilight - Size
-
... ... @@ -1,1 +1,0 @@ 1 -56.1 KB - Content
- image-20220613191345-4.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.Kilight - Size
-
... ... @@ -1,1 +1,0 @@ 1 -55.4 KB - Content
- image-20220613191426-5.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.Kilight - Size
-
... ... @@ -1,1 +1,0 @@ 1 -55.8 KB - Content
- image-20220613192816-6.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.Kilight - Size
-
... ... @@ -1,1 +1,0 @@ 1 -22.1 KB - Content
- image-20220714155901-1.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.Xiaoling - Size
-
... ... @@ -1,1 +1,0 @@ 1 -75.2 KB - Content