Changes for page MQTT Forward Instruction

Last modified by Kilight Cao on 2024/08/31 16:26

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