Skip to Content

Wiki source code of Notes for ChirpStack

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