Add twitter docs

This commit is contained in:
Fabian Affolter 2016-01-27 07:53:41 +01:00
parent 90cd3aa8a4
commit dd7b3b3835
2 changed files with 38 additions and 0 deletions

View File

@ -0,0 +1,38 @@
---
layout: component
title: "Twitter"
description: "Instructions how to add Twitter notifications to Home Assistant."
date: 2016-01-27 07:00
sidebar: true
comments: false
sharing: true
footer: true
logo: twitter.png
ha_category: Notifications
---
The `twitter` platform uses [Twitter](https://twitter.com) to delivery notifications from Home Assistant.
Go to [Twitter Apps](https://apps.twitter.com/app/new) and create an application. Visit "Keys and Access Tokens" of the application to get the details ("Consumer Key", "Consumer Secret", and "Access Token Secret" which needs to be generated).
To add Twitter to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
notify:
name: NOTIFIER_NAME
platform: twitter
consumer_key: ABCDEFGHJKLMNOPQRSTUVXYZ
consumer_secret: ABCDEFGHJKLMNOPQRSTUVXYZ
access_token_secret: ABCDEFGHJKLMNOPQRSTUVXYZ
```
Configuration variables:
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
- **consumer_key** (*Required*): Your "Consumer Key" (API Key) for the application.
- **consumer_secret** (*Required*): Your "Consumer Secret" (API Secret) for the application.
- **access_token_secret** (*Required*): Your "Access Token Secret" for the application.
To use notifications, please see the [getting started with automation page]({{site_root}}/components/automation/).

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB