Hide last authors
Xiaoling 44.2 1 **~ Table of Contents:**
Xiaoling 1.2 2
Xiaoling 1.4 3 {{toc/}}
Xiaoling 1.3 4
Xiaoling 1.4 5
Xiaoling 44.2 6 = 1.  Introduction =
Xiaoling 1.3 7
Xiaoling 44.2 8
Xiaoling 1.2 9 Dragino LoRa/LoRaWAN gateway support MQTT forwarding. It can forward the sensor data from LoRa network to MQTT server , and vice verse.
10
Xiaoling 3.2 11
Xiaoling 44.2 12 == 1.1  Support Devices ==
Xiaoling 1.2 13
Xiaoling 44.2 14
Xiaoling 1.2 15 This MQTT forward instruction is for below devices:
16
17 * Firmware Version > LG02_LG08-5.3.1580178039 [[Firmware Download>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]]
Xiaoling 37.6 18 * LG01N, OLG01N ((% style="color:red" %)**Warning**(%%): LG01-P LG01-S use another instruction: [[MQTT for LG01-P/LG01S>>doc:Through MQTT to upload data.WebHome]])
Xiaoling 1.2 19 * LG02, OLG02
20 * LG308, DLOS8
21 * LPS8
22 * LIG16
23 * MS14 series if installed with the same firmware. (in this case, the MQTT forward will work , but no LoRa support)
24
Xiaoling 37.7 25
Xiaoling 1.2 26
Xiaoling 44.2 27
28 = 2.  Firmware Change Log for MQTT feature =
29
30
Xiaoling 1.6 31 (((
Xiaoling 1.2 32 This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware.
Xiaoling 1.6 33 )))
Xiaoling 1.2 34
35 * LG02_LG08-5.3.1580178039
36 ** Initiate version
37
Xiaoling 37.8 38
Xiaoling 44.2 39
40
Xiaoling 44.3 41 = 3.  MQTT forward operating principle =
Xiaoling 1.2 42
43
Xiaoling 44.3 44 == 3.1  Network Structure ==
45
46
Xiaoling 1.2 47 Below shows the network structure for MQTT forwarding.
48
Xiaoling 44.4 49 * **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.
50 * **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,
Xiaoling 1.2 51
Xiaoling 3.2 52 [[image:image-20220527133547-1.png]]
Xiaoling 1.2 53
54 General MQTT structure
55
Xiaoling 1.6 56
Xiaoling 1.3 57 == 3.2 How sensor data is forwarded ==
Xiaoling 1.2 58
59 In this MQTT forward feature, the key point is how the gateway process the sensor data.
60
Xiaoling 1.6 61
Xiaoling 1.3 62 === 3.2.1 Upstream ===
Xiaoling 1.2 63
64 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.
65
Xiaoling 1.6 66 (((
Xiaoling 1.2 67 The data flow works as below diagram.
Xiaoling 1.6 68 )))
Xiaoling 1.2 69
Xiaoling 5.2 70 [[image:image-20220527134000-2.png]]
Xiaoling 1.2 71
Xiaoling 1.6 72 (((
Xiaoling 1.2 73 Upstream path
Xiaoling 1.6 74 )))
Xiaoling 1.2 75
Xiaoling 1.6 76 (((
Xiaoling 1.2 77 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 78 )))
Xiaoling 1.2 79
Xiaoling 1.6 80 (((
81
82 )))
83
Xiaoling 1.3 84 === 3.2.2 Downstream ===
Xiaoling 1.2 85
86 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.
87
Xiaoling 1.6 88 (((
Xiaoling 1.2 89 Below are the data flow for downstream.
Xiaoling 1.6 90 )))
Xiaoling 1.2 91
Xiaoling 5.2 92 [[image:image-20220527134038-3.png]]
Xiaoling 1.2 93
94 Downstream path
95
96
Xiaoling 1.3 97 == 3.3 Macro Definition ==
Xiaoling 1.2 98
99 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish.
100
Xiaoling 1.8 101 (((
Xiaoling 5.2 102 Currently the (% style="color:#4f81bd" %)**-t (topic)**(%%) and (% style="color:#4f81bd" %)**-m (message)**(%%) support Macros.
Xiaoling 5.3 103
104
Xiaoling 1.8 105 )))
Xiaoling 1.2 106
Xiaoling 1.3 107 === 3.3.1 -t topic macro ===
Xiaoling 1.2 108
109 * CHANNEL: Remote Channel ID
110 * CLIENTID: Client ID , Same as -i
111 * WRITE_API: Remote Channel Write API
112 * USERNAME: User ID (-u)
113 * HOSTNAME: Device Hostname
114
Xiaoling 1.3 115 === 3.3.2 -m message macro ===
Xiaoling 1.2 116
117 * HOSTNAME: Device Hostname
118 * CHANNEL: Remote Channel ID
119 * DATA: Sensor Data without time stamp and rssi
120 * META: Completely sensor data with time stamp and rssi
121 * JSON: Convert META to json format.
122
Xiaoling 1.3 123 === 3.3.3 Example for Macro ===
Xiaoling 1.2 124
Xiaoling 6.2 125 [[image:image-20220527134251-4.png]]
Xiaoling 1.2 126
127 MQTT Publish configure
128
Xiaoling 37.11 129
Xiaoling 1.2 130 Above screen shots shows below format:
131
132 * -t: CLIENTID/CHANNEL/data
133 * -m: DATA
134
135 When there is a LoRa sensor arrive. it will be store at the /var/iot/channels as below:
136
Xiaoling 7.2 137 [[image:image-20220527134332-5.png]]
Xiaoling 1.2 138
139 Sensor Data
140
Xiaoling 37.12 141
Xiaoling 1.8 142 (((
Xiaoling 7.3 143 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.
Xiaoling 1.8 144 )))
Xiaoling 1.2 145
146
Xiaoling 1.3 147 == 3.4 Modify the MQTT to support more options ==
Xiaoling 1.2 148
149 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:
150
Xiaoling 1.9 151 (% class="box" %)
152 (((
153 root@dragino-1ec39c:~~# mosquitto_pub ~-~-help
Xiaoling 1.2 154 mosquitto_pub is a simple mqtt client that will publish a message on a single topic and exit.
155 mosquitto_pub version 1.6.4 running on libmosquitto 1.6.4.
Xiaoling 2.2 156 \\Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL}
Xiaoling 1.2 157 {-f file | -l | -n | -m message}
Xiaoling 1.9 158 [-c] [-k keepalive] [-q qos] [-r] [~-~-repeat N] [~-~-repeat-delay time]
Xiaoling 1.2 159 [-A bind_address]
160 [-i id] [-I id_prefix]
Xiaoling 1.9 161 [-d] [~-~-quiet]
Xiaoling 1.2 162 [-M max_inflight]
163 [-u username [-P password]]
Xiaoling 1.9 164 [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]]
165 [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file]
166 [~-~-ciphers ciphers] [~-~-insecure]
167 [~-~-tls-alpn protocol]
168 [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]
169 [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]]
170 [~-~-proxy socks-url]
171 [~-~-property command identifier value]
Xiaoling 1.2 172 [-D command identifier value]
Xiaoling 1.9 173 mosquitto_pub ~-~-help
Xiaoling 2.2 174 \\-A : bind the outgoing socket to this host/ip address. Use to control which interface
Xiaoling 1.2 175 the client communicates over.
Xiaoling 1.9 176 -d : enable debug messages.
177 -D : Define MQTT v5 properties. See the documentation for more details.
178 -f : send the contents of a file as the message.
179 -h : mqtt host to connect to. Defaults to localhost.
180 -i : id to use for this client. Defaults to mosquitto_pub_ appended with the process id.
181 -I : define the client id as id_prefix appended with the process id. Useful for when the
Xiaoling 1.2 182 broker is using the clientid_prefixes option.
Xiaoling 1.9 183 -k : keep alive in seconds for this client. Defaults to 60.
184 -L : specify user, password, hostname, port and topic as a URL in the form:
185 mqtt(s):~/~/[username[:password]@]host[:port]/topic
186 -l : read messages from stdin, sending a separate message for each line.
187 -m : message payload to send.
188 -M : the maximum inflight messages for QoS 1/2..
189 -n : send a null (zero length) message.
190 -p : network port to connect to. Defaults to 1883 for plain MQTT and 8883 for MQTT over TLS.
191 -P : provide a password
192 -q : quality of service level to use for all messages. Defaults to 0.
193 -r : message should be retained.
194 -s : read message from stdin, sending the entire input as a message.
195 -t : mqtt topic to publish to.
196 -u : provide a username
197 -V : specify the version of the MQTT protocol to use when connecting.
Xiaoling 1.2 198 Can be mqttv5, mqttv311 or mqttv31. Defaults to mqttv311.
Xiaoling 1.9 199 ~-~-help : display this message.
200 ~-~-repeat : if publish mode is -f, -m, or -s, then repeat the publish N times.
201 ~-~-repeat-delay : if using ~-~-repeat, wait time seconds between publishes. Defaults to 0.
Xiaoling 7.4 202 ~-~-quiet : (% style="color:red" %)don't print error messages.
Xiaoling 1.9 203 ~-~-will-payload : payload for the client Will, which is sent by the broker in case of
Xiaoling 1.2 204 unexpected disconnection. If not given and will-topic is set, a zero
205 length message will be sent.
Xiaoling 1.9 206 ~-~-will-qos : QoS level for the client Will.
207 ~-~-will-retain : if given, make the client Will retained.
208 ~-~-will-topic : the topic on which to publish the client Will.
209 ~-~-cafile : path to a file containing trusted CA certificates to enable encrypted
Xiaoling 1.2 210 communication.
Xiaoling 1.9 211 ~-~-capath : path to a directory containing trusted CA certificates to enable encrypted
Xiaoling 1.2 212 communication.
Xiaoling 1.9 213 ~-~-cert : client certificate for authentication, if required by server.
214 ~-~-key : client private key for authentication, if required by server.
215 ~-~-keyform : keyfile type, can be either "pem" or "engine".
216 ~-~-ciphers : openssl compatible list of TLS ciphers to support.
217 ~-~-tls-version : TLS protocol version, can be one of tlsv1.3 tlsv1.2 or tlsv1.1.
Xiaoling 1.2 218 Defaults to tlsv1.2 if available.
Xiaoling 1.9 219 ~-~-insecure : do not check that the server certificate hostname matches the remote
Xiaoling 1.2 220 hostname. Using this option means that you cannot be sure that the
221 remote host is the server you wish to connect to and so is insecure.
222 Do not use this option in a production environment.
Xiaoling 1.9 223 ~-~-tls-engine : If set, enables the use of a TLS engine device.
224 ~-~-tls-engine-kpass-sha1 : SHA1 of the key password to be used with the selected SSL engine.
225 ~-~-psk : pre-shared-key in hexadecimal (no leading 0x) to enable TLS-PSK mode.
226 ~-~-psk-identity : client identity string for TLS-PSK mode.
227 ~-~-proxy : SOCKS5 proxy URL of the form:
228 socks5h:~/~/[username[:password]@]hostname[:port]
Xiaoling 1.2 229 Only "none" and "username" authentication is supported.
Xiaoling 2.2 230 \\See https:~/~/mosquitto.org/ for more information.
Xiaoling 1.9 231 )))
Xiaoling 1.2 232
233
Xiaoling 1.13 234 (((
Xiaoling 1.2 235 and modify the /usr/bin/mqtt_process.sh script, the location to change the command option is below lines:
Xiaoling 1.13 236 )))
Xiaoling 1.2 237
Xiaoling 1.9 238 (% class="box" %)
239 (((
Xiaoling 7.5 240 //# Call MQTT Publish command
Xiaoling 2.2 241 \\# 1. Case with User, Password and Client ID present  (e.g. Azure)
Xiaoling 1.2 242 if [ ! -z "$pass" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then
Xiaoling 1.9 243 case="1" 
244 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"
Xiaoling 2.2 245 \\# 2. Case with Certificate, Key and ClientID present (e.g. AWS)
Xiaoling 1.2 246 elif [ ! -z "$certfile" ] && [ ! -z "$key" ] && [ ! -z "$clientID" ]; then
Xiaoling 1.9 247 case="2" 
248 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"
Xiaoling 2.2 249 \\# 3. Case with no User, Certificate or ClientID present
Xiaoling 1.2 250 elif [ -z "$user" ] && [ -z "$certfile" ] && [ -z "$clientID" ]; then
Xiaoling 1.9 251 case="3" 
252 mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data"
Xiaoling 2.2 253 \\# 4. Case with no User, Certificate, but with ClientID present
Xiaoling 1.2 254 elif [ -z "$user" ] && [ -z "$certfile" ] && [ ! -z "$clientID" ]; then
Xiaoling 1.9 255 case="4" 
256 mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data"
Xiaoling 2.2 257 \\# 5. Case with User and ClientID present, but no Password and no Certificate present
Xiaoling 1.2 258 elif [ -z "$pass" ] && [ -z "$certfile" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then
Xiaoling 1.9 259 case="5" 
260 mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user $PUB_FLAG "$mqtt_data"
Xiaoling 2.2 261 \\# 6. Case with User and Password present, but no ClientID and no Certificate present
Xiaoling 1.2 262 elif [ ! -z "$user" ] && [ ! -z "$pass" ] && [ -z "$clientID" ] && [ -z "$certfile" ]; then
Xiaoling 1.9 263 case="6" 
264 mosquitto_pub $D -h $server -p $port -q $pub_qos  -t $pub_topic -u $user -P "$pass" $PUB_FLAG "$mqtt_data"
Xiaoling 2.2 265 \\# 0. Else - invalid parameters, just log
Xiaoling 1.2 266 else
Xiaoling 7.7 267 case="(% style="color:red" %)Invalid parameters" (%%)
Xiaoling 7.6 268 logger (% style="color:red" %)"[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."(%%)
Xiaoling 7.5 269 fi//
Xiaoling 1.9 270 )))
Xiaoling 1.2 271
272
Xiaoling 1.3 273 = 4. Example to communicate to a simple MQTT server =
Xiaoling 1.2 274
Xiaoling 1.3 275 == 4.1 Overview ==
Xiaoling 1.2 276
277 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/]].
278
Xiaoling 8.2 279
Xiaoling 1.3 280 == 4.2 Simulate via MQTT.fx utility ==
Xiaoling 1.2 281
282 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.
283
Xiaoling 1.14 284 (((
Xiaoling 1.2 285 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 286 )))
Xiaoling 1.2 287
Xiaoling 8.2 288 [[image:image-20220527134929-6.png]]
Xiaoling 1.2 289
290 Connect to MQTT Broker
291
Xiaoling 9.2 292
Xiaoling 1.2 293 After connected, use publish to public some thing to MQTT server. This to simulate upsteam
294
Xiaoling 9.2 295 [[image:image-20220527135037-7.png]]
Xiaoling 1.2 296
297 Upstream: Publish message to MQTT Broker
298
Xiaoling 9.2 299
Xiaoling 1.2 300 To simulate a downstream, use MQTT.fx to subscribe a topic, and publish something to this topic. as Below:
301
Xiaoling 10.2 302 [[image:image-20220527135215-8.png]]
Xiaoling 1.2 303
304 Downstream: Subscribe a topic to get downstream
305
306
Xiaoling 1.3 307 == 4.3 Simulate via Dragino Command Line ==
Xiaoling 1.2 308
309 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.
310
311 In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection.
312
313
Xiaoling 11.2 314 (% style="color:#4f81bd" %)**For Upstream**
Xiaoling 1.2 315
316 command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]]
317
318 Example: mosquitto_pub -h 192.168.199.148 -p 1883 -t /channel/6543 -m temp=36
319
320 Note: 192.168.199.148 is MQTT broker address, the gateway and the MQTT broker PC are in the same network.
321
Xiaoling 11.2 322 [[image:image-20220527135310-9.png]]
Xiaoling 1.2 323
324 mosquitto_pub
325
326
Xiaoling 12.2 327 (% style="color:#4f81bd" %)**For Downstream**
Xiaoling 1.2 328
329 Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic.
330
Xiaoling 12.2 331 [[image:image-20220527135440-10.png]]
Xiaoling 1.2 332
333 mosquitto_sub
334
Xiaoling 1.10 335
Xiaoling 1.3 336 == 4.4 Configure Dragino UI for MQTT connection ==
Xiaoling 1.2 337
338 This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection.
339
Xiaoling 1.16 340 (((
Xiaoling 12.3 341 Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client**
Xiaoling 1.16 342 )))
Xiaoling 1.2 343
Xiaoling 1.10 344 [[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 345
346 go to mqtt configure menu
347
Xiaoling 37.13 348
Xiaoling 1.17 349 (((
Xiaoling 12.3 350 Select (% style="color:#4f81bd" %)**Forward to MQTT server**. (% style="color:red" %)**Notice**(%%): This option is removed from the latest firmware, in the latest firmware, if user submit "SAVE & APPLY" in MQTT page, the gateway will use MQTT service.
Xiaoling 1.17 351 )))
Xiaoling 1.2 352
Xiaoling 13.2 353 [[image:image-20220527135742-11.png]]
Xiaoling 1.2 354
355 forward to MQTT
356
Xiaoling 1.10 357
Xiaoling 1.3 358 === 4.4.1 Configure the MQTT Client for Upstream ===
Xiaoling 1.2 359
360 Below screenshot is same as the publish command:
361
Xiaoling 1.17 362 (% class="box" %)
363 (((
364 mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA
365 ~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for
366 ~/~/CLIENTID: dragino-1b7060
367 ~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456
368 ~/~/DATA: The data stores in /var/iot/channels/
369 )))
Xiaoling 1.2 370
Xiaoling 14.2 371 [[image:image-20220527135828-12.png]]
Xiaoling 1.2 372
373 MQTT Publish configure
374
Xiaoling 1.18 375
Xiaoling 15.2 376 [[image:image-20220527135929-13.png]]
Xiaoling 1.2 377
378 MQTT Channel settings
379
Xiaoling 16.2 380
Xiaoling 1.18 381 (((
Xiaoling 1.2 382 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:
Xiaoling 1.18 383 )))
Xiaoling 1.2 384
Xiaoling 1.18 385 (% class="box" %)
386 (((
387 mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t dragino-1b7060/78901/data -m temp=46
388 )))
Xiaoling 1.2 389
Xiaoling 1.18 390 (((
Xiaoling 1.2 391 to MQTT broker.
Xiaoling 1.18 392 )))
Xiaoling 1.2 393
394
395 (((
396 Below is a simulation to put this data to active the MQTT publish.
397 )))
398
Xiaoling 16.2 399 [[image:image-20220527140023-14.png]]
Xiaoling 1.2 400
401 MQTT Publish
402
403
Xiaoling 1.3 404 === 4.4.2 Configure the MQTT Client for Downstream ===
Xiaoling 1.2 405
406 Below screen shot equal to this subscribe command:
407
Xiaoling 1.19 408 (% class="box" %)
409 (((
410 mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command.
411 )))
Xiaoling 1.2 412
Xiaoling 17.2 413 [[image:image-20220527140100-15.png]]
Xiaoling 1.2 414
415 MQTT Subscribe
416
417
Xiaoling 1.19 418 (((
Xiaoling 1.2 419 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:
Xiaoling 1.19 420 )))
Xiaoling 1.2 421
Xiaoling 18.2 422 [[image:image-20220527140148-16.png]]
Xiaoling 1.2 423
424 LoRa Broadcast parameters.
425
426
427 And below is the subscribe simulation:
428
Xiaoling 19.2 429 [[image:image-20220527140238-17.png]]
Xiaoling 1.2 430
431 downstream simulation
432
433
Xiaoling 1.3 434 == 4.5 Add LoRa support to communicate with remote sensor ==
Xiaoling 1.2 435
436 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.
437
Xiaoling 19.3 438
Xiaoling 1.3 439 === 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
Xiaoling 1.2 440
441 (((
442 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.
443 )))
444
445 (((
446 The example Sketch for LoRa Shield +Arduino is here: [[LoRa_Shield_Sketch_For_MQTT>>url:http://www.dragino.com/downloads/index.php?dir=LoraShield/]]
447 )))
448
449 (((
450 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.
451 )))
452
453 (((
454 What does the Arduino Sketch do? The Arduino Sketch will:
455 )))
456
457 * 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).
458 * Downstream: Listening broadcast message from gateway, and print it in console.
459 * The LoRa parameter settings in Arduino should match the LoRa settings in gateway, as below:
460
Xiaoling 21.2 461 [[image:image-20220527140354-18.png]]
Xiaoling 1.2 462
463 LoRa Parameter should match
464
465
Xiaoling 37.14 466
Xiaoling 1.2 467 Below is the test result after the Arduino Sketch is running.
468
Xiaoling 21.2 469 [[image:image-20220527140459-19.png]]
Xiaoling 1.2 470
471 Upstream Data Flow
472
Xiaoling 21.2 473
Xiaoling 37.14 474
Xiaoling 22.2 475 [[image:image-20220527140542-20.png]]
Xiaoling 1.2 476
477 Downstream Data Flow
478
479
Xiaoling 1.3 480 === 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
Xiaoling 1.2 481
482 (((
Xiaoling 23.2 483 Since firmware (% style="color:#4f81bd" %)**LG02_LG08~-~-build-v5.3.1585192026-20200326-1109,**(%%) Dragino LoRaWAN gateways support the communication to LoRaWAN (% style="color:#4f81bd" %)**ABP end node**(%%) locally without the need of LoRaWAN server. This feature allow us to integrate MQTT in the gateway to support LoRaWAN to MQTT forwarding or visa verse.
Xiaoling 1.20 484 )))
485
486 (((
Xiaoling 23.2 487 When use test this feature, please use the version higher then : (% style="color:#4f81bd" %)**LG02_LG08~-~-build-v5.4.1593400722-20200629-1120**(%%), in this version, the upload format is changed and readable, which is easier for integration.
488 (% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
Xiaoling 1.20 489 )))
490
491 (((
Xiaoling 36.4 492 (% style="color:#4f81bd" %)**Step 1**(%%): Refer [[Communicate with ABP End Node>>Communicate with ABP End Node without LoRaWAN Network Server --- LG308]] to know how to set up LG308 to work with LoRaWAN End node.
Xiaoling 1.20 493 )))
494
495 (((
Xiaoling 23.2 496 (% style="color:#4f81bd" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
Xiaoling 1.20 497 )))
498
Xiaoling 23.2 499 [[image:image-20220527141235-21.png]]
Xiaoling 1.2 500
501 Use Same Frequency Band as End Node
502
503
504 (((
Xiaoling 2.5 505 (((
Kilight Cao 44.1 506 (% style="color:#4f81bd" %)**Step 3**(%%): Set up publish format and MQTT channel. The LG308 will store the Data from End node in (% style="color:#4f81bd" %)**HEX format**(%%) in the file.
Xiaoling 1.20 507 )))
Xiaoling 2.5 508 )))
Xiaoling 1.2 509
Kilight Cao 44.1 510 [[image:image-20220613191345-4.png]]
Xiaoling 1.2 511
512
513
Xiaoling 23.2 514 (% style="color:#4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
Xiaoling 1.2 515
Kilight Cao 44.1 516 [[image:image-20220613190635-2.png]]
Xiaoling 1.2 517
518
519
Xiaoling 23.2 520 (% style="color:#4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
Xiaoling 1.2 521
Xiaoling 26.2 522 [[image:image-20220527141843-24.png]]
Xiaoling 1.2 523
524
Xiaoling 26.2 525
Xiaoling 37.16 526
Xiaoling 28.2 527 [[image:image-20220527141933-25.png]]
Xiaoling 1.2 528
529 Choose ASCII Format
530
531
Xiaoling 37.15 532
Xiaoling 28.2 533 [[image:image-20220527142028-26.png]]
534
Xiaoling 1.2 535 LHT65 Decoder
536
537
Xiaoling 37.17 538
Xiaoling 23.2 539 (% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
Xiaoling 2.3 540
Kilight Cao 44.1 541 [[image:image-20220613191426-5.png]]
Xiaoling 1.2 542
543
544
Xiaoling 29.2 545 (% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
Xiaoling 1.2 546
Xiaoling 30.2 547 [[image:image-20220527142239-28.png]]
Xiaoling 1.2 548
549
Kilight Cao 44.1 550
551 === MQTT Downstream format ===
552
553
554 mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**"
555
556 (% class="box infomessage" %)
557 (((
558 mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"
559 )))
560
561 mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**"
562
563 (% class="box infomessage" %)
564 (((
565 mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello,20,1,SF12,923300000,2 > /var/iot/push/test"
566 )))
567
568 Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]]
569
570 [[image:image-20220613192816-6.png||height="440" width="1056"]]
571
Xiaoling 36.5 572 (% style="color:red" %)**Notice: The text use for Downstream must meet the requirement from [[LG308 Downstream Payload>>Communicate with ABP End Node without LoRaWAN Network Server --- LG308||anchor="H2.2Downstream"]]**
Xiaoling 1.2 573
Kilight Cao 44.1 574 Check out this link for more mosquito-related directives [[https:~~/~~/mosquitto.org/man/mosquitto_pub-1.html>>https://mosquitto.org/man/mosquitto_pub-1.html]]
Xiaoling 1.2 575
Edwin Chen 36.1 576 = 5. How to Debug =
Xiaoling 1.2 577
Xiaoling 34.2 578 User can login the gateway's console and run (% style="color:#4f81bd" %)**logread -f**(%%). It will shows the output when there is packet arrive.User can see if it is correct.
Xiaoling 1.2 579
Xiaoling 30.3 580
Edwin Chen 36.1 581 = 6. How to ask for Support =
Xiaoling 1.2 582
583 If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info:
584
585 * Detail of your LoRaWAN end node.
586 * Gateway Model and firmware version
587 * A set of screenshots you configure in the gateway according to our instruction
588 * A full log of "logread -f"
Copyright ©2010-2024 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0