Wiki source code of Notes for ChirpStack

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