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, 7 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,15 +1,18 @@ 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 12 13 +== 1.1 Support Devices == 14 + 15 + 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,10 @@ 22 22 23 23 24 24 25 -= 2. Firmware Change Log for MQTT feature = 26 26 29 += 2. Firmware Change Log for MQTT feature = 30 + 31 + 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,31 +33,42 @@ 33 33 34 34 35 35 36 -= 3. MQTT forward operating principle = 37 37 38 -= =3.1NetworkStructure ==42 += 3. MQTT forward operating principle = 39 39 44 + 45 +== 3.1 Network Structure == 46 + 47 + 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 ,50 +* **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. 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. 44 44 53 + 54 + 45 45 [[image:image-20220527133547-1.png]] 46 46 47 47 General MQTT structure 48 48 49 49 50 -== 3.2 How sensor data is forwarded == 51 51 61 +== 3.2 How sensor data is forwarded == 62 + 63 + 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 === 56 56 68 +=== 3.2.1 Upstream === 69 + 70 + 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 ((( 60 60 The data flow works as below diagram. 75 + 76 + 61 61 ))) 62 62 63 63 [[image:image-20220527134000-2.png]] ... ... @@ -64,22 +64,29 @@ 64 64 65 65 ((( 66 66 Upstream path 83 + 84 + 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> 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>** 71 71 ))) 72 72 73 73 ((( 74 74 93 + 94 + 75 75 ))) 76 76 77 -=== 3.2.2 Downstream === 97 +=== 3.2.2 Downstream === 78 78 99 + 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 ((( 82 82 Below are the data flow for downstream. 104 + 105 + 83 83 ))) 84 84 85 85 [[image:image-20220527134038-3.png]] ... ... @@ -87,18 +87,22 @@ 87 87 Downstream path 88 88 89 89 90 -== 3.3 Macro Definition == 91 91 114 +== 3.3 Macro Definition == 115 + 116 + 92 92 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 93 93 94 94 ((( 95 95 Currently the (% style="color:#4f81bd" %)**-t (topic)**(%%) and (% style="color:#4f81bd" %)**-m (message)**(%%) support Macros. 96 96 122 + 97 97 98 98 ))) 99 99 100 -=== 3.3.1 -t topic macro === 126 +=== 3.3.1 -t topic macro === 101 101 128 + 102 102 * CHANNEL: Remote Channel ID 103 103 * CLIENTID: Client ID , Same as -i 104 104 * WRITE_API: Remote Channel Write API ... ... @@ -107,8 +107,10 @@ 107 107 108 108 109 109 110 -=== 3.3.2 -m message macro === 111 111 138 +=== 3.3.2 -m message macro === 139 + 140 + 112 112 * HOSTNAME: Device Hostname 113 113 * CHANNEL: Remote Channel ID 114 114 * DATA: Sensor Data without time stamp and rssi ... ... @@ -117,14 +117,16 @@ 117 117 118 118 119 119 120 -=== 3.3.3 Example for Macro === 121 121 150 +=== 3.3.3 Example for Macro === 151 + 152 + 122 122 [[image:image-20220527134251-4.png]] 123 123 124 124 MQTT Publish configure 125 125 126 126 127 -Above screen shots shows below format: 158 +**Above screen shots shows below format:** 128 128 129 129 * -t: CLIENTID/CHANNEL/data 130 130 * -m: DATA ... ... @@ -141,8 +141,10 @@ 141 141 ))) 142 142 143 143 144 -== 3.4 Modify the MQTT to support more options == 145 145 176 +== 3.4 Modify the MQTT to support more options == 177 + 178 + 146 146 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: 147 147 148 148 (% class="box" %) ... ... @@ -160,9 +160,9 @@ 160 160 [-u username [-P password]] 161 161 [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]] 162 162 [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file] 163 - 164 - 165 - 196 + [~-~-ciphers ciphers] [~-~-insecure] 197 + [~-~-tls-alpn protocol] 198 + [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]] 166 166 [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]] 167 167 [~-~-proxy socks-url] 168 168 [~-~-property command identifier value] ... ... @@ -267,15 +267,20 @@ 267 267 ))) 268 268 269 269 270 -= 4. Example to communicate to a simple MQTT server = 271 271 272 -= =4.1Overview==304 += 4. Example to communicate to a simple MQTT server = 273 273 306 + 307 +== 4.1 Overview == 308 + 309 + 274 274 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/]]. 275 275 276 276 277 -== 4.2 Simulate via MQTT.fx utility == 278 278 314 +== 4.2 Simulate via MQTT.fx utility == 315 + 316 + 279 279 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. 280 280 281 281 ((( ... ... @@ -301,14 +301,16 @@ 301 301 Downstream: Subscribe a topic to get downstream 302 302 303 303 304 -== 4.3 Simulate via Dragino Command Line == 305 305 343 +== 4.3 Simulate via Dragino Command Line == 344 + 345 + 306 306 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. 307 307 308 308 In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection. 309 309 310 310 311 -(% style="color: #4f81bd" %)**For Upstream**351 +(% style="color:blue" %)**For Upstream** 312 312 313 313 command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]] 314 314 ... ... @@ -321,8 +321,9 @@ 321 321 mosquitto_pub 322 322 323 323 324 -(% style="color:#4f81bd" %)**For Downstream** 325 325 365 +(% style="color:blue" %)**For Downstream** 366 + 326 326 Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic. 327 327 328 328 [[image:image-20220527135440-10.png]] ... ... @@ -330,8 +330,10 @@ 330 330 mosquitto_sub 331 331 332 332 333 -== 4.4 Configure Dragino UI for MQTT connection == 334 334 375 +== 4.4 Configure Dragino UI for MQTT connection == 376 + 377 + 335 335 This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection. 336 336 337 337 ((( ... ... @@ -338,10 +338,11 @@ 338 338 Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client** 339 339 ))) 340 340 341 -[[image: https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]]384 +[[image:image-20220714155901-1.png]] 342 342 343 343 go to mqtt configure menu 344 344 388 + 345 345 ((( 346 346 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. 347 347 ))) ... ... @@ -351,24 +351,28 @@ 351 351 forward to MQTT 352 352 353 353 354 -=== 4.4.1 Configure the MQTT Client for Upstream === 355 355 356 - Belowscreenshotis sameasthepublishcommand:399 +=== 4.4.1 Configure the MQTT Client for Upstream === 357 357 401 + 402 +**Below screenshot is same as the publish command:** 403 + 358 358 (% class="box" %) 359 359 ((( 360 -mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA 406 +**mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA 361 361 ~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for 362 362 ~/~/CLIENTID: dragino-1b7060 363 363 ~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456 364 -~/~/DATA: The data stores in /var/iot/channels/ 410 +~/~/DATA: The data stores in /var/iot/channels/** 365 365 ))) 366 366 413 + 367 367 [[image:image-20220527135828-12.png]] 368 368 369 369 MQTT Publish configure 370 370 371 371 419 + 372 372 [[image:image-20220527135929-13.png]] 373 373 374 374 MQTT Channel settings ... ... @@ -397,8 +397,10 @@ 397 397 MQTT Publish 398 398 399 399 400 -=== 4.4.2 Configure the MQTT Client for Downstream === 401 401 449 +=== 4.4.2 Configure the MQTT Client for Downstream === 450 + 451 + 402 402 Below screen shot equal to this subscribe command: 403 403 404 404 (% class="box" %) ... ... @@ -427,13 +427,16 @@ 427 427 downstream simulation 428 428 429 429 430 -== 4.5 Add LoRa support to communicate with remote sensor == 480 +== 4.5 Add LoRa support to communicate with remote sensor == 431 431 482 + 432 432 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. 433 433 434 434 435 -=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 436 436 487 +=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 488 + 489 + 437 437 ((( 438 438 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. 439 439 ))) ... ... @@ -444,6 +444,8 @@ 444 444 445 445 ((( 446 446 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 + 447 447 ))) 448 448 449 449 ((( ... ... @@ -454,11 +454,14 @@ 454 454 * Downstream: Listening broadcast message from gateway, and print it in console. 455 455 * The LoRa parameter settings in Arduino should match the LoRa settings in gateway, as below: 456 456 512 + 513 + 457 457 [[image:image-20220527140354-18.png]] 458 458 459 459 LoRa Parameter should match 460 460 461 461 519 + 462 462 Below is the test result after the Arduino Sketch is running. 463 463 464 464 [[image:image-20220527140459-19.png]] ... ... @@ -466,13 +466,16 @@ 466 466 Upstream Data Flow 467 467 468 468 527 + 469 469 [[image:image-20220527140542-20.png]] 470 470 471 471 Downstream Data Flow 472 472 473 473 474 -=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 475 475 534 +=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 535 + 536 + 476 476 ((( 477 477 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. 478 478 ))) ... ... @@ -479,15 +479,17 @@ 479 479 480 480 ((( 481 481 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. 482 -(% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 543 + 544 + 545 +(% style="color:blue" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 483 483 ))) 484 484 485 485 ((( 486 -(% 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.549 +(% 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. 487 487 ))) 488 488 489 489 ((( 490 -(% style="color: #4f81bd" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.553 +(% style="color:blue" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings. 491 491 ))) 492 492 493 493 [[image:image-20220527141235-21.png]] ... ... @@ -497,62 +497,90 @@ 497 497 498 498 ((( 499 499 ((( 500 -(% 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**563 +(% 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. 501 501 ))) 502 502 ))) 503 503 504 -[[image:image-20220 527141450-22.png]]567 +[[image:image-20220613191345-4.png]] 505 505 506 -Publish mush use META as data format for LG308 507 507 508 508 509 -(% style="color: #4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.571 +(% style="color:blue" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server. 510 510 511 -[[image:image-20220 527141727-23.png]]573 +[[image:image-20220613190635-2.png]] 512 512 513 -Map Dev Addr to remote ID 514 514 515 515 516 -(% style="color: #4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server577 +(% style="color:blue" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server 517 517 518 518 [[image:image-20220527141843-24.png]] 519 519 520 -Upstream Process 521 521 522 522 583 + 523 523 [[image:image-20220527141933-25.png]] 524 524 525 525 Choose ASCII Format 526 526 527 527 589 + 528 528 [[image:image-20220527142028-26.png]] 529 529 530 530 LHT65 Decoder 531 531 532 532 533 -(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream. 534 534 535 - [[image:image-20220527142115-27.png]]596 +(% style="color:blue" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream. 536 536 537 - Subscribetoatopic598 +[[image:image-20220613191426-5.png]] 538 538 539 539 540 -(% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 541 541 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 + 542 542 [[image:image-20220527142239-28.png]] 543 543 544 -Downstream Flow 545 545 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 + 546 546 (% 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"]]** 547 547 548 548 549 - =5.HowtoDebug=633 +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]] 550 550 635 + 636 + 637 += 5. How to Debug = 638 + 639 + 551 551 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. 552 552 553 553 554 -= 6. How to ask for Support = 555 555 644 += 6. How to ask for Support = 645 + 646 + 556 556 If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info: 557 557 558 558 * 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