ChirpStack MQTT Forwarder is a Semtech UDP and ChirpStack Concentratord to MQTT forwarder. It is intended to run on the gateway and is a more lightweight alternative to the ChirpStack Gateway Bridge such that it can run on gateways with a limited amount of flash memory.

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

Building ChirpStack MQTT Forwarder requires:

• Nix (recommended) and
• Docker

Nix is used for setting up the development environment which is used for local development and for creating the binaries.

If you do not have Nix installed and do not wish to install it, then you can use the provided Docker Compose based Nix environment. To start this environment execute the following command:

make docker-devshell

Note: You will be able to run the test commands and run cargo build, but cross-compiling will not work within this environment (because it would try start Docker within Docker).

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

Run the following command to start the development shell:

nix-shell

Or if you do not have Nix installed, execute the following command:

make docker-devshell

ChirpStack MQTT Forwarder depends on a MQTT broker for running the tests. You need to start this service manually if you started the development shell using nix-shell:

docker-compose up -d

Execute the following command to run the tests:

make test

Execute the following commands to build the ChirpStack MQTT Forwarder binaries and packages:

# Only build binaries
make build

# Build binaries + distributable packages.
make dist

ChirpStack MQTT Forwarder is distributed under the MIT license. See also LICENSE.