Changes for page MQTT Forward Instruction

Last modified by Kilight Cao on 2024/08/31 16:26
<
From version < 1.8 >
edited by Xiaoling
on 2022/05/12 15:57
To version < 1.2 >
edited by Xiaoling
on 2022/05/12 15:37
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,18 +1,13 @@
1 -**~ Contents：**
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.1 Support Devices ==
5 +== Support Devices ==
11 11  
12 12  This MQTT forward instruction is for below devices:
13 13  
14 14  * Firmware Version > LG02_LG08-5.3.1580178039 [[Firmware Download>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]]
15 -* LG01N, OLG01N ((% class="mark" %)**Warning**(%%): LG01-P LG01-S use another instruction: [[MQTT for LG01-P/LG01S>>url:https://wiki.dragino.com/index.php/Through_MQTT_to_upload_data]])
10 +* LG01N, OLG01N (Warning: LG01-P LG01-S use another instruction: [[MQTT for LG01-P/LG01S>>url:https://wiki.dragino.com/index.php/Through_MQTT_to_upload_data]])
16 16  * LG02, OLG02
17 17  * LG308, DLOS8
18 18  * LPS8
... ... @@ -20,79 +20,65 @@
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  
25 -(((
20 += Firmware Change Log for MQTT feature =
21 +
26 26  This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware.
27 -)))
28 28  
29 29  * LG02_LG08-5.3.1580178039
30 30  ** Initiate version
31 31  
32 32  
33 -= 3. MQTT forward operating principle =
28 +\\
34 34  
35 -== 3.1 Network Structure ==
30 += MQTT forward operating principle =
36 36  
32 +== Network Structure ==
33 +
37 37  Below shows the network structure for MQTT forwarding.
38 38  
39 39  * 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 40  * 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,
41 41  
42 -[[image:https://wiki.dragino.com/images/thumb/4/45/MQTT_Forward_1.png/600px-MQTT_Forward_1.png||height="348" width="600"]]
39 +[[~[~[image:https://wiki.dragino.com/images/thumb/4/45/MQTT_Forward_1.png/600px-MQTT_Forward_1.png~|~|height="348" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_1.png]]
43 43  
44 44  General MQTT structure
45 45  
43 +== How sensor data is forwarded ==
46 46  
47 -== 3.2 How sensor data is forwarded ==
48 -
49 49  In this MQTT forward feature, the key point is how the gateway process the sensor data.
50 50  
47 +=== Upstream ===
51 51  
52 -=== 3.2.1 Upstream ===
53 -
54 54  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.
55 55  
56 -(((
57 57  The data flow works as below diagram.
58 -)))
59 59  
60 60  [[~[~[image:https://wiki.dragino.com/images/thumb/2/2a/MQTT_Forward_2.png/600px-MQTT_Forward_2.png~|~|height="355" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_2.png]]
61 61  
62 -(((
63 63  Upstream path
64 -)))
65 65  
66 -(((
67 67  Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span>
68 -)))
69 69  
70 -(((
71 -
72 -)))
59 +=== Downstream ===
73 73  
74 -=== 3.2.2 Downstream ===
75 -
76 76  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.
77 77  
78 -(((
79 79  Below are the data flow for downstream.
80 -)))
81 81  
82 -[[image:https://wiki.dragino.com/images/thumb/3/3a/MQTT_Forward_3.png/600px-MQTT_Forward_3.png||height="368" width="600"]]
65 +[[~[~[image:https://wiki.dragino.com/images/thumb/3/3a/MQTT_Forward_3.png/600px-MQTT_Forward_3.png~|~|height="368" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_3.png]]
83 83  
84 84  Downstream path
85 85  
86 86  
87 -== 3.3 Macro Definition ==
70 +== Macro Definition ==
88 88  
89 89  The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish.
90 90  
91 -(((
92 -Currently the (% class="mark" %)**-t (topic)**(%%) and (% class="mark" %)**-m (message)**(%%) support Macros.
93 -)))
74 +Currently the -t (topic) and -m (message) support Macros.
94 94  
95 -=== 3.3.1 -t topic macro ===
76 +=== -t topic macro ===
96 96  
97 97  * CHANNEL: Remote Channel ID
98 98  * CLIENTID: Client ID , Same as -i
... ... @@ -100,7 +100,7 @@
100 100  * USERNAME: User ID (-u)
101 101  * HOSTNAME: Device Hostname
102 102  
103 -=== 3.3.2 -m message macro ===
84 +=== -m message macro ===
104 104  
105 105  * HOSTNAME: Device Hostname
106 106  * CHANNEL: Remote Channel ID
... ... @@ -108,9 +108,9 @@
108 108  * META: Completely sensor data with time stamp and rssi
109 109  * JSON: Convert META to json format.
110 110  
111 -=== 3.3.3 Example for Macro ===
92 +=== Example for Macro ===
112 112  
113 -[[image:https://wiki.dragino.com/images/thumb/c/c7/MQTT_Command_9.png/600px-MQTT_Command_9.png||height="385" width="600"]]
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]]
114 114  
115 115  MQTT Publish configure
116 116  
... ... @@ -121,17 +121,18 @@
121 121  
122 122  When there is a LoRa sensor arrive. it will be store at the /var/iot/channels as below:
123 123  
124 -[[image:https://wiki.dragino.com/images/thumb/c/c4/MQTT_Command_20.png/600px-MQTT_Command_20.png||height="325" width="600"]]
105 +[[~[~[image:https://wiki.dragino.com/images/thumb/c/c4/MQTT_Command_20.png/600px-MQTT_Command_20.png~|~|height="325" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_20.png]]
125 125  
126 126  Sensor Data
127 127  
128 -(((
129 -According to above macro. Gateway will publish (% class="mark" %)**field1=22.0&field2=49.0**(%%) to topic: (% class="mark" %)**dragino-1b7060/78901/data**(%%), where 78901 is the remote channel for this node ID.
130 -)))
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.
131 131  
132 132  
133 -== 3.4 Modify the MQTT to support more options ==
112 +\\
134 134  
114 +
115 +== Modify the MQTT to support more options ==
116 +
135 135  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:
136 136  
137 137  {{{root@dragino-1ec39c:~# mosquitto_pub --help
... ... @@ -258,13 +258,13 @@
258 258  fi}}}
259 259  
260 260  
261 -= 4. Example to communicate to a simple MQTT server =
243 += Example to communicate to a simple MQTT server =
262 262  
263 -== 4.1 Overview ==
245 +== Overview ==
264 264  
265 265  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/]].
266 266  
267 -== 4.2 Simulate via MQTT.fx utility ==
249 +== Simulate via MQTT.fx utility ==
268 268  
269 269  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.
270 270  
... ... @@ -287,7 +287,7 @@
287 287  Downstream: Subscribe a topic to get downstream
288 288  
289 289  
290 -== 4.3 Simulate via Dragino Command Line ==
272 +== Simulate via Dragino Command Line ==
291 291  
292 292  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.
293 293  
... ... @@ -315,7 +315,7 @@
315 315  
316 316  mosquitto_sub
317 317  
318 -== 4.4 Configure Dragino UI for MQTT connection ==
300 +== Configure Dragino UI for MQTT connection ==
319 319  
320 320  This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection.
321 321  
... ... @@ -331,7 +331,7 @@
331 331  
332 332  forward to MQTT
333 333  
334 -=== 4.4.1 Configure the MQTT Client for Upstream ===
316 +=== Configure the MQTT Client for Upstream ===
335 335  
336 336  Below screenshot is same as the publish command:
337 337  
... ... @@ -365,7 +365,7 @@
365 365  MQTT Publish
366 366  
367 367  
368 -=== 4.4.2 Configure the MQTT Client for Downstream ===
350 +=== Configure the MQTT Client for Downstream ===
369 369  
370 370  Below screen shot equal to this subscribe command:
371 371  
... ... @@ -391,12 +391,13 @@
391 391  downstream simulation
392 392  
393 393  
376 +\\
394 394  
395 -== 4.5 Add LoRa support to communicate with remote sensor ==
378 +== Add LoRa support to communicate with remote sensor ==
396 396  
397 397  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.
398 398  
399 -=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
382 +=== Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
400 400  
401 401  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.
402 402  
... ... @@ -426,7 +426,7 @@
426 426  Downstream Data Flow
427 427  
428 428  
429 -=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
412 +=== Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
430 430  
431 431  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.
432 432  
... ... @@ -433,8 +433,7 @@
433 433  When use test this feature, please use the version higher then : LG02_LG08~-~-build-v5.4.1593400722-20200629-1120, in this version, the upload format is changed and readable, which is easier for integration.
434 434  
435 435  
436 -
437 -Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
419 +\\Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
438 438  
439 439  
440 440  Step 1: Refer [[Communicate with ABP End Node>>url:https://wiki.dragino.com/index.php/Communication_with_ABP_End_Node]] to know how to set up LG308 to work with LoRaWAN End node.
... ... @@ -490,7 +490,7 @@
490 490  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]]
491 491  
492 492  
493 -= 5. Example For Different MQTT Servers =
475 += Example For Different MQTT Servers =
494 494  
495 495  |=(((
496 496  [[~[~[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]]
... ... @@ -515,11 +515,12 @@
515 515  [[AWS Examples>>url:https://wiki.dragino.com/index.php/MQTT_Forward_to_Amazon_AWS-IOT]]
516 516  )))
517 517  
518 -= 6. How to Debug =
519 519  
501 += How to Debug =
502 +
520 520  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.
521 521  
522 -= 7. How to ask for Support =
505 += How to ask for Support =
523 523  
524 524  If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info:
525 525  

Applications

Navigation

Copyright ©2010-2022 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0