v3.24.1

Getting Started Devices Gateways Integrations Reference
Get The Things Stack

Reference

    Overview
  • Adaptive Data Rate
  • API
  • Application Packages
  • Billing with Stripe
  • Command-Line Interface
  • Components
  • Configuration
  • Data Formats
  • Data Retention and Privacy
  • Device Claiming Configuration
  • Email Templates
  • Federated Authentication
  • Frequency Plans
  • FUOTA
  • Gateway RTT
  • Glossary
  • ID and EUI Constraints
  • Last Activity
  • LoRa Basics Station Implementation Guide
  • LoRaWAN Join Server Configuration
  • LoRaWAN Specification and Regional Parameters
  • Networking
  • Packet Broker Routing
  • Packet Forwarders
  • Purging Entities
  • Rate Limiting
  • Resource Limiting
  • Root Certificates
  • Telemetry
  • Tenant Management
  • Web UI Branding

Reference

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.

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.
Read

API

This is the reference for the gRPC and HTTP APIs that The Things Stack exposes.
Read

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.
Read

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.
Read

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.
Read

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.
Read

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.
Read

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.
Read

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.
Read

Device Claiming Configuration

The Things Stack Device Claiming Server can claim devices on LoRaWAN Join Servers.
Read

Email Templates

Removed in 3.19

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.
Read

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.
Read

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.
Read

FUOTA

This section contains information on using FUOTA with The Things Stack.
Read

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.
Read

Glossary

This reference contains common terms and definitions to help you find your way around The Things Stack.
Read

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.
Read

Last Activity

This guide provides some in depth information about how the Last activity values in the entity overviews of the Console are calculated.
Read

LoRa Basics Station Implementation Guide

This guide contains implementation details primarily for gateway manufacturers intending to implement the LoRa Basics™ Station protocol.
Read

LoRaWAN Join Server Configuration

The Things Stack Network Server and Application Server can use LoRaWAN Backend Interfaces 1.0 and 1.1 with LoRaWAN Join Servers. Network Server and Application Server use this configuration to contact LoRaWAN Join Servers. Learn how to configure Network Server and Application Server to use the interoperability client configuration. Configuration Files The Things Stack reads configuration from a file system. The root should contain config.yml, which contains Join Servers. join-servers:- file:'./path/js.yml'# relative path to a file containing Join Server configurationcomponents:['as','ns']# optional selector for components (new in 3.
Read

LoRaWAN Specification and Regional Parameters

The Things Stack supports versions 1.0.x and 1.1.x of the LoRaWAN specifications.
Read

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.
Read

Packet Broker Routing

This reference contains default Packet Broker routing tables.
Read

Packet Forwarders

This reference describes support for various Packet Forwarders in The Things Stack.
Read

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.
Read

Rate Limiting

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.
Read

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.
Read

Root Certificates

This section contains links to common root SSL certificates used in The Things Stack, issued by trusted certificate authorities (CAs).
Read

Telemetry

The Things Stack exports Prometheus telemetry on the /metrics endpoint. This reference gives an overview of the most important metrics.
Read

Tenant Management

This guide contains detailed information on how to perform common tenant management operations for The Things Stack Enterprise.
Read

Web UI Branding

This reference gives details on how to customize the branding of the login pages and the Console.
Read
← Webhooks Adaptive Data Rate →

On this page

The Things Stack

Getting Started

Devices

Gateways

Integrations

Reference

Contributing

GitHub

Forum

About Us

The Things Network

The Things Industries

About this page

Last changed by Ben Olayinka on 16 Feb 2021.
doc: Add descriptions to root sections

Edit on Github