355 lines
12 KiB
Python
355 lines
12 KiB
Python
"""
|
|
Support for Nest devices.
|
|
|
|
For more details about this component, please refer to the documentation at
|
|
https://home-assistant.io/components/nest/
|
|
"""
|
|
from concurrent.futures import ThreadPoolExecutor
|
|
import logging
|
|
import socket
|
|
from datetime import datetime, timedelta
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.const import (
|
|
CONF_STRUCTURE, CONF_FILENAME, CONF_BINARY_SENSORS, CONF_SENSORS,
|
|
CONF_MONITORED_CONDITIONS,
|
|
EVENT_HOMEASSISTANT_START, EVENT_HOMEASSISTANT_STOP)
|
|
from homeassistant.helpers import discovery, config_validation as cv
|
|
from homeassistant.helpers.dispatcher import async_dispatcher_send, \
|
|
async_dispatcher_connect
|
|
from homeassistant.helpers.entity import Entity
|
|
|
|
REQUIREMENTS = ['python-nest==4.0.2']
|
|
|
|
_CONFIGURING = {}
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DOMAIN = 'nest'
|
|
|
|
DATA_NEST = 'nest'
|
|
|
|
SIGNAL_NEST_UPDATE = 'nest_update'
|
|
|
|
NEST_CONFIG_FILE = 'nest.conf'
|
|
CONF_CLIENT_ID = 'client_id'
|
|
CONF_CLIENT_SECRET = 'client_secret'
|
|
|
|
ATTR_HOME_MODE = 'home_mode'
|
|
ATTR_STRUCTURE = 'structure'
|
|
ATTR_TRIP_ID = 'trip_id'
|
|
ATTR_ETA = 'eta'
|
|
ATTR_ETA_WINDOW = 'eta_window'
|
|
|
|
HOME_MODE_AWAY = 'away'
|
|
HOME_MODE_HOME = 'home'
|
|
|
|
SENSOR_SCHEMA = vol.Schema({
|
|
vol.Optional(CONF_MONITORED_CONDITIONS): vol.All(cv.ensure_list)
|
|
})
|
|
|
|
AWAY_SCHEMA = vol.Schema({
|
|
vol.Required(ATTR_HOME_MODE): vol.In([HOME_MODE_AWAY, HOME_MODE_HOME]),
|
|
vol.Optional(ATTR_STRUCTURE): vol.All(cv.ensure_list, cv.string),
|
|
vol.Optional(ATTR_TRIP_ID): cv.string,
|
|
vol.Optional(ATTR_ETA): cv.time_period,
|
|
vol.Optional(ATTR_ETA_WINDOW): cv.time_period
|
|
})
|
|
|
|
CONFIG_SCHEMA = vol.Schema({
|
|
DOMAIN: vol.Schema({
|
|
vol.Required(CONF_CLIENT_ID): cv.string,
|
|
vol.Required(CONF_CLIENT_SECRET): cv.string,
|
|
vol.Optional(CONF_STRUCTURE): vol.All(cv.ensure_list, cv.string),
|
|
vol.Optional(CONF_SENSORS): SENSOR_SCHEMA,
|
|
vol.Optional(CONF_BINARY_SENSORS): SENSOR_SCHEMA
|
|
})
|
|
}, extra=vol.ALLOW_EXTRA)
|
|
|
|
|
|
async def async_nest_update_event_broker(hass, nest):
|
|
"""
|
|
Dispatch SIGNAL_NEST_UPDATE to devices when nest stream API received data.
|
|
|
|
nest.update_event.wait will block the thread in most of time,
|
|
so specific an executor to save default thread pool.
|
|
"""
|
|
_LOGGER.debug("listening nest.update_event")
|
|
with ThreadPoolExecutor(max_workers=1) as executor:
|
|
while True:
|
|
await hass.loop.run_in_executor(executor, nest.update_event.wait)
|
|
if hass.is_running:
|
|
nest.update_event.clear()
|
|
_LOGGER.debug("dispatching nest data update")
|
|
async_dispatcher_send(hass, SIGNAL_NEST_UPDATE)
|
|
else:
|
|
return
|
|
|
|
|
|
async def async_request_configuration(nest, hass, config):
|
|
"""Request configuration steps from the user."""
|
|
configurator = hass.components.configurator
|
|
if 'nest' in _CONFIGURING:
|
|
_LOGGER.debug("configurator failed")
|
|
configurator.async_notify_errors(
|
|
_CONFIGURING['nest'], "Failed to configure, please try again.")
|
|
return
|
|
|
|
async def async_nest_config_callback(data):
|
|
"""Run when the configuration callback is called."""
|
|
_LOGGER.debug("configurator callback")
|
|
pin = data.get('pin')
|
|
if await async_setup_nest(hass, nest, config, pin=pin):
|
|
# start nest update event listener as we missed startup hook
|
|
hass.async_add_job(async_nest_update_event_broker, hass, nest)
|
|
|
|
_CONFIGURING['nest'] = configurator.async_request_config(
|
|
"Nest", async_nest_config_callback,
|
|
description=('To configure Nest, click Request Authorization below, '
|
|
'log into your Nest account, '
|
|
'and then enter the resulting PIN'),
|
|
link_name='Request Authorization',
|
|
link_url=nest.authorize_url,
|
|
submit_caption="Confirm",
|
|
fields=[{'id': 'pin', 'name': 'Enter the PIN', 'type': ''}]
|
|
)
|
|
|
|
|
|
async def async_setup_nest(hass, nest, config, pin=None):
|
|
"""Set up the Nest devices."""
|
|
from nest.nest import AuthorizationError, APIError
|
|
if pin is not None:
|
|
_LOGGER.debug("pin acquired, requesting access token")
|
|
error_message = None
|
|
try:
|
|
nest.request_token(pin)
|
|
except AuthorizationError as auth_error:
|
|
error_message = "Nest authorization failed: {}".format(auth_error)
|
|
except APIError as api_error:
|
|
error_message = "Failed to call Nest API: {}".format(api_error)
|
|
|
|
if error_message is not None:
|
|
_LOGGER.warning(error_message)
|
|
hass.components.configurator.async_notify_errors(
|
|
_CONFIGURING['nest'], error_message)
|
|
return False
|
|
|
|
if nest.access_token is None:
|
|
_LOGGER.debug("no access_token, requesting configuration")
|
|
await async_request_configuration(nest, hass, config)
|
|
return False
|
|
|
|
if 'nest' in _CONFIGURING:
|
|
_LOGGER.debug("configuration done")
|
|
configurator = hass.components.configurator
|
|
configurator.async_request_done(_CONFIGURING.pop('nest'))
|
|
|
|
_LOGGER.debug("proceeding with setup")
|
|
conf = config[DOMAIN]
|
|
hass.data[DATA_NEST] = NestDevice(hass, conf, nest)
|
|
|
|
for component, discovered in [
|
|
('climate', {}),
|
|
('camera', {}),
|
|
('sensor', conf.get(CONF_SENSORS, {})),
|
|
('binary_sensor', conf.get(CONF_BINARY_SENSORS, {}))]:
|
|
_LOGGER.debug("proceeding with discovery -- %s", component)
|
|
hass.async_add_job(discovery.async_load_platform,
|
|
hass, component, DOMAIN, discovered, config)
|
|
|
|
def set_mode(service):
|
|
"""
|
|
Set the home/away mode for a Nest structure.
|
|
|
|
You can set optional eta information when set mode to away.
|
|
"""
|
|
if ATTR_STRUCTURE in service.data:
|
|
structures = service.data[ATTR_STRUCTURE]
|
|
else:
|
|
structures = hass.data[DATA_NEST].local_structure
|
|
|
|
for structure in nest.structures:
|
|
if structure.name in structures:
|
|
_LOGGER.info("Setting mode for %s", structure.name)
|
|
structure.away = service.data[ATTR_HOME_MODE]
|
|
|
|
if service.data[ATTR_HOME_MODE] == HOME_MODE_AWAY \
|
|
and ATTR_ETA in service.data:
|
|
now = datetime.utcnow()
|
|
eta_begin = now + service.data[ATTR_ETA]
|
|
eta_window = service.data.get(ATTR_ETA_WINDOW,
|
|
timedelta(minutes=1))
|
|
eta_end = eta_begin + eta_window
|
|
trip_id = service.data.get(
|
|
ATTR_TRIP_ID, "trip_{}".format(int(now.timestamp())))
|
|
_LOGGER.info("Setting eta for %s, eta window starts at "
|
|
"%s ends at %s", trip_id, eta_begin, eta_end)
|
|
structure.set_eta(trip_id, eta_begin, eta_end)
|
|
else:
|
|
_LOGGER.error("Invalid structure %s",
|
|
service.data[ATTR_STRUCTURE])
|
|
|
|
hass.services.async_register(
|
|
DOMAIN, 'set_mode', set_mode, schema=AWAY_SCHEMA)
|
|
|
|
def start_up(event):
|
|
"""Start Nest update event listener."""
|
|
hass.async_add_job(async_nest_update_event_broker, hass, nest)
|
|
|
|
hass.bus.async_listen_once(EVENT_HOMEASSISTANT_START, start_up)
|
|
|
|
def shut_down(event):
|
|
"""Stop Nest update event listener."""
|
|
if nest:
|
|
nest.update_event.set()
|
|
|
|
hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STOP, shut_down)
|
|
|
|
_LOGGER.debug("async_setup_nest is done")
|
|
|
|
return True
|
|
|
|
|
|
async def async_setup(hass, config):
|
|
"""Set up Nest components."""
|
|
from nest import Nest
|
|
|
|
if 'nest' in _CONFIGURING:
|
|
return
|
|
|
|
conf = config[DOMAIN]
|
|
client_id = conf[CONF_CLIENT_ID]
|
|
client_secret = conf[CONF_CLIENT_SECRET]
|
|
filename = config.get(CONF_FILENAME, NEST_CONFIG_FILE)
|
|
|
|
access_token_cache_file = hass.config.path(filename)
|
|
|
|
nest = Nest(
|
|
access_token_cache_file=access_token_cache_file,
|
|
client_id=client_id, client_secret=client_secret)
|
|
|
|
await async_setup_nest(hass, nest, config)
|
|
|
|
return True
|
|
|
|
|
|
class NestDevice(object):
|
|
"""Structure Nest functions for hass."""
|
|
|
|
def __init__(self, hass, conf, nest):
|
|
"""Init Nest Devices."""
|
|
self.hass = hass
|
|
self.nest = nest
|
|
|
|
if CONF_STRUCTURE not in conf:
|
|
self.local_structure = [s.name for s in nest.structures]
|
|
else:
|
|
self.local_structure = conf[CONF_STRUCTURE]
|
|
_LOGGER.debug("Structures to include: %s", self.local_structure)
|
|
|
|
def structures(self):
|
|
"""Generate a list of structures."""
|
|
try:
|
|
for structure in self.nest.structures:
|
|
if structure.name in self.local_structure:
|
|
yield structure
|
|
else:
|
|
_LOGGER.debug("Ignoring structure %s, not in %s",
|
|
structure.name, self.local_structure)
|
|
except socket.error:
|
|
_LOGGER.error(
|
|
"Connection error logging into the nest web service.")
|
|
|
|
def thermostats(self):
|
|
"""Generate a list of thermostats and their location."""
|
|
try:
|
|
for structure in self.nest.structures:
|
|
if structure.name in self.local_structure:
|
|
for device in structure.thermostats:
|
|
yield (structure, device)
|
|
else:
|
|
_LOGGER.debug("Ignoring structure %s, not in %s",
|
|
structure.name, self.local_structure)
|
|
except socket.error:
|
|
_LOGGER.error(
|
|
"Connection error logging into the nest web service.")
|
|
|
|
def smoke_co_alarms(self):
|
|
"""Generate a list of smoke co alarms."""
|
|
try:
|
|
for structure in self.nest.structures:
|
|
if structure.name in self.local_structure:
|
|
for device in structure.smoke_co_alarms:
|
|
yield (structure, device)
|
|
else:
|
|
_LOGGER.debug("Ignoring structure %s, not in %s",
|
|
structure.name, self.local_structure)
|
|
except socket.error:
|
|
_LOGGER.error(
|
|
"Connection error logging into the nest web service.")
|
|
|
|
def cameras(self):
|
|
"""Generate a list of cameras."""
|
|
try:
|
|
for structure in self.nest.structures:
|
|
if structure.name in self.local_structure:
|
|
for device in structure.cameras:
|
|
yield (structure, device)
|
|
else:
|
|
_LOGGER.debug("Ignoring structure %s, not in %s",
|
|
structure.name, self.local_structure)
|
|
except socket.error:
|
|
_LOGGER.error(
|
|
"Connection error logging into the nest web service.")
|
|
|
|
|
|
class NestSensorDevice(Entity):
|
|
"""Representation of a Nest sensor."""
|
|
|
|
def __init__(self, structure, device, variable):
|
|
"""Initialize the sensor."""
|
|
self.structure = structure
|
|
self.variable = variable
|
|
|
|
if device is not None:
|
|
# device specific
|
|
self.device = device
|
|
self._name = "{} {}".format(self.device.name_long,
|
|
self.variable.replace('_', ' '))
|
|
else:
|
|
# structure only
|
|
self.device = structure
|
|
self._name = "{} {}".format(self.structure.name,
|
|
self.variable.replace('_', ' '))
|
|
|
|
self._state = None
|
|
self._unit = None
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the nest, if any."""
|
|
return self._name
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
"""Return the unit the value is expressed in."""
|
|
return self._unit
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""Do not need poll thanks using Nest streaming API."""
|
|
return False
|
|
|
|
def update(self):
|
|
"""Do not use NestSensorDevice directly."""
|
|
raise NotImplementedError
|
|
|
|
async def async_added_to_hass(self):
|
|
"""Register update signal handler."""
|
|
async def async_update_state():
|
|
"""Update sensor state."""
|
|
await self.async_update_ha_state(True)
|
|
|
|
async_dispatcher_connect(self.hass, SIGNAL_NEST_UPDATE,
|
|
async_update_state)
|