Wiki source code of Notes for ChirpStack

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

Applications

Navigation

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