Implement thermostat support for Alexa #13340

trisk · 2018-03-19T19:41:30Z

Description:

This provides full Alexa.ThermostatController support for thermostats with multiple setpoints. These entities also support the Alexa.TemperatureSensor interface for reporting the current temperature.

Example entry for `configuration.yaml` (if applicable):

alexa:
  smart_home:
    filter:
      include_domains:
        - climate

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass

If the code does not interact with devices:

Tests have been added to verify that the new code works.

houndci-bot · 2018-03-19T19:41:42Z

tests/components/alexa/test_smart_home.py

+        'Alexa.TemperatureSensor',
+    )
+
+    properties = yield from reported_properties(hass, 'climate#test_thermostat')


line too long (80 > 79 characters)

houndci-bot · 2018-03-19T19:41:43Z

homeassistant/components/alexa/smart_home.py

+
+
+def temperature_from_object(temperature, to_unit, absolute=True)
+    """Get temperature from Temperature object in requested unit."""


unexpected indentation

houndci-bot · 2018-03-19T19:41:43Z

homeassistant/components/alexa/smart_home.py

+        temp = self.entity.state
+        if self.entity.domain == climate.DOMAIN:
+            temp =
+                self.entity.attributes.get(climate.ATTR_CURRENT_TEMPERATURE, 0)


unexpected indentation

houndci-bot · 2018-03-19T19:41:43Z

homeassistant/components/alexa/smart_home.py

@@ -383,12 +371,85 @@ def get_property(self, name):
            raise _UnsupportedProperty(name)

        unit = self.entity.attributes[CONF_UNIT_OF_MEASUREMENT]
+        temp = self.entity.state
+        if self.entity.domain == climate.DOMAIN:
+            temp =


SyntaxError: invalid syntax

houndci-bot · 2018-03-19T19:41:43Z

homeassistant/components/alexa/const.py

+
+API_TEMP_UNITS = {
+    TEMP_FAHRENHEIT: 'FAHRENHEIT',
+    TEMP_CELSIUS: 'CELSIUS',


undefined name 'TEMP_CELSIUS'

houndci-bot · 2018-03-19T19:41:43Z

homeassistant/components/alexa/const.py

+SMART_HOME_HTTP_ENDPOINT = '/api/alexa/smart_home'
+
+API_TEMP_UNITS = {
+    TEMP_FAHRENHEIT: 'FAHRENHEIT',


undefined name 'TEMP_FAHRENHEIT'

houndci-bot · 2018-03-19T19:41:43Z

tests/components/alexa/test_smart_home.py

+        'Alexa.TemperatureSensor',
+    )
+
+    properties = yield from reported_properties(hass, 'climate#test_thermostat')


line too long (80 > 79 characters)

houndci-bot · 2018-03-19T19:41:44Z

homeassistant/components/alexa/smart_home.py

+
+
+def temperature_from_object(temperature, to_unit, absolute=True)
+    """Get temperature from Temperature object in requested unit."""


unexpected indentation

houndci-bot · 2018-03-19T19:41:44Z

homeassistant/components/alexa/smart_home.py

+        temp = self.entity.state
+        if self.entity.domain == climate.DOMAIN:
+            temp =
+                self.entity.attributes.get(climate.ATTR_CURRENT_TEMPERATURE, 0)


unexpected indentation

houndci-bot · 2018-03-19T19:41:44Z

homeassistant/components/alexa/smart_home.py

@@ -383,12 +371,85 @@ def get_property(self, name):
            raise _UnsupportedProperty(name)

        unit = self.entity.attributes[CONF_UNIT_OF_MEASUREMENT]
+        temp = self.entity.state
+        if self.entity.domain == climate.DOMAIN:
+            temp =


SyntaxError: invalid syntax

houndci-bot · 2018-03-19T19:41:44Z

homeassistant/components/alexa/const.py

+
+API_TEMP_UNITS = {
+    TEMP_FAHRENHEIT: 'FAHRENHEIT',
+    TEMP_CELSIUS: 'CELSIUS',


undefined name 'TEMP_CELSIUS'

houndci-bot · 2018-03-19T19:41:44Z

homeassistant/components/alexa/const.py

+SMART_HOME_HTTP_ENDPOINT = '/api/alexa/smart_home'
+
+API_TEMP_UNITS = {
+    TEMP_FAHRENHEIT: 'FAHRENHEIT',


undefined name 'TEMP_FAHRENHEIT'

houndci-bot · 2018-03-19T19:50:58Z

homeassistant/components/alexa/smart_home.py

@@ -383,12 +377,84 @@ def get_property(self, name):
            raise _UnsupportedProperty(name)

        unit = self.entity.attributes[CONF_UNIT_OF_MEASUREMENT]
+        temp = self.entity.state
+        if self.entity.domain == climate.DOMAIN:
+            temp =/  self.entity.attributes.get(climate.ATTR_CURRENT_TEMPERATURE, 0)


missing whitespace around operator
SyntaxError: invalid syntax
multiple spaces after operator
line too long (84 > 79 characters)

houndci-bot · 2018-03-22T16:38:37Z

homeassistant/components/alexa/smart_home.py

+
+@HANDLERS.register(('Alexa.ThermostatController', 'SetTargetTemperature')
+@asyncio.coroutine
+def async_api_set_target_temperature(hass, config, request, entity):


SyntaxError: invalid syntax

houndci-bot · 2018-03-22T16:51:27Z

homeassistant/components/alexa/smart_home.py

+
+    data = {
+        ATTR_ENTITY_ID: entity.entity_id
+        ATTR_TEMPERATURE: entity.attributes[ATTR_TEMPERATURE] + delta


SyntaxError: invalid syntax

houndci-bot · 2018-03-22T21:06:34Z

tests/components/alexa/test_smart_home.py

+            'target_temp_low': 60.0,
+            'current_temperature': 75.0,
+            'friendly_name': "Test Thermostat",
+            'supported_features': 1|2|4|128,


missing whitespace around bitwise or shift operator

houndci-bot · 2018-03-28T17:08:47Z

homeassistant/components/alexa/smart_home.py

+            request,
+            namespace='Alexa.ThermostatController',
+            error_type='UNSUPPORTED_THERMOSTAT_MODE',
+            error_message=msg


missing whitespace around operator

houndci-bot · 2018-03-28T17:08:47Z

homeassistant/components/alexa/smart_home.py

+        return api_error(
+            request,
+            namespace='Alexa.ThermostatController',
+            error_type='UNSUPPORTED_THERMOSTAT_MODE',


missing whitespace around operator

houndci-bot · 2018-03-28T17:08:47Z

homeassistant/components/alexa/smart_home.py

+        _LOGGER.info(msg)
+        return api_error(
+            request,
+            namespace='Alexa.ThermostatController',


missing whitespace around operator

houndci-bot · 2018-03-28T17:08:47Z

homeassistant/components/alexa/smart_home.py

+        msg = 'The requested thermostat mode {} is not supported'.format(mode)
+        _LOGGER.info(msg)
+        return api_error(
+            request,


unexpected indentation

houndci-bot · 2018-03-28T17:08:47Z

homeassistant/components/alexa/smart_home.py

+        None)
+    )
+    if ha_mode not in operation_list:
+        msg = 'The requested thermostat mode {} is not supported'.format(mode)


unexpected spaces around keyword / parameter equals

houndci-bot · 2018-03-28T17:08:48Z

homeassistant/components/alexa/smart_home.py

+        (k for k, v in API_THERMOSTAT_MODES.items() if v == mode),
+        None)
+    )
+    if ha_mode not in operation_list:


continuation line missing indentation or outdented

houndci-bot · 2018-03-28T17:08:48Z

homeassistant/components/alexa/smart_home.py

+    ha_mode = next(
+        (k for k, v in API_THERMOSTAT_MODES.items() if v == mode),
+        None)
+    )


SyntaxError: invalid syntax

balloob · 2018-03-28T23:08:55Z

tests/components/alexa/test_smart_home.py

@@ -693,6 +693,134 @@ def test_unknown_sensor(hass):
    yield from discovery_test(device, hass, expected_endpoints=0)


+@asyncio.coroutine


We've migrated to async/await syntax. Please drop this decorator and prefix async methods with async like async def test_thermostat. Replace any yield from with await.

balloob · 2018-03-28T23:09:47Z

homeassistant/components/alexa/smart_home.py

+    mode = request[API_PAYLOAD]['thermostatMode']
+
+    operation_list = entity.attributes.get(climate.ATTR_OPERATION_LIST)
+    # pylint: disable=stop-iteration-return


What are you disabling here?

The travis-ci build uses a version of pylint that incorrectly fails next(..., default) as throwing an exception. pylint-dev/pylint#1830

balloob · 2018-03-28T23:10:12Z

homeassistant/components/alexa/smart_home.py

+    )
+    if ha_mode not in operation_list:
+        msg = 'The requested thermostat mode {} is not supported'.format(mode)
+        _LOGGER.info(msg)


This should be an error ? And should we have the alexa smart home handler just log an error when we are returning an error message?

Totally valid requests from the user can specify modes or temperatures not supported by the device (since the API does not enumerate the accepted values) and I'm logging them at info level since they're not indicative of software bugs or configuration errors.

You're right, it might make sense to log all error responses we send though.

balloob · 2018-03-28T23:10:37Z

homeassistant/components/alexa/smart_home.py

+
+@HANDLERS.register(('Alexa.ThermostatController', 'AdjustTargetTemperature'))
+@extract_entity
+@asyncio.coroutine


We've migrated to async/await syntax. Please drop this decorator and prefix async methods with async like async def async_api_adjust_target_temp. Replace any yield from with await.

balloob · 2018-03-28T23:10:57Z

homeassistant/components/alexa/smart_home.py

+    }
+
+    msg = 'The requested temperature {} is out of range'.format(temp)
+    _LOGGER.info(msg)


Stale debug

I'm logging this intentionally, but it might make sense to do it from the api_error method.

houndci-bot · 2018-03-29T16:16:04Z

homeassistant/components/alexa/smart_home.py

+    _LOGGER.warning("Request %s/%s error %s: %s",
+                 request[API_HEADER]['namespace'],
+                 request[API_HEADER]['name'],
+                 error_type, error_message)


continuation line under-indented for visual indent

houndci-bot · 2018-03-29T16:16:04Z

homeassistant/components/alexa/smart_home.py

+
+    _LOGGER.warning("Request %s/%s error %s: %s",
+                 request[API_HEADER]['namespace'],
+                 request[API_HEADER]['name'],


continuation line under-indented for visual indent

houndci-bot · 2018-03-29T16:16:05Z

homeassistant/components/alexa/smart_home.py

+    payload['message'] = error_message
+
+    _LOGGER.warning("Request %s/%s error %s: %s",
+                 request[API_HEADER]['namespace'],


continuation line under-indented for visual indent

houndci-bot · 2018-03-29T22:29:48Z

homeassistant/components/alexa/smart_home.py

+    _LOGGER.info("Request %s/%s error %s: %s",
+                    request[API_HEADER]['namespace'],
+                    request[API_HEADER]['name'],
+                    error_type, error_message)


continuation line over-indented for visual indent

houndci-bot · 2018-03-29T22:29:49Z

homeassistant/components/alexa/smart_home.py

+
+    _LOGGER.info("Request %s/%s error %s: %s",
+                    request[API_HEADER]['namespace'],
+                    request[API_HEADER]['name'],


continuation line over-indented for visual indent

houndci-bot · 2018-03-29T22:29:49Z

homeassistant/components/alexa/smart_home.py

+    payload['message'] = error_message
+
+    _LOGGER.info("Request %s/%s error %s: %s",
+                    request[API_HEADER]['namespace'],


continuation line over-indented for visual indent

houndci-bot · 2018-03-29T22:29:49Z

homeassistant/components/alexa/smart_home.py

+    _LOGGER.info("Request %s/%s error %s: %s",
+                    request[API_HEADER]['namespace'],
+                    request[API_HEADER]['name'],
+                    error_type, error_message)


continuation line over-indented for visual indent

houndci-bot · 2018-03-29T22:29:49Z

homeassistant/components/alexa/smart_home.py

+
+    _LOGGER.info("Request %s/%s error %s: %s",
+                    request[API_HEADER]['namespace'],
+                    request[API_HEADER]['name'],


continuation line over-indented for visual indent

houndci-bot · 2018-03-29T22:29:49Z

homeassistant/components/alexa/smart_home.py

+    payload['message'] = error_message
+
+    _LOGGER.info("Request %s/%s error %s: %s",
+                    request[API_HEADER]['namespace'],


continuation line over-indented for visual indent

balloob · 2018-03-30T06:49:12Z

Nice! 🎉

homeassistant added cla-signed integration: alexa core labels Mar 19, 2018

houndci-bot reviewed Mar 19, 2018

View reviewed changes

trisk force-pushed the alexa_thermostat branch from 17c3e7d to a0d2905 Compare March 19, 2018 19:50

homeassistant added the cla-signed label Mar 19, 2018

houndci-bot reviewed Mar 19, 2018

View reviewed changes

trisk force-pushed the alexa_thermostat branch from a0d2905 to f7406e7 Compare March 19, 2018 19:52

homeassistant added the cla-signed label Mar 19, 2018

trisk force-pushed the alexa_thermostat branch from f7406e7 to b78d2a7 Compare March 19, 2018 19:59

homeassistant added the cla-signed label Mar 19, 2018

trisk force-pushed the alexa_thermostat branch from b78d2a7 to 11985e4 Compare March 22, 2018 16:38

homeassistant added the cla-signed label Mar 22, 2018

houndci-bot reviewed Mar 22, 2018

View reviewed changes

trisk force-pushed the alexa_thermostat branch from 11985e4 to aced973 Compare March 22, 2018 16:51

homeassistant added the cla-signed label Mar 22, 2018

houndci-bot reviewed Mar 22, 2018

View reviewed changes

trisk force-pushed the alexa_thermostat branch from aced973 to ed397ff Compare March 22, 2018 17:27

homeassistant added the cla-signed label Mar 22, 2018

trisk force-pushed the alexa_thermostat branch from ed397ff to 444090b Compare March 22, 2018 17:39

homeassistant added the cla-signed label Mar 22, 2018

trisk force-pushed the alexa_thermostat branch from 444090b to 000501c Compare March 22, 2018 21:06

homeassistant added the cla-signed label Mar 22, 2018

houndci-bot reviewed Mar 22, 2018

View reviewed changes

trisk force-pushed the alexa_thermostat branch from 000501c to 0091604 Compare March 22, 2018 21:12

homeassistant added the cla-signed label Mar 22, 2018

trisk force-pushed the alexa_thermostat branch from 0091604 to ff9e645 Compare March 22, 2018 23:21

homeassistant added the cla-signed label Mar 22, 2018

trisk force-pushed the alexa_thermostat branch from ff9e645 to b5472fb Compare March 22, 2018 23:39

trisk force-pushed the alexa_thermostat branch from 45b8e78 to 8af9d77 Compare March 28, 2018 17:08

homeassistant added the cla-signed label Mar 28, 2018

houndci-bot reviewed Mar 28, 2018

View reviewed changes

trisk force-pushed the alexa_thermostat branch from 8af9d77 to 826973d Compare March 28, 2018 17:18

homeassistant added the cla-signed label Mar 28, 2018

balloob reviewed Mar 28, 2018

View reviewed changes

trisk added 2 commits March 29, 2018 15:42

Use climate.ATTR_OPERATION_MODE for Alexa thermostat mode

806c5fc

Switch coroutines to async/await

ece4450

trisk force-pushed the alexa_thermostat branch from 826973d to ece4450 Compare March 29, 2018 15:49

homeassistant added the cla-signed label Mar 29, 2018

houndci-bot reviewed Mar 29, 2018

View reviewed changes

trisk force-pushed the alexa_thermostat branch from 13ecb0a to dd1d48e Compare March 29, 2018 16:18

homeassistant added the cla-signed label Mar 29, 2018

anthonylavado mentioned this pull request Mar 29, 2018

"Climate" not recognized mike-grant/haaska#33

Closed

trisk force-pushed the alexa_thermostat branch from dd1d48e to d536b27 Compare March 29, 2018 22:29

homeassistant added the cla-signed label Mar 29, 2018

houndci-bot reviewed Mar 29, 2018

View reviewed changes

Log all Alexa error events

9f91acb

trisk force-pushed the alexa_thermostat branch from d536b27 to 9f91acb Compare March 29, 2018 22:55

homeassistant added the cla-signed label Mar 29, 2018

balloob approved these changes Mar 30, 2018

View reviewed changes

balloob merged commit 5801d78 into home-assistant:dev Mar 30, 2018

balloob mentioned this pull request Apr 13, 2018

0.67.0 #13856

Merged

home-assistant locked and limited conversation to collaborators Jul 26, 2018



		def temperature_from_object(temperature, to_unit, absolute=True)
		"""Get temperature from Temperature object in requested unit."""

		@@ -693,6 +693,134 @@ def test_unknown_sensor(hass):
		yield from discovery_test(device, hass, expected_endpoints=0)


		@asyncio.coroutine

Implement thermostat support for Alexa #13340

Implement thermostat support for Alexa #13340

Conversation

trisk commented Mar 19, 2018 • edited Loading

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trisk Mar 28, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

balloob commented Mar 30, 2018

trisk commented Mar 19, 2018 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):

trisk Mar 28, 2018 •

edited

Loading