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,13 +1,8 @@ 1 - **~ontents:**1 += INTRODUCTION = 2 2 3 -{{toc/}} 4 - 5 - 6 -= 1. Introduction = 7 - 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 -== 1.1Support Devices ==5 +== Support Devices == 11 11 12 12 This MQTT forward instruction is for below devices: 13 13 ... ... @@ -20,8 +20,10 @@ 20 20 * MS14 series if installed with the same firmware. (in this case, the MQTT forward will work , but no LoRa support) 21 21 22 22 23 - =2. Firmware Change Log for MQTT feature =18 +\\ 24 24 20 += Firmware Change Log for MQTT feature = 21 + 25 25 This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware. 26 26 27 27 * LG02_LG08-5.3.1580178039 ... ... @@ -28,10 +28,12 @@ 28 28 ** Initiate version 29 29 30 30 31 - =3. MQTT forward operating principle =28 +\\ 32 32 33 -= =3.1NetworkStructure ==30 += MQTT forward operating principle = 34 34 32 +== Network Structure == 33 + 35 35 Below shows the network structure for MQTT forwarding. 36 36 37 37 * 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,11 +41,11 @@ 41 41 42 42 General MQTT structure 43 43 44 -== 3.2How sensor data is forwarded ==43 +== How sensor data is forwarded == 45 45 46 46 In this MQTT forward feature, the key point is how the gateway process the sensor data. 47 47 48 -=== 3.2.1Upstream ===47 +=== Upstream === 49 49 50 50 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. 51 51 ... ... @@ -57,7 +57,7 @@ 57 57 58 58 Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span> 59 59 60 -=== 3.2.2Downstream ===59 +=== Downstream === 61 61 62 62 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. 63 63 ... ... @@ -68,13 +68,13 @@ 68 68 Downstream path 69 69 70 70 71 -== 3.3Macro Definition ==70 +== Macro Definition == 72 72 73 73 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 74 74 75 75 Currently the -t (topic) and -m (message) support Macros. 76 76 77 -=== 3.3.1-t topic macro ===76 +=== -t topic macro === 78 78 79 79 * CHANNEL: Remote Channel ID 80 80 * CLIENTID: Client ID , Same as -i ... ... @@ -82,7 +82,7 @@ 82 82 * USERNAME: User ID (-u) 83 83 * HOSTNAME: Device Hostname 84 84 85 -=== 3.3.2-m message macro ===84 +=== -m message macro === 86 86 87 87 * HOSTNAME: Device Hostname 88 88 * CHANNEL: Remote Channel ID ... ... @@ -90,7 +90,7 @@ 90 90 * META: Completely sensor data with time stamp and rssi 91 91 * JSON: Convert META to json format. 92 92 93 -=== 3.3.3Example for Macro ===92 +=== Example for Macro === 94 94 95 95 [[~[~[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]] 96 96 ... ... @@ -110,8 +110,11 @@ 110 110 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. 111 111 112 112 113 - ==3.4 Modify the MQTT to support more options ==112 +\\ 114 114 114 + 115 +== Modify the MQTT to support more options == 116 + 115 115 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: 116 116 117 117 {{{root@dragino-1ec39c:~# mosquitto_pub --help ... ... @@ -238,13 +238,13 @@ 238 238 fi}}} 239 239 240 240 241 -= 4.Example to communicate to a simple MQTT server =243 += Example to communicate to a simple MQTT server = 242 242 243 -== 4.1Overview ==245 +== Overview == 244 244 245 245 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/]]. 246 246 247 -== 4.2Simulate via MQTT.fx utility ==249 +== Simulate via MQTT.fx utility == 248 248 249 249 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. 250 250 ... ... @@ -267,7 +267,7 @@ 267 267 Downstream: Subscribe a topic to get downstream 268 268 269 269 270 -== 4.3Simulate via Dragino Command Line ==272 +== Simulate via Dragino Command Line == 271 271 272 272 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. 273 273 ... ... @@ -295,7 +295,7 @@ 295 295 296 296 mosquitto_sub 297 297 298 -== 4.4Configure Dragino UI for MQTT connection ==300 +== Configure Dragino UI for MQTT connection == 299 299 300 300 This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection. 301 301 ... ... @@ -311,7 +311,7 @@ 311 311 312 312 forward to MQTT 313 313 314 -=== 4.4.1Configure the MQTT Client for Upstream ===316 +=== Configure the MQTT Client for Upstream === 315 315 316 316 Below screenshot is same as the publish command: 317 317 ... ... @@ -345,7 +345,7 @@ 345 345 MQTT Publish 346 346 347 347 348 -=== 4.4.2Configure the MQTT Client for Downstream ===350 +=== Configure the MQTT Client for Downstream === 349 349 350 350 Below screen shot equal to this subscribe command: 351 351 ... ... @@ -373,11 +373,11 @@ 373 373 374 374 \\ 375 375 376 -== 4.5Add LoRa support to communicate with remote sensor ==378 +== Add LoRa support to communicate with remote sensor == 377 377 378 378 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. 379 379 380 -=== 4.5.1Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===382 +=== Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 381 381 382 382 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. 383 383 ... ... @@ -407,7 +407,7 @@ 407 407 Downstream Data Flow 408 408 409 409 410 -=== 4.5.2Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===412 +=== Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 411 411 412 412 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. 413 413 ... ... @@ -470,7 +470,7 @@ 470 470 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]] 471 471 472 472 473 -= 5.Example For Different MQTT Servers =475 += Example For Different MQTT Servers = 474 474 475 475 |=((( 476 476 [[~[~[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]] ... ... @@ -496,11 +496,11 @@ 496 496 ))) 497 497 498 498 499 -= 6.How to Debug =501 += How to Debug = 500 500 501 501 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. 502 502 503 -= 7.How to ask for Support =505 += How to ask for Support = 504 504 505 505 If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info: 506 506