Skip to Content

Wiki source code of MQTT Forward Instruction

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