2df149e120
* Add oauth token doc
* Adjust to latest config changes
* ✏️ Tweaks
* Remove optional config from example
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
1.8 KiB
title, description, logo, ha_category, ha_release, ha_iot_class
| title | description | logo | ha_category | ha_release | ha_iot_class | |
|---|---|---|---|---|---|---|
| Twitch | Instructions on how to integrate Twitch sensors into Home Assistant. | twitch.png |
|
0.10 | Cloud Polling |
The twitch platform will allow you to monitor Twitch channel status from within Home Assistant and setup automation based on the information.
Setup Client ID
Create a new app at "Register Your Application" in the Twitch developer portal. Then get the Client ID for the new application.
Setup OAuth Token
To enable the follow and subscription attributes, the OAuth token is needed to get the right permissions on the Twitch API.
If you don't need those, ignore the configuration setting: token.
To get the OAuth token, visit the OAuth Token Generator, insert your Client ID and user_read user_subscriptions inside scopes.
Before clicking Summit (the broken image below the form), visit the Twitch dev console and add a new application.
As OAuth Redirect URLs add https://twitchapps.com/tokengen/ and click Create
.
Back at the Token Generator, click the Summit button, accept the consent screen and get your OAuth Token.
Configuration
To use Twitch with your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry
sensor:
platform: twitch
client_id: YOUR_TWITCH_CLIENT_ID
channels:
- channel1
- channel2
{% configuration %} client_id: description: Your Twitch client ID. required: true type: string token: description: Your Twitch OAuth Token. required: false type: string channels: description: List of channels names required: true type: list {% endconfiguration %}