37463d655a
* Fix signal collision in tado with multiple accounts Tado signals were not unique enough to prevent collisions between accounts with the same zone ids. * Bump upstream to fix multiple tado accounts * switch signal undo to async_on_remove * Bump version now that upstream is released * bump python-tado * While its only the dep that changed since the last run, best to force another CI to be sure
302 lines
8.7 KiB
Python
302 lines
8.7 KiB
Python
"""Support for the (unofficial) Tado API."""
|
|
import asyncio
|
|
from datetime import timedelta
|
|
import logging
|
|
|
|
from PyTado.interface import Tado
|
|
from requests import RequestException
|
|
import requests.exceptions
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.climate.const import PRESET_AWAY, PRESET_HOME
|
|
from homeassistant.config_entries import SOURCE_IMPORT, ConfigEntry
|
|
from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
|
|
from homeassistant.core import HomeAssistant, callback
|
|
from homeassistant.exceptions import ConfigEntryNotReady
|
|
from homeassistant.helpers import config_validation as cv
|
|
from homeassistant.helpers.dispatcher import dispatcher_send
|
|
from homeassistant.helpers.event import async_track_time_interval
|
|
from homeassistant.util import Throttle
|
|
|
|
from .const import (
|
|
CONF_FALLBACK,
|
|
DATA,
|
|
DOMAIN,
|
|
SIGNAL_TADO_UPDATE_RECEIVED,
|
|
UPDATE_LISTENER,
|
|
UPDATE_TRACK,
|
|
)
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
TADO_COMPONENTS = ["sensor", "climate", "water_heater"]
|
|
|
|
MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=10)
|
|
SCAN_INTERVAL = timedelta(seconds=15)
|
|
|
|
CONFIG_SCHEMA = vol.Schema(
|
|
{
|
|
DOMAIN: vol.All(
|
|
cv.ensure_list,
|
|
[
|
|
{
|
|
vol.Required(CONF_USERNAME): cv.string,
|
|
vol.Required(CONF_PASSWORD): cv.string,
|
|
vol.Optional(CONF_FALLBACK, default=True): cv.boolean,
|
|
}
|
|
],
|
|
)
|
|
},
|
|
extra=vol.ALLOW_EXTRA,
|
|
)
|
|
|
|
|
|
async def async_setup(hass: HomeAssistant, config: dict):
|
|
"""Set up the Tado component."""
|
|
|
|
hass.data.setdefault(DOMAIN, {})
|
|
|
|
if DOMAIN not in config:
|
|
return True
|
|
|
|
for conf in config[DOMAIN]:
|
|
hass.async_create_task(
|
|
hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": SOURCE_IMPORT}, data=conf,
|
|
)
|
|
)
|
|
|
|
return True
|
|
|
|
|
|
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
|
|
"""Set up Tado from a config entry."""
|
|
|
|
_async_import_options_from_data_if_missing(hass, entry)
|
|
|
|
username = entry.data[CONF_USERNAME]
|
|
password = entry.data[CONF_PASSWORD]
|
|
fallback = entry.options.get(CONF_FALLBACK, True)
|
|
|
|
tadoconnector = TadoConnector(hass, username, password, fallback)
|
|
|
|
try:
|
|
await hass.async_add_executor_job(tadoconnector.setup)
|
|
except KeyError:
|
|
_LOGGER.error("Failed to login to tado")
|
|
return False
|
|
except RuntimeError as exc:
|
|
_LOGGER.error("Failed to setup tado: %s", exc)
|
|
return ConfigEntryNotReady
|
|
except requests.exceptions.HTTPError as ex:
|
|
if ex.response.status_code > 400 and ex.response.status_code < 500:
|
|
_LOGGER.error("Failed to login to tado: %s", ex)
|
|
return False
|
|
raise ConfigEntryNotReady
|
|
|
|
# Do first update
|
|
await hass.async_add_executor_job(tadoconnector.update)
|
|
|
|
# Poll for updates in the background
|
|
update_track = async_track_time_interval(
|
|
hass, lambda now: tadoconnector.update(), SCAN_INTERVAL,
|
|
)
|
|
|
|
update_listener = entry.add_update_listener(_async_update_listener)
|
|
|
|
hass.data[DOMAIN][entry.entry_id] = {
|
|
DATA: tadoconnector,
|
|
UPDATE_TRACK: update_track,
|
|
UPDATE_LISTENER: update_listener,
|
|
}
|
|
|
|
for component in TADO_COMPONENTS:
|
|
hass.async_create_task(
|
|
hass.config_entries.async_forward_entry_setup(entry, component)
|
|
)
|
|
|
|
return True
|
|
|
|
|
|
@callback
|
|
def _async_import_options_from_data_if_missing(hass: HomeAssistant, entry: ConfigEntry):
|
|
options = dict(entry.options)
|
|
if CONF_FALLBACK not in options:
|
|
options[CONF_FALLBACK] = entry.data.get(CONF_FALLBACK, True)
|
|
hass.config_entries.async_update_entry(entry, options=options)
|
|
|
|
|
|
async def _async_update_listener(hass: HomeAssistant, entry: ConfigEntry):
|
|
"""Handle options update."""
|
|
await hass.config_entries.async_reload(entry.entry_id)
|
|
|
|
|
|
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry):
|
|
"""Unload a config entry."""
|
|
unload_ok = all(
|
|
await asyncio.gather(
|
|
*[
|
|
hass.config_entries.async_forward_entry_unload(entry, component)
|
|
for component in TADO_COMPONENTS
|
|
]
|
|
)
|
|
)
|
|
|
|
hass.data[DOMAIN][entry.entry_id][UPDATE_TRACK]()
|
|
hass.data[DOMAIN][entry.entry_id][UPDATE_LISTENER]()
|
|
|
|
if unload_ok:
|
|
hass.data[DOMAIN].pop(entry.entry_id)
|
|
|
|
return unload_ok
|
|
|
|
|
|
class TadoConnector:
|
|
"""An object to store the Tado data."""
|
|
|
|
def __init__(self, hass, username, password, fallback):
|
|
"""Initialize Tado Connector."""
|
|
self.hass = hass
|
|
self._username = username
|
|
self._password = password
|
|
self._fallback = fallback
|
|
|
|
self.device_id = None
|
|
self.tado = None
|
|
self.zones = None
|
|
self.devices = None
|
|
self.data = {
|
|
"zone": {},
|
|
"device": {},
|
|
}
|
|
|
|
@property
|
|
def fallback(self):
|
|
"""Return fallback flag to Smart Schedule."""
|
|
return self._fallback
|
|
|
|
def setup(self):
|
|
"""Connect to Tado and fetch the zones."""
|
|
self.tado = Tado(self._username, self._password)
|
|
self.tado.setDebugging(True)
|
|
# Load zones and devices
|
|
self.zones = self.tado.getZones()
|
|
self.devices = self.tado.getMe()["homes"]
|
|
self.device_id = self.devices[0]["id"]
|
|
|
|
@Throttle(MIN_TIME_BETWEEN_UPDATES)
|
|
def update(self):
|
|
"""Update the registered zones."""
|
|
for zone in self.zones:
|
|
self.update_sensor("zone", zone["id"])
|
|
for device in self.devices:
|
|
self.update_sensor("device", device["id"])
|
|
|
|
def update_sensor(self, sensor_type, sensor):
|
|
"""Update the internal data from Tado."""
|
|
_LOGGER.debug("Updating %s %s", sensor_type, sensor)
|
|
try:
|
|
if sensor_type == "zone":
|
|
data = self.tado.getZoneState(sensor)
|
|
elif sensor_type == "device":
|
|
devices_data = self.tado.getDevices()
|
|
if not devices_data:
|
|
_LOGGER.info("There are no devices to setup on this tado account.")
|
|
return
|
|
|
|
data = devices_data[0]
|
|
else:
|
|
_LOGGER.debug("Unknown sensor: %s", sensor_type)
|
|
return
|
|
except RuntimeError:
|
|
_LOGGER.error(
|
|
"Unable to connect to Tado while updating %s %s", sensor_type, sensor,
|
|
)
|
|
return
|
|
|
|
self.data[sensor_type][sensor] = data
|
|
|
|
_LOGGER.debug(
|
|
"Dispatching update to %s %s %s: %s",
|
|
self.device_id,
|
|
sensor_type,
|
|
sensor,
|
|
data,
|
|
)
|
|
dispatcher_send(
|
|
self.hass,
|
|
SIGNAL_TADO_UPDATE_RECEIVED.format(self.device_id, sensor_type, sensor),
|
|
)
|
|
|
|
def get_capabilities(self, zone_id):
|
|
"""Return the capabilities of the devices."""
|
|
return self.tado.getCapabilities(zone_id)
|
|
|
|
def reset_zone_overlay(self, zone_id):
|
|
"""Reset the zone back to the default operation."""
|
|
self.tado.resetZoneOverlay(zone_id)
|
|
self.update_sensor("zone", zone_id)
|
|
|
|
def set_presence(
|
|
self, presence=PRESET_HOME,
|
|
):
|
|
"""Set the presence to home or away."""
|
|
if presence == PRESET_AWAY:
|
|
self.tado.setAway()
|
|
elif presence == PRESET_HOME:
|
|
self.tado.setHome()
|
|
|
|
def set_zone_overlay(
|
|
self,
|
|
zone_id=None,
|
|
overlay_mode=None,
|
|
temperature=None,
|
|
duration=None,
|
|
device_type="HEATING",
|
|
mode=None,
|
|
fan_speed=None,
|
|
swing=None,
|
|
):
|
|
"""Set a zone overlay."""
|
|
_LOGGER.debug(
|
|
"Set overlay for zone %s: overlay_mode=%s, temp=%s, duration=%s, type=%s, mode=%s fan_speed=%s swing=%s",
|
|
zone_id,
|
|
overlay_mode,
|
|
temperature,
|
|
duration,
|
|
device_type,
|
|
mode,
|
|
fan_speed,
|
|
swing,
|
|
)
|
|
|
|
try:
|
|
self.tado.setZoneOverlay(
|
|
zone_id,
|
|
overlay_mode,
|
|
temperature,
|
|
duration,
|
|
device_type,
|
|
"ON",
|
|
mode,
|
|
fanSpeed=fan_speed,
|
|
swing=swing,
|
|
)
|
|
|
|
except RequestException as exc:
|
|
_LOGGER.error("Could not set zone overlay: %s", exc)
|
|
|
|
self.update_sensor("zone", zone_id)
|
|
|
|
def set_zone_off(self, zone_id, overlay_mode, device_type="HEATING"):
|
|
"""Set a zone to off."""
|
|
try:
|
|
self.tado.setZoneOverlay(
|
|
zone_id, overlay_mode, None, None, device_type, "OFF"
|
|
)
|
|
except RequestException as exc:
|
|
_LOGGER.error("Could not set zone overlay: %s", exc)
|
|
|
|
self.update_sensor("zone", zone_id)
|