Skip to Content

Changes for page MQTT Forward Instruction

Last modified by Xiaoling on 2025/07/31 16:59
From version 1.3
edited by Xiaoling
on 2022/05/12 15:46
Change comment: There is no comment for this version
To version 53.1
edited by Kilight Cao
on 2024/08/31 16:00
Change comment: Uploaded new attachment "image-20240831160038-1.png", version {1}

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Xiaoling
1 +XWiki.Kilight
Content
... ... @@ -1,395 +1,102 @@
1 -
1 +**~ Table of Contents：**
2 2  
3 +{{toc/}}
3 3  
4 -= 1. Introduction =
5 5  
6 += 1.  Introduction =
7 +
8 +
6 6  Dragino LoRa/LoRaWAN gateway support MQTT forwarding. It can forward the sensor data from LoRa network to MQTT server , and vice verse.
7 7  
8 -== 1.1 Support Devices ==
9 9  
12 +== 1.1  Support Devices ==
13 +
14 +
10 10  This MQTT forward instruction is for below devices:
11 11  
12 -* Firmware Version > LG02_LG08-5.3.1580178039 [[Firmware Download>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]]
13 -* LG01N, OLG01N (Warning: LG01-P LG01-S use another instruction: [[MQTT for LG01-P/LG01S>>url:https://wiki.dragino.com/index.php/Through_MQTT_to_upload_data]])
17 +* LG01N, OLG01N ((% style="color:red" %)**Warning**(%%): LG01-P LG01-S use another instruction: [[MQTT for LG01-P/LG01S>>doc:Main.Through MQTT to upload data.WebHome]])
14 14  * LG02, OLG02
15 -* LG308, DLOS8
16 -* LPS8
17 -* LIG16
19 +* LG308, DLOS8, LPS8, LIG16
18 18  * MS14 series if installed with the same firmware. (in this case, the MQTT forward will work , but no LoRa support)
21 +* LG308N, DLOS8N, LPS8N
22 +* LPS8V2
19 19  
20 20  
21 -= 2. Firmware Change Log for MQTT feature =
25 +The MQTT Client Utility used in Dragino is **mosquitto_pub** and **mosquitto_sub**. User can add more options to the mqtt commands.
22 22  
23 -This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware.
27 +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]]**
24 24  
25 -* LG02_LG08-5.3.1580178039
26 -** Initiate version
27 27  
30 += 2.  Example to communicate to a simple MQTT server =
28 28  
29 -= 3. MQTT forward operating principle =
32 +== 2.1  Overview ==
30 30  
31 -== 3.1 Network Structure ==
32 32  
33 -Below shows the network structure for MQTT forwarding.
35 +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/]].
34 34  
35 -* 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.
36 -* 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,
37 37  
38 -[[~[~[image:https://wiki.dragino.com/images/thumb/4/45/MQTT_Forward_1.png/600px-MQTT_Forward_1.png~|~|height="348" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_1.png]]
38 +== 2.2  Simulate via MQTT.fx utility ==
39 39  
40 -General MQTT structure
41 41  
42 -== 3.2 How sensor data is forwarded ==
43 -
44 -In this MQTT forward feature, the key point is how the gateway process the sensor data.
45 -
46 -=== 3.2.1 Upstream ===
47 -
48 -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.
49 -
50 -The data flow works as below diagram.
51 -
52 -[[~[~[image:https://wiki.dragino.com/images/thumb/2/2a/MQTT_Forward_2.png/600px-MQTT_Forward_2.png~|~|height="355" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_2.png]]
53 -
54 -Upstream path
55 -
56 -Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span>
57 -
58 -=== 3.2.2 Downstream ===
59 -
60 -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.
61 -
62 -Below are the data flow for downstream.
63 -
64 -[[~[~[image:https://wiki.dragino.com/images/thumb/3/3a/MQTT_Forward_3.png/600px-MQTT_Forward_3.png~|~|height="368" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_3.png]]
65 -
66 -Downstream path
67 -
68 -
69 -== 3.3 Macro Definition ==
70 -
71 -The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish.
72 -
73 -Currently the -t (topic) and -m (message) support Macros.
74 -
75 -=== 3.3.1 -t topic macro ===
76 -
77 -* CHANNEL: Remote Channel ID
78 -* CLIENTID: Client ID , Same as -i
79 -* WRITE_API: Remote Channel Write API
80 -* USERNAME: User ID (-u)
81 -* HOSTNAME: Device Hostname
82 -
83 -=== 3.3.2 -m message macro ===
84 -
85 -* HOSTNAME: Device Hostname
86 -* CHANNEL: Remote Channel ID
87 -* DATA: Sensor Data without time stamp and rssi
88 -* META: Completely sensor data with time stamp and rssi
89 -* JSON: Convert META to json format.
90 -
91 -=== 3.3.3 Example for Macro ===
92 -
93 -[[~[~[image:https://wiki.dragino.com/images/thumb/c/c7/MQTT_Command_9.png/600px-MQTT_Command_9.png~|~|height="385" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_9.png]]
94 -
95 -MQTT Publish configure
96 -
97 -Above screen shots shows below format:
98 -
99 -* -t: CLIENTID/CHANNEL/data
100 -* -m: DATA
101 -
102 -When there is a LoRa sensor arrive. it will be store at the /var/iot/channels as below:
103 -
104 -[[~[~[image:https://wiki.dragino.com/images/thumb/c/c4/MQTT_Command_20.png/600px-MQTT_Command_20.png~|~|height="325" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_20.png]]
105 -
106 -Sensor Data
107 -
108 -According to above macro. Gateway will publish field1=22.0&field2=49.0 to topic: dragino-1b7060/78901/data, where 78901 is the remote channel for this node ID.
109 -
110 -
111 -== 3.4 Modify the MQTT to support more options ==
112 -
113 -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:
114 -
115 -{{{root@dragino-1ec39c:~# mosquitto_pub --help
116 -mosquitto_pub is a simple mqtt client that will publish a message on a single topic and exit.
117 -mosquitto_pub version 1.6.4 running on libmosquitto 1.6.4.
118 - 
119 -Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL}
120 - {-f file | -l | -n | -m message}
121 - [-c] [-k keepalive] [-q qos] [-r] [--repeat N] [--repeat-delay time]
122 - [-A bind_address]
123 - [-i id] [-I id_prefix]
124 - [-d] [--quiet]
125 - [-M max_inflight]
126 - [-u username [-P password]]
127 - [--will-topic [--will-payload payload] [--will-qos qos] [--will-retain]]
128 - [{--cafile file | --capath dir} [--cert file] [--key file]
129 - [--ciphers ciphers] [--insecure]
130 - [--tls-alpn protocol]
131 - [--tls-engine engine] [--keyform keyform] [--tls-engine-kpass-sha1]]
132 - [--psk hex-key --psk-identity identity [--ciphers ciphers]]
133 - [--proxy socks-url]
134 - [--property command identifier value]
135 - [-D command identifier value]
136 - mosquitto_pub --help
137 - 
138 - -A : bind the outgoing socket to this host/ip address. Use to control which interface
139 - the client communicates over.
140 - -d : enable debug messages.
141 - -D : Define MQTT v5 properties. See the documentation for more details.
142 - -f : send the contents of a file as the message.
143 - -h : mqtt host to connect to. Defaults to localhost.
144 - -i : id to use for this client. Defaults to mosquitto_pub_ appended with the process id.
145 - -I : define the client id as id_prefix appended with the process id. Useful for when the
146 - broker is using the clientid_prefixes option.
147 - -k : keep alive in seconds for this client. Defaults to 60.
148 - -L : specify user, password, hostname, port and topic as a URL in the form:
149 - mqtt(s)://[username[:password]@]host[:port]/topic
150 - -l : read messages from stdin, sending a separate message for each line.
151 - -m : message payload to send.
152 - -M : the maximum inflight messages for QoS 1/2..
153 - -n : send a null (zero length) message.
154 - -p : network port to connect to. Defaults to 1883 for plain MQTT and 8883 for MQTT over TLS.
155 - -P : provide a password
156 - -q : quality of service level to use for all messages. Defaults to 0.
157 - -r : message should be retained.
158 - -s : read message from stdin, sending the entire input as a message.
159 - -t : mqtt topic to publish to.
160 - -u : provide a username
161 - -V : specify the version of the MQTT protocol to use when connecting.
162 - Can be mqttv5, mqttv311 or mqttv31. Defaults to mqttv311.
163 - --help : display this message.
164 - --repeat : if publish mode is -f, -m, or -s, then repeat the publish N times.
165 - --repeat-delay : if using --repeat, wait time seconds between publishes. Defaults to 0.
166 - --quiet : don't print error messages.
167 - --will-payload : payload for the client Will, which is sent by the broker in case of
168 - unexpected disconnection. If not given and will-topic is set, a zero
169 - length message will be sent.
170 - --will-qos : QoS level for the client Will.
171 - --will-retain : if given, make the client Will retained.
172 - --will-topic : the topic on which to publish the client Will.
173 - --cafile : path to a file containing trusted CA certificates to enable encrypted
174 - communication.
175 - --capath : path to a directory containing trusted CA certificates to enable encrypted
176 - communication.
177 - --cert : client certificate for authentication, if required by server.
178 - --key : client private key for authentication, if required by server.
179 - --keyform : keyfile type, can be either "pem" or "engine".
180 - --ciphers : openssl compatible list of TLS ciphers to support.
181 - --tls-version : TLS protocol version, can be one of tlsv1.3 tlsv1.2 or tlsv1.1.
182 - Defaults to tlsv1.2 if available.
183 - --insecure : do not check that the server certificate hostname matches the remote
184 - hostname. Using this option means that you cannot be sure that the
185 - remote host is the server you wish to connect to and so is insecure.
186 - Do not use this option in a production environment.
187 - --tls-engine : If set, enables the use of a TLS engine device.
188 - --tls-engine-kpass-sha1 : SHA1 of the key password to be used with the selected SSL engine.
189 - --psk : pre-shared-key in hexadecimal (no leading 0x) to enable TLS-PSK mode.
190 - --psk-identity : client identity string for TLS-PSK mode.
191 - --proxy : SOCKS5 proxy URL of the form:
192 - socks5h://[username[:password]@]hostname[:port]
193 - Only "none" and "username" authentication is supported.
194 - 
195 -See https://mosquitto.org/ for more information.}}}
196 -
197 -
198 -and modify the /usr/bin/mqtt_process.sh script, the location to change the command option is below lines:
199 -
200 -{{{# Call MQTT Publish command
201 - 
202 -# 1. Case with User, Password and Client ID present (e.g. Azure)
203 -if [ ! -z "$pass" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then
204 - case="1"
205 - 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"
206 - 
207 -# 2. Case with Certificate, Key and ClientID present (e.g. AWS)
208 -elif [ ! -z "$certfile" ] && [ ! -z "$key" ] && [ ! -z "$clientID" ]; then
209 - case="2"
210 - 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"
211 - 
212 -# 3. Case with no User, Certificate or ClientID present
213 -elif [ -z "$user" ] && [ -z "$certfile" ] && [ -z "$clientID" ]; then
214 - case="3"
215 - mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data"
216 - 
217 -# 4. Case with no User, Certificate, but with ClientID present
218 -elif [ -z "$user" ] && [ -z "$certfile" ] && [ ! -z "$clientID" ]; then
219 - case="4"
220 - mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data"
221 - 
222 -# 5. Case with User and ClientID present, but no Password and no Certificate present
223 -elif [ -z "$pass" ] && [ -z "$certfile" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then
224 - case="5"
225 - mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user $PUB_FLAG "$mqtt_data"
226 - 
227 -# 6. Case with User and Password present, but no ClientID and no Certificate present
228 -elif [ ! -z "$user" ] && [ ! -z "$pass" ] && [ -z "$clientID" ] && [ -z "$certfile" ]; then
229 - case="6"
230 - mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic -u $user -P "$pass" $PUB_FLAG "$mqtt_data"
231 - 
232 -# 0. Else - invalid parameters, just log
233 -else
234 - case="Invalid parameters"
235 - logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."
236 -fi}}}
237 -
238 -
239 -= 4. Example to communicate to a simple MQTT server =
240 -
241 -== 4.1 Overview ==
242 -
243 -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/]].
244 -
245 -== 4.2 Simulate via MQTT.fx utility ==
246 -
247 247  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.
248 248  
43 +(((
249 249  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.
45 +)))
250 250  
251 -[[~[~[image:https://wiki.dragino.com/images/thumb/0/06/MQTT_Forward_4.png/600px-MQTT_Forward_4.png~|~|height="201" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_4.png]]
47 +[[image:image-20220527134929-6.png]]
252 252  
253 253  Connect to MQTT Broker
254 254  
51 +
255 255  After connected, use publish to public some thing to MQTT server. This to simulate upsteam
256 256  
257 -[[~[~[image:https://wiki.dragino.com/images/thumb/b/bd/MQTT_Forward_5.png/600px-MQTT_Forward_5.png~|~|height="149" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_5.png]]
54 +[[image:image-20220527135037-7.png]]
258 258  
259 259  Upstream: Publish message to MQTT Broker
260 260  
58 +
261 261  To simulate a downstream, use MQTT.fx to subscribe a topic, and publish something to this topic. as Below:
262 262  
263 -[[~[~[image:https://wiki.dragino.com/images/thumb/3/3d/MQTT_Forward_6.png/600px-MQTT_Forward_6.png~|~|height="279" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_6.png]]
61 +[[image:image-20220527135215-8.png]]
264 264  
265 265  Downstream: Subscribe a topic to get downstream
266 266  
267 267  
268 -== 4.3 Simulate via Dragino Command Line ==
269 269  
270 -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.
67 += 3. Add LoRa support to communicate with remote sensor =
271 271  
272 -In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection.
273 273  
70 +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.
274 274  
275 -For Upstream
276 276  
277 -command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]]
278 278  
279 -Example: mosquitto_pub -h 192.168.199.148 -p 1883 -t /channel/6543 -m temp=36
74 +== 3.1  Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ==
280 280  
281 -Note: 192.168.199.148 is MQTT broker address, the gateway and the MQTT broker PC are in the same network.
282 282  
283 -[[~[~[image:https://wiki.dragino.com/images/thumb/d/d0/MQTT_Command_6.png/600px-MQTT_Command_6.png~|~|height="188" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_6.png]]
77 +(((
78 +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.
79 +)))
284 284  
285 -mosquitto_pub
81 +(((
82 +The example Sketch for LoRa Shield +Arduino is here: **[[LoRa_Shield_Sketch_For_MQTT>>url:http://www.dragino.com/downloads/index.php?dir=LoraShield/]]**
83 +)))
286 286  
85 +(((
86 +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.
287 287  
288 -For Downstream
88 +
89 +)))
289 289  
290 -Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic.
291 -
292 -[[~[~[image:https://wiki.dragino.com/images/thumb/8/89/MQTT_Command_7.png/600px-MQTT_Command_7.png~|~|height="267" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_7.png]]
293 -
294 -mosquitto_sub
295 -
296 -== 4.4 Configure Dragino UI for MQTT connection ==
297 -
298 -This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection.
299 -
300 -Go to Dragino Menu ~-~-> MQTT Client
301 -
302 -[[~[~[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png~|~|height="249" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_8.png]]
303 -
304 -go to mqtt configure menu
305 -
306 -Select Forward to MQTT server. 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.
307 -
308 -[[~[~[image:https://wiki.dragino.com/images/thumb/1/14/MQTT_Commands_8.png/600px-MQTT_Commands_8.png~|~|height="240" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Commands_8.png]]
309 -
310 -forward to MQTT
311 -
312 -=== 4.4.1 Configure the MQTT Client for Upstream ===
313 -
314 -Below screenshot is same as the publish command:
315 -
316 -{{{mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA
317 -//where the CLIENTID, CHANNEL & DATA are macro. represent for
318 -//CLIENTID: dragino-1b7060
319 -//CHANNEL: Remote ID in Channel settings; here is 78901 or 567456
320 -//DATA: The data stores in /var/iot/channels/
321 -}}}
322 -
323 -[[~[~[image:https://wiki.dragino.com/images/thumb/c/c7/MQTT_Command_9.png/600px-MQTT_Command_9.png~|~|height="385" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_9.png]]
324 -
325 -MQTT Publish configure
326 -
327 -[[~[~[image:https://wiki.dragino.com/images/thumb/b/b7/MQTT_Command_10.png/600px-MQTT_Command_10.png~|~|height="544" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_10.png]]
328 -
329 -MQTT Channel settings
330 -
331 -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:
332 -
333 -{{{mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t dragino-1b7060/78901/data -m temp=46
334 -}}}
335 -
336 -to MQTT broker.
337 -
338 -
339 -Below is a simulation to put this data to active the MQTT publish.
340 -
341 -[[~[~[image:https://wiki.dragino.com/images/thumb/3/30/MQTT_Command_11.png/600px-MQTT_Command_11.png~|~|height="308" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_11.png]]
342 -
343 -MQTT Publish
344 -
345 -
346 -=== 4.4.2 Configure the MQTT Client for Downstream ===
347 -
348 -Below screen shot equal to this subscribe command:
349 -
350 -{{{ mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command.
351 -}}}
352 -
353 -[[~[~[image:https://wiki.dragino.com/images/3/36/MQTT_Command_12.png~|~|height="173" width="579"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_12.png]]
354 -
355 -MQTT Subscribe
356 -
357 -
358 -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:
359 -
360 -[[~[~[image:https://wiki.dragino.com/images/thumb/b/b8/MQTT_Command_13.png/600px-MQTT_Command_13.png~|~|height="300" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_13.png]]
361 -
362 -LoRa Broadcast parameters.
363 -
364 -
365 -And below is the subscribe simulation:
366 -
367 -[[~[~[image:https://wiki.dragino.com/images/thumb/6/60/MQTT_Command_14.png/600px-MQTT_Command_14.png~|~|height="255" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_14.png]]
368 -
369 -downstream simulation
370 -
371 -
372 -\\
373 -
374 -== 4.5 Add LoRa support to communicate with remote sensor ==
375 -
376 -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.
377 -
378 -=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
379 -
380 -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.
381 -
382 -The example Sketch for LoRa Shield +Arduino is here: [[LoRa_Shield_Sketch_For_MQTT>>url:http://www.dragino.com/downloads/index.php?dir=LoraShield/]]
383 -
384 -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.
385 -
91 +(((
386 386  What does the Arduino Sketch do? The Arduino Sketch will:
93 +)))
387 387  
388 388  * 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).
389 389  * Downstream: Listening broadcast message from gateway, and print it in console.
390 390  * The LoRa parameter settings in Arduino should match the LoRa settings in gateway, as below:
391 391  
392 -[[~[~[image:https://wiki.dragino.com/images/thumb/3/3b/MQTT_Command_17.png/600px-MQTT_Command_17.png~|~|height="197" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_17.png]]
99 +[[image:image-20220527140354-18.png]]
393 393  
394 394  LoRa Parameter should match
395 395  
... ... @@ -396,110 +396,112 @@
396 396  
397 397  Below is the test result after the Arduino Sketch is running.
398 398  
399 -[[~[~[image:https://wiki.dragino.com/images/thumb/6/63/MQTT_Command_18.png/600px-MQTT_Command_18.png~|~|height="319" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_18.png]]
106 +[[image:image-20220527140459-19.png]]
400 400  
401 401  Upstream Data Flow
402 402  
403 -[[~[~[image:https://wiki.dragino.com/images/thumb/1/18/MQTT_Command_19.png/600px-MQTT_Command_19.png~|~|height="309" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_19.png]]
404 404  
111 +[[image:image-20220527140542-20.png]]
112 +
405 405  Downstream Data Flow
406 406  
407 407  
408 -=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
116 +== 3.2  Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8/LG308N/LPS8N/DLOS8N ==
409 409  
410 -Since firmware LG02_LG08~-~-build-v5.3.1585192026-20200326-1109, Dragino LoRaWAN gateways support the communication to LoRaWAN 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.
411 411  
412 -When use test this feature, please use the version higher then : LG02_LG08~-~-build-v5.4.1593400722-20200629-1120, in this version, the upload format is changed and readable, which is easier for integration.
119 +(((
120 +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.
121 +)))
413 413  
123 +(((
124 +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.
414 414  
415 -\\Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
416 -
417 417  
418 -Step 1: Refer [[Communicate with ABP End Node>>url:https://wiki.dragino.com/index.php/Communication_with_ABP_End_Node]] to know how to set up LG308 to work with LoRaWAN End node.
127 +(% style="color:blue" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
128 +)))
419 419  
420 -Step 2: Make sure your Radio settings match the End Node settings.
130 +(((
131 +(% 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.
132 +)))
421 421  
422 -[[~[~[image:https://wiki.dragino.com/images/thumb/f/f7/LG308_MQTT_5.png/600px-LG308_MQTT_5.png~|~|height="387" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_5.png]]
134 +(((
135 +(% style="color:blue" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
136 +)))
423 423  
138 +[[image:image-20220527141235-21.png]]
139 +
424 424  Use Same Frequency Band as End Node
425 425  
426 426  
427 -Step 3: Set up publish format and MQTT channel. The LG308 will store the Data from End node in HEX format in the file. And we need to config the format to META
143 +(((
144 +(((
145 +(% 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.
146 +)))
147 +)))
428 428  
429 -[[~[~[image:https://wiki.dragino.com/images/thumb/8/8d/LG308_MQTT_3.png/600px-LG308_MQTT_3.png~|~|height="385" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_3.png]]
149 +[[image:image-20220613191345-4.png]]
430 430  
431 -Publish mush use META as data format for LG308
432 432  
152 +(% style="color:blue" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
433 433  
434 -Step 4: Map the Device Address to Remote ID in MQTT server.
154 +[[image:image-20220613190635-2.png]]
435 435  
436 -[[~[~[image:https://wiki.dragino.com/images/thumb/7/7f/LG308_MQTT_4.png/600px-LG308_MQTT_4.png~|~|height="335" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_4.png]]
437 437  
438 -Map Dev Addr to remote ID
157 +(% style="color:blue" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
439 439  
159 +[[image:image-20220527141843-24.png]]
440 440  
441 -Step 5: Upstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server
442 442  
443 -[[~[~[image:https://wiki.dragino.com/images/thumb/b/be/LG308_MQTT_6.png/600px-LG308_MQTT_6.png~|~|height="279" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_6.png]]
162 +[[image:image-20220527141933-25.png]]
444 444  
445 -Upstream Process
446 -
447 -[[~[~[image:https://wiki.dragino.com/images/thumb/0/07/LG308_MQTT_6_1.png/600px-LG308_MQTT_6_1.png~|~|height="246" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_6_1.png]]
448 -
449 449  Choose ASCII Format
450 450  
451 -[[~[~[image:https://wiki.dragino.com/images/thumb/a/a3/LG308_MQTT_6_2.png/600px-LG308_MQTT_6_2.png~|~|height="248" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_6_2.png]]
452 452  
167 +[[image:image-20220527142028-26.png]]
168 +
453 453  LHT65 Decoder
454 454  
455 -Step 6: Set up subscribe: Subscribe a topci for downstream.
456 456  
457 -[[~[~[image:https://wiki.dragino.com/images/thumb/b/b9/LG308_MQTT_7.png/600px-LG308_MQTT_7.png~|~|height="176" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_7.png]]
172 +(% style="color:blue" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
458 458  
459 -Subscribe to a topic
174 +[[image:image-20220613191426-5.png]]
460 460  
461 461  
462 -Step 7: Downstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
177 +(% style="color:blue" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
463 463  
464 -[[~[~[image:https://wiki.dragino.com/images/thumb/9/97/LG308_MQTT_8.png/600px-LG308_MQTT_8.png~|~|height="298" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_8.png]]
179 +[[image:image-20220527142239-28.png]]
465 465  
466 -Downstream Flow
467 467  
468 -Notice: The text use for Downstream must meet the requirement from [[LG308 Downstream Payload>>url:https://wiki.dragino.com/index.php/Communication_with_ABP_End_Node#Downstream]]
469 469  
183 +mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**"
470 470  
471 -= 5. Example For Different MQTT Servers =
185 +(% class="box infomessage" %)
186 +(((
187 +**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"**
188 +)))
472 472  
473 -|=(((
474 -[[~[~[image:https://wiki.dragino.com/images/thumb/7/73/ThingSpeak1.png/200px-ThingSpeak1.png~|~|alt="ThingSpeak1.png" height="98" width="200"~]~]>>url:https://wiki.dragino.com/index.php/File:ThingSpeak1.png]]
190 +mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**"
475 475  
476 -=== [[ThingSpeak Server>>url:http://www.thingspeak.com/]] ===
192 +(% class="box infomessage" %)
193 +(((
194 +**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello,20,1,SF12,923300000,2"**
195 +)))
477 477  
197 +(% 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"]]**
478 478  
479 -[[Examples>>url:https://wiki.dragino.com/index.php/ThingSpeak_Examples]]
480 -)))|=(((
481 -[[~[~[image:https://wiki.dragino.com/images/thumb/3/3b/Lewei50.png/200px-Lewei50.png~|~|alt="Lewei50.png" height="58" width="200"~]~]>>url:https://wiki.dragino.com/index.php/File:Lewei50.png]]
199 +Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]]
482 482  
483 -=== [[乐联网平台>>url:https://www.lewei50.com/]] ===
201 +[[image:image-20220613192816-6.png||height="440" width="1056"]]
484 484  
485 485  
486 -[[lewei Example>>url:https://wiki.dragino.com/index.php/Lewei_Example_mqtt]]
487 -)))|=(((
488 -[[~[~[image:https://wiki.dragino.com/images/thumb/a/aa/AWS-IOT.png/200px-AWS-IOT.png~|~|alt="AWS-IOT.png" height="122" width="200"~]~]>>url:https://wiki.dragino.com/index.php/File:AWS-IOT.png]]
204 +== 3.3 Use LoRaWAN Protocol for communication ~-~- For LPS8V2 ==
489 489  
490 -=== [[AWS-IOT>>url:https://aws.amazon.com/cn/iot-platform/how-it-works/]] ===
491 491  
492 492  
493 -[[AWS Examples>>url:https://wiki.dragino.com/index.php/MQTT_Forward_to_Amazon_AWS-IOT]]
494 -)))
495 495  
209 += 4.  How to ask for Support =
496 496  
497 -= 6. How to Debug =
498 498  
499 -User can login the gateway's console and run **logread -f**. It will shows the output when there is packet arrive.User can see if it is correct.
500 -
501 -= 7. How to ask for Support =
502 -
503 503  If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info:
504 504  
505 505  * Detail of your LoRaWAN end node.
image-20220527133547-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +199.3 KB
Content
image-20220527134000-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +115.8 KB
Content
image-20220527134038-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +94.2 KB
Content
image-20220527134251-4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +35.1 KB
Content
image-20220527134332-5.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +34.7 KB
Content
image-20220527134929-6.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +61.6 KB
Content
image-20220527135037-7.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +65.1 KB
Content
image-20220527135215-8.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +125.6 KB
Content
image-20220527135310-9.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +87.9 KB
Content
image-20220527135440-10.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +111.5 KB
Content
image-20220527135742-11.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +18.2 KB
Content
image-20220527135828-12.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +35.1 KB
Content
image-20220527135929-13.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +31.0 KB
Content
image-20220527140023-14.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +182.2 KB
Content
image-20220527140100-15.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +8.2 KB
Content
image-20220527140148-16.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +34.0 KB
Content
image-20220527140238-17.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +126.3 KB
Content
image-20220527140354-18.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +62.7 KB
Content
image-20220527140459-19.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +151.0 KB
Content
image-20220527140542-20.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +165.4 KB
Content
image-20220527141235-21.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +83.3 KB
Content
image-20220527141450-22.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +46.5 KB
Content
image-20220527141727-23.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +23.6 KB
Content
image-20220527141843-24.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +164.3 KB
Content
image-20220527141933-25.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +100.1 KB
Content
image-20220527142028-26.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +95.2 KB
Content
image-20220527142115-27.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +9.3 KB
Content
image-20220527142239-28.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +181.1 KB
Content
image-20220527142638-29.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +62.3 KB
Content
image-20220527142706-30.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +43.1 KB
Content
image-20220527142733-31.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +10.3 KB
Content
image-20220527142820-32.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +155.6 KB
Content
image-20220613190254-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +55.7 KB
Content
image-20220613190635-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +44.1 KB
Content
image-20220613191154-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +56.1 KB
Content
image-20220613191345-4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +55.4 KB
Content
image-20220613191426-5.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +55.8 KB
Content
image-20220613192816-6.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +22.1 KB
Content
image-20220714155901-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +75.2 KB
Content
image-20240831160038-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Kilight
Size
... ... @@ -1,0 +1,1 @@
1 +151.6 KB
Content