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,10 +20,9 @@ 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 24 25 -= 2. Firmware Change Log for MQTT feature = 26 - 27 27 ((( 28 28 This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware. 29 29 ))) ... ... @@ -31,16 +31,16 @@ 31 31 * LG02_LG08-5.3.1580178039 32 32 ** Initiate version 33 33 35 += 3. MQTT forward operating principle = 34 34 35 35 36 -= 3. MQTT forwardoperatingprinciple =38 +== 3.1 Network Structure == 37 37 38 -== 3.1 Network Structure == 39 39 40 40 Below shows the network structure for MQTT forwarding. 41 41 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, 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, 44 44 45 45 [[image:image-20220527133547-1.png]] 46 46 ... ... @@ -47,12 +47,13 @@ 47 47 General MQTT structure 48 48 49 49 50 -== 3.2 How sensor data is forwarded == 51 +== 3.2 How sensor data is forwarded == 51 51 53 + 52 52 In this MQTT forward feature, the key point is how the gateway process the sensor data. 53 53 54 54 55 -=== 3.2.1 Upstream === 57 +=== 3.2.1 Upstream === 56 56 57 57 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. 58 58 ... ... @@ -64,10 +64,12 @@ 64 64 65 65 ((( 66 66 Upstream path 69 + 70 + 67 67 ))) 68 68 69 69 ((( 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> 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>** 71 71 ))) 72 72 73 73 ((( ... ... @@ -74,8 +74,9 @@ 74 74 75 75 ))) 76 76 77 -=== 3.2.2 Downstream === 81 +=== 3.2.2 Downstream === 78 78 83 + 79 79 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. 80 80 81 81 ((( ... ... @@ -87,8 +87,9 @@ 87 87 Downstream path 88 88 89 89 90 -== 3.3 Macro Definition == 95 +== 3.3 Macro Definition == 91 91 97 + 92 92 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 93 93 94 94 ((( ... ... @@ -97,8 +97,9 @@ 97 97 98 98 ))) 99 99 100 -=== 3.3.1 -t topic macro === 106 +=== 3.3.1 -t topic macro === 101 101 108 + 102 102 * CHANNEL: Remote Channel ID 103 103 * CLIENTID: Client ID , Same as -i 104 104 * WRITE_API: Remote Channel Write API ... ... @@ -106,8 +106,8 @@ 106 106 * HOSTNAME: Device Hostname 107 107 108 108 116 +=== 3.3.2 -m message macro === 109 109 110 -=== 3.3.2 -m message macro === 111 111 112 112 * HOSTNAME: Device Hostname 113 113 * CHANNEL: Remote Channel ID ... ... @@ -116,8 +116,8 @@ 116 116 * JSON: Convert META to json format. 117 117 118 118 126 +=== 3.3.3 Example for Macro === 119 119 120 -=== 3.3.3 Example for Macro === 121 121 122 122 [[image:image-20220527134251-4.png]] 123 123 ... ... @@ -124,7 +124,7 @@ 124 124 MQTT Publish configure 125 125 126 126 127 -Above screen shots shows below format: 134 +**Above screen shots shows below format:** 128 128 129 129 * -t: CLIENTID/CHANNEL/data 130 130 * -m: DATA ... ... @@ -141,8 +141,10 @@ 141 141 ))) 142 142 143 143 144 -== 3.4 Modify the MQTT to support more options == 145 145 152 +== 3.4 Modify the MQTT to support more options == 153 + 154 + 146 146 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: 147 147 148 148 (% class="box" %) ... ... @@ -160,9 +160,9 @@ 160 160 [-u username [-P password]] 161 161 [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]] 162 162 [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file] 163 - 164 - 165 - 172 + [~-~-ciphers ciphers] [~-~-insecure] 173 + [~-~-tls-alpn protocol] 174 + [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]] 166 166 [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]] 167 167 [~-~-proxy socks-url] 168 168 [~-~-property command identifier value] ... ... @@ -267,15 +267,19 @@ 267 267 ))) 268 268 269 269 270 -= 4. Example to communicate to a simple MQTT server = 271 271 272 -= =4.1Overview==280 += 4. Example to communicate to a simple MQTT server = 273 273 282 + 283 +== 4.1 Overview == 284 + 285 + 274 274 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/]]. 275 275 276 276 277 -== 4.2 Simulate via MQTT.fx utility == 289 +== 4.2 Simulate via MQTT.fx utility == 278 278 291 + 279 279 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. 280 280 281 281 ((( ... ... @@ -301,14 +301,15 @@ 301 301 Downstream: Subscribe a topic to get downstream 302 302 303 303 304 -== 4.3 Simulate via Dragino Command Line == 305 305 318 +== 4.3 Simulate via Dragino Command Line == 319 + 306 306 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. 307 307 308 308 In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection. 309 309 310 310 311 -(% style="color: #4f81bd" %)**For Upstream**325 +(% style="color:blue" %)**For Upstream** 312 312 313 313 command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]] 314 314 ... ... @@ -321,8 +321,9 @@ 321 321 mosquitto_pub 322 322 323 323 324 -(% style="color:#4f81bd" %)**For Downstream** 325 325 339 +(% style="color:blue" %)**For Downstream** 340 + 326 326 Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic. 327 327 328 328 [[image:image-20220527135440-10.png]] ... ... @@ -330,7 +330,7 @@ 330 330 mosquitto_sub 331 331 332 332 333 -== 4.4 Configure Dragino UI for MQTT connection == 348 +== 4.4 Configure Dragino UI for MQTT connection == 334 334 335 335 This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection. 336 336 ... ... @@ -338,7 +338,7 @@ 338 338 Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client** 339 339 ))) 340 340 341 -[[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]] 342 342 343 343 go to mqtt configure menu 344 344 ... ... @@ -352,24 +352,28 @@ 352 352 forward to MQTT 353 353 354 354 355 -=== 4.4.1 Configure the MQTT Client for Upstream === 356 356 357 - Belowscreenshotis sameasthepublishcommand:371 +=== 4.4.1 Configure the MQTT Client for Upstream === 358 358 373 + 374 +**Below screenshot is same as the publish command:** 375 + 359 359 (% class="box" %) 360 360 ((( 361 -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 362 362 ~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for 363 363 ~/~/CLIENTID: dragino-1b7060 364 364 ~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456 365 -~/~/DATA: The data stores in /var/iot/channels/ 382 +~/~/DATA: The data stores in /var/iot/channels/** 366 366 ))) 367 367 385 + 368 368 [[image:image-20220527135828-12.png]] 369 369 370 370 MQTT Publish configure 371 371 372 372 391 + 373 373 [[image:image-20220527135929-13.png]] 374 374 375 375 MQTT Channel settings ... ... @@ -398,8 +398,10 @@ 398 398 MQTT Publish 399 399 400 400 401 -=== 4.4.2 Configure the MQTT Client for Downstream === 402 402 421 +=== 4.4.2 Configure the MQTT Client for Downstream === 422 + 423 + 403 403 Below screen shot equal to this subscribe command: 404 404 405 405 (% class="box" %) ... ... @@ -428,13 +428,15 @@ 428 428 downstream simulation 429 429 430 430 431 -== 4.5 Add LoRa support to communicate with remote sensor == 452 +== 4.5 Add LoRa support to communicate with remote sensor == 432 432 454 + 433 433 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. 434 434 435 435 436 -=== 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 === 437 437 460 + 438 438 ((( 439 439 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. 440 440 ))) ... ... @@ -445,6 +445,8 @@ 445 445 446 446 ((( 447 447 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 + 448 448 ))) 449 449 450 450 ((( ... ... @@ -474,8 +474,10 @@ 474 474 Downstream Data Flow 475 475 476 476 477 -=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 478 478 503 +=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 504 + 505 + 479 479 ((( 480 480 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. 481 481 ))) ... ... @@ -482,15 +482,17 @@ 482 482 483 483 ((( 484 484 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 + 485 485 (% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 486 486 ))) 487 487 488 488 ((( 489 -(% 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. 490 490 ))) 491 491 492 492 ((( 493 -(% 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. 494 494 ))) 495 495 496 496 [[image:image-20220527141235-21.png]] ... ... @@ -500,27 +500,24 @@ 500 500 501 501 ((( 502 502 ((( 503 -(% 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**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. 504 504 ))) 505 505 ))) 506 506 507 -[[image:image-20220 527141450-22.png]]536 +[[image:image-20220613191345-4.png]] 508 508 509 -Publish mush use META as data format for LG308 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 -[[image:image-20220 527141727-23.png]]542 +[[image:image-20220613190635-2.png]] 515 515 516 -Map Dev Addr to remote ID 517 517 518 518 519 -(% 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 520 520 521 521 [[image:image-20220527141843-24.png]] 522 522 523 -Upstream Process 524 524 525 525 526 526 ... ... @@ -536,30 +536,56 @@ 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 -[[image:image-20220 527142115-27.png]]567 +[[image:image-20220613191426-5.png]] 542 542 543 -Subscribe to a topic 544 544 545 545 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 -(% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 548 - 549 549 [[image:image-20220527142239-28.png]] 550 550 551 -Downstream Flow 552 552 576 + 577 +=== 4.5.3 MQTT Downstream format === 578 + 579 + 580 +mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**" 581 + 582 +(% class="box infomessage" %) 583 +((( 584 +**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"** 585 +))) 586 + 587 +mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**" 588 + 589 +(% class="box infomessage" %) 590 +((( 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"** 592 +))) 593 + 594 +Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]] 595 + 596 +[[image:image-20220613192816-6.png||height="440" width="1056"]] 597 + 598 + 553 553 (% 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"]]** 554 554 555 555 556 - =5.HowtoDebug=602 +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]] 557 557 604 + 605 + 606 += 5. How to Debug = 607 + 608 + 558 558 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. 559 559 560 560 561 -= 6. How to ask for Support = 612 += 6. How to ask for Support = 562 562 614 + 563 563 If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info: 564 564 565 565 * 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