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, 0 added, 8 removed)
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 === ... ... @@ -111,7 +111,7 @@ 111 111 112 112 === 3.3.3 Example for Macro === 113 113 114 -[[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"]] 115 115 116 116 MQTT Publish configure 117 117 ... ... @@ -122,12 +122,12 @@ 122 122 123 123 When there is a LoRa sensor arrive. it will be store at the /var/iot/channels as below: 124 124 125 -[[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"]] 126 126 127 127 Sensor Data 128 128 129 129 ((( 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.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. 131 131 ))) 132 132 133 133 ... ... @@ -140,7 +140,8 @@ 140 140 root@dragino-1ec39c:~~# mosquitto_pub ~-~-help 141 141 mosquitto_pub is a simple mqtt client that will publish a message on a single topic and exit. 142 142 mosquitto_pub version 1.6.4 running on libmosquitto 1.6.4. 143 -\\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} 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,7 +158,8 @@ 158 158 [~-~-property command identifier value] 159 159 [-D command identifier value] 160 160 mosquitto_pub ~-~-help 161 -\\-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 162 162 the client communicates over. 163 163 -d : enable debug messages. 164 164 -D : Define MQTT v5 properties. See the documentation for more details. ... ... @@ -186,7 +186,7 @@ 186 186 ~-~-help : display this message. 187 187 ~-~-repeat : if publish mode is -f, -m, or -s, then repeat the publish N times. 188 188 ~-~-repeat-delay : if using ~-~-repeat, wait time seconds between publishes. Defaults to 0. 189 -~-~-quiet : (% style="color:red" %)don't print error messages.190 +~-~-quiet : (% class="mark" %)don't print error messages. 190 190 ~-~-will-payload : payload for the client Will, which is sent by the broker in case of 191 191 unexpected disconnection. If not given and will-topic is set, a zero 192 192 length message will be sent. ... ... @@ -214,7 +214,8 @@ 214 214 ~-~-proxy : SOCKS5 proxy URL of the form: 215 215 socks5h:~/~/[username[:password]@]hostname[:port] 216 216 Only "none" and "username" authentication is supported. 217 -\\See https:~/~/mosquitto.org/ for more information. 218 + 219 +See https:~/~/mosquitto.org/ for more information. 218 218 ))) 219 219 220 220 ... ... @@ -224,36 +224,43 @@ 224 224 225 225 (% class="box" %) 226 226 ((( 227 -//# Call MQTT Publish command 228 -\\# 1. Case with User, Password and Client ID present (e.g. Azure) 229 +# Call MQTT Publish command 230 + 231 +# 1. Case with User, Password and Client ID present (e.g. Azure) 229 229 if [ ! -z "$pass" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then 230 230 case="1" 231 231 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" 232 -\\# 2. Case with Certificate, Key and ClientID present (e.g. AWS) 235 + 236 +# 2. Case with Certificate, Key and ClientID present (e.g. AWS) 233 233 elif [ ! -z "$certfile" ] && [ ! -z "$key" ] && [ ! -z "$clientID" ]; then 234 234 case="2" 235 235 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" 236 -\\# 3. Case with no User, Certificate or ClientID present 240 + 241 +# 3. Case with no User, Certificate or ClientID present 237 237 elif [ -z "$user" ] && [ -z "$certfile" ] && [ -z "$clientID" ]; then 238 238 case="3" 239 239 mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data" 240 -\\# 4. Case with no User, Certificate, but with ClientID present 245 + 246 +# 4. Case with no User, Certificate, but with ClientID present 241 241 elif [ -z "$user" ] && [ -z "$certfile" ] && [ ! -z "$clientID" ]; then 242 242 case="4" 243 243 mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data" 244 -\\# 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 245 245 elif [ -z "$pass" ] && [ -z "$certfile" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then 246 246 case="5" 247 247 mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user $PUB_FLAG "$mqtt_data" 248 -\\# 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 249 249 elif [ ! -z "$user" ] && [ ! -z "$pass" ] && [ -z "$clientID" ] && [ -z "$certfile" ]; then 250 250 case="6" 251 251 mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic -u $user -P "$pass" $PUB_FLAG "$mqtt_data" 252 -\\# 0. Else - invalid parameters, just log 260 + 261 +# 0. Else - invalid parameters, just log 253 253 else 254 -case=" (% style="color:red" %)Invalid parameters"(%%)255 -logger (% style="color:red" %)"[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."(%%)256 -fi //263 +case="Invalid parameters" 264 +logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called." 265 +fi 257 257 ))) 258 258 259 259 ... ... @@ -263,7 +263,6 @@ 263 263 264 264 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/]]. 265 265 266 - 267 267 == 4.2 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. ... ... @@ -272,18 +272,16 @@ 272 272 In this test, the MQTT broker and MQTT.fx are installed in the same PC, so the MQTT server address in MQTT.fx should be localhost. Below shows how to connect to the server. 273 273 ))) 274 274 275 -[[image:image -20220527134929-6.png]]283 +[[image:https://wiki.dragino.com/images/thumb/0/06/MQTT_Forward_4.png/600px-MQTT_Forward_4.png||height="201" width="600"]] 276 276 277 277 Connect to MQTT Broker 278 278 279 - 280 280 After connected, use publish to public some thing to MQTT server. This to simulate upsteam 281 281 282 -[[image:image -20220527135037-7.png]]289 +[[image:https://wiki.dragino.com/images/thumb/b/bd/MQTT_Forward_5.png/600px-MQTT_Forward_5.png||height="149" width="600"]] 283 283 284 284 Upstream: Publish message to MQTT Broker 285 285 286 - 287 287 To simulate a downstream, use MQTT.fx to subscribe a topic, and publish something to this topic. as Below: 288 288 289 289 [[image:https://wiki.dragino.com/images/thumb/3/3d/MQTT_Forward_6.png/600px-MQTT_Forward_6.png||height="279" width="600"]] ... ... @@ -377,9 +377,7 @@ 377 377 ))) 378 378 379 379 380 -((( 381 381 Below is a simulation to put this data to active the MQTT publish. 382 -))) 383 383 384 384 [[image:https://wiki.dragino.com/images/thumb/3/30/MQTT_Command_11.png/600px-MQTT_Command_11.png||height="308" width="600"]] 385 385 ... ... @@ -390,10 +390,8 @@ 390 390 391 391 Below screen shot equal to this subscribe command: 392 392 393 -(% class="box" %) 394 -((( 395 -mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command. 396 -))) 397 +{{{ mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command. 398 +}}} 397 397 398 398 [[image:https://wiki.dragino.com/images/3/36/MQTT_Command_12.png||height="173" width="579"]] 399 399 ... ... @@ -400,9 +400,7 @@ 400 400 MQTT Subscribe 401 401 402 402 403 -((( 404 404 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: 405 -))) 406 406 407 407 [[image:https://wiki.dragino.com/images/thumb/b/b8/MQTT_Command_13.png/600px-MQTT_Command_13.png||height="300" width="600"]] 408 408 ... ... @@ -422,21 +422,13 @@ 422 422 423 423 === 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 424 424 425 -((( 426 426 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. 427 -))) 428 428 429 -((( 430 430 The example Sketch for LoRa Shield +Arduino is here: [[LoRa_Shield_Sketch_For_MQTT>>url:http://www.dragino.com/downloads/index.php?dir=LoraShield/]] 431 -))) 432 432 433 -((( 434 434 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. 435 -))) 436 436 437 -((( 438 438 What does the Arduino Sketch do? The Arduino Sketch will: 439 -))) 440 440 441 441 * 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). 442 442 * Downstream: Listening broadcast message from gateway, and print it in console. ... ... @@ -460,33 +460,25 @@ 460 460 461 461 === 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 462 462 463 -((( 464 -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. 465 -))) 455 +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. 466 466 467 -((( 468 -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. 469 -(% class="mark" %)**Video Instruction**(%%):[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 470 -))) 457 +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. 471 471 472 -((( 473 -**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. 474 -))) 475 475 476 -((( 477 -**Step 2**: Make sure your Radio settings match the End Node settings. 478 -))) 479 479 461 +Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 462 + 463 + 464 +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. 465 + 466 +Step 2: Make sure your Radio settings match the End Node settings. 467 + 480 480 [[image:https://wiki.dragino.com/images/thumb/f/f7/LG308_MQTT_5.png/600px-LG308_MQTT_5.png||height="387" width="600"]] 481 481 482 482 Use Same Frequency Band as End Node 483 483 484 484 485 -((( 486 -((( 487 -**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 488 -))) 489 -))) 473 +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 490 490 491 491 [[image:https://wiki.dragino.com/images/thumb/8/8d/LG308_MQTT_3.png/600px-LG308_MQTT_3.png||height="385" width="600"]] 492 492 ... ... @@ -493,7 +493,7 @@ 493 493 Publish mush use META as data format for LG308 494 494 495 495 496 - **Step 4**: Map the Device Address to Remote ID in MQTT server.480 +Step 4: Map the Device Address to Remote ID in MQTT server. 497 497 498 498 [[image:https://wiki.dragino.com/images/thumb/7/7f/LG308_MQTT_4.png/600px-LG308_MQTT_4.png||height="335" width="600"]] 499 499 ... ... @@ -500,7 +500,7 @@ 500 500 Map Dev Addr to remote ID 501 501 502 502 503 - **Step 5: Upstream**: Save the change, we can see the log info via "sytem log", End Node and MQTT Server487 +Step 5: Upstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server 504 504 505 505 [[image:https://wiki.dragino.com/images/thumb/b/be/LG308_MQTT_6.png/600px-LG308_MQTT_6.png||height="279" width="600"]] 506 506 ... ... @@ -514,21 +514,20 @@ 514 514 515 515 LHT65 Decoder 516 516 501 +Step 6: Set up subscribe: Subscribe a topci for downstream. 517 517 518 -**Step 6: Set up subscribe:** Subscribe a topci for downstream. 519 - 520 520 [[image:https://wiki.dragino.com/images/thumb/b/b9/LG308_MQTT_7.png/600px-LG308_MQTT_7.png||height="176" width="600"]] 521 521 522 522 Subscribe to a topic 523 523 524 524 525 - **Step 7**: Downstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server.508 +Step 7: Downstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 526 526 527 527 [[image:https://wiki.dragino.com/images/thumb/9/97/LG308_MQTT_8.png/600px-LG308_MQTT_8.png||height="298" width="600"]] 528 528 529 529 Downstream Flow 530 530 531 - (% 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]]**514 +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]] 532 532 533 533 534 534 = 5. Example For Different MQTT Servers = ... ... @@ -544,6 +544,8 @@ 544 544 )))|=(% style="width: 242px;" %)((( 545 545 [[image:https://wiki.dragino.com/images/thumb/3/3b/Lewei50.png/200px-Lewei50.png||alt="Lewei50.png" height="65" width="223"]] 546 546 530 +(% class="wikigeneratedid" %) 531 +== == 547 547 548 548 == [[乐联网平台>>url:https://www.lewei50.com/]] == 549 549
- 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
- image-20220527134929-6.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.Xiaoling - Size
-
... ... @@ -1,1 +1,0 @@ 1 -61.6 KB - Content
- image-20220527135037-7.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.Xiaoling - Size
-
... ... @@ -1,1 +1,0 @@ 1 -65.1 KB - Content
- image-20220527135215-8.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.Xiaoling - Size
-
... ... @@ -1,1 +1,0 @@ 1 -125.6 KB - Content