Wiki source code of Notes for ChirpStack

Version 127.1 by Kilight Cao on 2022/12/22 14:07

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 108.7 90 == 2.4  Step 4. Add the gateway ==
Xiaoling 1.2 91
Xiaoling 108.7 92
Xiaoling 1.2 93 The example gateway id is: a840411e96744150
94
Xiaoling 1.5 95 (((
Xiaoling 1.4 96 (% style="color:red" %)**Note : The Gateway EUI and server addresses must match the ChirpStack configuration.**
Xiaoling 108.7 97
98
Xiaoling 1.5 99 )))
Xiaoling 1.2 100
Xiaoling 90.2 101 [[image:image-20220531171923-4.png]](% style="display:none" %)
Xiaoling 1.2 102
103 Add the gateway
104
Xiaoling 108.7 105
106
Xiaoling 91.2 107 [[image:image-20220531172031-5.png]]
Xiaoling 1.2 108
109 Configure the gateway
110
Xiaoling 84.2 111
Xiaoling 1.2 112
Xiaoling 108.8 113 == 2.5  Step 5. Checking gateway Status ==
114
115
Xiaoling 92.2 116 [[image:image-20220531172158-6.png]](% style="display:none" %)
Xiaoling 1.2 117
Xiaoling 84.2 118
Xiaoling 108.8 119
Xiaoling 1.2 120 gateway Status
121
Xiaoling 93.2 122 [[image:image-20220531172304-7.png]]
Xiaoling 1.2 123
124 gateway Status
125
Xiaoling 86.6 126
Xiaoling 108.8 127
Xiaoling 108.9 128 = 3.  Gateway Registration for Basics Station =
Xiaoling 1.2 129
Xiaoling 108.9 130 == 3.1  Introduction ==
Kilight Cao 9.1 131
Xiaoling 108.8 132
Kilight Cao 9.1 133 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.
134
135 ChirpStack Open-Source LoRaWAN® Network Server needs to set up a configuration that can use Semtech BasicStation.
136
137
Xiaoling 108.8 138 (% style="color:blue" %)**Below list the support products and Requirements:**
139
Kilight Cao 9.1 140 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]]
141 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/]]
142
Xiaoling 108.8 143 (% style="color:blue" %)**How to set up chirpStack Basic Station**
144
Kilight Cao 9.1 145 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]]
146
147
Xiaoling 108.8 148 (% style="color:blue" %)**What do you need to prepare**
149
Kilight Cao 9.1 150 A gateway that can access the internet normally
151
Xiaoling 86.7 152
Xiaoling 108.9 153 == 3.2  Add Gateway ==
Kilight Cao 9.1 154
Xiaoling 108.9 155
Xiaoling 20.2 156 [[image:image-20220524164205-10.png]]
Kilight Cao 9.1 157
Xiaoling 86.8 158
Xiaoling 108.9 159 == 3.3  Access the gateway GUI ==
Kilight Cao 9.1 160
Xiaoling 108.9 161
Kilight Cao 9.1 162 Access the gateway GUI interface of LoRaWAN~-~->LoRaWAN ~-~- Basic Station
163
Xiaoling 20.2 164 [[image:image-20220524164319-11.png]]
Kilight Cao 9.1 165
Xiaoling 108.9 166
Kilight Cao 9.1 167 User need to Choose the ChirpStack/Senet ~-~- Basic Station , input Server URI and Upload the TLS Certificate
168
169 (% class="box" %)
170 (((
171 Service Provider  ~-~->  Choose the ChirpStack/Senet ~-~- Basic Station
172
173 LNS URI  ~-~->  Enter the LNS URI address, For example : wss:~/~/xxxx.chirpstack.com:433 or ws:~/~/xxxx.chirpstack.com:3001
174
175 LNS TLS trust  ~-~->  Upload the TLS Certificate
176 )))
177
178 (% class="wikigeneratedid" %)
Xiaoling 20.2 179 [[image:image-20220524164341-12.png]]
Kilight Cao 9.1 180
Xiaoling 86.9 181
Xiaoling 108.9 182 == 3.4  Start Station ==
Kilight Cao 9.1 183
Xiaoling 108.9 184
Xiaoling 108.14 185 When the user has finished the configuration, Please click **Sace&Apply** to start station to connect ChirpStack.
Kilight Cao 9.1 186
Xiaoling 86.10 187
Xiaoling 108.9 188 == 3.5  Successful Connection ==
Kilight Cao 9.1 189
Xiaoling 108.9 190
Kilight Cao 9.1 191 If user completes the above steps, which will see live date in the ChirpStack.
192
Xiaoling 23.2 193 [[image:image-20220524164448-13.png]]
Kilight Cao 9.1 194
Xiaoling 86.11 195
Xiaoling 108.9 196 == 3.6  Trouble Shooting ==
197
198
Kilight Cao 9.1 199 User can check the station log in the logread/system log page.
200
Xiaoling 95.2 201 [[image:image-20220531172837-8.png]]
Kilight Cao 9.1 202
Xiaoling 86.13 203
Kilight Cao 9.1 204 and recode the station log in the system/Recode log page.
205
Xiaoling 95.2 206 [[image:image-20220531172857-9.png]]
Kilight Cao 9.1 207
Xiaoling 86.12 208
Kilight Cao 124.1 209 = 4. How the gateway connects to Chirpstack v4 via gateway-bridge =
Xiaoling 108.9 210
Xiaoling 1.2 211
Kilight Cao 127.1 212 == 4.1 Configure Packet Forwarder ==
Xiaoling 1.2 213
Kilight Cao 124.1 214 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 215
Kilight Cao 124.1 216 * In the **LoRaWAN** menu, click on **LoRaWAN ~-~- Semtech UDP**
217 * Make sure the following settings are set:
218 ** **Service Provider:** //~-~-Custom/Private LoRaWAN~-~-//
219 ** **LoRaWAN Server Address:** //localhost or 127.0.0.1//
220 ** **Server port for upstream:** //1700//
221 ** **Server port for downstream:** //1700//
222
223 Click **Save & Apply**.
224
225 [[image:image-20221222114220-2.png||height="748" width="931"]]
226
227
Kilight Cao 127.1 228 == 4.2 Configuring gateway frequency ==
Kilight Cao 124.1 229
Kilight Cao 127.1 230 Note: Gateway frequencies must match
231
232 [[image:image-20221222134830-3.png||height="408" width="923"]]
233
234
235 == 4.3 Modify the gateway-bridge configuration file ==
236
237
238 Run the gateway command line command to modify the gateway-bridge configuration file:
239
240 (% class="box infomessage" %)
241 (((
242 root@dragino-1d27d4:~~#  vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml
243 )))
244
Kilight Cao 124.1 245 [[image:image-20221222113302-1.png]]
246
Kilight Cao 127.1 247 [[image:image-20221222140203-4.png||height="875" width="806"]]
248
249
250 (% class="wikigeneratedid" id="H" %)
251 After the modification, run the following command: **/etc/init.d/chirpstack-gateway-bridge restart**
252
253 == 4.3 (Re)start and stop gateway-bridge ==
254
255 Use the following commands to (re)start and stop the ChirpStack Gateway Bridge Service:
256
257 (% class="box infomessage" %)
258 (((
259 **# start**
260
261 /etc/init.d/chirpstack-gateway-bridge start
262
263 **# stop**
264
265 /etc/init.d/chirpstack-gateway-bridge stop
266
267 **# restart**
268
269 /etc/init.d/chirpstack-gateway-bridge restart
270 )))
271
Kilight Cao 124.1 272 = 5.  Downlink =
273
274 == 5.1 Convert HEX to Base64 ==
275
276
Edwin Chen 111.1 277 (% 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 278
Xiaoling 121.2 279 **[[Online HEX to Base64 Converter>>https://base64.guru/converter/encode/hex]]:**
Edwin Chen 111.1 280
281 [[image:image-20221010193350-1.png]]
282
283
284
Xiaoling 121.2 285 **[[Online Base64 to Hex converter>>https://base64.guru/converter/decode/hex]]**
286
Edwin Chen 111.1 287 [[image:image-20221010193621-2.png]]
288
289
Kilight Cao 124.1 290 == 5.2  Chirpstack Downlink Note ==
Edwin Chen 111.1 291
292
Xiaoling 108.2 293 [[image:image-20220601102543-2.png]]
Xiaoling 1.2 294
Xiaoling 121.2 295 **Convert the data to Base64**
Xiaoling 1.2 296
Xiaoling 121.2 297 (% style="display:none" %) (%%)
Xiaoling 86.14 298
Xiaoling 1.2 299
Xiaoling 121.2 300 [[image:image-20220531173236-10.png||height="597" width="1215"]]
Xiaoling 1.2 301
Xiaoling 121.2 302 **Check ChripStack downlink DataRate**
Xiaoling 86.15 303
Xiaoling 121.2 304
305
Xiaoling 65.2 306 [[image:image-20220525101326-11.png]]
Xiaoling 1.2 307
Xiaoling 121.2 308 **Make sure the RX2DR is the same in the end node**
Xiaoling 1.2 309
Xiaoling 86.16 310
Kilight Cao 124.1 311 == 5.3  Loraserver Downlink Note ==
Xiaoling 108.9 312
313
Xiaoling 1.2 314 User can use MQTT to send downlink payload to ChirpStack to perform downstream to LoRaWAN End
315
Xiaoling 1.5 316 (((
Xiaoling 108.9 317 **Below is examples:**
Xiaoling 1.5 318 )))
Xiaoling 1.2 319
Xiaoling 1.4 320 (% class="box" %)
321 (((
322 Connect to your server via MQTT:
323 MQTT Client ID: Any   
324 Protocol:mqtt/tcp   Server IP:loraserver_ip:1883
Xiaoling 1.2 325 User name: User name Password: password
Xiaoling 1.4 326 )))
Xiaoling 1.2 327
Xiaoling 97.2 328 [[image:image-20220531173419-11.png]]
Xiaoling 1.2 329
Xiaoling 1.5 330 (((
Xiaoling 121.2 331 **MQTT Connect to ChirpStack**
Xiaoling 86.17 332
Xiaoling 108.9 333
Xiaoling 86.17 334
Xiaoling 1.5 335 )))
Xiaoling 1.2 336
Xiaoling 1.5 337 (((
Xiaoling 108.9 338 **After connect**
Xiaoling 1.5 339 )))
Xiaoling 1.2 340
Xiaoling 1.4 341 (% class="box" %)
342 (((
343 Subscribe : Format:application/ID/device/ Device EUI/rx
Xiaoling 1.2 344 Example: application/7/device/00aedb3da649cb23/rx
Xiaoling 1.4 345 )))
Xiaoling 1.2 346
Xiaoling 1.4 347 (% class="box" %)
348 (((
349 Publish:
Xiaoling 1.2 350 Format: Top: application/ID/device/ Device EUI/tx
351 Payload: {"confirmed":true or false,"fPort":XX,"data":"xxxx"}
352 Example: Top: application/7/device/00aedb3da649cb23/tx
353 Payload: {"confirmed":true,"fPort":2,"data":"AwEB"}
Xiaoling 1.4 354 )))
Xiaoling 1.2 355
Xiaoling 98.2 356 [[image:image-20220531173519-12.png]]
Xiaoling 1.2 357
Xiaoling 121.2 358 **MQTT Connect to ChirpStack**
Xiaoling 1.2 359
Xiaoling 86.18 360
Xiaoling 121.2 361 **If we want to send downstream hex 030101 to end node, the BASE64 payload is AwEB**
Xiaoling 1.2 362
Xiaoling 100.2 363 [[image:image-20220531173658-14.png]]
Xiaoling 1.2 364
Xiaoling 108.9 365
Xiaoling 1.5 366 (((
Xiaoling 1.2 367 Downlink payload encode javescript code: 可以在网站上运行以下Javsscript代码:
Xiaoling 1.5 368 )))
Xiaoling 1.2 369
Xiaoling 1.4 370 (% class="box" %)
371 (((
372 function sha1_to_base64(sha1)
Xiaoling 1.2 373 {
374 var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
375 var base64_rep = "";
376 var cnt = 0;
377 var bit_arr = 0;
378 var bit_num = 0;
Xiaoling 1.5 379 \\ for(var n = 0; n < sha1.length; ++n)
Xiaoling 1.2 380 {
381 if(sha1[n] >= 'A' && sha1[n] <= 'Z')
382 {
Jean-Philippe Gagné 121.1 383 ascv = sha1.charCodeAt( n ) - 55;
Xiaoling 1.2 384 }
385 else if(sha1[n] >= 'a' && sha1[n] <= 'z')
386 {
Jean-Philippe Gagné 121.1 387 ascv = sha1.charCodeAt( n ) - 87;
Xiaoling 1.2 388 }
389 else
390 {
Jean-Philippe Gagné 121.1 391 ascv = sha1.charCodeAt( n ) - 48;
Xiaoling 1.2 392 }
Xiaoling 1.5 393 \\ bit_arr = (bit_arr << 4) | ascv;
Xiaoling 1.2 394 bit_num += 4;
395 if(bit_num >= 6)
396 {
Xiaoling 1.4 397 bit_num -= 6;        
Xiaoling 1.2 398 base64_rep += digits[bit_arr >>> bit_num];
Xiaoling 1.4 399 bit_arr &= ~~(-1 << bit_num);
Xiaoling 1.2 400 }
401 }
Xiaoling 1.5 402 \\ if(bit_num > 0)
Xiaoling 1.2 403 {
404 bit_arr <<= 6 - bit_num;
405 base64_rep += digits[bit_arr];
406 }
Xiaoling 1.5 407 \\ var padding = base64_rep.length % 4;   
408 \\ if(padding > 0)
Xiaoling 1.2 409 {
410 for(var n = 0; n < 4 - padding; ++n)
411 {
412 base64_rep += "=";
413 }
414 }
415 return base64_rep;
416 }
Xiaoling 1.5 417 \\console.log(sha1_to_base64("data"));
418 \\data is downlink payload required by end node.
Xiaoling 1.4 419 e.g console.log(sha1_to_base64("030101"));
420 ​result: AwEB     
Xiaoling 1.2 421 AwEB is the 0x030101's base 64 Encode.
Xiaoling 1.5 422 \\​e.g console.log(sha1_to_base64("030000"));
Xiaoling 1.4 423 ​result: AwAA     
424 AwAA is 0x030000's base 64 Encode.
425 )))
Xiaoling 1.2 426
Xiaoling 86.21 427
Xiaoling 1.2 428
Xiaoling 108.9 429 == 4.3  Add the decode function in Chirpstack for the payload ==
430
431
Xiaoling 1.2 432 User enters the payload code according to the steps.
433
Xiaoling 121.2 434 [[image:image-20220531173754-15.png||height="474" width="1334"]]
Xiaoling 1.2 435
436
Xiaoling 102.2 437 [[image:image-20220531173856-16.png]]
Xiaoling 1.2 438
Xiaoling 102.2 439
Xiaoling 106.2 440 [[image:image-20220531174120-20.png]]
Xiaoling 84.2 441
Xiaoling 105.2 442 [[image:image-20220531174046-19.png]]
Xiaoling 1.2 443
Xiaoling 86.22 444
Kilight Cao 124.1 445 = 6.  Multiply Uplink in ChirpStack =
Xiaoling 108.9 446
447
Xiaoling 1.4 448 (((
Xiaoling 1.2 449 nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data.
Xiaoling 1.4 450 )))
Xiaoling 1.2 451
Xiaoling 1.4 452 (((
Xiaoling 1.2 453 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 454
455
Xiaoling 1.4 456 )))
Xiaoling 1.2 457
Xiaoling 121.2 458 [[image:image-20220526091912-7.png||height="241" width="1336"]]
Xiaoling 1.2 459
Xiaoling 108.9 460
Xiaoling 1.5 461 (((
Xiaoling 1.2 462 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 463
464
Xiaoling 1.5 465 )))
Xiaoling 1.2 466
Xiaoling 76.2 467 [[image:image-20220525104359-21.png]]
Xiaoling 1.2 468
Xiaoling 1.4 469 (((
Xiaoling 1.2 470 Above behaviour will cause the platform shows below two cases of error:
Xiaoling 108.9 471
472
Xiaoling 1.4 473 )))
Xiaoling 1.2 474
Xiaoling 1.4 475 (((
Xiaoling 1.2 476 Error of duplicate Frame Counter
Xiaoling 1.4 477 )))
Xiaoling 1.2 478
Xiaoling 76.2 479 [[image:image-20220525104437-22.png]]
Xiaoling 1.2 480
Xiaoling 86.23 481
Xiaoling 108.9 482
Xiaoling 121.2 483 **Duplicate transmission in short time**
Xiaoling 1.2 484
Xiaoling 121.2 485 [[image:image-20220601102430-1.png||height="598" width="1319"]]
Xiaoling 1.2 486
Xiaoling 86.24 487
Xiaoling 1.2 488
Kilight Cao 124.1 489 == 6.1  Solution ==
Xiaoling 108.9 490
491
Xiaoling 1.2 492 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]]
493
Xiaoling 108.9 494
Xiaoling 1.5 495 (((
Xiaoling 108.11 496 (% 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 497
498
Xiaoling 1.5 499 )))
Xiaoling 1.2 500
Xiaoling 79.2 501 [[image:image-20220525104532-24.png]]
Xiaoling 1.2 502
Xiaoling 86.25 503
Xiaoling 108.9 504 **installation path:**
Xiaoling 1.2 505
Xiaoling 79.2 506 [[image:image-20220525104554-25.png]]
Xiaoling 1.2 507
Xiaoling 86.25 508
Xiaoling 108.9 509
Xiaoling 1.5 510 (((
Xiaoling 108.11 511 (% style="color:blue" %)**2.  Environment variable settings:**
Xiaoling 1.5 512 )))
Xiaoling 1.2 513
Xiaoling 1.5 514 (((
Xiaoling 1.2 515 1) Open Computer -> Properties -> Advanced System Settings -> Environment Variables and add a "new" system variable:
Xiaoling 1.5 516 )))
Xiaoling 1.2 517
Xiaoling 1.5 518 (((
Xiaoling 108.9 519 2) Set the variable name GOROOT and the variable value C:\Go\ (installation directory)
Xiaoling 1.5 520 )))
Xiaoling 1.2 521
Xiaoling 43.2 522 [[image:image-20220524165433-33.png]]
Xiaoling 1.2 523
Xiaoling 86.26 524
Xiaoling 108.9 525 3) Modify the system variable Path and add C:\Go\bin\:
Xiaoling 1.2 526
Xiaoling 43.2 527 [[image:image-20220524165452-34.png]]
Xiaoling 1.2 528
Xiaoling 106.3 529
Xiaoling 1.2 530 User variable setting file generation directory: D:\go:
531
Xiaoling 43.2 532 [[image:image-20220524165517-35.png]]
Xiaoling 1.2 533
Xiaoling 86.27 534
Xiaoling 1.2 535
Xiaoling 108.11 536 (% 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 537
Xiaoling 1.2 538 The name of the plugin: Example ADR plugin:
539
Xiaoling 48.2 540 [[image:image-20220524165540-36.png]]
Xiaoling 1.2 541
542 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.
543
Xiaoling 48.2 544 [[image:image-20220524165557-37.png]]
Xiaoling 1.2 545
Xiaoling 86.28 546
Xiaoling 1.2 547
Xiaoling 108.11 548 (% style="color:blue" %)**4.  Compile the ADR configuration file and generate the exe file.**
Xiaoling 108.9 549
Xiaoling 1.2 550 1) Create a folder named adr-setting
551
552 2) Open the adr-setting folder
553
554 3) Put adr.setting.go in this folder.
555
556 4) Open the computer cmd and run the following commands in sequencecd adr-setting
557
558 go mod init adr-setting
559
560 go get github.com/brocaar/chirpstack-network-server/v3/adr
561
562 go get github.com/hashicorp/go-plugin
563
564 go get adr-setting
565
566 go build
567
568 5) Finally generate this file:
569
Xiaoling 48.2 570 [[image:image-20220524165623-38.png]]
Xiaoling 1.2 571
Xiaoling 86.29 572
Xiaoling 1.2 573
Xiaoling 108.11 574 (% style="color:blue" %)**5.  Add the plugin and run the plugin.**
Xiaoling 108.9 575
Xiaoling 1.5 576 (((
Xiaoling 1.2 577 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 578 )))
Xiaoling 1.2 579
Xiaoling 48.2 580 [[image:image-20220524165641-39.png]]
Xiaoling 1.2 581
Xiaoling 1.4 582 (((
Xiaoling 1.5 583 (((
Xiaoling 1.2 584 For example: adr_plugins=[“adr-setting”]
Xiaoling 1.4 585 )))
Xiaoling 1.5 586 )))
Xiaoling 1.2 587
Xiaoling 1.4 588 * (((
Xiaoling 1.5 589 (((
Xiaoling 1.4 590 Adding a single plugin format is adr_plugins=["filename"]
591 )))
Xiaoling 1.5 592 )))
Xiaoling 1.2 593
Xiaoling 1.4 594 * (((
Xiaoling 1.5 595 (((
Xiaoling 1.4 596 Adding multiple plugins The format is adr_plugins=["file name 1", "file name 2",...]
597 )))
Xiaoling 1.5 598 )))
Xiaoling 1.2 599
Xiaoling 1.4 600 (((
Xiaoling 1.5 601 (((
Xiaoling 1.2 602 Finally, re-run chirpstack-network-server.exe, and then select the plugin you just compiled in Device-profiles,
Xiaoling 1.4 603 )))
Xiaoling 1.5 604 )))
Xiaoling 1.2 605
Xiaoling 79.2 606 [[image:image-20220525104647-26.png]]
Xiaoling 1.2 607
608 Finish.
609
Xiaoling 86.30 610
Kilight Cao 124.1 611 = 7.  How to store/get all data traffic for a specific sensor, including raw payload, and uplink/ downlink history. =
Xiaoling 108.9 612
Xiaoling 1.2 613
Xiaoye 115.1 614 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 615
Xiaoye 115.1 616 This example will be shown how to store/get all the data in two ways:
Xiaoling 108.9 617
Xiaoye 115.1 618 **//1). Chirpstack ~-~-> Node-red//**
619
620
Xiaoye 117.1 621 [[image:image-20221012184501-1.png]]
Xiaoye 115.1 622
Xiaoling 121.2 623
Xiaoye 120.1 624 Use MQTT in Nore-red to subscribe to topics published by the chirpstack-application and then continuously write to a file
Xiaoye 115.1 625
626 [[image:image-20221012174220-2.png]]
627
628
Xiaoye 120.1 629 [[image:image-20221012184655-3.png||height="395" width="1049"]]
630
631
Xiaoling 121.2 632 **Each message is continuously logged to a specified file**
Xiaoye 115.1 633
634 [[image:image-20221012174352-3.png]]
635
636
637 **//2). MQTT  Sub//**
638
639 If you don't want to store the information via node-red, you can get the output via the subscribe command.
640
641
642 **If connecting from the same machine, you can use the following command to receive data:**
643
644 (% class="box infomessage" %)
Xiaoling 1.4 645 (((
Xiaoye 115.1 646 mosquitto_sub -h localhost -t "application/#" -v
647 )))
648
649
650 **Different host**
651
652 (% class="box infomessage" %)
653 (((
654 mosquitto_sub -h IPADDRESS -p 8883 ~-~-insecure ~-~-cafile ca.pem ~-~-cert cert.pem ~-~-key key.pem -t "application/#" -v
655 )))
656
657 [[image:image-20221012173639-1.png]]
658
659
Kilight Cao 124.1 660 = 8.  Trouble Shooting =
Xiaoye 115.1 661
Kilight Cao 124.1 662 == 8.1  MIC Mismatch or MIC Failed ==
Xiaoye 115.1 663
664
665 (((
Xiaoling 1.2 666 When the device is registered or the device is working normally, the problem of MIC mismatch and MIC failed occurs.
Xiaoling 1.4 667 )))
Xiaoling 1.2 668
Xiaoling 1.4 669 (((
Xiaoling 1.2 670 Under normal circumstances, users need to change the APPKEY to solve this problem.
Xiaoling 1.4 671 )))