This section contains reference information for The Things Stack. Here, you’ll find API listings, component descriptions, data formats, a glossary of terms, and more.
Reference
Adaptive Data Rate
Adaptive Data Rate (ADR) is a mechanism for optimizing data rates, airtime and energy consumption in the network.
This reference documents how ADR is implemented in The Things Stack.
API
This is the reference for the gRPC and HTTP APIs that The Things Stack exposes.
Application Packages
Application packages specify state machines running both on the end device and the Application Server, as well as signalling messages exchanged between the end device’s application layer and the Application Server.
Billing with Stripe
This is a reference for the Stripe backend of the Tenant Billing Server.
It covers the creation of a product, the pricing plans and adding customer subscriptions.
Command-Line Interface
This is the reference for the command-line interface of The Things Stack: ttn-lw-cli.
Expand the command tree to the left to see information about commands.
Components
The Things Stack is composed of a number of components. The core components Network Server, Application Server and Join Server follow the LoRaWAN Network Reference Model. The Things Stack also contains an Identity Server, Gateway Server, Console and Command-line Interface.
Configuration
The Things Stack binary can be configured with many different options. Those options can be provided as command-line flags, environment variables or using a configuration file.
Data Formats
The streaming data integrations provide multiple formats for the delivery of application uplink messages and downlink queue operations. This section will delve into the common formats used by them.
Data Retention and Privacy
This reference contains information about what access administrators and users have to data, and how long The Things Stack persists device data. For inquiries about data privacy or data security, read on, or contact The Things Industries.
Email Templates
Email templates define the contents of the emails that The Things Stack sends to its users. They allow network operators to override the default contents of the emails with their own custom contents.
Federated Authentication
Federated Authentication allows network administrators to use the already existing identity providers in order to authenticate users, instead of manually creating and managing the accounts in The Things Stack.
Frequency Plans
This reference contains Frequency Plans that are officially supported by The Things Stack. This list is populated from the lorawan-frequency-plans Github repository.
Deployments may also have custom frequency plans configured.
Gateway RTT
The Things Stack records Round Trip Times (RTT) between the Gateway Server and Gateways which act as a measure of latency.
This section explains how The Things Stack records and uses these values.
Glossary
This reference contains common terms and definitions to help you find your way around The Things Stack.
ID and EUI Constraints
This reference explains how The Things Stack deals with IDs and EUIs, including regular expression requirements, uniqueness, and how deletion is handled.
Interoperability Repository
The Things Stack expects the root of interoperability repository to contain config.yml, which contains various interoperablity configuration options.
Last Activity
This guide provides some in depth information about how the Last activity values in the entity overviews of the Console are calculated.
LoRa Basics Station Implementation Guide
This guide contains implementation details primarily for gateway manufacturers intending to implement the LoRa Basics™ Station protocol.
LoRaWAN Specification and Regional Parameters
The Things Stack supports versions 1.0.x and 1.1.x of the LoRaWAN specifications.
Networking
The Things Stack uses a port per protocol, with a TLS counterpart when applicable. Ports can be shared by multiple services using the same protocol, i.e. gRPC services sharing management, data and events services.
Packet Broker Routing
This reference contains default Packet Broker routing tables.
Packet Forwarders
This reference describes support for various Packet Forwarders in The Things Stack.
Purging Entities
When entities are deleted, The Things Stack retains some IDs by default to prevent another user re-registering the ID and obtaining historical data.
It is also possible for administrators to purge IDs so that they may be reused. This reference contains information about how to do this, and the implications of purging IDs.
Rate Limiting
New in 3.12
The Things Stack supports rate limiting for all outward facing services. Access to each resource is limited by a unique identifier key, and it is possible to define rate limiting classes for fine-grained control.
Resource Limiting
New in 3.14.2
The Things Stack supports setting maximum limits for active resources. Access to each resource is limited by a unique identifier key, and it is possible to define resource limiting classes for fine-grained control.
Root Certificates
This section contains links to common root SSL certificates used in The Things Stack, issued by trusted certificate authorities (CAs).
Telemetry
The Things Stack exports Prometheus telemetry on the /metrics endpoint. This reference gives an overview of the most important metrics.
Tenant Management
This guide contains detailed information on how to perform common tenant management operations for The Things Stack Enterprise.
Web UI Branding
This reference gives details on how to customize the branding of the login pages and the Console.