v3.24.1

Getting Started Devices Gateways Integrations Reference
Get The Things Stack

Getting Started

    Overview
  • Quick Start
  • What Is The Things Stack?
  • Console
  • Subscription and Billing Management
  • Command-line Interface
  • Installing The Things Stack
  • Upgrading The Things Stack
  • Migrating to The Things Stack
    • Migrating End Devices between The Things Stack distributions
    • Migration Tool
      • Export Devices from The Things Stack
      • Export End Devices from ChirpStack
    • Migrating End Devices from V2
    • Import End Devices in The Things Stack
    • Fine-tuning MAC Settings for End Devices
    • Migrating Gateways
    • JSON File Reference
    • CSV File Reference
    • Migration FAQ
  • The Things Stack Cloud
  • The Things Stack AWS Launcher
  • The Things Stack on Kubernetes
  • The Things Join Server
  • The Things Network
  • Server Addresses
  • Packet Broker
  • Single Sign-On
  • Users and Organizations
  • Using the API
  • Working with Events
  • Troubleshooting Getting Started

Migration Tool

ttn-lw-migrate is a tool that can be used for migrating end devices and applications from supported LoRaWAN networks (like ChirpStack) to The Things Stack, or between The Things Stack distributions. This section provides details on how to install, configure and use this tool.

This tool works in a way that it exports descriptions of end devices and applications to a JSON file, that can later be imported in The Things Stack.

Installation

The migration tool can be installed using package managers or manually from binary files. We highly recommend installing or upgrading to ttn-lw-migrate version 0.5.0 or newer, because some features like session migration are not available for prior versions.

  • macOS
  • Linux
  • Windows

To install ttn-lw-migrate tool with brew:

brew install TheThingsNetwork/homebrew-lorawan-stack/ttn-lw-migrate

To upgrade ttn-lw-migrate tool if updates are available:

brew upgrade TheThingsNetwork/homebrew-lorawan-stack/ttn-lw-migrate

To install ttn-lw-migrate tool with snap:

sudo snap install ttn-lw-migrate

To upgrade ttn-lw-migrate tool if updates are available:

sudo snap refresh ttn-lw-migrate

Download the zipped archive with binary files for Windows from Github.

Extract the folder from ZIP archive and enter the folder. Double-click to run the ttn-lw-migrate.exe executable file.

After this, you will be notified that you can run ttn-lw-migrate from the command prompt.

Usage

To use the ttn-lw-migrate tool after successful installation, use your terminal or command prompt to navigate to the folder where it is installed and run the commands from there. Run ttn-lw-migrate help to see all available commands and flags.

To list available sources that you can migrate your end devices and applications from:

ttn-lw-migrate sources

Currently, there are three available sources listed in the table below. For detailed migration instructions using these three sources, check the linked sections.

Source Section Used for
ttnv3 Export Devices from The Things Stack Migrating between The Things Stack distributions
chirpstack Export Devices from ChirpStack Migrating devices from ChirpStack
ttnv2 Discontinued Migrating from legacy V2 deployments

Export Devices from The Things Stack

This section explains how to configure the migration tool and use it to export end devices from The Things Stack, that can later be imported in other The Things Stack deployments. This is a base for migrating end devices between The Things Stack distributions.
Read

Export End Devices from ChirpStack

This section contains instructions on how to configure migration tool and use it to export end devices from ChirpStack, that can later be imported in The Things Stack. This is a base for migrating end devices from ChirpStack to The Things Stack.
Read
← Migrate Active Device Session Export Devices from The Things Stack →

On this page

  • Installation
  • Usage

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 Aleksander Borowski on 16 Jan 2023.
doc: Add `ttnv3` migration tool docs and reorganize existing docs (#991)

Edit on Github