Changes for page MQTT Forward Instruction

Last modified by Kilight Cao on 2024/08/31 16:26
<
From version < 1.20 >
edited by Xiaoling
on 2022/05/12 16:26
To version < 7.6 >
edited by Xiaoling
on 2022/05/27 13:48
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -7,12 +7,13 @@
7 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 +
10 10  == 1.1 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]])
16 +* LG01N, OLG01N ((% style="color:red" %)**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
... ... @@ -19,7 +19,6 @@
19 19  * LIG16
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 -
23 23  = 2. Firmware Change Log for MQTT feature =
24 24  
25 25  (((
... ... @@ -29,7 +29,6 @@
29 29  * LG02_LG08-5.3.1580178039
30 30  ** Initiate version
31 31  
32 -
33 33  = 3. MQTT forward operating principle =
34 34  
35 35  == 3.1 Network Structure ==
... ... @@ -39,7 +39,7 @@
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"]]
41 +[[image:image-20220527133547-1.png]]
43 43  
44 44  General MQTT structure
45 45  
... ... @@ -57,7 +57,7 @@
57 57  The data flow works as below diagram.
58 58  )))
59 59  
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]]
59 +[[image:image-20220527134000-2.png]]
61 61  
62 62  (((
63 63  Upstream path
... ... @@ -79,7 +79,7 @@
79 79  Below are the data flow for downstream.
80 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"]]
81 +[[image:image-20220527134038-3.png]]
83 83  
84 84  Downstream path
85 85  
... ... @@ -89,7 +89,9 @@
89 89  The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish.
90 90  
91 91  (((
92 -Currently the (% class="mark" %)**-t (topic)**(%%) and (% class="mark" %)**-m (message)**(%%) support Macros.
91 +Currently the (% style="color:#4f81bd" %)**-t (topic)**(%%) and (% style="color:#4f81bd" %)**-m (message)**(%%) support Macros.
92 +
93 +
93 93  )))
94 94  
95 95  === 3.3.1 -t topic macro ===
... ... @@ -110,7 +110,7 @@
110 110  
111 111  === 3.3.3 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"]]
114 +[[image:image-20220527134251-4.png]]
114 114  
115 115  MQTT Publish configure
116 116  
... ... @@ -121,12 +121,12 @@
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"]]
125 +[[image:image-20220527134332-5.png]]
125 125  
126 126  Sensor Data
127 127  
128 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 +According to above macro. Gateway will publish (% style="color:#4f81bd" %)**field1=22.0&field2=49.0**(%%) to topic: (% style="color:#4f81bd" %)**dragino-1b7060/78901/data**(%%), where 78901 is the remote channel for this node ID.
130 130  )))
131 131  
132 132  
... ... @@ -139,8 +139,7 @@
139 139  root@dragino-1ec39c:~~# mosquitto_pub ~-~-help
140 140  mosquitto_pub is a simple mqtt client that will publish a message on a single topic and exit.
141 141  mosquitto_pub version 1.6.4 running on libmosquitto 1.6.4.
142 -
143 -Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL}
143 +\\Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL}
144 144   {-f file | -l | -n | -m message}
145 145   [-c] [-k keepalive] [-q qos] [-r] [~-~-repeat N] [~-~-repeat-delay time]
146 146   [-A bind_address]
... ... @@ -158,8 +158,7 @@
158 158   [~-~-property command identifier value]
159 159   [-D command identifier value]
160 160   mosquitto_pub ~-~-help
161 -
162 --A : bind the outgoing socket to this host/ip address. Use to control which interface
161 +\\-A : bind the outgoing socket to this host/ip address. Use to control which interface
163 163   the client communicates over.
164 164  -d : enable debug messages.
165 165  -D : Define MQTT v5 properties. See the documentation for more details.
... ... @@ -187,7 +187,7 @@
187 187  ~-~-help : display this message.
188 188  ~-~-repeat : if publish mode is -f, -m, or -s, then repeat the publish N times.
189 189  ~-~-repeat-delay : if using ~-~-repeat, wait time seconds between publishes. Defaults to 0.
190 -~-~-quiet : (% class="mark" %)don't print error messages.
189 +~-~-quiet : (% style="color:red" %)don't print error messages.
191 191  ~-~-will-payload : payload for the client Will, which is sent by the broker in case of
192 192   unexpected disconnection. If not given and will-topic is set, a zero
193 193   length message will be sent.
... ... @@ -215,8 +215,7 @@
215 215  ~-~-proxy : SOCKS5 proxy URL of the form:
216 216   socks5h:~/~/[username[:password]@]hostname[:port]
217 217   Only "none" and "username" authentication is supported.
218 -
219 -See https:~/~/mosquitto.org/ for more information.
217 +\\See https:~/~/mosquitto.org/ for more information.
220 220  )))
221 221  
222 222  
... ... @@ -226,43 +226,36 @@
226 226  
227 227  (% class="box" %)
228 228  (((
229 -# Call MQTT Publish command
230 -
231 -# 1. Case with User, Password and Client ID present  (e.g. Azure)
227 +//# Call MQTT Publish command
228 +\\# 1. Case with User, Password and Client ID present  (e.g. Azure)
232 232  if [ ! -z "$pass" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then
233 233  case="1" 
234 234  mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user -P "$pass" $C $cafile $PUB_FLAG "$mqtt_data"
235 -
236 -# 2. Case with Certificate, Key and ClientID present (e.g. AWS)
232 +\\# 2. Case with Certificate, Key and ClientID present (e.g. AWS)
237 237  elif [ ! -z "$certfile" ] && [ ! -z "$key" ] && [ ! -z "$clientID" ]; then
238 238  case="2" 
239 239  mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic ~-~-cert $cert ~-~-key $key $C $cafile $PUB_FLAG "$mqtt_data"
240 -
241 -# 3. Case with no User, Certificate or ClientID present
236 +\\# 3. Case with no User, Certificate or ClientID present
242 242  elif [ -z "$user" ] && [ -z "$certfile" ] && [ -z "$clientID" ]; then
243 243  case="3" 
244 244  mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data"
245 -
246 -# 4. Case with no User, Certificate, but with ClientID present
240 +\\# 4. Case with no User, Certificate, but with ClientID present
247 247  elif [ -z "$user" ] && [ -z "$certfile" ] && [ ! -z "$clientID" ]; then
248 248  case="4" 
249 249  mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data"
250 -
251 -# 5. Case with User and ClientID present, but no Password and no Certificate present
244 +\\# 5. Case with User and ClientID present, but no Password and no Certificate present
252 252  elif [ -z "$pass" ] && [ -z "$certfile" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then
253 253  case="5" 
254 254  mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user $PUB_FLAG "$mqtt_data"
255 -
256 -# 6. Case with User and Password present, but no ClientID and no Certificate present
248 +\\# 6. Case with User and Password present, but no ClientID and no Certificate present
257 257  elif [ ! -z "$user" ] && [ ! -z "$pass" ] && [ -z "$clientID" ] && [ -z "$certfile" ]; then
258 258  case="6" 
259 259  mosquitto_pub $D -h $server -p $port -q $pub_qos  -t $pub_topic -u $user -P "$pass" $PUB_FLAG "$mqtt_data"
260 -
261 -# 0. Else - invalid parameters, just log
252 +\\# 0. Else - invalid parameters, just log
262 262  else
263 -case="Invalid parameters" 
264 -logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."
265 -fi
254 +case="(% style="color:red" %)Invalid parameters" (%%)
255 +logger (% style="color:red" %)"[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."(%%)
256 +fi//
266 266  )))
267 267  
268 268  
... ... @@ -467,20 +467,20 @@
467 467  === 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
468 468  
469 469  (((
470 -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.
461 +Since firmware (% class="mark" %)**LG02_LG08~-~-build-v5.3.1585192026-20200326-1109,**(%%) Dragino LoRaWAN gateways support the communication to LoRaWAN (% class="mark" %)**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.
471 471  )))
472 472  
473 473  (((
474 -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.
475 -Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
465 +When use test this feature, please use the version higher then : (% class="mark" %)**LG02_LG08~-~-build-v5.4.1593400722-20200629-1120**(%%), in this version, the upload format is changed and readable, which is easier for integration.
466 +(% class="mark" %)**Video Instruction**(%%):[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
476 476  )))
477 477  
478 478  (((
479 -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.
470 +**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.
480 480  )))
481 481  
482 482  (((
483 -Step 2: Make sure your Radio settings match the End Node settings.
474 +**Step 2**: Make sure your Radio settings match the End Node settings.
484 484  )))
485 485  
486 486  [[image:https://wiki.dragino.com/images/thumb/f/f7/LG308_MQTT_5.png/600px-LG308_MQTT_5.png||height="387" width="600"]]
... ... @@ -489,8 +489,10 @@
489 489  
490 490  
491 491  (((
492 -Step 3: Set up publish format and MQTT channel. The LG308 will store the Data from End node in HEX format in the file. And we need to config the format to META
483 +(((
484 +**Step 3**: Set up publish format and MQTT channel. The LG308 will store the Data from End node in HEX format in the file. And we need to config the format to META
493 493  )))
486 +)))
494 494  
495 495  [[image:https://wiki.dragino.com/images/thumb/8/8d/LG308_MQTT_3.png/600px-LG308_MQTT_3.png||height="385" width="600"]]
496 496  
... ... @@ -497,7 +497,7 @@
497 497  Publish mush use META as data format for LG308
498 498  
499 499  
500 -Step 4: Map the Device Address to Remote ID in MQTT server.
493 +**Step 4**: Map the Device Address to Remote ID in MQTT server.
501 501  
502 502  [[image:https://wiki.dragino.com/images/thumb/7/7f/LG308_MQTT_4.png/600px-LG308_MQTT_4.png||height="335" width="600"]]
503 503  
... ... @@ -504,7 +504,7 @@
504 504  Map Dev Addr to remote ID
505 505  
506 506  
507 -Step 5: Upstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server
500 +**Step 5: Upstream**: Save the change, we can see the log info via "sytem log", End Node and MQTT Server
508 508  
509 509  [[image:https://wiki.dragino.com/images/thumb/b/be/LG308_MQTT_6.png/600px-LG308_MQTT_6.png||height="279" width="600"]]
510 510  
... ... @@ -518,20 +518,21 @@
518 518  
519 519  LHT65 Decoder
520 520  
521 -Step 6: Set up subscribe: Subscribe a topci for downstream.
522 522  
515 +**Step 6: Set up subscribe:** Subscribe a topci for downstream.
516 +
523 523  [[image:https://wiki.dragino.com/images/thumb/b/b9/LG308_MQTT_7.png/600px-LG308_MQTT_7.png||height="176" width="600"]]
524 524  
525 525  Subscribe to a topic
526 526  
527 527  
528 -Step 7: Downstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
522 +**Step 7**: Downstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
529 529  
530 530  [[image:https://wiki.dragino.com/images/thumb/9/97/LG308_MQTT_8.png/600px-LG308_MQTT_8.png||height="298" width="600"]]
531 531  
532 532  Downstream Flow
533 533  
534 -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]]
528 +(% class="mark" %)**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]]**
535 535  
536 536  
537 537  = 5. Example For Different MQTT Servers =
... ... @@ -547,8 +547,6 @@
547 547  )))|=(% style="width: 242px;" %)(((
548 548  [[image:https://wiki.dragino.com/images/thumb/3/3b/Lewei50.png/200px-Lewei50.png||alt="Lewei50.png" height="65" width="223"]]
549 549  
550 -(% class="wikigeneratedid" %)
551 -== ==
552 552  
553 553  == [[乐联网平台>>url:https://www.lewei50.com/]] ==
554 554  
image-20220527133547-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +199.3 KB
Content
image-20220527134000-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +115.8 KB
Content
image-20220527134038-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +94.2 KB
Content
image-20220527134251-4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +35.1 KB
Content
image-20220527134332-5.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +34.7 KB
Content

Applications

Navigation

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