Wiki source code of Notes for ChirpStack

Version 12.1 by Xiaoling on 2022/05/24 16:39

version	line-number	content
1.7	1	~ Contents:
1.2	2
1.1	3	{{toc/}}
	4
1.2	5	= 1. Introduction =
1.1	6
1.2	7	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	8
1.5	9	(((
1.2	10	The dragino gateway can connect the ChirpStack server via Semtech UDP or Semtech Basic Station.
1.5	11	)))
1.1	12
1.2	13	Prerequisite
1.1	14
1.2	15	1) Have a Chirstack Server.
1.1	16
10.3	17	[[image:image-20220524163736-2.png]]
1.1	18
10.2	19
1.2	20	ChirpStack home page
1.1	21
1.2	22	2) Gateway model support
1.1	23
1.2	24	(% class="box" %)
	25	(((
1.5	26	(((
1.2	27	Semtech UDP : All Model
	28	Basic Station : , ,
	29	Note : the firmware needs > if use the Bais station
	30	)))
1.5	31	)))
1.1	32
1.2	33	= 2. Semtech UDP =
1.1	34
1.2	35	== 2.1 Step 1. Add the Network-servers ==
1.1	36
1.2	37	The network-Servers address varies depending on the ChirpStack server setup environment
1.1	38
1.3	39	(% class="box" %)
	40	(((
	41	Windows ~-~->Network-server server * : localhost:8000
	42	Linux ~-~->Network-server server * : chirpstack-network-server:8000
	43	)))
1.1	44
1.2	45	If the user cannot add network-Servers, re-check the ChirpStack code or the server building process.
1.1	46
9.1	47	[[image:https://wiki.dragino.com/images/thumb/6/6b/Add_the_Network-servers.png/600px-Add_the_Network-servers.png\|\|height="424" width="700"]]
1.2	48
	49	Add the Network-servers
	50
	51	== 2.2 Step 2. Create Gateway-profiles ==
	52
9.1	53	[[image:https://wiki.dragino.com/images/thumb/a/a9/Create_Gateway-profiles.png/600px-Create_Gateway-profiles.png\|\|height="424" width="700"]]
1.2	54
	55	Create Gateway-profiles
	56
	57	== 2.3 Step 3. Create Service-profiles ==
	58
9.1	59	[[image:https://wiki.dragino.com/images/thumb/1/1f/Create_Service-profiles.png/600px-Create_Service-profiles.png\|\|height="424" width="700"]]
1.2	60
	61	Create Service-profiles
	62
	63	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.
	64
1.4	65	(% style="color:red" %)Note : Before add the gateway, the user needs to complete the preceding three steps.
1.2	66
	67	If the user has completed the preceding steps, proceed to the next step.
	68
	69	== 2.4 Step 4. Add the gateway ==
	70
	71	The example gateway id is: a840411e96744150
	72
1.5	73	(((
1.4	74	(% style="color:red" %)Note : The Gateway EUI and server addresses must match the ChirpStack configuration.
1.5	75	)))
1.2	76
9.1	77	[[image:https://wiki.dragino.com/images/thumb/c/c6/Add_the_gateway.png/600px-Add_the_gateway.png\|\|height="424" width="700"]]
1.2	78
	79	Add the gateway
	80
9.1	81	[[image:https://wiki.dragino.com/images/thumb/1/14/ChirpStack_Configure_the_gateway.png/600px-ChirpStack_Configure_the_gateway.png\|\|height="355" width="700"]]
1.2	82
	83	Configure the gateway
	84
	85	== 2.5 Step 5. Checking gateway Status ==
	86
9.1	87	[[image:https://wiki.dragino.com/images/thumb/2/2c/Gateway_Status_cao_1.png/600px-Gateway_Status_cao_1.png\|\|height="424" width="700"]]
1.2	88
	89	gateway Status
	90
9.1	91	[[image:https://wiki.dragino.com/images/thumb/1/11/Gateway_Status_cao_2.png/600px-Gateway_Status_cao_2.png\|\|height="424" width="700"]]
1.2	92
	93	gateway Status
	94
9.1	95	= 3. Gateway Registration for Basics Station =
1.2	96
9.1	97	== Introduction ==
	98
	99	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.
	100
	101	ChirpStack Open-Source LoRaWAN® Network Server needs to set up a configuration that can use Semtech BasicStation.
	102
	103	Below list the support products and Requirements:
	104
	105	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]]
	106	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/]]
	107
	108	How to set up chirpStack Basic Station
	109
	110	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]]
	111
	112	What do you need to prepare
	113
	114	A gateway that can access the internet normally
	115
	116	== 3.1 Add Gateway ==
	117
	118	[[image:image-20220519152235-5.png\|\|height="338" width="699"]]
	119
	120
	121	== 3.2 Access the gateway GUI ==
	122
	123	Access the gateway GUI interface of LoRaWAN~-~->LoRaWAN ~-~- Basic Station
	124
	125	[[image:image-20220519151612-4.png\|\|height="208" width="700"]]
	126
	127	User need to Choose the ChirpStack/Senet ~-~- Basic Station , input Server URI and Upload the TLS Certificate
	128
	129	(% class="box" %)
	130	(((
	131	Service Provider ~-~-> Choose the ChirpStack/Senet ~-~- Basic Station
	132
	133	LNS URI ~-~-> Enter the LNS URI address, For example : wss:~/~/xxxx.chirpstack.com:433 or ws:~/~/xxxx.chirpstack.com:3001
	134
	135	LNS TLS trust ~-~-> Upload the TLS Certificate
	136	)))
	137
	138	(% class="wikigeneratedid" %)
	139	[[image:image-20220519153027-6.png\|\|height="371" width="704"]]
	140
	141	== 3.3 Start Station ==
	142
	143	When the user has finished the configuration, Please click Sace&Apply to start station to connect ChirpStack
	144
	145	== 3.4 Successful Connection ==
	146
	147	If user completes the above steps, which will see live date in the ChirpStack.
	148
	149	[[image:image-20220519154215-7.png\|\|height="400" width="707"]]
	150
10.2	151	== 3.5 Trouble Shooting ==
9.1	152
	153	User can check the station log in the logread/system log page.
	154
	155	[[image:https://wiki.dragino.com/images/thumb/7/7c/Station_log_xiao.png/600px-Station_log_xiao.png]]
	156
	157	and recode the station log in the system/Recode log page.
	158
	159	[[image:https://wiki.dragino.com/images/thumb/5/50/Recore_log_xiao.png/600px-Recore_log_xiao.png]]
	160
1.2	161	= 4. Downlink =
	162
	163	== 4.1 Chirpstack Downlink Note ==
	164
9.1	165	[[image:https://wiki.dragino.com/images/thumb/b/ba/ChirpStack_Down_5.png/600px-ChirpStack_Down_5.png\|\|height="342" width="700"]]
1.2	166
	167	Convert the data to Base64
	168
9.1	169	[[image:https://wiki.dragino.com/images/thumb/2/2c/ChirpStack_Down_6.png/600px-ChirpStack_Down_6.png\|\|height="349" width="697"]]
1.2	170
	171	Check ChripStack downlink DataRate
	172
	173	[[image:https://wiki.dragino.com/images/thumb/d/dc/ChirpStack_Down_7.png/600px-ChirpStack_Down_7.png\|\|height="711" width="600"]]
	174
	175	Make sure the RX2DR is the same in the end node
	176
	177	== 4.2 Loraserver Downlink Note ==
	178
	179	User can use MQTT to send downlink payload to ChirpStack to perform downstream to LoRaWAN End
	180
1.5	181	(((
1.2	182	Below is examples:
1.5	183	)))
1.2	184
1.4	185	(% class="box" %)
	186	(((
	187	Connect to your server via MQTT：
	188	MQTT Client ID: Any
	189	Protocol：mqtt/tcp Server IP：loraserver_ip:1883
1.2	190	User name: User name Password: password
1.4	191	)))
1.2	192
	193	[[image:https://wiki.dragino.com/images/thumb/0/06/ChirpStack_Down_1.png/600px-ChirpStack_Down_1.png\|\|height="578" width="600"]]
	194
1.5	195	(((
1.2	196	MQTT Connect to ChirpStack
1.5	197	)))
1.2	198
1.5	199	(((
1.2	200	After connect
1.5	201	)))
1.2	202
1.4	203	(% class="box" %)
	204	(((
	205	Subscribe : Format：application/ID/device/ Device EUI/rx
1.2	206	Example: application/7/device/00aedb3da649cb23/rx
1.4	207	)))
1.2	208
1.4	209	(% class="box" %)
	210	(((
	211	Publish:
1.2	212	Format: Top: application/ID/device/ Device EUI/tx
	213	Payload: {"confirmed":true or false,"fPort":XX,"data":"xxxx"}
	214	Example: Top: application/7/device/00aedb3da649cb23/tx
	215	Payload: {"confirmed":true,"fPort":2,"data":"AwEB"}
1.4	216	)))
1.2	217
	218	[[image:https://wiki.dragino.com/images/thumb/c/c8/ChirpStack_Down_2.png/600px-ChirpStack_Down_2.png\|\|height="342" width="600"]]
	219
	220	MQTT Connect to ChirpStack
	221
1.4	222	(((
	223	(% style="color:red" %)Note: Chirpstack use base64 to downlink, so need to convert the downlink payload from HEX to base64 [[https:~~/~~/base64.us/>>url:https://base64.us/]]
	224	)))
1.2	225
	226	[[image:https://wiki.dragino.com/images/thumb/f/f8/ChirpStack_Down_3.png/600px-ChirpStack_Down_3.png\|\|height="309" width="600"]]
	227
	228	Choose to Use Hex for Encode
	229
	230	If we want send downstream hex 030101 to end node, the BASE64 payload is AwEB
	231
	232	[[image:https://wiki.dragino.com/images/thumb/d/d2/ChirpStack_Down_4.png/600px-ChirpStack_Down_4.png\|\|alt="ChirpStack Down 4.png" height="344" width="600"]]
	233
1.5	234	(((
1.2	235	Downlink payload encode javescript code: 可以在网站上运行以下Javsscript代码：
1.5	236	)))
1.2	237
1.4	238	(% class="box" %)
	239	(((
	240	function sha1_to_base64(sha1)
1.2	241	{
	242	var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
	243	var base64_rep = "";
	244	var cnt = 0;
	245	var bit_arr = 0;
	246	var bit_num = 0;
1.5	247	\\ for(var n = 0; n < sha1.length; ++n)
1.2	248	{
	249	if(sha1[n] >= 'A' && sha1[n] <= 'Z')
	250	{
	251	ascv = sha1.charCodeAt(n) - 55;
	252	}
	253	else if(sha1[n] >= 'a' && sha1[n] <= 'z')
	254	{
	255	ascv = sha1.charCodeAt(n) - 87;
	256	}
	257	else
	258	{
	259	ascv = sha1.charCodeAt(n) - 48;
	260	}
1.5	261	\\ bit_arr = (bit_arr << 4) \| ascv;
1.2	262	bit_num += 4;
	263	if(bit_num >= 6)
	264	{
1.4	265	bit_num -= 6;
1.2	266	base64_rep += digits[bit_arr >>> bit_num];
1.4	267	bit_arr &= ~~(-1 << bit_num);
1.2	268	}
	269	}
1.5	270	\\ if(bit_num > 0)
1.2	271	{
	272	bit_arr <<= 6 - bit_num;
	273	base64_rep += digits[bit_arr];
	274	}
1.5	275	\\ var padding = base64_rep.length % 4;
	276	\\ if(padding > 0)
1.2	277	{
	278	for(var n = 0; n < 4 - padding; ++n)
	279	{
	280	base64_rep += "=";
	281	}
	282	}
	283	return base64_rep;
	284	}
1.5	285	\\console.log(sha1_to_base64("data"));
	286	\\data is downlink payload required by end node.
1.4	287	e.g console.log(sha1_to_base64("030101"));
	288	result: AwEB
1.2	289	AwEB is the 0x030101's base 64 Encode.
1.5	290	\\e.g console.log(sha1_to_base64("030000"));
1.4	291	result: AwAA
	292	AwAA is 0x030000's base 64 Encode.
	293	)))
1.2	294
	295	== 4.3 Add the decode function in Chirpstack for the payload ==
	296
	297	User enters the payload code according to the steps.
	298
	299	[[image:https://wiki.dragino.com/images/thumb/9/9f/Step2.png/600px-Step2.png\|\|alt="Step2.png" height="224" width="600"]]
	300
	301	[[image:https://wiki.dragino.com/images/thumb/0/08/Step3.png/600px-Step3.png\|\|alt="Step3.png" height="289" width="600"]]
	302
	303	[[image:https://wiki.dragino.com/images/thumb/8/83/Step6.png/600px-Step6.png\|\|alt="Step6.png" height="259" width="600"]]
	304
	305	[[image:https://wiki.dragino.com/images/thumb/4/4f/Step5.png/600px-Step5.png\|\|alt="Step5.png" height="221" width="600"]]
	306
	307	= 5. Multiply Uplink in ChirpStack =
	308
1.4	309	(((
1.2	310	nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data.
1.4	311	)))
1.2	312
1.4	313	(((
1.2	314	ChirpStack will auto adjust nbtrans according to uplink rssi. [[link to source>>url:https://github.com/brocaar/chirpstack-network-server/blob/master/internal/adr/adr.go]]
1.4	315	)))
1.2	316
	317	[[image:https://wiki.dragino.com/images/thumb/6/63/Nbtrans_1.png/600px-Nbtrans_1.png\|\|alt="Nbtrans 1.png" height="103" width="600"]]
	318
1.5	319	(((
1.2	320	nbtrans is a field of ADR message, in unconfirm mode, it tells end node how many time it needs to transmit for every frame.
1.5	321	)))
1.2	322
	323	[[image:https://wiki.dragino.com/images/thumb/1/17/Nbtrans_2.png/300px-Nbtrans_2.png\|\|alt="Nbtrans 2.png" height="462" width="300"]]
	324
1.4	325	(((
1.2	326	Above behaviour will cause the platform shows below two cases of error:
1.4	327	)))
1.2	328
1.4	329	(((
1.2	330	Error of duplicate Frame Counter
1.4	331	)))
1.2	332
	333	[[image:https://wiki.dragino.com/images/7/7e/Nbtrans_3.png\|\|alt="Nbtrans 3.png" height="677" width="600"]]
	334
	335	Duplicate transmission in short time
	336
	337	[[image:https://wiki.dragino.com/images/thumb/c/c4/Nbtrans_4.png/600px-Nbtrans_4.png\|\|alt="Nbtrans 4.png" height="301" width="600"]]
	338
	339	== 5.1 Solution ==
	340
	341	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]]
	342
1.5	343	(((
1.2	344	~1. Install the GO compilation environment: Download the corresponding version of the Go compiler at [[https:~~/~~/go.dev/dl/>>url:https://go.dev/dl/]] and install it.
1.5	345	)))
1.2	346
	347	[[image:https://wiki.dragino.com/images/3/37/Chirpstacksolution-1.png\|\|alt="Chirpstacksolution-1.png" height="199" width="554"]]
	348
	349	installation path:
	350
	351	[[image:https://wiki.dragino.com/images/c/ca/Chirpstacksolution-2.png\|\|alt="Chirpstacksolution-2.png" height="283" width="361"]]
	352
1.5	353	(((
1.2	354	2. Environment variable settings:.
1.5	355	)))
1.2	356
1.5	357	(((
1.2	358	1) Open Computer -> Properties -> Advanced System Settings -> Environment Variables and add a "new" system variable:
1.5	359	)))
1.2	360
1.5	361	(((
1.2	362	2)Set the variable name GOROOT and the variable value C:\Go\ (installation directory)
1.5	363	)))
1.2	364
	365	[[image:https://wiki.dragino.com/images/f/f9/Chirpstacksolution-3.png\|\|alt="Chirpstacksolution-3.png" height="152" width="554"]]
	366
	367	3)Modify the system variable Path and add C:\Go\bin\:
	368
	369	[[image:https://wiki.dragino.com/images/1/1b/Chirpstacksolution-4.png\|\|alt="Chirpstacksolution-4.png" height="152" width="554"]]
	370
	371	User variable setting file generation directory: D:\go:
	372
	373	[[image:https://wiki.dragino.com/images/9/9b/Chirpstacksolution-5.png\|\|alt="Chirpstacksolution-5.png" height="278" width="371"]]
	374
	375	3. Modify the ADR configuration file according to your own needs, adr.setting.go is an example of the ADR configuration file.
	376
	377	The name of the plugin: Example ADR plugin:
	378
	379	[[image:https://wiki.dragino.com/images/1/12/Chirpstacksolution-6.jpg\|\|alt="Chirpstacksolution-6.jpg" height="89" width="554"]]
	380
	381	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.
	382
	383	[[image:https://wiki.dragino.com/images/2/25/Chirpstacksolution-7.png\|\|alt="Chirpstacksolution-7.png" height="98" width="426"]]
	384
	385	4. Compile the ADR configuration file and generate the exe file.
	386
	387	1) Create a folder named adr-setting
	388
	389	2) Open the adr-setting folder
	390
	391	3) Put adr.setting.go in this folder.
	392
	393	4) Open the computer cmd and run the following commands in sequencecd adr-setting
	394
	395	go mod init adr-setting
	396
	397	go get github.com/brocaar/chirpstack-network-server/v3/adr
	398
	399	go get github.com/hashicorp/go-plugin
	400
	401	go get adr-setting
	402
	403	go build
	404
	405	5) Finally generate this file：
	406
	407	[[image:https://wiki.dragino.com/images/6/66/Chirpstacksolution-8.png\|\|alt="Chirpstacksolution-8.png" height="96" width="554"]]
	408
	409	5. Add the plugin and run the plugin.
	410
1.5	411	(((
1.2	412	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	413	)))
1.2	414
	415	[[image:https://wiki.dragino.com/images/8/82/Chirpstacksolution-9.png\|\|alt="Chirpstacksolution-9.png" height="73" width="554"]]
	416
1.4	417	(((
1.5	418	(((
1.2	419	For example: adr_plugins=[“adr-setting”]
1.4	420	)))
1.5	421	)))
1.2	422
1.4	423	* (((
1.5	424	(((
1.4	425	Adding a single plugin format is adr_plugins=["filename"]
	426	)))
1.5	427	)))
1.2	428
1.4	429	* (((
1.5	430	(((
1.4	431	Adding multiple plugins The format is adr_plugins=["file name 1", "file name 2",...]
	432	)))
1.5	433	)))
1.2	434
1.4	435	(((
1.5	436	(((
1.2	437	Finally, re-run chirpstack-network-server.exe, and then select the plugin you just compiled in Device-profiles,
1.4	438	)))
1.5	439	)))
1.2	440
	441	[[image:https://wiki.dragino.com/images/3/39/Chirpstacksolution-10.png\|\|alt="Chirpstacksolution-10.png" height="275" width="554"]]
	442
	443	Finish.
	444
	445	= 6. Trouble Shooting =
	446
	447	== 6.1 MIC Mismatch or MIC Failed ==
	448
1.4	449	(((
1.2	450	When the device is registered or the device is working normally, the problem of MIC mismatch and MIC failed occurs.
1.4	451	)))
1.2	452
1.4	453	(((
1.2	454	Under normal circumstances, users need to change the APPKEY to solve this problem.
1.4	455	)))

Wiki source code of Notes for ChirpStack

Applications

Navigation