Skip to content
The Things Stack documentation home
Getting Started Concepts Cloud Enterprise Integrations API Hardware
Getting Started Concepts
Cloud Enterprise
Integrations API Hardware
Get The Things Stack

    Recent searches

      Popular pages

      • Getting Started
      • Adding Gateways
      • Adding Devices
      • Payload Formatters
      • Webhooks
      • Authentication

      No results for “”.

      • Check the spelling, or try fewer or more general words.
      • Ask the community on The Things Network Forum
      • Contact support
      ↑↓ to navigate ↵ to open Esc to close

      Hardware

      • Overview
      • Devices
        • Adding Devices
        • Configuring Devices
          • Device location settings
          • MAC Settings
          • Class B Settings
          • Class C Settings
          • Multicast Groups
          • Downlink Queue Operations
          • Payload Crypto Override
          • Relay Settings
        • Concepts
        • Models
        • Troubleshooting Devices
      • Gateways
      • Works with The Things Stack

      Relay Settings

      Updated 20 January 2025 Edit on GitHub
      Copy page
      • View as MarkdownThis page as plain text
      • Open in ChatGPTAsk questions about this page
      • Open in ClaudeAsk questions about this page

      This section provides guidelines for configuring relay settings for end devices via CLI.

      Command-line interface only

      The instructions below use the command-line interface (CLI).

      Learn how to install the CLI

      Retroactivity

      In contrast to MAC settings, the relay configuration commands will automatically apply changes to both the current, pending and future sessions of the end devices.

      Examples

      Enabling the Serving Mode New in 3.29.0

      In order to enable the serving mode of an end device, use the create command and the --mode.serving parameter.

      ttn-lw-cli relays create <app-id> <device-id> --mode.serving
      

      Enabling the Served Mode New in 3.29.0

      In order to enable the served mode of an end device, use the create command and the --mode.served flag.

      Note:

      A serving end device must already exist.
      ttn-lw-cli relays create <app-id> <device-id> --mode.served.mode.end-device-controlled --mode.served.serving-device-id <serving-device-id>
      

      Multiple modes of operations are available for a served end device:

      1. A device may always attempt to use the serving end device before transmitting an uplink message. This mode is called always, and can be used using the --mode.served.mode.always flag.
      2. A device may attempt to use the serving end device only after it has not received a downlink message recently. This mode is called dynamic, and can be used using the --mode.served.mode.dynamic flag.
      3. A device may have its own algorithm to choose when to use the serving end device. This mode is called end device controlled, and can be used using the --mode.served.mode.end-device-controlled flag.

      Retrieving the Settings New in 3.29.0

      In order to retrieve the settings of a serving end device, use the get command.

      ttn-lw-cli relays get <app-id> <device-id> --mode.serving
      

      The --mode.served may be used to retrieve the settings of a served end device.

      Updating the Settings New in 3.29.0

      In order to update the settings of an end device, use the set command.

      ttn-lw-cli relays set <app-id> <device-id> --mode.serving.cad-periodicity 1
      

      You can see the possible parameters which can be updated using the --help flag.

      Removing the Settings New in 3.29.0

      In order to delete all of the relay settings of an end device, use the delete command.

      ttn-lw-cli relays delete <app-id> <device-id>
      

      Creating an Uplink Forwarding Rule New in 3.29.0

      In order to create an uplink forwarding rule on a serving end device, for a served end device, use the uplink-forwarding-rules create command.

      Note:

      Rule IDs are strictly positive integers between 0 and 15.

      Note:

      The served end device must be in the same application as the serving end device.

      ttn-lw-cli relays uplink-forwarding-rules create <app-id> <device-id> <rule-id> --device-id <served-device-id>
      

      Retrieving All Uplink Forwarding Rules New in 3.29.0

      In order to retrieve all of the uplink forwarding rules of a serving end device, use the uplink-forwarding-rules list command.

      ttn-lw-cli relays uplink-forwarding-rules list <app-id> <device-id> --device-id
      

      Like other list-like commands in The Things Stack, the fields which are returned have to be specified in the command flags. Use the --help flags to see which other fields can be retrieved.

      Retrieving Individual Uplink Forwarding Rules New in 3.29.0

      In order to retrieve an individual uplink forwarding rule of a serving end device, use the uplink-forwarding-rules get command.

      ttn-lw-cli relays uplink-forwarding-rules get <app-id> <device-id> <rule-id>
      

      Like other get-like commands in The Things Stack, the fields which are returned have to be specified in the command flags. Use the --help flags to see which other fields can be retrieved.

      Updating Uplink Forwarding Rules New in 3.29.0

      In order to update an uplink forwarding rule of a serving end device, use the uplink-forwarding-rules set command.

      ttn-lw-cli relays uplink-forwarding-rules set <app-id> <device-id> <rule-id> --device-id <serving-device-id>
      

      You can see the possible parameters which can be updated using the --help flag.

      Deleting Uplink Forwarding Rules New in 3.29.0

      In order to delete an uplink forwarding rule of a serving end device, use the uplink-forwarding-rules delete command.

      ttn-lw-cli relays uplink-forwarding-rules delete <app-id> <device-id> <rule-id>
      
      ← Payload Crypto Override

      On this page

      • Retroactivity
      • Examples

      Sections

      Getting Started

      Concepts

      Cloud

      Enterprise

      Integrations

      API

      Hardware

      Sitemap

      View our Sitemap

      Contributing

      GitHub

      About Us

      The Things Industries

      Privacy Policy

      Cookie settings

      Cookie Settings

      We use cookies to enhance your experience, analyze site traffic and deliver personalized content. Read our Privacy Policy.

      Cookie categories