Skip to Content

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
Change comment: There is no comment for this version
To version 24.2
edited by Xiaoling
on 2022/05/27 14:16
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -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,7 +110,6 @@
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 116  [[image:image-20220527134251-4.png]]
... ... @@ -188,7 +188,7 @@
188 188  ~-~-help : display this message.
189 189  ~-~-repeat : if publish mode is -f, -m, or -s, then repeat the publish N times.
190 190  ~-~-repeat-delay : if using ~-~-repeat, wait time seconds between publishes. Defaults to 0.
191 -~-~-quiet : (% class="mark" %)don't print error messages.
189 +~-~-quiet : (% style="color:red" %)don't print error messages.
192 192  ~-~-will-payload : payload for the client Will, which is sent by the broker in case of
193 193   unexpected disconnection. If not given and will-topic is set, a zero
194 194   length message will be sent.
... ... @@ -226,7 +226,7 @@
226 226  
227 227  (% class="box" %)
228 228  (((
229 -# Call MQTT Publish command
227 +//# Call MQTT Publish command
230 230  \\# 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" 
... ... @@ -253,9 +253,9 @@
253 253  mosquitto_pub $D -h $server -p $port -q $pub_qos  -t $pub_topic -u $user -P "$pass" $PUB_FLAG "$mqtt_data"
254 254  \\# 0. Else - invalid parameters, just log
255 255  else
256 -case="Invalid parameters" 
257 -logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."
258 -fi
254 +case="(% style="color:red" %)Invalid parameters" (%%)
255 +logger (% style="color:red" %)"[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."(%%)
256 +fi//
259 259  )))
260 260  
261 261  
... ... @@ -265,6 +265,7 @@
265 265  
266 266  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/]].
267 267  
266 +
268 268  == 4.2 Simulate via MQTT.fx utility ==
269 269  
270 270  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.
... ... @@ -273,19 +273,21 @@
273 273  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.
274 274  )))
275 275  
276 -[[image:https://wiki.dragino.com/images/thumb/0/06/MQTT_Forward_4.png/600px-MQTT_Forward_4.png||height="201" width="600"]]
275 +[[image:image-20220527134929-6.png]]
277 277  
278 278  Connect to MQTT Broker
279 279  
279 +
280 280  After connected, use publish to public some thing to MQTT server. This to simulate upsteam
281 281  
282 -[[image:https://wiki.dragino.com/images/thumb/b/bd/MQTT_Forward_5.png/600px-MQTT_Forward_5.png||height="149" width="600"]]
282 +[[image:image-20220527135037-7.png]]
283 283  
284 284  Upstream: Publish message to MQTT Broker
285 285  
286 +
286 286  To simulate a downstream, use MQTT.fx to subscribe a topic, and publish something to this topic. as Below:
287 287  
288 -[[image:https://wiki.dragino.com/images/thumb/3/3d/MQTT_Forward_6.png/600px-MQTT_Forward_6.png||height="279" width="600"]]
289 +[[image:image-20220527135215-8.png]]
289 289  
290 290  Downstream: Subscribe a topic to get downstream
291 291  
... ... @@ -297,7 +297,7 @@
297 297  In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection.
298 298  
299 299  
300 -(% class="mark" %)**For Upstream**
301 +(% style="color:#4f81bd" %)**For Upstream**
301 301  
302 302  command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]]
303 303  
... ... @@ -305,16 +305,16 @@
305 305  
306 306  Note: 192.168.199.148 is MQTT broker address, the gateway and the MQTT broker PC are in the same network.
307 307  
308 -[[image:https://wiki.dragino.com/images/thumb/d/d0/MQTT_Command_6.png/600px-MQTT_Command_6.png||height="188" width="600"]]
309 +[[image:image-20220527135310-9.png]]
309 309  
310 310  mosquitto_pub
311 311  
312 312  
313 -(% class="mark" %)**For Downstream**
314 +(% style="color:#4f81bd" %)**For Downstream**
314 314  
315 315  Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic.
316 316  
317 -[[image:https://wiki.dragino.com/images/thumb/8/89/MQTT_Command_7.png/600px-MQTT_Command_7.png||height="267" width="600"]]
318 +[[image:image-20220527135440-10.png]]
318 318  
319 319  mosquitto_sub
320 320  
... ... @@ -324,7 +324,7 @@
324 324  This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection.
325 325  
326 326  (((
327 -Go to (% class="mark" %)**Dragino Menu ~-~-> MQTT Client**
328 +Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client**
328 328  )))
329 329  
330 330  [[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]]
... ... @@ -332,10 +332,10 @@
332 332  go to mqtt configure menu
333 333  
334 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 +Select (% style="color:#4f81bd" %)**Forward to MQTT server**. (% style="color:red" %)**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 336  )))
337 337  
338 -[[image:https://wiki.dragino.com/images/thumb/1/14/MQTT_Commands_8.png/600px-MQTT_Commands_8.png||height="240" width="600"]]
339 +[[image:image-20220527135742-11.png]]
339 339  
340 340  forward to MQTT
341 341  
... ... @@ -353,15 +353,16 @@
353 353  ~/~/DATA: The data stores in /var/iot/channels/
354 354  )))
355 355  
356 -[[image:https://wiki.dragino.com/images/thumb/c/c7/MQTT_Command_9.png/600px-MQTT_Command_9.png||height="385" width="600"]]
357 +[[image:image-20220527135828-12.png]]
357 357  
358 358  MQTT Publish configure
359 359  
360 360  
361 -[[image:https://wiki.dragino.com/images/thumb/b/b7/MQTT_Command_10.png/600px-MQTT_Command_10.png||height="544" width="600"]]
362 +[[image:image-20220527135929-13.png]]
362 362  
363 363  MQTT Channel settings
364 364  
366 +
365 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 367  )))
... ... @@ -380,7 +380,7 @@
380 380  Below is a simulation to put this data to active the MQTT publish.
381 381  )))
382 382  
383 -[[image:https://wiki.dragino.com/images/thumb/3/30/MQTT_Command_11.png/600px-MQTT_Command_11.png||height="308" width="600"]]
385 +[[image:image-20220527140023-14.png]]
384 384  
385 385  MQTT Publish
386 386  
... ... @@ -394,7 +394,7 @@
394 394  mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command.
395 395  )))
396 396  
397 -[[image:https://wiki.dragino.com/images/3/36/MQTT_Command_12.png||height="173" width="579"]]
399 +[[image:image-20220527140100-15.png]]
398 398  
399 399  MQTT Subscribe
400 400  
... ... @@ -403,7 +403,7 @@
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 404  )))
405 405  
406 -[[image:https://wiki.dragino.com/images/thumb/b/b8/MQTT_Command_13.png/600px-MQTT_Command_13.png||height="300" width="600"]]
408 +[[image:image-20220527140148-16.png]]
407 407  
408 408  LoRa Broadcast parameters.
409 409  
... ... @@ -410,7 +410,7 @@
410 410  
411 411  And below is the subscribe simulation:
412 412  
413 -[[image:https://wiki.dragino.com/images/thumb/6/60/MQTT_Command_14.png/600px-MQTT_Command_14.png||height="255" width="600"]]
415 +[[image:image-20220527140238-17.png]]
414 414  
415 415  downstream simulation
416 416  
... ... @@ -419,6 +419,7 @@
419 419  
420 420  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.
421 421  
424 +
422 422  === 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
423 423  
424 424  (((
... ... @@ -441,7 +441,7 @@
441 441  * Downstream: Listening broadcast message from gateway, and print it in console.
442 442  * The LoRa parameter settings in Arduino should match the LoRa settings in gateway, as below:
443 443  
444 -[[image:https://wiki.dragino.com/images/thumb/3/3b/MQTT_Command_17.png/600px-MQTT_Command_17.png||height="197" width="600"]]
447 +[[image:image-20220527140354-18.png]]
445 445  
446 446  LoRa Parameter should match
447 447  
... ... @@ -448,12 +448,13 @@
448 448  
449 449  Below is the test result after the Arduino Sketch is running.
450 450  
451 -[[image:https://wiki.dragino.com/images/thumb/6/63/MQTT_Command_18.png/600px-MQTT_Command_18.png||height="319" width="600"]]
454 +[[image:image-20220527140459-19.png]]
452 452  
453 453  Upstream Data Flow
454 454  
455 -[[image:https://wiki.dragino.com/images/thumb/1/18/MQTT_Command_19.png/600px-MQTT_Command_19.png||height="309" width="600"]]
456 456  
459 +[[image:image-20220527140542-20.png]]
460 +
457 457  Downstream Data Flow
458 458  
459 459  
... ... @@ -460,23 +460,23 @@
460 460  === 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
461 461  
462 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.
467 +Since firmware (% style="color:#4f81bd" %)**LG02_LG08~-~-build-v5.3.1585192026-20200326-1109,**(%%) Dragino LoRaWAN gateways support the communication to LoRaWAN (% style="color:#4f81bd" %)**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 464  )))
465 465  
466 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]]
471 +When use test this feature, please use the version higher then : (% style="color:#4f81bd" %)**LG02_LG08~-~-build-v5.4.1593400722-20200629-1120**(%%), in this version, the upload format is changed and readable, which is easier for integration.
472 +(% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
469 469  )))
470 470  
471 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.
476 +(% style="color:#4f81bd" %)**Step 1**(%%): Refer [[Communicate with ABP End Node>>doc:Main.Communicate with ABP End Node without LoRaWAN Network Server --- LG308.WebHome]] to know how to set up LG308 to work with LoRaWAN End node.
473 473  )))
474 474  
475 475  (((
476 -**Step 2**: Make sure your Radio settings match the End Node settings.
480 +(% style="color:#4f81bd" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
477 477  )))
478 478  
479 -[[image:https://wiki.dragino.com/images/thumb/f/f7/LG308_MQTT_5.png/600px-LG308_MQTT_5.png||height="387" width="600"]]
483 +[[image:image-20220527141235-21.png]]
480 480  
481 481  Use Same Frequency Band as End Node
482 482  
... ... @@ -483,16 +483,16 @@
483 483  
484 484  (((
485 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
490 +(% style="color:#4f81bd" %)**Step 3**(%%): Set up publish format and MQTT channel. The LG308 will store the Data from End node in (% style="color:#4f81bd" %)**HEX format**(%%) in the file. And we need to config the format to (% style="color:#4f81bd" %)**META**
487 487  )))
488 488  )))
489 489  
490 -[[image:https://wiki.dragino.com/images/thumb/8/8d/LG308_MQTT_3.png/600px-LG308_MQTT_3.png||height="385" width="600"]]
494 +[[image:image-20220527141450-22.png]]
491 491  
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.
499 +(% style="color:#4f81bd" %)**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
506 +(% style="color:#4f81bd" %)**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  
... ... @@ -514,7 +514,7 @@
514 514  LHT65 Decoder
515 515  
516 516  
517 -**Step 6: Set up subscribe:** Subscribe a topci for downstream.
521 +(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
518 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,13 +521,13 @@
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.
528 +(% style="color:#4f81bd" %)**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]]**
534 +(% style="color:red" %)**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 =
image-20220527134929-6.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +61.6 KB
Content
image-20220527135037-7.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +65.1 KB
Content
image-20220527135215-8.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +125.6 KB
Content
image-20220527135310-9.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +87.9 KB
Content
image-20220527135440-10.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +111.5 KB
Content
image-20220527135742-11.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +18.2 KB
Content
image-20220527135828-12.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +35.1 KB
Content
image-20220527135929-13.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +31.0 KB
Content
image-20220527140023-14.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +182.2 KB
Content
image-20220527140100-15.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +8.2 KB
Content
image-20220527140148-16.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +34.0 KB
Content
image-20220527140238-17.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +126.3 KB
Content
image-20220527140354-18.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +62.7 KB
Content
image-20220527140459-19.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +151.0 KB
Content
image-20220527140542-20.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +165.4 KB
Content
image-20220527141235-21.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +83.3 KB
Content
image-20220527141450-22.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +46.5 KB
Content