Changes for page MQTT Forward Instruction

Last modified by Kilight Cao on 2024/08/31 16:26
<
From version < 37.4 >
edited by Xiaoling
on 2022/05/31 14:41
To version < 44.5 >
edited by Xiaoling
on 2022/07/14 15:55
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,19 +1,21 @@
1 -**~ Contents：**
1 +**~ Table of Contents：**
2 2  
3 3  {{toc/}}
4 4  
5 5  
6 -= 1. Introduction =
6 += 1.  Introduction =
7 7  
8 +
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  
11 -== 1.1 Support Devices ==
12 +== 1.1  Support Devices ==
12 12  
14 +
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>>Through MQTT to upload data]])
18 +* LG01N, OLG01N ((% style="color:red" %)**Warning**(%%): LG01-P LG01-S use another instruction: [[MQTT for LG01-P/LG01S>>doc:Through MQTT to upload data.WebHome]])
17 17  * LG02, OLG02
18 18  * LG308, DLOS8
19 19  * LPS8
... ... @@ -21,8 +21,10 @@
21 21  * MS14 series if installed with the same firmware. (in this case, the MQTT forward will work , but no LoRa support)
22 22  
23 23  
24 -= 2. Firmware Change Log for MQTT feature =
25 25  
27 += 2.  Firmware Change Log for MQTT feature =
28 +
29 +
26 26  (((
27 27  This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware.
28 28  )))
... ... @@ -31,14 +31,17 @@
31 31  ** Initiate version
32 32  
33 33  
34 -= 3. MQTT forward operating principle =
35 35  
36 -== 3.1 Network Structure ==
39 += 3.  MQTT forward operating principle =
37 37  
41 +
42 +== 3.1  Network Structure ==
43 +
44 +
38 38  Below shows the network structure for MQTT forwarding.
39 39  
40 -* 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.
41 -* 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,
47 +* **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.
48 +* **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,
42 42  
43 43  [[image:image-20220527133547-1.png]]
44 44  
... ... @@ -45,12 +45,13 @@
45 45  General MQTT structure
46 46  
47 47  
48 -== 3.2 How sensor data is forwarded ==
55 +== 3.2  How sensor data is forwarded ==
49 49  
57 +
50 50  In this MQTT forward feature, the key point is how the gateway process the sensor data.
51 51  
52 52  
53 -=== 3.2.1 Upstream ===
61 +=== 3.2.1  Upstream ===
54 54  
55 55  Assume there are two sensor nodes, their ID are Node1 ID: 6734 , Node2 ID: 7456. In the remote MQTT broker there are two topics: Topic1: /channel/765800, Topic2: /channel/367860. We can set up in the gateway to map Node1 to Topic1 and Node2 to Topic2. So when there is a sensor data from Node1, the gateway will forward the data to Topic1, when there is sensor data from Node2, the gateway will forward to Topic2.
56 56  
... ... @@ -62,10 +62,12 @@
62 62  
63 63  (((
64 64  Upstream path
73 +
74 +
65 65  )))
66 66  
67 67  (((
68 -Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span>
78 +(% style="color:red" %)**Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span>**
69 69  )))
70 70  
71 71  (((
... ... @@ -72,8 +72,9 @@
72 72  
73 73  )))
74 74  
75 -=== 3.2.2 Downstream ===
85 +=== 3.2.2  Downstream ===
76 76  
87 +
77 77  The gateway subscribes to a topic of the remote MQTT broker topic. When there is some one publish a value on this topic. The gateway will get it and broadcast to local LoRa Network.
78 78  
79 79  (((
... ... @@ -85,8 +85,9 @@
85 85  Downstream path
86 86  
87 87  
88 -== 3.3 Macro Definition ==
99 +== 3.3  Macro Definition ==
89 89  
101 +
90 90  The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish.
91 91  
92 92  (((
... ... @@ -95,8 +95,9 @@
95 95  
96 96  )))
97 97  
98 -=== 3.3.1 -t topic macro ===
110 +=== 3.3.1  -t topic macro ===
99 99  
112 +
100 100  * CHANNEL: Remote Channel ID
101 101  * CLIENTID: Client ID , Same as -i
102 102  * WRITE_API: Remote Channel Write API
... ... @@ -103,8 +103,12 @@
103 103  * USERNAME: User ID (-u)
104 104  * HOSTNAME: Device Hostname
105 105  
106 -=== 3.3.2 -m message macro ===
107 107  
120 +
121 +
122 +=== 3.3.2  -m message macro ===
123 +
124 +
108 108  * HOSTNAME: Device Hostname
109 109  * CHANNEL: Remote Channel ID
110 110  * DATA: Sensor Data without time stamp and rssi
... ... @@ -111,14 +111,19 @@
111 111  * META: Completely sensor data with time stamp and rssi
112 112  * JSON: Convert META to json format.
113 113  
114 -=== 3.3.3 Example for Macro ===
115 115  
132 +
133 +
134 +=== 3.3.3  Example for Macro ===
135 +
136 +
116 116  [[image:image-20220527134251-4.png]]
117 117  
118 118  MQTT Publish configure
119 119  
120 -Above screen shots shows below format:
121 121  
142 +**Above screen shots shows below format:**
143 +
122 122  * -t: CLIENTID/CHANNEL/data
123 123  * -m: DATA
124 124  
... ... @@ -128,13 +128,16 @@
128 128  
129 129  Sensor Data
130 130  
153 +
131 131  (((
132 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.
133 133  )))
134 134  
135 135  
136 -== 3.4 Modify the MQTT to support more options ==
137 137  
160 +== 3.4  Modify the MQTT to support more options ==
161 +
162 +
138 138  The MQTT Client Utility used in Dragino is **mosquitto_pub** and **mosquitto_sub**. User can add more options to the mqtt commands. User can check the valid options by command mosquitto_pub ~-~-help. as below:
139 139  
140 140  (% class="box" %)
... ... @@ -152,9 +152,9 @@
152 152   [-u username [-P password]]
153 153   [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]]
154 154   [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file]
155 - [~-~-ciphers ciphers] [~-~-insecure]
156 - [~-~-tls-alpn protocol]
157 - [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]
180 + [~-~-ciphers ciphers] [~-~-insecure]
181 + [~-~-tls-alpn protocol]
182 + [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]
158 158   [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]]
159 159   [~-~-proxy socks-url]
160 160   [~-~-property command identifier value]
... ... @@ -334,6 +334,7 @@
334 334  
335 335  go to mqtt configure menu
336 336  
362 +
337 337  (((
338 338  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.
339 339  )))
... ... @@ -451,6 +451,7 @@
451 451  LoRa Parameter should match
452 452  
453 453  
480 +
454 454  Below is the test result after the Arduino Sketch is running.
455 455  
456 456  [[image:image-20220527140459-19.png]]
... ... @@ -458,6 +458,7 @@
458 458  Upstream Data Flow
459 459  
460 460  
488 +
461 461  [[image:image-20220527140542-20.png]]
462 462  
463 463  Downstream Data Flow
... ... @@ -489,20 +489,18 @@
489 489  
490 490  (((
491 491  (((
492 -(% 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**
520 +(% 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.
493 493  )))
494 494  )))
495 495  
496 -[[image:image-20220527141450-22.png]]
524 +[[image:image-20220613191345-4.png]]
497 497  
498 -Publish mush use META as data format for LG308
499 499  
500 500  
501 501  (% style="color:#4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
502 502  
503 -[[image:image-20220527141727-23.png]]
530 +[[image:image-20220613190635-2.png]]
504 504  
505 -Map Dev Addr to remote ID
506 506  
507 507  
508 508  (% style="color:#4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
... ... @@ -509,24 +509,25 @@
509 509  
510 510  [[image:image-20220527141843-24.png]]
511 511  
512 -Upstream Process
513 513  
514 514  
540 +
515 515  [[image:image-20220527141933-25.png]]
516 516  
517 517  Choose ASCII Format
518 518  
519 519  
546 +
520 520  [[image:image-20220527142028-26.png]]
521 521  
522 522  LHT65 Decoder
523 523  
524 524  
552 +
525 525  (% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
526 526  
527 -[[image:image-20220527142115-27.png]]
555 +[[image:image-20220613191426-5.png]]
528 528  
529 -Subscribe to a topic
530 530  
531 531  
532 532  (% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
... ... @@ -533,10 +533,32 @@
533 533  
534 534  [[image:image-20220527142239-28.png]]
535 535  
536 -Downstream Flow
537 537  
564 +
565 +=== MQTT Downstream format ===
566 +
567 +
568 +mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**"
569 +
570 +(% class="box infomessage" %)
571 +(((
572 +mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"
573 +)))
574 +
575 +mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**"
576 +
577 +(% class="box infomessage" %)
578 +(((
579 +mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello,20,1,SF12,923300000,2 > /var/iot/push/test"
580 +)))
581 +
582 +Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]]
583 +
584 +[[image:image-20220613192816-6.png||height="440" width="1056"]]
585 +
538 538  (% style="color:red" %)**Notice: The text use for Downstream must meet the requirement from [[LG308 Downstream Payload>>Communicate with ABP End Node without LoRaWAN Network Server --- LG308||anchor="H2.2Downstream"]]**
539 539  
588 +Check out this link for more mosquito-related directives [[https:~~/~~/mosquitto.org/man/mosquitto_pub-1.html>>https://mosquitto.org/man/mosquitto_pub-1.html]]
540 540  
541 541  = 5. How to Debug =
542 542  
image-20220613190254-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +55.7 KB
Content
image-20220613190635-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +44.1 KB
Content
image-20220613191154-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +56.1 KB
Content
image-20220613191345-4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +55.4 KB
Content
image-20220613191426-5.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +55.8 KB
Content
image-20220613192816-6.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +22.1 KB
Content

Applications

Navigation

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