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