Skip to content

Added documentation for the ThingSpeak component #1309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 27, 2016
Merged

Added documentation for the ThingSpeak component #1309

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 39 additions & 0 deletions source/_components/thingspeak.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: page
title: "Thingspeak"
description: "Record one entity in Thingspeak"
date: 2016-10-24 15:45
sidebar: true
comments: false
sharing: true
footer: true
ha_category: "History"
ha_release: 0.32
---

The `thingspeak` components makes Home Assistant communicate with the [ThingSpeak API](https://thingspeak.com/).
For now, it records exactly one entity at once, which is great for testing purposes. For long-time storage you should rely
on the [InfluxDB component](https://home-assistant.io/components/influxdb/).

```yaml
# Example configuration.yaml entry
thingspeak:
```

You will have to create a [new channel](https://thingspeak.com/channels/new) on ThingSpeak and grab your API key from your [account page](https://thingspeak.com/account).

Configuration variables:
- **api_key**: Yout ThingSpeak API key
- **id**: The ID of your desired ThingSpeak channel
- **whitelist**: The name of the entity whose states should be sent to the channel.

## {% linkable_title Examples %}

### {% linkable_title Full configuration %}

```yaml
thingspeak:
api_key: MY_API_KEY
id: 1337
whitelist: sensor.yr_temperature
```