Skip to Content

Wiki source code of Notes for ChirpStack

Version 108.5 by Xiaoling on 2022/07/23 13:54
Hide last authors
Xiaoling 108.4 1 **~ Table of Contents:**
Xiaoling 1.2 2
Xiaoling 1.1 3 {{toc/}}
4
Xiaoling 86.4 5
6
7
Xiaoling 108.4 8 = 1.  Introduction =
Xiaoling 1.1 9
Xiaoling 108.4 10
Kilight Cao 53.1 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/]]
Xiaoling 1.1 12
Xiaoling 1.5 13 (((
Kilight Cao 51.1 14 (% style="color:black" %)The dragino gateway can connect the ChirpStack server via Semtech UDP or Semtech Basic Station.
Xiaoling 108.4 15
16
Xiaoling 1.5 17 )))
Xiaoling 1.1 18
Xiaoling 108.4 19 (% style="color:blue" %)**Prerequisite:**
Xiaoling 1.1 20
Xiaoling 108.4 21 **1) Have a Chirstack Server.**
Xiaoling 1.1 22
Xiaoling 54.2 23 [[image:image-20220525100058-1.png]]
Xiaoling 1.1 24
Xiaoling 1.2 25 ChirpStack home page
Xiaoling 1.1 26
Xiaoling 54.2 27
Xiaoling 1.1 28
Xiaoling 108.4 29 **2) Gateway model support**
30
Xiaoling 1.2 31 (% class="box" %)
32 (((
Xiaoling 1.5 33 (((
Xiaoling 1.2 34 Semtech UDP : **All Model**
Xiaoling 108.4 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
Xiaoling 1.2 37 )))
Xiaoling 1.5 38 )))
Xiaoling 1.1 39
Xiaoling 86.5 40
41
Xiaoling 108.4 42 = 2.  Semtech UDP =
Xiaoling 1.1 43
Xiaoling 108.4 44 == 2.1  Step 1. Add the Network-servers ==
Xiaoling 1.1 45
Xiaoling 108.4 46
Xiaoling 1.2 47 The network-Servers address varies depending on the ChirpStack server setup environment
Xiaoling 1.1 48
Xiaoling 1.3 49 (% class="box" %)
50 (((
Xiaoling 108.5 51 Windows       ~-~->  Network-server server *  :  localhost:8000
52 Linux  ~-~->  Network-server server *  :  chirpstack-network-server:8000
Xiaoling 1.3 53 )))
Xiaoling 1.1 54
Xiaoling 108.4 55
Xiaoling 1.2 56 If the user cannot add network-Servers, re-check the ChirpStack code or the server building process.
Xiaoling 1.1 57
Xiaoling 108.4 58
Xiaoling 87.2 59 [[image:image-20220531171609-1.png]]
Xiaoling 1.2 60
61 Add the Network-servers
62
Xiaoling 84.2 63
Xiaoling 108.4 64
Xiaoling 1.2 65 == 2.2 Step 2. Create Gateway-profiles ==
66
Xiaoling 88.2 67 [[image:image-20220531171651-2.png]]
Xiaoling 1.2 68
69 Create Gateway-profiles
70
Xiaoling 84.2 71
Xiaoling 1.2 72 == 2.3 Step 3. Create Service-profiles ==
73
Xiaoling 89.2 74 [[image:image-20220531171809-3.png]]
Xiaoling 1.2 75
76 Create Service-profiles
77
Xiaoling 89.3 78
Xiaoling 1.2 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
Xiaoling 1.4 81 (% style="color:red" %)**Note : Before add the gateway, the user needs to complete the preceding three steps.**
Xiaoling 1.2 82
Xiaoling 84.2 83 If the user has completed the preceding steps, proceed to the next step.(% style="display:none" %)
Xiaoling 1.2 84
Xiaoling 84.2 85
Xiaoling 1.2 86 == 2.4 Step 4. Add the gateway ==
87
88 The example gateway id is: a840411e96744150
89
Xiaoling 1.5 90 (((
Xiaoling 1.4 91 (% style="color:red" %)**Note : The Gateway EUI and server addresses must match the ChirpStack configuration.**
Xiaoling 1.5 92 )))
Xiaoling 1.2 93
Xiaoling 90.2 94 [[image:image-20220531171923-4.png]](% style="display:none" %)
Xiaoling 1.2 95
Xiaoling 84.2 96
Xiaoling 1.2 97 Add the gateway
98
Xiaoling 91.2 99 [[image:image-20220531172031-5.png]]
Xiaoling 1.2 100
101 Configure the gateway
102
Xiaoling 84.2 103
Xiaoling 1.2 104 == 2.5 Step 5. Checking gateway Status ==
105
Xiaoling 92.2 106 [[image:image-20220531172158-6.png]](% style="display:none" %)
Xiaoling 1.2 107
Xiaoling 84.2 108
Xiaoling 1.2 109 gateway Status
110
Xiaoling 93.2 111 [[image:image-20220531172304-7.png]]
Xiaoling 1.2 112
113 gateway Status
114
Xiaoling 86.6 115
Kilight Cao 9.1 116 = 3. Gateway Registration for Basics Station =
Xiaoling 1.2 117
Xiaoling 93.3 118 == 3.1 Introduction ==
Kilight Cao 9.1 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
Xiaoling 86.7 137
Xiaoling 93.3 138 == 3.2 Add Gateway ==
Kilight Cao 9.1 139
Xiaoling 20.2 140 [[image:image-20220524164205-10.png]]
Kilight Cao 9.1 141
Xiaoling 86.8 142
Xiaoling 93.3 143 == 3.3 Access the gateway GUI ==
Kilight Cao 9.1 144
145 Access the gateway GUI interface of LoRaWAN~-~->LoRaWAN ~-~- Basic Station
146
Xiaoling 20.2 147 [[image:image-20220524164319-11.png]]
Kilight Cao 9.1 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" %)
Xiaoling 20.2 161 [[image:image-20220524164341-12.png]]
Kilight Cao 9.1 162
Xiaoling 86.9 163
Xiaoling 93.4 164 == 3.4 Start Station ==
Kilight Cao 9.1 165
166 When the user has finished the configuration, Please click Sace&Apply to start station to connect ChirpStack
167
Xiaoling 86.10 168
Xiaoling 93.4 169 == 3.5 Successful Connection ==
Kilight Cao 9.1 170
171 If user completes the above steps, which will see live date in the ChirpStack.
172
Xiaoling 23.2 173 [[image:image-20220524164448-13.png]]
Kilight Cao 9.1 174
Xiaoling 86.11 175
Xiaoling 93.4 176 == 3.6 Trouble Shooting ==
Kilight Cao 9.1 177
178 User can check the station log in the logread/system log page.
179
Xiaoling 95.2 180 [[image:image-20220531172837-8.png]]
Kilight Cao 9.1 181
Xiaoling 86.13 182
Kilight Cao 9.1 183 and recode the station log in the system/Recode log page.
184
Xiaoling 95.2 185 [[image:image-20220531172857-9.png]]
Kilight Cao 9.1 186
Xiaoling 86.12 187
Xiaoling 1.2 188 = 4. Downlink =
189
190 == 4.1 Chirpstack Downlink Note ==
191
Xiaoling 108.2 192 [[image:image-20220601102543-2.png]]
Xiaoling 1.2 193
194 Convert the data to Base64
195
Xiaoling 86.14 196
Xiaoling 96.2 197 [[image:image-20220531173236-10.png]]
Xiaoling 1.2 198
199 Check ChripStack downlink DataRate
200
Xiaoling 86.15 201
Xiaoling 65.2 202 [[image:image-20220525101326-11.png]]
Xiaoling 1.2 203
204 Make sure the RX2DR is the same in the end node
205
Xiaoling 86.16 206
Xiaoling 1.2 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
Xiaoling 1.5 211 (((
Xiaoling 1.2 212 Below is examples:
Xiaoling 1.5 213 )))
Xiaoling 1.2 214
Xiaoling 1.4 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
Xiaoling 1.2 220 User name: User name Password: password
Xiaoling 1.4 221 )))
Xiaoling 1.2 222
Xiaoling 97.2 223 [[image:image-20220531173419-11.png]]
Xiaoling 1.2 224
Xiaoling 1.5 225 (((
Xiaoling 1.2 226 MQTT Connect to ChirpStack
Xiaoling 86.17 227
228
Xiaoling 1.5 229 )))
Xiaoling 1.2 230
Xiaoling 1.5 231 (((
Xiaoling 1.2 232 After connect
Xiaoling 1.5 233 )))
Xiaoling 1.2 234
Xiaoling 1.4 235 (% class="box" %)
236 (((
237 Subscribe : Format：application/ID/device/ Device EUI/rx
Xiaoling 1.2 238 Example: application/7/device/00aedb3da649cb23/rx
Xiaoling 1.4 239 )))
Xiaoling 1.2 240
Xiaoling 1.4 241 (% class="box" %)
242 (((
243 Publish:
Xiaoling 1.2 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"}
Xiaoling 1.4 248 )))
Xiaoling 1.2 249
Xiaoling 98.2 250 [[image:image-20220531173519-12.png]]
Xiaoling 1.2 251
252 MQTT Connect to ChirpStack
253
Xiaoling 86.18 254
Xiaoling 1.4 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 )))
Xiaoling 1.2 258
Xiaoling 99.2 259 [[image:image-20220531173601-13.png]]
Xiaoling 1.2 260
261 Choose to Use Hex for Encode
262
Xiaoling 86.19 263
Xiaoling 1.2 264 If we want send downstream hex 030101 to end node, the BASE64 payload is AwEB
265
Xiaoling 100.2 266 [[image:image-20220531173658-14.png]]
Xiaoling 1.2 267
Xiaoling 1.5 268 (((
Xiaoling 1.2 269 Downlink payload encode javescript code: 可以在网站上运行以下Javsscript代码：
Xiaoling 1.5 270 )))
Xiaoling 1.2 271
Xiaoling 1.4 272 (% class="box" %)
273 (((
274 function sha1_to_base64(sha1)
Xiaoling 1.2 275 {
276 var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
277 var base64_rep = "";
278 var cnt = 0;
279 var bit_arr = 0;
280 var bit_num = 0;
Xiaoling 1.5 281 \\ for(var n = 0; n < sha1.length; ++n)
Xiaoling 1.2 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 }
Xiaoling 1.5 295 \\ bit_arr = (bit_arr << 4) | ascv;
Xiaoling 1.2 296 bit_num += 4;
297 if(bit_num >= 6)
298 {
Xiaoling 1.4 299 bit_num -= 6;        
Xiaoling 1.2 300 base64_rep += digits[bit_arr >>> bit_num];
Xiaoling 1.4 301 bit_arr &= ~~(-1 << bit_num);
Xiaoling 1.2 302 }
303 }
Xiaoling 1.5 304 \\ if(bit_num > 0)
Xiaoling 1.2 305 {
306 bit_arr <<= 6 - bit_num;
307 base64_rep += digits[bit_arr];
308 }
Xiaoling 1.5 309 \\ var padding = base64_rep.length % 4;   
310 \\ if(padding > 0)
Xiaoling 1.2 311 {
312 for(var n = 0; n < 4 - padding; ++n)
313 {
314 base64_rep += "=";
315 }
316 }
317 return base64_rep;
318 }
Xiaoling 1.5 319 \\console.log(sha1_to_base64("data"));
320 \\data is downlink payload required by end node.
Xiaoling 1.4 321 e.g console.log(sha1_to_base64("030101"));
322 ​result: AwEB     
Xiaoling 1.2 323 AwEB is the 0x030101's base 64 Encode.
Xiaoling 1.5 324 \\​e.g console.log(sha1_to_base64("030000"));
Xiaoling 1.4 325 ​result: AwAA     
326 AwAA is 0x030000's base 64 Encode.
327 )))
Xiaoling 1.2 328
Xiaoling 86.21 329
Xiaoling 1.2 330 == 4.3 Add the decode function in Chirpstack for the payload ==
331
332 User enters the payload code according to the steps.
333
Xiaoling 101.2 334 [[image:image-20220531173754-15.png]]
Xiaoling 1.2 335
336
Xiaoling 102.2 337 [[image:image-20220531173856-16.png]]
Xiaoling 1.2 338
Xiaoling 102.2 339
Xiaoling 106.2 340 [[image:image-20220531174120-20.png]]
Xiaoling 84.2 341
Xiaoling 105.2 342 [[image:image-20220531174046-19.png]]
Xiaoling 1.2 343
Xiaoling 86.22 344
Xiaoling 1.2 345 = 5. Multiply Uplink in ChirpStack =
346
Xiaoling 1.4 347 (((
Xiaoling 1.2 348 nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data.
Xiaoling 1.4 349 )))
Xiaoling 1.2 350
Xiaoling 1.4 351 (((
Xiaoling 1.2 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]]
Xiaoling 1.4 353 )))
Xiaoling 1.2 354
Xiaoling 86.2 355 [[image:image-20220526091912-7.png]]
Xiaoling 1.2 356
Xiaoling 1.5 357 (((
Xiaoling 1.2 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.
Xiaoling 1.5 359 )))
Xiaoling 1.2 360
Xiaoling 76.2 361 [[image:image-20220525104359-21.png]]
Xiaoling 1.2 362
Xiaoling 1.4 363 (((
Xiaoling 1.2 364 Above behaviour will cause the platform shows below two cases of error:
Xiaoling 1.4 365 )))
Xiaoling 1.2 366
Xiaoling 1.4 367 (((
Xiaoling 1.2 368 Error of duplicate Frame Counter
Xiaoling 1.4 369 )))
Xiaoling 1.2 370
Xiaoling 76.2 371 [[image:image-20220525104437-22.png]]
Xiaoling 1.2 372
Xiaoling 86.23 373
Xiaoling 1.2 374 Duplicate transmission in short time
375
Xiaoling 107.2 376 [[image:image-20220601102430-1.png]]
Xiaoling 1.2 377
Xiaoling 86.24 378
Xiaoling 1.2 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
Xiaoling 1.5 383 (((
Xiaoling 1.2 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.
Xiaoling 1.5 385 )))
Xiaoling 1.2 386
Xiaoling 79.2 387 [[image:image-20220525104532-24.png]]
Xiaoling 1.2 388
Xiaoling 86.25 389
Xiaoling 1.2 390 installation path:
391
Xiaoling 79.2 392 [[image:image-20220525104554-25.png]]
Xiaoling 1.2 393
Xiaoling 86.25 394
Xiaoling 1.5 395 (((
Xiaoling 1.2 396 2. Environment variable settings:.
Xiaoling 1.5 397 )))
Xiaoling 1.2 398
Xiaoling 1.5 399 (((
Xiaoling 1.2 400 1) Open Computer -> Properties -> Advanced System Settings -> Environment Variables and add a "new" system variable:
Xiaoling 1.5 401 )))
Xiaoling 1.2 402
Xiaoling 1.5 403 (((
Xiaoling 1.2 404 2)Set the variable name GOROOT and the variable value C:\Go\ (installation directory)
Xiaoling 1.5 405 )))
Xiaoling 1.2 406
Xiaoling 43.2 407 [[image:image-20220524165433-33.png]]
Xiaoling 1.2 408
Xiaoling 86.26 409
Xiaoling 1.2 410 3)Modify the system variable Path and add C:\Go\bin\:
411
Xiaoling 43.2 412 [[image:image-20220524165452-34.png]]
Xiaoling 1.2 413
Xiaoling 106.3 414
Xiaoling 1.2 415 User variable setting file generation directory: D:\go:
416
Xiaoling 43.2 417 [[image:image-20220524165517-35.png]]
Xiaoling 1.2 418
Xiaoling 86.27 419
Xiaoling 1.2 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
Xiaoling 48.2 424 [[image:image-20220524165540-36.png]]
Xiaoling 1.2 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
Xiaoling 48.2 428 [[image:image-20220524165557-37.png]]
Xiaoling 1.2 429
Xiaoling 86.28 430
Xiaoling 1.2 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
Xiaoling 48.2 453 [[image:image-20220524165623-38.png]]
Xiaoling 1.2 454
Xiaoling 86.29 455
Xiaoling 1.2 456 5. Add the plugin and run the plugin.
457
Xiaoling 1.5 458 (((
Xiaoling 1.2 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:
Xiaoling 1.5 460 )))
Xiaoling 1.2 461
Xiaoling 48.2 462 [[image:image-20220524165641-39.png]]
Xiaoling 1.2 463
Xiaoling 1.4 464 (((
Xiaoling 1.5 465 (((
Xiaoling 1.2 466 For example: adr_plugins=[“adr-setting”]
Xiaoling 1.4 467 )))
Xiaoling 1.5 468 )))
Xiaoling 1.2 469
Xiaoling 1.4 470 * (((
Xiaoling 1.5 471 (((
Xiaoling 1.4 472 Adding a single plugin format is adr_plugins=["filename"]
473 )))
Xiaoling 1.5 474 )))
Xiaoling 1.2 475
Xiaoling 1.4 476 * (((
Xiaoling 1.5 477 (((
Xiaoling 1.4 478 Adding multiple plugins The format is adr_plugins=["file name 1", "file name 2",...]
479 )))
Xiaoling 1.5 480 )))
Xiaoling 1.2 481
Xiaoling 1.4 482 (((
Xiaoling 1.5 483 (((
Xiaoling 1.2 484 Finally, re-run chirpstack-network-server.exe, and then select the plugin you just compiled in Device-profiles,
Xiaoling 1.4 485 )))
Xiaoling 1.5 486 )))
Xiaoling 1.2 487
Xiaoling 79.2 488 [[image:image-20220525104647-26.png]]
Xiaoling 1.2 489
490 Finish.
491
Xiaoling 86.30 492
Xiaoling 1.2 493 = 6. Trouble Shooting =
494
495 == 6.1 MIC Mismatch or MIC Failed ==
496
Xiaoling 1.4 497 (((
Xiaoling 1.2 498 When the device is registered or the device is working normally, the problem of MIC mismatch and MIC failed occurs.
Xiaoling 1.4 499 )))
Xiaoling 1.2 500
Xiaoling 1.4 501 (((
Xiaoling 1.2 502 Under normal circumstances, users need to change the APPKEY to solve this problem.
Xiaoling 1.4 503 )))