Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/content/integrations/storage/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,5 @@ A gRPC service and an HTTP API is exposed so that stored messages can then be re

- Long-term storage of historical data for end-devices.
- No need to maintain a connection with {{% tts %}} at all times, e.g. for end devices that send messages infrequently.

{{< note >}} TTS Cloud is configured to store only uplink messages, and support for other message types may come in the future if there is a request for it by customers. {{</ note >}}
72 changes: 72 additions & 0 deletions doc/content/integrations/storage/disable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: Disable
description: ""
summary: Disable Storage Integration for applications and end-devices.
weight: 30
---

The Storage Integration is implemented as an [Application Package]({{< ref "/reference/application-packages" >}}). In order to disable it, you have to delete a default association for an application and an association for an end-device.

{{< cli-only >}}

## Disable for an Application

You can list down the default associations of an application using the below command:

```bash
$ ttn-lw-cli applications packages default-associations list "app1"
{
"defaults": [
{
"ids": {
"application_ids": {
"application_id": "app1"
},
"f_port": 100
},
"created_at": "2020-08-24T21:09:44.649890166Z",
"updated_at": "2020-08-24T21:09:44.649890166Z",
"package_name": "storage-integration"
}
]
}
```

Out of the listed default associations, you can choose the ones to delete by its `f_port` number. Use the below command to delete the default association:

```bash
$ ttn-lw-cli applications packages default-associations delete "app1" 100
```

## Disable for an End Device

You can list down the associations of an end-device using the below command:
```bash
$ ttn-lw-cli applications packages associations list "app1" "dev1"
{
"associations": [
{
"ids": {
"end_device_ids": {
"device_id": "dev1",
"application_ids": {
"application_id": "app1"
}
},
"f_port": 100
},
"created_at": "2020-08-24T21:09:44.649890166Z",
"updated_at": "2020-08-24T21:09:44.649890166Z",
"package_name": "storage-integration"
}
]
}


```

Out of the listed associations, you can choose the ones to delete by its `f_port` number. Use the below command to delete the association:

```bash
$ ttn-lw-cli applications packages associations delete "app1" "dev1" 100
```
38 changes: 3 additions & 35 deletions doc/content/integrations/storage/enable.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ The Storage Integration is implemented as an [Application Package]({{< ref "/ref

{{< cli-only >}}

{{< warning >}}The Storage Integration is new in {{% tts %}} 3.10. You may need to update the CLI to use the new features. See instructions in [Installing the CLI]({{< ref "/getting-started/cli/installing-cli" >}})
{{</ warning >}}
{{< note >}} The `f_port` for the default association and association is set to `100`. This value is irrelevant. **The storage integration will receive and store all uplink messages, regardless of `f_port`**. The `f_port` value is only needed because of the way application packages work with {{% tts %}}. {{</ note >}}


## Enable for an Application

Expand All @@ -20,8 +20,6 @@ Set up a default association between the desired application and the `storage-in
$ ttn-lw-cli applications packages default-associations set "app1" 100 --package-name storage-integration
```

{{< note >}} The `f_port` for the default association is set to `100`. This value is irrelevant. **The storage integration will receive and store all uplink messages, regardless of `f_port`**. The `f_port` value is only needed because of the way application packages work with {{% tts %}}. {{</ note >}}

{{< warning >}} **Do not configure more than one default association for the same application**, since that will lead to storing duplicate messages in the persistent storage. {{</ warning >}}

## Enable for an End Device
Expand All @@ -32,34 +30,4 @@ Set up an association between the desired end device and the `storage-integratio
$ ttn-lw-cli applications packages associations set "app1" "dev1" 100 --package-name storage-integration
```

{{< note >}} The `f_port` value is irrelevant. {{</ note >}}

{{< warning >}} **Do not configure multiple associations for the same end device**, since that will lead to storing duplicate uplinks in the persistent storage. {{</ warning >}}

## Disable the Storage Integration

Delete the package association, or the default association:

```bash
# List default associations
$ ttn-lw-cli applications packages default-associations list "app1"
{
"defaults": [
{
"ids": {
"application_ids": {
"application_id": "app1"
},
"f_port": 100
},
"created_at": "2020-08-24T21:09:44.649890166Z",
"updated_at": "2020-08-24T21:09:44.649890166Z",
"package_name": "storage-integration"
}
]
}
```

```bash
$ ttn-lw-cli applications packages default-associations delete "app1" 100
```
{{< warning >}} **Do not configure multiple associations for the same end device**, since that will lead to storing duplicate uplinks in the persistent storage. {{</ warning >}}
2 changes: 1 addition & 1 deletion doc/content/integrations/storage/retrieve.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Retrieve messages
summary: Retrieve historical data using the HTTP API
weight: 30
weight: 40
---

The Storage Integration offers the `ApplicationUpStorage` gRPC service and the respective HTTP endpoints for retrieving historical data. This page merely contains a few examples, see [Reference]({{< ref "/reference/api/storage_integration" >}}) for more details.
Expand Down