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