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,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,13 +48,12 @@ 48 48 General MQTT structure 49 49 50 50 51 -== 3.2 48 +== 3.2 How sensor data is forwarded == 52 52 53 - 54 54 In this MQTT forward feature, the key point is how the gateway process the sensor data. 55 55 56 56 57 -=== 3.2.1 53 +=== 3.2.1 Upstream === 58 58 59 59 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. 60 60 ... ... @@ -66,12 +66,10 @@ 66 66 67 67 ((( 68 68 Upstream path 69 - 70 - 71 71 ))) 72 72 73 73 ((( 74 - (% 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> 75 75 ))) 76 76 77 77 ((( ... ... @@ -78,9 +78,8 @@ 78 78 79 79 ))) 80 80 81 -=== 3.2.2 75 +=== 3.2.2 Downstream === 82 82 83 - 84 84 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. 85 85 86 86 ((( ... ... @@ -92,9 +92,8 @@ 92 92 Downstream path 93 93 94 94 95 -== 3.3 88 +== 3.3 Macro Definition == 96 96 97 - 98 98 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 99 99 100 100 ((( ... ... @@ -103,9 +103,8 @@ 103 103 104 104 ))) 105 105 106 -=== 3.3.1 98 +=== 3.3.1 -t topic macro === 107 107 108 - 109 109 * CHANNEL: Remote Channel ID 110 110 * CLIENTID: Client ID , Same as -i 111 111 * WRITE_API: Remote Channel Write API ... ... @@ -112,10 +112,8 @@ 112 112 * USERNAME: User ID (-u) 113 113 * HOSTNAME: Device Hostname 114 114 106 +=== 3.3.2 -m message macro === 115 115 116 -=== 3.3.2 -m message macro === 117 - 118 - 119 119 * HOSTNAME: Device Hostname 120 120 * CHANNEL: Remote Channel ID 121 121 * DATA: Sensor Data without time stamp and rssi ... ... @@ -122,17 +122,14 @@ 122 122 * META: Completely sensor data with time stamp and rssi 123 123 * JSON: Convert META to json format. 124 124 114 +=== 3.3.3 Example for Macro === 125 125 126 -=== 3.3.3 Example for Macro === 127 - 128 - 129 129 [[image:image-20220527134251-4.png]] 130 130 131 131 MQTT Publish configure 132 132 120 +Above screen shots shows below format: 133 133 134 -**Above screen shots shows below format:** 135 - 136 136 * -t: CLIENTID/CHANNEL/data 137 137 * -m: DATA 138 138 ... ... @@ -142,16 +142,13 @@ 142 142 143 143 Sensor Data 144 144 145 - 146 146 ((( 147 147 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. 148 148 ))) 149 149 150 150 136 +== 3.4 Modify the MQTT to support more options == 151 151 152 -== 3.4 Modify the MQTT to support more options == 153 - 154 - 155 155 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: 156 156 157 157 (% class="box" %) ... ... @@ -169,9 +169,9 @@ 169 169 [-u username [-P password]] 170 170 [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]] 171 171 [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file] 172 - [~-~-ciphers ciphers] [~-~-insecure] 173 - [~-~-tls-alpn protocol] 174 - [~-~-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]] 175 175 [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]] 176 176 [~-~-proxy socks-url] 177 177 [~-~-property command identifier value] ... ... @@ -276,19 +276,15 @@ 276 276 ))) 277 277 278 278 262 += 4. Example to communicate to a simple MQTT server = 279 279 280 -= 4. Exampleto communicate to a simple MQTT server=264 +== 4.1 Overview == 281 281 282 - 283 -== 4.1 Overview == 284 - 285 - 286 286 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/]]. 287 287 288 288 289 -== 4.2 269 +== 4.2 Simulate via MQTT.fx utility == 290 290 291 - 292 292 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. 293 293 294 294 ((( ... ... @@ -314,15 +314,14 @@ 314 314 Downstream: Subscribe a topic to get downstream 315 315 316 316 296 +== 4.3 Simulate via Dragino Command Line == 317 317 318 -== 4.3 Simulate via Dragino Command Line == 319 - 320 320 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. 321 321 322 322 In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection. 323 323 324 324 325 -(% style="color:b lue" %)**For Upstream**303 +(% style="color:#4f81bd" %)**For Upstream** 326 326 327 327 command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]] 328 328 ... ... @@ -335,9 +335,8 @@ 335 335 mosquitto_pub 336 336 337 337 316 +(% style="color:#4f81bd" %)**For Downstream** 338 338 339 -(% style="color:blue" %)**For Downstream** 340 - 341 341 Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic. 342 342 343 343 [[image:image-20220527135440-10.png]] ... ... @@ -345,7 +345,7 @@ 345 345 mosquitto_sub 346 346 347 347 348 -== 4.4 325 +== 4.4 Configure Dragino UI for MQTT connection == 349 349 350 350 This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection. 351 351 ... ... @@ -353,11 +353,10 @@ 353 353 Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client** 354 354 ))) 355 355 356 -[[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"]] 357 357 358 358 go to mqtt configure menu 359 359 360 - 361 361 ((( 362 362 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. 363 363 ))) ... ... @@ -367,28 +367,24 @@ 367 367 forward to MQTT 368 368 369 369 346 +=== 4.4.1 Configure the MQTT Client for Upstream === 370 370 371 - === 4.4.1 Configure theMQTT Clientfor Upstream===348 +Below screenshot is same as the publish command: 372 372 373 - 374 -**Below screenshot is same as the publish command:** 375 - 376 376 (% class="box" %) 377 377 ((( 378 - **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 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/ **356 +~/~/DATA: The data stores in /var/iot/channels/ 383 383 ))) 384 384 385 - 386 386 [[image:image-20220527135828-12.png]] 387 387 388 388 MQTT Publish configure 389 389 390 390 391 - 392 392 [[image:image-20220527135929-13.png]] 393 393 394 394 MQTT Channel settings ... ... @@ -417,10 +417,8 @@ 417 417 MQTT Publish 418 418 419 419 392 +=== 4.4.2 Configure the MQTT Client for Downstream === 420 420 421 -=== 4.4.2 Configure the MQTT Client for Downstream === 422 - 423 - 424 424 Below screen shot equal to this subscribe command: 425 425 426 426 (% class="box" %) ... ... @@ -449,15 +449,13 @@ 449 449 downstream simulation 450 450 451 451 452 -== 4.5 422 +== 4.5 Add LoRa support to communicate with remote sensor == 453 453 454 - 455 455 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. 456 456 457 457 458 -=== 4.5.1 427 +=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 459 459 460 - 461 461 ((( 462 462 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. 463 463 ))) ... ... @@ -468,8 +468,6 @@ 468 468 469 469 ((( 470 470 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. 471 - 472 - 473 473 ))) 474 474 475 475 ((( ... ... @@ -485,7 +485,6 @@ 485 485 LoRa Parameter should match 486 486 487 487 488 - 489 489 Below is the test result after the Arduino Sketch is running. 490 490 491 491 [[image:image-20220527140459-19.png]] ... ... @@ -493,16 +493,13 @@ 493 493 Upstream Data Flow 494 494 495 495 496 - 497 497 [[image:image-20220527140542-20.png]] 498 498 499 499 Downstream Data Flow 500 500 501 501 466 +=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 502 502 503 -=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 504 - 505 - 506 506 ((( 507 507 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. 508 508 ))) ... ... @@ -509,17 +509,15 @@ 509 509 510 510 ((( 511 511 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. 512 - 513 - 514 514 (% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 515 515 ))) 516 516 517 517 ((( 518 -(% style="color:b lued" %)**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. 519 519 ))) 520 520 521 521 ((( 522 -(% 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. 523 523 ))) 524 524 525 525 [[image:image-20220527141235-21.png]] ... ... @@ -529,89 +529,62 @@ 529 529 530 530 ((( 531 531 ((( 532 -(% 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** 533 533 ))) 534 534 ))) 535 535 536 -[[image:image-20220 613191345-4.png]]496 +[[image:image-20220527141450-22.png]] 537 537 498 +Publish mush use META as data format for LG308 538 538 539 539 540 -(% 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. 541 541 542 -[[image:image-20220 613190635-2.png]]503 +[[image:image-20220527141727-23.png]] 543 543 505 +Map Dev Addr to remote ID 544 544 545 545 546 -(% 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 547 547 548 548 [[image:image-20220527141843-24.png]] 549 549 512 +Upstream Process 550 550 551 551 552 - 553 553 [[image:image-20220527141933-25.png]] 554 554 555 555 Choose ASCII Format 556 556 557 557 558 - 559 559 [[image:image-20220527142028-26.png]] 560 560 561 561 LHT65 Decoder 562 562 563 563 525 +(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream. 564 564 565 - (% style="color:blue" %)**Step 6: Set up subscribe**(%%)**:** Subscribeatopci for downstream.527 +[[image:image-20220527142115-27.png]] 566 566 567 - [[image:image-20220613191426-5.png]]529 +Subscribe to a topic 568 568 569 569 532 +(% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 570 570 571 -(% style="color:blue" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 572 - 573 573 [[image:image-20220527142239-28.png]] 574 574 536 +Downstream Flow 575 575 576 - 577 -=== 4.5.3 MQTT Downstream format === 578 - 579 - 580 -mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**" 581 - 582 -(% class="box infomessage" %) 583 -((( 584 -**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"** 585 -))) 586 - 587 -mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**" 588 - 589 -(% class="box infomessage" %) 590 -((( 591 -**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"** 592 -))) 593 - 594 -Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]] 595 - 596 -[[image:image-20220613192816-6.png||height="440" width="1056"]] 597 - 598 - 599 599 (% 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"]]** 600 600 601 601 602 - 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 = 603 603 604 - 605 - 606 -= 5. How to Debug = 607 - 608 - 609 609 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. 610 610 611 611 612 -= 6. 546 += 6. How to ask for Support = 613 613 614 - 615 615 If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info: 616 616 617 617 * 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