Changes for page MQTT Forward Instruction

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

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