83 lines
2.3 KiB
Python
83 lines
2.3 KiB
Python
"""
|
|
homeassistant.components.sensor.twitch
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
A sensor for the Twitch stream status.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/sensor.twitch/
|
|
"""
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.const import ATTR_ENTITY_PICTURE
|
|
|
|
STATE_STREAMING = 'streaming'
|
|
STATE_OFFLINE = 'offline'
|
|
ATTR_GAME = 'game'
|
|
ATTR_TITLE = 'title'
|
|
ICON = 'mdi:twitch'
|
|
|
|
REQUIREMENTS = ['python-twitch==1.2.0']
|
|
DOMAIN = 'twitch'
|
|
|
|
|
|
# pylint: disable=unused-argument
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
""" Sets up the Twitch platform. """
|
|
add_devices(
|
|
[TwitchSensor(channel) for channel in config.get('channels', [])])
|
|
|
|
|
|
class TwitchSensor(Entity):
|
|
""" Represents an Twitch channel. """
|
|
|
|
# pylint: disable=abstract-method
|
|
def __init__(self, channel):
|
|
self._channel = channel
|
|
self._state = STATE_OFFLINE
|
|
self._preview = None
|
|
self._game = None
|
|
self._title = None
|
|
self.update()
|
|
|
|
@property
|
|
def should_poll(self):
|
|
""" Device should be polled. """
|
|
return True
|
|
|
|
@property
|
|
def name(self):
|
|
""" Returns the name of the sensor. """
|
|
return self._channel
|
|
|
|
@property
|
|
def state(self):
|
|
""" State of the sensor. """
|
|
return self._state
|
|
|
|
# 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._state = STATE_OFFLINE
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
""" Returns the state attributes. """
|
|
if self._state == STATE_STREAMING:
|
|
return {
|
|
ATTR_GAME: self._game,
|
|
ATTR_TITLE: self._title,
|
|
ATTR_ENTITY_PICTURE: self._preview
|
|
}
|
|
|
|
@property
|
|
def icon(self):
|
|
""" Icon to use in the frontend, if any. """
|
|
return ICON
|