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,12 +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 - 28 -= 2. Firmware Change Log for MQTT feature = 29 - 30 - 31 31 ((( 32 32 This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware. 33 33 ))) ... ... @@ -35,19 +35,14 @@ 35 35 * LG02_LG08-5.3.1580178039 36 36 ** Initiate version 37 37 32 += 3. MQTT forward operating principle = 38 38 34 +== 3.1 Network Structure == 39 39 40 - 41 -= 3. MQTT forward operating principle = 42 - 43 - 44 -== 3.1 Network Structure == 45 - 46 - 47 47 Below shows the network structure for MQTT forwarding. 48 48 49 -* **For Uplink:**50 -* **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, 51 51 52 52 [[image:image-20220527133547-1.png]] 53 53 ... ... @@ -54,13 +54,12 @@ 54 54 General MQTT structure 55 55 56 56 57 -== 3.2 46 +== 3.2 How sensor data is forwarded == 58 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 65 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. 66 66 ... ... @@ -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>**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> 81 81 ))) 82 82 83 83 ((( ... ... @@ -84,9 +84,8 @@ 84 84 85 85 ))) 86 86 87 -=== 3.2.2 73 +=== 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,9 +98,8 @@ 98 98 Downstream path 99 99 100 100 101 -== 3.3 86 +== 3.3 Macro Definition == 102 102 103 - 104 104 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 105 105 106 106 ((( ... ... @@ -109,9 +109,8 @@ 109 109 110 110 ))) 111 111 112 -=== 3.3.1 96 +=== 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 104 +=== 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 112 +=== 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 118 +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 134 +== 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]] 153 + [~-~-ciphers ciphers] [~-~-insecure] 154 + [~-~-tls-alpn protocol] 155 + [~-~-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 260 += 4. Example to communicate to a simple MQTT server = 283 283 284 -= 4. Exampleto communicate to a simple MQTT server=262 +== 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 267 +== 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,15 +318,14 @@ 318 318 Downstream: Subscribe a topic to get downstream 319 319 320 320 294 +== 4.3 Simulate via Dragino Command Line == 321 321 322 -== 4.3 Simulate via Dragino Command Line == 323 - 324 324 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. 325 325 326 326 In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection. 327 327 328 328 329 -(% style="color:b lue" %)**For Upstream**301 +(% style="color:#4f81bd" %)**For Upstream** 330 330 331 331 command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]] 332 332 ... ... @@ -339,9 +339,8 @@ 339 339 mosquitto_pub 340 340 341 341 314 +(% style="color:#4f81bd" %)**For Downstream** 342 342 343 -(% style="color:blue" %)**For Downstream** 344 - 345 345 Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic. 346 346 347 347 [[image:image-20220527135440-10.png]] ... ... @@ -349,7 +349,7 @@ 349 349 mosquitto_sub 350 350 351 351 352 -== 4.4 323 +== 4.4 Configure Dragino UI for MQTT connection == 353 353 354 354 This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection. 355 355 ... ... @@ -357,11 +357,10 @@ 357 357 Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client** 358 358 ))) 359 359 360 -[[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"]] 361 361 362 362 go to mqtt configure menu 363 363 364 - 365 365 ((( 366 366 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. 367 367 ))) ... ... @@ -371,28 +371,24 @@ 371 371 forward to MQTT 372 372 373 373 344 +=== 4.4.1 Configure the MQTT Client for Upstream === 374 374 375 - === 4.4.1 Configure theMQTT Clientfor Upstream===346 +Below screenshot is same as the publish command: 376 376 377 - 378 -**Below screenshot is same as the publish command:** 379 - 380 380 (% class="box" %) 381 381 ((( 382 - **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 383 383 ~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for 384 384 ~/~/CLIENTID: dragino-1b7060 385 385 ~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456 386 -~/~/DATA: The data stores in /var/iot/channels/ **354 +~/~/DATA: The data stores in /var/iot/channels/ 387 387 ))) 388 388 389 - 390 390 [[image:image-20220527135828-12.png]] 391 391 392 392 MQTT Publish configure 393 393 394 394 395 - 396 396 [[image:image-20220527135929-13.png]] 397 397 398 398 MQTT Channel settings ... ... @@ -421,10 +421,8 @@ 421 421 MQTT Publish 422 422 423 423 390 +=== 4.4.2 Configure the MQTT Client for Downstream === 424 424 425 -=== 4.4.2 Configure the MQTT Client for Downstream === 426 - 427 - 428 428 Below screen shot equal to this subscribe command: 429 429 430 430 (% class="box" %) ... ... @@ -453,15 +453,13 @@ 453 453 downstream simulation 454 454 455 455 456 -== 4.5 420 +== 4.5 Add LoRa support to communicate with remote sensor == 457 457 458 - 459 459 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. 460 460 461 461 462 -=== 4.5.1 425 +=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 463 463 464 - 465 465 ((( 466 466 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. 467 467 ))) ... ... @@ -472,8 +472,6 @@ 472 472 473 473 ((( 474 474 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. 475 - 476 - 477 477 ))) 478 478 479 479 ((( ... ... @@ -489,7 +489,6 @@ 489 489 LoRa Parameter should match 490 490 491 491 492 - 493 493 Below is the test result after the Arduino Sketch is running. 494 494 495 495 [[image:image-20220527140459-19.png]] ... ... @@ -497,16 +497,13 @@ 497 497 Upstream Data Flow 498 498 499 499 500 - 501 501 [[image:image-20220527140542-20.png]] 502 502 503 503 Downstream Data Flow 504 504 505 505 464 +=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 506 506 507 -=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 508 - 509 - 510 510 ((( 511 511 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. 512 512 ))) ... ... @@ -513,17 +513,15 @@ 513 513 514 514 ((( 515 515 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. 516 - 517 - 518 518 (% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 519 519 ))) 520 520 521 521 ((( 522 -(% 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.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. 523 523 ))) 524 524 525 525 ((( 526 -(% 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. 527 527 ))) 528 528 529 529 [[image:image-20220527141235-21.png]] ... ... @@ -533,89 +533,62 @@ 533 533 534 534 ((( 535 535 ((( 536 -(% 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** 537 537 ))) 538 538 ))) 539 539 540 -[[image:image-20220 613191345-4.png]]494 +[[image:image-20220527141450-22.png]] 541 541 496 +Publish mush use META as data format for LG308 542 542 543 543 544 -(% 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. 545 545 546 -[[image:image-20220 613190635-2.png]]501 +[[image:image-20220527141727-23.png]] 547 547 503 +Map Dev Addr to remote ID 548 548 549 549 550 -(% 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 551 551 552 552 [[image:image-20220527141843-24.png]] 553 553 510 +Upstream Process 554 554 555 555 556 - 557 557 [[image:image-20220527141933-25.png]] 558 558 559 559 Choose ASCII Format 560 560 561 561 562 - 563 563 [[image:image-20220527142028-26.png]] 564 564 565 565 LHT65 Decoder 566 566 567 567 523 +(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream. 568 568 569 - (% style="color:blue" %)**Step 6: Set up subscribe**(%%)**:** Subscribeatopci for downstream.525 +[[image:image-20220527142115-27.png]] 570 570 571 - [[image:image-20220613191426-5.png]]527 +Subscribe to a topic 572 572 573 573 530 +(% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 574 574 575 -(% style="color:blue" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 576 - 577 577 [[image:image-20220527142239-28.png]] 578 578 534 +Downstream Flow 579 579 580 - 581 -=== 4.5.3 MQTT Downstream format === 582 - 583 - 584 -mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**" 585 - 586 -(% class="box infomessage" %) 587 -((( 588 -**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"** 589 -))) 590 - 591 -mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**" 592 - 593 -(% class="box infomessage" %) 594 -((( 595 -**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"** 596 -))) 597 - 598 -Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]] 599 - 600 -[[image:image-20220613192816-6.png||height="440" width="1056"]] 601 - 602 - 603 603 (% 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"]]** 604 604 605 605 606 - 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 = 607 607 608 - 609 - 610 -= 5. How to Debug = 611 - 612 - 613 613 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. 614 614 615 615 616 -= 6. 544 += 6. How to ask for Support = 617 617 618 - 619 619 If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info: 620 620 621 621 * 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