Wiki source code of Notes for ChirpStack

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

Applications

Navigation

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