Wiki source code of MQTT Forward Instruction

Version 47.1 by Xiaoling on 2022/07/14 16:22

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