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)
Details
- Page properties
-
- Content
-
... ... @@ -1,11 +1,8 @@ 1 - 1 += INTRODUCTION = 2 2 3 - 4 -= 1. Introduction = 5 - 6 6 Dragino LoRa/LoRaWAN gateway support MQTT forwarding. It can forward the sensor data from LoRa network to MQTT server , and vice verse. 7 7 8 -== 1.1Support Devices ==5 +== Support Devices == 9 9 10 10 This MQTT forward instruction is for below devices: 11 11 ... ... @@ -18,8 +18,10 @@ 18 18 * MS14 series if installed with the same firmware. (in this case, the MQTT forward will work , but no LoRa support) 19 19 20 20 21 - =2. Firmware Change Log for MQTT feature =18 +\\ 22 22 20 += Firmware Change Log for MQTT feature = 21 + 23 23 This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware. 24 24 25 25 * LG02_LG08-5.3.1580178039 ... ... @@ -26,10 +26,12 @@ 26 26 ** Initiate version 27 27 28 28 29 - =3. MQTT forward operating principle =28 +\\ 30 30 31 -= =3.1NetworkStructure ==30 += MQTT forward operating principle = 32 32 32 +== Network Structure == 33 + 33 33 Below shows the network structure for MQTT forwarding. 34 34 35 35 * 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. ... ... @@ -39,11 +39,11 @@ 39 39 40 40 General MQTT structure 41 41 42 -== 3.2How sensor data is forwarded ==43 +== How sensor data is forwarded == 43 43 44 44 In this MQTT forward feature, the key point is how the gateway process the sensor data. 45 45 46 -=== 3.2.1Upstream ===47 +=== Upstream === 47 47 48 48 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. 49 49 ... ... @@ -55,7 +55,7 @@ 55 55 56 56 Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span> 57 57 58 -=== 3.2.2Downstream ===59 +=== Downstream === 59 59 60 60 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. 61 61 ... ... @@ -66,13 +66,13 @@ 66 66 Downstream path 67 67 68 68 69 -== 3.3Macro Definition ==70 +== Macro Definition == 70 70 71 71 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 72 72 73 73 Currently the -t (topic) and -m (message) support Macros. 74 74 75 -=== 3.3.1-t topic macro ===76 +=== -t topic macro === 76 76 77 77 * CHANNEL: Remote Channel ID 78 78 * CLIENTID: Client ID , Same as -i ... ... @@ -80,7 +80,7 @@ 80 80 * USERNAME: User ID (-u) 81 81 * HOSTNAME: Device Hostname 82 82 83 -=== 3.3.2-m message macro ===84 +=== -m message macro === 84 84 85 85 * HOSTNAME: Device Hostname 86 86 * CHANNEL: Remote Channel ID ... ... @@ -88,7 +88,7 @@ 88 88 * META: Completely sensor data with time stamp and rssi 89 89 * JSON: Convert META to json format. 90 90 91 -=== 3.3.3Example for Macro ===92 +=== Example for Macro === 92 92 93 93 [[~[~[image:https://wiki.dragino.com/images/thumb/c/c7/MQTT_Command_9.png/600px-MQTT_Command_9.png~|~|height="385" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_9.png]] 94 94 ... ... @@ -108,8 +108,11 @@ 108 108 According to above macro. Gateway will publish field1=22.0&field2=49.0 to topic: dragino-1b7060/78901/data, where 78901 is the remote channel for this node ID. 109 109 110 110 111 - ==3.4 Modify the MQTT to support more options ==112 +\\ 112 112 114 + 115 +== Modify the MQTT to support more options == 116 + 113 113 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: 114 114 115 115 {{{root@dragino-1ec39c:~# mosquitto_pub --help ... ... @@ -236,13 +236,13 @@ 236 236 fi}}} 237 237 238 238 239 -= 4.Example to communicate to a simple MQTT server =243 += Example to communicate to a simple MQTT server = 240 240 241 -== 4.1Overview ==245 +== Overview == 242 242 243 243 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/]]. 244 244 245 -== 4.2Simulate via MQTT.fx utility ==249 +== Simulate via MQTT.fx utility == 246 246 247 247 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. 248 248 ... ... @@ -265,7 +265,7 @@ 265 265 Downstream: Subscribe a topic to get downstream 266 266 267 267 268 -== 4.3Simulate via Dragino Command Line ==272 +== Simulate via Dragino Command Line == 269 269 270 270 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. 271 271 ... ... @@ -293,7 +293,7 @@ 293 293 294 294 mosquitto_sub 295 295 296 -== 4.4Configure Dragino UI for MQTT connection ==300 +== Configure Dragino UI for MQTT connection == 297 297 298 298 This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection. 299 299 ... ... @@ -309,7 +309,7 @@ 309 309 310 310 forward to MQTT 311 311 312 -=== 4.4.1Configure the MQTT Client for Upstream ===316 +=== Configure the MQTT Client for Upstream === 313 313 314 314 Below screenshot is same as the publish command: 315 315 ... ... @@ -343,7 +343,7 @@ 343 343 MQTT Publish 344 344 345 345 346 -=== 4.4.2Configure the MQTT Client for Downstream ===350 +=== Configure the MQTT Client for Downstream === 347 347 348 348 Below screen shot equal to this subscribe command: 349 349 ... ... @@ -371,11 +371,11 @@ 371 371 372 372 \\ 373 373 374 -== 4.5Add LoRa support to communicate with remote sensor ==378 +== Add LoRa support to communicate with remote sensor == 375 375 376 376 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. 377 377 378 -=== 4.5.1Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===382 +=== Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 379 379 380 380 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. 381 381 ... ... @@ -405,7 +405,7 @@ 405 405 Downstream Data Flow 406 406 407 407 408 -=== 4.5.2Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===412 +=== Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 409 409 410 410 Since firmware LG02_LG08~-~-build-v5.3.1585192026-20200326-1109, Dragino LoRaWAN gateways support the communication to LoRaWAN 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. 411 411 ... ... @@ -468,7 +468,7 @@ 468 468 Notice: The text use for Downstream must meet the requirement from [[LG308 Downstream Payload>>url:https://wiki.dragino.com/index.php/Communication_with_ABP_End_Node#Downstream]] 469 469 470 470 471 -= 5.Example For Different MQTT Servers =475 += Example For Different MQTT Servers = 472 472 473 473 |=((( 474 474 [[~[~[image:https://wiki.dragino.com/images/thumb/7/73/ThingSpeak1.png/200px-ThingSpeak1.png~|~|alt="ThingSpeak1.png" height="98" width="200"~]~]>>url:https://wiki.dragino.com/index.php/File:ThingSpeak1.png]] ... ... @@ -494,11 +494,11 @@ 494 494 ))) 495 495 496 496 497 -= 6.How to Debug =501 += How to Debug = 498 498 499 499 User can login the gateway's console and run **logread -f**. It will shows the output when there is packet arrive.User can see if it is correct. 500 500 501 -= 7.How to ask for Support =505 += How to ask for Support = 502 502 503 503 If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info: 504 504