100 lines
2.6 KiB
Python
100 lines
2.6 KiB
Python
"""
|
|
Support for the Twitch stream status.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/sensor.twitch/
|
|
"""
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
|
from homeassistant.helpers.entity import Entity
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
REQUIREMENTS = ['python-twitch==1.3.0']
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
ATTR_GAME = 'game'
|
|
ATTR_TITLE = 'title'
|
|
|
|
CONF_CHANNELS = 'channels'
|
|
ICON = 'mdi:twitch'
|
|
|
|
STATE_OFFLINE = 'offline'
|
|
STATE_STREAMING = 'streaming'
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Required(CONF_CHANNELS, default=[]):
|
|
vol.All(cv.ensure_list, [cv.string]),
|
|
})
|
|
|
|
|
|
# pylint: disable=unused-argument
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
"""Set up the Twitch platform."""
|
|
channels = config.get(CONF_CHANNELS, [])
|
|
|
|
add_devices([TwitchSensor(channel) for channel in channels], True)
|
|
|
|
|
|
class TwitchSensor(Entity):
|
|
"""Representation of an Twitch channel."""
|
|
|
|
def __init__(self, channel):
|
|
"""Initialize the sensor."""
|
|
self._channel = channel
|
|
self._state = STATE_OFFLINE
|
|
self._preview = None
|
|
self._game = None
|
|
self._title = None
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""Device should be polled."""
|
|
return True
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return self._channel
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the sensor."""
|
|
return self._state
|
|
|
|
@property
|
|
def entity_picture(self):
|
|
"""Return preview of current game."""
|
|
return self._preview
|
|
|
|
# pylint: disable=no-member
|
|
def update(self):
|
|
"""Update device state."""
|
|
from twitch.api import v3 as twitch
|
|
stream = twitch.streams.by_channel(self._channel).get('stream')
|
|
if stream:
|
|
self._game = stream.get('channel').get('game')
|
|
self._title = stream.get('channel').get('status')
|
|
self._preview = stream.get('preview').get('small')
|
|
self._state = STATE_STREAMING
|
|
else:
|
|
self._preview = None
|
|
self._state = STATE_OFFLINE
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
"""Return the state attributes."""
|
|
if self._state == STATE_STREAMING:
|
|
return {
|
|
ATTR_GAME: self._game,
|
|
ATTR_TITLE: self._title,
|
|
}
|
|
|
|
@property
|
|
def icon(self):
|
|
"""Icon to use in the frontend, if any."""
|
|
return ICON
|