Changes for page MQTT Forward Instruction

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

Summary

Details

Page properties
Content
... ... @@ -7,13 +7,12 @@
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 -
11 11  == 1.1 Support Devices ==
12 12  
13 13  This MQTT forward instruction is for below devices:
14 14  
15 15  * Firmware Version > LG02_LG08-5.3.1580178039 [[Firmware Download>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]]
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]])
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]])
17 17  * LG02, OLG02
18 18  * LG308, DLOS8
19 19  * LPS8
... ... @@ -20,6 +20,7 @@
20 20  * LIG16
21 21  * MS14 series if installed with the same firmware. (in this case, the MQTT forward will work , but no LoRa support)
22 22  
22 +
23 23  = 2. Firmware Change Log for MQTT feature =
24 24  
25 25  (((
... ... @@ -29,6 +29,7 @@
29 29  * LG02_LG08-5.3.1580178039
30 30  ** Initiate version
31 31  
32 +
32 32  = 3. MQTT forward operating principle =
33 33  
34 34  == 3.1 Network Structure ==
... ... @@ -38,7 +38,7 @@
38 38  * 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 39  * 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,
40 40  
41 -[[image:image-20220527133547-1.png]]
42 +[[image:https://wiki.dragino.com/images/thumb/4/45/MQTT_Forward_1.png/600px-MQTT_Forward_1.png||height="348" width="600"]]
42 42  
43 43  General MQTT structure
44 44  
... ... @@ -56,7 +56,7 @@
56 56  The data flow works as below diagram.
57 57  )))
58 58  
59 -[[image:image-20220527134000-2.png]]
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]]
60 60  
61 61  (((
62 62  Upstream path
... ... @@ -78,7 +78,7 @@
78 78  Below are the data flow for downstream.
79 79  )))
80 80  
81 -[[image:image-20220527134038-3.png]]
82 +[[image:https://wiki.dragino.com/images/thumb/3/3a/MQTT_Forward_3.png/600px-MQTT_Forward_3.png||height="368" width="600"]]
82 82  
83 83  Downstream path
84 84  
... ... @@ -88,9 +88,7 @@
88 88  The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish.
89 89  
90 90  (((
91 -Currently the (% style="color:#4f81bd" %)**-t (topic)**(%%) and (% style="color:#4f81bd" %)**-m (message)**(%%) support Macros.
92 -
93 -
92 +Currently the (% class="mark" %)**-t (topic)**(%%) and (% class="mark" %)**-m (message)**(%%) support Macros.
94 94  )))
95 95  
96 96  === 3.3.1 -t topic macro ===
... ... @@ -101,7 +101,6 @@
101 101  * USERNAME: User ID (-u)
102 102  * HOSTNAME: Device Hostname
103 103  
104 -
105 105  === 3.3.2 -m message macro ===
106 106  
107 107  * HOSTNAME: Device Hostname
... ... @@ -110,10 +110,9 @@
110 110  * META: Completely sensor data with time stamp and rssi
111 111  * JSON: Convert META to json format.
112 112  
113 -
114 114  === 3.3.3 Example for Macro ===
115 115  
116 -[[image:image-20220527134251-4.png]]
113 +[[image:https://wiki.dragino.com/images/thumb/c/c7/MQTT_Command_9.png/600px-MQTT_Command_9.png||height="385" width="600"]]
117 117  
118 118  MQTT Publish configure
119 119  
... ... @@ -124,12 +124,12 @@
124 124  
125 125  When there is a LoRa sensor arrive. it will be store at the /var/iot/channels as below:
126 126  
127 -[[image:image-20220527134332-5.png]]
124 +[[image:https://wiki.dragino.com/images/thumb/c/c4/MQTT_Command_20.png/600px-MQTT_Command_20.png||height="325" width="600"]]
128 128  
129 129  Sensor Data
130 130  
131 131  (((
132 -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.
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.
133 133  )))
134 134  
135 135  
... ... @@ -142,7 +142,8 @@
142 142  root@dragino-1ec39c:~~# mosquitto_pub ~-~-help
143 143  mosquitto_pub is a simple mqtt client that will publish a message on a single topic and exit.
144 144  mosquitto_pub version 1.6.4 running on libmosquitto 1.6.4.
145 -\\Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL}
142 +
143 +Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL}
146 146   {-f file | -l | -n | -m message}
147 147   [-c] [-k keepalive] [-q qos] [-r] [~-~-repeat N] [~-~-repeat-delay time]
148 148   [-A bind_address]
... ... @@ -160,7 +160,8 @@
160 160   [~-~-property command identifier value]
161 161   [-D command identifier value]
162 162   mosquitto_pub ~-~-help
163 -\\-A : bind the outgoing socket to this host/ip address. Use to control which interface
161 +
162 +-A : bind the outgoing socket to this host/ip address. Use to control which interface
164 164   the client communicates over.
165 165  -d : enable debug messages.
166 166  -D : Define MQTT v5 properties. See the documentation for more details.
... ... @@ -216,7 +216,8 @@
216 216  ~-~-proxy : SOCKS5 proxy URL of the form:
217 217   socks5h:~/~/[username[:password]@]hostname[:port]
218 218   Only "none" and "username" authentication is supported.
219 -\\See https:~/~/mosquitto.org/ for more information.
218 +
219 +See https:~/~/mosquitto.org/ for more information.
220 220  )))
221 221  
222 222  
... ... @@ -227,31 +227,38 @@
227 227  (% class="box" %)
228 228  (((
229 229  # Call MQTT Publish command
230 -\\# 1. Case with User, Password and Client ID present  (e.g. Azure)
230 +
231 +# 1. Case with User, Password and Client ID present  (e.g. Azure)
231 231  if [ ! -z "$pass" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then
232 232  case="1" 
233 233  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"
234 -\\# 2. Case with Certificate, Key and ClientID present (e.g. AWS)
235 +
236 +# 2. Case with Certificate, Key and ClientID present (e.g. AWS)
235 235  elif [ ! -z "$certfile" ] && [ ! -z "$key" ] && [ ! -z "$clientID" ]; then
236 236  case="2" 
237 237  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"
238 -\\# 3. Case with no User, Certificate or ClientID present
240 +
241 +# 3. Case with no User, Certificate or ClientID present
239 239  elif [ -z "$user" ] && [ -z "$certfile" ] && [ -z "$clientID" ]; then
240 240  case="3" 
241 241  mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data"
242 -\\# 4. Case with no User, Certificate, but with ClientID present
245 +
246 +# 4. Case with no User, Certificate, but with ClientID present
243 243  elif [ -z "$user" ] && [ -z "$certfile" ] && [ ! -z "$clientID" ]; then
244 244  case="4" 
245 245  mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data"
246 -\\# 5. Case with User and ClientID present, but no Password and no Certificate present
250 +
251 +# 5. Case with User and ClientID present, but no Password and no Certificate present
247 247  elif [ -z "$pass" ] && [ -z "$certfile" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then
248 248  case="5" 
249 249  mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user $PUB_FLAG "$mqtt_data"
250 -\\# 6. Case with User and Password present, but no ClientID and no Certificate present
255 +
256 +# 6. Case with User and Password present, but no ClientID and no Certificate present
251 251  elif [ ! -z "$user" ] && [ ! -z "$pass" ] && [ -z "$clientID" ] && [ -z "$certfile" ]; then
252 252  case="6" 
253 253  mosquitto_pub $D -h $server -p $port -q $pub_qos  -t $pub_topic -u $user -P "$pass" $PUB_FLAG "$mqtt_data"
254 -\\# 0. Else - invalid parameters, just log
260 +
261 +# 0. Else - invalid parameters, just log
255 255  else
256 256  case="Invalid parameters" 
257 257  logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."
... ... @@ -357,28 +357,19 @@
357 357  
358 358  MQTT Publish configure
359 359  
360 -
361 361  [[image:https://wiki.dragino.com/images/thumb/b/b7/MQTT_Command_10.png/600px-MQTT_Command_10.png||height="544" width="600"]]
362 362  
363 363  MQTT Channel settings
364 364  
365 -(((
366 366  For example, if we put a data(temp=46) on the file /var/iot/channels/4567, because 4567 match the remote channel 78901. the gateway will run this command:
367 -)))
368 368  
369 -(% class="box" %)
370 -(((
371 -mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t dragino-1b7060/78901/data -m temp=46
372 -)))
373 +{{{mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t dragino-1b7060/78901/data -m temp=46
374 +}}}
373 373  
374 -(((
375 375  to MQTT broker.
376 -)))
377 377  
378 378  
379 -(((
380 380  Below is a simulation to put this data to active the MQTT publish.
381 -)))
382 382  
383 383  [[image:https://wiki.dragino.com/images/thumb/3/30/MQTT_Command_11.png/600px-MQTT_Command_11.png||height="308" width="600"]]
384 384  
... ... @@ -389,10 +389,8 @@
389 389  
390 390  Below screen shot equal to this subscribe command:
391 391  
392 -(% class="box" %)
393 -(((
394 -mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command.
395 -)))
390 +{{{ mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command.
391 +}}}
396 396  
397 397  [[image:https://wiki.dragino.com/images/3/36/MQTT_Command_12.png||height="173" width="579"]]
398 398  
... ... @@ -399,9 +399,7 @@
399 399  MQTT Subscribe
400 400  
401 401  
402 -(((
403 403  When MQTT broker receive a update on this topic, the gateway will get the update and use LoRa radio to broadcast this message. The LoRa parameters used for update is:
404 -)))
405 405  
406 406  [[image:https://wiki.dragino.com/images/thumb/b/b8/MQTT_Command_13.png/600px-MQTT_Command_13.png||height="300" width="600"]]
407 407  
... ... @@ -421,21 +421,13 @@
421 421  
422 422  === 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
423 423  
424 -(((
425 425  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.
426 -)))
427 427  
428 -(((
429 429  The example Sketch for LoRa Shield +Arduino is here: [[LoRa_Shield_Sketch_For_MQTT>>url:http://www.dragino.com/downloads/index.php?dir=LoraShield/]]
430 -)))
431 431  
432 -(((
433 433  And this link is the required library: [[arduino-LoRa-master>>url:http://www.dragino.com/downloads/index.php?dir=LoraShield/]]. Unzip this library and put in Arduino library location.
434 -)))
435 435  
436 -(((
437 437  What does the Arduino Sketch do? The Arduino Sketch will:
438 -)))
439 439  
440 440  * Upstream: Keep sending a LoRa Message every minutes with this payload : <4567>tem=xx&hum=yy (Where xx and yy are temperature and humidity value generated randomly).
441 441  * Downstream: Listening broadcast message from gateway, and print it in console.
... ... @@ -459,33 +459,25 @@
459 459  
460 460  === 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
461 461  
462 -(((
463 -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.
464 -)))
448 +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.
465 465  
466 -(((
467 -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.
468 -(% class="mark" %)**Video Instruction**(%%):[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
469 -)))
450 +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.
470 470  
471 -(((
472 -**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.
473 -)))
474 474  
475 -(((
476 -**Step 2**: Make sure your Radio settings match the End Node settings.
477 -)))
478 478  
454 +Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
455 +
456 +
457 +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.
458 +
459 +Step 2: Make sure your Radio settings match the End Node settings.
460 +
479 479  [[image:https://wiki.dragino.com/images/thumb/f/f7/LG308_MQTT_5.png/600px-LG308_MQTT_5.png||height="387" width="600"]]
480 480  
481 481  Use Same Frequency Band as End Node
482 482  
483 483  
484 -(((
485 -(((
486 -**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
487 -)))
488 -)))
466 +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
489 489  
490 490  [[image:https://wiki.dragino.com/images/thumb/8/8d/LG308_MQTT_3.png/600px-LG308_MQTT_3.png||height="385" width="600"]]
491 491  
... ... @@ -492,7 +492,7 @@
492 492  Publish mush use META as data format for LG308
493 493  
494 494  
495 -**Step 4**: Map the Device Address to Remote ID in MQTT server.
473 +Step 4: Map the Device Address to Remote ID in MQTT server.
496 496  
497 497  [[image:https://wiki.dragino.com/images/thumb/7/7f/LG308_MQTT_4.png/600px-LG308_MQTT_4.png||height="335" width="600"]]
498 498  
... ... @@ -499,7 +499,7 @@
499 499  Map Dev Addr to remote ID
500 500  
501 501  
502 -**Step 5: Upstream**: Save the change, we can see the log info via "sytem log", End Node and MQTT Server
480 +Step 5: Upstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server
503 503  
504 504  [[image:https://wiki.dragino.com/images/thumb/b/be/LG308_MQTT_6.png/600px-LG308_MQTT_6.png||height="279" width="600"]]
505 505  
... ... @@ -513,21 +513,20 @@
513 513  
514 514  LHT65 Decoder
515 515  
494 +Step 6: Set up subscribe: Subscribe a topci for downstream.
516 516  
517 -**Step 6: Set up subscribe:** Subscribe a topci for downstream.
518 -
519 519  [[image:https://wiki.dragino.com/images/thumb/b/b9/LG308_MQTT_7.png/600px-LG308_MQTT_7.png||height="176" width="600"]]
520 520  
521 521  Subscribe to a topic
522 522  
523 523  
524 -**Step 7**: Downstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
501 +Step 7: Downstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
525 525  
526 526  [[image:https://wiki.dragino.com/images/thumb/9/97/LG308_MQTT_8.png/600px-LG308_MQTT_8.png||height="298" width="600"]]
527 527  
528 528  Downstream Flow
529 529  
530 -(% 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]]**
507 +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]]
531 531  
532 532  
533 533  = 5. Example For Different MQTT Servers =
... ... @@ -543,6 +543,8 @@
543 543  )))|=(% style="width: 242px;" %)(((
544 544  [[image:https://wiki.dragino.com/images/thumb/3/3b/Lewei50.png/200px-Lewei50.png||alt="Lewei50.png" height="65" width="223"]]
545 545  
523 +(% class="wikigeneratedid" %)
524 +== ==
546 546  
547 547  == [[乐联网平台>>url:https://www.lewei50.com/]] ==
548 548  
image-20220527133547-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -199.3 KB
Content
image-20220527134000-2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -115.8 KB
Content
image-20220527134038-3.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -94.2 KB
Content
image-20220527134251-4.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -35.1 KB
Content
image-20220527134332-5.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -34.7 KB
Content

Applications

Navigation

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