Split out fastdotcom into a component and a sensor platform (#20341)
* Split out fastdotcom into a component and a sensor platform * Update .coveragerc * Switching to async and using a Throttle * Add the async_track_time_interval call * Remove the throttle * Reorder sensor methods and add should_poll property
This commit is contained in:
1 parent
9e765fb05d
commit
fcccf133ba
6 files changed
+166
-117
No files matched your search
@@ -1,115 +0,0 @@
|
||||
"""
|
||||
Support for Fast.com internet speed testing sensor.
|
||||
|
||||
For more details about this platform, please refer to the documentation at
|
||||
https://home-assistant.io/components/sensor.fastdotcom/
|
||||
"""
|
||||
import logging
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant.components.sensor import DOMAIN, PLATFORM_SCHEMA
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.helpers.event import track_time_change
|
||||
from homeassistant.helpers.restore_state import RestoreEntity
|
||||
import homeassistant.util.dt as dt_util
|
||||
|
||||
REQUIREMENTS = ['fastdotcom==0.0.3']
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
CONF_SECOND = 'second'
|
||||
CONF_MINUTE = 'minute'
|
||||
CONF_HOUR = 'hour'
|
||||
CONF_MANUAL = 'manual'
|
||||
|
||||
ICON = 'mdi:speedometer'
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||
vol.Optional(CONF_SECOND, default=[0]):
|
||||
vol.All(cv.ensure_list, [vol.All(vol.Coerce(int), vol.Range(0, 59))]),
|
||||
vol.Optional(CONF_MINUTE, default=[0]):
|
||||
vol.All(cv.ensure_list, [vol.All(vol.Coerce(int), vol.Range(0, 59))]),
|
||||
vol.Optional(CONF_HOUR):
|
||||
vol.All(cv.ensure_list, [vol.All(vol.Coerce(int), vol.Range(0, 23))]),
|
||||
vol.Optional(CONF_MANUAL, default=False): cv.boolean,
|
||||
})
|
||||
|
||||
|
||||
def setup_platform(hass, config, add_entities, discovery_info=None):
|
||||
"""Set up the Fast.com sensor."""
|
||||
data = SpeedtestData(hass, config)
|
||||
sensor = SpeedtestSensor(data)
|
||||
add_entities([sensor])
|
||||
|
||||
def update(call=None):
|
||||
"""Update service for manual updates."""
|
||||
data.update(dt_util.now())
|
||||
sensor.update()
|
||||
|
||||
hass.services.register(DOMAIN, 'update_fastdotcom', update)
|
||||
|
||||
|
||||
class SpeedtestSensor(RestoreEntity):
|
||||
"""Implementation of a FAst.com sensor."""
|
||||
|
||||
def __init__(self, speedtest_data):
|
||||
"""Initialize the sensor."""
|
||||
self._name = 'Fast.com Download'
|
||||
self.speedtest_client = speedtest_data
|
||||
self._state = None
|
||||
self._unit_of_measurement = 'Mbit/s'
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""Return the name of the sensor."""
|
||||
return self._name
|
||||
|
||||
@property
|
||||
def state(self):
|
||||
"""Return the state of the device."""
|
||||
return self._state
|
||||
|
||||
@property
|
||||
def unit_of_measurement(self):
|
||||
"""Return the unit of measurement of this entity, if any."""
|
||||
return self._unit_of_measurement
|
||||
|
||||
def update(self):
|
||||
"""Get the latest data and update the states."""
|
||||
data = self.speedtest_client.data
|
||||
if data is None:
|
||||
return
|
||||
|
||||
self._state = data['download']
|
||||
|
||||
async def async_added_to_hass(self):
|
||||
"""Handle entity which will be added."""
|
||||
await super().async_added_to_hass()
|
||||
state = await self.async_get_last_state()
|
||||
if not state:
|
||||
return
|
||||
self._state = state.state
|
||||
|
||||
@property
|
||||
def icon(self):
|
||||
"""Return icon."""
|
||||
return ICON
|
||||
|
||||
|
||||
class SpeedtestData:
|
||||
"""Get the latest data from fast.com."""
|
||||
|
||||
def __init__(self, hass, config):
|
||||
"""Initialize the data object."""
|
||||
self.data = None
|
||||
if not config.get(CONF_MANUAL):
|
||||
track_time_change(
|
||||
hass, self.update, second=config.get(CONF_SECOND),
|
||||
minute=config.get(CONF_MINUTE), hour=config.get(CONF_HOUR))
|
||||
|
||||
def update(self, now):
|
||||
"""Get the latest data from fast.com."""
|
||||
from fastdotcom import fast_com
|
||||
_LOGGER.info("Executing fast.com speedtest")
|
||||
self.data = {'download': fast_com()}
|
||||
Reference in new issue
Block a user