Changes for page MQTT Forward Instruction

Last modified by Xiaoling on 2025/07/31 16:59

From version 58.1
edited by Xiaoling
on 2025/07/31 16:59
Change comment: There is no comment for this version
To version 1.8
edited by Xiaoling
on 2022/05/12 15:57
Change comment: There is no comment for this version

Summary

Details

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