Add The Things Network documentation (#3465)
* Add The Things Network documentation * Fix date * Rename sensor platform
79
source/_components/sensor.thethingsnetwork.markdown
Normal file
@ -0,0 +1,79 @@
|
||||
---
|
||||
layout: page
|
||||
title: "The Things Network Sensor"
|
||||
description: "Instructions how to integrate The Things Network sensors into Home Assistant."
|
||||
date: 2017-09-30 08:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: thethingsnetwork.png
|
||||
ha_category: Sensor
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_release: 0.55
|
||||
---
|
||||
|
||||
The `thethingsnetwork` sensor platform allows you to get data from a [The Things Network Storage Integration](https://www.thethingsnetwork.org/docs/applications/storage/).
|
||||
|
||||
This platform requires that the [The Things Network component](/components/thethingsnetwork/) is set up and the [The Things Network Storage Integration](https://www.thethingsnetwork.org/docs/applications/storage/) as well.
|
||||
|
||||
Visit the [The Things Network Console](https://console.thethingsnetwork.org/) website, log in with your The Things Network credentials, choose your application from **Applications** and go to **Integrations**.
|
||||
|
||||
Add a new integration.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/components/thethingsnetwork/add_integration.png' />
|
||||
Add a The Things Network integration
|
||||
</p>
|
||||
|
||||
Select **Data Storage**.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/components/thethingsnetwork/choose_integration.png' />
|
||||
Choose a The Things Network integration
|
||||
</p>
|
||||
|
||||
Click **Add integration** to finish the process.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/components/thethingsnetwork/confirm_integration.png' />
|
||||
Add a The Things Network Data Storage integration
|
||||
</p>
|
||||
|
||||
When done, the status of the integration should be **Running**. You could check the output after clicking on **go to platform** in an interactive web interface.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/components/thethingsnetwork/storage_integration.png' />
|
||||
Add a The Things Network integration
|
||||
</p>
|
||||
|
||||
Select **Devices** to get the ID of your device that you want to use.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/components/thethingsnetwork/devices.png' />
|
||||
Devices overview
|
||||
</p>
|
||||
|
||||
To enable this platform, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: thethingsnetwork
|
||||
device_id: ha-demo
|
||||
values:
|
||||
sensor_value: unit of measurment
|
||||
voltage: V
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
device_id:
|
||||
description: The ID of the device.
|
||||
required: true
|
||||
type: string
|
||||
values:
|
||||
description: The sensor values with their unit of measurement
|
||||
required: true
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
63
source/_components/thethingsnetwork.markdown
Normal file
@ -0,0 +1,63 @@
|
||||
---
|
||||
layout: page
|
||||
title: "The Things Network"
|
||||
description: "Instructions for how to integrate The Things Network within Home Assistant."
|
||||
date: 2017-09-30 08:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: thethingsnetwork.png
|
||||
ha_category: Hub
|
||||
ha_release: 0.55
|
||||
ha_iot_class: depends
|
||||
---
|
||||
|
||||
The `thethingsnetwork` component allows one to interact with the [The Things Network](https://www.thethingsnetwork.org). This community-driven and open network supports [LoRaWAN](https://www.lora-alliance.org/) for long range (~5 to 15km) communication with a low bandwidth (51 bytes/message). [Gateways](https://www.thethingsnetwork.org/docs/gateways/) transfers the received data from the sensors to the The Things Network.
|
||||
|
||||
The Things network support various integrations to make the data available:
|
||||
|
||||
| The Things Network Integration | Home Assistant platform |
|
||||
|---|---|
|
||||
| [MQTT](https://www.thethingsnetwork.org/docs/applications/mqtt/) | |
|
||||
| [Storage](https://www.thethingsnetwork.org/docs/applications/storage/) | [`thethingsnetwork`](/component/sensor.thethingsnetwork/) |
|
||||
| [HTTP](https://www.thethingsnetwork.org/docs/applications/http/} | |
|
||||
|
||||
### {% linkable_title Setup %}
|
||||
|
||||
Visit the [The Things Network Console](https://console.thethingsnetwork.org/) website, log in with your The Things Network credentials, choose your application from **Applications**.
|
||||
|
||||
The **Application ID** is used to identify the scope of your data.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/components/thethingsnetwork/applications.png' />
|
||||
Application overview
|
||||
</p>
|
||||
|
||||
You need an access key to be able to read the data from your application.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/components/thethingsnetwork/access_key.png' />
|
||||
Access keys
|
||||
</p>
|
||||
|
||||
To enable this component, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
thethingsnetwork:
|
||||
app_id: sensor-123
|
||||
access_key: ttn-account-v2.xxxxxxxxxxx_yyyyyyyyyyy
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
app_id:
|
||||
description: The Application ID.
|
||||
required: true
|
||||
type: string
|
||||
access_key:
|
||||
description: The access key.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
BIN
source/images/components/thethingsnetwork/access_key.png
Normal file
After Width: | Height: | Size: 16 KiB |
BIN
source/images/components/thethingsnetwork/add_integration.png
Normal file
After Width: | Height: | Size: 24 KiB |
BIN
source/images/components/thethingsnetwork/applications.png
Normal file
After Width: | Height: | Size: 45 KiB |
BIN
source/images/components/thethingsnetwork/choose_integration.png
Normal file
After Width: | Height: | Size: 62 KiB |
After Width: | Height: | Size: 42 KiB |
BIN
source/images/components/thethingsnetwork/devices.png
Normal file
After Width: | Height: | Size: 33 KiB |
After Width: | Height: | Size: 27 KiB |
BIN
source/images/supported_brands/thethingsnetwork.png
Normal file
After Width: | Height: | Size: 34 KiB |