Upgrade python-nest, add security_state sensor, nest.set_mode service set ETA as well (#14901)

homeassistant/components/nest.py

@@ -7,6 +7,7 @@ https://home-assistant.io/components/nest/
 from concurrent.futures import ThreadPoolExecutor
 import logging
 import socket
+from datetime import datetime, timedelta
 
 import voluptuous as vol
 
@@ -19,7 +20,7 @@ from homeassistant.helpers.dispatcher import async_dispatcher_send, \
     async_dispatcher_connect
 from homeassistant.helpers.entity import Entity
 
-REQUIREMENTS = ['python-nest==4.0.1']
+REQUIREMENTS = ['python-nest==4.0.2']
 
 _CONFIGURING = {}
 _LOGGER = logging.getLogger(__name__)
@@ -36,14 +37,23 @@ 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): cv.string,
-    vol.Optional(ATTR_STRUCTURE): vol.All(cv.ensure_list, cv.string)
+    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_str,
+    vol.Optional(ATTR_ETA_WINDOW): cv.time_period_str
 })
 
 CONFIG_SCHEMA = vol.Schema({
@@ -148,7 +158,11 @@ async def async_setup_nest(hass, nest, config, pin=None):
                            hass, component, DOMAIN, discovered, config)
 
     def set_mode(service):
-        """Set the home/away mode for a Nest structure."""
+        """
+        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:
@@ -158,6 +172,19 @@ async def async_setup_nest(hass, nest, config, pin=None):
             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])

homeassistant/components/sensor/nest.py

@@ -23,7 +23,7 @@ PROTECT_SENSOR_TYPES = ['co_status',
                         # color_status: "gray", "green", "yellow", "red"
                         'color_status']
 
-STRUCTURE_SENSOR_TYPES = ['eta']
+STRUCTURE_SENSOR_TYPES = ['eta', 'security_state']
 
 _VALID_SENSOR_TYPES = SENSOR_TYPES + TEMP_SENSOR_TYPES + PROTECT_SENSOR_TYPES \
                       + STRUCTURE_SENSOR_TYPES

homeassistant/components/services.yaml

@@ -576,3 +576,28 @@ shopping_list:
       name:
         description: The name of the item to mark as completed.
         example: Beer
+
+nest:
+  set_mode:
+    description: >
+                  Set the home/away mode for a Nest structure.
+                  Set to away mode will also set Estimated Arrival Time if provided.
+                  Set ETA will cause the thermostat to begin warming or cooling the home before the user arrives.
+                  After ETA set other Automation can read ETA sensor as a signal to prepare the home for
+                  the user's arrival.
+    fields:
+      home_mode:
+        description: home or away
+        example: home
+      structure:
+        description: Optional structure name. Default set all structures managed by Home Assistant.
+        example: My Home
+      eta:
+        description: Optional Estimated Arrival Time from now.
+        example: 0:10
+      eta_window:
+        description: Optional ETA window. Default is 1 minute.
+        example: 0:5
+      trip_id:
+        description: Optional identity of a trip. Using the same trip_ID will update the estimation.
+        example: trip_back_home

requirements_all.txt

@@ -1051,7 +1051,7 @@ python-mpd2==1.0.0
 python-mystrom==0.4.4
 
 # homeassistant.components.nest
-python-nest==4.0.1
+python-nest==4.0.2
 
 # homeassistant.components.device_tracker.nmap_tracker
 python-nmap==0.6.1