Changes for page MQTT Forward Instruction
Last modified by Kilight Cao on 2024/08/31 16:26
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 7 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Kilight1 +XWiki.Xiaoling - Content
-
... ... @@ -1,21 +1,19 @@ 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/]] 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]])16 +* LG01N, OLG01N ((% style="color:red" %)**Warning**(%%): LG01-P LG01-S use another instruction: [[MQTT for LG01-P/LG01S>>Through MQTT to upload data]]) 19 19 * LG02, OLG02 20 20 * LG308, DLOS8 21 21 * LPS8 ... ... @@ -22,8 +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 25 -= 2. Firmware Change Log for MQTT feature = 26 26 24 += 2. Firmware Change Log for MQTT feature = 27 27 28 28 ((( 29 29 This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware. ... ... @@ -32,16 +32,15 @@ 32 32 * LG02_LG08-5.3.1580178039 33 33 ** Initiate version 34 34 35 -= 3. MQTT forward operating principle = 36 36 34 += 3. MQTT forward operating principle = 37 37 38 -== 3.1 36 +== 3.1 Network Structure == 39 39 40 - 41 41 Below shows the network structure for MQTT forwarding. 42 42 43 -* **For Uplink:**44 -* **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.40 +* 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. 41 +* 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, 45 45 46 46 [[image:image-20220527133547-1.png]] 47 47 ... ... @@ -48,22 +48,17 @@ 48 48 General MQTT structure 49 49 50 50 48 +== 3.2 How sensor data is forwarded == 51 51 52 -== 3.2 How sensor data is forwarded == 53 - 54 - 55 55 In this MQTT forward feature, the key point is how the gateway process the sensor data. 56 56 57 57 58 -=== 3.2.1 53 +=== 3.2.1 Upstream === 59 59 60 - 61 61 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. 62 62 63 63 ((( 64 64 The data flow works as below diagram. 65 - 66 - 67 67 ))) 68 68 69 69 [[image:image-20220527134000-2.png]] ... ... @@ -70,12 +70,10 @@ 70 70 71 71 ((( 72 72 Upstream path 73 - 74 - 75 75 ))) 76 76 77 77 ((( 78 - (% 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>**68 +Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span> 79 79 ))) 80 80 81 81 ((( ... ... @@ -82,9 +82,8 @@ 82 82 83 83 ))) 84 84 85 -=== 3.2.2 75 +=== 3.2.2 Downstream === 86 86 87 - 88 88 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. 89 89 90 90 ((( ... ... @@ -96,22 +96,18 @@ 96 96 Downstream path 97 97 98 98 88 +== 3.3 Macro Definition == 99 99 100 -== 3.3 Macro Definition == 101 - 102 - 103 103 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 104 104 105 105 ((( 106 106 Currently the (% style="color:#4f81bd" %)**-t (topic)**(%%) and (% style="color:#4f81bd" %)**-m (message)**(%%) support Macros. 107 107 108 - 109 109 110 110 ))) 111 111 112 -=== 3.3.1 98 +=== 3.3.1 -t topic macro === 113 113 114 - 115 115 * CHANNEL: Remote Channel ID 116 116 * CLIENTID: Client ID , Same as -i 117 117 * WRITE_API: Remote Channel Write API ... ... @@ -118,9 +118,8 @@ 118 118 * USERNAME: User ID (-u) 119 119 * HOSTNAME: Device Hostname 120 120 121 -=== 3.3.2 106 +=== 3.3.2 -m message macro === 122 122 123 - 124 124 * HOSTNAME: Device Hostname 125 125 * CHANNEL: Remote Channel ID 126 126 * DATA: Sensor Data without time stamp and rssi ... ... @@ -127,16 +127,14 @@ 127 127 * META: Completely sensor data with time stamp and rssi 128 128 * JSON: Convert META to json format. 129 129 130 -=== 3.3.3 114 +=== 3.3.3 Example for Macro === 131 131 132 - 133 133 [[image:image-20220527134251-4.png]] 134 134 135 135 MQTT Publish configure 136 136 120 +Above screen shots shows below format: 137 137 138 -**Above screen shots shows below format:** 139 - 140 140 * -t: CLIENTID/CHANNEL/data 141 141 * -m: DATA 142 142 ... ... @@ -146,16 +146,13 @@ 146 146 147 147 Sensor Data 148 148 149 - 150 150 ((( 151 151 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. 152 152 ))) 153 153 154 154 136 +== 3.4 Modify the MQTT to support more options == 155 155 156 -== 3.4 Modify the MQTT to support more options == 157 - 158 - 159 159 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: 160 160 161 161 (% class="box" %) ... ... @@ -173,9 +173,9 @@ 173 173 [-u username [-P password]] 174 174 [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]] 175 175 [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file] 176 - [~-~-ciphers ciphers] [~-~-insecure] 177 - [~-~-tls-alpn protocol] 178 - [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]] 155 + [~-~-ciphers ciphers] [~-~-insecure] 156 + [~-~-tls-alpn protocol] 157 + [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]] 179 179 [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]] 180 180 [~-~-proxy socks-url] 181 181 [~-~-property command identifier value] ... ... @@ -280,19 +280,15 @@ 280 280 ))) 281 281 282 282 262 += 4. Example to communicate to a simple MQTT server = 283 283 284 -= 4. Exampleto communicate to a simple MQTT server=264 +== 4.1 Overview == 285 285 286 - 287 -== 4.1 Overview == 288 - 289 - 290 290 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/]]. 291 291 292 292 293 -== 4.2 269 +== 4.2 Simulate via MQTT.fx utility == 294 294 295 - 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,16 +318,14 @@ 318 318 Downstream: Subscribe a topic to get downstream 319 319 320 320 296 +== 4.3 Simulate via Dragino Command Line == 321 321 322 -== 4.3 Simulate via Dragino Command Line == 323 - 324 - 325 325 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. 326 326 327 327 In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection. 328 328 329 329 330 -(% style="color:b lue" %)**For Upstream**303 +(% style="color:#4f81bd" %)**For Upstream** 331 331 332 332 command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]] 333 333 ... ... @@ -340,9 +340,8 @@ 340 340 mosquitto_pub 341 341 342 342 316 +(% style="color:#4f81bd" %)**For Downstream** 343 343 344 -(% style="color:blue" %)**For Downstream** 345 - 346 346 Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic. 347 347 348 348 [[image:image-20220527135440-10.png]] ... ... @@ -350,10 +350,8 @@ 350 350 mosquitto_sub 351 351 352 352 325 +== 4.4 Configure Dragino UI for MQTT connection == 353 353 354 -== 4.4 Configure Dragino UI for MQTT connection == 355 - 356 - 357 357 This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection. 358 358 359 359 ((( ... ... @@ -360,11 +360,10 @@ 360 360 Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client** 361 361 ))) 362 362 363 -[[image:image -20220714155901-1.png]]333 +[[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]] 364 364 365 365 go to mqtt configure menu 366 366 367 - 368 368 ((( 369 369 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. 370 370 ))) ... ... @@ -374,28 +374,24 @@ 374 374 forward to MQTT 375 375 376 376 346 +=== 4.4.1 Configure the MQTT Client for Upstream === 377 377 378 - === 4.4.1 Configure theMQTT Clientfor Upstream===348 +Below screenshot is same as the publish command: 379 379 380 - 381 -**Below screenshot is same as the publish command:** 382 - 383 383 (% class="box" %) 384 384 ((( 385 - **mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA352 +mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA 386 386 ~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for 387 387 ~/~/CLIENTID: dragino-1b7060 388 388 ~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456 389 -~/~/DATA: The data stores in /var/iot/channels/ **356 +~/~/DATA: The data stores in /var/iot/channels/ 390 390 ))) 391 391 392 - 393 393 [[image:image-20220527135828-12.png]] 394 394 395 395 MQTT Publish configure 396 396 397 397 398 - 399 399 [[image:image-20220527135929-13.png]] 400 400 401 401 MQTT Channel settings ... ... @@ -424,10 +424,8 @@ 424 424 MQTT Publish 425 425 426 426 392 +=== 4.4.2 Configure the MQTT Client for Downstream === 427 427 428 -=== 4.4.2 Configure the MQTT Client for Downstream === 429 - 430 - 431 431 Below screen shot equal to this subscribe command: 432 432 433 433 (% class="box" %) ... ... @@ -456,15 +456,13 @@ 456 456 downstream simulation 457 457 458 458 459 -== 4.5 422 +== 4.5 Add LoRa support to communicate with remote sensor == 460 460 461 - 462 462 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. 463 463 464 464 465 -=== 4.5.1 427 +=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 466 466 467 - 468 468 ((( 469 469 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. 470 470 ))) ... ... @@ -475,8 +475,6 @@ 475 475 476 476 ((( 477 477 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. 478 - 479 - 480 480 ))) 481 481 482 482 ((( ... ... @@ -492,7 +492,6 @@ 492 492 LoRa Parameter should match 493 493 494 494 495 - 496 496 Below is the test result after the Arduino Sketch is running. 497 497 498 498 [[image:image-20220527140459-19.png]] ... ... @@ -500,16 +500,13 @@ 500 500 Upstream Data Flow 501 501 502 502 503 - 504 504 [[image:image-20220527140542-20.png]] 505 505 506 506 Downstream Data Flow 507 507 508 508 466 +=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 509 509 510 -=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 511 - 512 - 513 513 ((( 514 514 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. 515 515 ))) ... ... @@ -516,17 +516,15 @@ 516 516 517 517 ((( 518 518 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. 519 - 520 - 521 -(% style="color:blue" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 474 +(% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 522 522 ))) 523 523 524 524 ((( 525 -(% 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.478 +(% 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. 526 526 ))) 527 527 528 528 ((( 529 -(% style="color:b lue" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.482 +(% style="color:#4f81bd" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings. 530 530 ))) 531 531 532 532 [[image:image-20220527141235-21.png]] ... ... @@ -536,89 +536,62 @@ 536 536 537 537 ((( 538 538 ((( 539 -(% 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.492 +(% 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** 540 540 ))) 541 541 ))) 542 542 543 -[[image:image-20220 613191345-4.png]]496 +[[image:image-20220527141450-22.png]] 544 544 498 +Publish mush use META as data format for LG308 545 545 546 546 547 -(% style="color:b lue" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.501 +(% style="color:#4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server. 548 548 549 -[[image:image-20220 613190635-2.png]]503 +[[image:image-20220527141727-23.png]] 550 550 505 +Map Dev Addr to remote ID 551 551 552 552 553 -(% style="color:b lue" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server508 +(% style="color:#4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server 554 554 555 555 [[image:image-20220527141843-24.png]] 556 556 512 +Upstream Process 557 557 558 558 559 - 560 560 [[image:image-20220527141933-25.png]] 561 561 562 562 Choose ASCII Format 563 563 564 564 565 - 566 566 [[image:image-20220527142028-26.png]] 567 567 568 568 LHT65 Decoder 569 569 570 570 525 +(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream. 571 571 572 - (% style="color:blue" %)**Step 6: Set up subscribe**(%%)**:** Subscribeatopci for downstream.527 +[[image:image-20220527142115-27.png]] 573 573 574 - [[image:image-20220613191426-5.png]]529 +Subscribe to a topic 575 575 576 576 532 +(% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 577 577 578 -(% style="color:blue" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 579 - 580 580 [[image:image-20220527142239-28.png]] 581 581 536 +Downstream Flow 582 582 583 - 584 -=== 4.5.3 MQTT Downstream format === 585 - 586 - 587 -mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**" 588 - 589 -(% class="box infomessage" %) 590 -((( 591 -**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"** 592 -))) 593 - 594 -mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**" 595 - 596 -(% class="box infomessage" %) 597 -((( 598 -**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello,20,1,SF12,923300000,2"** 599 -))) 600 - 601 -Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]] 602 - 603 -[[image:image-20220613192816-6.png||height="440" width="1056"]] 604 - 605 - 606 606 (% 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"]]** 607 607 608 608 609 - Checkoutthis link formore mosquito-relateddirectives [[https:~~/~~/mosquitto.org/man/mosquitto_pub-1.html>>https://mosquitto.org/man/mosquitto_pub-1.html]]541 += 5. How to Debug = 610 610 611 - 612 - 613 -= 5. How to Debug = 614 - 615 - 616 616 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. 617 617 618 618 619 -= 6. 546 += 6. How to ask for Support = 620 620 621 - 622 622 If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info: 623 623 624 624 * 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