Skip to Content

Wiki source code of Notes for ChirpStack

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