Skip to Content

Changes for page MQTT Forward Instruction

Last modified by Kilight Cao on 2024/08/31 16:26
From version 5.2
edited by Xiaoling
on 2022/05/27 13:41
Change comment: There is no comment for this version
To version 23.2
edited by Xiaoling
on 2022/05/27 14:14
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -89,6 +89,8 @@
89 89  
90 90  (((
91 91  Currently the (% style="color:#4f81bd" %)**-t (topic)**(%%) and (% style="color:#4f81bd" %)**-m (message)**(%%) support Macros.
92 +
93 +
92 92  )))
93 93  
94 94  === 3.3.1 -t topic macro ===
... ... @@ -109,7 +109,7 @@
109 109  
110 110  === 3.3.3 Example for Macro ===
111 111  
112 -[[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]]
113 113  
114 114  MQTT Publish configure
115 115  
... ... @@ -120,12 +120,12 @@
120 120  
121 121  When there is a LoRa sensor arrive. it will be store at the /var/iot/channels as below:
122 122  
123 -[[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]]
124 124  
125 125  Sensor Data
126 126  
127 127  (((
128 -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.
129 129  )))
130 130  
131 131  
... ... @@ -184,7 +184,7 @@
184 184  ~-~-help : display this message.
185 185  ~-~-repeat : if publish mode is -f, -m, or -s, then repeat the publish N times.
186 186  ~-~-repeat-delay : if using ~-~-repeat, wait time seconds between publishes. Defaults to 0.
187 -~-~-quiet : (% class="mark" %)don't print error messages.
189 +~-~-quiet : (% style="color:red" %)don't print error messages.
188 188  ~-~-will-payload : payload for the client Will, which is sent by the broker in case of
189 189   unexpected disconnection. If not given and will-topic is set, a zero
190 190   length message will be sent.
... ... @@ -222,7 +222,7 @@
222 222  
223 223  (% class="box" %)
224 224  (((
225 -# Call MQTT Publish command
227 +//# Call MQTT Publish command
226 226  \\# 1. Case with User, Password and Client ID present  (e.g. Azure)
227 227  if [ ! -z "$pass" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then
228 228  case="1" 
... ... @@ -249,9 +249,9 @@
249 249  mosquitto_pub $D -h $server -p $port -q $pub_qos  -t $pub_topic -u $user -P "$pass" $PUB_FLAG "$mqtt_data"
250 250  \\# 0. Else - invalid parameters, just log
251 251  else
252 -case="Invalid parameters" 
253 -logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."
254 -fi
254 +case="(% style="color:red" %)Invalid parameters" (%%)
255 +logger (% style="color:red" %)"[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."(%%)
256 +fi//
255 255  )))
256 256  
257 257  
... ... @@ -261,6 +261,7 @@
261 261  
262 262  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/]].
263 263  
266 +
264 264  == 4.2 Simulate via MQTT.fx utility ==
265 265  
266 266  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.
... ... @@ -269,19 +269,21 @@
269 269  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.
270 270  )))
271 271  
272 -[[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]]
273 273  
274 274  Connect to MQTT Broker
275 275  
279 +
276 276  After connected, use publish to public some thing to MQTT server. This to simulate upsteam
277 277  
278 -[[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]]
279 279  
280 280  Upstream: Publish message to MQTT Broker
281 281  
286 +
282 282  To simulate a downstream, use MQTT.fx to subscribe a topic, and publish something to this topic. as Below:
283 283  
284 -[[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]]
285 285  
286 286  Downstream: Subscribe a topic to get downstream
287 287  
... ... @@ -293,7 +293,7 @@
293 293  In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection.
294 294  
295 295  
296 -(% class="mark" %)**For Upstream**
301 +(% style="color:#4f81bd" %)**For Upstream**
297 297  
298 298  command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]]
299 299  
... ... @@ -301,16 +301,16 @@
301 301  
302 302  Note: 192.168.199.148 is MQTT broker address, the gateway and the MQTT broker PC are in the same network.
303 303  
304 -[[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]]
305 305  
306 306  mosquitto_pub
307 307  
308 308  
309 -(% class="mark" %)**For Downstream**
314 +(% style="color:#4f81bd" %)**For Downstream**
310 310  
311 311  Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic.
312 312  
313 -[[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]]
314 314  
315 315  mosquitto_sub
316 316  
... ... @@ -320,7 +320,7 @@
320 320  This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection.
321 321  
322 322  (((
323 -Go to (% class="mark" %)**Dragino Menu ~-~-> MQTT Client**
328 +Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client**
324 324  )))
325 325  
326 326  [[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]]
... ... @@ -328,10 +328,10 @@
328 328  go to mqtt configure menu
329 329  
330 330  (((
331 -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.
332 332  )))
333 333  
334 -[[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]]
335 335  
336 336  forward to MQTT
337 337  
... ... @@ -349,15 +349,16 @@
349 349  ~/~/DATA: The data stores in /var/iot/channels/
350 350  )))
351 351  
352 -[[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]]
353 353  
354 354  MQTT Publish configure
355 355  
356 356  
357 -[[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]]
358 358  
359 359  MQTT Channel settings
360 360  
366 +
361 361  (((
362 362  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:
363 363  )))
... ... @@ -376,7 +376,7 @@
376 376  Below is a simulation to put this data to active the MQTT publish.
377 377  )))
378 378  
379 -[[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]]
380 380  
381 381  MQTT Publish
382 382  
... ... @@ -390,7 +390,7 @@
390 390  mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command.
391 391  )))
392 392  
393 -[[image:https://wiki.dragino.com/images/3/36/MQTT_Command_12.png||height="173" width="579"]]
399 +[[image:image-20220527140100-15.png]]
394 394  
395 395  MQTT Subscribe
396 396  
... ... @@ -399,7 +399,7 @@
399 399  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:
400 400  )))
401 401  
402 -[[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]]
403 403  
404 404  LoRa Broadcast parameters.
405 405  
... ... @@ -406,7 +406,7 @@
406 406  
407 407  And below is the subscribe simulation:
408 408  
409 -[[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]]
410 410  
411 411  downstream simulation
412 412  
... ... @@ -415,6 +415,7 @@
415 415  
416 416  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.
417 417  
424 +
418 418  === 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
419 419  
420 420  (((
... ... @@ -437,7 +437,7 @@
437 437  * Downstream: Listening broadcast message from gateway, and print it in console.
438 438  * The LoRa parameter settings in Arduino should match the LoRa settings in gateway, as below:
439 439  
440 -[[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]]
441 441  
442 442  LoRa Parameter should match
443 443  
... ... @@ -444,12 +444,13 @@
444 444  
445 445  Below is the test result after the Arduino Sketch is running.
446 446  
447 -[[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]]
448 448  
449 449  Upstream Data Flow
450 450  
451 -[[image:https://wiki.dragino.com/images/thumb/1/18/MQTT_Command_19.png/600px-MQTT_Command_19.png||height="309" width="600"]]
452 452  
459 +[[image:image-20220527140542-20.png]]
460 +
453 453  Downstream Data Flow
454 454  
455 455  
... ... @@ -456,23 +456,23 @@
456 456  === 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
457 457  
458 458  (((
459 -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.
460 460  )))
461 461  
462 462  (((
463 -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.
464 -(% 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]]
465 465  )))
466 466  
467 467  (((
468 -**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.
469 469  )))
470 470  
471 471  (((
472 -**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.
473 473  )))
474 474  
475 -[[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]]
476 476  
477 477  Use Same Frequency Band as End Node
478 478  
... ... @@ -479,7 +479,7 @@
479 479  
480 480  (((
481 481  (((
482 -**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 HEX format in the file. And we need to config the format to META
483 483  )))
484 484  )))
485 485  
... ... @@ -488,7 +488,7 @@
488 488  Publish mush use META as data format for LG308
489 489  
490 490  
491 -**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.
492 492  
493 493  [[image:https://wiki.dragino.com/images/thumb/7/7f/LG308_MQTT_4.png/600px-LG308_MQTT_4.png||height="335" width="600"]]
494 494  
... ... @@ -495,7 +495,7 @@
495 495  Map Dev Addr to remote ID
496 496  
497 497  
498 -**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
499 499  
500 500  [[image:https://wiki.dragino.com/images/thumb/b/be/LG308_MQTT_6.png/600px-LG308_MQTT_6.png||height="279" width="600"]]
501 501  
... ... @@ -510,7 +510,7 @@
510 510  LHT65 Decoder
511 511  
512 512  
513 -**Step 6: Set up subscribe:** Subscribe a topci for downstream.
521 +(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
514 514  
515 515  [[image:https://wiki.dragino.com/images/thumb/b/b9/LG308_MQTT_7.png/600px-LG308_MQTT_7.png||height="176" width="600"]]
516 516  
... ... @@ -517,13 +517,13 @@
517 517  Subscribe to a topic
518 518  
519 519  
520 -**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.
521 521  
522 522  [[image:https://wiki.dragino.com/images/thumb/9/97/LG308_MQTT_8.png/600px-LG308_MQTT_8.png||height="298" width="600"]]
523 523  
524 524  Downstream Flow
525 525  
526 -(% 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]]**
527 527  
528 528  
529 529  = 5. Example For Different MQTT Servers =
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
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