Wiki source code of MQTT Forward Instruction

Version 1.14 by Xiaoling on 2022/05/12 16:14

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