Skip to Content

Wiki source code of Notes for ChirpStack

Version 138.1 by Kilight Cao on 2023/04/15 17:15
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
Xiaoling 108.4 41 = 2.  Semtech UDP =
Xiaoling 1.1 42
Xiaoling 108.4 43 == 2.1  Step 1. Add the Network-servers ==
Xiaoling 1.1 44
Xiaoling 108.4 45
Xiaoling 1.2 46 The network-Servers address varies depending on the ChirpStack server setup environment
Xiaoling 1.1 47
Xiaoling 1.3 48 (% class="box" %)
49 (((
Xiaoling 108.5 50 Windows       ~-~->  Network-server server *  :  localhost:8000
51 Linux  ~-~->  Network-server server *  :  chirpstack-network-server:8000
Xiaoling 1.3 52 )))
Xiaoling 1.1 53
Xiaoling 108.4 54
Xiaoling 108.6 55 (% style="color:red" %)**If the user cannot add network-Servers, re-check the ChirpStack code or the server building process.**
Xiaoling 1.1 56
Xiaoling 108.4 57
Xiaoling 87.2 58 [[image:image-20220531171609-1.png]]
Xiaoling 1.2 59
60 Add the Network-servers
61
Xiaoling 84.2 62
Xiaoling 108.6 63 == 2.2  Step 2. Create Gateway-profiles ==
Xiaoling 1.2 64
Xiaoling 108.6 65
Xiaoling 88.2 66 [[image:image-20220531171651-2.png]]
Xiaoling 1.2 67
68 Create Gateway-profiles
69
Xiaoling 84.2 70
Xiaoling 108.6 71 == 2.3  Step 3. Create Service-profiles ==
72
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 108.7 86 == 2.4  Step 4. Add the gateway ==
Xiaoling 1.2 87
Xiaoling 108.7 88
Xiaoling 1.2 89 The example gateway id is: a840411e96744150
90
Xiaoling 1.5 91 (((
Xiaoling 1.4 92 (% style="color:red" %)**Note : The Gateway EUI and server addresses must match the ChirpStack configuration.**
Xiaoling 108.7 93
94
Xiaoling 1.5 95 )))
Xiaoling 1.2 96
Xiaoling 90.2 97 [[image:image-20220531171923-4.png]](% style="display:none" %)
Xiaoling 1.2 98
99 Add the gateway
100
Xiaoling 108.7 101
102
Xiaoling 91.2 103 [[image:image-20220531172031-5.png]]
Xiaoling 1.2 104
105 Configure the gateway
106
Xiaoling 84.2 107
Xiaoling 108.8 108 == 2.5  Step 5. Checking gateway Status ==
109
110
Xiaoling 92.2 111 [[image:image-20220531172158-6.png]](% style="display:none" %)
Xiaoling 1.2 112
Xiaoling 84.2 113
Xiaoling 108.8 114
Xiaoling 1.2 115 gateway Status
116
Xiaoling 93.2 117 [[image:image-20220531172304-7.png]]
Xiaoling 1.2 118
119 gateway Status
120
Xiaoling 86.6 121
Xiaoling 108.9 122 = 3.  Gateway Registration for Basics Station =
Xiaoling 1.2 123
Xiaoling 108.9 124 == 3.1  Introduction ==
Kilight Cao 9.1 125
Xiaoling 108.8 126
Kilight Cao 9.1 127 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.
128
129 ChirpStack Open-Source LoRaWAN® Network Server needs to set up a configuration that can use Semtech BasicStation.
130
131
Xiaoling 108.8 132 (% style="color:blue" %)**Below list the support products and Requirements:**
133
Kilight Cao 9.1 134 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]]
135 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/]]
136
Xiaoling 108.8 137 (% style="color:blue" %)**How to set up chirpStack Basic Station**
138
Kilight Cao 9.1 139 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]]
140
141
Xiaoling 108.8 142 (% style="color:blue" %)**What do you need to prepare**
143
Kilight Cao 9.1 144 A gateway that can access the internet normally
145
Xiaoling 86.7 146
Xiaoling 108.9 147 == 3.2  Add Gateway ==
Kilight Cao 9.1 148
Xiaoling 108.9 149
Xiaoling 20.2 150 [[image:image-20220524164205-10.png]]
Kilight Cao 9.1 151
Xiaoling 86.8 152
Xiaoling 108.9 153 == 3.3  Access the gateway GUI ==
Kilight Cao 9.1 154
Xiaoling 108.9 155
Kilight Cao 9.1 156 Access the gateway GUI interface of LoRaWAN~-~->LoRaWAN ~-~- Basic Station
157
Xiaoling 20.2 158 [[image:image-20220524164319-11.png]]
Kilight Cao 9.1 159
Xiaoling 108.9 160
Kilight Cao 9.1 161 User need to Choose the ChirpStack/Senet ~-~- Basic Station , input Server URI and Upload the TLS Certificate
162
163 (% class="box" %)
164 (((
165 Service Provider  ~-~->  Choose the ChirpStack/Senet ~-~- Basic Station
166
167 LNS URI  ~-~->  Enter the LNS URI address, For example : wss:~/~/xxxx.chirpstack.com:433 or ws:~/~/xxxx.chirpstack.com:3001
168
169 LNS TLS trust  ~-~->  Upload the TLS Certificate
170 )))
171
172 (% class="wikigeneratedid" %)
Xiaoling 20.2 173 [[image:image-20220524164341-12.png]]
Kilight Cao 9.1 174
Xiaoling 86.9 175
Xiaoling 108.9 176 == 3.4  Start Station ==
Kilight Cao 9.1 177
Xiaoling 108.9 178
Xiaoling 108.14 179 When the user has finished the configuration, Please click **Sace&Apply** to start station to connect ChirpStack.
Kilight Cao 9.1 180
Xiaoling 86.10 181
Xiaoling 108.9 182 == 3.5  Successful Connection ==
Kilight Cao 9.1 183
Xiaoling 108.9 184
Kilight Cao 9.1 185 If user completes the above steps, which will see live date in the ChirpStack.
186
Xiaoling 23.2 187 [[image:image-20220524164448-13.png]]
Kilight Cao 9.1 188
Xiaoling 86.11 189
Xiaoling 108.9 190 == 3.6  Trouble Shooting ==
191
192
Kilight Cao 9.1 193 User can check the station log in the logread/system log page.
194
Xiaoling 95.2 195 [[image:image-20220531172837-8.png]]
Kilight Cao 9.1 196
Xiaoling 86.13 197
Kilight Cao 9.1 198 and recode the station log in the system/Recode log page.
199
Xiaoling 95.2 200 [[image:image-20220531172857-9.png]]
Kilight Cao 9.1 201
Xiaoling 86.12 202
Kilight Cao 138.1 203 = 4.  How the gateway connects to Chirpstack v3 via gateway-bridge =
Xiaoling 108.9 204
Xiaoling 1.2 205
Kilight Cao 128.1 206 (% style="color:blue" %)**Below list the support products and Requirements:**
207
208 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]],[[LPS8N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/200-lps8n.html]],[[LG308N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/229-lg308n.html]],[[DLOS8N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/225-dlos8n.html]]
Kilight Cao 138.1 209 1. Firmware version since: [[Chirpstack-Bridge-V3.14.6>>https://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/Chirpstack-gateway-bridge/Chirpstack-Bridge-V3.14.6-Bridge--build-v5.4.1679487778-20230322-2024/]]
Kilight Cao 128.1 210
211 (% style="color:blue" %)**How to set up chirpStack Gateway-bridge**
212
Kilight Cao 138.1 213 Users can check out the ChirpStack gateway-bridge v3 [[link>>https://www.chirpstack.io/gateway-bridge/gateway/dragino/]]
Kilight Cao 128.1 214
215
216 (% style="color:blue" %)**What do you need to prepare**
217
218 A gateway that can access the internet normally
219
Xiaoling 1.2 220
Kilight Cao 138.1 221 The following example does not have configuration certificates:
222
Xiaoling 131.2 223 == 4.1  Configure Packet Forwarder ==
224
225
Kilight Cao 124.1 226 In the Dragino gateway web interface, you need to configure the Packet Forwarder so that it forwards its data to the port. localhost:1700 or 127.0.0.1:1700
Xiaoling 121.2 227
Kilight Cao 124.1 228 * In the **LoRaWAN** menu, click on **LoRaWAN ~-~- Semtech UDP**
229 * Make sure the following settings are set:
230 ** **Service Provider:** //~-~-Custom/Private LoRaWAN~-~-//
231 ** **LoRaWAN Server Address:** //localhost or 127.0.0.1//
232 ** **Server port for upstream:** //1700//
233 ** **Server port for downstream:** //1700//
234
235 Click **Save & Apply**.
236
237 [[image:image-20221222114220-2.png||height="748" width="931"]]
238
239
Xiaoling 131.2 240 == 4.2  Configuring gateway frequency ==
Kilight Cao 124.1 241
Kilight Cao 127.1 242
Xiaoling 131.2 243 (% style="color:red" %)**Note: Gateway frequencies must match**
244
Kilight Cao 127.1 245 [[image:image-20221222134830-3.png||height="408" width="923"]]
246
247
Kilight Cao 138.1 248 == 4.3  Generate and modify the gateway-bridge configuration file ==
Kilight Cao 127.1 249
250
Kilight Cao 138.1 251 **1）Generate the gateway-bridge configuration file**
252
253 By default, the configuration file is not up-to-date,so the user needs to rebuild the gateway-bridge configuration file.
254
255 Users need to access the command line of the gateway through SSH,Then type the following command:
256
257 (% class="box infomessage" %)
258 (((
259 /opt/chirpstack-gateway-bridge/chirpstack-gateway-bridge configfile > /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml
260 )))
261
262
263 **2）modify the gateway-bridge configuration file**
264
265 The user needs to modify the server address in line 252 in the configuration file
266
267 (% class="box infomessage" %)
268 (((
269 vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml
270 )))
271
272 [[image:image-20230415165254-1.png||height="583" width="956"]]
273
274
275 == 4.4  Debug ==
276
277
278 After the above configuration is completed, the user can enter the command to debug the gateway-bridge connection
279
280 (% class="box infomessage" %)
281 (((
282 /opt/chirpstack-gateway-bridge/chirpstack-gateway-bridge ~-~-config /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml
283 )))
284
285 If the gateway-bridge connection is normal, the debug log displays **"connected to mqtt broker"**.
286
287 [[image:image-20230415170404-2.png]]
288
289
290 If the debug log shows "**connection error**", check that the server port or server is correct
291
292 [[image:image-20230415170854-3.png]]
293
294
295 More information can be found on the **[[ChirpStack website>>https://www.chirpstack.io/docs/]]**or **[[Forum>>url:https://forum.chirpstack.io/]]**
296
297
298 == 4.5  (Re)start and stop gateway-bridge ==
299
300
301 Use the following commands to (re)start and stop the ChirpStack Gateway Bridge Service:
302
303 (% class="box infomessage" %)
304 (((
305 **# start**
306
307 /etc/init.d/chirpstack-gateway-bridge start
308
309 **# stop**
310
311 /etc/init.d/chirpstack-gateway-bridge stop
312
313 **# restart**
314
315 /etc/init.d/chirpstack-gateway-bridge restart
316 )))
317
318
319 = 5.  How the gateway connects to Chirpstack v4 via gateway-bridge =
320
321
322 (% style="color:blue" %)**Below list the support products and Requirements:**
323
324 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]],[[LPS8N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/200-lps8n.html]],[[LG308N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/229-lg308n.html]],[[DLOS8N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/225-dlos8n.html]]
325 1. Firmware version since: [[Chirpstack-Bridge-V4>>https://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/Chirpstack-gateway-bridge/Chirpstack-Bridge-V4--build-v5.4.1670655072-20221210-1452/]]
326
327 (% style="color:blue" %)**How to set up chirpStack Gateway-bridge**
328
329 Users can check out the ChirpStack gateway-bridge v4 [[link>>https://www.chirpstack.io/docs/chirpstack-gateway-bridge/install/dragino.html]]
330
331
332 (% style="color:blue" %)**What do you need to prepare**
333
334 A gateway that can access the internet normally
335
336
337 == 5.1  Configure Packet Forwarder ==
338
339
340 In the Dragino gateway web interface, you need to configure the Packet Forwarder so that it forwards its data to the port. localhost:1700 or 127.0.0.1:1700
341
342 * In the **LoRaWAN** menu, click on **LoRaWAN ~-~- Semtech UDP**
343 * Make sure the following settings are set:
344 ** **Service Provider:** //~-~-Custom/Private LoRaWAN~-~-//
345 ** **LoRaWAN Server Address:** //localhost or 127.0.0.1//
346 ** **Server port for upstream:** //1700//
347 ** **Server port for downstream:** //1700//
348
349 Click **Save & Apply**.
350
351 [[image:image-20221222114220-2.png||height="748" width="931"]]
352
353
354 == 5.2  Configuring gateway frequency ==
355
356
357 (% style="color:red" %)**Note: Gateway frequencies must match**
358
359 [[image:image-20221222134830-3.png||height="408" width="923"]]
360
361
362 == 5.3  Modify the gateway-bridge configuration file ==
363
364
Kilight Cao 127.1 365 Run the gateway command line command to modify the gateway-bridge configuration file:
366
367 (% class="box infomessage" %)
368 (((
369 root@dragino-1d27d4:~~#  vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml
370 )))
371
Kilight Cao 124.1 372 [[image:image-20221222113302-1.png]]
373
Xiaoling 131.2 374
Kilight Cao 127.1 375 [[image:image-20221222140203-4.png||height="875" width="806"]]
376
Kilight Cao 133.1 377 [[image:image-20221230094246-1.png||height="768" width="783"]]
Kilight Cao 127.1 378
379 (% class="wikigeneratedid" id="H" %)
380 After the modification, run the following command: **/etc/init.d/chirpstack-gateway-bridge restart**
381
382
Kilight Cao 138.1 383 == 5.4  (Re)start and stop gateway-bridge ==
Xiaoling 131.2 384
385
Kilight Cao 127.1 386 Use the following commands to (re)start and stop the ChirpStack Gateway Bridge Service:
387
388 (% class="box infomessage" %)
389 (((
390 **# start**
391
392 /etc/init.d/chirpstack-gateway-bridge start
393
394 **# stop**
395
396 /etc/init.d/chirpstack-gateway-bridge stop
397
398 **# restart**
399
400 /etc/init.d/chirpstack-gateway-bridge restart
401 )))
402
Kilight Cao 131.1 403
Kilight Cao 138.1 404 == 5.5  Successful Connection ==
Kilight Cao 131.1 405
Xiaoling 131.2 406
Kilight Cao 131.1 407 [[image:image-20221222141754-5.png||height="488" width="1150"]]
408
Xiaoling 131.2 409
Kilight Cao 131.1 410 [[image:image-20221222141830-6.png||height="582" width="1153"]]
411
Xiaoling 131.2 412
Kilight Cao 138.1 413 = 6.  Downlink =
Kilight Cao 124.1 414
Kilight Cao 138.1 415 == 6.1  Convert HEX to Base64 ==
Kilight Cao 124.1 416
417
Edwin Chen 111.1 418 (% style="color:red" %)**Note: Chirpstack uses base64 to downlink, the end node user manual provides HEX format of the downlink commands. So user needs to convert the HEX to Base64.**
Xiaoling 108.9 419
Xiaoling 121.2 420 **[[Online HEX to Base64 Converter>>https://base64.guru/converter/encode/hex]]:**
Edwin Chen 111.1 421
422 [[image:image-20221010193350-1.png]]
423
424
425
Xiaoling 121.2 426 **[[Online Base64 to Hex converter>>https://base64.guru/converter/decode/hex]]**
427
Edwin Chen 111.1 428 [[image:image-20221010193621-2.png]]
429
430
Kilight Cao 138.1 431 == 6.2  Chirpstack Downlink Note ==
Edwin Chen 111.1 432
433
Xiaoling 108.2 434 [[image:image-20220601102543-2.png]]
Xiaoling 1.2 435
Xiaoling 121.2 436 **Convert the data to Base64**
Xiaoling 1.2 437
Xiaoling 121.2 438 (% style="display:none" %) (%%)
Xiaoling 86.14 439
Xiaoling 1.2 440
Xiaoling 121.2 441 [[image:image-20220531173236-10.png||height="597" width="1215"]]
Xiaoling 1.2 442
Xiaoling 121.2 443 **Check ChripStack downlink DataRate**
Xiaoling 86.15 444
Xiaoling 121.2 445
446
Xiaoling 65.2 447 [[image:image-20220525101326-11.png]]
Xiaoling 1.2 448
Xiaoling 121.2 449 **Make sure the RX2DR is the same in the end node**
Xiaoling 1.2 450
Xiaoling 86.16 451
Kilight Cao 138.1 452 == 6.3  Loraserver Downlink Note ==
Xiaoling 108.9 453
454
Xiaoling 1.2 455 User can use MQTT to send downlink payload to ChirpStack to perform downstream to LoRaWAN End
456
Xiaoling 1.5 457 (((
Xiaoling 108.9 458 **Below is examples:**
Xiaoling 1.5 459 )))
Xiaoling 1.2 460
Xiaoling 1.4 461 (% class="box" %)
462 (((
463 Connect to your server via MQTT：
464 MQTT Client ID: Any   
465 Protocol：mqtt/tcp   Server IP：loraserver_ip:1883
Xiaoling 1.2 466 User name: User name Password: password
Xiaoling 1.4 467 )))
Xiaoling 1.2 468
Xiaoling 97.2 469 [[image:image-20220531173419-11.png]]
Xiaoling 1.2 470
Xiaoling 1.5 471 (((
Xiaoling 121.2 472 **MQTT Connect to ChirpStack**
Xiaoling 86.17 473
Xiaoling 108.9 474
Xiaoling 86.17 475
Xiaoling 1.5 476 )))
Xiaoling 1.2 477
Xiaoling 1.5 478 (((
Xiaoling 108.9 479 **After connect**
Xiaoling 1.5 480 )))
Xiaoling 1.2 481
Xiaoling 1.4 482 (% class="box" %)
483 (((
484 Subscribe : Format：application/ID/device/ Device EUI/rx
Xiaoling 1.2 485 Example: application/7/device/00aedb3da649cb23/rx
Xiaoling 1.4 486 )))
Xiaoling 1.2 487
Xiaoling 1.4 488 (% class="box" %)
489 (((
490 Publish:
Xiaoling 1.2 491 Format: Top: application/ID/device/ Device EUI/tx
492 Payload: {"confirmed":true or false,"fPort":XX,"data":"xxxx"}
493 Example: Top: application/7/device/00aedb3da649cb23/tx
494 Payload: {"confirmed":true,"fPort":2,"data":"AwEB"}
Xiaoling 1.4 495 )))
Xiaoling 1.2 496
Xiaoling 98.2 497 [[image:image-20220531173519-12.png]]
Xiaoling 1.2 498
Xiaoling 121.2 499 **MQTT Connect to ChirpStack**
Xiaoling 1.2 500
Xiaoling 86.18 501
Xiaoling 121.2 502 **If we want to send downstream hex 030101 to end node, the BASE64 payload is AwEB**
Xiaoling 1.2 503
Xiaoling 100.2 504 [[image:image-20220531173658-14.png]]
Xiaoling 1.2 505
Xiaoling 108.9 506
Xiaoling 1.5 507 (((
Xiaoling 1.2 508 Downlink payload encode javescript code: 可以在网站上运行以下Javsscript代码：
Xiaoling 1.5 509 )))
Xiaoling 1.2 510
Xiaoling 1.4 511 (% class="box" %)
512 (((
513 function sha1_to_base64(sha1)
Xiaoling 1.2 514 {
515 var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
516 var base64_rep = "";
517 var cnt = 0;
518 var bit_arr = 0;
519 var bit_num = 0;
Xiaoling 1.5 520 \\ for(var n = 0; n < sha1.length; ++n)
Xiaoling 1.2 521 {
522 if(sha1[n] >= 'A' && sha1[n] <= 'Z')
523 {
Jean-Philippe Gagné 121.1 524 ascv = sha1.charCodeAt( n ) - 55;
Xiaoling 1.2 525 }
526 else if(sha1[n] >= 'a' && sha1[n] <= 'z')
527 {
Jean-Philippe Gagné 121.1 528 ascv = sha1.charCodeAt( n ) - 87;
Xiaoling 1.2 529 }
530 else
531 {
Jean-Philippe Gagné 121.1 532 ascv = sha1.charCodeAt( n ) - 48;
Xiaoling 1.2 533 }
Xiaoling 1.5 534 \\ bit_arr = (bit_arr << 4) | ascv;
Xiaoling 1.2 535 bit_num += 4;
536 if(bit_num >= 6)
537 {
Xiaoling 1.4 538 bit_num -= 6;        
Xiaoling 1.2 539 base64_rep += digits[bit_arr >>> bit_num];
Xiaoling 1.4 540 bit_arr &= ~~(-1 << bit_num);
Xiaoling 1.2 541 }
542 }
Xiaoling 1.5 543 \\ if(bit_num > 0)
Xiaoling 1.2 544 {
545 bit_arr <<= 6 - bit_num;
546 base64_rep += digits[bit_arr];
547 }
Xiaoling 1.5 548 \\ var padding = base64_rep.length % 4;   
549 \\ if(padding > 0)
Xiaoling 1.2 550 {
551 for(var n = 0; n < 4 - padding; ++n)
552 {
553 base64_rep += "=";
554 }
555 }
556 return base64_rep;
557 }
Xiaoling 1.5 558 \\console.log(sha1_to_base64("data"));
559 \\data is downlink payload required by end node.
Xiaoling 1.4 560 e.g console.log(sha1_to_base64("030101"));
561 ​result: AwEB     
Xiaoling 1.2 562 AwEB is the 0x030101's base 64 Encode.
Xiaoling 1.5 563 \\​e.g console.log(sha1_to_base64("030000"));
Xiaoling 1.4 564 ​result: AwAA     
565 AwAA is 0x030000's base 64 Encode.
566 )))
Xiaoling 1.2 567
Xiaoling 86.21 568
Kilight Cao 138.1 569 == 6.3  Add the decode function in Chirpstack for the payload ==
Xiaoling 108.9 570
571
Xiaoling 1.2 572 User enters the payload code according to the steps.
573
Xiaoling 121.2 574 [[image:image-20220531173754-15.png||height="474" width="1334"]]
Xiaoling 1.2 575
576
Xiaoling 102.2 577 [[image:image-20220531173856-16.png]]
Xiaoling 1.2 578
Xiaoling 102.2 579
Xiaoling 106.2 580 [[image:image-20220531174120-20.png]]
Xiaoling 84.2 581
Xiaoling 105.2 582 [[image:image-20220531174046-19.png]]
Xiaoling 1.2 583
Xiaoling 86.22 584
Kilight Cao 138.1 585 = 7.  Multiply Uplink in ChirpStack =
Xiaoling 108.9 586
587
Xiaoling 1.4 588 (((
Xiaoling 1.2 589 nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data.
Xiaoling 1.4 590 )))
Xiaoling 1.2 591
Xiaoling 1.4 592 (((
Xiaoling 1.2 593 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 108.9 594
595
Xiaoling 1.4 596 )))
Xiaoling 1.2 597
Xiaoling 121.2 598 [[image:image-20220526091912-7.png||height="241" width="1336"]]
Xiaoling 1.2 599
Xiaoling 108.9 600
Xiaoling 1.5 601 (((
Xiaoling 1.2 602 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 108.9 603
604
Xiaoling 1.5 605 )))
Xiaoling 1.2 606
Xiaoling 76.2 607 [[image:image-20220525104359-21.png]]
Xiaoling 1.2 608
Xiaoling 1.4 609 (((
Xiaoling 1.2 610 Above behaviour will cause the platform shows below two cases of error:
Xiaoling 108.9 611
612
Xiaoling 1.4 613 )))
Xiaoling 1.2 614
Xiaoling 1.4 615 (((
Xiaoling 1.2 616 Error of duplicate Frame Counter
Xiaoling 1.4 617 )))
Xiaoling 1.2 618
Xiaoling 76.2 619 [[image:image-20220525104437-22.png]]
Xiaoling 1.2 620
Xiaoling 86.23 621
Xiaoling 108.9 622
Xiaoling 121.2 623 **Duplicate transmission in short time**
Xiaoling 1.2 624
Xiaoling 121.2 625 [[image:image-20220601102430-1.png||height="598" width="1319"]]
Xiaoling 1.2 626
Xiaoling 86.24 627
Kilight Cao 138.1 628 == 7.1  Solution ==
Xiaoling 108.9 629
630
Xiaoling 1.2 631 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]]
632
Xiaoling 108.9 633
Xiaoling 1.5 634 (((
Xiaoling 108.11 635 (% style="color:blue" %)**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 108.9 636
637
Xiaoling 1.5 638 )))
Xiaoling 1.2 639
Xiaoling 79.2 640 [[image:image-20220525104532-24.png]]
Xiaoling 1.2 641
Xiaoling 86.25 642
Xiaoling 108.9 643 **installation path:**
Xiaoling 1.2 644
Xiaoling 79.2 645 [[image:image-20220525104554-25.png]]
Xiaoling 1.2 646
Xiaoling 86.25 647
Xiaoling 108.9 648
Xiaoling 1.5 649 (((
Xiaoling 108.11 650 (% style="color:blue" %)**2.  Environment variable settings:**
Xiaoling 1.5 651 )))
Xiaoling 1.2 652
Xiaoling 1.5 653 (((
Xiaoling 1.2 654 1) Open Computer -> Properties -> Advanced System Settings -> Environment Variables and add a "new" system variable:
Xiaoling 1.5 655 )))
Xiaoling 1.2 656
Xiaoling 1.5 657 (((
Xiaoling 108.9 658 2) Set the variable name GOROOT and the variable value C:\Go\ (installation directory)
Xiaoling 1.5 659 )))
Xiaoling 1.2 660
Xiaoling 43.2 661 [[image:image-20220524165433-33.png]]
Xiaoling 1.2 662
Xiaoling 86.26 663
Xiaoling 108.9 664 3) Modify the system variable Path and add C:\Go\bin\:
Xiaoling 1.2 665
Xiaoling 43.2 666 [[image:image-20220524165452-34.png]]
Xiaoling 1.2 667
Xiaoling 106.3 668
Xiaoling 1.2 669 User variable setting file generation directory: D:\go:
670
Xiaoling 43.2 671 [[image:image-20220524165517-35.png]]
Xiaoling 1.2 672
Xiaoling 86.27 673
Xiaoling 1.2 674
Xiaoling 108.11 675 (% style="color:blue" %)**3.  Modify the ADR configuration file according to your own needs, adr.setting.go is an example of the ADR configuration file.**
Xiaoling 108.9 676
Xiaoling 1.2 677 The name of the plugin: Example ADR plugin:
678
Xiaoling 48.2 679 [[image:image-20220524165540-36.png]]
Xiaoling 1.2 680
681 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.
682
Xiaoling 48.2 683 [[image:image-20220524165557-37.png]]
Xiaoling 1.2 684
Xiaoling 86.28 685
Xiaoling 1.2 686
Xiaoling 108.11 687 (% style="color:blue" %)**4.  Compile the ADR configuration file and generate the exe file.**
Xiaoling 108.9 688
Xiaoling 1.2 689 1) Create a folder named adr-setting
690
691 2) Open the adr-setting folder
692
693 3) Put adr.setting.go in this folder.
694
695 4) Open the computer cmd and run the following commands in sequencecd adr-setting
696
697 go mod init adr-setting
698
699 go get github.com/brocaar/chirpstack-network-server/v3/adr
700
701 go get github.com/hashicorp/go-plugin
702
703 go get adr-setting
704
705 go build
706
707 5) Finally generate this file：
708
Xiaoling 48.2 709 [[image:image-20220524165623-38.png]]
Xiaoling 1.2 710
Xiaoling 86.29 711
Xiaoling 1.2 712
Xiaoling 108.11 713 (% style="color:blue" %)**5.  Add the plugin and run the plugin.**
Xiaoling 108.9 714
Xiaoling 1.5 715 (((
Xiaoling 1.2 716 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 717 )))
Xiaoling 1.2 718
Xiaoling 48.2 719 [[image:image-20220524165641-39.png]]
Xiaoling 1.2 720
Xiaoling 1.4 721 (((
Xiaoling 1.5 722 (((
Xiaoling 1.2 723 For example: adr_plugins=[“adr-setting”]
Xiaoling 1.4 724 )))
Xiaoling 1.5 725 )))
Xiaoling 1.2 726
Xiaoling 1.4 727 * (((
Xiaoling 1.5 728 (((
Xiaoling 1.4 729 Adding a single plugin format is adr_plugins=["filename"]
730 )))
Xiaoling 1.5 731 )))
Xiaoling 1.2 732
Xiaoling 1.4 733 * (((
Xiaoling 1.5 734 (((
Xiaoling 1.4 735 Adding multiple plugins The format is adr_plugins=["file name 1", "file name 2",...]
736 )))
Xiaoling 1.5 737 )))
Xiaoling 1.2 738
Xiaoling 1.4 739 (((
Xiaoling 1.5 740 (((
Xiaoling 1.2 741 Finally, re-run chirpstack-network-server.exe, and then select the plugin you just compiled in Device-profiles,
Xiaoling 1.4 742 )))
Xiaoling 1.5 743 )))
Xiaoling 1.2 744
Xiaoling 79.2 745 [[image:image-20220525104647-26.png]]
Xiaoling 1.2 746
747 Finish.
748
Xiaoling 86.30 749
Kilight Cao 138.1 750 = 8.  How to store/get all data traffic for a specific sensor, including raw payload, and uplink/ downlink history. =
Xiaoling 108.9 751
Xiaoling 1.2 752
Xiaoye 115.1 753 All data is published to the MQTT topics. if you want to store/get the data, you would have to create an MQTT handler and store the data yourself.
Xiaoling 1.2 754
Xiaoye 115.1 755 This example will be shown how to store/get all the data in two ways:
Xiaoling 108.9 756
Xiaoye 115.1 757 **//1). Chirpstack ~-~-> Node-red//**
758
759
Xiaoye 117.1 760 [[image:image-20221012184501-1.png]]
Xiaoye 115.1 761
Xiaoling 121.2 762
Xiaoye 120.1 763 Use MQTT in Nore-red to subscribe to topics published by the chirpstack-application and then continuously write to a file
Xiaoye 115.1 764
765 [[image:image-20221012174220-2.png]]
766
767
Xiaoye 120.1 768 [[image:image-20221012184655-3.png||height="395" width="1049"]]
769
770
Xiaoling 121.2 771 **Each message is continuously logged to a specified file**
Xiaoye 115.1 772
773 [[image:image-20221012174352-3.png]]
774
775
776 **//2). MQTT  Sub//**
777
778 If you don't want to store the information via node-red, you can get the output via the subscribe command.
779
780
781 **If connecting from the same machine, you can use the following command to receive data:**
782
783 (% class="box infomessage" %)
Xiaoling 1.4 784 (((
Xiaoye 115.1 785 mosquitto_sub -h localhost -t "application/#" -v
786 )))
787
788
789 **Different host**
790
791 (% class="box infomessage" %)
792 (((
793 mosquitto_sub -h IPADDRESS -p 8883 ~-~-insecure ~-~-cafile ca.pem ~-~-cert cert.pem ~-~-key key.pem -t "application/#" -v
794 )))
795
796 [[image:image-20221012173639-1.png]]
797
798
Kilight Cao 138.1 799 = 9.  Trouble Shooting =
Xiaoye 115.1 800
Kilight Cao 138.1 801 == 9.1  MIC Mismatch or MIC Failed ==
Xiaoye 115.1 802
803
804 (((
Xiaoling 1.2 805 When the device is registered or the device is working normally, the problem of MIC mismatch and MIC failed occurs.
Xiaoling 1.4 806 )))
Xiaoling 1.2 807
Xiaoling 1.4 808 (((
Xiaoling 1.2 809 Under normal circumstances, users need to change the APPKEY to solve this problem.
Xiaoling 131.2 810
811
812
813
Xiaoling 1.4 814 )))