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, 1 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Kilight1 +XWiki.Xiaoling - Content
-
... ... @@ -1,15 +1,17 @@ 1 -**~ Contents:** 1 +**~ Table of Contents:** 2 2 3 3 {{toc/}} 4 4 5 5 6 -= 1. Introduction = 6 += 1. Introduction = 7 7 8 + 8 8 Dragino LoRa/LoRaWAN gateway support MQTT forwarding. It can forward the sensor data from LoRa network to MQTT server , and vice verse. 9 9 10 10 11 -== 1.1 Support Devices == 12 +== 1.1 Support Devices == 12 12 14 + 13 13 This MQTT forward instruction is for below devices: 14 14 15 15 * Firmware Version > LG02_LG08-5.3.1580178039 [[Firmware Download>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]] ... ... @@ -20,8 +20,8 @@ 20 20 * LIG16 21 21 * MS14 series if installed with the same firmware. (in this case, the MQTT forward will work , but no LoRa support) 22 22 25 += 2. Firmware Change Log for MQTT feature = 23 23 24 -= 2. Firmware Change Log for MQTT feature = 25 25 26 26 ((( 27 27 This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware. ... ... @@ -30,15 +30,16 @@ 30 30 * LG02_LG08-5.3.1580178039 31 31 ** Initiate version 32 32 35 += 3. MQTT forward operating principle = 33 33 34 -= 3. MQTT forward operating principle = 35 35 36 -== 3.1 Network Structure == 38 +== 3.1 Network Structure == 37 37 40 + 38 38 Below shows the network structure for MQTT forwarding. 39 39 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, 43 +* **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. 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, 42 42 43 43 [[image:image-20220527133547-1.png]] 44 44 ... ... @@ -45,12 +45,13 @@ 45 45 General MQTT structure 46 46 47 47 48 -== 3.2 How sensor data is forwarded == 51 +== 3.2 How sensor data is forwarded == 49 49 53 + 50 50 In this MQTT forward feature, the key point is how the gateway process the sensor data. 51 51 52 52 53 -=== 3.2.1 Upstream === 57 +=== 3.2.1 Upstream === 54 54 55 55 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. 56 56 ... ... @@ -62,10 +62,12 @@ 62 62 63 63 ((( 64 64 Upstream path 69 + 70 + 65 65 ))) 66 66 67 67 ((( 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> 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>** 69 69 ))) 70 70 71 71 ((( ... ... @@ -72,8 +72,9 @@ 72 72 73 73 ))) 74 74 75 -=== 3.2.2 Downstream === 81 +=== 3.2.2 Downstream === 76 76 83 + 77 77 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. 78 78 79 79 ((( ... ... @@ -85,8 +85,9 @@ 85 85 Downstream path 86 86 87 87 88 -== 3.3 Macro Definition == 95 +== 3.3 Macro Definition == 89 89 97 + 90 90 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 91 91 92 92 ((( ... ... @@ -95,8 +95,9 @@ 95 95 96 96 ))) 97 97 98 -=== 3.3.1 -t topic macro === 106 +=== 3.3.1 -t topic macro === 99 99 108 + 100 100 * CHANNEL: Remote Channel ID 101 101 * CLIENTID: Client ID , Same as -i 102 102 * WRITE_API: Remote Channel Write API ... ... @@ -104,8 +104,9 @@ 104 104 * HOSTNAME: Device Hostname 105 105 106 106 107 -=== 3.3.2 -m message macro === 116 +=== 3.3.2 -m message macro === 108 108 118 + 109 109 * HOSTNAME: Device Hostname 110 110 * CHANNEL: Remote Channel ID 111 111 * DATA: Sensor Data without time stamp and rssi ... ... @@ -113,14 +113,15 @@ 113 113 * JSON: Convert META to json format. 114 114 115 115 116 -=== 3.3.3 Example for Macro === 126 +=== 3.3.3 Example for Macro === 117 117 128 + 118 118 [[image:image-20220527134251-4.png]] 119 119 120 120 MQTT Publish configure 121 121 122 122 123 -Above screen shots shows below format: 134 +**Above screen shots shows below format:** 124 124 125 125 * -t: CLIENTID/CHANNEL/data 126 126 * -m: DATA ... ... @@ -137,8 +137,10 @@ 137 137 ))) 138 138 139 139 140 -== 3.4 Modify the MQTT to support more options == 141 141 152 +== 3.4 Modify the MQTT to support more options == 153 + 154 + 142 142 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: 143 143 144 144 (% class="box" %) ... ... @@ -156,9 +156,9 @@ 156 156 [-u username [-P password]] 157 157 [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]] 158 158 [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file] 159 - 160 - 161 - 172 + [~-~-ciphers ciphers] [~-~-insecure] 173 + [~-~-tls-alpn protocol] 174 + [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]] 162 162 [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]] 163 163 [~-~-proxy socks-url] 164 164 [~-~-property command identifier value] ... ... @@ -263,15 +263,19 @@ 263 263 ))) 264 264 265 265 266 -= 4. Example to communicate to a simple MQTT server = 267 267 268 -= =4.1Overview==280 += 4. Example to communicate to a simple MQTT server = 269 269 282 + 283 +== 4.1 Overview == 284 + 285 + 270 270 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/]]. 271 271 272 272 273 -== 4.2 Simulate via MQTT.fx utility == 289 +== 4.2 Simulate via MQTT.fx utility == 274 274 291 + 275 275 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. 276 276 277 277 ((( ... ... @@ -297,14 +297,15 @@ 297 297 Downstream: Subscribe a topic to get downstream 298 298 299 299 300 -== 4.3 Simulate via Dragino Command Line == 301 301 318 +== 4.3 Simulate via Dragino Command Line == 319 + 302 302 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. 303 303 304 304 In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection. 305 305 306 306 307 -(% style="color: #4f81bd" %)**For Upstream**325 +(% style="color:blue" %)**For Upstream** 308 308 309 309 command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]] 310 310 ... ... @@ -317,8 +317,9 @@ 317 317 mosquitto_pub 318 318 319 319 320 -(% style="color:#4f81bd" %)**For Downstream** 321 321 339 +(% style="color:blue" %)**For Downstream** 340 + 322 322 Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic. 323 323 324 324 [[image:image-20220527135440-10.png]] ... ... @@ -326,7 +326,7 @@ 326 326 mosquitto_sub 327 327 328 328 329 -== 4.4 Configure Dragino UI for MQTT connection == 348 +== 4.4 Configure Dragino UI for MQTT connection == 330 330 331 331 This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection. 332 332 ... ... @@ -334,7 +334,7 @@ 334 334 Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client** 335 335 ))) 336 336 337 -[[image: https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]]356 +[[image:image-20220714155901-1.png]] 338 338 339 339 go to mqtt configure menu 340 340 ... ... @@ -348,24 +348,28 @@ 348 348 forward to MQTT 349 349 350 350 351 -=== 4.4.1 Configure the MQTT Client for Upstream === 352 352 353 - Belowscreenshotis sameasthepublishcommand:371 +=== 4.4.1 Configure the MQTT Client for Upstream === 354 354 373 + 374 +**Below screenshot is same as the publish command:** 375 + 355 355 (% class="box" %) 356 356 ((( 357 -mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA 378 +**mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA 358 358 ~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for 359 359 ~/~/CLIENTID: dragino-1b7060 360 360 ~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456 361 -~/~/DATA: The data stores in /var/iot/channels/ 382 +~/~/DATA: The data stores in /var/iot/channels/** 362 362 ))) 363 363 385 + 364 364 [[image:image-20220527135828-12.png]] 365 365 366 366 MQTT Publish configure 367 367 368 368 391 + 369 369 [[image:image-20220527135929-13.png]] 370 370 371 371 MQTT Channel settings ... ... @@ -394,8 +394,10 @@ 394 394 MQTT Publish 395 395 396 396 397 -=== 4.4.2 Configure the MQTT Client for Downstream === 398 398 421 +=== 4.4.2 Configure the MQTT Client for Downstream === 422 + 423 + 399 399 Below screen shot equal to this subscribe command: 400 400 401 401 (% class="box" %) ... ... @@ -424,13 +424,15 @@ 424 424 downstream simulation 425 425 426 426 427 -== 4.5 Add LoRa support to communicate with remote sensor == 452 +== 4.5 Add LoRa support to communicate with remote sensor == 428 428 454 + 429 429 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. 430 430 431 431 432 -=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 458 +=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 433 433 460 + 434 434 ((( 435 435 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. 436 436 ))) ... ... @@ -441,6 +441,8 @@ 441 441 442 442 ((( 443 443 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 + 444 444 ))) 445 445 446 446 ((( ... ... @@ -470,8 +470,10 @@ 470 470 Downstream Data Flow 471 471 472 472 473 -=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 474 474 503 +=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 504 + 505 + 475 475 ((( 476 476 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. 477 477 ))) ... ... @@ -478,15 +478,17 @@ 478 478 479 479 ((( 480 480 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 + 481 481 (% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 482 482 ))) 483 483 484 484 ((( 485 -(% 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.518 +(% style="color:blued" %)**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 486 ))) 487 487 488 488 ((( 489 -(% style="color: #4f81bd" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.522 +(% style="color:blue" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings. 490 490 ))) 491 491 492 492 [[image:image-20220527141235-21.png]] ... ... @@ -496,7 +496,7 @@ 496 496 497 497 ((( 498 498 ((( 499 -(% 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.532 +(% style="color:blue" %)**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 500 ))) 501 501 ))) 502 502 ... ... @@ -504,13 +504,13 @@ 504 504 505 505 506 506 507 -(% style="color: #4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.540 +(% style="color:blue" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server. 508 508 509 509 [[image:image-20220613190635-2.png]] 510 510 511 511 512 512 513 -(% style="color: #4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server546 +(% style="color:blue" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server 514 514 515 515 [[image:image-20220527141843-24.png]] 516 516 ... ... @@ -529,19 +529,19 @@ 529 529 530 530 531 531 532 -(% style="color: #4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.565 +(% style="color:blue" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream. 533 533 534 534 [[image:image-20220613191426-5.png]] 535 535 536 536 537 537 538 -(% style="color: #4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.571 +(% style="color:blue" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 539 539 540 540 [[image:image-20220527142239-28.png]] 541 541 542 542 543 543 544 -=== MQTT Downstream format === 577 +=== 4.5.3 MQTT Downstream format === 545 545 546 546 547 547 mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**" ... ... @@ -548,7 +548,7 @@ 548 548 549 549 (% class="box infomessage" %) 550 550 ((( 551 -mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello" 584 +**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"** 552 552 ))) 553 553 554 554 mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**" ... ... @@ -555,7 +555,7 @@ 555 555 556 556 (% class="box infomessage" %) 557 557 ((( 558 -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" 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"** 559 559 ))) 560 560 561 561 Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]] ... ... @@ -562,17 +562,23 @@ 562 562 563 563 [[image:image-20220613192816-6.png||height="440" width="1056"]] 564 564 598 + 565 565 (% 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"]]** 566 566 601 + 567 567 Check out this link for more mosquito-related directives [[https:~~/~~/mosquitto.org/man/mosquitto_pub-1.html>>https://mosquitto.org/man/mosquitto_pub-1.html]] 568 568 569 -= 5. How to Debug = 570 570 605 + 606 += 5. How to Debug = 607 + 608 + 571 571 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. 572 572 573 573 574 -= 6. How to ask for Support = 612 += 6. How to ask for Support = 575 575 614 + 576 576 If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info: 577 577 578 578 * Detail of your LoRaWAN end node.
- image-20220714155901-1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.Xiaoling - Size
-
... ... @@ -1,0 +1,1 @@ 1 +75.2 KB - Content