Add Speedtestdotnet config_flow (#36254)
This commit is contained in:
1 parent
c65e72886c
commit
2c1a76cf92
14 files changed
+678
-104
No files matched your search
@@ -5,30 +5,32 @@ import logging
|
||||
import speedtest
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN
|
||||
from homeassistant.config_entries import SOURCE_IMPORT
|
||||
from homeassistant.const import CONF_MONITORED_CONDITIONS, CONF_SCAN_INTERVAL
|
||||
from homeassistant.exceptions import ConfigEntryNotReady
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.helpers.discovery import async_load_platform
|
||||
from homeassistant.helpers.dispatcher import dispatcher_send
|
||||
from homeassistant.helpers.event import async_track_time_interval
|
||||
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
|
||||
|
||||
from .const import DATA_UPDATED, DOMAIN, SENSOR_TYPES
|
||||
from .const import (
|
||||
CONF_MANUAL,
|
||||
CONF_SERVER_ID,
|
||||
DEFAULT_SCAN_INTERVAL,
|
||||
DEFAULT_SERVER,
|
||||
DOMAIN,
|
||||
SENSOR_TYPES,
|
||||
SPEED_TEST_SERVICE,
|
||||
)
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
CONF_SERVER_ID = "server_id"
|
||||
CONF_MANUAL = "manual"
|
||||
|
||||
DEFAULT_INTERVAL = timedelta(hours=1)
|
||||
|
||||
CONFIG_SCHEMA = vol.Schema(
|
||||
{
|
||||
DOMAIN: vol.Schema(
|
||||
{
|
||||
vol.Optional(CONF_SERVER_ID): cv.positive_int,
|
||||
vol.Optional(CONF_SCAN_INTERVAL, default=DEFAULT_INTERVAL): vol.All(
|
||||
cv.time_period, cv.positive_timedelta
|
||||
),
|
||||
vol.Optional(
|
||||
CONF_SCAN_INTERVAL, default=timedelta(minutes=DEFAULT_SCAN_INTERVAL)
|
||||
): vol.All(cv.time_period, cv.positive_timedelta),
|
||||
vol.Optional(CONF_MANUAL, default=False): cv.boolean,
|
||||
vol.Optional(
|
||||
CONF_MONITORED_CONDITIONS, default=list(SENSOR_TYPES)
|
||||
@@ -40,46 +42,148 @@ CONFIG_SCHEMA = vol.Schema(
|
||||
)
|
||||
|
||||
|
||||
def server_id_valid(server_id):
|
||||
"""Check if server_id is valid."""
|
||||
try:
|
||||
api = speedtest.Speedtest()
|
||||
api.get_servers([int(server_id)])
|
||||
except (speedtest.ConfigRetrievalError, speedtest.NoMatchedServers):
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
|
||||
async def async_setup(hass, config):
|
||||
"""Import integration from config."""
|
||||
|
||||
if DOMAIN in config:
|
||||
hass.async_create_task(
|
||||
hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": SOURCE_IMPORT}, data=config[DOMAIN]
|
||||
)
|
||||
)
|
||||
return True
|
||||
|
||||
|
||||
async def async_setup_entry(hass, config_entry):
|
||||
"""Set up the Speedtest.net component."""
|
||||
conf = config[DOMAIN]
|
||||
data = hass.data[DOMAIN] = SpeedtestData(hass, conf.get(CONF_SERVER_ID))
|
||||
coordinator = SpeedTestDataCoordinator(hass, config_entry)
|
||||
await coordinator.async_setup()
|
||||
|
||||
if not conf[CONF_MANUAL]:
|
||||
async_track_time_interval(hass, data.update, conf[CONF_SCAN_INTERVAL])
|
||||
await coordinator.async_refresh()
|
||||
if not coordinator.last_update_success:
|
||||
raise ConfigEntryNotReady
|
||||
|
||||
def update(call=None):
|
||||
"""Service call to manually update the data."""
|
||||
data.update()
|
||||
|
||||
hass.services.async_register(DOMAIN, "speedtest", update)
|
||||
hass.data[DOMAIN] = coordinator
|
||||
|
||||
hass.async_create_task(
|
||||
async_load_platform(
|
||||
hass, SENSOR_DOMAIN, DOMAIN, conf[CONF_MONITORED_CONDITIONS], config
|
||||
)
|
||||
hass.config_entries.async_forward_entry_setup(config_entry, "sensor")
|
||||
)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
class SpeedtestData:
|
||||
async def async_unload_entry(hass, config_entry):
|
||||
"""Unload SpeedTest Entry from config_entry."""
|
||||
hass.services.async_remove(DOMAIN, SPEED_TEST_SERVICE)
|
||||
|
||||
await hass.config_entries.async_forward_entry_unload(config_entry, "sensor")
|
||||
|
||||
hass.data.pop(DOMAIN)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
class SpeedTestDataCoordinator(DataUpdateCoordinator):
|
||||
"""Get the latest data from speedtest.net."""
|
||||
|
||||
def __init__(self, hass, server_id):
|
||||
def __init__(self, hass, config_entry):
|
||||
"""Initialize the data object."""
|
||||
self.data = None
|
||||
self._hass = hass
|
||||
self._servers = [] if server_id is None else [server_id]
|
||||
self.hass = hass
|
||||
self.config_entry = config_entry
|
||||
self.api = None
|
||||
self.servers = {}
|
||||
super().__init__(
|
||||
self.hass,
|
||||
_LOGGER,
|
||||
name=DOMAIN,
|
||||
update_method=self.async_update,
|
||||
update_interval=timedelta(
|
||||
minutes=self.config_entry.options.get(
|
||||
CONF_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL
|
||||
)
|
||||
),
|
||||
)
|
||||
|
||||
def update(self, now=None):
|
||||
def update_data(self):
|
||||
"""Get the latest data from speedtest.net."""
|
||||
server_list = self.api.get_servers()
|
||||
|
||||
_LOGGER.debug("Executing speedtest.net speed test")
|
||||
speed = speedtest.Speedtest()
|
||||
speed.get_servers(self._servers)
|
||||
speed.get_best_server()
|
||||
speed.download()
|
||||
speed.upload()
|
||||
self.data = speed.results.dict()
|
||||
dispatcher_send(self._hass, DATA_UPDATED)
|
||||
self.servers[DEFAULT_SERVER] = {}
|
||||
for server in sorted(
|
||||
server_list.values(), key=lambda server: server[0]["country"]
|
||||
):
|
||||
self.servers[f"{server[0]['country']} - {server[0]['sponsor']}"] = server[0]
|
||||
|
||||
if self.config_entry.options.get(CONF_SERVER_ID):
|
||||
server_id = self.config_entry.options.get(CONF_SERVER_ID)
|
||||
self.api.closest.clear()
|
||||
self.api.get_servers(servers=[server_id])
|
||||
self.api.get_best_server()
|
||||
_LOGGER.debug(
|
||||
"Executing speedtest.net speed test with server_id: %s", self.api.best["id"]
|
||||
)
|
||||
|
||||
self.api.download()
|
||||
self.api.upload()
|
||||
return self.api.results.dict()
|
||||
|
||||
async def async_update(self, *_):
|
||||
"""Update Speedtest data."""
|
||||
try:
|
||||
return await self.hass.async_add_executor_job(self.update_data)
|
||||
except (speedtest.ConfigRetrievalError, speedtest.NoMatchedServers):
|
||||
raise UpdateFailed
|
||||
|
||||
async def async_set_options(self):
|
||||
"""Set options for entry."""
|
||||
if not self.config_entry.options:
|
||||
data = {**self.config_entry.data}
|
||||
options = {
|
||||
CONF_SCAN_INTERVAL: data.pop(CONF_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL),
|
||||
CONF_MANUAL: data.pop(CONF_MANUAL, False),
|
||||
CONF_SERVER_ID: str(data.pop(CONF_SERVER_ID, "")),
|
||||
}
|
||||
self.hass.config_entries.async_update_entry(
|
||||
self.config_entry, data=data, options=options
|
||||
)
|
||||
|
||||
async def async_setup(self):
|
||||
"""Set up SpeedTest."""
|
||||
try:
|
||||
self.api = await self.hass.async_add_executor_job(speedtest.Speedtest)
|
||||
except speedtest.ConfigRetrievalError:
|
||||
raise ConfigEntryNotReady
|
||||
|
||||
async def request_update(call):
|
||||
"""Request update."""
|
||||
await self.async_request_refresh()
|
||||
|
||||
await self.async_set_options()
|
||||
|
||||
self.hass.services.async_register(DOMAIN, SPEED_TEST_SERVICE, request_update)
|
||||
|
||||
self.config_entry.add_update_listener(options_updated_listener)
|
||||
|
||||
|
||||
async def options_updated_listener(hass, entry):
|
||||
"""Handle options update."""
|
||||
if not entry.options[CONF_MANUAL]:
|
||||
hass.data[DOMAIN].update_interval = timedelta(
|
||||
minutes=entry.options[CONF_SCAN_INTERVAL]
|
||||
)
|
||||
await hass.data[DOMAIN].async_request_refresh()
|
||||
return
|
||||
# set the update interval to a very long time
|
||||
# if the user wants to disable auto update
|
||||
hass.data[DOMAIN].update_interval = timedelta(days=7)
|
||||
Reference in new issue
Block a user