Wiki source code of Notes for ChirpStack

Version 47.1 by Xiaoling on 2022/05/24 16:56

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
13.2	47	[[image:image-20220524163926-3.png]]
1.2	48
	49	Add the Network-servers
	50
	51	== 2.2 Step 2. Create Gateway-profiles ==
	52
13.2	53	[[image:image-20220524163952-4.png]]
1.2	54
	55	Create Gateway-profiles
	56
	57	== 2.3 Step 3. Create Service-profiles ==
	58
13.2	59	[[image:image-20220524164008-5.png]]
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
16.2	77	[[image:image-20220524164029-6.png]]
1.2	78
	79	Add the gateway
	80
16.2	81	[[image:image-20220524164048-7.png]]
1.2	82
	83	Configure the gateway
	84
	85	== 2.5 Step 5. Checking gateway Status ==
	86
16.2	87	[[image:image-20220524164104-8.png]]
1.2	88
	89	gateway Status
	90
17.2	91	[[image:image-20220524164129-9.png]]
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
20.2	118	[[image:image-20220524164205-10.png]]
9.1	119
	120	== 3.2 Access the gateway GUI ==
	121
	122	Access the gateway GUI interface of LoRaWAN~-~->LoRaWAN ~-~- Basic Station
	123
20.2	124	[[image:image-20220524164319-11.png]]
9.1	125
	126	User need to Choose the ChirpStack/Senet ~-~- Basic Station , input Server URI and Upload the TLS Certificate
	127
	128	(% class="box" %)
	129	(((
	130	Service Provider ~-~-> Choose the ChirpStack/Senet ~-~- Basic Station
	131
	132	LNS URI ~-~-> Enter the LNS URI address, For example : wss:~/~/xxxx.chirpstack.com:433 or ws:~/~/xxxx.chirpstack.com:3001
	133
	134	LNS TLS trust ~-~-> Upload the TLS Certificate
	135	)))
	136
	137	(% class="wikigeneratedid" %)
20.2	138	[[image:image-20220524164341-12.png]]
9.1	139
	140	== 3.3 Start Station ==
	141
	142	When the user has finished the configuration, Please click Sace&Apply to start station to connect ChirpStack
	143
	144	== 3.4 Successful Connection ==
	145
	146	If user completes the above steps, which will see live date in the ChirpStack.
	147
23.2	148	[[image:image-20220524164448-13.png]]
9.1	149
10.2	150	== 3.5 Trouble Shooting ==
9.1	151
	152	User can check the station log in the logread/system log page.
	153
23.2	154	[[image:image-20220524164514-14.png]]
9.1	155
	156	and recode the station log in the system/Recode log page.
	157
23.2	158	[[image:image-20220524164541-15.png]]
9.1	159
1.2	160	= 4. Downlink =
	161
	162	== 4.1 Chirpstack Downlink Note ==
	163
25.2	164	[[image:image-20220524164613-16.png]]
1.2	165
	166	Convert the data to Base64
	167
25.2	168	[[image:image-20220524164632-17.png]]
1.2	169
	170	Check ChripStack downlink DataRate
	171
27.2	172	[[image:image-20220524164724-18.png]]
1.2	173
	174	Make sure the RX2DR is the same in the end node
	175
	176	== 4.2 Loraserver Downlink Note ==
	177
	178	User can use MQTT to send downlink payload to ChirpStack to perform downstream to LoRaWAN End
	179
1.5	180	(((
1.2	181	Below is examples:
1.5	182	)))
1.2	183
1.4	184	(% class="box" %)
	185	(((
	186	Connect to your server via MQTT：
	187	MQTT Client ID: Any
	188	Protocol：mqtt/tcp Server IP：loraserver_ip:1883
1.2	189	User name: User name Password: password
1.4	190	)))
1.2	191
27.2	192	[[image:image-20220524164806-19.png]]
1.2	193
1.5	194	(((
1.2	195	MQTT Connect to ChirpStack
1.5	196	)))
1.2	197
1.5	198	(((
1.2	199	After connect
1.5	200	)))
1.2	201
1.4	202	(% class="box" %)
	203	(((
	204	Subscribe : Format：application/ID/device/ Device EUI/rx
1.2	205	Example: application/7/device/00aedb3da649cb23/rx
1.4	206	)))
1.2	207
1.4	208	(% class="box" %)
	209	(((
	210	Publish:
1.2	211	Format: Top: application/ID/device/ Device EUI/tx
	212	Payload: {"confirmed":true or false,"fPort":XX,"data":"xxxx"}
	213	Example: Top: application/7/device/00aedb3da649cb23/tx
	214	Payload: {"confirmed":true,"fPort":2,"data":"AwEB"}
1.4	215	)))
1.2	216
30.2	217	[[image:image-20220524164829-20.png]]
1.2	218
	219	MQTT Connect to ChirpStack
	220
1.4	221	(((
	222	(% 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/]]
	223	)))
1.2	224
30.2	225	[[image:image-20220524164849-21.png]]
1.2	226
	227	Choose to Use Hex for Encode
	228
	229	If we want send downstream hex 030101 to end node, the BASE64 payload is AwEB
	230
30.2	231	[[image:image-20220524164907-22.png]]
1.2	232
1.5	233	(((
1.2	234	Downlink payload encode javescript code: 可以在网站上运行以下Javsscript代码：
1.5	235	)))
1.2	236
1.4	237	(% class="box" %)
	238	(((
	239	function sha1_to_base64(sha1)
1.2	240	{
	241	var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
	242	var base64_rep = "";
	243	var cnt = 0;
	244	var bit_arr = 0;
	245	var bit_num = 0;
1.5	246	\\ for(var n = 0; n < sha1.length; ++n)
1.2	247	{
	248	if(sha1[n] >= 'A' && sha1[n] <= 'Z')
	249	{
	250	ascv = sha1.charCodeAt(n) - 55;
	251	}
	252	else if(sha1[n] >= 'a' && sha1[n] <= 'z')
	253	{
	254	ascv = sha1.charCodeAt(n) - 87;
	255	}
	256	else
	257	{
	258	ascv = sha1.charCodeAt(n) - 48;
	259	}
1.5	260	\\ bit_arr = (bit_arr << 4) \| ascv;
1.2	261	bit_num += 4;
	262	if(bit_num >= 6)
	263	{
1.4	264	bit_num -= 6;
1.2	265	base64_rep += digits[bit_arr >>> bit_num];
1.4	266	bit_arr &= ~~(-1 << bit_num);
1.2	267	}
	268	}
1.5	269	\\ if(bit_num > 0)
1.2	270	{
	271	bit_arr <<= 6 - bit_num;
	272	base64_rep += digits[bit_arr];
	273	}
1.5	274	\\ var padding = base64_rep.length % 4;
	275	\\ if(padding > 0)
1.2	276	{
	277	for(var n = 0; n < 4 - padding; ++n)
	278	{
	279	base64_rep += "=";
	280	}
	281	}
	282	return base64_rep;
	283	}
1.5	284	\\console.log(sha1_to_base64("data"));
	285	\\data is downlink payload required by end node.
1.4	286	e.g console.log(sha1_to_base64("030101"));
	287	result: AwEB
1.2	288	AwEB is the 0x030101's base 64 Encode.
1.5	289	\\e.g console.log(sha1_to_base64("030000"));
1.4	290	result: AwAA
	291	AwAA is 0x030000's base 64 Encode.
	292	)))
1.2	293
	294	== 4.3 Add the decode function in Chirpstack for the payload ==
	295
	296	User enters the payload code according to the steps.
	297
36.2	298	[[image:image-20220524165001-23.png]]
1.2	299
36.2	300	[[image:image-20220524165028-24.png]]
1.2	301
36.2	302	[[image:image-20220524165100-25.png]]
1.2	303
36.2	304	[[image:image-20220524165116-26.png]]
1.2	305
	306	= 5. Multiply Uplink in ChirpStack =
	307
1.4	308	(((
1.2	309	nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data.
1.4	310	)))
1.2	311
1.4	312	(((
1.2	313	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	314	)))
1.2	315
36.2	316	[[image:image-20220524165141-27.png]]
1.2	317
1.5	318	(((
1.2	319	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	320	)))
1.2	321
36.2	322	[[image:image-20220524165158-28.png]]
1.2	323
1.4	324	(((
1.2	325	Above behaviour will cause the platform shows below two cases of error:
1.4	326	)))
1.2	327
1.4	328	(((
1.2	329	Error of duplicate Frame Counter
1.4	330	)))
1.2	331
37.2	332	[[image:image-20220524165301-29.png]]
1.2	333
	334	Duplicate transmission in short time
	335
40.2	336	[[image:image-20220524165319-30.png]]
1.2	337
	338	== 5.1 Solution ==
	339
	340	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]]
	341
1.5	342	(((
1.2	343	~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	344	)))
1.2	345
40.2	346	[[image:image-20220524165339-31.png]]
1.2	347
	348	installation path:
	349
40.2	350	[[image:image-20220524165400-32.png]]
1.2	351
1.5	352	(((
1.2	353	2. Environment variable settings:.
1.5	354	)))
1.2	355
1.5	356	(((
1.2	357	1) Open Computer -> Properties -> Advanced System Settings -> Environment Variables and add a "new" system variable:
1.5	358	)))
1.2	359
1.5	360	(((
1.2	361	2)Set the variable name GOROOT and the variable value C:\Go\ (installation directory)
1.5	362	)))
1.2	363
43.2	364	[[image:image-20220524165433-33.png]]
1.2	365
	366	3)Modify the system variable Path and add C:\Go\bin\:
	367
43.2	368	[[image:image-20220524165452-34.png]]
1.2	369
	370	User variable setting file generation directory: D:\go:
	371
43.2	372	[[image:image-20220524165517-35.png]]
1.2	373
	374	3. Modify the ADR configuration file according to your own needs, adr.setting.go is an example of the ADR configuration file.
	375
	376	The name of the plugin: Example ADR plugin:
	377
	378	[[image:https://wiki.dragino.com/images/1/12/Chirpstacksolution-6.jpg\|\|alt="Chirpstacksolution-6.jpg" height="89" width="554"]]
	379
	380	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.
	381
	382	[[image:https://wiki.dragino.com/images/2/25/Chirpstacksolution-7.png\|\|alt="Chirpstacksolution-7.png" height="98" width="426"]]
	383
	384	4. Compile the ADR configuration file and generate the exe file.
	385
	386	1) Create a folder named adr-setting
	387
	388	2) Open the adr-setting folder
	389
	390	3) Put adr.setting.go in this folder.
	391
	392	4) Open the computer cmd and run the following commands in sequencecd adr-setting
	393
	394	go mod init adr-setting
	395
	396	go get github.com/brocaar/chirpstack-network-server/v3/adr
	397
	398	go get github.com/hashicorp/go-plugin
	399
	400	go get adr-setting
	401
	402	go build
	403
	404	5) Finally generate this file：
	405
	406	[[image:https://wiki.dragino.com/images/6/66/Chirpstacksolution-8.png\|\|alt="Chirpstacksolution-8.png" height="96" width="554"]]
	407
	408	5. Add the plugin and run the plugin.
	409
1.5	410	(((
1.2	411	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	412	)))
1.2	413
	414	[[image:https://wiki.dragino.com/images/8/82/Chirpstacksolution-9.png\|\|alt="Chirpstacksolution-9.png" height="73" width="554"]]
	415
1.4	416	(((
1.5	417	(((
1.2	418	For example: adr_plugins=[“adr-setting”]
1.4	419	)))
1.5	420	)))
1.2	421
1.4	422	* (((
1.5	423	(((
1.4	424	Adding a single plugin format is adr_plugins=["filename"]
	425	)))
1.5	426	)))
1.2	427
1.4	428	* (((
1.5	429	(((
1.4	430	Adding multiple plugins The format is adr_plugins=["file name 1", "file name 2",...]
	431	)))
1.5	432	)))
1.2	433
1.4	434	(((
1.5	435	(((
1.2	436	Finally, re-run chirpstack-network-server.exe, and then select the plugin you just compiled in Device-profiles,
1.4	437	)))
1.5	438	)))
1.2	439
	440	[[image:https://wiki.dragino.com/images/3/39/Chirpstacksolution-10.png\|\|alt="Chirpstacksolution-10.png" height="275" width="554"]]
	441
	442	Finish.
	443
	444	= 6. Trouble Shooting =
	445
	446	== 6.1 MIC Mismatch or MIC Failed ==
	447
1.4	448	(((
1.2	449	When the device is registered or the device is working normally, the problem of MIC mismatch and MIC failed occurs.
1.4	450	)))
1.2	451
1.4	452	(((
1.2	453	Under normal circumstances, users need to change the APPKEY to solve this problem.
1.4	454	)))

Wiki source code of Notes for ChirpStack

Applications

Navigation