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