Changes for page MQTT Forward Instruction

Last modified by Kilight Cao on 2024/08/31 16:26
<
From version < 1.7 >
edited by Xiaoling
on 2022/05/12 15:53
To version < 5.2 >
edited by Xiaoling
on 2022/05/27 13:41
>
Change comment: There is no comment for this version

Summary

Details

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

Applications

Navigation

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