Skip to Content

Wiki source code of Notes for ChirpStack

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