Changes for page MQTT Forward Instruction

Last modified by Xiaoling on 2025/07/31 16:59

From version 37.10
edited by Xiaoling
on 2022/06/01 10:45
Change comment: There is no comment for this version
To version 1.8
edited by Xiaoling
on 2022/05/12 15:57
Change comment: There is no comment for this version

Summary

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>>doc:Through MQTT to upload data.WebHome]])
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
... ... @@ -21,7 +21,6 @@
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 -
25 25  = 2. Firmware Change Log for MQTT feature =
26 26  
27 27  (((
... ... @@ -32,7 +32,6 @@
32 32  ** Initiate version
33 33  
34 34  
35 -
36 36  = 3. MQTT forward operating principle =
37 37  
38 38  == 3.1 Network Structure ==
... ... @@ -42,7 +42,7 @@
42 42  * 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.
43 43  * 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,
44 44  
45 -[[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"]]
46 46  
47 47  General MQTT structure
48 48  
... ... @@ -60,7 +60,7 @@
60 60  The data flow works as below diagram.
61 61  )))
62 62  
63 -[[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]]
64 64  
65 65  (((
66 66  Upstream path
... ... @@ -82,7 +82,7 @@
82 82  Below are the data flow for downstream.
83 83  )))
84 84  
85 -[[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"]]
86 86  
87 87  Downstream path
88 88  
... ... @@ -92,9 +92,7 @@
92 92  The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish.
93 93  
94 94  (((
95 -Currently the (% style="color:#4f81bd" %)**-t (topic)**(%%) and (% style="color:#4f81bd" %)**-m (message)**(%%) support Macros.
96 -
97 -
92 +Currently the (% class="mark" %)**-t (topic)**(%%) and (% class="mark" %)**-m (message)**(%%) support Macros.
98 98  )))
99 99  
100 100  === 3.3.1 -t topic macro ===
... ... @@ -105,8 +105,6 @@
105 105  * USERNAME: User ID (-u)
106 106  * HOSTNAME: Device Hostname
107 107  
108 -
109 -
110 110  === 3.3.2 -m message macro ===
111 111  
112 112  * HOSTNAME: Device Hostname
... ... @@ -115,11 +115,9 @@
115 115  * META: Completely sensor data with time stamp and rssi
116 116  * JSON: Convert META to json format.
117 117  
118 -
119 -
120 120  === 3.3.3 Example for Macro ===
121 121  
122 -[[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"]]
123 123  
124 124  MQTT Publish configure
125 125  
... ... @@ -130,12 +130,12 @@
130 130  
131 131  When there is a LoRa sensor arrive. it will be store at the /var/iot/channels as below:
132 132  
133 -[[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"]]
134 134  
135 135  Sensor Data
136 136  
137 137  (((
138 -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.
139 139  )))
140 140  
141 141  
... ... @@ -143,126 +143,128 @@
143 143  
144 144  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:
145 145  
146 -(% class="box" %)
147 -(((
148 -root@dragino-1ec39c:~~# mosquitto_pub ~-~-help
137 +{{{root@dragino-1ec39c:~# mosquitto_pub --help
149 149  mosquitto_pub is a simple mqtt client that will publish a message on a single topic and exit.
150 150  mosquitto_pub version 1.6.4 running on libmosquitto 1.6.4.
151 -\\Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL}
140
141 +Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL}
152 152   {-f file | -l | -n | -m message}
153 - [-c] [-k keepalive] [-q qos] [-r] [~-~-repeat N] [~-~-repeat-delay time]
143 + [-c] [-k keepalive] [-q qos] [-r] [--repeat N] [--repeat-delay time]
154 154   [-A bind_address]
155 155   [-i id] [-I id_prefix]
156 - [-d] [~-~-quiet]
146 + [-d] [--quiet]
157 157   [-M max_inflight]
158 158   [-u username [-P password]]
159 - [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]]
160 - [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file]
161 - [~-~-ciphers ciphers] [~-~-insecure]
162 - [~-~-tls-alpn protocol]
163 - [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]
164 - [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]]
165 - [~-~-proxy socks-url]
166 - [~-~-property command identifier value]
149 + [--will-topic [--will-payload payload] [--will-qos qos] [--will-retain]]
150 + [{--cafile file | --capath dir} [--cert file] [--key file]
151 + [--ciphers ciphers] [--insecure]
152 + [--tls-alpn protocol]
153 + [--tls-engine engine] [--keyform keyform] [--tls-engine-kpass-sha1]]
154 + [--psk hex-key --psk-identity identity [--ciphers ciphers]]
155 + [--proxy socks-url]
156 + [--property command identifier value]
167 167   [-D command identifier value]
168 - mosquitto_pub ~-~-help
169 -\\-A : bind the outgoing socket to this host/ip address. Use to control which interface
158 + mosquitto_pub --help
159
160 + -A : bind the outgoing socket to this host/ip address. Use to control which interface
170 170   the client communicates over.
171 --d : enable debug messages.
172 --D : Define MQTT v5 properties. See the documentation for more details.
173 --f : send the contents of a file as the message.
174 --h : mqtt host to connect to. Defaults to localhost.
175 --i : id to use for this client. Defaults to mosquitto_pub_ appended with the process id.
176 --I : define the client id as id_prefix appended with the process id. Useful for when the
162 + -d : enable debug messages.
163 + -D : Define MQTT v5 properties. See the documentation for more details.
164 + -f : send the contents of a file as the message.
165 + -h : mqtt host to connect to. Defaults to localhost.
166 + -i : id to use for this client. Defaults to mosquitto_pub_ appended with the process id.
167 + -I : define the client id as id_prefix appended with the process id. Useful for when the
177 177   broker is using the clientid_prefixes option.
178 --k : keep alive in seconds for this client. Defaults to 60.
179 --L : specify user, password, hostname, port and topic as a URL in the form:
180 - mqtt(s):~/~/[username[:password]@]host[:port]/topic
181 --l : read messages from stdin, sending a separate message for each line.
182 --m : message payload to send.
183 --M : the maximum inflight messages for QoS 1/2..
184 --n : send a null (zero length) message.
185 --p : network port to connect to. Defaults to 1883 for plain MQTT and 8883 for MQTT over TLS.
186 --P : provide a password
187 --q : quality of service level to use for all messages. Defaults to 0.
188 --r : message should be retained.
189 --s : read message from stdin, sending the entire input as a message.
190 --t : mqtt topic to publish to.
191 --u : provide a username
192 --V : specify the version of the MQTT protocol to use when connecting.
169 + -k : keep alive in seconds for this client. Defaults to 60.
170 + -L : specify user, password, hostname, port and topic as a URL in the form:
171 + mqtt(s)://[username[:password]@]host[:port]/topic
172 + -l : read messages from stdin, sending a separate message for each line.
173 + -m : message payload to send.
174 + -M : the maximum inflight messages for QoS 1/2..
175 + -n : send a null (zero length) message.
176 + -p : network port to connect to. Defaults to 1883 for plain MQTT and 8883 for MQTT over TLS.
177 + -P : provide a password
178 + -q : quality of service level to use for all messages. Defaults to 0.
179 + -r : message should be retained.
180 + -s : read message from stdin, sending the entire input as a message.
181 + -t : mqtt topic to publish to.
182 + -u : provide a username
183 + -V : specify the version of the MQTT protocol to use when connecting.
193 193   Can be mqttv5, mqttv311 or mqttv31. Defaults to mqttv311.
194 -~-~-help : display this message.
195 -~-~-repeat : if publish mode is -f, -m, or -s, then repeat the publish N times.
196 -~-~-repeat-delay : if using ~-~-repeat, wait time seconds between publishes. Defaults to 0.
197 -~-~-quiet : (% style="color:red" %)don't print error messages.
198 -~-~-will-payload : payload for the client Will, which is sent by the broker in case of
185 + --help : display this message.
186 + --repeat : if publish mode is -f, -m, or -s, then repeat the publish N times.
187 + --repeat-delay : if using --repeat, wait time seconds between publishes. Defaults to 0.
188 + --quiet : don't print error messages.
189 + --will-payload : payload for the client Will, which is sent by the broker in case of
199 199   unexpected disconnection. If not given and will-topic is set, a zero
200 200   length message will be sent.
201 -~-~-will-qos : QoS level for the client Will.
202 -~-~-will-retain : if given, make the client Will retained.
203 -~-~-will-topic : the topic on which to publish the client Will.
204 -~-~-cafile : path to a file containing trusted CA certificates to enable encrypted
192 + --will-qos : QoS level for the client Will.
193 + --will-retain : if given, make the client Will retained.
194 + --will-topic : the topic on which to publish the client Will.
195 + --cafile : path to a file containing trusted CA certificates to enable encrypted
205 205   communication.
206 -~-~-capath : path to a directory containing trusted CA certificates to enable encrypted
197 + --capath : path to a directory containing trusted CA certificates to enable encrypted
207 207   communication.
208 -~-~-cert : client certificate for authentication, if required by server.
209 -~-~-key : client private key for authentication, if required by server.
210 -~-~-keyform : keyfile type, can be either "pem" or "engine".
211 -~-~-ciphers : openssl compatible list of TLS ciphers to support.
212 -~-~-tls-version : TLS protocol version, can be one of tlsv1.3 tlsv1.2 or tlsv1.1.
199 + --cert : client certificate for authentication, if required by server.
200 + --key : client private key for authentication, if required by server.
201 + --keyform : keyfile type, can be either "pem" or "engine".
202 + --ciphers : openssl compatible list of TLS ciphers to support.
203 + --tls-version : TLS protocol version, can be one of tlsv1.3 tlsv1.2 or tlsv1.1.
213 213   Defaults to tlsv1.2 if available.
214 -~-~-insecure : do not check that the server certificate hostname matches the remote
205 + --insecure : do not check that the server certificate hostname matches the remote
215 215   hostname. Using this option means that you cannot be sure that the
216 216   remote host is the server you wish to connect to and so is insecure.
217 217   Do not use this option in a production environment.
218 -~-~-tls-engine : If set, enables the use of a TLS engine device.
219 -~-~-tls-engine-kpass-sha1 : SHA1 of the key password to be used with the selected SSL engine.
220 -~-~-psk : pre-shared-key in hexadecimal (no leading 0x) to enable TLS-PSK mode.
221 -~-~-psk-identity : client identity string for TLS-PSK mode.
222 -~-~-proxy : SOCKS5 proxy URL of the form:
223 - socks5h:~/~/[username[:password]@]hostname[:port]
209 + --tls-engine : If set, enables the use of a TLS engine device.
210 + --tls-engine-kpass-sha1 : SHA1 of the key password to be used with the selected SSL engine.
211 + --psk : pre-shared-key in hexadecimal (no leading 0x) to enable TLS-PSK mode.
212 + --psk-identity : client identity string for TLS-PSK mode.
213 + --proxy : SOCKS5 proxy URL of the form:
214 + socks5h://[username[:password]@]hostname[:port]
224 224   Only "none" and "username" authentication is supported.
225 -\\See https:~/~/mosquitto.org/ for more information.
226 -)))
216 + 
217 +See https://mosquitto.org/ for more information.}}}
227 227  
228 228  
229 -(((
230 230  and modify the /usr/bin/mqtt_process.sh script, the location to change the command option is below lines:
231 -)))
232 232  
233 -(% class="box" %)
234 -(((
235 -//# Call MQTT Publish command
236 -\\# 1. Case with User, Password and Client ID present  (e.g. Azure)
222 +{{{# Call MQTT Publish command
223
224 +# 1. Case with User, Password and Client ID present (e.g. Azure)
237 237  if [ ! -z "$pass" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then
238 -case="1" 
239 -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"
240 -\\# 2. Case with Certificate, Key and ClientID present (e.g. AWS)
226 + case="1"
227 + 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"
228
229 +# 2. Case with Certificate, Key and ClientID present (e.g. AWS)
241 241  elif [ ! -z "$certfile" ] && [ ! -z "$key" ] && [ ! -z "$clientID" ]; then
242 -case="2" 
243 -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"
244 -\\# 3. Case with no User, Certificate or ClientID present
231 + case="2"
232 + 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"
233
234 +# 3. Case with no User, Certificate or ClientID present
245 245  elif [ -z "$user" ] && [ -z "$certfile" ] && [ -z "$clientID" ]; then
246 -case="3" 
247 -mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data"
248 -\\# 4. Case with no User, Certificate, but with ClientID present
236 + case="3"
237 + mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data"
238
239 +# 4. Case with no User, Certificate, but with ClientID present
249 249  elif [ -z "$user" ] && [ -z "$certfile" ] && [ ! -z "$clientID" ]; then
250 -case="4" 
251 -mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data"
252 -\\# 5. Case with User and ClientID present, but no Password and no Certificate present
241 + case="4"
242 + mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data"
243
244 +# 5. Case with User and ClientID present, but no Password and no Certificate present
253 253  elif [ -z "$pass" ] && [ -z "$certfile" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then
254 -case="5" 
255 -mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user $PUB_FLAG "$mqtt_data"
256 -\\# 6. Case with User and Password present, but no ClientID and no Certificate present
246 + case="5"
247 + mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user $PUB_FLAG "$mqtt_data"
248
249 +# 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 -case="6" 
259 -mosquitto_pub $D -h $server -p $port -q $pub_qos  -t $pub_topic -u $user -P "$pass" $PUB_FLAG "$mqtt_data"
260 -\\# 0. Else - invalid parameters, just log
251 + case="6"
252 + mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic -u $user -P "$pass" $PUB_FLAG "$mqtt_data"
253
254 +# 0. Else - invalid parameters, just log
261 261  else
262 -case="(% style="color:red" %)Invalid parameters" (%%)
263 -logger (% style="color:red" %)"[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."(%%)
264 -fi//
265 -)))
256 + case="Invalid parameters"
257 + logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."
258 +fi}}}
266 266  
267 267  
268 268  = 4. Example to communicate to a simple MQTT server =
... ... @@ -271,30 +271,25 @@
271 271  
272 272  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/]].
273 273  
274 -
275 275  == 4.2 Simulate via MQTT.fx utility ==
276 276  
277 277  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.
278 278  
279 -(((
280 280  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.
281 -)))
282 282  
283 -[[image:image-20220527134929-6.png]]
273 +[[~[~[image:https://wiki.dragino.com/images/thumb/0/06/MQTT_Forward_4.png/600px-MQTT_Forward_4.png~|~|height="201" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_4.png]]
284 284  
285 285  Connect to MQTT Broker
286 286  
287 -
288 288  After connected, use publish to public some thing to MQTT server. This to simulate upsteam
289 289  
290 -[[image:image-20220527135037-7.png]]
279 +[[~[~[image:https://wiki.dragino.com/images/thumb/b/bd/MQTT_Forward_5.png/600px-MQTT_Forward_5.png~|~|height="149" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_5.png]]
291 291  
292 292  Upstream: Publish message to MQTT Broker
293 293  
294 -
295 295  To simulate a downstream, use MQTT.fx to subscribe a topic, and publish something to this topic. as Below:
296 296  
297 -[[image:image-20220527135215-8.png]]
285 +[[~[~[image:https://wiki.dragino.com/images/thumb/3/3d/MQTT_Forward_6.png/600px-MQTT_Forward_6.png~|~|height="279" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_6.png]]
298 298  
299 299  Downstream: Subscribe a topic to get downstream
300 300  
... ... @@ -306,7 +306,7 @@
306 306  In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection.
307 307  
308 308  
309 -(% style="color:#4f81bd" %)**For Upstream**
297 +For Upstream
310 310  
311 311  command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]]
312 312  
... ... @@ -314,83 +314,65 @@
314 314  
315 315  Note: 192.168.199.148 is MQTT broker address, the gateway and the MQTT broker PC are in the same network.
316 316  
317 -[[image:image-20220527135310-9.png]]
305 +[[~[~[image:https://wiki.dragino.com/images/thumb/d/d0/MQTT_Command_6.png/600px-MQTT_Command_6.png~|~|height="188" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_6.png]]
318 318  
319 319  mosquitto_pub
320 320  
321 321  
322 -(% style="color:#4f81bd" %)**For Downstream**
310 +For Downstream
323 323  
324 324  Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic.
325 325  
326 -[[image:image-20220527135440-10.png]]
314 +[[~[~[image:https://wiki.dragino.com/images/thumb/8/89/MQTT_Command_7.png/600px-MQTT_Command_7.png~|~|height="267" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_7.png]]
327 327  
328 328  mosquitto_sub
329 329  
330 -
331 331  == 4.4 Configure Dragino UI for MQTT connection ==
332 332  
333 333  This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection.
334 334  
335 -(((
336 -Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client**
337 -)))
322 +Go to Dragino Menu ~-~-> MQTT Client
338 338  
339 -[[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]]
324 +[[~[~[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png~|~|height="249" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_8.png]]
340 340  
341 341  go to mqtt configure menu
342 342  
343 -(((
344 -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.
345 -)))
328 +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.
346 346  
347 -[[image:image-20220527135742-11.png]]
330 +[[~[~[image:https://wiki.dragino.com/images/thumb/1/14/MQTT_Commands_8.png/600px-MQTT_Commands_8.png~|~|height="240" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Commands_8.png]]
348 348  
349 349  forward to MQTT
350 350  
351 -
352 352  === 4.4.1 Configure the MQTT Client for Upstream ===
353 353  
354 354  Below screenshot is same as the publish command:
355 355  
356 -(% class="box" %)
357 -(((
358 -mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA
359 -~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for
360 -~/~/CLIENTID: dragino-1b7060
361 -~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456
362 -~/~/DATA: The data stores in /var/iot/channels/
363 -)))
338 +{{{mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA
339 +//where the CLIENTID, CHANNEL & DATA are macro. represent for
340 +//CLIENTID: dragino-1b7060
341 +//CHANNEL: Remote ID in Channel settings; here is 78901 or 567456
342 +//DATA: The data stores in /var/iot/channels/
343 +}}}
364 364  
365 -[[image:image-20220527135828-12.png]]
345 +[[~[~[image:https://wiki.dragino.com/images/thumb/c/c7/MQTT_Command_9.png/600px-MQTT_Command_9.png~|~|height="385" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_9.png]]
366 366  
367 367  MQTT Publish configure
368 368  
349 +[[~[~[image:https://wiki.dragino.com/images/thumb/b/b7/MQTT_Command_10.png/600px-MQTT_Command_10.png~|~|height="544" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_10.png]]
369 369  
370 -[[image:image-20220527135929-13.png]]
371 -
372 372  MQTT Channel settings
373 373  
374 -
375 -(((
376 376  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:
377 -)))
378 378  
379 -(% class="box" %)
380 -(((
381 -mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t dragino-1b7060/78901/data -m temp=46
382 -)))
355 +{{{mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t dragino-1b7060/78901/data -m temp=46
356 +}}}
383 383  
384 -(((
385 385  to MQTT broker.
386 -)))
387 387  
388 388  
389 -(((
390 390  Below is a simulation to put this data to active the MQTT publish.
391 -)))
392 392  
393 -[[image:image-20220527140023-14.png]]
363 +[[~[~[image:https://wiki.dragino.com/images/thumb/3/30/MQTT_Command_11.png/600px-MQTT_Command_11.png~|~|height="308" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_11.png]]
394 394  
395 395  MQTT Publish
396 396  
... ... @@ -399,21 +399,17 @@
399 399  
400 400  Below screen shot equal to this subscribe command:
401 401  
402 -(% class="box" %)
403 -(((
404 -mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command.
405 -)))
372 +{{{ mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command.
373 +}}}
406 406  
407 -[[image:image-20220527140100-15.png]]
375 +[[~[~[image:https://wiki.dragino.com/images/3/36/MQTT_Command_12.png~|~|height="173" width="579"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_12.png]]
408 408  
409 409  MQTT Subscribe
410 410  
411 411  
412 -(((
413 413  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:
414 -)))
415 415  
416 -[[image:image-20220527140148-16.png]]
382 +[[~[~[image:https://wiki.dragino.com/images/thumb/b/b8/MQTT_Command_13.png/600px-MQTT_Command_13.png~|~|height="300" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_13.png]]
417 417  
418 418  LoRa Broadcast parameters.
419 419  
... ... @@ -420,39 +420,31 @@
420 420  
421 421  And below is the subscribe simulation:
422 422  
423 -[[image:image-20220527140238-17.png]]
389 +[[~[~[image:https://wiki.dragino.com/images/thumb/6/60/MQTT_Command_14.png/600px-MQTT_Command_14.png~|~|height="255" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_14.png]]
424 424  
425 425  downstream simulation
426 426  
427 427  
394 +
428 428  == 4.5 Add LoRa support to communicate with remote sensor ==
429 429  
430 430  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.
431 431  
432 -
433 433  === 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
434 434  
435 -(((
436 436  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.
437 -)))
438 438  
439 -(((
440 440  The example Sketch for LoRa Shield +Arduino is here: [[LoRa_Shield_Sketch_For_MQTT>>url:http://www.dragino.com/downloads/index.php?dir=LoraShield/]]
441 -)))
442 442  
443 -(((
444 444  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.
445 -)))
446 446  
447 -(((
448 448  What does the Arduino Sketch do? The Arduino Sketch will:
449 -)))
450 450  
451 451  * 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).
452 452  * Downstream: Listening broadcast message from gateway, and print it in console.
453 453  * The LoRa parameter settings in Arduino should match the LoRa settings in gateway, as below:
454 454  
455 -[[image:image-20220527140354-18.png]]
413 +[[~[~[image:https://wiki.dragino.com/images/thumb/3/3b/MQTT_Command_17.png/600px-MQTT_Command_17.png~|~|height="197" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_17.png]]
456 456  
457 457  LoRa Parameter should match
458 458  
... ... @@ -459,98 +459,110 @@
459 459  
460 460  Below is the test result after the Arduino Sketch is running.
461 461  
462 -[[image:image-20220527140459-19.png]]
420 +[[~[~[image:https://wiki.dragino.com/images/thumb/6/63/MQTT_Command_18.png/600px-MQTT_Command_18.png~|~|height="319" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_18.png]]
463 463  
464 464  Upstream Data Flow
465 465  
424 +[[~[~[image:https://wiki.dragino.com/images/thumb/1/18/MQTT_Command_19.png/600px-MQTT_Command_19.png~|~|height="309" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_19.png]]
466 466  
467 -[[image:image-20220527140542-20.png]]
468 -
469 469  Downstream Data Flow
470 470  
471 471  
472 472  === 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
473 473  
474 -(((
475 -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.
476 -)))
431 +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.
477 477  
478 -(((
479 -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.
480 -(% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
481 -)))
433 +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.
482 482  
483 -(((
484 -(% style="color:#4f81bd" %)**Step 1**(%%): Refer [[Communicate with ABP End Node>>Communicate with ABP End Node without LoRaWAN Network Server --- LG308]] to know how to set up LG308 to work with LoRaWAN End node.
485 -)))
486 486  
487 -(((
488 -(% style="color:#4f81bd" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
489 -)))
490 490  
491 -[[image:image-20220527141235-21.png]]
437 +Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
438 +
492 492  
440 +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.
441 +
442 +Step 2: Make sure your Radio settings match the End Node settings.
443 +
444 +[[~[~[image:https://wiki.dragino.com/images/thumb/f/f7/LG308_MQTT_5.png/600px-LG308_MQTT_5.png~|~|height="387" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_5.png]]
445 +
493 493  Use Same Frequency Band as End Node
494 494  
495 495  
496 -(((
497 -(((
498 -(% 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**
499 -)))
500 -)))
449 +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
501 501  
502 -[[image:image-20220527141450-22.png]]
451 +[[~[~[image:https://wiki.dragino.com/images/thumb/8/8d/LG308_MQTT_3.png/600px-LG308_MQTT_3.png~|~|height="385" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_3.png]]
503 503  
504 504  Publish mush use META as data format for LG308
505 505  
506 506  
507 -(% style="color:#4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
456 +Step 4: Map the Device Address to Remote ID in MQTT server.
508 508  
509 -[[image:image-20220527141727-23.png]]
458 +[[~[~[image:https://wiki.dragino.com/images/thumb/7/7f/LG308_MQTT_4.png/600px-LG308_MQTT_4.png~|~|height="335" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_4.png]]
510 510  
511 511  Map Dev Addr to remote ID
512 512  
513 513  
514 -(% style="color:#4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
463 +Step 5: Upstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server
515 515  
516 -[[image:image-20220527141843-24.png]]
465 +[[~[~[image:https://wiki.dragino.com/images/thumb/b/be/LG308_MQTT_6.png/600px-LG308_MQTT_6.png~|~|height="279" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_6.png]]
517 517  
518 518  Upstream Process
519 519  
469 +[[~[~[image:https://wiki.dragino.com/images/thumb/0/07/LG308_MQTT_6_1.png/600px-LG308_MQTT_6_1.png~|~|height="246" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_6_1.png]]
520 520  
521 -[[image:image-20220527141933-25.png]]
522 -
523 523  Choose ASCII Format
524 524  
473 +[[~[~[image:https://wiki.dragino.com/images/thumb/a/a3/LG308_MQTT_6_2.png/600px-LG308_MQTT_6_2.png~|~|height="248" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_6_2.png]]
525 525  
526 -[[image:image-20220527142028-26.png]]
527 -
528 528  LHT65 Decoder
529 529  
477 +Step 6: Set up subscribe: Subscribe a topci for downstream.
530 530  
531 -(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
479 +[[~[~[image:https://wiki.dragino.com/images/thumb/b/b9/LG308_MQTT_7.png/600px-LG308_MQTT_7.png~|~|height="176" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_7.png]]
532 532  
533 -[[image:image-20220527142115-27.png]]
534 -
535 535  Subscribe to a topic
536 536  
537 537  
538 -(% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
484 +Step 7: Downstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
539 539  
540 -[[image:image-20220527142239-28.png]]
486 +[[~[~[image:https://wiki.dragino.com/images/thumb/9/97/LG308_MQTT_8.png/600px-LG308_MQTT_8.png~|~|height="298" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_8.png]]
541 541  
542 542  Downstream Flow
543 543  
544 -(% 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"]]**
490 +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]]
545 545  
546 546  
547 -= 5. How to Debug =
493 += 5. Example For Different MQTT Servers =
548 548  
549 -User can login the gateway's console and run (% style="color:#4f81bd" %)**logread -f**(%%). It will shows the output when there is packet arrive.User can see if it is correct.
495 +|=(((
496 +[[~[~[image:https://wiki.dragino.com/images/thumb/7/73/ThingSpeak1.png/200px-ThingSpeak1.png~|~|alt="ThingSpeak1.png" height="98" width="200"~]~]>>url:https://wiki.dragino.com/index.php/File:ThingSpeak1.png]]
550 550  
498 +=== [[ThingSpeak Server>>url:http://www.thingspeak.com/]] ===
551 551  
552 -= 6. How to ask for Support =
553 553  
501 +[[Examples>>url:https://wiki.dragino.com/index.php/ThingSpeak_Examples]]
502 +)))|=(((
503 +[[~[~[image:https://wiki.dragino.com/images/thumb/3/3b/Lewei50.png/200px-Lewei50.png~|~|alt="Lewei50.png" height="58" width="200"~]~]>>url:https://wiki.dragino.com/index.php/File:Lewei50.png]]
504 +
505 +=== [[乐联网平台>>url:https://www.lewei50.com/]] ===
506 +
507 +
508 +[[lewei Example>>url:https://wiki.dragino.com/index.php/Lewei_Example_mqtt]]
509 +)))|=(((
510 +[[~[~[image:https://wiki.dragino.com/images/thumb/a/aa/AWS-IOT.png/200px-AWS-IOT.png~|~|alt="AWS-IOT.png" height="122" width="200"~]~]>>url:https://wiki.dragino.com/index.php/File:AWS-IOT.png]]
511 +
512 +=== [[AWS-IOT>>url:https://aws.amazon.com/cn/iot-platform/how-it-works/]] ===
513 +
514 +
515 +[[AWS Examples>>url:https://wiki.dragino.com/index.php/MQTT_Forward_to_Amazon_AWS-IOT]]
516 +)))
517 +
518 += 6. How to Debug =
519 +
520 +User can login the gateway's console and run **logread -f**. It will shows the output when there is packet arrive.User can see if it is correct.
521 +
522 += 7. How to ask for Support =
523 +
554 554  If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info:
555 555  
556 556  * Detail of your LoRaWAN end node.
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
image-20220527135310-9.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -87.9 KB
Content
image-20220527135440-10.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -111.5 KB
Content
image-20220527135742-11.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -18.2 KB
Content
image-20220527135828-12.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -35.1 KB
Content
image-20220527135929-13.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -31.0 KB
Content
image-20220527140023-14.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -182.2 KB
Content
image-20220527140100-15.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -8.2 KB
Content
image-20220527140148-16.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -34.0 KB
Content
image-20220527140238-17.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -126.3 KB
Content
image-20220527140354-18.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -62.7 KB
Content
image-20220527140459-19.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -151.0 KB
Content
image-20220527140542-20.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -165.4 KB
Content
image-20220527141235-21.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -83.3 KB
Content
image-20220527141450-22.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -46.5 KB
Content
image-20220527141727-23.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -23.6 KB
Content
image-20220527141843-24.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -164.3 KB
Content
image-20220527141933-25.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -100.1 KB
Content
image-20220527142028-26.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -95.2 KB
Content
image-20220527142115-27.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -9.3 KB
Content
image-20220527142239-28.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -181.1 KB
Content
image-20220527142638-29.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -62.3 KB
Content
image-20220527142706-30.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -43.1 KB
Content
image-20220527142733-31.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -10.3 KB
Content
image-20220527142820-32.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -155.6 KB
Content