Implement templates for covers by PhracturedBlue · Pull Request #8100 · home-assistant/core

PhracturedBlue · 2017-06-19T03:17:29Z

Description:

Implement templates for cover elements

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#2842

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

cover:
  - platform: template
    cover:
      garage_door:
        friendly_name: "Garage Door"
        value_template: "{% raw %}{{is_state('sensor.garage_door > 0'}}{% endraw %}"
        open_cover:
          service: script.open_garage_door
        close_cover:
          service: script.close_garage_door
        stop_cover:
          service: script.stop_garage_door

Checklist:

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code does not interact with devices:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
Tests have been added to verify that the new code works.

houndci-bot · 2017-06-19T03:17:34Z

+        self.hass.start()
+        self.hass.block_till_done()
+
+        core.cover.set_cover_tilt_position(self.hass, 42, 'cover.test_template_cover')


line too long (86 > 79 characters)

houndci-bot · 2017-06-19T03:17:34Z

+        state = self.hass.states.get('cover.test_template_cover')
+        assert state.state == STATE_OPEN
+
+        core.cover.set_cover_position(self.hass, 42, 'cover.test_template_cover')


line too long (81 > 79 characters)

houndci-bot · 2017-06-19T03:17:34Z

+                    'covers': {
+                        'test_template_cover': {
+                            'position_template':
+                                "{{ states.cover.test_state.attributes.position }}",


line too long (84 > 79 characters)

I am not sure how to best fix this one without breaking the indentation

Since it is a string, wondering if you can split it in two lines, like:

"{{states.cover.test_state." "attributes.position}}",

You can find some other approaches to handle this here

Thanks.
I decided to shorten the state-variable name. I only needed 4 characters.. I think readability is better.

houndci-bot · 2017-06-19T03:17:34Z

+
+        state = self.hass.states.get('cover.test_template_cover')
+        assert state.state == STATE_CLOSED
+    def test_template_state_boolean(self):


expected 1 blank line, found 0

houndci-bot · 2017-06-19T03:17:34Z

+from homeassistant.const import STATE_ON, STATE_OFF, STATE_OPEN, STATE_CLOSED
+from homeassistant.helpers.restore_state import DATA_RESTORE_CACHE
+
+from tests.common import (


'tests.common.mock_component' imported but unused

houndci-bot · 2017-06-19T03:17:35Z

+                state = float(self._position_template.async_render())
+                if state < 0 or state > 100:
+                    self._position = None
+                    _LOGGER.error("Cover position value must be between 0 and 100.  Value was: %.2f", state)


line too long (108 > 79 characters)

houndci-bot · 2017-06-19T03:17:35Z

+            try:
+                state = self._template.async_render().lower()
+                if state in _VALID_STATES:
+                    self._position = 100 if state in ('true', STATE_OPEN) else 0


line too long (80 > 79 characters)

houndci-bot · 2017-06-19T03:17:35Z

+            self._tilt_template.hass = self.hass
+        if self._icon_template is not None:
+            self._icon_template.hass = self.hass
+    @asyncio.coroutine


expected 1 blank line, found 0

houndci-bot · 2017-06-19T03:17:35Z

+        if ((position_template is None and state_template is None) or
+                (position_template is not None and state_template is not None)):
+            _LOGGER.error('Must specify only one of: %s',
+                          ', '.join([CONF_VALUE_TEMPLATE, CONF_VALUE_TEMPLATE]))


line too long (80 > 79 characters)

houndci-bot · 2017-06-19T03:17:35Z

+        tilt_action = device_config.get(TILT_ACTION)
+
+        if ((position_template is None and state_template is None) or
+                (position_template is not None and state_template is not None)):


line too long (80 > 79 characters)

houndci-bot · 2017-06-19T03:24:29Z

+                state = float(self._position_template.async_render())
+                if state < 0 or state > 100:
+                    self._position = None
+                    _LOGGER.error("Cover position value must be between 0 and 100."


line too long (83 > 79 characters)

arsaboo · 2017-06-20T12:18:32Z

+        self.hass.stop()
+
+    def test_template_state_text(self):
+        """"Test the state text of a template."""


You have an extra double quote here.

arsaboo · 2017-06-20T12:20:02Z

+        assert state.state == STATE_CLOSED
+
+    def test_template_state_boolean(self):
+        """"Test the state text of a template."""


arsaboo · 2017-06-20T12:20:09Z

+        assert state.state == STATE_OPEN
+
+    def test_template_position(self):
+        """"Test the state text of a template."""


arsaboo · 2017-06-20T12:20:24Z

+        assert state.state == STATE_CLOSED
+
+    def test_template_tilt(self):
+        """"Test the state text of a template."""


Again, 4 quotes

arsaboo · 2017-06-20T12:20:32Z

+        assert state.attributes.get('current_tilt_position') == 42.0
+
+    def test_template_out_of_bounds(self):
+        """"Test the state text of a template."""


arsaboo · 2017-06-20T12:20:42Z

+        assert self.hass.states.all() == []
+
+    def test_template_non_numeric(self):
+        """"Test the state text of a template."""


Same. Just search for """" and replace by """ throughout the document

arsaboo · 2017-06-22T12:31:58Z

You may have to push another commit to fix the travis timeout error.

balloob · 2017-06-24T07:39:42Z

+        if ((position_template is None and state_template is None) or
+                (position_template is not None and
+                 state_template is not None)):
+            _LOGGER.error('Must specify only one of: %s',


Instead of testing like this, use the voluptuous Exclusive validator to make sure only 1 is passed in. Example: https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/wink.py#L53-L56

I've changed this, however I still need the check because voluptuous doesn't seem to offer one-hot exclusivity.

balloob · 2017-06-24T07:42:02Z

+    def async_added_to_hass(self):
+        """Register callbacks."""
+        state = yield from async_get_last_state(self.hass, self.entity_id)
+        if state:


This is a weird check. You want to check the value too. Now you just check that a state exists.

I don't understand the issue. I check the value in the next line:

if state: self._position = 100 if state.state else 0

Do you prefer that I remove the ternary check?

Sorry, added comment to the wrong line. But state.state is going to be either STATE_OPEN or STATE_CLOSED. Both are string values and thus will always be truthy, setting the position to 100.

Thank you for taking the time to explain the issue.

balloob · 2017-06-24T07:43:57Z

Great work! This is very close to be ready to be merged 💃

* Implement templates for covers * Fix a few remaining pylint warnings * Fix hound line-length warnings * Fix one more hound line-length warning * Fix quadruple-quotes an line length code-quality issues * Irrelevant change to retrigger travis due to timeout * Use volutuous Exclusive to check for mutex condition * Fix incorrect state check

Implement templates for covers

0e060bc

homeassistant added new-platform platform: cover.template cla-signed labels Jun 19, 2017

houndci-bot reviewed Jun 19, 2017

View reviewed changes

PhracturedBlue mentioned this pull request Jun 19, 2017

Initial documentation for cover templates home-assistant/home-assistant.io#2842

Merged

Fix a few remaining pylint warnings

975179c

balloobbot added the platform label Jun 19, 2017

houndci-bot reviewed Jun 19, 2017

View reviewed changes

Fix hound line-length warnings

9d97564

homeassistant added the cla-signed label Jun 19, 2017

Fix one more hound line-length warning

bfbca99

arsaboo reviewed Jun 20, 2017

View reviewed changes

Fix quadruple-quotes an line length code-quality issues

118319e

Irrelevant change to retrigger travis due to timeout

1df6f91

balloob reviewed Jun 24, 2017

View reviewed changes

PhracturedBlue added 2 commits June 24, 2017 06:29

Use volutuous Exclusive to check for mutex condition

e944659

Fix incorrect state check

f3ad4b2

balloob approved these changes Jun 30, 2017

View reviewed changes

balloob merged commit 17237e9 into home-assistant:dev Jun 30, 2017

balloob mentioned this pull request Jul 1, 2017

0.48 #8270

Merged

home-assistant locked and limited conversation to collaborators Oct 20, 2017

ghost added integration: template and removed platform: cover.template labels Mar 21, 2019

Uh oh!

Conversation

PhracturedBlue commented Jun 19, 2017 • edited by fabaff Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

arsaboo Jun 20, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

arsaboo commented Jun 22, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

balloob Jun 27, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

balloob commented Jun 24, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

PhracturedBlue commented Jun 19, 2017 •

edited by fabaff

Loading

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

arsaboo Jun 20, 2017 •

edited

Loading

balloob Jun 27, 2017 •

edited

Loading