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,17 +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 12 -== 1.1 11 +== 1.1 Support Devices == 13 13 14 - 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/]] ... ... @@ -22,11 +22,8 @@ 22 22 * LIG16 23 23 * MS14 series if installed with the same firmware. (in this case, the MQTT forward will work , but no LoRa support) 24 24 23 += 2. Firmware Change Log for MQTT feature = 25 25 26 - 27 -= 2. Firmware Change Log for MQTT feature = 28 - 29 - 30 30 ((( 31 31 This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware. 32 32 ))) ... ... @@ -34,41 +34,31 @@ 34 34 * LG02_LG08-5.3.1580178039 35 35 ** Initiate version 36 36 32 += 3. MQTT forward operating principle = 37 37 34 +== 3.1 Network Structure == 38 38 39 -= 3. MQTT forward operating principle = 40 - 41 - 42 -== 3.1 Network Structure == 43 - 44 - 45 45 Below shows the network structure for MQTT forwarding. 46 46 47 -* **For Uplink:**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.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, 49 49 50 - 51 51 [[image:image-20220527133547-1.png]] 52 52 53 53 General MQTT structure 54 54 55 55 46 +== 3.2 How sensor data is forwarded == 56 56 57 -== 3.2 How sensor data is forwarded == 58 - 59 - 60 60 In this MQTT forward feature, the key point is how the gateway process the sensor data. 61 61 62 62 63 -=== 3.2.1 51 +=== 3.2.1 Upstream === 64 64 65 - 66 66 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. 67 67 68 68 ((( 69 69 The data flow works as below diagram. 70 - 71 - 72 72 ))) 73 73 74 74 [[image:image-20220527134000-2.png]] ... ... @@ -75,12 +75,10 @@ 75 75 76 76 ((( 77 77 Upstream path 78 - 79 - 80 80 ))) 81 81 82 82 ((( 83 - (% 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>**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> 84 84 ))) 85 85 86 86 ((( ... ... @@ -87,9 +87,8 @@ 87 87 88 88 ))) 89 89 90 -=== 3.2.2 73 +=== 3.2.2 Downstream === 91 91 92 - 93 93 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. 94 94 95 95 ((( ... ... @@ -101,22 +101,18 @@ 101 101 Downstream path 102 102 103 103 86 +== 3.3 Macro Definition == 104 104 105 -== 3.3 Macro Definition == 106 - 107 - 108 108 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 109 109 110 110 ((( 111 111 Currently the (% style="color:#4f81bd" %)**-t (topic)**(%%) and (% style="color:#4f81bd" %)**-m (message)**(%%) support Macros. 112 112 113 - 114 114 115 115 ))) 116 116 117 -=== 3.3.1 96 +=== 3.3.1 -t topic macro === 118 118 119 - 120 120 * CHANNEL: Remote Channel ID 121 121 * CLIENTID: Client ID , Same as -i 122 122 * WRITE_API: Remote Channel Write API ... ... @@ -123,11 +123,8 @@ 123 123 * USERNAME: User ID (-u) 124 124 * HOSTNAME: Device Hostname 125 125 104 +=== 3.3.2 -m message macro === 126 126 127 - 128 -=== 3.3.2 -m message macro === 129 - 130 - 131 131 * HOSTNAME: Device Hostname 132 132 * CHANNEL: Remote Channel ID 133 133 * DATA: Sensor Data without time stamp and rssi ... ... @@ -134,18 +134,14 @@ 134 134 * META: Completely sensor data with time stamp and rssi 135 135 * JSON: Convert META to json format. 136 136 112 +=== 3.3.3 Example for Macro === 137 137 138 - 139 -=== 3.3.3 Example for Macro === 140 - 141 - 142 142 [[image:image-20220527134251-4.png]] 143 143 144 144 MQTT Publish configure 145 145 118 +Above screen shots shows below format: 146 146 147 -**Above screen shots shows below format:** 148 - 149 149 * -t: CLIENTID/CHANNEL/data 150 150 * -m: DATA 151 151 ... ... @@ -155,16 +155,13 @@ 155 155 156 156 Sensor Data 157 157 158 - 159 159 ((( 160 160 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. 161 161 ))) 162 162 163 163 134 +== 3.4 Modify the MQTT to support more options == 164 164 165 -== 3.4 Modify the MQTT to support more options == 166 - 167 - 168 168 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: 169 169 170 170 (% class="box" %) ... ... @@ -182,9 +182,9 @@ 182 182 [-u username [-P password]] 183 183 [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]] 184 184 [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file] 185 - [~-~-ciphers ciphers] [~-~-insecure] 186 - [~-~-tls-alpn protocol] 187 - [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]] 153 + [~-~-ciphers ciphers] [~-~-insecure] 154 + [~-~-tls-alpn protocol] 155 + [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]] 188 188 [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]] 189 189 [~-~-proxy socks-url] 190 190 [~-~-property command identifier value] ... ... @@ -289,19 +289,15 @@ 289 289 ))) 290 290 291 291 260 += 4. Example to communicate to a simple MQTT server = 292 292 293 -= 4. Exampleto communicate to a simple MQTT server=262 +== 4.1 Overview == 294 294 295 - 296 -== 4.1 Overview == 297 - 298 - 299 299 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/]]. 300 300 301 301 302 -== 4.2 267 +== 4.2 Simulate via MQTT.fx utility == 303 303 304 - 305 305 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. 306 306 307 307 ((( ... ... @@ -327,16 +327,14 @@ 327 327 Downstream: Subscribe a topic to get downstream 328 328 329 329 294 +== 4.3 Simulate via Dragino Command Line == 330 330 331 -== 4.3 Simulate via Dragino Command Line == 332 - 333 - 334 334 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. 335 335 336 336 In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection. 337 337 338 338 339 -(% style="color:b lue" %)**For Upstream**301 +(% style="color:#4f81bd" %)**For Upstream** 340 340 341 341 command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]] 342 342 ... ... @@ -349,9 +349,8 @@ 349 349 mosquitto_pub 350 350 351 351 314 +(% style="color:#4f81bd" %)**For Downstream** 352 352 353 -(% style="color:blue" %)**For Downstream** 354 - 355 355 Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic. 356 356 357 357 [[image:image-20220527135440-10.png]] ... ... @@ -359,10 +359,8 @@ 359 359 mosquitto_sub 360 360 361 361 323 +== 4.4 Configure Dragino UI for MQTT connection == 362 362 363 -== 4.4 Configure Dragino UI for MQTT connection == 364 - 365 - 366 366 This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection. 367 367 368 368 ((( ... ... @@ -369,11 +369,10 @@ 369 369 Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client** 370 370 ))) 371 371 372 -[[image:image -20220714155901-1.png]]331 +[[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]] 373 373 374 374 go to mqtt configure menu 375 375 376 - 377 377 ((( 378 378 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. 379 379 ))) ... ... @@ -383,28 +383,24 @@ 383 383 forward to MQTT 384 384 385 385 344 +=== 4.4.1 Configure the MQTT Client for Upstream === 386 386 387 - === 4.4.1 Configure theMQTT Clientfor Upstream===346 +Below screenshot is same as the publish command: 388 388 389 - 390 -**Below screenshot is same as the publish command:** 391 - 392 392 (% class="box" %) 393 393 ((( 394 - **mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA350 +mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA 395 395 ~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for 396 396 ~/~/CLIENTID: dragino-1b7060 397 397 ~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456 398 -~/~/DATA: The data stores in /var/iot/channels/ **354 +~/~/DATA: The data stores in /var/iot/channels/ 399 399 ))) 400 400 401 - 402 402 [[image:image-20220527135828-12.png]] 403 403 404 404 MQTT Publish configure 405 405 406 406 407 - 408 408 [[image:image-20220527135929-13.png]] 409 409 410 410 MQTT Channel settings ... ... @@ -433,10 +433,8 @@ 433 433 MQTT Publish 434 434 435 435 390 +=== 4.4.2 Configure the MQTT Client for Downstream === 436 436 437 -=== 4.4.2 Configure the MQTT Client for Downstream === 438 - 439 - 440 440 Below screen shot equal to this subscribe command: 441 441 442 442 (% class="box" %) ... ... @@ -465,15 +465,13 @@ 465 465 downstream simulation 466 466 467 467 468 -== 4.5 420 +== 4.5 Add LoRa support to communicate with remote sensor == 469 469 470 - 471 471 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. 472 472 473 473 474 -=== 4.5.1 425 +=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 475 475 476 - 477 477 ((( 478 478 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. 479 479 ))) ... ... @@ -484,8 +484,6 @@ 484 484 485 485 ((( 486 486 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. 487 - 488 - 489 489 ))) 490 490 491 491 ((( ... ... @@ -501,7 +501,6 @@ 501 501 LoRa Parameter should match 502 502 503 503 504 - 505 505 Below is the test result after the Arduino Sketch is running. 506 506 507 507 [[image:image-20220527140459-19.png]] ... ... @@ -509,16 +509,13 @@ 509 509 Upstream Data Flow 510 510 511 511 512 - 513 513 [[image:image-20220527140542-20.png]] 514 514 515 515 Downstream Data Flow 516 516 517 517 464 +=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 518 518 519 -=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 520 - 521 - 522 522 ((( 523 523 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. 524 524 ))) ... ... @@ -525,17 +525,15 @@ 525 525 526 526 ((( 527 527 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. 528 - 529 - 530 -(% style="color:blue" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 472 +(% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 531 531 ))) 532 532 533 533 ((( 534 -(% 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.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. 535 535 ))) 536 536 537 537 ((( 538 -(% style="color:b lue" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.480 +(% style="color:#4f81bd" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings. 539 539 ))) 540 540 541 541 [[image:image-20220527141235-21.png]] ... ... @@ -545,89 +545,62 @@ 545 545 546 546 ((( 547 547 ((( 548 -(% 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.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** 549 549 ))) 550 550 ))) 551 551 552 -[[image:image-20220 613191345-4.png]]494 +[[image:image-20220527141450-22.png]] 553 553 496 +Publish mush use META as data format for LG308 554 554 555 555 556 -(% style="color:b lue" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.499 +(% style="color:#4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server. 557 557 558 -[[image:image-20220 613190635-2.png]]501 +[[image:image-20220527141727-23.png]] 559 559 503 +Map Dev Addr to remote ID 560 560 561 561 562 -(% style="color:b lue" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server506 +(% style="color:#4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server 563 563 564 564 [[image:image-20220527141843-24.png]] 565 565 510 +Upstream Process 566 566 567 567 568 - 569 569 [[image:image-20220527141933-25.png]] 570 570 571 571 Choose ASCII Format 572 572 573 573 574 - 575 575 [[image:image-20220527142028-26.png]] 576 576 577 577 LHT65 Decoder 578 578 579 579 523 +(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream. 580 580 581 - (% style="color:blue" %)**Step 6: Set up subscribe**(%%)**:** Subscribeatopci for downstream.525 +[[image:image-20220527142115-27.png]] 582 582 583 - [[image:image-20220613191426-5.png]]527 +Subscribe to a topic 584 584 585 585 530 +(% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 586 586 587 -(% style="color:blue" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 588 - 589 589 [[image:image-20220527142239-28.png]] 590 590 534 +Downstream Flow 591 591 592 - 593 -=== 4.5.3 MQTT Downstream format === 594 - 595 - 596 -mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**" 597 - 598 -(% class="box infomessage" %) 599 -((( 600 -**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"** 601 -))) 602 - 603 -mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**" 604 - 605 -(% class="box infomessage" %) 606 -((( 607 -**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"** 608 -))) 609 - 610 -Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]] 611 - 612 -[[image:image-20220613192816-6.png||height="440" width="1056"]] 613 - 614 - 615 615 (% 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"]]** 616 616 617 617 618 - Checkoutthis link formore mosquito-relateddirectives [[https:~~/~~/mosquitto.org/man/mosquitto_pub-1.html>>https://mosquitto.org/man/mosquitto_pub-1.html]]539 += 5. How to Debug = 619 619 620 - 621 - 622 -= 5. How to Debug = 623 - 624 - 625 625 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. 626 626 627 627 628 -= 6. 544 += 6. How to ask for Support = 629 629 630 - 631 631 If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info: 632 632 633 633 * 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