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