jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-21 08:16:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Twitter component configuration (#6901)

Browse Source 
* Update Twitter component configuration

* 🚑 Deleted line

* Minor changes
This commit is contained in:
Klaas Schoute 2018-10-17 23:55:32 +02:00 committed by Fabian Affolter
parent dec2c68ee3
commit 1166c36b32
1 changed files with 33 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
source/_components/notify.twitter.markdown
View File

@ -13,9 +13,13 @@ ha_release: 0.12
---
The `twitter` platform uses [Twitter](https://twitter.com) to deliver notifications from Home Assistant.
The `twitter` notification platform uses [Twitter](https://twitter.com) to deliver 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", "Access Token" and "Access Token Secret" which needs to be generated).
## {% linkable_title Setup %}
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, Access Token and Access Token Secret which needs to be generated).
## {% linkable_title Configuration %}
To add Twitter to your installation, add the following to your `configuration.yaml` file:
@ -30,13 +34,32 @@ notify:
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** (*Required*): Your "Access Token" for the application.
- **access_token_secret** (*Required*): Your "Access Token Secret" for the application.
- **username** (*Optional*): Twitter handle without `@` or with `@` and quoting for direct messaging.
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
required: false
default: "`notify`"
type: string
consumer_key:
description: Your Consumer Key (API Key) for the application.
required: true
type: string
consumer_secret:
description: Your Consumer Secret (API Secret) for the application.
required: true
type: string
access_token:
description: Your Access Token for the application.
required: true
type: string
access_token_secret:
description: Your Access Token Secret for the application.
required: true
type: string
username:
description: "Twitter handle without `@` or with `@` and quoting for direct messaging."
required: false
type: string
{% endconfiguration %}
To use notifications, please see the [getting started with automation page](/getting-started/automation/).