Skip to content

Commit

Permalink
Restructure and update devices section (#1210)
Browse files Browse the repository at this point in the history
* doc: Use cards in sub sections

* doc: Move best practices

* doc: Expand concepts

* doc: Move models to a sub section

* doc: Add configuration content

* doc: Restructure adding devices

* doc: Recreate adding devices

* doc: Add other sections

* doc: Update aliases

* doc: Update introductory passage

* doc: Update guide
  • Loading branch information
KrishnaIyer authored Nov 13, 2023
1 parent 940ed93 commit c65fa9b
Show file tree
Hide file tree
Showing 139 changed files with 1,005 additions and 870 deletions.
2 changes: 1 addition & 1 deletion doc/content/devices/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ menu:
weight: 3
---

This section contains information to help you work with end devices in {{% tts %}}. Here, you'll find guides for adding devices, configuring MAC settings, best practices for designing devices, and much more.
This section contains guides to add, configure and troubleshoot LoRaWAN® end devices in {{% tts %}}. There are also guides on core concepts to learn more and detailed information on popular end devices.
370 changes: 34 additions & 336 deletions doc/content/devices/adding-devices/_index.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,17 +1,29 @@
---
title: Import End Devices in The Things Stack
weight: 4
aliases: [/getting-started/migrating-from-v2/import-devices, /getting-started/migrating-from-networks/import-devices, /the-things-stack/migrating-from-v2/import-devices, /the-things-stack/migrating-from-networks/import-devices,/getting-started/migrating, /getting-started/migrating/import-devices]
title: "Adding devices in bulk"
description: ""
weight: 3
aliases:
[
/getting-started/migrating-from-v2/import-devices,
/getting-started/migrating-from-networks/import-devices,
/the-things-stack/migrating-from-v2/import-devices,
/the-things-stack/migrating-from-networks/import-devices,
/getting-started/migrating,
/getting-started/migrating/import-devices,
/devices/adding-devices/adding-devices-in-bulk,
]
---

To import end devices, you need access to an application in {{% tts %}}. If you have not created one previously, see the [Adding Applications]({{< ref "integrations/adding-applications" >}}) guide for detailed instructions.
Instead of adding devices one by one, {{% tts %}} supports multiple methods of adding multiple end devices at once. Adding multiple devices is also referred to as **importing devices**.

<!--more-->

There are two ways to import devices in {{% tts %}} - using [Console]({{< ref "/the-things-stack/interact/console" >}}) or [CLI]({{< ref "/the-things-stack/interact/cli" >}}).

{{% tts %}} supports importing end devices in JSON and CSV format:

- To import devices that are in a JSON file (for example, the one you created by following [Migrating End Devices from {{% ttnv2 %}}]({{< ref "/the-things-stack/migrating/migrating-from-v2" >}}) or [Exporting Devices from ChirpStack]({{< ref "/the-things-stack/migrating/migration-tool/export-from-chirpstack" >}})), use **{{% tts %}} JSON** format (identified by `the-things-stack`). The JSON format data format is documented in the [JSON File Reference]({{< ref "/the-things-stack/migrating/device-json" >}}).
- To import devices that are in a CSV file, use the **{{% tts %}} CSV** (identified by `the-things-stack-csv`). The CSV data format is documented in the [CSV File Reference]({{< ref "/the-things-stack/migrating/device-csv" >}}), including a handy Excel template.
- To import devices that are in a JSON file (for example, the one you created by following [Migrating End Devices from {{% ttnv2 %}}]({{< ref "/the-things-stack/migrating/migrating-from-v2" >}}) or [Exporting Devices from ChirpStack]({{< ref "/the-things-stack/migrating/migration-tool/export-from-chirpstack" >}})), use **{{% tts %}} JSON** format (identified by `the-things-stack`). The JSON format data format is documented in the [JSON File Reference]({{< ref "/devices/adding-devices/adding-devices-in-bulk/device-json" >}}).
- To import devices that are in a CSV file, use the **{{% tts %}} CSV** (identified by `the-things-stack-csv`). The CSV data format is documented in the [CSV File Reference]({{< ref "/devices/adding-devices/adding-devices-in-bulk/device-csv" >}}), including a handy Excel template.

{{< tabs/container "Console" "CLI" >}}

Expand All @@ -21,7 +33,7 @@ There are two ways to import devices in {{% tts %}} - using [Console]({{< ref "/

Open your application and click the button **Import end devices**

{{< figure src="../import-end-devices.png" alt="import devices" >}}
{{< figure src="import-end-devices.png" alt="import devices" >}}

Select the **File format** and upload the file (e.g. `devices.json` or `devices.csv`).

Expand All @@ -31,11 +43,11 @@ You can also expand the **Advanced claiming and component settings** to set targ

Start the import by clicking the **Import end devices** button.

{{< figure src="../upload-file.png" alt="upload devices.json file" >}}
{{< figure src="upload-file.png" alt="upload devices.json file" >}}

Wait for the end devices to be successfully imported. In case any device fails, you will see a relevant error message in the console.

{{< figure src="../operation-finished.png" alt="import finished" >}}
{{< figure src="operation-finished.png" alt="import finished" >}}

If the import was successful, your devices are added to the list of end devices in your application.

Expand Down Expand Up @@ -68,8 +80,10 @@ If the import was successful, you will see your devices added to the list of end

{{< /tabs/container >}}

{{< figure src="../successful-import.png" alt="successful-import" >}}
{{< figure src="successful-import.png" alt="successful-import" >}}

Your devices are now registered on {{% tts %}}.
See the following video from [The Things Network youtube channel](https://youtu.be/ouz-VuiosU4) for instructions.

Keep in mind that you still might need to initiate a new join on {{% tts %}} network! See [Migrating End Devices from {{% ttnv2 %}}]({{< ref "/the-things-stack/migrating/migrating-from-v2" >}}) for detailed info on how to complete the migration of your devices.
<details><summary>Show video</summary>
{{< youtube "ouz-VuiosU4" >}}
</details>
Loading

0 comments on commit c65fa9b

Please sign in to comment.