Wiki source code of MQTT Forward Instruction

Version 37.10 by Xiaoling on 2022/06/01 10:45

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