1
mirror of https://github.com/home-assistant/core synced 2024-09-03 08:14:07 +02:00
ha-core/homeassistant/components/socialblade/sensor.py
springstan e79a5baf9e Move imports in slack and socialblade (#27747)
* Moved imports to top-level in samsungtv, slack and socialblade

* Rewinded top-level imports in samsungtv component
2019-10-16 21:36:19 -07:00

86 lines
2.2 KiB
Python

"""Support for Social Blade."""
from datetime import timedelta
import logging
import socialbladeclient
import voluptuous as vol
from homeassistant.components.sensor import PLATFORM_SCHEMA
from homeassistant.const import CONF_NAME
from homeassistant.helpers import config_validation as cv
from homeassistant.helpers.entity import Entity
from homeassistant.util import Throttle
_LOGGER = logging.getLogger(__name__)
CHANNEL_ID = "channel_id"
DEFAULT_NAME = "Social Blade"
MIN_TIME_BETWEEN_UPDATES = timedelta(hours=2)
SUBSCRIBERS = "subscribers"
TOTAL_VIEWS = "total_views"
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
{
vol.Required(CHANNEL_ID): cv.string,
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
}
)
def setup_platform(hass, config, add_entities, discovery_info=None):
"""Set up the Social Blade sensor."""
social_blade = SocialBladeSensor(config[CHANNEL_ID], config[CONF_NAME])
social_blade.update()
if social_blade.valid_channel_id is False:
return
add_entities([social_blade])
class SocialBladeSensor(Entity):
"""Representation of a Social Blade Sensor."""
def __init__(self, case, name):
"""Initialize the Social Blade sensor."""
self._state = None
self.channel_id = case
self._attributes = None
self.valid_channel_id = None
self._name = name
@property
def name(self):
"""Return the name."""
return self._name
@property
def state(self):
"""Return the state."""
return self._state
@property
def device_state_attributes(self):
"""Return the state attributes."""
if self._attributes:
return self._attributes
@Throttle(MIN_TIME_BETWEEN_UPDATES)
def update(self):
"""Get the latest data from Social Blade."""
try:
data = socialbladeclient.get_data(self.channel_id)
self._attributes = {TOTAL_VIEWS: data[TOTAL_VIEWS]}
self._state = data[SUBSCRIBERS]
self.valid_channel_id = True
except (ValueError, IndexError):
_LOGGER.error("Unable to find valid channel ID")
self.valid_channel_id = False
self._attributes = None