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 138.2 223
Xiaoling 131.2 224 == 4.1  Configure Packet Forwarder ==
225
226
Kilight Cao 124.1 227 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 228
Xiaoling 138.3 229 * In the (% style="color:blue" %)**LoRaWAN** (%%)menu, click on (% style="color:blue" %)**LoRaWAN ~-~- Semtech UDP**
Xiaoling 138.2 230
Kilight Cao 124.1 231 * Make sure the following settings are set:
Xiaoling 138.4 232 ** **Service Provider:** //~-~-Custom/Private LoRaWAN~-~-//
233 ** **LoRaWAN Server Address:** //localhost or 127.0.0.1//
234 ** **Server port for upstream:** //1700//
235 ** **Server port for downstream:** //1700//
Xiaoling 138.2 236
Xiaoling 138.3 237 Click (% style="color:blue" %)**Save & Apply**.
Kilight Cao 124.1 238
239 [[image:image-20221222114220-2.png||height="748" width="931"]]
240
241
Xiaoling 131.2 242 == 4.2  Configuring gateway frequency ==
Kilight Cao 124.1 243
Kilight Cao 127.1 244
Xiaoling 131.2 245 (% style="color:red" %)**Note: Gateway frequencies must match**
246
Kilight Cao 127.1 247 [[image:image-20221222134830-3.png||height="408" width="923"]]
248
249
Kilight Cao 138.1 250 == 4.3  Generate and modify the gateway-bridge configuration file ==
Kilight Cao 127.1 251
252
Kilight Cao 138.1 253 **1)Generate the gateway-bridge configuration file**
254
255 By default, the configuration file is not up-to-date,so the user needs to rebuild the gateway-bridge configuration file.
256
257 Users need to access the command line of the gateway through SSH,Then type the following command:
258
259 (% class="box infomessage" %)
260 (((
Xiaoling 138.5 261 **/opt/chirpstack-gateway-bridge/chirpstack-gateway-bridge configfile > /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml **
Kilight Cao 138.1 262 )))
263
264
265 **2)modify the gateway-bridge configuration file**
266
267 The user needs to modify the server address in line 252 in the configuration file
268
269 (% class="box infomessage" %)
270 (((
Xiaoling 138.5 271 **vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml **
Kilight Cao 138.1 272 )))
273
274 [[image:image-20230415165254-1.png||height="583" width="956"]]
275
276
277 == 4.4  Debug ==
278
279
280 After the above configuration is completed, the user can enter the command to debug the gateway-bridge connection
281
282 (% class="box infomessage" %)
283 (((
Xiaoling 138.5 284 **/opt/chirpstack-gateway-bridge/chirpstack-gateway-bridge ~-~-config /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml**
Kilight Cao 138.1 285 )))
286
287 If the gateway-bridge connection is normal, the debug log displays **"connected to mqtt broker"**.
288
289 [[image:image-20230415170404-2.png]]
290
291
292 If the debug log shows "**connection error**", check that the server port or server is correct
293
294 [[image:image-20230415170854-3.png]]
295
296
297 More information can be found on the **[[ChirpStack website>>https://www.chirpstack.io/docs/]]**or **[[Forum>>url:https://forum.chirpstack.io/]]**
298
299
300 == 4.5  (Re)start and stop gateway-bridge ==
301
302
303 Use the following commands to (re)start and stop the ChirpStack Gateway Bridge Service:
304
305 (% class="box infomessage" %)
306 (((
307 **# start**
308
309 /etc/init.d/chirpstack-gateway-bridge start
310
311 **# stop**
312
313 /etc/init.d/chirpstack-gateway-bridge stop
314
315 **# restart**
316
317 /etc/init.d/chirpstack-gateway-bridge restart
318 )))
319
320
321 = 5.  How the gateway connects to Chirpstack v4 via gateway-bridge =
322
323
324 (% style="color:blue" %)**Below list the support products and Requirements:**
325
326 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]]
327 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/]]
328
329 (% style="color:blue" %)**How to set up chirpStack Gateway-bridge**
330
331 Users can check out the ChirpStack gateway-bridge v4 [[link>>https://www.chirpstack.io/docs/chirpstack-gateway-bridge/install/dragino.html]]
332
333
334 (% style="color:blue" %)**What do you need to prepare**
335
336 A gateway that can access the internet normally
337
338
339 == 5.1  Configure Packet Forwarder ==
340
341
342 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
343
Xiaoling 138.5 344 * In the (% style="color:blue" %)**LoRaWAN**(%%) menu, click on (% style="color:blue" %)**LoRaWAN ~-~- Semtech UDP**
345
Kilight Cao 138.1 346 * Make sure the following settings are set:
347 ** **Service Provider:** //~-~-Custom/Private LoRaWAN~-~-//
348 ** **LoRaWAN Server Address:** //localhost or 127.0.0.1//
349 ** **Server port for upstream:** //1700//
350 ** **Server port for downstream:** //1700//
351
Xiaoling 138.5 352 Click (% style="color:blue" %)**Save & Apply**.
Kilight Cao 138.1 353
354 [[image:image-20221222114220-2.png||height="748" width="931"]]
355
356
357 == 5.2  Configuring gateway frequency ==
358
359
360 (% style="color:red" %)**Note: Gateway frequencies must match**
361
362 [[image:image-20221222134830-3.png||height="408" width="923"]]
363
364
365 == 5.3  Modify the gateway-bridge configuration file ==
366
367
Kilight Cao 127.1 368 Run the gateway command line command to modify the gateway-bridge configuration file:
369
370 (% class="box infomessage" %)
371 (((
Xiaoling 138.5 372 **root@dragino-1d27d4:~~#  vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml **
Kilight Cao 127.1 373 )))
374
Kilight Cao 124.1 375 [[image:image-20221222113302-1.png]]
376
Xiaoling 131.2 377
Kilight Cao 127.1 378 [[image:image-20221222140203-4.png||height="875" width="806"]]
379
Kilight Cao 133.1 380 [[image:image-20221230094246-1.png||height="768" width="783"]]
Kilight Cao 127.1 381
382 (% class="wikigeneratedid" id="H" %)
383 After the modification, run the following command: **/etc/init.d/chirpstack-gateway-bridge restart**
384
385
Kilight Cao 138.1 386 == 5.4  (Re)start and stop gateway-bridge ==
Xiaoling 131.2 387
388
Kilight Cao 127.1 389 Use the following commands to (re)start and stop the ChirpStack Gateway Bridge Service:
390
391 (% class="box infomessage" %)
392 (((
393 **# start**
394
395 /etc/init.d/chirpstack-gateway-bridge start
396
397 **# stop**
398
399 /etc/init.d/chirpstack-gateway-bridge stop
400
401 **# restart**
402
403 /etc/init.d/chirpstack-gateway-bridge restart
404 )))
405
Kilight Cao 131.1 406
Kilight Cao 138.1 407 == 5.5  Successful Connection ==
Kilight Cao 131.1 408
Xiaoling 131.2 409
Kilight Cao 131.1 410 [[image:image-20221222141754-5.png||height="488" width="1150"]]
411
Xiaoling 131.2 412
Kilight Cao 131.1 413 [[image:image-20221222141830-6.png||height="582" width="1153"]]
414
Xiaoling 131.2 415
Kilight Cao 138.1 416 = 6.  Downlink =
Kilight Cao 124.1 417
Kilight Cao 138.1 418 == 6.1  Convert HEX to Base64 ==
Kilight Cao 124.1 419
420
Edwin Chen 111.1 421 (% 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 422
Xiaoling 121.2 423 **[[Online HEX to Base64 Converter>>https://base64.guru/converter/encode/hex]]:**
Edwin Chen 111.1 424
425 [[image:image-20221010193350-1.png]]
426
427
428
Xiaoling 121.2 429 **[[Online Base64 to Hex converter>>https://base64.guru/converter/decode/hex]]**
430
Edwin Chen 111.1 431 [[image:image-20221010193621-2.png]]
432
433
Kilight Cao 138.1 434 == 6.2  Chirpstack Downlink Note ==
Edwin Chen 111.1 435
436
Xiaoling 108.2 437 [[image:image-20220601102543-2.png]]
Xiaoling 1.2 438
Xiaoling 121.2 439 **Convert the data to Base64**
Xiaoling 1.2 440
Xiaoling 121.2 441 (% style="display:none" %) (%%)
Xiaoling 86.14 442
Xiaoling 1.2 443
Xiaoling 121.2 444 [[image:image-20220531173236-10.png||height="597" width="1215"]]
Xiaoling 1.2 445
Xiaoling 121.2 446 **Check ChripStack downlink DataRate**
Xiaoling 86.15 447
Xiaoling 121.2 448
449
Xiaoling 65.2 450 [[image:image-20220525101326-11.png]]
Xiaoling 1.2 451
Xiaoling 121.2 452 **Make sure the RX2DR is the same in the end node**
Xiaoling 1.2 453
Xiaoling 86.16 454
Kilight Cao 138.1 455 == 6.3  Loraserver Downlink Note ==
Xiaoling 108.9 456
457
Xiaoling 1.2 458 User can use MQTT to send downlink payload to ChirpStack to perform downstream to LoRaWAN End
459
Xiaoling 1.5 460 (((
Xiaoling 108.9 461 **Below is examples:**
Xiaoling 1.5 462 )))
Xiaoling 1.2 463
Xiaoling 1.4 464 (% class="box" %)
465 (((
466 Connect to your server via MQTT:
467 MQTT Client ID: Any   
468 Protocol:mqtt/tcp   Server IP:loraserver_ip:1883
Xiaoling 1.2 469 User name: User name Password: password
Xiaoling 1.4 470 )))
Xiaoling 1.2 471
Xiaoling 97.2 472 [[image:image-20220531173419-11.png]]
Xiaoling 1.2 473
Xiaoling 1.5 474 (((
Xiaoling 121.2 475 **MQTT Connect to ChirpStack**
Xiaoling 86.17 476
Xiaoling 108.9 477
Xiaoling 86.17 478
Xiaoling 1.5 479 )))
Xiaoling 1.2 480
Xiaoling 1.5 481 (((
Xiaoling 108.9 482 **After connect**
Xiaoling 1.5 483 )))
Xiaoling 1.2 484
Xiaoling 1.4 485 (% class="box" %)
486 (((
487 Subscribe : Format:application/ID/device/ Device EUI/rx
Xiaoling 1.2 488 Example: application/7/device/00aedb3da649cb23/rx
Xiaoling 1.4 489 )))
Xiaoling 1.2 490
Xiaoling 1.4 491 (% class="box" %)
492 (((
493 Publish:
Xiaoling 1.2 494 Format: Top: application/ID/device/ Device EUI/tx
495 Payload: {"confirmed":true or false,"fPort":XX,"data":"xxxx"}
496 Example: Top: application/7/device/00aedb3da649cb23/tx
497 Payload: {"confirmed":true,"fPort":2,"data":"AwEB"}
Xiaoling 1.4 498 )))
Xiaoling 1.2 499
Xiaoling 98.2 500 [[image:image-20220531173519-12.png]]
Xiaoling 1.2 501
Xiaoling 121.2 502 **MQTT Connect to ChirpStack**
Xiaoling 1.2 503
Xiaoling 86.18 504
Xiaoling 121.2 505 **If we want to send downstream hex 030101 to end node, the BASE64 payload is AwEB**
Xiaoling 1.2 506
Xiaoling 100.2 507 [[image:image-20220531173658-14.png]]
Xiaoling 1.2 508
Xiaoling 108.9 509
Xiaoling 1.5 510 (((
Xiaoling 1.2 511 Downlink payload encode javescript code: 可以在网站上运行以下Javsscript代码:
Xiaoling 1.5 512 )))
Xiaoling 1.2 513
Xiaoling 1.4 514 (% class="box" %)
515 (((
516 function sha1_to_base64(sha1)
Xiaoling 1.2 517 {
518 var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
519 var base64_rep = "";
520 var cnt = 0;
521 var bit_arr = 0;
522 var bit_num = 0;
Xiaoling 1.5 523 \\ for(var n = 0; n < sha1.length; ++n)
Xiaoling 1.2 524 {
525 if(sha1[n] >= 'A' && sha1[n] <= 'Z')
526 {
Jean-Philippe Gagné 121.1 527 ascv = sha1.charCodeAt( n ) - 55;
Xiaoling 1.2 528 }
529 else if(sha1[n] >= 'a' && sha1[n] <= 'z')
530 {
Jean-Philippe Gagné 121.1 531 ascv = sha1.charCodeAt( n ) - 87;
Xiaoling 1.2 532 }
533 else
534 {
Jean-Philippe Gagné 121.1 535 ascv = sha1.charCodeAt( n ) - 48;
Xiaoling 1.2 536 }
Xiaoling 1.5 537 \\ bit_arr = (bit_arr << 4) | ascv;
Xiaoling 1.2 538 bit_num += 4;
539 if(bit_num >= 6)
540 {
Xiaoling 1.4 541 bit_num -= 6;        
Xiaoling 1.2 542 base64_rep += digits[bit_arr >>> bit_num];
Xiaoling 1.4 543 bit_arr &= ~~(-1 << bit_num);
Xiaoling 1.2 544 }
545 }
Xiaoling 1.5 546 \\ if(bit_num > 0)
Xiaoling 1.2 547 {
548 bit_arr <<= 6 - bit_num;
549 base64_rep += digits[bit_arr];
550 }
Xiaoling 1.5 551 \\ var padding = base64_rep.length % 4;   
552 \\ if(padding > 0)
Xiaoling 1.2 553 {
554 for(var n = 0; n < 4 - padding; ++n)
555 {
556 base64_rep += "=";
557 }
558 }
559 return base64_rep;
560 }
Xiaoling 1.5 561 \\console.log(sha1_to_base64("data"));
562 \\data is downlink payload required by end node.
Xiaoling 1.4 563 e.g console.log(sha1_to_base64("030101"));
564 ​result: AwEB     
Xiaoling 1.2 565 AwEB is the 0x030101's base 64 Encode.
Xiaoling 1.5 566 \\​e.g console.log(sha1_to_base64("030000"));
Xiaoling 1.4 567 ​result: AwAA     
568 AwAA is 0x030000's base 64 Encode.
569 )))
Xiaoling 1.2 570
Xiaoling 86.21 571
Kilight Cao 138.1 572 == 6.3  Add the decode function in Chirpstack for the payload ==
Xiaoling 108.9 573
574
Xiaoling 1.2 575 User enters the payload code according to the steps.
576
Xiaoling 121.2 577 [[image:image-20220531173754-15.png||height="474" width="1334"]]
Xiaoling 1.2 578
579
Xiaoling 102.2 580 [[image:image-20220531173856-16.png]]
Xiaoling 1.2 581
Xiaoling 102.2 582
Xiaoling 106.2 583 [[image:image-20220531174120-20.png]]
Xiaoling 84.2 584
Xiaoling 105.2 585 [[image:image-20220531174046-19.png]]
Xiaoling 1.2 586
Xiaoling 86.22 587
Kilight Cao 138.1 588 = 7.  Multiply Uplink in ChirpStack =
Xiaoling 108.9 589
590
Xiaoling 1.4 591 (((
Xiaoling 1.2 592 nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data.
Xiaoling 1.4 593 )))
Xiaoling 1.2 594
Xiaoling 1.4 595 (((
Xiaoling 1.2 596 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 597
598
Xiaoling 1.4 599 )))
Xiaoling 1.2 600
Xiaoling 121.2 601 [[image:image-20220526091912-7.png||height="241" width="1336"]]
Xiaoling 1.2 602
Xiaoling 108.9 603
Xiaoling 1.5 604 (((
Xiaoling 1.2 605 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 606
607
Xiaoling 1.5 608 )))
Xiaoling 1.2 609
Xiaoling 76.2 610 [[image:image-20220525104359-21.png]]
Xiaoling 1.2 611
Xiaoling 1.4 612 (((
Xiaoling 1.2 613 Above behaviour will cause the platform shows below two cases of error:
Xiaoling 108.9 614
615
Xiaoling 1.4 616 )))
Xiaoling 1.2 617
Xiaoling 1.4 618 (((
Xiaoling 1.2 619 Error of duplicate Frame Counter
Xiaoling 1.4 620 )))
Xiaoling 1.2 621
Xiaoling 76.2 622 [[image:image-20220525104437-22.png]]
Xiaoling 1.2 623
Xiaoling 86.23 624
Xiaoling 108.9 625
Xiaoling 121.2 626 **Duplicate transmission in short time**
Xiaoling 1.2 627
Xiaoling 121.2 628 [[image:image-20220601102430-1.png||height="598" width="1319"]]
Xiaoling 1.2 629
Xiaoling 86.24 630
Kilight Cao 138.1 631 == 7.1  Solution ==
Xiaoling 108.9 632
633
Xiaoling 1.2 634 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]]
635
Xiaoling 108.9 636
Xiaoling 1.5 637 (((
Xiaoling 108.11 638 (% 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 639
640
Xiaoling 1.5 641 )))
Xiaoling 1.2 642
Xiaoling 79.2 643 [[image:image-20220525104532-24.png]]
Xiaoling 1.2 644
Xiaoling 86.25 645
Xiaoling 108.9 646 **installation path:**
Xiaoling 1.2 647
Xiaoling 79.2 648 [[image:image-20220525104554-25.png]]
Xiaoling 1.2 649
Xiaoling 86.25 650
Xiaoling 108.9 651
Xiaoling 1.5 652 (((
Xiaoling 108.11 653 (% style="color:blue" %)**2.  Environment variable settings:**
Xiaoling 1.5 654 )))
Xiaoling 1.2 655
Xiaoling 1.5 656 (((
Xiaoling 1.2 657 1) Open Computer -> Properties -> Advanced System Settings -> Environment Variables and add a "new" system variable:
Xiaoling 1.5 658 )))
Xiaoling 1.2 659
Xiaoling 1.5 660 (((
Xiaoling 108.9 661 2) Set the variable name GOROOT and the variable value C:\Go\ (installation directory)
Xiaoling 1.5 662 )))
Xiaoling 1.2 663
Xiaoling 43.2 664 [[image:image-20220524165433-33.png]]
Xiaoling 1.2 665
Xiaoling 86.26 666
Xiaoling 108.9 667 3) Modify the system variable Path and add C:\Go\bin\:
Xiaoling 1.2 668
Xiaoling 43.2 669 [[image:image-20220524165452-34.png]]
Xiaoling 1.2 670
Xiaoling 106.3 671
Xiaoling 1.2 672 User variable setting file generation directory: D:\go:
673
Xiaoling 43.2 674 [[image:image-20220524165517-35.png]]
Xiaoling 1.2 675
Xiaoling 86.27 676
Xiaoling 1.2 677
Xiaoling 108.11 678 (% 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 679
Xiaoling 1.2 680 The name of the plugin: Example ADR plugin:
681
Xiaoling 48.2 682 [[image:image-20220524165540-36.png]]
Xiaoling 1.2 683
684 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.
685
Xiaoling 48.2 686 [[image:image-20220524165557-37.png]]
Xiaoling 1.2 687
Xiaoling 86.28 688
Xiaoling 1.2 689
Xiaoling 108.11 690 (% style="color:blue" %)**4.  Compile the ADR configuration file and generate the exe file.**
Xiaoling 108.9 691
Xiaoling 1.2 692 1) Create a folder named adr-setting
693
694 2) Open the adr-setting folder
695
696 3) Put adr.setting.go in this folder.
697
698 4) Open the computer cmd and run the following commands in sequencecd adr-setting
699
700 go mod init adr-setting
701
702 go get github.com/brocaar/chirpstack-network-server/v3/adr
703
704 go get github.com/hashicorp/go-plugin
705
706 go get adr-setting
707
708 go build
709
710 5) Finally generate this file:
711
Xiaoling 48.2 712 [[image:image-20220524165623-38.png]]
Xiaoling 1.2 713
Xiaoling 86.29 714
Xiaoling 1.2 715
Xiaoling 108.11 716 (% style="color:blue" %)**5.  Add the plugin and run the plugin.**
Xiaoling 108.9 717
Xiaoling 1.5 718 (((
Xiaoling 1.2 719 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 720 )))
Xiaoling 1.2 721
Xiaoling 48.2 722 [[image:image-20220524165641-39.png]]
Xiaoling 1.2 723
Xiaoling 1.4 724 (((
Xiaoling 1.5 725 (((
Xiaoling 1.2 726 For example: adr_plugins=[“adr-setting”]
Xiaoling 1.4 727 )))
Xiaoling 1.5 728 )))
Xiaoling 1.2 729
Xiaoling 1.4 730 * (((
Xiaoling 1.5 731 (((
Xiaoling 1.4 732 Adding a single plugin format is adr_plugins=["filename"]
733 )))
Xiaoling 1.5 734 )))
Xiaoling 1.2 735
Xiaoling 1.4 736 * (((
Xiaoling 1.5 737 (((
Xiaoling 1.4 738 Adding multiple plugins The format is adr_plugins=["file name 1", "file name 2",...]
739 )))
Xiaoling 1.5 740 )))
Xiaoling 1.2 741
Xiaoling 1.4 742 (((
Xiaoling 1.5 743 (((
Xiaoling 1.2 744 Finally, re-run chirpstack-network-server.exe, and then select the plugin you just compiled in Device-profiles,
Xiaoling 1.4 745 )))
Xiaoling 1.5 746 )))
Xiaoling 1.2 747
Xiaoling 79.2 748 [[image:image-20220525104647-26.png]]
Xiaoling 1.2 749
750 Finish.
751
Xiaoling 86.30 752
Kilight Cao 138.1 753 = 8.  How to store/get all data traffic for a specific sensor, including raw payload, and uplink/ downlink history. =
Xiaoling 108.9 754
Xiaoling 1.2 755
Xiaoye 115.1 756 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 757
Xiaoye 115.1 758 This example will be shown how to store/get all the data in two ways:
Xiaoling 108.9 759
Xiaoling 138.5 760 (% style="color:blue" %)**//1). Chirpstack ~-~-> Node-red//**
Xiaoye 115.1 761
762
Xiaoye 117.1 763 [[image:image-20221012184501-1.png]]
Xiaoye 115.1 764
Xiaoling 121.2 765
Xiaoye 120.1 766 Use MQTT in Nore-red to subscribe to topics published by the chirpstack-application and then continuously write to a file
Xiaoye 115.1 767
768 [[image:image-20221012174220-2.png]]
769
770
Xiaoye 120.1 771 [[image:image-20221012184655-3.png||height="395" width="1049"]]
772
773
Xiaoling 121.2 774 **Each message is continuously logged to a specified file**
Xiaoye 115.1 775
776 [[image:image-20221012174352-3.png]]
777
778
Xiaoling 138.5 779 (% style="color:blue" %)**//2). MQTT  Sub//**
Xiaoye 115.1 780
781 If you don't want to store the information via node-red, you can get the output via the subscribe command.
782
783
784 **If connecting from the same machine, you can use the following command to receive data:**
785
786 (% class="box infomessage" %)
Xiaoling 1.4 787 (((
Xiaoling 138.5 788 **mosquitto_sub -h localhost -t "application/#" -v**
Xiaoye 115.1 789 )))
790
791
Xiaoling 138.5 792 (% style="color:blue" %)**Different host**
Xiaoye 115.1 793
794 (% class="box infomessage" %)
795 (((
Xiaoling 138.5 796 **mosquitto_sub -h IPADDRESS -p 8883 ~-~-insecure ~-~-cafile ca.pem ~-~-cert cert.pem ~-~-key key.pem -t "application/#" -v**
Xiaoye 115.1 797 )))
798
799 [[image:image-20221012173639-1.png]]
800
801
Kilight Cao 138.1 802 = 9.  Trouble Shooting =
Xiaoye 115.1 803
Kilight Cao 138.1 804 == 9.1  MIC Mismatch or MIC Failed ==
Xiaoye 115.1 805
806
807 (((
Xiaoling 1.2 808 When the device is registered or the device is working normally, the problem of MIC mismatch and MIC failed occurs.
Xiaoling 1.4 809 )))
Xiaoling 1.2 810
Xiaoling 1.4 811 (((
Xiaoling 1.2 812 Under normal circumstances, users need to change the APPKEY to solve this problem.
Xiaoling 131.2 813
814
Xiaoling 1.4 815 )))
Copyright ©2010-2022 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0