Notes for ChirpStack

Version 151.1 by Kilight Cao on 2023/06/01 08:40

     Table of Contents:

1.  Introduction

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

The dragino gateway can connect the ChirpStack server via Semtech UDP or Semtech Basic Station.

 

Prerequisite:

1) Have a Chirstack Server.

image-20220525100058-1.png

ChirpStack home page

2) Gateway model support

Semtech UDP : All Model
Basic Station : LIG16, LG308, DLOS8 LPS8
Note : the firmware needs >lgw--build-v5.4.1640315898  if use the Bais station

2.  Semtech UDP

2.1  Step 1. Add the Network-servers

The network-Servers address varies depending on the ChirpStack server setup environment

   Windows       -->  Network-server server *   :   localhost:8000
   Linux             -->  Network-server server *   :   chirpstack-network-server:8000

If the user cannot add network-Servers, re-check the ChirpStack code or the server building process.

image-20220531171609-1.png

Add the Network-servers

2.2  Step 2. Create Gateway-profiles

image-20220531171651-2.png

Create Gateway-profiles

2.3  Step 3. Create Service-profiles

image-20220531171809-3.png

Create Service-profiles

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.

Note : Before add the gateway, the user needs to complete the preceding three steps.

If the user has completed the preceding steps, proceed to the next step. 

2.4  Step 4. Add the gateway

The example gateway id is: a840411e96744150

Note : The Gateway EUI and server addresses must match the ChirpStack configuration.

 

image-20220531171923-4.png 

Add the gateway

image-20220531172031-5.png

Configure the gateway

2.5  Step 5. Checking gateway Status

image-20220531172158-6.png 

gateway Status

image-20220531172304-7.png

gateway Status

3.  Gateway Registration for Basics Station

3.1  Introduction

The Semtech Basic Station backend implements the LNS protocol. It exposes a WebSocket handler to which Basic Station powered gateways can connect.

ChirpStack Open-Source LoRaWAN® Network Server needs to set up a configuration that can use Semtech BasicStation.

Below list the support products and Requirements:

  1. LoRaWAN Gateway model: LIG16, LG308, DLOS8 ,LPS8
  2. Firmware version since :lgw--build-v5.4.1651822913

How to set up chirpStack Basic Station

Users can check out the ChirpStack Basic Station link and forum

What do you need to prepare

A gateway that can access the internet normally

3.2  Add Gateway

image-20220524164205-10.png

3.3  Access the gateway GUI

Access the gateway GUI interface of LoRaWAN-->LoRaWAN -- Basic Station

image-20220524164319-11.png

User need to Choose the ChirpStack/Senet -- Basic Station , input Server URI and Upload the TLS Certificate

Service Provider                -->     Choose the ChirpStack/Senet -- Basic Station

LNS URI                             -->     Enter the LNS URI address, For example : wss://xxxx.chirpstack.com:433 or ws://xxxx.chirpstack.com:3001

LNS TLS trust                     -->    Upload the TLS Certificate 

image-20220524164341-12.png

3.4  Start Station

When the user has finished the configuration, Please click Sace&Apply to start station to connect ChirpStack.

3.5  Successful Connection

If user completes the above steps, which will see live date in the ChirpStack.

image-20220524164448-13.png

3.6  Trouble Shooting

User can check the station log in the logread/system log page.

image-20220531172837-8.png

and recode the station log in the system/Recode log page.

image-20220531172857-9.png

4.  How the gateway connects to Chirpstack v3 via gateway-bridge

Below list the support products and Requirements:

  1. LoRaWAN Gateway model: LIG16, LG308, DLOS8 ,LPS8,LPS8N,LG308N,DLOS8N
  2. Firmware version since: Chirpstack-Bridge-V3.14.6

How to set up chirpStack Gateway-bridge

Users can check out the ChirpStack gateway-bridge v3 link

What do you need to prepare

A gateway that can access the internet normally

The following example does not have configuration certificates:

4.1  Configure Packet Forwarder

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

  • In the LoRaWAN menu, click on LoRaWAN -- Semtech UDP
  • Make sure the following settings are set:
    • Service Provider: --Custom/Private LoRaWAN--
    • LoRaWAN Server Address: localhost or 127.0.0.1
    • Server port for upstream: 1700
    • Server port for downstream: 1700

      Click Save & Apply.

image-20221222114220-2.png

4.2  Configuring gateway frequency

Note: Gateway frequencies must match

image-20221222134830-3.png

4.3  Generate and modify the gateway-bridge configuration file

1）Generate the gateway-bridge configuration file

By default, the configuration file is not up-to-date,so the user needs to rebuild the gateway-bridge configuration file.

Users need to access the command line of the gateway through SSH,Then type the following command:

/opt/chirpstack-gateway-bridge/chirpstack-gateway-bridge configfile > /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml 

2）modify the gateway-bridge configuration file

The user needs to modify the server address in line 252 in the configuration file

vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml 

image-20230415165254-1.png

4.4  Debug

After the above configuration is completed, the user can enter the command to debug the gateway-bridge connection

/opt/chirpstack-gateway-bridge/chirpstack-gateway-bridge --config /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml

If the gateway-bridge connection is normal, the debug log displays "connected to mqtt broker".

image-20230415170404-2.png

If the debug log shows "connection error", check that the server port or server is correct

image-20230415170854-3.png

More information can be found on the ChirpStack websiteor Forum

4.5  (Re)start and stop gateway-bridge

Use the following commands to (re)start and stop the ChirpStack Gateway Bridge Service:

# start

/etc/init.d/chirpstack-gateway-bridge start

# stop

/etc/init.d/chirpstack-gateway-bridge stop

# restart

/etc/init.d/chirpstack-gateway-bridge restart

5.  How the gateway connects to Chirpstack v4 via gateway-bridge

Below list the support products and Requirements:

  1. LoRaWAN Gateway model: LIG16, LG308, DLOS8 ,LPS8,LPS8N,LG308N,DLOS8N
  2. Firmware version since: Chirpstack-Bridge-V4

How to set up chirpStack Gateway-bridge

Users can check out the ChirpStack gateway-bridge v4 link

What do you need to prepare

A gateway that can access the internet normally

5.1  Configure Packet Forwarder

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

  • In the LoRaWAN menu, click on LoRaWAN -- Semtech UDP
  • Make sure the following settings are set:
    • Service Provider: --Custom/Private LoRaWAN--
    • LoRaWAN Server Address: localhost or 127.0.0.1
    • Server port for upstream: 1700
    • Server port for downstream: 1700

      Click Save & Apply.

image-20221222114220-2.png

5.2  Configuring gateway frequency

Note: Gateway frequencies must match

image-20221222134830-3.png

5.3  Modify the gateway-bridge configuration file

Run the gateway command line command to modify the gateway-bridge configuration file:

root@dragino-1d27d4:~#  vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml 

image-20221222113302-1.png

image-20221222140203-4.png

image-20221230094246-1.png

After the modification, run the following command: /etc/init.d/chirpstack-gateway-bridge restart

5.4  (Re)start and stop gateway-bridge

Use the following commands to (re)start and stop the ChirpStack Gateway Bridge Service:

# start

/etc/init.d/chirpstack-gateway-bridge start

# stop

/etc/init.d/chirpstack-gateway-bridge stop

# restart

/etc/init.d/chirpstack-gateway-bridge restart

5.5  Successful Connection

image-20221222141754-5.png

image-20221222141830-6.png

6.  Downlink

6.1  Convert HEX to Base64

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.

Online HEX to Base64 Converter:

image-20221010193350-1.png

Online Base64 to Hex converter

image-20221010193621-2.png

6.2  Chirpstack Downlink Note

image-20220601102543-2.png

Convert the data to Base64

  

image-20220531173236-10.png

Check ChripStack downlink DataRate

image-20220525101326-11.png

Make sure the RX2DR is the same in the end node

6.3  Loraserver Downlink Note

User can use MQTT to send downlink payload to ChirpStack to perform downstream to LoRaWAN End

Below is examples:

Connect to your server via MQTT：
MQTT Client ID: Any   
Protocol：mqtt/tcp   Server IP：loraserver_ip:1883
User name: User name Password: password

image-20220531173419-11.png

MQTT Connect to ChirpStack

 

After connect

Subscribe : Format：application/ID/device/ Device EUI/rx
Example: application/7/device/00aedb3da649cb23/rx

Publish:
Format: Top: application/ID/device/ Device EUI/tx
Payload: {"confirmed":true or false,"fPort":XX,"data":"xxxx"}
Example: Top: application/7/device/00aedb3da649cb23/tx
Payload: {"confirmed":true,"fPort":2,"data":"AwEB"} 

image-20220531173519-12.png

MQTT Connect to ChirpStack

If we want to send downstream hex 030101 to end node, the BASE64 payload is AwEB

image-20220531173658-14.png

Downlink payload encode javescript code: 可以在网站上运行以下Javsscript代码：

function sha1_to_base64(sha1)
{
    var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
    var base64_rep = "";
    var cnt = 0;
    var bit_arr = 0;
    var bit_num = 0;

    for(var n = 0; n < sha1.length; ++n)
    {
        if(sha1[n] >= 'A' && sha1[n] <= 'Z')
        {
            ascv = sha1.charCodeAt( n ) - 55;
        }
        else if(sha1[n] >= 'a' && sha1[n] <= 'z')
        {
           ascv = sha1.charCodeAt( n ) - 87;
        }
        else
        {
            ascv = sha1.charCodeAt( n ) - 48;
        }

        bit_arr = (bit_arr << 4) | ascv;
        bit_num += 4;
        if(bit_num >= 6)
        {
            bit_num -= 6;        
            base64_rep += digits[bit_arr >>> bit_num];
            bit_arr &= ~(-1 << bit_num);
        }
    }

    if(bit_num > 0)
    {
        bit_arr <<= 6 - bit_num;
        base64_rep += digits[bit_arr];
    }

    var padding = base64_rep.length % 4;   

    if(padding > 0)
    {
        for(var n = 0; n < 4 - padding; ++n)
        {
            base64_rep += "=";
        }
    }
    return base64_rep;
}

console.log(sha1_to_base64("data"));

data is downlink payload required by end node.
e.g console.log(sha1_to_base64("030101"));
    ​result: AwEB     
    AwEB is the 0x030101's base 64 Encode.

​e.g console.log(sha1_to_base64("030000"));
    ​result: AwAA     
    AwAA is 0x030000's base 64 Encode.

6.4  Add the decode function in Chirpstack for the payload

User enters the payload code according to the steps.

Add the node device decoder you are using. The decoder for each node device is different. The decoder is found in this link: decoder for dragino end node

image-20220531173754-15.png

image-20220531173856-16.png

image-20220531174120-20.png

image-20220531174046-19.png

7.  Multiply Uplink in ChirpStack

nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data.

ChirpStack will auto adjust nbtrans according to uplink rssi. link to source

 

image-20220526091912-7.png

nbtrans is a field of ADR message, in unconfirm mode, it tells end node how many time it needs to transmit for every frame.

 

image-20220525104359-21.png

Above behaviour will cause the platform shows below two cases of error:

 

Error of duplicate Frame Counter

image-20220525104437-22.png

Duplicate transmission in short time

image-20220601102430-1.png

7.1  Solution

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

1.  Install the GO compilation environment: Download the corresponding version of the Go compiler at https://go.dev/dl/ and install it.

 

image-20220525104532-24.png

installation path:

image-20220525104554-25.png

2.  Environment variable settings:

1) Open Computer -> Properties -> Advanced System Settings -> Environment Variables and add a "new" system variable:

2) Set the variable name GOROOT and the variable value C:\Go\ (installation directory)

image-20220524165433-33.png

3) Modify the system variable Path and add C:\Go\bin\:

image-20220524165452-34.png

User variable setting file generation directory: D:\go:

image-20220524165517-35.png

3.  Modify the ADR configuration file according to your own needs, adr.setting.go is an example of the ADR configuration file.

The name of the plugin: Example ADR plugin:

image-20220524165540-36.png

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.

image-20220524165557-37.png

4.  Compile the ADR configuration file and generate the exe file.

1) Create a folder named adr-setting

2) Open the adr-setting folder

3) Put adr.setting.go in this folder.

4) Open the computer cmd and run the following commands in sequencecd adr-setting

go mod init adr-setting

go get github.com/brocaar/chirpstack-network-server/v3/adr

go get github.com/hashicorp/go-plugin

go get adr-setting

go build

5) Finally generate this file：

image-20220524165623-38.png

5.  Add the plugin and run the plugin.

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:

image-20220524165641-39.png

For example: adr_plugins=[“adr-setting”]

  • Adding a single plugin format is adr_plugins=["filename"]

  • Adding multiple plugins The format is adr_plugins=["file name 1", "file name 2",...]

Finally, re-run chirpstack-network-server.exe, and then select the plugin you just compiled in Device-profiles,

image-20220525104647-26.png

Finish.

8.  How to store/get all data traffic for a specific sensor, including raw payload, and uplink/ downlink history.

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.

This example will be shown how to store/get all the data in two ways:

1). Chirpstack --> Node-red

image-20221012184501-1.png

Use MQTT in Nore-red to subscribe to topics published by the chirpstack-application and then continuously write to a file

image-20221012174220-2.png

image-20221012184655-3.png

Each message is continuously logged to a specified file

image-20221012174352-3.png

2). MQTT  Sub

If you don't want to store the information via node-red, you can get the output via the subscribe command.

If connecting from the same machine, you can use the following command to receive data:

mosquitto_sub -h localhost -t "application/#" -v

Different host

mosquitto_sub -h IPADDRESS -p 8883 --insecure --cafile ca.pem --cert cert.pem --key key.pem -t "application/#" -v

image-20221012173639-1.png

9.  Example: Use Local Server ChirpStack and Node-Red in LPS8v2

LPS8v2 includes a local ChirpStack Server and Node-Red. This example shows how to configure LHT65N to use with the local Node-Red server. This example assumes users already have:

  • LHT65N register on LPS8v2 Built-In ChirpStack server already
  • The user is able to see the data on the built-in ChirpStack server device page.

Below are the steps to plot the sensor data on LPS8v2 Node-Red.

9.1 Link Node-Red to Local ChirpStack

Users can download the Node-Red decoder from this link and import it into the Node-Red platform:  LHT65N-ChirpStack-node-red.json

For more information on importing Input Flow, check out this link: Import Input Flow for Dragino Sensors

After importing the Input Flow is complete, the user needs to edit the MQTT in the node

1. Change the Topic

Topic modifies it to the following format:

application/Application ID/device/End device ID/event/up

image-20230527143923-1.png

2. Enter the MQTT configuration information

image-20230527144206-2.png

3. Finally, click "Update" and Deploy

"Connected" indicates that the Link Node-red to Local Chirpstack is normal.

image-20220914140918-5.png

9.2 Check result.

Users can check logs by adding debug.

Browser access: Node-Red-Server-Address:1880/ui

image-20230529150923-1.png

10.  Trouble Shooting

10.1  MIC Mismatch or MIC Failed

When the device is registered or the device is working normally, the problem of MIC mismatch and MIC failed occurs.

Under normal circumstances, users need to change the APPKEY to solve this problem.

 

Tags:
Created by Xiaoling on 2022/05/16 11:13
    

No comments for this page

Applications

Navigation

Copyright ©2010-2024 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0