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)
-
Attachments (0 modified, 5 added, 0 removed)
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 === ... ... @@ -100,6 +100,7 @@ 100 100 * USERNAME: User ID (-u) 101 101 * HOSTNAME: Device Hostname 102 102 104 + 103 103 === 3.3.2 -m message macro === 104 104 105 105 * HOSTNAME: Device Hostname ... ... @@ -108,9 +108,10 @@ 108 108 * META: Completely sensor data with time stamp and rssi 109 109 * JSON: Convert META to json format. 110 110 113 + 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"]]116 +[[image:image-20220527134251-4.png]] 114 114 115 115 MQTT Publish configure 116 116 ... ... @@ -121,7 +121,7 @@ 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"]]127 +[[image:image-20220527134332-5.png]] 125 125 126 126 Sensor Data 127 127 ... ... @@ -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} 145 +\\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 163 +\\-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. ... ... @@ -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. 219 +\\See https:~/~/mosquitto.org/ for more information. 220 220 ))) 221 221 222 222 ... ... @@ -227,38 +227,31 @@ 227 227 (% class="box" %) 228 228 ((( 229 229 # Call MQTT Publish command 230 - 231 -# 1. Case with User, Password and Client ID present (e.g. Azure) 230 +\\# 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) 234 +\\# 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 238 +\\# 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 242 +\\# 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 246 +\\# 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 250 +\\# 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 254 +\\# 0. Else - invalid parameters, just log 262 262 else 263 263 case="Invalid parameters" 264 264 logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called." ... ... @@ -338,7 +338,9 @@ 338 338 339 339 go to mqtt configure menu 340 340 341 -Select Forward to MQTT server. Notice: This option is removed from the latest firmware, in the latest firmware, if user submit "SAVE & APPLY" in MQTT page, the gateway will use MQTT service. 334 +((( 335 +Select **Forward to MQTT server**. (% class="mark" %)**Notice**(%%): This option is removed from the latest firmware, in the latest firmware, if user submit "SAVE & APPLY" in MQTT page, the gateway will use MQTT service. 336 +))) 342 342 343 343 [[image:https://wiki.dragino.com/images/thumb/1/14/MQTT_Commands_8.png/600px-MQTT_Commands_8.png||height="240" width="600"]] 344 344 ... ... @@ -349,30 +349,41 @@ 349 349 350 350 Below screenshot is same as the publish command: 351 351 352 -{{{mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA 353 -//where the CLIENTID, CHANNEL & DATA are macro. represent for 354 -//CLIENTID: dragino-1b7060 355 -//CHANNEL: Remote ID in Channel settings; here is 78901 or 567456 356 -//DATA: The data stores in /var/iot/channels/ 357 -}}} 347 +(% class="box" %) 348 +((( 349 +mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA 350 +~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for 351 +~/~/CLIENTID: dragino-1b7060 352 +~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456 353 +~/~/DATA: The data stores in /var/iot/channels/ 354 +))) 358 358 359 359 [[image:https://wiki.dragino.com/images/thumb/c/c7/MQTT_Command_9.png/600px-MQTT_Command_9.png||height="385" width="600"]] 360 360 361 361 MQTT Publish configure 362 362 360 + 363 363 [[image:https://wiki.dragino.com/images/thumb/b/b7/MQTT_Command_10.png/600px-MQTT_Command_10.png||height="544" width="600"]] 364 364 365 365 MQTT Channel settings 366 366 365 +((( 367 367 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 -{{{mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t dragino-1b7060/78901/data -m temp=46 370 -}}} 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 +))) 371 371 374 +((( 372 372 to MQTT broker. 376 +))) 373 373 374 374 379 +((( 375 375 Below is a simulation to put this data to active the MQTT publish. 381 +))) 376 376 377 377 [[image:https://wiki.dragino.com/images/thumb/3/30/MQTT_Command_11.png/600px-MQTT_Command_11.png||height="308" width="600"]] 378 378 ... ... @@ -383,8 +383,10 @@ 383 383 384 384 Below screen shot equal to this subscribe command: 385 385 386 -{{{ mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command. 387 -}}} 392 +(% class="box" %) 393 +((( 394 +mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command. 395 +))) 388 388 389 389 [[image:https://wiki.dragino.com/images/3/36/MQTT_Command_12.png||height="173" width="579"]] 390 390 ... ... @@ -391,7 +391,9 @@ 391 391 MQTT Subscribe 392 392 393 393 402 +((( 394 394 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 +))) 395 395 396 396 [[image:https://wiki.dragino.com/images/thumb/b/b8/MQTT_Command_13.png/600px-MQTT_Command_13.png||height="300" width="600"]] 397 397 ... ... @@ -411,13 +411,21 @@ 411 411 412 412 === 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 413 413 424 +((( 414 414 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 +))) 415 415 428 +((( 416 416 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 +))) 417 417 432 +((( 418 418 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 +))) 419 419 436 +((( 420 420 What does the Arduino Sketch do? The Arduino Sketch will: 438 +))) 421 421 422 422 * 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). 423 423 * Downstream: Listening broadcast message from gateway, and print it in console. ... ... @@ -441,25 +441,33 @@ 441 441 442 442 === 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 443 443 444 -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. 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 +))) 445 445 446 -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. 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 +))) 447 447 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 +))) 448 448 475 +((( 476 +**Step 2**: Make sure your Radio settings match the End Node settings. 477 +))) 449 449 450 -Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 451 - 452 - 453 -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. 454 - 455 -Step 2: Make sure your Radio settings match the End Node settings. 456 - 457 457 [[image:https://wiki.dragino.com/images/thumb/f/f7/LG308_MQTT_5.png/600px-LG308_MQTT_5.png||height="387" width="600"]] 458 458 459 459 Use Same Frequency Band as End Node 460 460 461 461 462 -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 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 +))) 463 463 464 464 [[image:https://wiki.dragino.com/images/thumb/8/8d/LG308_MQTT_3.png/600px-LG308_MQTT_3.png||height="385" width="600"]] 465 465 ... ... @@ -466,7 +466,7 @@ 466 466 Publish mush use META as data format for LG308 467 467 468 468 469 -Step 4: Map the Device Address to Remote ID in MQTT server. 495 +**Step 4**: Map the Device Address to Remote ID in MQTT server. 470 470 471 471 [[image:https://wiki.dragino.com/images/thumb/7/7f/LG308_MQTT_4.png/600px-LG308_MQTT_4.png||height="335" width="600"]] 472 472 ... ... @@ -473,7 +473,7 @@ 473 473 Map Dev Addr to remote ID 474 474 475 475 476 -Step 5: Upstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server 502 +**Step 5: Upstream**: Save the change, we can see the log info via "sytem log", End Node and MQTT Server 477 477 478 478 [[image:https://wiki.dragino.com/images/thumb/b/be/LG308_MQTT_6.png/600px-LG308_MQTT_6.png||height="279" width="600"]] 479 479 ... ... @@ -487,20 +487,21 @@ 487 487 488 488 LHT65 Decoder 489 489 490 -Step 6: Set up subscribe: Subscribe a topci for downstream. 491 491 517 +**Step 6: Set up subscribe:** Subscribe a topci for downstream. 518 + 492 492 [[image:https://wiki.dragino.com/images/thumb/b/b9/LG308_MQTT_7.png/600px-LG308_MQTT_7.png||height="176" width="600"]] 493 493 494 494 Subscribe to a topic 495 495 496 496 497 -Step 7: Downstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 524 +**Step 7**: Downstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 498 498 499 499 [[image:https://wiki.dragino.com/images/thumb/9/97/LG308_MQTT_8.png/600px-LG308_MQTT_8.png||height="298" width="600"]] 500 500 501 501 Downstream Flow 502 502 503 -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]] 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]]** 504 504 505 505 506 506 = 5. Example For Different MQTT Servers = ... ... @@ -516,8 +516,6 @@ 516 516 )))|=(% style="width: 242px;" %)((( 517 517 [[image:https://wiki.dragino.com/images/thumb/3/3b/Lewei50.png/200px-Lewei50.png||alt="Lewei50.png" height="65" width="223"]] 518 518 519 -(% class="wikigeneratedid" %) 520 -== == 521 521 522 522 == [[乐联网平台>>url:https://www.lewei50.com/]] == 523 523
- 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