Wiki source code of Notes for ChirpStack

Version 134.1 by Kilight Cao on 2023/03/31 14:42
Show last authors
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 v4 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-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/]]
210
211 (% style="color:blue" %)**How to set up chirpStack Gateway-bridge**
212
213 Users can check out the ChirpStack gateway-bridge v4 [[link>>https://www.chirpstack.io/docs/chirpstack-gateway-bridge/install/dragino.html]]
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 == 4.1  Configure Packet Forwarder ==
222
223
224 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
225
226 * In the **LoRaWAN** menu, click on **LoRaWAN ~-~- Semtech UDP**
227 * Make sure the following settings are set:
228 ** **Service Provider:** //~-~-Custom/Private LoRaWAN~-~-//
229 ** **LoRaWAN Server Address:** //localhost or 127.0.0.1//
230 ** **Server port for upstream:** //1700//
231 ** **Server port for downstream:** //1700//
232
233 Click **Save & Apply**.
234
235 [[image:image-20221222114220-2.png||height="748" width="931"]]
236
237
238 == 4.2  Configuring gateway frequency ==
239
240
241 (% style="color:red" %)**Note: Gateway frequencies must match**
242
243 [[image:image-20221222134830-3.png||height="408" width="923"]]
244
245
246 == 4.3  Modify the gateway-bridge configuration file ==
247
248
249 Run the gateway command line command to modify the gateway-bridge configuration file:
250
251 (% class="box infomessage" %)
252 (((
253 root@dragino-1d27d4:~~#  vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml
254 )))
255
256 [[image:image-20221222113302-1.png]]
257
258
259 [[image:image-20221222140203-4.png||height="875" width="806"]]
260
261 [[image:image-20221230094246-1.png||height="768" width="783"]]
262
263 (% class="wikigeneratedid" id="H" %)
264 After the modification, run the following command: **/etc/init.d/chirpstack-gateway-bridge restart**
265
266
267 == 4.4  (Re)start and stop gateway-bridge ==
268
269
270 Use the following commands to (re)start and stop the ChirpStack Gateway Bridge Service:
271
272 (% class="box infomessage" %)
273 (((
274 **# start**
275
276 /etc/init.d/chirpstack-gateway-bridge start
277
278 **# stop**
279
280 /etc/init.d/chirpstack-gateway-bridge stop
281
282 **# restart**
283
284 /etc/init.d/chirpstack-gateway-bridge restart
285 )))
286
287
288 == 4.5  Successful Connection ==
289
290
291 [[image:image-20221222141754-5.png||height="488" width="1150"]]
292
293
294 [[image:image-20221222141830-6.png||height="582" width="1153"]]
295
296
297 = 5.  Downlink =
298
299 == 5.1  Convert HEX to Base64 ==
300
301
302 (% 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.**
303
304 **[[Online HEX to Base64 Converter>>https://base64.guru/converter/encode/hex]]:**
305
306 [[image:image-20221010193350-1.png]]
307
308
309
310 **[[Online Base64 to Hex converter>>https://base64.guru/converter/decode/hex]]**
311
312 [[image:image-20221010193621-2.png]]
313
314
315 == 5.2  Chirpstack Downlink Note ==
316
317
318 [[image:image-20220601102543-2.png]]
319
320 **Convert the data to Base64**
321
322 (% style="display:none" %) (%%)
323
324
325 [[image:image-20220531173236-10.png||height="597" width="1215"]]
326
327 **Check ChripStack downlink DataRate**
328
329
330
331 [[image:image-20220525101326-11.png]]
332
333 **Make sure the RX2DR is the same in the end node**
334
335
336 == 5.3  Loraserver Downlink Note ==
337
338
339 User can use MQTT to send downlink payload to ChirpStack to perform downstream to LoRaWAN End
340
341 (((
342 **Below is examples:**
343 )))
344
345 (% class="box" %)
346 (((
347 Connect to your server via MQTT：
348 MQTT Client ID: Any   
349 Protocol：mqtt/tcp   Server IP：loraserver_ip:1883
350 User name: User name Password: password
351 )))
352
353 [[image:image-20220531173419-11.png]]
354
355 (((
356 **MQTT Connect to ChirpStack**
357
358
359
360 )))
361
362 (((
363 **After connect**
364 )))
365
366 (% class="box" %)
367 (((
368 Subscribe : Format：application/ID/device/ Device EUI/rx
369 Example: application/7/device/00aedb3da649cb23/rx
370 )))
371
372 (% class="box" %)
373 (((
374 Publish:
375 Format: Top: application/ID/device/ Device EUI/tx
376 Payload: {"confirmed":true or false,"fPort":XX,"data":"xxxx"}
377 Example: Top: application/7/device/00aedb3da649cb23/tx
378 Payload: {"confirmed":true,"fPort":2,"data":"AwEB"}
379 )))
380
381 [[image:image-20220531173519-12.png]]
382
383 **MQTT Connect to ChirpStack**
384
385
386 **If we want to send downstream hex 030101 to end node, the BASE64 payload is AwEB**
387
388 [[image:image-20220531173658-14.png]]
389
390
391 (((
392 Downlink payload encode javescript code: 可以在网站上运行以下Javsscript代码：
393 )))
394
395 (% class="box" %)
396 (((
397 function sha1_to_base64(sha1)
398 {
399 var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
400 var base64_rep = "";
401 var cnt = 0;
402 var bit_arr = 0;
403 var bit_num = 0;
404 \\ for(var n = 0; n < sha1.length; ++n)
405 {
406 if(sha1[n] >= 'A' && sha1[n] <= 'Z')
407 {
408 ascv = sha1.charCodeAt( n ) - 55;
409 }
410 else if(sha1[n] >= 'a' && sha1[n] <= 'z')
411 {
412 ascv = sha1.charCodeAt( n ) - 87;
413 }
414 else
415 {
416 ascv = sha1.charCodeAt( n ) - 48;
417 }
418 \\ bit_arr = (bit_arr << 4) | ascv;
419 bit_num += 4;
420 if(bit_num >= 6)
421 {
422 bit_num -= 6;        
423 base64_rep += digits[bit_arr >>> bit_num];
424 bit_arr &= ~~(-1 << bit_num);
425 }
426 }
427 \\ if(bit_num > 0)
428 {
429 bit_arr <<= 6 - bit_num;
430 base64_rep += digits[bit_arr];
431 }
432 \\ var padding = base64_rep.length % 4;   
433 \\ if(padding > 0)
434 {
435 for(var n = 0; n < 4 - padding; ++n)
436 {
437 base64_rep += "=";
438 }
439 }
440 return base64_rep;
441 }
442 \\console.log(sha1_to_base64("data"));
443 \\data is downlink payload required by end node.
444 e.g console.log(sha1_to_base64("030101"));
445 ​result: AwEB     
446 AwEB is the 0x030101's base 64 Encode.
447 \\​e.g console.log(sha1_to_base64("030000"));
448 ​result: AwAA     
449 AwAA is 0x030000's base 64 Encode.
450 )))
451
452
453 == 4.3  Add the decode function in Chirpstack for the payload ==
454
455
456 User enters the payload code according to the steps.
457
458 [[image:image-20220531173754-15.png||height="474" width="1334"]]
459
460
461 [[image:image-20220531173856-16.png]]
462
463
464 [[image:image-20220531174120-20.png]]
465
466 [[image:image-20220531174046-19.png]]
467
468
469 = 6.  Multiply Uplink in ChirpStack =
470
471
472 (((
473 nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data.
474 )))
475
476 (((
477 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]]
478
479
480 )))
481
482 [[image:image-20220526091912-7.png||height="241" width="1336"]]
483
484
485 (((
486 nbtrans is a field of ADR message, in unconfirm mode, it tells end node how many time it needs to transmit for every frame.
487
488
489 )))
490
491 [[image:image-20220525104359-21.png]]
492
493 (((
494 Above behaviour will cause the platform shows below two cases of error:
495
496
497 )))
498
499 (((
500 Error of duplicate Frame Counter
501 )))
502
503 [[image:image-20220525104437-22.png]]
504
505
506
507 **Duplicate transmission in short time**
508
509 [[image:image-20220601102430-1.png||height="598" width="1319"]]
510
511
512 == 6.1  Solution ==
513
514
515 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]]
516
517
518 (((
519 (% 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.**
520
521
522 )))
523
524 [[image:image-20220525104532-24.png]]
525
526
527 **installation path:**
528
529 [[image:image-20220525104554-25.png]]
530
531
532
533 (((
534 (% style="color:blue" %)**2.  Environment variable settings:**
535 )))
536
537 (((
538 1) Open Computer -> Properties -> Advanced System Settings -> Environment Variables and add a "new" system variable:
539 )))
540
541 (((
542 2) Set the variable name GOROOT and the variable value C:\Go\ (installation directory)
543 )))
544
545 [[image:image-20220524165433-33.png]]
546
547
548 3) Modify the system variable Path and add C:\Go\bin\:
549
550 [[image:image-20220524165452-34.png]]
551
552
553 User variable setting file generation directory: D:\go:
554
555 [[image:image-20220524165517-35.png]]
556
557
558
559 (% 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.**
560
561 The name of the plugin: Example ADR plugin:
562
563 [[image:image-20220524165540-36.png]]
564
565 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.
566
567 [[image:image-20220524165557-37.png]]
568
569
570
571 (% style="color:blue" %)**4.  Compile the ADR configuration file and generate the exe file.**
572
573 1) Create a folder named adr-setting
574
575 2) Open the adr-setting folder
576
577 3) Put adr.setting.go in this folder.
578
579 4) Open the computer cmd and run the following commands in sequencecd adr-setting
580
581 go mod init adr-setting
582
583 go get github.com/brocaar/chirpstack-network-server/v3/adr
584
585 go get github.com/hashicorp/go-plugin
586
587 go get adr-setting
588
589 go build
590
591 5) Finally generate this file：
592
593 [[image:image-20220524165623-38.png]]
594
595
596
597 (% style="color:blue" %)**5.  Add the plugin and run the plugin.**
598
599 (((
600 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:
601 )))
602
603 [[image:image-20220524165641-39.png]]
604
605 (((
606 (((
607 For example: adr_plugins=[“adr-setting”]
608 )))
609 )))
610
611 * (((
612 (((
613 Adding a single plugin format is adr_plugins=["filename"]
614 )))
615 )))
616
617 * (((
618 (((
619 Adding multiple plugins The format is adr_plugins=["file name 1", "file name 2",...]
620 )))
621 )))
622
623 (((
624 (((
625 Finally, re-run chirpstack-network-server.exe, and then select the plugin you just compiled in Device-profiles,
626 )))
627 )))
628
629 [[image:image-20220525104647-26.png]]
630
631 Finish.
632
633
634 = 7.  How to store/get all data traffic for a specific sensor, including raw payload, and uplink/ downlink history. =
635
636
637 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.
638
639 This example will be shown how to store/get all the data in two ways:
640
641 **//1). Chirpstack ~-~-> Node-red//**
642
643
644 [[image:image-20221012184501-1.png]]
645
646
647 Use MQTT in Nore-red to subscribe to topics published by the chirpstack-application and then continuously write to a file
648
649 [[image:image-20221012174220-2.png]]
650
651
652 [[image:image-20221012184655-3.png||height="395" width="1049"]]
653
654
655 **Each message is continuously logged to a specified file**
656
657 [[image:image-20221012174352-3.png]]
658
659
660 **//2). MQTT  Sub//**
661
662 If you don't want to store the information via node-red, you can get the output via the subscribe command.
663
664
665 **If connecting from the same machine, you can use the following command to receive data:**
666
667 (% class="box infomessage" %)
668 (((
669 mosquitto_sub -h localhost -t "application/#" -v
670 )))
671
672
673 **Different host**
674
675 (% class="box infomessage" %)
676 (((
677 mosquitto_sub -h IPADDRESS -p 8883 ~-~-insecure ~-~-cafile ca.pem ~-~-cert cert.pem ~-~-key key.pem -t "application/#" -v
678 )))
679
680 [[image:image-20221012173639-1.png]]
681
682
683 = 8.  Trouble Shooting =
684
685 == 8.1  MIC Mismatch or MIC Failed ==
686
687
688 (((
689 When the device is registered or the device is working normally, the problem of MIC mismatch and MIC failed occurs.
690 )))
691
692 (((
693 Under normal circumstances, users need to change the APPKEY to solve this problem.
694
695
696
697
698 )))

Applications

Navigation

Copyright ©2010-2022 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0