Skip to Content

Wiki source code of MQTT Forward Instruction

Last modified by Xiaoling on 2025/07/31 16:59
Show last authors
1 **~ Table of Contents：**
2
3 {{toc/}}
4
5
6 = 1.  Introduction =
7
8
9 Dragino LoRa/LoRaWAN gateway support MQTT forwarding. It can forward the sensor data from LoRa network to MQTT server , and vice verse.
10
11
12 == 1.1  Support Devices ==
13
14
15 This MQTT forward instruction is for below devices:
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]])
18 * LG02, OLG02
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
23 The MQTT Client Utility used in Dragino is **mosquitto_pub** and **mosquitto_sub**. User can add more options to the mqtt commands.
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]]**
26
27
28 = 2.  Example to communicate to a simple MQTT server =
29
30 == 2.1  Overview ==
31
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/]].
34
35
36 == 2.2  Simulate via MQTT.fx utility ==
37
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.
40
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.
43 )))
44
45 [[image:image-20220527134929-6.png]]
46
47 Connect to MQTT Broker
48
49
50 After connected, use publish to public some thing to MQTT server. This to simulate upsteam
51
52 [[image:image-20220527135037-7.png]]
53
54 Upstream: Publish message to MQTT Broker
55
56
57 To simulate a downstream, use MQTT.fx to subscribe a topic, and publish something to this topic. as Below:
58
59 [[image:image-20220527135215-8.png]]
60
61 Downstream: Subscribe a topic to get downstream
62
63
64 = 3. Add LoRa support to communicate with remote sensor =
65
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.
68
69
70 == 3.1  Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ==
71
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 )))
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 )))
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.
83
84
85 )))
86
87 (((
88 What does the Arduino Sketch do? The Arduino Sketch will:
89 )))
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:
94
95 [[image:image-20220527140354-18.png]]
96
97 LoRa Parameter should match
98
99
100 Below is the test result after the Arduino Sketch is running.
101
102 [[image:image-20220527140459-19.png]]
103
104 Upstream Data Flow
105
106
107 [[image:image-20220527140542-20.png]]
108
109 Downstream Data Flow
110
111
112 == 3.2  Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8/LG308N/LPS8N/DLOS8N ==
113
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 )))
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.
121
122
123 (% style="color:blue" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
124 )))
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 )))
129
130 (((
131 (% style="color:blue" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
132 )))
133
134 [[image:image-20220527141235-21.png]]
135
136 Use Same Frequency Band as End Node
137
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
145 [[image:image-20220613191345-4.png]]
146
147
148 (% style="color:blue" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
149
150 [[image:image-20220613190635-2.png]]
151
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
154
155 [[image:image-20220527141843-24.png]]
156
157
158 [[image:image-20220527141933-25.png]]
159
160 Choose ASCII Format
161
162
163 [[image:image-20220527142028-26.png]]
164
165 LHT65 Decoder
166
167
168 (% style="color:blue" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
169
170 [[image:image-20220613191426-5.png]]
171
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
175 [[image:image-20220527142239-28.png]]
176
177
178
179 mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**"
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 )))
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**"
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 )))
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"]]**
194
195 Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]]
196
197 [[image:image-20220613192816-6.png||height="440" width="1056"]]
198
199
200 == 3.3  Use LoRaWAN Protocol for communication ~-~- For LPS8V2 ==
201
202 (((
203
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 )))
207
208 (((
209 (% style="color:blue" %)**Step 2**(%%): Make sure your node data is normal on the built-in server
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
212
213 [[image:image-20240831160038-1.png||height="680" width="1321"]]
214 )))
215
216
217 (% style="color:blue" %)**Step 3**(%%): Set up MQTT Forworder.
218
219 [[image:image-20240831162021-2.png||height="684" width="1191"]]
220
221
222 (% style="color:blue" %)**Step 4:** (%%)Check result
223
224 Users can check the data through the MQTT server, or use the MQtt.fx tool.
225
226 [[image:image-20240831162254-3.png||height="661" width="1284"]]
227
228 [[image:image-20240831162454-4.png]]
229
230 = 4.  How to ask for Support =
231
232
233 If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info:
234
235 * Detail of your LoRaWAN end node.
236 * Gateway Model and firmware version
237 * A set of screenshots you configure in the gateway according to our instruction
238 * A full log of "logread -f"