Skip to Content

Wiki source code of Notes for ChirpStack

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