Wiki source code of Notes for ChirpStack
Version 151.1 by Kilight Cao on 2023/06/01 08:40
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | **~ Table of Contents:** | ||
2 | |||
3 | {{toc/}} | ||
4 | |||
5 | |||
6 | |||
7 | |||
8 | = 1. Introduction = | ||
9 | |||
10 | |||
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/]] | ||
12 | |||
13 | ((( | ||
14 | (% style="color:black" %)The dragino gateway can connect the ChirpStack server via Semtech UDP or Semtech Basic Station. | ||
15 | |||
16 | |||
17 | ))) | ||
18 | |||
19 | (% style="color:blue" %)**Prerequisite:** | ||
20 | |||
21 | **1) Have a Chirstack Server.** | ||
22 | |||
23 | [[image:image-20220525100058-1.png]] | ||
24 | |||
25 | ChirpStack home page | ||
26 | |||
27 | |||
28 | |||
29 | **2) Gateway model support** | ||
30 | |||
31 | (% class="box" %) | ||
32 | ((( | ||
33 | ((( | ||
34 | Semtech UDP : **All Model** | ||
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 | ||
37 | ))) | ||
38 | ))) | ||
39 | |||
40 | |||
41 | = 2. Semtech UDP = | ||
42 | |||
43 | == 2.1 Step 1. Add the Network-servers == | ||
44 | |||
45 | |||
46 | The network-Servers address varies depending on the ChirpStack server setup environment | ||
47 | |||
48 | (% class="box" %) | ||
49 | ((( | ||
50 | Windows ~-~-> Network-server server * : localhost:8000 | ||
51 | Linux ~-~-> Network-server server * : chirpstack-network-server:8000 | ||
52 | ))) | ||
53 | |||
54 | |||
55 | (% style="color:red" %)**If the user cannot add network-Servers, re-check the ChirpStack code or the server building process.** | ||
56 | |||
57 | |||
58 | [[image:image-20220531171609-1.png]] | ||
59 | |||
60 | Add the Network-servers | ||
61 | |||
62 | |||
63 | == 2.2 Step 2. Create Gateway-profiles == | ||
64 | |||
65 | |||
66 | [[image:image-20220531171651-2.png]] | ||
67 | |||
68 | Create Gateway-profiles | ||
69 | |||
70 | |||
71 | == 2.3 Step 3. Create Service-profiles == | ||
72 | |||
73 | |||
74 | [[image:image-20220531171809-3.png]] | ||
75 | |||
76 | Create Service-profiles | ||
77 | |||
78 | |||
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 | |||
81 | (% style="color:red" %)**Note : Before add the gateway, the user needs to complete the preceding three steps.** | ||
82 | |||
83 | If the user has completed the preceding steps, proceed to the next step.(% style="display:none" %) | ||
84 | |||
85 | |||
86 | == 2.4 Step 4. Add the gateway == | ||
87 | |||
88 | |||
89 | The example gateway id is: a840411e96744150 | ||
90 | |||
91 | ((( | ||
92 | (% style="color:red" %)**Note : The Gateway EUI and server addresses must match the ChirpStack configuration.** | ||
93 | |||
94 | |||
95 | ))) | ||
96 | |||
97 | [[image:image-20220531171923-4.png]](% style="display:none" %) | ||
98 | |||
99 | Add the gateway | ||
100 | |||
101 | |||
102 | |||
103 | [[image:image-20220531172031-5.png]] | ||
104 | |||
105 | Configure the gateway | ||
106 | |||
107 | |||
108 | == 2.5 Step 5. Checking gateway Status == | ||
109 | |||
110 | |||
111 | [[image:image-20220531172158-6.png]](% style="display:none" %) | ||
112 | |||
113 | |||
114 | |||
115 | gateway Status | ||
116 | |||
117 | [[image:image-20220531172304-7.png]] | ||
118 | |||
119 | gateway Status | ||
120 | |||
121 | |||
122 | = 3. Gateway Registration for Basics Station = | ||
123 | |||
124 | == 3.1 Introduction == | ||
125 | |||
126 | |||
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 | |||
132 | (% style="color:blue" %)**Below list the support products and Requirements:** | ||
133 | |||
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 | |||
137 | (% style="color:blue" %)**How to set up chirpStack Basic Station** | ||
138 | |||
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 | |||
142 | (% style="color:blue" %)**What do you need to prepare** | ||
143 | |||
144 | A gateway that can access the internet normally | ||
145 | |||
146 | |||
147 | == 3.2 Add Gateway == | ||
148 | |||
149 | |||
150 | [[image:image-20220524164205-10.png]] | ||
151 | |||
152 | |||
153 | == 3.3 Access the gateway GUI == | ||
154 | |||
155 | |||
156 | Access the gateway GUI interface of LoRaWAN~-~->LoRaWAN ~-~- Basic Station | ||
157 | |||
158 | [[image:image-20220524164319-11.png]] | ||
159 | |||
160 | |||
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" %) | ||
173 | [[image:image-20220524164341-12.png]] | ||
174 | |||
175 | |||
176 | == 3.4 Start Station == | ||
177 | |||
178 | |||
179 | When the user has finished the configuration, Please click **Sace&Apply** to start station to connect ChirpStack. | ||
180 | |||
181 | |||
182 | == 3.5 Successful Connection == | ||
183 | |||
184 | |||
185 | If user completes the above steps, which will see live date in the ChirpStack. | ||
186 | |||
187 | [[image:image-20220524164448-13.png]] | ||
188 | |||
189 | |||
190 | == 3.6 Trouble Shooting == | ||
191 | |||
192 | |||
193 | User can check the station log in the logread/system log page. | ||
194 | |||
195 | [[image:image-20220531172837-8.png]] | ||
196 | |||
197 | |||
198 | and recode the station log in the system/Recode log page. | ||
199 | |||
200 | [[image:image-20220531172857-9.png]] | ||
201 | |||
202 | |||
203 | = 4. How the gateway connects to Chirpstack v3 via gateway-bridge = | ||
204 | |||
205 | |||
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]] | ||
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/]] | ||
210 | |||
211 | (% style="color:blue" %)**How to set up chirpStack Gateway-bridge** | ||
212 | |||
213 | Users can check out the ChirpStack gateway-bridge v3 [[link>>https://www.chirpstack.io/gateway-bridge/gateway/dragino/]] | ||
214 | |||
215 | |||
216 | (% style="color:blue" %)**What do you need to prepare** | ||
217 | |||
218 | A gateway that can access the internet normally | ||
219 | |||
220 | |||
221 | The following example does not have configuration certificates: | ||
222 | |||
223 | |||
224 | == 4.1 Configure Packet Forwarder == | ||
225 | |||
226 | |||
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 | ||
228 | |||
229 | * In the (% style="color:blue" %)**LoRaWAN** (%%)menu, click on (% style="color:blue" %)**LoRaWAN ~-~- Semtech UDP** | ||
230 | |||
231 | * Make sure the following settings are set: | ||
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// | ||
236 | |||
237 | Click (% style="color:blue" %)**Save & Apply**. | ||
238 | |||
239 | [[image:image-20221222114220-2.png||height="748" width="931"]] | ||
240 | |||
241 | |||
242 | == 4.2 Configuring gateway frequency == | ||
243 | |||
244 | |||
245 | (% style="color:red" %)**Note: Gateway frequencies must match** | ||
246 | |||
247 | [[image:image-20221222134830-3.png||height="408" width="923"]] | ||
248 | |||
249 | |||
250 | == 4.3 Generate and modify the gateway-bridge configuration file == | ||
251 | |||
252 | |||
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 | ((( | ||
261 | **/opt/chirpstack-gateway-bridge/chirpstack-gateway-bridge configfile > /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml ** | ||
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 | ((( | ||
271 | **vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml ** | ||
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 | ((( | ||
284 | **/opt/chirpstack-gateway-bridge/chirpstack-gateway-bridge ~-~-config /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml** | ||
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 | |||
344 | * In the (% style="color:blue" %)**LoRaWAN**(%%) menu, click on (% style="color:blue" %)**LoRaWAN ~-~- Semtech UDP** | ||
345 | |||
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 | |||
352 | Click (% style="color:blue" %)**Save & Apply**. | ||
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 | |||
368 | Run the gateway command line command to modify the gateway-bridge configuration file: | ||
369 | |||
370 | (% class="box infomessage" %) | ||
371 | ((( | ||
372 | **root@dragino-1d27d4:~~# vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml ** | ||
373 | ))) | ||
374 | |||
375 | [[image:image-20221222113302-1.png]] | ||
376 | |||
377 | |||
378 | [[image:image-20221222140203-4.png||height="875" width="806"]] | ||
379 | |||
380 | [[image:image-20221230094246-1.png||height="768" width="783"]] | ||
381 | |||
382 | (% class="wikigeneratedid" id="H" %) | ||
383 | After the modification, run the following command: **/etc/init.d/chirpstack-gateway-bridge restart** | ||
384 | |||
385 | |||
386 | == 5.4 (Re)start and stop gateway-bridge == | ||
387 | |||
388 | |||
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 | |||
406 | |||
407 | == 5.5 Successful Connection == | ||
408 | |||
409 | |||
410 | [[image:image-20221222141754-5.png||height="488" width="1150"]] | ||
411 | |||
412 | |||
413 | [[image:image-20221222141830-6.png||height="582" width="1153"]] | ||
414 | |||
415 | |||
416 | = 6. Downlink = | ||
417 | |||
418 | == 6.1 Convert HEX to Base64 == | ||
419 | |||
420 | |||
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.** | ||
422 | |||
423 | **[[Online HEX to Base64 Converter>>https://base64.guru/converter/encode/hex]]:** | ||
424 | |||
425 | [[image:image-20221010193350-1.png]] | ||
426 | |||
427 | |||
428 | |||
429 | **[[Online Base64 to Hex converter>>https://base64.guru/converter/decode/hex]]** | ||
430 | |||
431 | [[image:image-20221010193621-2.png]] | ||
432 | |||
433 | |||
434 | == 6.2 Chirpstack Downlink Note == | ||
435 | |||
436 | |||
437 | [[image:image-20220601102543-2.png]] | ||
438 | |||
439 | **Convert the data to Base64** | ||
440 | |||
441 | (% style="display:none" %) (%%) | ||
442 | |||
443 | |||
444 | [[image:image-20220531173236-10.png||height="597" width="1215"]] | ||
445 | |||
446 | **Check ChripStack downlink DataRate** | ||
447 | |||
448 | |||
449 | |||
450 | [[image:image-20220525101326-11.png]] | ||
451 | |||
452 | **Make sure the RX2DR is the same in the end node** | ||
453 | |||
454 | |||
455 | == 6.3 Loraserver Downlink Note == | ||
456 | |||
457 | |||
458 | User can use MQTT to send downlink payload to ChirpStack to perform downstream to LoRaWAN End | ||
459 | |||
460 | ((( | ||
461 | **Below is examples:** | ||
462 | ))) | ||
463 | |||
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 | ||
469 | User name: User name Password: password | ||
470 | ))) | ||
471 | |||
472 | [[image:image-20220531173419-11.png]] | ||
473 | |||
474 | ((( | ||
475 | **MQTT Connect to ChirpStack** | ||
476 | |||
477 | |||
478 | |||
479 | ))) | ||
480 | |||
481 | ((( | ||
482 | **After connect** | ||
483 | ))) | ||
484 | |||
485 | (% class="box" %) | ||
486 | ((( | ||
487 | Subscribe : Format:application/ID/device/ Device EUI/rx | ||
488 | Example: application/7/device/00aedb3da649cb23/rx | ||
489 | ))) | ||
490 | |||
491 | (% class="box" %) | ||
492 | ((( | ||
493 | Publish: | ||
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"} | ||
498 | ))) | ||
499 | |||
500 | [[image:image-20220531173519-12.png]] | ||
501 | |||
502 | **MQTT Connect to ChirpStack** | ||
503 | |||
504 | |||
505 | **If we want to send downstream hex 030101 to end node, the BASE64 payload is AwEB** | ||
506 | |||
507 | [[image:image-20220531173658-14.png]] | ||
508 | |||
509 | |||
510 | ((( | ||
511 | Downlink payload encode javescript code: 可以在网站上运行以下Javsscript代码: | ||
512 | ))) | ||
513 | |||
514 | (% class="box" %) | ||
515 | ((( | ||
516 | function sha1_to_base64(sha1) | ||
517 | { | ||
518 | var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"; | ||
519 | var base64_rep = ""; | ||
520 | var cnt = 0; | ||
521 | var bit_arr = 0; | ||
522 | var bit_num = 0; | ||
523 | \\ for(var n = 0; n < sha1.length; ++n) | ||
524 | { | ||
525 | if(sha1[n] >= 'A' && sha1[n] <= 'Z') | ||
526 | { | ||
527 | ascv = sha1.charCodeAt( n ) - 55; | ||
528 | } | ||
529 | else if(sha1[n] >= 'a' && sha1[n] <= 'z') | ||
530 | { | ||
531 | ascv = sha1.charCodeAt( n ) - 87; | ||
532 | } | ||
533 | else | ||
534 | { | ||
535 | ascv = sha1.charCodeAt( n ) - 48; | ||
536 | } | ||
537 | \\ bit_arr = (bit_arr << 4) | ascv; | ||
538 | bit_num += 4; | ||
539 | if(bit_num >= 6) | ||
540 | { | ||
541 | bit_num -= 6; | ||
542 | base64_rep += digits[bit_arr >>> bit_num]; | ||
543 | bit_arr &= ~~(-1 << bit_num); | ||
544 | } | ||
545 | } | ||
546 | \\ if(bit_num > 0) | ||
547 | { | ||
548 | bit_arr <<= 6 - bit_num; | ||
549 | base64_rep += digits[bit_arr]; | ||
550 | } | ||
551 | \\ var padding = base64_rep.length % 4; | ||
552 | \\ if(padding > 0) | ||
553 | { | ||
554 | for(var n = 0; n < 4 - padding; ++n) | ||
555 | { | ||
556 | base64_rep += "="; | ||
557 | } | ||
558 | } | ||
559 | return base64_rep; | ||
560 | } | ||
561 | \\console.log(sha1_to_base64("data")); | ||
562 | \\data is downlink payload required by end node. | ||
563 | e.g console.log(sha1_to_base64("030101")); | ||
564 | result: AwEB | ||
565 | AwEB is the 0x030101's base 64 Encode. | ||
566 | \\e.g console.log(sha1_to_base64("030000")); | ||
567 | result: AwAA | ||
568 | AwAA is 0x030000's base 64 Encode. | ||
569 | ))) | ||
570 | |||
571 | |||
572 | == 6.4 Add the decode function in Chirpstack for the payload == | ||
573 | |||
574 | |||
575 | User enters the payload code according to the steps. | ||
576 | |||
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 | |||
579 | [[image:image-20220531173754-15.png||height="474" width="1334"]] | ||
580 | |||
581 | |||
582 | [[image:image-20220531173856-16.png]] | ||
583 | |||
584 | |||
585 | [[image:image-20220531174120-20.png]] | ||
586 | |||
587 | [[image:image-20220531174046-19.png]] | ||
588 | |||
589 | |||
590 | = 7. Multiply Uplink in ChirpStack = | ||
591 | |||
592 | |||
593 | ((( | ||
594 | nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data. | ||
595 | ))) | ||
596 | |||
597 | ((( | ||
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]] | ||
599 | |||
600 | |||
601 | ))) | ||
602 | |||
603 | [[image:image-20220526091912-7.png||height="241" width="1336"]] | ||
604 | |||
605 | |||
606 | ((( | ||
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. | ||
608 | |||
609 | |||
610 | ))) | ||
611 | |||
612 | [[image:image-20220525104359-21.png]] | ||
613 | |||
614 | ((( | ||
615 | Above behaviour will cause the platform shows below two cases of error: | ||
616 | |||
617 | |||
618 | ))) | ||
619 | |||
620 | ((( | ||
621 | Error of duplicate Frame Counter | ||
622 | ))) | ||
623 | |||
624 | [[image:image-20220525104437-22.png]] | ||
625 | |||
626 | |||
627 | |||
628 | **Duplicate transmission in short time** | ||
629 | |||
630 | [[image:image-20220601102430-1.png||height="598" width="1319"]] | ||
631 | |||
632 | |||
633 | == 7.1 Solution == | ||
634 | |||
635 | |||
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 | |||
638 | |||
639 | ((( | ||
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.** | ||
641 | |||
642 | |||
643 | ))) | ||
644 | |||
645 | [[image:image-20220525104532-24.png]] | ||
646 | |||
647 | |||
648 | **installation path:** | ||
649 | |||
650 | [[image:image-20220525104554-25.png]] | ||
651 | |||
652 | |||
653 | |||
654 | ((( | ||
655 | (% style="color:blue" %)**2. Environment variable settings:** | ||
656 | ))) | ||
657 | |||
658 | ((( | ||
659 | 1) Open Computer -> Properties -> Advanced System Settings -> Environment Variables and add a "new" system variable: | ||
660 | ))) | ||
661 | |||
662 | ((( | ||
663 | 2) Set the variable name GOROOT and the variable value C:\Go\ (installation directory) | ||
664 | ))) | ||
665 | |||
666 | [[image:image-20220524165433-33.png]] | ||
667 | |||
668 | |||
669 | 3) Modify the system variable Path and add C:\Go\bin\: | ||
670 | |||
671 | [[image:image-20220524165452-34.png]] | ||
672 | |||
673 | |||
674 | User variable setting file generation directory: D:\go: | ||
675 | |||
676 | [[image:image-20220524165517-35.png]] | ||
677 | |||
678 | |||
679 | |||
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.** | ||
681 | |||
682 | The name of the plugin: Example ADR plugin: | ||
683 | |||
684 | [[image:image-20220524165540-36.png]] | ||
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 | |||
688 | [[image:image-20220524165557-37.png]] | ||
689 | |||
690 | |||
691 | |||
692 | (% style="color:blue" %)**4. Compile the ADR configuration file and generate the exe file.** | ||
693 | |||
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 | |||
714 | [[image:image-20220524165623-38.png]] | ||
715 | |||
716 | |||
717 | |||
718 | (% style="color:blue" %)**5. Add the plugin and run the plugin.** | ||
719 | |||
720 | ((( | ||
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: | ||
722 | ))) | ||
723 | |||
724 | [[image:image-20220524165641-39.png]] | ||
725 | |||
726 | ((( | ||
727 | ((( | ||
728 | For example: adr_plugins=[“adr-setting”] | ||
729 | ))) | ||
730 | ))) | ||
731 | |||
732 | * ((( | ||
733 | ((( | ||
734 | Adding a single plugin format is adr_plugins=["filename"] | ||
735 | ))) | ||
736 | ))) | ||
737 | |||
738 | * ((( | ||
739 | ((( | ||
740 | Adding multiple plugins The format is adr_plugins=["file name 1", "file name 2",...] | ||
741 | ))) | ||
742 | ))) | ||
743 | |||
744 | ((( | ||
745 | ((( | ||
746 | Finally, re-run chirpstack-network-server.exe, and then select the plugin you just compiled in Device-profiles, | ||
747 | ))) | ||
748 | ))) | ||
749 | |||
750 | [[image:image-20220525104647-26.png]] | ||
751 | |||
752 | Finish. | ||
753 | |||
754 | |||
755 | = 8. How to store/get all data traffic for a specific sensor, including raw payload, and uplink/ downlink history. = | ||
756 | |||
757 | |||
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. | ||
759 | |||
760 | This example will be shown how to store/get all the data in two ways: | ||
761 | |||
762 | (% style="color:blue" %)**//1). Chirpstack ~-~-> Node-red//** | ||
763 | |||
764 | |||
765 | [[image:image-20221012184501-1.png]] | ||
766 | |||
767 | |||
768 | Use MQTT in Nore-red to subscribe to topics published by the chirpstack-application and then continuously write to a file | ||
769 | |||
770 | [[image:image-20221012174220-2.png]] | ||
771 | |||
772 | |||
773 | [[image:image-20221012184655-3.png||height="395" width="1049"]] | ||
774 | |||
775 | |||
776 | **Each message is continuously logged to a specified file** | ||
777 | |||
778 | [[image:image-20221012174352-3.png]] | ||
779 | |||
780 | |||
781 | (% style="color:blue" %)**//2). MQTT Sub//** | ||
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" %) | ||
789 | ((( | ||
790 | **mosquitto_sub -h localhost -t "application/#" -v** | ||
791 | ))) | ||
792 | |||
793 | |||
794 | (% style="color:blue" %)**Different host** | ||
795 | |||
796 | (% class="box infomessage" %) | ||
797 | ((( | ||
798 | **mosquitto_sub -h IPADDRESS -p 8883 ~-~-insecure ~-~-cafile ca.pem ~-~-cert cert.pem ~-~-key key.pem -t "application/#" -v** | ||
799 | ))) | ||
800 | |||
801 | [[image:image-20221012173639-1.png]] | ||
802 | |||
803 | = 9. Example: Use Local Server ChirpStack and Node-Red in LPS8v2 = | ||
804 | |||
805 | |||
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: | ||
807 | |||
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. | ||
810 | |||
811 | Below are the steps to plot the sensor data on LPS8v2 Node-Red. | ||
812 | |||
813 | |||
814 | == 9.1 Link Node-Red to Local ChirpStack == | ||
815 | |||
816 | |||
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"]]** | ||
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 | |||
824 | (% style="color:blue" %)**1. Change the Topic** | ||
825 | |||
826 | Topic modifies it to the following format: | ||
827 | |||
828 | **application/(% style="color:red" %)Application ID(%%)/device/(% style="color:red" %)End device ID(%%)/event/up** | ||
829 | |||
830 | [[image:image-20230527143923-1.png||height="588" width="1132"]] | ||
831 | |||
832 | |||
833 | |||
834 | (% style="color:blue" %)**2. Enter the MQTT configuration information** | ||
835 | |||
836 | [[image:image-20230527144206-2.png||height="590" width="1136"]] | ||
837 | |||
838 | |||
839 | (% style="color:blue" %)3. **Finally, click "Update" and Deploy** | ||
840 | |||
841 | "Connected" indicates that the Link Node-red to Local Chirpstack is normal. | ||
842 | |||
843 | [[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"]] | ||
844 | |||
845 | |||
846 | == 9.2 Check result. == | ||
847 | |||
848 | |||
849 | Users can check logs by adding debug. | ||
850 | |||
851 | Browser access: **Node-Red-Server-Address:1880/ui** | ||
852 | |||
853 | [[image:image-20230529150923-1.png||height="424" width="1118"]] | ||
854 | |||
855 | |||
856 | = 10. Trouble Shooting = | ||
857 | |||
858 | == 10.1 MIC Mismatch or MIC Failed == | ||
859 | |||
860 | |||
861 | ((( | ||
862 | When the device is registered or the device is working normally, the problem of MIC mismatch and MIC failed occurs. | ||
863 | ))) | ||
864 | |||
865 | ((( | ||
866 | Under normal circumstances, users need to change the APPKEY to solve this problem. | ||
867 | |||
868 | |||
869 | ))) |