/packet-forwarder-bridge

LoRa Gateway Bridge bridges between the packet_forwarder protocol and gRPC

Primary LanguageGoMIT LicenseMIT

LoRa Gateway Bridge / Packet Forwarder Bridge - The Things Network Fork

LoRa Gateway Bridge (or Packet Forwarder Bridge) is a service that does protocol translation between the packet_forwarder UDP protocol running on most LoRa gateways and the Protocol Buffers over gRPC that are used in The Things Network's backend.

Installation

You can download binaries for macOS, 64 bit Linux, 32 bit Linux, arm Linux, 64 bit Windows or 32 bit Windows. You can also install from source with the following steps:

  • Make sure you have Go installed (version 1.7 or later).
  • Set up your Go environment
  • Clone our fork: git clone https://github.com/TheThingsNetwork/packet-forwarder-bridge.git $GOPATH/src/github.com/brocaar/lora-gateway-bridge
  • Go to the folder: cd $GOPATH/src/github.com/brocaar/lora-gateway-bridge
  • Build: make deps build install

Running

lora-gateway-bridge [options]

Options

Flag ENV Var Description
--udp-bind UDP_BIND ip:port to bind the UDP listener to (default: "0.0.0.0:1700")
--ttn-account-server TTN_ACCOUNT_SERVER Account Server URL (default: "https://account.thethingsnetwork.org")
--ttn-account-client-id TTN_ACCOUNT_CLIENT_ID Client ID to authenticate with the Account Server (optional)
--ttn-account-client-secret TTN_ACCOUNT_CLIENT_SECRET Client Secret to authenticate with the Account Server (optional)
--ttn-discovery-server TTN_DISCOVERY_SERVER host:port of TTN Discovery Server
--root-ca-file ROOT_CA_FILE Root CA file (if discovery server uses TLS)
--ttn-router TTN_ROUTER TTN Router ID
--ttn-gateway-eui TTN_GATEWAY_EUI TTN Gateway EUI (optional)
--ttn-gateway-id TTN_GATEWAY_ID TTN Gateway ID the EUI should translate to (optional)
--ttn-gateway-token TTN_GATEWAY_TOKEN TTN Gateway Token to authenticate the Gateway ID (optional)
--ttn-gateway-key TTN_GATEWAY_KEY TTN Gateway Key to authenticate the Gateway ID (optional)

Example

If you set up the TTN backend for development (as described in the README) you can use the following to start the bridge:

lora-gateway-bridge --ttn-discovery-server localhost:1900 --ttn-router dev

Issues / Feature Requests

Issues or feature requests for the bridge can be opened at github.com/brocaar/lora-gateway-bridge/issues. Issues or feature requests related to The Things Network can be opened at github.com/TheThingsNetwork/ttn/issues.

License

LoRa Gateway Bridge is distributed under the MIT license. See LICENSE.