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