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