2.1 KiB

title description ha_category ha_release ha_iot_class ha_domain ha_platforms ha_integration_type
Twitch Instructions on how to integrate Twitch sensors into Home Assistant.
Social
0.10 Cloud Polling twitch
sensor
integration

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 and Client secret

Create a new app at "Register Your Application" in the Twitch developer portal. Then get the Client ID and Client secret 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: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 Connect 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
  client_secret: YOUR_TWITCH_CLIENT_SECRET
  token: YOUR_TWITCH_OAUTH_TOKEN
  channels:
    - channel1
    - channel2

{% configuration %} client_id: description: Your Twitch client ID. required: true type: string client_secret: description: Your Twitch client secret. 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 %}