Wiki source code of Notes for ChirpStack

Version 113.1 by Xiaoye on 2022/10/12 17: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
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
131 == 3.1  Introduction ==
132
133
134 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.
135
136 ChirpStack Open-Source LoRaWAN® Network Server needs to set up a configuration that can use Semtech BasicStation.
137
138
139 (% style="color:blue" %)**Below list the support products and Requirements:**
140
141 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]]
142 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/]]
143
144 (% style="color:blue" %)**How to set up chirpStack Basic Station**
145
146 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]]
147
148
149 (% style="color:blue" %)**What do you need to prepare**
150
151 A gateway that can access the internet normally
152
153
154
155 == 3.2  Add Gateway ==
156
157
158 [[image:image-20220524164205-10.png]]
159
160
161 == 3.3  Access the gateway GUI ==
162
163
164 Access the gateway GUI interface of LoRaWAN~-~->LoRaWAN ~-~- Basic Station
165
166 [[image:image-20220524164319-11.png]]
167
168
169 User need to Choose the ChirpStack/Senet ~-~- Basic Station , input Server URI and Upload the TLS Certificate
170
171 (% class="box" %)
172 (((
173 Service Provider  ~-~->  Choose the ChirpStack/Senet ~-~- Basic Station
174
175 LNS URI  ~-~->  Enter the LNS URI address, For example : wss:~/~/xxxx.chirpstack.com:433 or ws:~/~/xxxx.chirpstack.com:3001
176
177 LNS TLS trust  ~-~->  Upload the TLS Certificate
178 )))
179
180 (% class="wikigeneratedid" %)
181 [[image:image-20220524164341-12.png]]
182
183
184 == 3.4  Start Station ==
185
186
187 When the user has finished the configuration, Please click **Sace&Apply** to start station to connect ChirpStack.
188
189
190 == 3.5  Successful Connection ==
191
192
193 If user completes the above steps, which will see live date in the ChirpStack.
194
195 [[image:image-20220524164448-13.png]]
196
197
198
199 == 3.6  Trouble Shooting ==
200
201
202 User can check the station log in the logread/system log page.
203
204 [[image:image-20220531172837-8.png]]
205
206
207 and recode the station log in the system/Recode log page.
208
209 [[image:image-20220531172857-9.png]]
210
211
212
213 = 4.  Downlink =
214
215 (% class="wikigeneratedid" %)
216 == 4.1 Convert HEX to Base64 ==
217
218 (% 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.**
219
220 [[Online HEX to Base64 Converter>>https://base64.guru/converter/encode/hex]]:
221
222 [[image:image-20221010193350-1.png]]
223
224
225 [[Online Base64 to Hex converter>>https://base64.guru/converter/decode/hex]]
226
227 [[image:image-20221010193621-2.png]]
228
229
230
231 == 4.2  Chirpstack Downlink Note ==
232
233
234 [[image:image-20220601102543-2.png]]
235
236 Convert the data to Base64
237
238
239 [[image:image-20220531173236-10.png]]
240
241 Check ChripStack downlink DataRate
242
243
244 [[image:image-20220525101326-11.png]]
245
246 Make sure the RX2DR is the same in the end node
247
248
249
250 == 4.3  Loraserver Downlink Note ==
251
252
253 User can use MQTT to send downlink payload to ChirpStack to perform downstream to LoRaWAN End
254
255 (((
256 **Below is examples:**
257 )))
258
259 (% class="box" %)
260 (((
261 Connect to your server via MQTT：
262 MQTT Client ID: Any   
263 Protocol：mqtt/tcp   Server IP：loraserver_ip:1883
264 User name: User name Password: password
265 )))
266
267 [[image:image-20220531173419-11.png]]
268
269 (((
270 MQTT Connect to ChirpStack
271
272
273
274 )))
275
276 (((
277 **After connect**
278 )))
279
280 (% class="box" %)
281 (((
282 Subscribe : Format：application/ID/device/ Device EUI/rx
283 Example: application/7/device/00aedb3da649cb23/rx
284 )))
285
286 (% class="box" %)
287 (((
288 Publish:
289 Format: Top: application/ID/device/ Device EUI/tx
290 Payload: {"confirmed":true or false,"fPort":XX,"data":"xxxx"}
291 Example: Top: application/7/device/00aedb3da649cb23/tx
292 Payload: {"confirmed":true,"fPort":2,"data":"AwEB"}
293 )))
294
295 [[image:image-20220531173519-12.png]]
296
297 MQTT Connect to ChirpStack
298
299
300 If we want to send downstream hex 030101 to end node, the BASE64 payload is AwEB
301
302 [[image:image-20220531173658-14.png]]
303
304
305 (((
306 Downlink payload encode javescript code: 可以在网站上运行以下Javsscript代码：
307 )))
308
309 (% class="box" %)
310 (((
311 function sha1_to_base64(sha1)
312 {
313 var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
314 var base64_rep = "";
315 var cnt = 0;
316 var bit_arr = 0;
317 var bit_num = 0;
318 \\ for(var n = 0; n < sha1.length; ++n)
319 {
320 if(sha1[n] >= 'A' && sha1[n] <= 'Z')
321 {
322 ascv = sha1.charCodeAt(n) - 55;
323 }
324 else if(sha1[n] >= 'a' && sha1[n] <= 'z')
325 {
326 ascv = sha1.charCodeAt(n) - 87;
327 }
328 else
329 {
330 ascv = sha1.charCodeAt(n) - 48;
331 }
332 \\ bit_arr = (bit_arr << 4) | ascv;
333 bit_num += 4;
334 if(bit_num >= 6)
335 {
336 bit_num -= 6;        
337 base64_rep += digits[bit_arr >>> bit_num];
338 bit_arr &= ~~(-1 << bit_num);
339 }
340 }
341 \\ if(bit_num > 0)
342 {
343 bit_arr <<= 6 - bit_num;
344 base64_rep += digits[bit_arr];
345 }
346 \\ var padding = base64_rep.length % 4;   
347 \\ if(padding > 0)
348 {
349 for(var n = 0; n < 4 - padding; ++n)
350 {
351 base64_rep += "=";
352 }
353 }
354 return base64_rep;
355 }
356 \\console.log(sha1_to_base64("data"));
357 \\data is downlink payload required by end node.
358 e.g console.log(sha1_to_base64("030101"));
359 ​result: AwEB     
360 AwEB is the 0x030101's base 64 Encode.
361 \\​e.g console.log(sha1_to_base64("030000"));
362 ​result: AwAA     
363 AwAA is 0x030000's base 64 Encode.
364 )))
365
366
367
368 == 4.3  Add the decode function in Chirpstack for the payload ==
369
370
371 User enters the payload code according to the steps.
372
373 [[image:image-20220531173754-15.png]]
374
375
376 [[image:image-20220531173856-16.png]]
377
378
379 [[image:image-20220531174120-20.png]]
380
381 [[image:image-20220531174046-19.png]]
382
383
384
385 = 5.  Multiply Uplink in ChirpStack =
386
387
388 (((
389 nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data.
390 )))
391
392 (((
393 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]]
394
395
396 )))
397
398 [[image:image-20220526091912-7.png]]
399
400
401 (((
402 nbtrans is a field of ADR message, in unconfirm mode, it tells end node how many time it needs to transmit for every frame.
403
404
405 )))
406
407 [[image:image-20220525104359-21.png]]
408
409 (((
410 Above behaviour will cause the platform shows below two cases of error:
411
412
413 )))
414
415 (((
416 Error of duplicate Frame Counter
417 )))
418
419 [[image:image-20220525104437-22.png]]
420
421
422
423 Duplicate transmission in short time
424
425 [[image:image-20220601102430-1.png]]
426
427
428
429 == 5.1  Solution ==
430
431
432 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]]
433
434
435 (((
436 (% 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.**
437
438
439 )))
440
441 [[image:image-20220525104532-24.png]]
442
443
444 **installation path:**
445
446 [[image:image-20220525104554-25.png]]
447
448
449
450 (((
451 (% style="color:blue" %)**2.  Environment variable settings:**
452 )))
453
454 (((
455 1) Open Computer -> Properties -> Advanced System Settings -> Environment Variables and add a "new" system variable:
456 )))
457
458 (((
459 2) Set the variable name GOROOT and the variable value C:\Go\ (installation directory)
460 )))
461
462 [[image:image-20220524165433-33.png]]
463
464
465 3) Modify the system variable Path and add C:\Go\bin\:
466
467 [[image:image-20220524165452-34.png]]
468
469
470 User variable setting file generation directory: D:\go:
471
472 [[image:image-20220524165517-35.png]]
473
474
475
476 (% 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.**
477
478 The name of the plugin: Example ADR plugin:
479
480 [[image:image-20220524165540-36.png]]
481
482 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.
483
484 [[image:image-20220524165557-37.png]]
485
486
487
488 (% style="color:blue" %)**4.  Compile the ADR configuration file and generate the exe file.**
489
490 1) Create a folder named adr-setting
491
492 2) Open the adr-setting folder
493
494 3) Put adr.setting.go in this folder.
495
496 4) Open the computer cmd and run the following commands in sequencecd adr-setting
497
498 go mod init adr-setting
499
500 go get github.com/brocaar/chirpstack-network-server/v3/adr
501
502 go get github.com/hashicorp/go-plugin
503
504 go get adr-setting
505
506 go build
507
508 5) Finally generate this file：
509
510 [[image:image-20220524165623-38.png]]
511
512
513
514 (% style="color:blue" %)**5.  Add the plugin and run the plugin.**
515
516 (((
517 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:
518 )))
519
520 [[image:image-20220524165641-39.png]]
521
522 (((
523 (((
524 For example: adr_plugins=[“adr-setting”]
525 )))
526 )))
527
528 * (((
529 (((
530 Adding a single plugin format is adr_plugins=["filename"]
531 )))
532 )))
533
534 * (((
535 (((
536 Adding multiple plugins The format is adr_plugins=["file name 1", "file name 2",...]
537 )))
538 )))
539
540 (((
541 (((
542 Finally, re-run chirpstack-network-server.exe, and then select the plugin you just compiled in Device-profiles,
543 )))
544 )))
545
546 [[image:image-20220525104647-26.png]]
547
548 Finish.
549
550
551
552 = 6.  Trouble Shooting =
553
554 == 6.1  MIC Mismatch or MIC Failed ==
555
556
557 (((
558 When the device is registered or the device is working normally, the problem of MIC mismatch and MIC failed occurs.
559 )))
560
561 (((
562 Under normal circumstances, users need to change the APPKEY to solve this problem.
563 )))

Applications

Navigation

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