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: Main.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>>doc:Through MQTT to upload data.WebHome]]) 19 19 * LG02, OLG02 20 20 * LG308, DLOS8 21 21 * LPS8 ... ... @@ -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,15 +34,15 @@ 34 34 ** Initiate version 35 35 36 36 37 -= 3. MQTT forward operating principle = 38 38 39 -= =3.1NetworkStructure ==36 += 3. MQTT forward operating principle = 40 40 38 +== 3.1 Network Structure == 41 41 42 42 Below shows the network structure for MQTT forwarding. 43 43 44 -* **For Uplink:**45 -* **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, 46 46 47 47 [[image:image-20220527133547-1.png]] 48 48 ... ... @@ -49,15 +49,13 @@ 49 49 General MQTT structure 50 50 51 51 52 -== 3.2 50 +== 3.2 How sensor data is forwarded == 53 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 55 +=== 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 ((( ... ... @@ -68,12 +68,10 @@ 68 68 69 69 ((( 70 70 Upstream path 71 - 72 - 73 73 ))) 74 74 75 75 ((( 76 - (% 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> 77 77 ))) 78 78 79 79 ((( ... ... @@ -80,9 +80,8 @@ 80 80 81 81 ))) 82 82 83 -=== 3.2.2 77 +=== 3.2.2 Downstream === 84 84 85 - 86 86 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. 87 87 88 88 ((( ... ... @@ -94,9 +94,8 @@ 94 94 Downstream path 95 95 96 96 97 -== 3.3 90 +== 3.3 Macro Definition == 98 98 99 - 100 100 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 101 101 102 102 ((( ... ... @@ -105,9 +105,8 @@ 105 105 106 106 ))) 107 107 108 -=== 3.3.1 100 +=== 3.3.1 -t topic macro === 109 109 110 - 111 111 * CHANNEL: Remote Channel ID 112 112 * CLIENTID: Client ID , Same as -i 113 113 * WRITE_API: Remote Channel Write API ... ... @@ -115,8 +115,8 @@ 115 115 * HOSTNAME: Device Hostname 116 116 117 117 118 -=== 3.3.2 -m message macro === 119 119 110 +=== 3.3.2 -m message macro === 120 120 121 121 * HOSTNAME: Device Hostname 122 122 * CHANNEL: Remote Channel ID ... ... @@ -125,8 +125,8 @@ 125 125 * JSON: Convert META to json format. 126 126 127 127 128 -=== 3.3.3 Example for Macro === 129 129 120 +=== 3.3.3 Example for Macro === 130 130 131 131 [[image:image-20220527134251-4.png]] 132 132 ... ... @@ -133,7 +133,7 @@ 133 133 MQTT Publish configure 134 134 135 135 136 - **Above screen shots shows below format:**127 +Above screen shots shows below format: 137 137 138 138 * -t: CLIENTID/CHANNEL/data 139 139 * -m: DATA ... ... @@ -150,9 +150,8 @@ 150 150 ))) 151 151 152 152 153 -== 3.4 144 +== 3.4 Modify the MQTT to support more options == 154 154 155 - 156 156 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: 157 157 158 158 (% class="box" %) ... ... @@ -170,9 +170,9 @@ 170 170 [-u username [-P password]] 171 171 [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]] 172 172 [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file] 173 - [~-~-ciphers ciphers] [~-~-insecure] 174 - [~-~-tls-alpn protocol] 175 - [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]] 163 + [~-~-ciphers ciphers] [~-~-insecure] 164 + [~-~-tls-alpn protocol] 165 + [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]] 176 176 [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]] 177 177 [~-~-proxy socks-url] 178 178 [~-~-property command identifier value] ... ... @@ -277,17 +277,15 @@ 277 277 ))) 278 278 279 279 280 -= 4. 270 += 4. Example to communicate to a simple MQTT server = 281 281 282 -== 4.1 272 +== 4.1 Overview == 283 283 284 - 285 285 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/]]. 286 286 287 287 288 -== 4.2 277 +== 4.2 Simulate via MQTT.fx utility == 289 289 290 - 291 291 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. 292 292 293 293 ((( ... ... @@ -313,15 +313,14 @@ 313 313 Downstream: Subscribe a topic to get downstream 314 314 315 315 316 -== 4.3 304 +== 4.3 Simulate via Dragino Command Line == 317 317 318 - 319 319 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. 320 320 321 321 In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection. 322 322 323 323 324 -(% style="color:b lue" %)**For Upstream**311 +(% style="color:#4f81bd" %)**For Upstream** 325 325 326 326 command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]] 327 327 ... ... @@ -334,7 +334,7 @@ 334 334 mosquitto_pub 335 335 336 336 337 -(% style="color:b lue" %)**For Downstream**324 +(% style="color:#4f81bd" %)**For Downstream** 338 338 339 339 Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic. 340 340 ... ... @@ -343,9 +343,8 @@ 343 343 mosquitto_sub 344 344 345 345 346 -== 4.4 333 +== 4.4 Configure Dragino UI for MQTT connection == 347 347 348 - 349 349 This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection. 350 350 351 351 ((( ... ... @@ -352,11 +352,10 @@ 352 352 Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client** 353 353 ))) 354 354 355 -[[image:image -20220714155901-1.png]]341 +[[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]] 356 356 357 357 go to mqtt configure menu 358 358 359 - 360 360 ((( 361 361 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. 362 362 ))) ... ... @@ -366,21 +366,19 @@ 366 366 forward to MQTT 367 367 368 368 369 -=== 4.4.1 354 +=== 4.4.1 Configure the MQTT Client for Upstream === 370 370 356 +Below screenshot is same as the publish command: 371 371 372 -**Below screenshot is same as the publish command:** 373 - 374 374 (% class="box" %) 375 375 ((( 376 - **mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA360 +mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA 377 377 ~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for 378 378 ~/~/CLIENTID: dragino-1b7060 379 379 ~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456 380 -~/~/DATA: The data stores in /var/iot/channels/ **364 +~/~/DATA: The data stores in /var/iot/channels/ 381 381 ))) 382 382 383 - 384 384 [[image:image-20220527135828-12.png]] 385 385 386 386 MQTT Publish configure ... ... @@ -414,9 +414,8 @@ 414 414 MQTT Publish 415 415 416 416 417 -=== 4.4.2 400 +=== 4.4.2 Configure the MQTT Client for Downstream === 418 418 419 - 420 420 Below screen shot equal to this subscribe command: 421 421 422 422 (% class="box" %) ... ... @@ -445,16 +445,13 @@ 445 445 downstream simulation 446 446 447 447 448 -== 4.5 430 +== 4.5 Add LoRa support to communicate with remote sensor == 449 449 450 - 451 451 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. 452 452 453 453 435 +=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 454 454 455 -=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 456 - 457 - 458 458 ((( 459 459 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. 460 460 ))) ... ... @@ -465,8 +465,6 @@ 465 465 466 466 ((( 467 467 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. 468 - 469 - 470 470 ))) 471 471 472 472 ((( ... ... @@ -494,9 +494,8 @@ 494 494 Downstream Data Flow 495 495 496 496 497 -=== 4.5.2 474 +=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 498 498 499 - 500 500 ((( 501 501 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. 502 502 ))) ... ... @@ -503,17 +503,15 @@ 503 503 504 504 ((( 505 505 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. 506 - 507 - 508 -(% style="color:blue" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 482 +(% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 509 509 ))) 510 510 511 511 ((( 512 -(% 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.486 +(% 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. 513 513 ))) 514 514 515 515 ((( 516 -(% style="color:b lue" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.490 +(% style="color:#4f81bd" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings. 517 517 ))) 518 518 519 519 [[image:image-20220527141235-21.png]] ... ... @@ -523,23 +523,29 @@ 523 523 524 524 ((( 525 525 ((( 526 -(% 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.500 +(% 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** 527 527 ))) 528 528 ))) 529 529 530 -[[image:image-20220 613191345-4.png]]504 +[[image:image-20220527141450-22.png]] 531 531 506 +Publish mush use META as data format for LG308 532 532 533 -(% style="color:blue" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server. 534 534 535 - [[image:image-20220613190635-2.png]]509 +(% style="color:#4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server. 536 536 511 +[[image:image-20220527141727-23.png]] 537 537 538 - (% style="color:blue" %)**Step5: Upstream**(%%): Savethechange, we can seethe loginfo via "sytemlog", End Nodeand MQTT Server513 +Map Dev Addr to remote ID 539 539 515 + 516 +(% style="color:#4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server 517 + 540 540 [[image:image-20220527141843-24.png]] 541 541 520 +Upstream Process 542 542 522 + 543 543 [[image:image-20220527141933-25.png]] 544 544 545 545 Choose ASCII Format ... ... @@ -550,53 +550,29 @@ 550 550 LHT65 Decoder 551 551 552 552 553 -(% style="color:b lue" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.533 +(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream. 554 554 555 -[[image:image-20220 613191426-5.png]]535 +[[image:image-20220527142115-27.png]] 556 556 537 +Subscribe to a topic 557 557 558 -(% style="color:blue" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 559 559 540 +(% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 541 + 560 560 [[image:image-20220527142239-28.png]] 561 561 544 +Downstream Flow 562 562 563 -=== 4.5.3 MQTT Downstream format === 564 - 565 - 566 -mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**" 567 - 568 -(% class="box infomessage" %) 569 -((( 570 -**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"** 571 -))) 572 - 573 -mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**" 574 - 575 -(% class="box infomessage" %) 576 -((( 577 -**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello,20,1,SF12,923300000,2"** 578 -))) 579 - 580 -Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]] 581 - 582 -[[image:image-20220613192816-6.png||height="440" width="1056"]] 583 - 584 - 585 585 (% 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"]]** 586 586 587 587 588 - Checkoutthis link formore mosquito-relateddirectives [[https:~~/~~/mosquitto.org/man/mosquitto_pub-1.html>>https://mosquitto.org/man/mosquitto_pub-1.html]]549 += 5. How to Debug = 589 589 590 - 591 -= 5. How to Debug = 592 - 593 - 594 594 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. 595 595 596 596 597 -= 6. 554 += 6. How to ask for Support = 598 598 599 - 600 600 If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info: 601 601 602 602 * 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