Wiki source code of Notes for ChirpStack

Version 131.1 by Kilight Cao on 2022/12/22 14: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
42 = 2.  Semtech UDP =
43
44 == 2.1  Step 1. Add the Network-servers ==
45
46
47 The network-Servers address varies depending on the ChirpStack server setup environment
48
49 (% class="box" %)
50 (((
51 Windows       ~-~->  Network-server server *  :  localhost:8000
52 Linux  ~-~->  Network-server server *  :  chirpstack-network-server:8000
53 )))
54
55
56 (% style="color:red" %)**If the user cannot add network-Servers, re-check the ChirpStack code or the server building process.**
57
58
59 [[image:image-20220531171609-1.png]]
60
61 Add the Network-servers
62
63
64
65 == 2.2  Step 2. Create Gateway-profiles ==
66
67
68 [[image:image-20220531171651-2.png]]
69
70 Create Gateway-profiles
71
72
73
74 == 2.3  Step 3. Create Service-profiles ==
75
76
77 [[image:image-20220531171809-3.png]]
78
79 Create Service-profiles
80
81
82 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.
83
84 (% style="color:red" %)**Note : Before add the gateway, the user needs to complete the preceding three steps.**
85
86 If the user has completed the preceding steps, proceed to the next step.(% style="display:none" %)
87
88
89
90 == 2.4  Step 4. Add the gateway ==
91
92
93 The example gateway id is: a840411e96744150
94
95 (((
96 (% style="color:red" %)**Note : The Gateway EUI and server addresses must match the ChirpStack configuration.**
97
98
99 )))
100
101 [[image:image-20220531171923-4.png]](% style="display:none" %)
102
103 Add the gateway
104
105
106
107 [[image:image-20220531172031-5.png]]
108
109 Configure the gateway
110
111
112
113 == 2.5  Step 5. Checking gateway Status ==
114
115
116 [[image:image-20220531172158-6.png]](% style="display:none" %)
117
118
119
120 gateway Status
121
122 [[image:image-20220531172304-7.png]]
123
124 gateway Status
125
126
127
128 = 3.  Gateway Registration for Basics Station =
129
130 == 3.1  Introduction ==
131
132
133 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.
134
135 ChirpStack Open-Source LoRaWAN® Network Server needs to set up a configuration that can use Semtech BasicStation.
136
137
138 (% style="color:blue" %)**Below list the support products and Requirements:**
139
140 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]]
141 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/]]
142
143 (% style="color:blue" %)**How to set up chirpStack Basic Station**
144
145 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]]
146
147
148 (% style="color:blue" %)**What do you need to prepare**
149
150 A gateway that can access the internet normally
151
152
153 == 3.2  Add Gateway ==
154
155
156 [[image:image-20220524164205-10.png]]
157
158
159 == 3.3  Access the gateway GUI ==
160
161
162 Access the gateway GUI interface of LoRaWAN~-~->LoRaWAN ~-~- Basic Station
163
164 [[image:image-20220524164319-11.png]]
165
166
167 User need to Choose the ChirpStack/Senet ~-~- Basic Station , input Server URI and Upload the TLS Certificate
168
169 (% class="box" %)
170 (((
171 Service Provider  ~-~->  Choose the ChirpStack/Senet ~-~- Basic Station
172
173 LNS URI  ~-~->  Enter the LNS URI address, For example : wss:~/~/xxxx.chirpstack.com:433 or ws:~/~/xxxx.chirpstack.com:3001
174
175 LNS TLS trust  ~-~->  Upload the TLS Certificate
176 )))
177
178 (% class="wikigeneratedid" %)
179 [[image:image-20220524164341-12.png]]
180
181
182 == 3.4  Start Station ==
183
184
185 When the user has finished the configuration, Please click **Sace&Apply** to start station to connect ChirpStack.
186
187
188 == 3.5  Successful Connection ==
189
190
191 If user completes the above steps, which will see live date in the ChirpStack.
192
193 [[image:image-20220524164448-13.png]]
194
195
196 == 3.6  Trouble Shooting ==
197
198
199 User can check the station log in the logread/system log page.
200
201 [[image:image-20220531172837-8.png]]
202
203
204 and recode the station log in the system/Recode log page.
205
206 [[image:image-20220531172857-9.png]]
207
208
209 = 4. How the gateway connects to Chirpstack v4 via gateway-bridge =
210
211
212 (% style="color:blue" %)**Below list the support products and Requirements:**
213
214 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]]
215 1. Firmware version since: [[Chirpstack-gateway-bridge>>url:https://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/Chirpstack-gateway-bridge/]]
216
217 (% style="color:blue" %)**How to set up chirpStack Gateway-bridge**
218
219 Users can check out the ChirpStack gateway-bridge v4 [[link>>https://www.chirpstack.io/docs/chirpstack-gateway-bridge/install/dragino.html]]
220
221
222 (% style="color:blue" %)**What do you need to prepare**
223
224 A gateway that can access the internet normally
225
226 == 4.1 Configure Packet Forwarder ==
227
228 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
229
230 * In the **LoRaWAN** menu, click on **LoRaWAN ~-~- Semtech UDP**
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 **Save & Apply**.
238
239 [[image:image-20221222114220-2.png||height="748" width="931"]]
240
241
242 == 4.2 Configuring gateway frequency ==
243
244 Note: Gateway frequencies must match
245
246 [[image:image-20221222134830-3.png||height="408" width="923"]]
247
248
249 == 4.3 Modify the gateway-bridge configuration file ==
250
251
252 Run the gateway command line command to modify the gateway-bridge configuration file:
253
254 (% class="box infomessage" %)
255 (((
256 root@dragino-1d27d4:~~#  vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml
257 )))
258
259 [[image:image-20221222113302-1.png]]
260
261 [[image:image-20221222140203-4.png||height="875" width="806"]]
262
263
264 (% class="wikigeneratedid" id="H" %)
265 After the modification, run the following command: **/etc/init.d/chirpstack-gateway-bridge restart**
266
267 == 4.3 (Re)start and stop gateway-bridge ==
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 (% class="wikigeneratedid" %)
288 == 4.4 Successful Connection ==
289
290 [[image:image-20221222141754-5.png||height="488" width="1150"]]
291
292 [[image:image-20221222141830-6.png||height="582" width="1153"]]
293
294 = 5.  Downlink =
295
296 == 5.1 Convert HEX to Base64 ==
297
298
299 (% 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.**
300
301 **[[Online HEX to Base64 Converter>>https://base64.guru/converter/encode/hex]]:**
302
303 [[image:image-20221010193350-1.png]]
304
305
306
307 **[[Online Base64 to Hex converter>>https://base64.guru/converter/decode/hex]]**
308
309 [[image:image-20221010193621-2.png]]
310
311
312 == 5.2  Chirpstack Downlink Note ==
313
314
315 [[image:image-20220601102543-2.png]]
316
317 **Convert the data to Base64**
318
319 (% style="display:none" %) (%%)
320
321
322 [[image:image-20220531173236-10.png||height="597" width="1215"]]
323
324 **Check ChripStack downlink DataRate**
325
326
327
328 [[image:image-20220525101326-11.png]]
329
330 **Make sure the RX2DR is the same in the end node**
331
332
333 == 5.3  Loraserver Downlink Note ==
334
335
336 User can use MQTT to send downlink payload to ChirpStack to perform downstream to LoRaWAN End
337
338 (((
339 **Below is examples:**
340 )))
341
342 (% class="box" %)
343 (((
344 Connect to your server via MQTT：
345 MQTT Client ID: Any   
346 Protocol：mqtt/tcp   Server IP：loraserver_ip:1883
347 User name: User name Password: password
348 )))
349
350 [[image:image-20220531173419-11.png]]
351
352 (((
353 **MQTT Connect to ChirpStack**
354
355
356
357 )))
358
359 (((
360 **After connect**
361 )))
362
363 (% class="box" %)
364 (((
365 Subscribe : Format：application/ID/device/ Device EUI/rx
366 Example: application/7/device/00aedb3da649cb23/rx
367 )))
368
369 (% class="box" %)
370 (((
371 Publish:
372 Format: Top: application/ID/device/ Device EUI/tx
373 Payload: {"confirmed":true or false,"fPort":XX,"data":"xxxx"}
374 Example: Top: application/7/device/00aedb3da649cb23/tx
375 Payload: {"confirmed":true,"fPort":2,"data":"AwEB"}
376 )))
377
378 [[image:image-20220531173519-12.png]]
379
380 **MQTT Connect to ChirpStack**
381
382
383 **If we want to send downstream hex 030101 to end node, the BASE64 payload is AwEB**
384
385 [[image:image-20220531173658-14.png]]
386
387
388 (((
389 Downlink payload encode javescript code: 可以在网站上运行以下Javsscript代码：
390 )))
391
392 (% class="box" %)
393 (((
394 function sha1_to_base64(sha1)
395 {
396 var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
397 var base64_rep = "";
398 var cnt = 0;
399 var bit_arr = 0;
400 var bit_num = 0;
401 \\ for(var n = 0; n < sha1.length; ++n)
402 {
403 if(sha1[n] >= 'A' && sha1[n] <= 'Z')
404 {
405 ascv = sha1.charCodeAt( n ) - 55;
406 }
407 else if(sha1[n] >= 'a' && sha1[n] <= 'z')
408 {
409 ascv = sha1.charCodeAt( n ) - 87;
410 }
411 else
412 {
413 ascv = sha1.charCodeAt( n ) - 48;
414 }
415 \\ bit_arr = (bit_arr << 4) | ascv;
416 bit_num += 4;
417 if(bit_num >= 6)
418 {
419 bit_num -= 6;        
420 base64_rep += digits[bit_arr >>> bit_num];
421 bit_arr &= ~~(-1 << bit_num);
422 }
423 }
424 \\ if(bit_num > 0)
425 {
426 bit_arr <<= 6 - bit_num;
427 base64_rep += digits[bit_arr];
428 }
429 \\ var padding = base64_rep.length % 4;   
430 \\ if(padding > 0)
431 {
432 for(var n = 0; n < 4 - padding; ++n)
433 {
434 base64_rep += "=";
435 }
436 }
437 return base64_rep;
438 }
439 \\console.log(sha1_to_base64("data"));
440 \\data is downlink payload required by end node.
441 e.g console.log(sha1_to_base64("030101"));
442 ​result: AwEB     
443 AwEB is the 0x030101's base 64 Encode.
444 \\​e.g console.log(sha1_to_base64("030000"));
445 ​result: AwAA     
446 AwAA is 0x030000's base 64 Encode.
447 )))
448
449
450
451 == 4.3  Add the decode function in Chirpstack for the payload ==
452
453
454 User enters the payload code according to the steps.
455
456 [[image:image-20220531173754-15.png||height="474" width="1334"]]
457
458
459 [[image:image-20220531173856-16.png]]
460
461
462 [[image:image-20220531174120-20.png]]
463
464 [[image:image-20220531174046-19.png]]
465
466
467 = 6.  Multiply Uplink in ChirpStack =
468
469
470 (((
471 nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data.
472 )))
473
474 (((
475 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]]
476
477
478 )))
479
480 [[image:image-20220526091912-7.png||height="241" width="1336"]]
481
482
483 (((
484 nbtrans is a field of ADR message, in unconfirm mode, it tells end node how many time it needs to transmit for every frame.
485
486
487 )))
488
489 [[image:image-20220525104359-21.png]]
490
491 (((
492 Above behaviour will cause the platform shows below two cases of error:
493
494
495 )))
496
497 (((
498 Error of duplicate Frame Counter
499 )))
500
501 [[image:image-20220525104437-22.png]]
502
503
504
505 **Duplicate transmission in short time**
506
507 [[image:image-20220601102430-1.png||height="598" width="1319"]]
508
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 )))

Applications

Navigation

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