Skip to content

Outdated documentation

You are reading outdated documentation. This page documents ChirpStack v3. ChirpStack v4 is the latest version.

Changelog

v3.17.9

Improvements

  • Update Go compiler to v1.19.3.
  • Update Alpine base container to v3.17.0.
  • Update prometheus/client_golang to v1.14.0.

v3.17.8

Improvements

  • Introduce use_userinfo and assume_email_verified options for OIDC. (#695)
  • Update build to latest Go toolchain.

v3.17.7

Improvements

  • Update to Go 1.18.
  • Update mqtt client dependency.
  • Misc UI dependency updates.

v3.17.6

Features

  • Add dev-nonce clear functionality. (#660)

Improvements

  • Update LoRa Cloud integration with Modem & Geolocation Services.

v3.17.4

Improvements

  • Handle email_verified as string response when using Azure as OIDC backend. (#641)
  • Extends uplink event with device-profile name, id and its tags. (#621)

v3.17.3

Bugfixes

  • Do not lookup from errToCode map when error is of type slice. (#631)

v3.17.2

Bugfixes

  • Fix parsing of multiple TLV records in LoRa Cloud integration. (#628)
  • Fix some events not showing up in device data tab.

v3.17.1

Improvements

  • Increase Azure Service-Bus API timeout to 5 seconds.

Bugfixes

  • Update PostgreSQL client library (fixes re-connect). (see #547)
  • Fix doughnut chart styling regression after chartjs update.

v3.17.0

Features

Device metrics

This adds the following metrics to the device overview:

  • RSSI
  • SNR
  • Uplinks per frequency
  • Uplinks per data-rate

Improvements

  • Add support for new tracker payload in the Semtech LoRa Cloud integration.
  • Get timestamp from rxInfo if available for join event in PostgreSQL integration.
  • Set http timeout on http integration. (#615)
  • Docker images added for ARM v6, v7 and ARM64. (#618)

Gateway metrics

This adds the following metrics to the gateway overview:

  • Uplinks and downlinks per frequency
  • Uplinks adn downlinks per data-rate
  • Downlinks per ack status

v3.16.0

Features

Live frame and event logs

By using a Redis Stream instead of Pub/Sub, the last frames and events (per gateway and device) can be retained, providing a configurable amount of history when opening the related pages (default is 10). This also improves the live frame and event logs interface to provide a better overview and faster rendering.

Note: Redis Streams requires Redis 5.0.0+.

Multicast refactor

This moves the multicast feature under applications, to enforce that all devices within the multicast group belong to the same application as the multicast group.

Before you upgrade, please validate that if you have any existing multicast-groups that:

  1. These are not empty (they contain one or multiple devices)
  2. All devices within the multicast group belong to the same application

If these conditions are met, ChirpStack Application Server will automatically migrate your multicast group(s) to the same application as your devices. In any other case, the migration will throw an error asking you to either remove the empty multicast group(s) or to re-assign the devices so that the above criteria are met.

InfluxDB v2

This adds InfluxDB v2 support by making the InfluxDB API protocol version configurable when adding the InfluxDB integration.

Improvements

  • Add device-address to search functionality. (#603)
  • Fetch OpenID Connect claims with UserInfo call. (#613)

Bugfixes

  • Fix gatewayId hex converter in live lorawan frames. (#606)
  • Fix PostgreSQL integration "unknown message type: gw.UplinkRXInfo" error when json_v3 marshaler is configured.
  • Fix use GetRedisKey for key generation in MQTT integration. (#610)

v3.15.0

Features

LoRaWAN 1.0.4

This adds the LoRaWAN 1.0.4 mac-version and RP002-1.0.0 and PR002-1.0.1 regional parameter revisions to the device-profile configuration.

ReEncryptDeviceQueueItems API method (AS)

This implements the ReEncryptDeviceQueueItems method to the (internal) application-server API. This method is used by ChirpStack Network Server v3.13+ when it needs request the application-server to re-encrypt the device queue-items.

PostgreSQL schema migrations

This implements automatic schema migrations for the PostgreSQL integration. When you have manually created the tables (as documented previously), then these tables will be automatically adopted and updated to the latest version. For newly setup integrations all tables will be created automatically. (#573)

Improvements

  • Don't run Docker container as root. (#520)
  • Add gateway downlink info in txack message. (#576)
  • Refactor SQL schema migrations from sql-migrate to golang-migrate. (#585)
  • Add option to configure Redis key-prefix.
  • Add ns precision to the log timestamps.
  • Fix Thingsboard rssi and snr telemetry keys + add fport, fcnt and dr telemetry keys.
  • PostgreSQL integration improvements
    • Store confirmed_uplink and dev_addr for uplink. (#579)
    • Use marshaler configuration when encoding rx_info to JSON.
    • Add tx_info field for uplinks.
    • Store txack payloads into PostgreSQL database.

Bugfixes

  • Fix getting network-server name in service-profile list. (#570)
  • Base MQTT downlink lock key on payload content. (#577)
  • Fix AppendCertsFromPEM error return. (#578)
  • Fix copy key to clipboard (UI). (#593)

v3.14.0

Features

Remove FUOTA

This removes FUOTA from the ChirpStack Application Server as well as handling the handling of application-layer payloads related to FUOTA. The reason for removing FUOTA is to provide more flexibility as it allows for custom FUOTA implementations. One such implementation is the ChirpStack FUOTA Server.

MQTT integration client-certificates

Like with the Gateway client-certificate feature, this feature makes it possible to generate application-specific client-certificates for authentication and authorization with the MQTT broker. In this case the CommonName is set to the application ID.

Private gateways

This feature makes it possible to make gateways private to a specific service-profile. When enabled, received uplinks can only be used by devices under the same service-profile. To enable you must assign a service-profile to the gateway and update the service-profile to enable the private gateways feature.

Note: this requires ChirpStack Network Server v3.12+.

Select ADR algorithm

This adds a ADR algorithm selection option to the device-profile. In combination with the ChirpStack Network Server pluggable ADR feature, this makes it possible to use different ADR algorithms for different types of devices.

Note: this requires ChirpStack Network Server v3.12+.

Improvements

  • Add Semtech Device and Application Service integration workaround for assistance position handling.

v3.13.2

Bugfixes

v3.13.1

Bugfixes

  • Fix wifi based geolocation in combination with LoRa Cloud DAS integration.

v3.13.0

Features

Pilot Things integration

This release adds a per-application Pilot Things integration. (#527)

Improvements

  • Expose gateway certificate expiration date in web-interface.
  • Improve organization auto-complete with total count of available options.
  • Make setting default gRPC resolver a config option.
    • Note: this changes the default resolver from dns back to passthrough, which is the default value for the Go gRPC library.
  • Support SCRAM-SHA-256/512 for Kafka integration. (#549)
  • Add tls_enabled option to Redis configuration.
  • Improve user email validation regexp. (#553)
  • Implement JWT token audience validation.
  • Make it impossible for users to delete themselves. (#557)
  • Add ms precision to LoRa Cloud DAS integration timestamps. (#556)
  • Implement UplinkMsgWifi + wifi stream record workaround for LoRa Cloud DAS integration.
  • Replace Math.random by window.crypto in UI.

Bugfixes

  • Exclude email validation for admin user. (#540)
  • Fix healthcheck -> health log line. (#550)
  • Fix list service-profiles for API-key users. (#532)
  • Fix create API-key with empty string name and validate max length. (#555)

v3.12.2

Improvements

  • Add gateway-profile option to configure (expected) gateway stats interval.
  • Implement workaround for parsing LoRa Cloud stream records containing GNSS payloads.

Bugfixes

  • Revert 'Add WebSocket ping (30s interval) to avoid that load-balancers close the connection after inactivity' as it causes more issues that that it solves.
  • Fix resetting altitude when updating the gateway location.

v3.12.1

Bugfixes

  • Fix duplicated network-server entries in API and web-interface.
  • Fix auto-complete select placeholder. (#526)

v3.12.0

Features

LoRa Cloud DAS GNSS resolving

This implements the handling of LoRa Cloud Device & Application Services GNSS payload on pre-configured port (default 198).

Dashboards

Implement global and per organization dashboard of active devices and gateways. Please note that for devices, you must configure the expected uplink interval in the device-profile so that ChirpStack knows the difference between an active and inactive devices.

Improvements

  • Add WebSocket ping (30s interval) to avoid that load-balancers close the connection after inactivity.
  • Add Prometheus metrics for MQTT integration.
  • Make it possible for organization admins to update the name of the organization.
  • Add logout_url configuration option for OpenID Connect authentication.

Bugfixes

  • Fix create FUOTA deployment and network-server with empty name. (#511)
  • Fix 'can't evaluate field TLS in type struct' error for configfile command. (#518)
  • Fix /api/network-servers error when using API key. (#488)
  • Fix /api/gateway-profiles error when using API key. (#525)

v3.11.1

Improvements

  • Update Kafka configuration parameters so that it is possible to integrate with Azure Event Hub.

Bugfixes

  • Fix setting LoRa Cloud DAS Modem port default value.

v3.11.0

Features

OpenID Connect authentication

This feature makes it possible to use an OpenID Connect authentication backend together with ChirpStack Application Server, for example Auth0.com. Users are automatically matched based on email address on the first login. If there is a successful match, an external OpenID Connect user identifier is associated with the user, so that even in case of an email address update, it can still be matched (and updated in the ChirpStack Application Server database).

The implementation of this feature required a couple of changes:

Usernames

Usernames no longer exist in ChirpStack Application Server and have been renamed to email. Existing users can still login with their username, but on user update, the username must be set to an email address.

Previously there was an unused email field. As there was no guarantee that this field was unique this field has been deprecated. It is still present in the database as email_old so that the new email field (containing the old username as value) can be updated by hand if needed.

Note: If you have integrated your MQTT broker with the ChirpStack PostgreSQL database, you must update your SQL queries when upgrading to this release as the username field in the database has been renamed to email. Please refer to the MQTT authentication documentation for more information.

Create users

Creating new users as an organization admin has been removed. However, the OpenID Connect integration provides a registration_enabled option, which automatically creates new users when it does not exist.

Together with the registration_callback_url, it can be used to automatically onboard new users. When this option is set, ChirpStack Application Server will make a HTTP request to configured URL when a new user is created. This makes it possible to implement an onboarding service which (using the API) could:

  • Create an organization for the given user ID
  • Setup one or multiple service-profiles
  • ...
Assigning users to organization

Previously there was an auto-complete field to assign an user to an organization. As the username has been replaced by email and to not leak email addresses, the autocomplete function has been removed and the exact email must be given when associating a given user with an organization.

LoRa Cloud integration

Geolocation

This migrates the geolocation integration from ChirpStack Network Server to ChirpStack Application Server and allows a per-application integration configuration. The LoRa Cloud Geolocation integration provides support for TDOA, RSSI, Wifi and LR1110 based GNSS geolocation.

DAS

This implements the integration with the LoRa Cloud Device & Application Services.

Disable device

This feature makes it possible to (temporarily) disable a device.

Kafka integration

This (global) integration makes it possible to forward events to a Kafka broker.

Gateway client-certificates

When also configured in ChirpStack Network Server this makes it possible to generate per-gateway client-certificates which can be used to implement gateway authentication and authorization. For example a MQTT broker can be configured to validate the client-certificate against a pre-configured CA certificate and if valid it can use the CommonName of the certificate (which contains the gateway ID) to authorize publish / subscribe to certain topics.

Support max gateway / device option

This option makes it possible to configure the maximum gateways and devices that can be created per organization.

Integrations

Cloud integrations

It is now possible to configuring per-application integrations for AWS SNS, Azure Service-Bus and GCP Pub/Sub

Web-interface

The interface to configure per-application configurations has been re-implemented.

Single HTTP integration endpoint

This updates the HTTP integration with a single endpoint configuration. Instead of configuring a per-event endpoint, this makes it possible to have a single endpoint to which all events are posted, with the event as query parameter.

This update makes it also possible to configure the marshaler (JSON, Protocol Buffers and legacy JSON v3) per HTTP integration.

Already configured HTTP integrations are not affected by this update but it is recommended to update your configuration so that you will automatically receive new event-types when they are introduced.

MQTT topic configuration

The MQTT integration has been updated with new MQTT topic configuration. Instead of configuring each topic separately, an event_topic_template template can be configured, which is used for all events. The command topic(s) can now be configured through the command_topic_template variable. In case the old configuration is still present, then the old topic configuration will remain active for backwards compatibility.

Important:

For consistency with the other components, the new configuration does introduce a change in MQTT topics (default configuration):

  • application/[ApplicationID]/device/[DevEUI]/rx -> application/[ApplicationID]/device/[DevEUI]/event/up
  • application/[ApplicationID]/device/[DevEUI]/join -> application/[ApplicationID]/device/[DevEUI]/event/join
  • application/[ApplicationID]/device/[DevEUI]/ack -> application/[ApplicationID]/device/[DevEUI]/event/ack
  • application/[ApplicationID]/device/[DevEUI]/error -> application/[ApplicationID]/device/[DevEUI]/event/error
  • application/[ApplicationID]/device/[DevEUI]/status -> application/[ApplicationID]/device/[DevEUI]/event/status
  • application/[ApplicationID]/device/[DevEUI]/txack -> application/[ApplicationID]/device/[DevEUI]/event/txack
  • application/[ApplicationID]/device/[DevEUI]/location -> application/[ApplicationID]/device/[DevEUI]/event/location
  • application/[ApplicationID]/device/[DevEUI]/tx -> application/[ApplicationID]/device/[DevEUI]/command/down

API keys

It is now possible to also generate per-organization API keys in the web-interface for easy integration with the gRPC and REST API.

Improvements

  • Make it possible to use activate API endpoint for OTAA devices (to import an existing activation).
  • Gateway Profile / channel-plan re-configuration documentation in web-interface.
  • Internal cleanup auto-complete select in web-interface.
  • Remove links in web-interface which could cause a logout due to user-permissions.
  • Redirect to device overview after saving root-keys.
  • Add network-server name in gateway list.
  • Expose (un)confirmed + DevAddr in integration payloads. (#453)
  • Highlight rlow when hovering over table rows in web-interface. (#474)
  • Include Network Server name column in Device- and Service Profile list. (#475)
  • Include RSSI and SNR in ThingsBoard integration. (#478)
  • Align Gateway detail overview styling. (#480)
  • Makefile changes to speed up tests. (#493)
  • Support multiple Redis addresses for clustering. (#491)

Bugfixes

  • Fix delete icon in gateway-profile UI (was showing + icon instead of delete).
  • Fix updating organization with global API key. (#487)
  • Add missing error check in AWS SNS integration. (#483)

v3.10.0

Features

Generate API keys in web-interface

This makes it possible to generate (and revoke) API keys directly from within the web-interface. Internally, a lot of authorization code has been cleaned up to remove duplication and make the code easier to maintain. (#421)

Redis Cluster and Sentinel

This release introduces the support for Redis Cluster and Redis Sentinel.

Improvements

  • Use server time instead of gateway reported time in stats. (#440)
  • Add "Last seen" column to gateway list view. (#444)
  • Change ISM band names to their common name. (#456)

Bugfixes

  • Fix objectJSON formatting in web-interface.
  • Fix AMQP re-connect issue.
  • Fix setting updated_at field on organization user update. (#430)
  • Fix create service-profile with empty name. (#436)
  • Fix closing WebSocket connections. (#373)
  • Fix create multicast-group with empty name. (#451)
  • Fix device-status margin type (uint32 > int32).
  • Fix passing the correct database transaction on downlink enqueue. (#412)
  • Update viper to fix reading configfile error. (#461)

v3.9.0

Features

Monitoring

The monitoring configuration has been updated so that it is possible to configure both a Prometheus endpoint at /metrics and healthcheck endpoint at /health. This change is backwards compatible, but to use the /health endpoint you must update your configuration.

Gateway tags and metadata

This makes it possible to store additional user-defined key/value configuration per gateway. Metadata pushed by the ChirpStack Gateway Bridge is now stored by the ChirpStack Application Server and visible under metadata.

Device-profile tags

This makes it possible to store additional user-defined key/value configuration per device-profile.

myDevices Cayenne

The myDevices Cayenne endpoint is now enabled for the myDevices integration.

Improvements

  • Implement searching devices by tags (e.g. tagname:tagvalue).
  • Refactor Prometheus endpoint and add /health endpoint.

Bugfixes

  • Update gRPC dependency to fix 'DNS name does not exist' error. (#426)

v3.8.0

Features

New error events

This release provide new error events for OTAA errors, frame-counter resets and re-transactions / replay-attacks (requires ChirpStack Network Server v3.7+). It also adds new error events when the gateway reports an error on downlink scheduling (e.g. collision, invalid frequency, ...).

This publishes an acknowledgement when an item from the queue has been sent to the gateway for transmission and was accepted by the gateway.

myDevices integration

This new integration makes it possible to forward payload events to myDevices IoT in a Box. myDevices Cayenne integration will be made available soon.

Syslog logger

This adds a configuration option log_to_syslog. When enabled, log items will be forwarded to syslog.

Improvements

  • Add API option to fetch device queue size only.
  • Add device profile to device list in web-interface.
  • Enable DNS round-robin load-balancing for gRPC client (to NS).
  • Add uplink IDs used for gelocation to geolocation event. (#413)
  • Internal cleanup of unused device_activation table and code.
  • Add option for 200 and 500 items per page in web-interface. (#418)

Bugfixes

  • Fix LoRaWAN 1.1 OTAA bug (and update tests). (#382)
  • Fix assigning device profile to device (validate they share the same organization). (#415)
  • Fix assigning service profile to application (validate they share the same organization).

v3.7.0

Features

AMQP / RabbitMQ integration

This new integration publishes device events to an AMQP / RabbitMQ message broker.

Device variables in JS codec

This makes it possible to store (for example) calibration values as device variables and use this variable in the JavaScript codec.

Improvements

API auth query cleanup

This cleanup optimizes the API authorization functions by using a SQL query specific to each function, instead of a shared SQL query joining all tables.

Connection settings

  • Implement max. reconnect interval setting for MQTT integration.
  • Fix Redis max. idle configuration and add max. active connections configuration.
  • Implement max open and idle connections for PostgreSQL integration.

Bugfixes

  • Check for null values in JSONTree web-interface component. (#398)

v3.6.1

Bugfixes

  • Fix setting time in rxInfo for json_v3 (default) integration marshaler.
  • Fix integrations break when codec function returns a NaN value. (#390)

v3.6.0

Features

Protobuf based integrations

This feature adds a marshaler configuration option to the integration configuration. The default is backwards compatible with the current JSON format. New options are protobuf (Protobuf binary) and json (Protobuf based JSON).

RPM packaging

This is the first release providing .rpm packages for CentOS and RedHat. (#383

Improvements

gRPC / Protobuf cleanup

All definitions are now imported from github.com/brocaar/chirpstack-api/go. When using the gRPC API, you must update your imports.

Azure Service-Bus integration

Implement re-connect in case of an Azure Service-Bus error. This to work partly around azure-service-bus-go/issues/149.

Support multiple HTTP endpoints

Implement support for configuring multiple endpoints in the HTTP integration.

Internal improvements

Handlink of the received uplinks has been improved to reduce the number of required database transactions.

Bugfixes

  • Payload codec is hidden on application create (it was already on edit).

v3.5.1

Improvements

  • Deprecate use of dots (.) in environment variable names, use double underscore (__) instead. (#369)

Bugfixes

  • Fixes init stop script which could cause the ChirpStack Application Server to not properly stop or restart. (#379)

v3.5.0

This release renames LoRa App Server to ChirpStack Application Server. See the Rename Announcement for more information.

Improvements

  • Add copy to clipboard for hex heys. (#364)
  • Persist selected number of table rows per page in localStorage. (#351)

Bugfixes

  • Fix rendering empty gateway map.

v3.4.0

Features

IDs for correlation

This release implements per context unique IDs that are printed in the logs and are returned as header in API responses. This makes it easier to correlate log events.

Organization admin permissions

Next to the organization admin permission, this release makes it possible to also (instead of full organization admin permissions), make an user "device admin" or "gateway admin".

Migrate gateway stats

This release migrates the gateway stats from LoRa Server into LoRa App Server. This also adds new configuration options to the configuration file, to configure the timezone for aggregation and metrics retention.

Gateway map

In the gateway list page, it is now possible to show a map showing all the gateways and their states.

Improvements

  • Add PostgreSQL max open / idle connections settings. (#360
  • Cleanup old freegeoip.net code for gateway location.

Bugfixes

  • Fix gateway last-seen in web-interface.

Upgrading

This release requires LoRa Server v3.3.0 or later (which will forward the gateway stats to the Application Server API). After upgrading LoRa App Server and restarting it, it will run a migration to import existing stats from the LoRa Server database. Therefore make sure LoRa Server is up and running during the upgrade of LoRa App Server.

v3.3.1

Improvements

  • Add RXInfo and TXInfo to join-notifications. (#235)

Bugfixes

  • Propagate gRPC errors to that the correct HTTP status is returned. (#349)
  • Fix not found UI error when device is inactive. (#359)

v3.3.0

Features

Multi-frame geolocation

The multi-frame geolocation (implemented by LoRa Server v3.2.0) fields have been added to the Device Profile form in the web-interface.

Prometheus metrics

Prometheus metics have been implemented for the Join Server API interface.

Improvements

  • Update UI dependencies to their latest versions.
  • Show popup on gateway create when no Service Profile exists. (#345)
  • Remove unused fields when listing users. (#328)
  • Update multicast address and session-key input field widgets.
  • Mention in API description that the organization ID of an application can not be updated after create. (#343)

Bugfixes

  • Trigger organization dropdown reload on organization change. (#342)

v3.2.0

Features

Device queue

The LoRa App Server web-interface has now the option to:

  • Enqueue payloads
  • List pending queue items
  • Flush the device queue

Prometheus metrics

gRPC API metrics can now be exposed using a Prometheus metrics endpoint. In future releases, more metrics will be exposed using this endpoint.

Improvements

  • Multicast-group frame-counter cleanup (there was a column in both the LoRa App Server and LoRa Server database). (#339)

Bugfixes

  • Fix missing multicast enqueue error handler (this caused the enqueue endpoint to return a 200 even in case of error).

v3.1.0

Features

Device variables and tags

Device variables and tags are user-defined key/value values that can be assigned to devices. Tags can be used to add additional meta-data to devices and variables can be used for configured integrations (e.g. ThingsBoard requires a per-device Access Token).

PostgreSQL integration

When configured in the lora-app-server.toml configuration file, this integration will write events into a PostgreSQL database. See the PostgreSQL Integration documentation for more information.

ThingsBoard integration

When configured as Application integration, this integration will write attributes and telemetry to the configured ThingsBoard instance. See the ThingsBoard Integration documentation for more information.

Improvements

  • Speedup login with default admin / admin credentials (for low CPU power devices). (#320)
  • Gateway ID, FPGA ID and AES-key widgets have been updated.
  • Always display Class-C timeout field in Device Profile.

Bugfixes

  • Fix Gen Application Key is no longer a mandatory field. (#322)
  • Fix create organization user. (#323)

Upgrading

Before upgrading, you must enable the hstore extension for the LoRa App Server PostgreSQL database. Example commands assuming the database is named chirpstack_as:

sudo -u postgres psql

Within the PostgreSQL prompt, enter the following queries:

-- change to chirpstack_as database and enable extension
\c chirpstack_as
create extension hstore;

-- exit the prompt
\q

v3.0.0

Features

Firmware Update Over The Air (FUOTA)

This release provides an implementation of the FUOTA specification. Currently the deployment is limited to one device as we would like to gather feedback on this implementation first. However, in this implementation the deployment to groups of devices is taken into account. Note: this feature is experimental and the API might change.

Updated rxInfo / txInfo (live frame-logs)

The LoRa Server <> LoRa Gateway Bridge messages have been updated to make the downlink scheduling more flexible and generic. This change exposes these fields in the live gateway and device frame-logs.

Payload codec

The payload codec settings have been moved to the Device Profile. Codec settings set in the application configuration still remain functional, but new codec settings must be configured in the Device Profile.

Bugfixes

  • Fix organization admin cannot add existing users. (#315)

Upgrading

Please upgrade LoRa Server first to v3 (see Changelog), then upgrade LoRa App Server to v3. This LoRa App Server release is fully backwards compatible.

v2.6.1

Improvements

  • Make it possible in the API to move devices between applications.
  • Add DevAddr to enqueue API call to LoRa Server so that LoRa Server can validate the session-keys are in sync.
  • Add device details overview (UI).

Bugfixes

  • Fix panic when JOSN object is set but contains null. (#314)

v2.6.0

Features

New integrations

Support has been added to forward events to an Azure service-bus or to AWS SNS. See Configuration.

Improvements

  • Make JS codec maximum execution-time configurable and increase default value to 100ms.
  • Add configuration option for CORS headers. (#275)
  • Internal code-cleanup with regards to passing configuration and objects.
  • Internal migration from Dep to Go modules.
  • Improve authentication validator SQL query for speed. (#302)
  • Add codec execution time for decoding. (#307)
  • UI: Make delete application confirmation more explicit. (#306)

v2.5.1

Bugfixes

  • Fix panic in InfluxDB handler on null values in object (#295)

v2.5.0

Features

Support for retained messages

It is now possible to configure the retained flag for the MQTT integration. When set, the MQTT broker will retain the last message and send this immediately when a MQTT client connects. (#272)

Environment variable based configuration

Environment variable based configuration has been re-implemented.

Improvements

  • Calls made by the HTTP integration are now made async.
  • The alignment of the UI tabs has been improved.

Bugfixes

  • Fix potential deadlock on MQTT re-connect (#103)
  • Fix logrotate issue (init based systems) (#282

v2.4.1

Bugfixes

  • Fix createLeafletElement implementation error (introduced by v2.4.0 leaflet upgrade).

v2.4.0

Improvements

TLS for web-interface and API optional

It is no longer required to configure a TLS certificate for securing the LoRa App Server web-interface and API. This configuration is now optional and unset by default.

The following values have been added:

  • RSSI
  • SNR
  • Uplink frame-counter

EUI and key input fields (web-interface)

The device EUI and (session)key input fields have been improved for easier input, supporting both MSB and LSB byte order. Also only the required fields (based on LoRaWAN 1.0.x or 1.1.x) are displayed in the forms.

v2.3.0

Features

Google Cloud Platform integration

LoRa App Server is now able to publish application data to Cloud Pub/Sub as an alternative to a MQTT broker. Please refer to the Configuration for more information.

Deactivate device API

An API endpoint has been added to de-activate (not remove) devices.

Device battery status

LoRa App Server now publishes the device battery-level as a percentage instead of a value between 0...255. The battery field will be removed in the next major release.

Improvements

  • The join-server ca_cert can be left blank to disable client-certificate validation when a TLS certificate is configured.

v2.2.0

Upgrade notes

This upgrade is backwards compatible with previous v2 releases, but when using geolocation-support, you must also upgrade LoRa Server to v2.2.0+.

Features

Geolocation

This release adds geolocation support.

  • Configuration of fine-timestamp decryption keys (e.g. for the Kerlink iBTS).
  • .../location MQTT topics on which device locations are published.
  • Location notification endpoint for HTTP integration.
  • Per device reference altitude (for more accurate geolocation).

Improvements

  • Replace garyburd/redigo/redis with gomodule/redigo/redis.

Bugfixes

  • Status notification endpoint was missing for HTTP integration.
  • Fix /api endpoint redirecting to web-interface (this might require a clear cache).

v2.1.0

Upgrade notes

This upgrade is backwards compatible with previous v2 releases, but when using multicast-support, you must also upgrade LoRa Server to v2.1.0+.

Features

Multicast support

This adds experimental support for creating multicast-groups to which devices can be assigned (potentially covered by multiple gateways).

LoRaWAN 1.0.3

This update adds LoRaWAN 1.0.3 in MAC version dropdown.

Bugfixes

  • Fix organization selector dropdown styling.

v2.0.1

Bugfixes

  • Use gofrs/uuid UUID library as satori/go.uuid is not truly random. (#253)
  • Fix web-interface login form (sometimes a double login was required).

v2.0.0

Upgrade notes

Before upgrading to v2, first make sure you have the latest v1 installed and running (including LoRa App Server). As always, it is recommended to make a backup first :-)

Features

LoRaWAN 1.1 support

This release adds support for LoRaWAN 1.1 devices (meaning that both LoRaWAN 1.0 and LoRaWAN 1.1 devices are supported). Please note that the LoRaWAN 1.0 AppKey is now called NwkKey and LoRaWAN 1.1 adds a new key called AppKey.

(Encrypted) key signaling

The LoRa App Server join-server API supports using Key Encryption Keys (KEK) for encrypting the session-keys on a (re)join-request, requested by LoRa Server. It will also send the (encrypted) AppSKey in this response to LoRa Server.

When LoRa Server receives the first uplink from the device (in case of a rejoin-request, this will be the first uplink using the new security context), it will send this (encrypted) AppSKey together with the application payload to LoRa App Server. This will also be the moment when LoRa App Server will sent the join notification!

New UI

The LoRa App Server web-interface has been re-designed with a focus on better navigation. All main components are now accessible from a sidebar.

Changes

Device-status

The device-status has been removed from the uplink payload and is sent over a separate MQTT topic (or HTTP integration). This to make sure that the the device-status is only published when an update is available. See also Sending and receiving data.

API changes

The API has been cleaned up to improve consistency and usability. This update affects most of the endpoints! Most of these changes can be summarized by the following example (where device is a separate object which now can be re-used for create / get and update methods).

Old API

POST /api/devices

{
  "name": "test-device",
  "devEUI": "0102030405060708",
  "applicationID": "123"
  ...
}
New API

POST /api/devices

{
  "device": {
    "name": "test-device",
    "devEUI": "0102030405060708",
    "applicationID": "123"
    ...
  }
}

InfluxDB changes

The device_uplink measurement spreading_factor, bandwidth, modulation and bitrate tags are now replaced by a single dr tag.

The uplink message payload (used for MQTT and HTTP integrations) has been modified slightly:

  • It now contains a dr field indicating the used uplink data-rate.
  • Location related fields of each rxInfo element has been moved inside a location object.
  • MAC has been renamed to gatewayID for each rxInfo element.
  • The adr field has been moved out of txInfo and moved into the root object.

The reference field has been removed to simplify the downlink queue handling. When using the REST or gRPC API interface, the response to an enqueue action contains the frame-counter mapped with the downlink queue item. This frame-counter then can be used to map the acknowledgement in case of a confirmed downlink payload.

v1.0.2

Bugfixes

  • Lock device row on downlink enqueue to avoid duplicated frame-counter values (#245)

v1.0.1

Improvements

  • tls_cert and tls_key are set automatically (again) when installing from .deb file.

v1.0.0

This marks the first stable release!

Upgrade notes

  • First make sure you have v0.21.1 installed and running (together with LoRa Server v0.26.3).
  • As some configuration defaults have been changed (in the MQTT topic node has been replaced by device), make sure the old defaults are in you config file. To re-generate a configuration file while keeping your modifications, run: 
    lora-app-server -c lora-app-server-old.toml configfile > lora-app-server.toml
  • You are now ready to upgrade to v1.0.0!

See Downloads for pre-compiled binaries or instructions how to setup the Debian / Ubuntu repository for v1.x.

Changes

  • In the MQTT topic configuration defaults, node has been replaced by device.
  • Code to remain backwards compatible with environment-variable based configuration has been removed.
  • Code to create device- and service-profiles on upgrade from v0.14.0 has been removed.
  • Code to migrate the device-queue on upgrade from v0.15.0 has been removed.
  • Code to create gateway-profiles on upgrade from v0.20.0 has been removed.
  • Old unused tables (kept for upgrade migration code) have been removed from db.

0.21.1

Bugfixes:

  • Fix InfluxDB handler error for unexported fields (these are now skipped).
  • Fix data_data in InfluxDB measurement names when using a JS based codec.
  • Add missing int64 and uint64 value handling.

0.21.0

Features:

Bugfixes:

  • In some cases the JavaScript editor (codec functions) would only render on click.

0.20.2

Bugfixes:

  • JS codec now handles all possible int and float types returned by the encoder function.
  • Fixed Gob decoding issues when decoding to interface{} by using JSON marshaler for logging events.

Improvements: * JS codec downlink errors are now logged to .../error MQTT topic.

0.20.1

Improvements:

  • Skip frame-counter check can now be set per device (so it can be used for OTAA devices).
  • Publish codec decode errors to the application/[applicationID]/node/[devEUI]/error MQTT topic.

0.20.0

Features:

  • (Gateway) channel-configuration has been refactored into gateway-profiles.
  • This requires LoRa Server 0.26.0 or up.
  • This removes the channel-configuration related gateway API methods.
  • This adds gateway-profile API methods.

Bugfixes:

  • Fix leaking Redis connections on pubsub subscriber (#313.
  • Fix discovery interval validation (#226).

Upgrade notes:

In order to automatically migrate the existing channel-configuration into the new gateway-profiles, first upgrade LoRa Server and restart it. After upgrading LoRa App Server and restarting it, all channel-configurations will be migrated and associated to the gateways. As always, it is advised to first make a backup of your (PostgreSQL) database.

0.19.0

Features:

  • Global search on organizations, applications, devices and gateways.
  • Display live device events (the same data as publised over MQTT). See also Event logging.

Improvements:

  • When creating an application, show a warning when no service-profile exists.
  • When creating a gateway, show a warning when no network-server has been associated.
  • When creating a device, show a warning when no device-profile exists.

Bugfixes:

  • Fix organization selector (which would sometimes show an empty value on select).
  • Fix user selector when assigning an user to an organization (which would sometimes show an empty value on select).

Upgrade notes:

Before upgrading, the PostgreSQL pg_trgm extension needs to be enabled. Assuming the LoRa App Server database is configured as chirpstack_as this extension could be enabled using the commands below.

Start the PostgreSQL prompt as the postgres user:

sudo -u postgres psql

Within the PostgreSQL prompt, enter the following queries:

-- change to the LoRa App Server database
\c chirpstack_as

-- enable the extension
create extension pg_trgm;

-- exit the prompt
\q

0.18.2

Improvements:

  • Gateway discovery configuration has been moved to network-server configuration.
  • Important: when you have the gateway discover feature configured, you need to re-add this configuration under network-servers (web-interface).
  • Expose the following MQTT options for the MQTT gateway backend:
  • Configurable MQTT topics (uplink, downlink, join, ack, error)
  • QoS (quality of service)
  • Client ID
  • Clean session on connect
  • Expose LoRa Server version and configured region through the network-server API endpoint.
  • Websocket client automatically re-connects on connection error (#221)

Bugfixes:

  • The Class-C enabled checkbox was displayed twice in the web-interface.
  • Organization dropdown was not autocompleting correctly.

0.18.1

Features:

  • Expose Class-B fields in device-profile web-interface form.
  • Note: Class-B support is implemented since LoRa Server 0.25.0.

Bugfixes:

  • Fix factory preset frequency field in device-profile form.

0.18.0

Features:

  • LoRa App Server uses a new configuration file format. See configuration for more information.
  • Frame-logs for device are now streaming and can be downloaded as JSON file.
  • Note: the /api/devices/{devEUI}/frames (formerly Device.GetFrameLogs) endpoint has changed (and the gRPC method has been renamed to Device.StreamFrameLogs).
  • You need LoRa Server 0.24+ in order to use this feature.
  • Added streaming frame-logs for gateways (which also can be downloaded as JSON file).
  • You need LoRa Server 0.24+ in order to use this feature.
  • Support MQTT client certificate authentication (#201).

Upgrade notes:

When upgrading using the .deb package / using apt or apt-get, your configuration will be automatically migrated for you. In any other case, please see configuration.

0.17.1

Bugfixes:

  • Fix missing / prefix in two UI links causing a redirect to the login page.
  • Fix typo in TLS certificate loading causing error failed to find certificate PEM data in certificate input (thanks @Francisco_Rivas)

0.17.0

Features:

  • Device last seen timestamp is now stored and displayed in device list
  • In the service-profile, it is now possible to set the
  • Device-status request frequency
  • Report battery level
  • Report margin

When the interval is set to > 0 and reporting of this status is enabled, then this information is displayed in the device list and exposed over MQTT and the configured integrations.

  • Extra logging has been added:
  • gRPC API calls (to the gRPC server and by the gRPC clients) are logged as info
  • Executed SQL queries are logged as debug
  • A warning is displayed in the web-interface when creating a service-profile when no network-server is connected.
  • A warning is displayed in the web-interface when creating a device-profile when the organization is not associated with a network-server.

Internal changes:

  • The project moved to using dep as vendoring tool. In case you run into compiling issues, remove the vendor folder (which is not part of the repository anymore) and run make requirements.

  • The front-end code has been updated to use React 16.2.0 and all dependencies have been updated.

Bugfixes:

  • --gw-ping-dr 0 is now handled correctly (#204)

0.16.1

Features:

  • Implement client certificate validation for incoming application-server API connections.
  • Implement client certificate validation for incoming join-server API connections.
  • Implement client certificate for API connections to LoRa Server.

This removes the following CLI options:

  • --ns-ca-cert
  • --ns-tls-cert
  • --ns-tls-key

See for more information:

Improvements:

  • Optional note field (users) has been changed to textarea.
  • Description field of the gateway has been changed to textarea.

Bugfixes:

  • Fix device-profile permissions in UI for organization admins.
  • Fix device-profile list per applicationID showing all device-profile names and IDs on the same network-server as the service-profile associated with the given application.

0.16.0

Features:

  • LoRa App Server is now able to decode (uplink) and encode (downlink) payloads using the following per application configurable codecs:

  • None (only the raw base64 encoded data will be exposed)

  • Cayenne LPP (data will be encoded / decoded using the Cayenne LPP encoding)
  • Custom JavaScript codec functions (you can provide your own encoding / decoding functions in JavaScript)

See Applications documentation for instructions how to configure this option.

0.15.0

Changes:

  • Downlink device-queue

  • Downlink device-queue has been moved from the LoRa App Server database to the LoRa Server database.

  • LoRa App Server sends nACK when no confirmation has been received on confirmed downlink transmission. See ACK notifications.
  • LoRa App Server will not re-try transmitting a confirmed downlink anymore.
  • ACK and error notifications now contain the fCnt to which the notification is related.

  • The downlink-queue is now flushed on a (re)activation.

  • Downlink device-queue API (/api/devices/{devEUI}/queue)

  • Removed DELETE /api/devices/{devEUI}/queue/{id} endpoint (as removing individual device-queue items will give fCnt gaps).

  • Added DELETE /api/devices/{devEUI}/queue to flush the whole device-queue.

  • Class-C

  • Class-C timeout (see device-profiles) has been implemented for confirmed downlink transmissions. Make sure to update this value for existing Class-C device-profiles to a sane value.

Bugfixes:

Improvements:

  • Use RFC1945 Authorization header format (thanks @fifthaxe)

Upgrading

This release depends on LoRa Server 0.23.0. Upgrade LoRa Server first. After upgrading LoRa App Server, it will migrate the remaining device-queue items to the LoRa Server database.

0.14.2

Bugfixes:

  • Fix unclosed response body (HTTP integrations).

0.14.1

Bugfixes:

  • Remove RxInfo length validation as this slice is empty when Add gateway meta-data is disabled in the service-profile (thanks @pni-jmattison).
  • Rename /api/node/... prefix of downlink queue into /api/device/... (thanks @iegomez).
  • Rename DownlinkQueue... gRPC methods and structs into DeviceQueue....

0.14.0

Note: this release brings many changes! Make sure (as always) to make a backup of your PostgreSQL and Redis database before upgrading.

Changes:

  • Data-model refactor to implement service-profile, device-profile and routing-profile storage as defined in the LoRaWAN backend interfaces.

  • Application users have been removed to avoid complexity in the API authorization. Users can still be assigned to organizations.

  • LoRa App Server can now connect to multiple LoRa Server instances.

  • LoRa App Server exposes a Join-Server API (as defined in the LoRaWAN backend interfaces document), which LoRa Server uses as a default join-server.

  • E-mail and note field added for users.

  • Adaptive-datarate configuration has been moved to LoRa Server.

  • OTAA RX configuration has been moved to LoRa Server.

API changes:

  • New API endpoints:
  • /api/device-profiles (management of device-profiles)
  • /api/service-profiles (management of service-profiles)
  • /api/network-servers (management of network-servers)

  • /api/devices (management of devices, used to be /api/nodes, settings have been removed and device-profile field has been added)

  • Updated API endpoints:

  • /api/applications (management of applications, most of the settings are now part of the device-profile)

  • /api/gateways (management of gateways, network-server field has been added)

  • Removed API endpoints:

  • /api/applications/{id}/users (management of application users)
  • /api/nodes (management of nodes, has been refactored into /api/devices)

Note: these changes also apply to the related gRPC API endpoints.

How to upgrade

Note: this release brings many changes! Make sure (as always) to make a backup of your PostgreSQL and Redis database before upgrading.

Note: When LoRa App Server is running on a different server than LoRa Server, make sure to set the --as-public-server / AS_PUBLIC_SERVER (default localhost:8001).

This release depends on the latest LoRa Server release (0.22). Start with updating LoRa Server first. See also the LoRa Server changelog.

LoRa App Server will perform the data-migration when the --db-automigrate / DB_AUTOMIGRATE config flag is set. It will:

  • Create a network-server record + routing-profile on LoRa Server (so that LoRa Server knows how to connect back).
  • For each organization, it will create a service-profile
  • It will create device-profiles (either per device or per application when the "use application settings" is checked)

0.13.2

Features:

  • The list of nodes can now be filtered on DevEUI or name prefix (thanks @iegomez).

0.13.1

Improvements:

  • Rename Gateway ping to Gateway discovery.
  • Rename Frame logs to Raw frame logs and add note that these frames are encrypted.

0.13.0

Features:

  • Gateway ping for testing the gateway coverage (by other gateways). When configured, LoRa App Server will send periodically pings through each gateway which has the ping functionality enabled. See also features.

Note: this release requires LoRa Server 0.21+ as the gateway ping feature depends on the 'Proprietary' LoRaWAN message-type.

Bugfixes:

  • Content-Type header was missing for HTTP integrations.

0.12.0

Features:

  • HTTP data integration. This makes it possible to setup per application http integrations (LoRa App Server posting to configurable HTTP endpoints). Note that LoRa Server will always send the data to the MQTT broker.

Improvements:

  • Better pagination in case there are many pages (thanks @iegomez).
  • Various code has been cleaned up.

Bugfixes:

  • Fixed duplicated resultset-items when requesting all applications within an organization.

0.11.0

Features:

  • Implement support for channel-configuration management. This makes it possible to assign channel-plans to gateways, which then can be used by LoRa Gateway Config.

Note: This feature is dependent on LoRa Server version 0.20.0+.

0.10.1

Improvements:

  • --mqtt-ca-cert / MQTT_CA_CERT configuration flag was added to specify an optional CA certificate (thanks @siscia).

Bugfixes:

  • MQTT client library update which fixes an issue where during a failed re-connect the protocol version would be downgraded (paho.mqtt.golang#116).

0.10.0

Features & changes:

  • Added frame logs tab to node to display all uplink and downlink frames of a given node. Note: This requires LoRa Server 0.18.0.
  • Updated organization, application and node navigation in UI.

0.9.1

Bugfixes:

  • Fix ABP sesstings not editable by organization admin (#85)

0.9.0

Features & Changes:

  • Channel-lists have been removed. Extra channels (if supported by the ISM band) are now managed by LoRa Server configuration.

Bugfixes:

  • On editing a gateway, disable the MAC input field (as this is the unique identifier of the gateway).
  • A pagination regression has been fixed (#82).

Note: when upgrading to this version with --db-automigrate / DB_AUTOMIGRATE set, channel-list data will be removed.

0.8.0

Features & changes:

  • Organization management so that applications and gateways can be managed per organization.
  • Node-session migrate function (to migrate from LoRa Server 0.11.*) has been cleaned up.

Bugfixes:

  • Openstreetmap tiles can now be fetched using https:// (in some cases Safari was not loading any tiles because of mixed content).
  • When the browser does not allow using the location service, freegeoip.net is used as a fallback.
  • Map zoom in/out on scrolling has been disabled (to avoid accidental zoom on scrolling the page).

Many thanks again to @jcampanell-cablelabs for collaborating on this feature.

0.7.2

Bugfixes:

  • Fix race-condition between fetching the gateway details and getting the current location if the gateway location is not yet set (UI).

0.7.1

Features & changes:

  • Add 'set to current location' (create / update gateway in UI)

0.7.0

Features & changes:

  • Gateway management and stats
    • Gateway management UI and API (accessible by global admin users) was added.
    • Gateway locations are now exposed in the uplink MQTT topic
    • Requires LoRa Server 0.16.0+.
  • On MQTT and PostgreSQL connect error, LoRa App Server will retry instead of fail.

Many thanks again to @jcampanell-cablelabs for collaborating on this feature.

0.6.0

This release contains changes that are not backwards compatible!

Features & changes:

  • User management with support to assign users to applications.
  • API authentication / authorization (JWT token) format has been updated (it contains the username instead of all the permissions of the user). See API documentation for more information.
  • --jwt-secret / JWT_SECRET is now mandatory.
  • An initial user with admin / admin credentials will be created (change this password immediately!).
  • Node-session API has been removed, use the /api/nodes/{devEUI}/activation endpoint for getting (and setting) node activations.
  • Updated web-interface to support user management.
  • New API endpoints for creating users and assigning users to applications.

Many thanks to @jcampanell-cablelabs for collaborating on this feature.

0.5.0

Features:

  • Per application (network) settings. Settings like Class-C, ADR, receive-window, data-rate etc. can now be managed on an application level. Optionally, they can be overridden per node.
  • Applications and nodes are now paginated per 20 rows.

0.4.0

Features & changes:

  • Class-C support. When adding / changing nodes, tick the Class-C checkbox to enable Class-C support for a given node.
  • Application ID added to application overview (as it is needed to subscribe to MQTT topics).
  • Nodes are now sorted by name.

Note: For Class-C functionality, upgrade LoRa Server to 0.14.0 or above.

0.3.0

This release contains changes that are not backwards compatible!

Features & changes:

  • Nodes can now be grouped per application (e.g. called temperature-sensor). For backwards compatibility, the AppEUI is used as application name when upgrading.
  • Nodes can now be given a name (e.g. garden-sensor), which must be unique within an application. For backwards compatibility the DevEUI is used as name for the nodes when upgrading.
  • Application ID, and the name of the application and node are included in the MQTT payloads.
  • JWT token validation is now based on the ID of the application instead of the AppEUI (which should not be used for grouping nodes by purpose).
  • The gRPC and REST apis have been updated to reflect the above application and node name changes.
  • The MQTT topics (and payloads) are now based on the application ID and node DevEUI (see mqtt topics for more info).
  • An endpoint for activating nodes and for fetching the activation status has been added (before this was done by using the node-session endpoint).
  • The node activation mode can now be set (OTAA or ABP). Incoming join-requests for ABP nodes will be rejected.
  • The node-session API is now accessible at /api/node/{devEUI}/session.

Many thanks to @jcampanell-cablelabs and @VirTERM for their input on the API changes.

Bugfixes:

  • limit and offset url parameters are now correctly documented in the API console.
  • More descriptive error on missing --http-tls-cert and --http-tls-key configuration.

0.2.0

Features:

  • Adaptive data-rate support. See loraserver/features for more information about ADR. Note:

    • LoRa Server 0.13.0 or higher is required
    • ADR is currently only implemented for the EU 863-870 ISM band
    • This is an experimental feature

  • Besides RX information, TX information is exposed for received uplink payloads. See MQTT topics for more information.

0.1.4

  • Update exposed data which is published to the application/[AppEUI]/node/[DevEUI]/rx topic. SNR, RSSI and GPS time (if available) are now included of all receiving gateways.
  • Change GW_MQTT_SERVER environment variable to MQTT_SERVER (thanks @siscia).

0.1.3

  • Make the relax frame-counter option visible in the ui (the static files were not generated and included in 0.1.2).

0.1.2

  • Add relax frame-counter option (this requires LoRa Server >= 0.12.3)

0.1.1

  • Better labels + help text for ui components
  • Redirect to JWT token form on authorization error
  • Add small delay between http server start and gprc-gateway init (to work around internal connection errors)
  • Store all used DevNonce values instead of max. 10.

0.1.0

Initial release. LoRa App Server requires LoRa Server 0.12.0+.

Migrating data from LoRa Server

The database migrations of LoRa App Server are compatible with the database schema of LoRa Server 0.11.0. Running lora-app-server with --db-automigrate will forward migrate the database to the new structure.

Because of the decoupling of the inventory part from LoRa Server, some data needs to be migrated from Redis into PostgreSQL. This process can be automated by starting lora-app-server with the --migrate-node-sessions flag. This must be executed after running the database migrations (--db-automigrate flag, you can use both flags together).

When running lora-app-server with --migrate-node-sessions, it will loop through all nodes in the database (PostgreSQL) and backfill the DevAddr, NwkSKey and AppSKey from the node-session (Redis).

Make sure you have a backup of both databases before starting any migration :-)