Wiki source code of Notes for ChirpStack
Version 157.1 by Bei Jinggeng on 2023/07/02 09:55
Hide last authors
author | version | line-number | content |
---|---|---|---|
108.4 | 1 | **~ Table of Contents:** | |
1.2 | 2 | ||
1.1 | 3 | {{toc/}} | |
4 | |||
86.4 | 5 | ||
6 | |||
7 | |||
108.4 | 8 | = 1. Introduction = | |
1.1 | 9 | ||
108.4 | 10 | ||
53.1 | 11 | (% style="color:black" %)The ChirpStack open-source LoRaWAN Network Server stack provides open-source components for LoRaWAN networks And the Chirpstack supports the users in building a private LoRaWAN Server. For more info please refer to this [[link>>url:https://www.chirpstack.io/]] | |
1.1 | 12 | ||
1.5 | 13 | ((( | |
51.1 | 14 | (% style="color:black" %)The dragino gateway can connect the ChirpStack server via Semtech UDP or Semtech Basic Station. | |
108.4 | 15 | ||
16 | |||
1.5 | 17 | ))) | |
1.1 | 18 | ||
108.4 | 19 | (% style="color:blue" %)**Prerequisite:** | |
1.1 | 20 | ||
108.4 | 21 | **1) Have a Chirstack Server.** | |
1.1 | 22 | ||
54.2 | 23 | [[image:image-20220525100058-1.png]] | |
1.1 | 24 | ||
1.2 | 25 | ChirpStack home page | |
1.1 | 26 | ||
54.2 | 27 | ||
1.1 | 28 | ||
108.4 | 29 | **2) Gateway model support** | |
30 | |||
1.2 | 31 | (% class="box" %) | |
32 | ((( | ||
1.5 | 33 | ((( | |
1.2 | 34 | Semtech UDP : **All Model** | |
108.4 | 35 | Basic Station : [[LIG16>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/171-lig16.html]], [[LG308>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/140-lg308.html]], [[DLOS8>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/160-dlos8.html]] [[LPS8>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/148-lps8.html]] | |
36 | (% style="color:red" %)**Note** (%%): the firmware needs >[[lgw~~-~~-build-v5.4.1640315898>>url:https://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]] if use the Bais station | ||
1.2 | 37 | ))) | |
1.5 | 38 | ))) | |
1.1 | 39 | ||
86.5 | 40 | ||
108.4 | 41 | = 2. Semtech UDP = | |
1.1 | 42 | ||
108.4 | 43 | == 2.1 Step 1. Add the Network-servers == | |
1.1 | 44 | ||
108.4 | 45 | ||
1.2 | 46 | The network-Servers address varies depending on the ChirpStack server setup environment | |
1.1 | 47 | ||
1.3 | 48 | (% class="box" %) | |
49 | ((( | ||
108.5 | 50 | Windows ~-~-> Network-server server * : localhost:8000 | |
51 | Linux ~-~-> Network-server server * : chirpstack-network-server:8000 | ||
1.3 | 52 | ))) | |
1.1 | 53 | ||
108.4 | 54 | ||
108.6 | 55 | (% style="color:red" %)**If the user cannot add network-Servers, re-check the ChirpStack code or the server building process.** | |
1.1 | 56 | ||
108.4 | 57 | ||
151.2 | 58 | [[image:image-20220531171609-1.png||height="638" width="1268"]](% style="display:none" %) | |
1.2 | 59 | ||
60 | Add the Network-servers | ||
61 | |||
84.2 | 62 | ||
108.6 | 63 | == 2.2 Step 2. Create Gateway-profiles == | |
1.2 | 64 | ||
108.6 | 65 | ||
151.2 | 66 | [[image:image-20220531171651-2.png||height="632" width="1264"]](% style="display:none" %) | |
1.2 | 67 | ||
68 | Create Gateway-profiles | ||
69 | |||
84.2 | 70 | ||
108.6 | 71 | == 2.3 Step 3. Create Service-profiles == | |
72 | |||
73 | |||
151.2 | 74 | [[image:image-20220531171809-3.png||height="761" width="1265"]] | |
1.2 | 75 | ||
76 | Create Service-profiles | ||
77 | |||
89.3 | 78 | ||
1.2 | 79 | In Step 3. Create Service-profiles, the above parameters can be set. If necessary, you can set them by yourself. This is only an example. | |
80 | |||
1.4 | 81 | (% style="color:red" %)**Note : Before add the gateway, the user needs to complete the preceding three steps.** | |
1.2 | 82 | ||
84.2 | 83 | If the user has completed the preceding steps, proceed to the next step.(% style="display:none" %) | |
1.2 | 84 | ||
84.2 | 85 | ||
108.7 | 86 | == 2.4 Step 4. Add the gateway == | |
1.2 | 87 | ||
108.7 | 88 | ||
1.2 | 89 | The example gateway id is: a840411e96744150 | |
90 | |||
1.5 | 91 | ((( | |
1.4 | 92 | (% style="color:red" %)**Note : The Gateway EUI and server addresses must match the ChirpStack configuration.** | |
108.7 | 93 | ||
94 | |||
1.5 | 95 | ))) | |
1.2 | 96 | ||
151.2 | 97 | [[image:image-20220531171923-4.png||height="745" width="1253"]](% style="display:none" %) | |
1.2 | 98 | ||
99 | Add the gateway | ||
100 | |||
108.7 | 101 | ||
102 | |||
91.2 | 103 | [[image:image-20220531172031-5.png]] | |
1.2 | 104 | ||
105 | Configure the gateway | ||
106 | |||
84.2 | 107 | ||
108.8 | 108 | == 2.5 Step 5. Checking gateway Status == | |
109 | |||
110 | |||
151.2 | 111 | [[image:image-20220531172158-6.png||height="704" width="1167"]](% style="display:none" %) | |
1.2 | 112 | ||
84.2 | 113 | ||
108.8 | 114 | ||
1.2 | 115 | gateway Status | |
116 | |||
151.2 | 117 | [[image:image-20220531172304-7.png||height="628" width="1165"]] | |
1.2 | 118 | ||
119 | gateway Status | ||
120 | |||
86.6 | 121 | ||
108.9 | 122 | = 3. Gateway Registration for Basics Station = | |
1.2 | 123 | ||
108.9 | 124 | == 3.1 Introduction == | |
9.1 | 125 | ||
108.8 | 126 | ||
9.1 | 127 | The [[Semtech Basic Station>>url:https://doc.sm.tc/station/]] backend implements the [[LNS protocol>>url:https://doc.sm.tc/station/tcproto.html]]. It exposes a WebSocket handler to which Basic Station powered gateways can connect. | |
128 | |||
129 | ChirpStack Open-Source LoRaWAN® Network Server needs to set up a configuration that can use Semtech BasicStation. | ||
130 | |||
131 | |||
108.8 | 132 | (% style="color:blue" %)**Below list the support products and Requirements:** | |
133 | |||
9.1 | 134 | 1. LoRaWAN Gateway model: [[LIG16>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/171-lig16.html]], [[LG308>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/140-lg308.html]], [[DLOS8>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/160-dlos8.html]] ,[[LPS8>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/148-lps8.html]] | |
135 | 1. Firmware version since :[[lgw~~-~~-build-v5.4.1651822913>>url:https://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Test_Firmware/lgw--build-v5.4.1651822913-20220506-1543/]] | ||
136 | |||
108.8 | 137 | (% style="color:blue" %)**How to set up chirpStack Basic Station** | |
138 | |||
9.1 | 139 | Users can check out the ChirpStack Basic Station [[link>>https://www.chirpstack.io/gateway-bridge/backends/basic-station/]] and [[forum>>https://forum.chirpstack.io/search?q=basic%20station]] | |
140 | |||
141 | |||
108.8 | 142 | (% style="color:blue" %)**What do you need to prepare** | |
143 | |||
9.1 | 144 | A gateway that can access the internet normally | |
145 | |||
86.7 | 146 | ||
108.9 | 147 | == 3.2 Add Gateway == | |
9.1 | 148 | ||
108.9 | 149 | ||
20.2 | 150 | [[image:image-20220524164205-10.png]] | |
9.1 | 151 | ||
86.8 | 152 | ||
108.9 | 153 | == 3.3 Access the gateway GUI == | |
9.1 | 154 | ||
108.9 | 155 | ||
9.1 | 156 | Access the gateway GUI interface of LoRaWAN~-~->LoRaWAN ~-~- Basic Station | |
157 | |||
20.2 | 158 | [[image:image-20220524164319-11.png]] | |
9.1 | 159 | ||
108.9 | 160 | ||
9.1 | 161 | User need to Choose the ChirpStack/Senet ~-~- Basic Station , input Server URI and Upload the TLS Certificate | |
162 | |||
163 | (% class="box" %) | ||
164 | ((( | ||
165 | Service Provider ~-~-> Choose the ChirpStack/Senet ~-~- Basic Station | ||
166 | |||
167 | LNS URI ~-~-> Enter the LNS URI address, For example : wss:~/~/xxxx.chirpstack.com:433 or ws:~/~/xxxx.chirpstack.com:3001 | ||
168 | |||
169 | LNS TLS trust ~-~-> Upload the TLS Certificate | ||
170 | ))) | ||
171 | |||
172 | (% class="wikigeneratedid" %) | ||
20.2 | 173 | [[image:image-20220524164341-12.png]] | |
9.1 | 174 | ||
86.9 | 175 | ||
108.9 | 176 | == 3.4 Start Station == | |
9.1 | 177 | ||
108.9 | 178 | ||
108.14 | 179 | When the user has finished the configuration, Please click **Sace&Apply** to start station to connect ChirpStack. | |
9.1 | 180 | ||
86.10 | 181 | ||
108.9 | 182 | == 3.5 Successful Connection == | |
9.1 | 183 | ||
108.9 | 184 | ||
9.1 | 185 | If user completes the above steps, which will see live date in the ChirpStack. | |
186 | |||
23.2 | 187 | [[image:image-20220524164448-13.png]] | |
9.1 | 188 | ||
86.11 | 189 | ||
108.9 | 190 | == 3.6 Trouble Shooting == | |
191 | |||
192 | |||
9.1 | 193 | User can check the station log in the logread/system log page. | |
194 | |||
95.2 | 195 | [[image:image-20220531172837-8.png]] | |
9.1 | 196 | ||
86.13 | 197 | ||
9.1 | 198 | and recode the station log in the system/Recode log page. | |
199 | |||
95.2 | 200 | [[image:image-20220531172857-9.png]] | |
9.1 | 201 | ||
86.12 | 202 | ||
138.1 | 203 | = 4. How the gateway connects to Chirpstack v3 via gateway-bridge = | |
108.9 | 204 | ||
1.2 | 205 | ||
128.1 | 206 | (% style="color:blue" %)**Below list the support products and Requirements:** | |
207 | |||
208 | 1. LoRaWAN Gateway model: [[LIG16>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/171-lig16.html]], [[LG308>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/140-lg308.html]], [[DLOS8>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/160-dlos8.html]] ,[[LPS8>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/148-lps8.html]],[[LPS8N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/200-lps8n.html]],[[LG308N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/229-lg308n.html]],[[DLOS8N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/225-dlos8n.html]] | ||
138.1 | 209 | 1. Firmware version since: [[Chirpstack-Bridge-V3.14.6>>https://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/Chirpstack-gateway-bridge/Chirpstack-Bridge-V3.14.6-Bridge--build-v5.4.1679487778-20230322-2024/]] | |
128.1 | 210 | ||
211 | (% style="color:blue" %)**How to set up chirpStack Gateway-bridge** | ||
212 | |||
138.1 | 213 | Users can check out the ChirpStack gateway-bridge v3 [[link>>https://www.chirpstack.io/gateway-bridge/gateway/dragino/]] | |
128.1 | 214 | ||
215 | |||
216 | (% style="color:blue" %)**What do you need to prepare** | ||
217 | |||
218 | A gateway that can access the internet normally | ||
219 | |||
1.2 | 220 | ||
138.1 | 221 | The following example does not have configuration certificates: | |
222 | |||
138.2 | 223 | ||
131.2 | 224 | == 4.1 Configure Packet Forwarder == | |
225 | |||
226 | |||
124.1 | 227 | In the Dragino gateway web interface, you need to configure the Packet Forwarder so that it forwards its data to the port. localhost:1700 or 127.0.0.1:1700 | |
121.2 | 228 | ||
138.3 | 229 | * In the (% style="color:blue" %)**LoRaWAN** (%%)menu, click on (% style="color:blue" %)**LoRaWAN ~-~- Semtech UDP** | |
138.2 | 230 | ||
124.1 | 231 | * Make sure the following settings are set: | |
138.4 | 232 | ** **Service Provider:** //~-~-Custom/Private LoRaWAN~-~-// | |
233 | ** **LoRaWAN Server Address:** //localhost or 127.0.0.1// | ||
234 | ** **Server port for upstream:** //1700// | ||
235 | ** **Server port for downstream:** //1700// | ||
138.2 | 236 | ||
138.3 | 237 | Click (% style="color:blue" %)**Save & Apply**. | |
124.1 | 238 | ||
239 | [[image:image-20221222114220-2.png||height="748" width="931"]] | ||
240 | |||
241 | |||
131.2 | 242 | == 4.2 Configuring gateway frequency == | |
124.1 | 243 | ||
127.1 | 244 | ||
131.2 | 245 | (% style="color:red" %)**Note: Gateway frequencies must match** | |
246 | |||
127.1 | 247 | [[image:image-20221222134830-3.png||height="408" width="923"]] | |
248 | |||
249 | |||
138.1 | 250 | == 4.3 Generate and modify the gateway-bridge configuration file == | |
127.1 | 251 | ||
252 | |||
138.1 | 253 | **1)Generate the gateway-bridge configuration file** | |
254 | |||
255 | By default, the configuration file is not up-to-date,so the user needs to rebuild the gateway-bridge configuration file. | ||
256 | |||
257 | Users need to access the command line of the gateway through SSH,Then type the following command: | ||
258 | |||
259 | (% class="box infomessage" %) | ||
260 | ((( | ||
138.5 | 261 | **/opt/chirpstack-gateway-bridge/chirpstack-gateway-bridge configfile > /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml ** | |
138.1 | 262 | ))) | |
263 | |||
264 | |||
265 | **2)modify the gateway-bridge configuration file** | ||
266 | |||
267 | The user needs to modify the server address in line 252 in the configuration file | ||
268 | |||
269 | (% class="box infomessage" %) | ||
270 | ((( | ||
138.5 | 271 | **vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml ** | |
138.1 | 272 | ))) | |
273 | |||
274 | [[image:image-20230415165254-1.png||height="583" width="956"]] | ||
275 | |||
276 | |||
277 | == 4.4 Debug == | ||
278 | |||
279 | |||
280 | After the above configuration is completed, the user can enter the command to debug the gateway-bridge connection | ||
281 | |||
282 | (% class="box infomessage" %) | ||
283 | ((( | ||
138.5 | 284 | **/opt/chirpstack-gateway-bridge/chirpstack-gateway-bridge ~-~-config /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml** | |
138.1 | 285 | ))) | |
286 | |||
287 | If the gateway-bridge connection is normal, the debug log displays **"connected to mqtt broker"**. | ||
288 | |||
289 | [[image:image-20230415170404-2.png]] | ||
290 | |||
291 | |||
292 | If the debug log shows "**connection error**", check that the server port or server is correct | ||
293 | |||
294 | [[image:image-20230415170854-3.png]] | ||
295 | |||
296 | |||
297 | More information can be found on the **[[ChirpStack website>>https://www.chirpstack.io/docs/]]**or **[[Forum>>url:https://forum.chirpstack.io/]]** | ||
298 | |||
299 | |||
300 | == 4.5 (Re)start and stop gateway-bridge == | ||
301 | |||
302 | |||
303 | Use the following commands to (re)start and stop the ChirpStack Gateway Bridge Service: | ||
304 | |||
305 | (% class="box infomessage" %) | ||
306 | ((( | ||
307 | **# start** | ||
308 | |||
309 | /etc/init.d/chirpstack-gateway-bridge start | ||
310 | |||
311 | **# stop** | ||
312 | |||
313 | /etc/init.d/chirpstack-gateway-bridge stop | ||
314 | |||
315 | **# restart** | ||
316 | |||
317 | /etc/init.d/chirpstack-gateway-bridge restart | ||
318 | ))) | ||
319 | |||
320 | |||
321 | = 5. How the gateway connects to Chirpstack v4 via gateway-bridge = | ||
322 | |||
323 | |||
324 | (% style="color:blue" %)**Below list the support products and Requirements:** | ||
325 | |||
326 | 1. LoRaWAN Gateway model: [[LIG16>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/171-lig16.html]], [[LG308>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/140-lg308.html]], [[DLOS8>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/160-dlos8.html]] ,[[LPS8>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/148-lps8.html]],[[LPS8N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/200-lps8n.html]],[[LG308N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/229-lg308n.html]],[[DLOS8N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/225-dlos8n.html]] | ||
327 | 1. Firmware version since: [[Chirpstack-Bridge-V4>>https://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/Chirpstack-gateway-bridge/Chirpstack-Bridge-V4--build-v5.4.1670655072-20221210-1452/]] | ||
328 | |||
329 | (% style="color:blue" %)**How to set up chirpStack Gateway-bridge** | ||
330 | |||
331 | Users can check out the ChirpStack gateway-bridge v4 [[link>>https://www.chirpstack.io/docs/chirpstack-gateway-bridge/install/dragino.html]] | ||
332 | |||
333 | |||
334 | (% style="color:blue" %)**What do you need to prepare** | ||
335 | |||
336 | A gateway that can access the internet normally | ||
337 | |||
338 | |||
339 | == 5.1 Configure Packet Forwarder == | ||
340 | |||
341 | |||
342 | In the Dragino gateway web interface, you need to configure the Packet Forwarder so that it forwards its data to the port. localhost:1700 or 127.0.0.1:1700 | ||
343 | |||
138.5 | 344 | * In the (% style="color:blue" %)**LoRaWAN**(%%) menu, click on (% style="color:blue" %)**LoRaWAN ~-~- Semtech UDP** | |
345 | |||
138.1 | 346 | * Make sure the following settings are set: | |
347 | ** **Service Provider:** //~-~-Custom/Private LoRaWAN~-~-// | ||
348 | ** **LoRaWAN Server Address:** //localhost or 127.0.0.1// | ||
349 | ** **Server port for upstream:** //1700// | ||
350 | ** **Server port for downstream:** //1700// | ||
351 | |||
138.5 | 352 | Click (% style="color:blue" %)**Save & Apply**. | |
138.1 | 353 | ||
354 | [[image:image-20221222114220-2.png||height="748" width="931"]] | ||
355 | |||
356 | |||
357 | == 5.2 Configuring gateway frequency == | ||
358 | |||
359 | |||
360 | (% style="color:red" %)**Note: Gateway frequencies must match** | ||
361 | |||
362 | [[image:image-20221222134830-3.png||height="408" width="923"]] | ||
363 | |||
364 | |||
365 | == 5.3 Modify the gateway-bridge configuration file == | ||
366 | |||
367 | |||
127.1 | 368 | Run the gateway command line command to modify the gateway-bridge configuration file: | |
369 | |||
370 | (% class="box infomessage" %) | ||
371 | ((( | ||
138.5 | 372 | **root@dragino-1d27d4:~~# vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml ** | |
127.1 | 373 | ))) | |
374 | |||
124.1 | 375 | [[image:image-20221222113302-1.png]] | |
376 | |||
131.2 | 377 | ||
127.1 | 378 | [[image:image-20221222140203-4.png||height="875" width="806"]] | |
379 | |||
133.1 | 380 | [[image:image-20221230094246-1.png||height="768" width="783"]] | |
127.1 | 381 | ||
382 | (% class="wikigeneratedid" id="H" %) | ||
383 | After the modification, run the following command: **/etc/init.d/chirpstack-gateway-bridge restart** | ||
384 | |||
385 | |||
138.1 | 386 | == 5.4 (Re)start and stop gateway-bridge == | |
131.2 | 387 | ||
388 | |||
127.1 | 389 | Use the following commands to (re)start and stop the ChirpStack Gateway Bridge Service: | |
390 | |||
391 | (% class="box infomessage" %) | ||
392 | ((( | ||
393 | **# start** | ||
394 | |||
395 | /etc/init.d/chirpstack-gateway-bridge start | ||
396 | |||
397 | **# stop** | ||
398 | |||
399 | /etc/init.d/chirpstack-gateway-bridge stop | ||
400 | |||
401 | **# restart** | ||
402 | |||
403 | /etc/init.d/chirpstack-gateway-bridge restart | ||
404 | ))) | ||
405 | |||
131.1 | 406 | ||
138.1 | 407 | == 5.5 Successful Connection == | |
131.1 | 408 | ||
131.2 | 409 | ||
131.1 | 410 | [[image:image-20221222141754-5.png||height="488" width="1150"]] | |
411 | |||
131.2 | 412 | ||
131.1 | 413 | [[image:image-20221222141830-6.png||height="582" width="1153"]] | |
414 | |||
131.2 | 415 | ||
138.1 | 416 | = 6. Downlink = | |
124.1 | 417 | ||
138.1 | 418 | == 6.1 Convert HEX to Base64 == | |
124.1 | 419 | ||
420 | |||
111.1 | 421 | (% style="color:red" %)**Note: Chirpstack uses base64 to downlink, the end node user manual provides HEX format of the downlink commands. So user needs to convert the HEX to Base64.** | |
108.9 | 422 | ||
121.2 | 423 | **[[Online HEX to Base64 Converter>>https://base64.guru/converter/encode/hex]]:** | |
111.1 | 424 | ||
425 | [[image:image-20221010193350-1.png]] | ||
426 | |||
427 | |||
428 | |||
121.2 | 429 | **[[Online Base64 to Hex converter>>https://base64.guru/converter/decode/hex]]** | |
430 | |||
111.1 | 431 | [[image:image-20221010193621-2.png]] | |
432 | |||
433 | |||
138.1 | 434 | == 6.2 Chirpstack Downlink Note == | |
111.1 | 435 | ||
436 | |||
108.2 | 437 | [[image:image-20220601102543-2.png]] | |
1.2 | 438 | ||
121.2 | 439 | **Convert the data to Base64** | |
1.2 | 440 | ||
121.2 | 441 | (% style="display:none" %) (%%) | |
86.14 | 442 | ||
1.2 | 443 | ||
121.2 | 444 | [[image:image-20220531173236-10.png||height="597" width="1215"]] | |
1.2 | 445 | ||
121.2 | 446 | **Check ChripStack downlink DataRate** | |
86.15 | 447 | ||
121.2 | 448 | ||
449 | |||
65.2 | 450 | [[image:image-20220525101326-11.png]] | |
1.2 | 451 | ||
121.2 | 452 | **Make sure the RX2DR is the same in the end node** | |
1.2 | 453 | ||
86.16 | 454 | ||
138.1 | 455 | == 6.3 Loraserver Downlink Note == | |
108.9 | 456 | ||
457 | |||
1.2 | 458 | User can use MQTT to send downlink payload to ChirpStack to perform downstream to LoRaWAN End | |
459 | |||
1.5 | 460 | ((( | |
108.9 | 461 | **Below is examples:** | |
1.5 | 462 | ))) | |
1.2 | 463 | ||
1.4 | 464 | (% class="box" %) | |
465 | ((( | ||
466 | Connect to your server via MQTT: | ||
467 | MQTT Client ID: Any | ||
468 | Protocol:mqtt/tcp Server IP:loraserver_ip:1883 | ||
1.2 | 469 | User name: User name Password: password | |
1.4 | 470 | ))) | |
1.2 | 471 | ||
97.2 | 472 | [[image:image-20220531173419-11.png]] | |
1.2 | 473 | ||
1.5 | 474 | ((( | |
121.2 | 475 | **MQTT Connect to ChirpStack** | |
86.17 | 476 | ||
108.9 | 477 | ||
86.17 | 478 | ||
1.5 | 479 | ))) | |
1.2 | 480 | ||
1.5 | 481 | ((( | |
108.9 | 482 | **After connect** | |
1.5 | 483 | ))) | |
1.2 | 484 | ||
1.4 | 485 | (% class="box" %) | |
486 | ((( | ||
487 | Subscribe : Format:application/ID/device/ Device EUI/rx | ||
1.2 | 488 | Example: application/7/device/00aedb3da649cb23/rx | |
1.4 | 489 | ))) | |
1.2 | 490 | ||
1.4 | 491 | (% class="box" %) | |
492 | ((( | ||
493 | Publish: | ||
1.2 | 494 | Format: Top: application/ID/device/ Device EUI/tx | |
495 | Payload: {"confirmed":true or false,"fPort":XX,"data":"xxxx"} | ||
496 | Example: Top: application/7/device/00aedb3da649cb23/tx | ||
497 | Payload: {"confirmed":true,"fPort":2,"data":"AwEB"} | ||
1.4 | 498 | ))) | |
1.2 | 499 | ||
98.2 | 500 | [[image:image-20220531173519-12.png]] | |
1.2 | 501 | ||
121.2 | 502 | **MQTT Connect to ChirpStack** | |
1.2 | 503 | ||
86.18 | 504 | ||
121.2 | 505 | **If we want to send downstream hex 030101 to end node, the BASE64 payload is AwEB** | |
1.2 | 506 | ||
100.2 | 507 | [[image:image-20220531173658-14.png]] | |
1.2 | 508 | ||
108.9 | 509 | ||
1.5 | 510 | ((( | |
1.2 | 511 | Downlink payload encode javescript code: 可以在网站上运行以下Javsscript代码: | |
1.5 | 512 | ))) | |
1.2 | 513 | ||
1.4 | 514 | (% class="box" %) | |
515 | ((( | ||
516 | function sha1_to_base64(sha1) | ||
1.2 | 517 | { | |
518 | var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"; | ||
519 | var base64_rep = ""; | ||
520 | var cnt = 0; | ||
521 | var bit_arr = 0; | ||
522 | var bit_num = 0; | ||
1.5 | 523 | \\ for(var n = 0; n < sha1.length; ++n) | |
1.2 | 524 | { | |
525 | if(sha1[n] >= 'A' && sha1[n] <= 'Z') | ||
526 | { | ||
121.1 | 527 | ascv = sha1.charCodeAt( n ) - 55; | |
1.2 | 528 | } | |
529 | else if(sha1[n] >= 'a' && sha1[n] <= 'z') | ||
530 | { | ||
121.1 | 531 | ascv = sha1.charCodeAt( n ) - 87; | |
1.2 | 532 | } | |
533 | else | ||
534 | { | ||
121.1 | 535 | ascv = sha1.charCodeAt( n ) - 48; | |
1.2 | 536 | } | |
1.5 | 537 | \\ bit_arr = (bit_arr << 4) | ascv; | |
1.2 | 538 | bit_num += 4; | |
539 | if(bit_num >= 6) | ||
540 | { | ||
1.4 | 541 | bit_num -= 6; | |
1.2 | 542 | base64_rep += digits[bit_arr >>> bit_num]; | |
1.4 | 543 | bit_arr &= ~~(-1 << bit_num); | |
1.2 | 544 | } | |
545 | } | ||
1.5 | 546 | \\ if(bit_num > 0) | |
1.2 | 547 | { | |
548 | bit_arr <<= 6 - bit_num; | ||
549 | base64_rep += digits[bit_arr]; | ||
550 | } | ||
1.5 | 551 | \\ var padding = base64_rep.length % 4; | |
552 | \\ if(padding > 0) | ||
1.2 | 553 | { | |
554 | for(var n = 0; n < 4 - padding; ++n) | ||
555 | { | ||
556 | base64_rep += "="; | ||
557 | } | ||
558 | } | ||
559 | return base64_rep; | ||
560 | } | ||
1.5 | 561 | \\console.log(sha1_to_base64("data")); | |
562 | \\data is downlink payload required by end node. | ||
1.4 | 563 | e.g console.log(sha1_to_base64("030101")); | |
564 | result: AwEB | ||
1.2 | 565 | AwEB is the 0x030101's base 64 Encode. | |
1.5 | 566 | \\e.g console.log(sha1_to_base64("030000")); | |
1.4 | 567 | result: AwAA | |
568 | AwAA is 0x030000's base 64 Encode. | ||
569 | ))) | ||
1.2 | 570 | ||
86.21 | 571 | ||
147.2 | 572 | == 6.4 Add the decode function in Chirpstack for the payload == | |
108.9 | 573 | ||
574 | |||
1.2 | 575 | User enters the payload code according to the steps. | |
576 | |||
150.1 | 577 | Add the node device decoder you are using. The decoder for each node device is different. The decoder is found in this link: **[[decoder for dragino end node>>https://github.com/dragino/dragino-end-node-decoder]]** | |
578 | |||
121.2 | 579 | [[image:image-20220531173754-15.png||height="474" width="1334"]] | |
1.2 | 580 | ||
581 | |||
102.2 | 582 | [[image:image-20220531173856-16.png]] | |
1.2 | 583 | ||
102.2 | 584 | ||
106.2 | 585 | [[image:image-20220531174120-20.png]] | |
84.2 | 586 | ||
105.2 | 587 | [[image:image-20220531174046-19.png]] | |
1.2 | 588 | ||
86.22 | 589 | ||
138.1 | 590 | = 7. Multiply Uplink in ChirpStack = | |
108.9 | 591 | ||
592 | |||
1.4 | 593 | ((( | |
1.2 | 594 | nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data. | |
1.4 | 595 | ))) | |
1.2 | 596 | ||
1.4 | 597 | ((( | |
1.2 | 598 | ChirpStack will auto adjust nbtrans according to uplink rssi. [[link to source>>url:https://github.com/brocaar/chirpstack-network-server/blob/master/internal/adr/adr.go]] | |
108.9 | 599 | ||
600 | |||
1.4 | 601 | ))) | |
1.2 | 602 | ||
121.2 | 603 | [[image:image-20220526091912-7.png||height="241" width="1336"]] | |
1.2 | 604 | ||
108.9 | 605 | ||
1.5 | 606 | ((( | |
1.2 | 607 | nbtrans is a field of ADR message, in unconfirm mode, it tells end node how many time it needs to transmit for every frame. | |
108.9 | 608 | ||
609 | |||
1.5 | 610 | ))) | |
1.2 | 611 | ||
76.2 | 612 | [[image:image-20220525104359-21.png]] | |
1.2 | 613 | ||
1.4 | 614 | ((( | |
1.2 | 615 | Above behaviour will cause the platform shows below two cases of error: | |
108.9 | 616 | ||
617 | |||
1.4 | 618 | ))) | |
1.2 | 619 | ||
1.4 | 620 | ((( | |
1.2 | 621 | Error of duplicate Frame Counter | |
1.4 | 622 | ))) | |
1.2 | 623 | ||
76.2 | 624 | [[image:image-20220525104437-22.png]] | |
1.2 | 625 | ||
86.23 | 626 | ||
108.9 | 627 | ||
121.2 | 628 | **Duplicate transmission in short time** | |
1.2 | 629 | ||
121.2 | 630 | [[image:image-20220601102430-1.png||height="598" width="1319"]] | |
1.2 | 631 | ||
86.24 | 632 | ||
138.1 | 633 | == 7.1 Solution == | |
108.9 | 634 | ||
635 | |||
1.2 | 636 | This example uses the Windows version as a template, other versions can refer to this. Similiar reference: [[https:~~/~~/confluence.alitecs.de/plugins/servlet/mobile?contentId=79790102#content/view/79790102>>url:https://confluence.alitecs.de/plugins/servlet/mobile?contentId=79790102#content/view/79790102]] | |
637 | |||
108.9 | 638 | ||
1.5 | 639 | ((( | |
108.11 | 640 | (% style="color:blue" %)**1. Install the GO compilation environment: Download the corresponding version of the Go compiler at [[https:~~/~~/go.dev/dl/>>url:https://go.dev/dl/]] and install it.** | |
108.9 | 641 | ||
642 | |||
1.5 | 643 | ))) | |
1.2 | 644 | ||
79.2 | 645 | [[image:image-20220525104532-24.png]] | |
1.2 | 646 | ||
86.25 | 647 | ||
108.9 | 648 | **installation path:** | |
1.2 | 649 | ||
79.2 | 650 | [[image:image-20220525104554-25.png]] | |
1.2 | 651 | ||
86.25 | 652 | ||
108.9 | 653 | ||
1.5 | 654 | ((( | |
108.11 | 655 | (% style="color:blue" %)**2. Environment variable settings:** | |
1.5 | 656 | ))) | |
1.2 | 657 | ||
1.5 | 658 | ((( | |
1.2 | 659 | 1) Open Computer -> Properties -> Advanced System Settings -> Environment Variables and add a "new" system variable: | |
1.5 | 660 | ))) | |
1.2 | 661 | ||
1.5 | 662 | ((( | |
108.9 | 663 | 2) Set the variable name GOROOT and the variable value C:\Go\ (installation directory) | |
1.5 | 664 | ))) | |
1.2 | 665 | ||
43.2 | 666 | [[image:image-20220524165433-33.png]] | |
1.2 | 667 | ||
86.26 | 668 | ||
108.9 | 669 | 3) Modify the system variable Path and add C:\Go\bin\: | |
1.2 | 670 | ||
43.2 | 671 | [[image:image-20220524165452-34.png]] | |
1.2 | 672 | ||
106.3 | 673 | ||
1.2 | 674 | User variable setting file generation directory: D:\go: | |
675 | |||
43.2 | 676 | [[image:image-20220524165517-35.png]] | |
1.2 | 677 | ||
86.27 | 678 | ||
1.2 | 679 | ||
108.11 | 680 | (% style="color:blue" %)**3. Modify the ADR configuration file according to your own needs, adr.setting.go is an example of the ADR configuration file.** | |
108.9 | 681 | ||
1.2 | 682 | The name of the plugin: Example ADR plugin: | |
683 | |||
48.2 | 684 | [[image:image-20220524165540-36.png]] | |
1.2 | 685 | ||
686 | Set Nbtrans: Nbtrans=1 (Nbtrans is the number of retransmissions, if it is 1, no retransmission, it is recommended to be 1). To enable it, you need to uncomment. | ||
687 | |||
48.2 | 688 | [[image:image-20220524165557-37.png]] | |
1.2 | 689 | ||
86.28 | 690 | ||
1.2 | 691 | ||
108.11 | 692 | (% style="color:blue" %)**4. Compile the ADR configuration file and generate the exe file.** | |
108.9 | 693 | ||
1.2 | 694 | 1) Create a folder named adr-setting | |
695 | |||
696 | 2) Open the adr-setting folder | ||
697 | |||
698 | 3) Put adr.setting.go in this folder. | ||
699 | |||
700 | 4) Open the computer cmd and run the following commands in sequencecd adr-setting | ||
701 | |||
702 | go mod init adr-setting | ||
703 | |||
704 | go get github.com/brocaar/chirpstack-network-server/v3/adr | ||
705 | |||
706 | go get github.com/hashicorp/go-plugin | ||
707 | |||
708 | go get adr-setting | ||
709 | |||
710 | go build | ||
711 | |||
712 | 5) Finally generate this file: | ||
713 | |||
48.2 | 714 | [[image:image-20220524165623-38.png]] | |
1.2 | 715 | ||
86.29 | 716 | ||
1.2 | 717 | ||
108.11 | 718 | (% style="color:blue" %)**5. Add the plugin and run the plugin.** | |
108.9 | 719 | ||
1.5 | 720 | ((( | |
1.2 | 721 | The exe file generated in the previous step is placed in the same root directory as chirpstack-network-server.toml, and the ADR plugin is added to the toml file. The location of the addition is as follows: | |
1.5 | 722 | ))) | |
1.2 | 723 | ||
48.2 | 724 | [[image:image-20220524165641-39.png]] | |
1.2 | 725 | ||
1.4 | 726 | ((( | |
1.5 | 727 | ((( | |
1.2 | 728 | For example: adr_plugins=[“adr-setting”] | |
1.4 | 729 | ))) | |
1.5 | 730 | ))) | |
1.2 | 731 | ||
1.4 | 732 | * ((( | |
1.5 | 733 | ((( | |
1.4 | 734 | Adding a single plugin format is adr_plugins=["filename"] | |
735 | ))) | ||
1.5 | 736 | ))) | |
1.2 | 737 | ||
1.4 | 738 | * ((( | |
1.5 | 739 | ((( | |
1.4 | 740 | Adding multiple plugins The format is adr_plugins=["file name 1", "file name 2",...] | |
741 | ))) | ||
1.5 | 742 | ))) | |
1.2 | 743 | ||
1.4 | 744 | ((( | |
1.5 | 745 | ((( | |
1.2 | 746 | Finally, re-run chirpstack-network-server.exe, and then select the plugin you just compiled in Device-profiles, | |
1.4 | 747 | ))) | |
1.5 | 748 | ))) | |
1.2 | 749 | ||
79.2 | 750 | [[image:image-20220525104647-26.png]] | |
1.2 | 751 | ||
752 | Finish. | ||
753 | |||
86.30 | 754 | ||
138.1 | 755 | = 8. How to store/get all data traffic for a specific sensor, including raw payload, and uplink/ downlink history. = | |
108.9 | 756 | ||
1.2 | 757 | ||
115.1 | 758 | All data is published to the MQTT topics. if you want to store/get the data, you would have to create an MQTT handler and store the data yourself. | |
1.2 | 759 | ||
115.1 | 760 | This example will be shown how to store/get all the data in two ways: | |
108.9 | 761 | ||
138.5 | 762 | (% style="color:blue" %)**//1). Chirpstack ~-~-> Node-red//** | |
115.1 | 763 | ||
764 | |||
117.1 | 765 | [[image:image-20221012184501-1.png]] | |
115.1 | 766 | ||
121.2 | 767 | ||
120.1 | 768 | Use MQTT in Nore-red to subscribe to topics published by the chirpstack-application and then continuously write to a file | |
115.1 | 769 | ||
770 | [[image:image-20221012174220-2.png]] | ||
771 | |||
772 | |||
120.1 | 773 | [[image:image-20221012184655-3.png||height="395" width="1049"]] | |
774 | |||
775 | |||
121.2 | 776 | **Each message is continuously logged to a specified file** | |
115.1 | 777 | ||
778 | [[image:image-20221012174352-3.png]] | ||
779 | |||
780 | |||
138.5 | 781 | (% style="color:blue" %)**//2). MQTT Sub//** | |
115.1 | 782 | ||
783 | If you don't want to store the information via node-red, you can get the output via the subscribe command. | ||
784 | |||
785 | |||
786 | **If connecting from the same machine, you can use the following command to receive data:** | ||
787 | |||
788 | (% class="box infomessage" %) | ||
1.4 | 789 | ((( | |
138.5 | 790 | **mosquitto_sub -h localhost -t "application/#" -v** | |
115.1 | 791 | ))) | |
792 | |||
793 | |||
138.5 | 794 | (% style="color:blue" %)**Different host** | |
115.1 | 795 | ||
796 | (% class="box infomessage" %) | ||
797 | ((( | ||
138.5 | 798 | **mosquitto_sub -h IPADDRESS -p 8883 ~-~-insecure ~-~-cafile ca.pem ~-~-cert cert.pem ~-~-key key.pem -t "application/#" -v** | |
115.1 | 799 | ))) | |
800 | |||
801 | [[image:image-20221012173639-1.png]] | ||
802 | |||
150.1 | 803 | = 9. Example: Use Local Server ChirpStack and Node-Red in LPS8v2 = | |
115.1 | 804 | ||
805 | |||
151.1 | 806 | LPS8v2 includes a local ChirpStack Server and Node-Red. This example shows how to configure LHT65N to use with the local Node-Red server. This example assumes users already have: | |
115.1 | 807 | ||
141.1 | 808 | * LHT65N register on LPS8v2 Built-In ChirpStack server already | |
809 | * The user is able to see the data on the built-in ChirpStack server device page. | ||
115.1 | 810 | ||
141.1 | 811 | Below are the steps to plot the sensor data on LPS8v2 Node-Red. | |
812 | |||
147.2 | 813 | ||
150.1 | 814 | == 9.1 Link Node-Red to Local ChirpStack == | |
141.1 | 815 | ||
147.2 | 816 | ||
145.1 | 817 | Users can download the Node-Red decoder from this link and import it into the Node-Red platform: **[[attach:LHT65N-ChirpStack-node-red.json||target="_blank"]]** | |
141.1 | 818 | ||
819 | For more information on importing Input Flow, check out this link: **[[Import Input Flow for Dragino Sensors>>url:http://wiki.dragino.com/xwiki/bin/view/Main/Node-RED/#H3.A0ImportInputFlowforDraginoSensors]]** | ||
820 | |||
821 | After importing the Input Flow is complete, the user needs to edit the MQTT in the node | ||
822 | |||
823 | |||
145.1 | 824 | (% style="color:blue" %)**1. Change the Topic** | |
825 | |||
141.1 | 826 | Topic modifies it to the following format: | |
827 | |||
145.1 | 828 | **application/(% style="color:red" %)Application ID(%%)/device/(% style="color:red" %)End device ID(%%)/event/up** | |
141.1 | 829 | ||
152.1 | 830 | Reference link: [[**Node-RED integration** >>https://www.chirpstack.io/docs/guides/node-red-integration.html]] | |
831 | |||
145.1 | 832 | [[image:image-20230527143923-1.png||height="588" width="1132"]] | |
141.1 | 833 | ||
834 | |||
145.1 | 835 | ||
836 | (% style="color:blue" %)**2. Enter the MQTT configuration information** | ||
837 | |||
838 | [[image:image-20230527144206-2.png||height="590" width="1136"]] | ||
839 | |||
840 | |||
147.1 | 841 | (% style="color:blue" %)3. **Finally, click "Update" and Deploy** | |
842 | |||
843 | "Connected" indicates that the Link Node-red to Local Chirpstack is normal. | ||
844 | |||
845 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/Notes%20for%20TTN/WebHome/image-20220914140918-5.png?width=1121&height=602&rev=1.1||alt="image-20220914140918-5.png"]] | ||
846 | |||
847 | |||
150.1 | 848 | == 9.2 Check result. == | |
147.1 | 849 | ||
147.2 | 850 | ||
147.1 | 851 | Users can check logs by adding debug. | |
852 | |||
853 | Browser access: **Node-Red-Server-Address:1880/ui** | ||
854 | |||
855 | [[image:image-20230529150923-1.png||height="424" width="1118"]] | ||
856 | |||
147.2 | 857 | ||
150.1 | 858 | = 10. Trouble Shooting = | |
141.1 | 859 | ||
150.1 | 860 | == 10.1 MIC Mismatch or MIC Failed == | |
141.1 | 861 | ||
862 | |||
115.1 | 863 | ((( | |
1.2 | 864 | When the device is registered or the device is working normally, the problem of MIC mismatch and MIC failed occurs. | |
1.4 | 865 | ))) | |
1.2 | 866 | ||
1.4 | 867 | ((( | |
1.2 | 868 | Under normal circumstances, users need to change the APPKEY to solve this problem. | |
131.2 | 869 | ||
870 | |||
1.4 | 871 | ))) |