Wiki source code of MQTT Forward Instruction

Version 49.2 by Xiaoling on 2022/08/09 16:18

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