lukejin-dev/lorawan-server

Compact server for private LoRa networks

Compact server for private LoRa networks

Open-source LoRaWAN Server that integrates both the network-server and the application-server. This is useful for application providers that operate their own LoRa network, or for device and application developers.

The server:

• Communicates with (any number of) remote LoRaWAN gateways. It currently supports:
  • All gateways based on the Packet Forwarder, such as the Semtech LoRa demo kit, LoRa Lite Gateway, LORANK-8, or MultiConnect Conduit.
• Performs all required encryption and integrity checks.
• Invokes internal modules with application logic. It provides examples for:
  • Semtech/IMST LoRaMote
  • Microchip LoRa(TM) Technology Mote
• Invokes external applications. It currently supports connections via:
  • WebSocket protocol RFC6455
• Supports (any number of) Class A or Class C devices.
• Supports both the activation by personalization and the over-the-air activation.
• Supports both unconfirmed and confirmed data uplink and downlink.
• Supports the EU 863-870, US 902-928, CN 779-787, EU 433, AU 915-928 and CN 470-510 band.
• Supports per-node configuration of TX power and data rate (manual ADR).
• Runs on all major operating systems, including Windows, Linux, OS X and Solaris, even on embedded systems like OpenWrt or in a Docker container.
• Does not crash as it's implemented in Erlang, which is designed for building fault-tolerant systems.
• Is free, distributed under the MIT license.

The server aims to be an all-in-one software package for small private LoRa networks. However:

• You still need to buy your LoRaWAN Gateway.
• You will need to deploy and maintain it yourself. (With my support.)
• It will probably never support the sophisticated management features of the commercial-grade network-servers.

Let me know if you (intend to) use the lorawan-server. The API may change and some functions may not be implemented. I will gladly assist you. Please add an Issue if you find a bug or miss a feature.

Documentation

The lorawan-server includes all functions required to run a private LoRa network. You only need to install the Erlang/OTP 18 or later.

The main components of the lorawan-server are shown in the following figure:

Usage

The Installation Instructions describe how to build, install and configure the server. You can use a Debian package, download the binary release and run it manually or build the server from source codes.

After the installation you have to:

• Add LoRaWAN gateways you want to use.
• Configure each device you want to use, either as a personalized device (ABP) or as an over-the-air activated (OTAA) device.

Run the lorawan-server release by:

cd lorawan-server
bin/lorawan-server

Terminate the lorawan-server by:

bin/lorawanctl stop

You can administrate and manage the server via a set of web-pages or via a REST API as described in the Administration Guide and in the Adaptive Data Rate (ADR) Guide.

Integration

You can integrate lorawan-server with external applications using the WebSocket interface as described in the WebSocket Guide.

You can also use the internal web server and develop application modules, which may offer custom REST APIs. See the Handler Development Guide.

Development

The lorawan-server is designed to be highly extensible. I encourage you to Learn You Some Erlang and develop your own applications.

To implement a new application you need to create a new module implementing the lorawan_application behaviour as described in the Handler Development Guide.

Copyright and Licensing

The lorawan-server is distributed under the MIT License. See the LICENSE.

Copyright (c) 2016-2017 Petr Gotthard

Sponsors

I2OT is the first industrial wireless sensor system that provides a total solution for industrial sensing needs.