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, 1 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -22,9 +22,6 @@ 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 - 26 - 27 - 28 28 = 2. Firmware Change Log for MQTT feature = 29 29 30 30 ... ... @@ -35,17 +35,16 @@ 35 35 * LG02_LG08-5.3.1580178039 36 36 ** Initiate version 37 37 35 += 3. MQTT forward operating principle = 38 38 39 39 38 +== 3.1 Network Structure == 40 40 41 -= 3. MQTT forward operating principle = 42 42 43 -== 3.1 Network Structure == 44 - 45 45 Below shows the network structure for MQTT forwarding. 46 46 47 -* 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. 48 -* 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, 49 49 50 50 [[image:image-20220527133547-1.png]] 51 51 ... ... @@ -52,12 +52,13 @@ 52 52 General MQTT structure 53 53 54 54 55 -== 3.2 How sensor data is forwarded == 51 +== 3.2 How sensor data is forwarded == 56 56 53 + 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 Upstream === 57 +=== 3.2.1 Upstream === 61 61 62 62 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. 63 63 ... ... @@ -69,10 +69,12 @@ 69 69 70 70 ((( 71 71 Upstream path 69 + 70 + 72 72 ))) 73 73 74 74 ((( 75 -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>** 76 76 ))) 77 77 78 78 ((( ... ... @@ -79,8 +79,9 @@ 79 79 80 80 ))) 81 81 82 -=== 3.2.2 Downstream === 81 +=== 3.2.2 Downstream === 83 83 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,8 +92,9 @@ 92 92 Downstream path 93 93 94 94 95 -== 3.3 Macro Definition == 95 +== 3.3 Macro Definition == 96 96 97 + 97 97 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 98 98 99 99 ((( ... ... @@ -102,8 +102,9 @@ 102 102 103 103 ))) 104 104 105 -=== 3.3.1 -t topic macro === 106 +=== 3.3.1 -t topic macro === 106 106 108 + 107 107 * CHANNEL: Remote Channel ID 108 108 * CLIENTID: Client ID , Same as -i 109 109 * WRITE_API: Remote Channel Write API ... ... @@ -110,8 +110,10 @@ 110 110 * USERNAME: User ID (-u) 111 111 * HOSTNAME: Device Hostname 112 112 113 -=== 3.3.2 -m message macro === 114 114 116 +=== 3.3.2 -m message macro === 117 + 118 + 115 115 * HOSTNAME: Device Hostname 116 116 * CHANNEL: Remote Channel ID 117 117 * DATA: Sensor Data without time stamp and rssi ... ... @@ -118,14 +118,16 @@ 118 118 * META: Completely sensor data with time stamp and rssi 119 119 * JSON: Convert META to json format. 120 120 121 -=== 3.3.3 Example for Macro === 122 122 126 +=== 3.3.3 Example for Macro === 127 + 128 + 123 123 [[image:image-20220527134251-4.png]] 124 124 125 125 MQTT Publish configure 126 126 127 127 128 -Above screen shots shows below format: 134 +**Above screen shots shows below format:** 129 129 130 130 * -t: CLIENTID/CHANNEL/data 131 131 * -m: DATA ... ... @@ -142,8 +142,10 @@ 142 142 ))) 143 143 144 144 145 -== 3.4 Modify the MQTT to support more options == 146 146 152 +== 3.4 Modify the MQTT to support more options == 153 + 154 + 147 147 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: 148 148 149 149 (% class="box" %) ... ... @@ -161,9 +161,9 @@ 161 161 [-u username [-P password]] 162 162 [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]] 163 163 [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file] 164 - 165 - 166 - 172 + [~-~-ciphers ciphers] [~-~-insecure] 173 + [~-~-tls-alpn protocol] 174 + [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]] 167 167 [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]] 168 168 [~-~-proxy socks-url] 169 169 [~-~-property command identifier value] ... ... @@ -268,15 +268,19 @@ 268 268 ))) 269 269 270 270 271 -= 4. Example to communicate to a simple MQTT server = 272 272 273 -= =4.1Overview==280 += 4. Example to communicate to a simple MQTT server = 274 274 282 + 283 +== 4.1 Overview == 284 + 285 + 275 275 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/]]. 276 276 277 277 278 -== 4.2 Simulate via MQTT.fx utility == 289 +== 4.2 Simulate via MQTT.fx utility == 279 279 291 + 280 280 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. 281 281 282 282 ((( ... ... @@ -302,14 +302,15 @@ 302 302 Downstream: Subscribe a topic to get downstream 303 303 304 304 305 -== 4.3 Simulate via Dragino Command Line == 306 306 318 +== 4.3 Simulate via Dragino Command Line == 319 + 307 307 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. 308 308 309 309 In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection. 310 310 311 311 312 -(% style="color: #4f81bd" %)**For Upstream**325 +(% style="color:blue" %)**For Upstream** 313 313 314 314 command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]] 315 315 ... ... @@ -322,8 +322,9 @@ 322 322 mosquitto_pub 323 323 324 324 325 -(% style="color:#4f81bd" %)**For Downstream** 326 326 339 +(% style="color:blue" %)**For Downstream** 340 + 327 327 Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic. 328 328 329 329 [[image:image-20220527135440-10.png]] ... ... @@ -331,7 +331,7 @@ 331 331 mosquitto_sub 332 332 333 333 334 -== 4.4 Configure Dragino UI for MQTT connection == 348 +== 4.4 Configure Dragino UI for MQTT connection == 335 335 336 336 This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection. 337 337 ... ... @@ -339,7 +339,7 @@ 339 339 Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client** 340 340 ))) 341 341 342 -[[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]] 343 343 344 344 go to mqtt configure menu 345 345 ... ... @@ -353,24 +353,28 @@ 353 353 forward to MQTT 354 354 355 355 356 -=== 4.4.1 Configure the MQTT Client for Upstream === 357 357 358 - Belowscreenshotis sameasthepublishcommand:371 +=== 4.4.1 Configure the MQTT Client for Upstream === 359 359 373 + 374 +**Below screenshot is same as the publish command:** 375 + 360 360 (% class="box" %) 361 361 ((( 362 -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 363 363 ~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for 364 364 ~/~/CLIENTID: dragino-1b7060 365 365 ~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456 366 -~/~/DATA: The data stores in /var/iot/channels/ 382 +~/~/DATA: The data stores in /var/iot/channels/** 367 367 ))) 368 368 385 + 369 369 [[image:image-20220527135828-12.png]] 370 370 371 371 MQTT Publish configure 372 372 373 373 391 + 374 374 [[image:image-20220527135929-13.png]] 375 375 376 376 MQTT Channel settings ... ... @@ -399,8 +399,10 @@ 399 399 MQTT Publish 400 400 401 401 402 -=== 4.4.2 Configure the MQTT Client for Downstream === 403 403 421 +=== 4.4.2 Configure the MQTT Client for Downstream === 422 + 423 + 404 404 Below screen shot equal to this subscribe command: 405 405 406 406 (% class="box" %) ... ... @@ -429,13 +429,15 @@ 429 429 downstream simulation 430 430 431 431 432 -== 4.5 Add LoRa support to communicate with remote sensor == 452 +== 4.5 Add LoRa support to communicate with remote sensor == 433 433 454 + 434 434 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. 435 435 436 436 437 -=== 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 === 438 438 460 + 439 439 ((( 440 440 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. 441 441 ))) ... ... @@ -446,6 +446,8 @@ 446 446 447 447 ((( 448 448 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 + 449 449 ))) 450 450 451 451 ((( ... ... @@ -475,8 +475,10 @@ 475 475 Downstream Data Flow 476 476 477 477 478 -=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 479 479 503 +=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 504 + 505 + 480 480 ((( 481 481 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. 482 482 ))) ... ... @@ -483,15 +483,17 @@ 483 483 484 484 ((( 485 485 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 + 486 486 (% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 487 487 ))) 488 488 489 489 ((( 490 -(% 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. 491 491 ))) 492 492 493 493 ((( 494 -(% 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. 495 495 ))) 496 496 497 497 [[image:image-20220527141235-21.png]] ... ... @@ -501,7 +501,7 @@ 501 501 502 502 ((( 503 503 ((( 504 -(% 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. 505 505 ))) 506 506 ))) 507 507 ... ... @@ -509,13 +509,13 @@ 509 509 510 510 511 511 512 -(% 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. 513 513 514 514 [[image:image-20220613190635-2.png]] 515 515 516 516 517 517 518 -(% 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 519 519 520 520 [[image:image-20220527141843-24.png]] 521 521 ... ... @@ -534,19 +534,19 @@ 534 534 535 535 536 536 537 -(% 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. 538 538 539 539 [[image:image-20220613191426-5.png]] 540 540 541 541 542 542 543 -(% 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. 544 544 545 545 [[image:image-20220527142239-28.png]] 546 546 547 547 548 548 549 -=== MQTT Downstream format === 577 +=== 4.5.3 MQTT Downstream format === 550 550 551 551 552 552 mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**" ... ... @@ -553,7 +553,7 @@ 553 553 554 554 (% class="box infomessage" %) 555 555 ((( 556 -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"** 557 557 ))) 558 558 559 559 mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**" ... ... @@ -560,7 +560,7 @@ 560 560 561 561 (% class="box infomessage" %) 562 562 ((( 563 -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"** 564 564 ))) 565 565 566 566 Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]] ... ... @@ -567,17 +567,23 @@ 567 567 568 568 [[image:image-20220613192816-6.png||height="440" width="1056"]] 569 569 598 + 570 570 (% 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"]]** 571 571 601 + 572 572 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]] 573 573 574 -= 5. How to Debug = 575 575 605 + 606 += 5. How to Debug = 607 + 608 + 576 576 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. 577 577 578 578 579 -= 6. How to ask for Support = 612 += 6. How to ask for Support = 580 580 614 + 581 581 If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info: 582 582 583 583 * 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