Skip to content

chirpstack/chirpstack-gateway-relay

Repository files navigation

ChirpStack Gateway Relay

This project is work in progress!

ChirpStack Gateway Relay is a software component that can turn a LoRa® gateway into a relay. This makes it possible to extend the LoRa coverage, without the need to connect each LoRa gateway to the internet.

The difference with the LoRa Alliance Relay protocol specification (TS011) is that this solution does not require any End Device modifications.

Documentation and binaries

Please refer to the ChirpStack Gateway Relay for documentation and pre-compiled binaries.

Building from source

Requirements

Building ChirpStack Gateway Relay requires:

Nix

Nix is used for setting up the development environment which is used for local development and compiling the binaries. As an alternative, you could install these dependencies manually, please refer to shell.nix.

Docker

Docker is used by cross-rs for cross-compiling, as well as some of the make commands.

Starting the development shell

Execute the following command to start the development shell:

nix-shell

Running tests

Execute the following command to run the tests:

make test

Compiling binaries

Execute the following commands to build the ChirpStack Gateway Relay binaries and packages:

# Only compile binaries
make build

# Compile binaries and build distributable packages
make dist

License

ChirpStack Gateway Relay is distributed under the MIT license. See also LICENSE.