Register and Connect Your Gateway to the Semtech Network Server

This section explains how to configure your gateway to communicate with the Semtech Network Server. These steps should be repeated for each of the gateways you wish to connect to the Semtech Network Server.

Configure Your Gateway

In this section you configure your gateway with the Semtech Network Server settings and the certificates you just generated. The instructions for this vary depending on whether your gateway is running LoRa Basics™ Station, Semtech UDP Packet Forwarder with the ChirpStack Gateway Bridge, or ChirpStack Gateway OS. Follow the instructions below for your implementation.

Configure a Gateway Running LoRa Basics Station

Consult the gateway documentation to find out how you can set the credentials on your gateway. You need to find out where these files should be stored, the configuration path.

Create the following files at the configuration path (e.g., if the configuration path is /home, you would create the files in the /home folder):

• tc.uri - set this file to the single line as shown below, replacing BASICS_STATION_ENDPOINT with the Basics Station Endpoint listed for your Frequency in the Regional Support section of the Semtech Network Server webpage:

   

  wss://BASICS_STATION_ENDPOINT

  For example, for the region EU868, where BASICS_STATION_ENDPOINT is eu868.basicstation.loracloud.com:443, the contents of the file is set to:

   

  wss://eu868.basicstation.loracloud.com:443

• tc.trust - set this file to the contents of the CA certificate field in the network server gateway certificate section, saved in the previous step as CA_CERTIFICATE.

• tc.crt - set this file to the contents of the TLS certificate field in the network server gateway certificate section, saved in the previous step as TLS_CERTIFICATE.

• tc.key - set this file to the contents of the TLS key field in the network server gateway certificate section, saved in the previous step as TLS_KEY.

Configure a Gateway with the Semtech UDP Packet Forwarder

When working with the Semtech UDP packet forwarder, you need to first configure the ChirpStack Gateway Bridge.

1. Locate the device running ChirpStack Gateway Bridge. This could be your gateway, a second device running Debian or Ubuntu on your network, or it could be a cloud server, as described in the Gateway section.

2. You need to know the Gateway Bridge configuration path. If you installed ChirpStack Gateway Bridge yourself, you should already know the path. If you bought a gateway with ChirpStack Gateway Bridge installed, consult the documentation. We refer to this path as GATEWAY_BRIDGE_CONFIGURATION_PATH.

   Note

   If you can connect to the device running ChirpStack Gateway Bridge using SSH or PuTTY, the configuration path will be the same as the folder that holds your chirpstack-gateway-bridge.toml file. On some gateway models, the configuration path could be one of the following:

   • /etc/chirpstack-gateway-bridge
   • $HOME/.config/chirpstack-gateway-bridge

3. Create a file at the GATEWAY_BRIDGE_CONFIGURATION_PATH named ca.pem, and populate it with the contents of the CA certificate field in the Network Server Gateways page CERTIFICATE tab, saved in the previous step as CA_CERTIFICATE.

   For example, if the GATEWAY_BRIDGE_CONFIGURATION_PATH is /etc/chirpstack-gateway-bridge the file will be saved at /etc/chirpstack-gateway-bridge/ca.pem.

4. Create a file at the GATEWAY_BRIDGE_CONFIGURATION_PATH named cert.pem, and populate it with the contents of the TLS certificate field in the Network Server Gateways page CERTIFICATE tab, saved in the previous step as TLS_CERTIFICATE.

   For example, if the GATEWAY_BRIDGE_CONFIGURATION_PATH is /etc/chirpstack-gateway-bridge the file will be saved at /etc/chirpstack-gateway-bridge/cert.pem.

5. Create a file at the GATEWAY_BRIDGE_CONFIGURATION_PATH named key.pem, populating this file with the contents of the TLS key field in the Network Server Gateways page CERTIFICATE tab, saved in the previous step as TLS_KEY.

   For example, if the GATEWAY_BRIDGE_CONFIGURATION_PATH is /etc/chirpstack-gateway-bridge the file will be saved at /etc/chirpstack-gateway-bridge/key.pem.

6. Open the chirpstack-gateway-bridge.toml file at the GATEWAY_BRIDGE_CONFIGURATION_PATH. Find the section starting with [integration.mqtt.auth]. Make sure the type is set to generic, as shown in the code example:

    

   [integration.mqtt.auth] type=generic

7. Locate the section in the chirpstack-gateway-bridge.toml which starts with [integration.mqtt.auth.generic]. Update or insert the following settings under the [integration.mqtt.auth.generic] section heading.

   • servers:

     Update or create the servers setting as shown below:

     servers=[ssl://mqtt.loracloud.com:8883]

   
   
   • ca_cert, tls_cert and tls_key:

     Update the ca_cert, tls_cert and tls_key settings as shown, where GATEWAY_BRIDGE_CONFIGURATION_PATH is replaced with the actual path to the gateway bridge configuration.

      

     ca_cert=[GATEWAY_BRIDGE_CONFIGURATION_PATH/ca.pem] tls_cert=[GATEWAY_BRIDGE_CONFIGURATION_PATH/cert.pem] tls_key=[GATEWAY_BRIDGE_CONFIGURATION_PATH/key.pem]

     For example, if your GATEWAY_BRIDGE_CONFIGURATION_PATH is /etc/chirpstack-gateway-bridge then this would be:

      

     ca_cert=[/etc/chirpstack-gateway-bridge/ca.pem] tls_cert=[/etc/chirpstack-gateway-bridge/cert.pem] tls_key=[/etc/chirpstack-gateway-bridge/key.pem]

8. Update or create the event_topic_template, state_topic_template and command_topic_template as shown below, replacing TOPIC_PREFIX with the MQTT topic prefix listed for your Frequency in the Regional Support section of the Semtech Network Server webpage.
   
   event_topic_template=TOPIC_PREFIX/gateway/{{ .GatewayID }}/event/{{ .EventType }}

state_topic_template=TOPIC_PREFIX/gateway/{{ .GatewayID }}/state/{{ .StateType }}

command_topic_template=TOPIC_PREFIX/gateway/{{ .GatewayID }}/command/#

For example, for the region EU868, where TOPIC_PREFIX is eu868, these settings are:

event_topic_template=eu868/gateway/{{ .GatewayID }}/event/{{ .EventType }}

state_topic_template=eu868/gateway/{{ .GatewayID }}/state/{{ .StateType }}

command_topic_template=eu868/gateway/{{ .GatewayID }}/command/#

Make sure your chirpstack-gateway-bridge.toml file has the [integration.mqtt], [integration.mqtt.auth] and [integration.mqtt.auth.generic] sections with the server, ca_cert, tls_cert and tls_key fields under the [integration.mqtt.auth.generic] section as shown.