Changing z-wave brightness calculation to respect 0x01 and 0x02 byte values #16420

Harvtronix · 2018-09-04T16:35:51Z

Description:

Changing z-wave brightness calculation to respect 0x01 and 0x02 byte values

Related issue (if applicable): fixes #16406

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

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

Checklist:

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

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

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

If the code communicates with devices, web services, or third-party tools:

New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New or updated dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:

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

values

homeassistant · 2018-09-04T16:35:52Z

Hi @Harvtronix,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

houndci-bot · 2018-09-04T16:36:09Z

homeassistant/components/light/zwave.py

@@ -62,6 +62,15 @@ def brightness_state(value):
        return round((value.data / 99) * 255), STATE_ON
    return 0, STATE_OFF

+def byte_to_zwave_brightness(value):


expected 2 blank lines, found 1

balloob · 2018-09-12T11:09:13Z

homeassistant/components/light/zwave.py

+    """
+    if value > 0:
+        return max(1, int((value / 255) * 99))
+    return 0


If the value is 0, shouldn't we just return None (there is no brightness) ?

@balloob The brightness value as it was used in the original code was an integer in the range of 0 to 99, with 255 representing a special case. I wanted to stay as close to this behavior as possible to minimize the risk of regressing existing code.
I'm open to whatever changes you'd like. I was just going for "minimally invasive" :)

We should keep it as returning zero, since this is the brightness that we send to the ZWave device, not the brightness value for hass.

emlove

I'm 👍 with this change overall. Great catch, and thanks for adding tests!

You'll also need to fix the picky lint issues Travis called out:
https://travis-ci.org/home-assistant/home-assistant/jobs/424420886#L561-L562

emlove · 2018-09-12T13:38:35Z

homeassistant/components/light/zwave.py

+    """
+    if value > 0:
+        return max(1, int((value / 255) * 99))
+    return 0


We should keep it as returning zero, since this is the brightness that we send to the ZWave device, not the brightness value for hass.

Harvtronix · 2018-09-12T13:46:58Z

@armills Thanks! And thanks for pointing that out! Looks like some comment formatting issues. I'll search for a multiline comment and model after that. Strangely, the linter that was running locally after I imported the project into vscode wasn't reporting these same issues.

- Add additional unit test to increase code coverage

Harvtronix · 2018-09-13T07:29:07Z

tests/components/light/test_zwave.py

+    device.turn_on(**{ATTR_BRIGHTNESS: 0})
+
+    assert device.is_on
+    assert device.brightness == 0


@armills I thought about the second part of this test here that I added some more, and I'd like your opinion as to whether or not the result makes sense. Right now, calling turn on with a brightness val of 0, will result in device.is_on returning true... Is that the intended behavior? If not, I can add an else block to the turn_on method that sets the state to off in the case of 0 being passed in.

Good catch. That really should be cleaned up.

If you don't mind we could also refactor it to make it a little simpler. self._state can just be a boolean. STATE_ON can be replaced with True, STATE_OFF can be replaced with False, and we can return it directly here: https://github.com/home-assistant/home-assistant/blob/a40a6e31ada250d48241698ed133a847f45508a0/homeassistant/components/light/zwave.py#L154 . Then in the turn_on method you can just assign self._state = brightness > 0.

emlove · 2018-09-13T14:39:22Z

I've merged this PR since the state problem existed already, and this is a solid bug fix. If you can help clean up that state problem you can open a new PR for that fix.

Thanks for the contribution! 🌟

Harvtronix · 2018-09-17T04:26:51Z

@armills Sure thing! I should hopefully be able to work on that over the next couple of days.

Changing z-wave brightness calculation to respect 0x01 and 0x02 byte

9b0b65e

values

Harvtronix requested a review from a team as a code owner September 4, 2018 16:35

homeassistant added cla-needed platform: light.zwave small-pr PRs with less than 30 lines. labels Sep 4, 2018

ghost added the in progress label Sep 4, 2018

houndci-bot reviewed Sep 4, 2018

View reviewed changes

homeassistant added cla-signed and removed cla-needed labels Sep 4, 2018

adding additional line breaks to satisfy houndci

d9d2ee2

homeassistant added the cla-signed label Sep 4, 2018

balloob reviewed Sep 12, 2018

View reviewed changes

emlove approved these changes Sep 12, 2018

View reviewed changes

- Update comment style for linter

9bb7ee1

- Add additional unit test to increase code coverage

homeassistant added the cla-signed label Sep 12, 2018

Update zwave.py

a40a6e3

ghost assigned balloob Sep 13, 2018

Harvtronix commented Sep 13, 2018

View reviewed changes

emlove merged commit d076251 into home-assistant:dev Sep 13, 2018

ghost removed the in progress label Sep 13, 2018

balloob mentioned this pull request Sep 28, 2018

0.79.0 #16940

Merged

home-assistant locked and limited conversation to collaborators Feb 5, 2019

ghost added integration: zwave and removed platform: light.zwave labels Mar 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changing z-wave brightness calculation to respect 0x01 and 0x02 byte values #16420

Changing z-wave brightness calculation to respect 0x01 and 0x02 byte values #16420

Harvtronix commented Sep 4, 2018 •

edited

Loading

homeassistant commented Sep 4, 2018

houndci-bot Sep 4, 2018

balloob Sep 12, 2018

Harvtronix Sep 12, 2018 •

edited

Loading

emlove Sep 12, 2018

emlove left a comment

emlove Sep 12, 2018

Harvtronix commented Sep 12, 2018

Harvtronix Sep 13, 2018

emlove Sep 13, 2018

emlove commented Sep 13, 2018

Harvtronix commented Sep 17, 2018

Changing z-wave brightness calculation to respect 0x01 and 0x02 byte values #16420

Changing z-wave brightness calculation to respect 0x01 and 0x02 byte values #16420

Conversation

Harvtronix commented Sep 4, 2018 • edited Loading

Description:

Example entry for configuration.yaml (if applicable): n/a

Checklist:

homeassistant commented Sep 4, 2018

houndci-bot Sep 4, 2018

Choose a reason for hiding this comment

balloob Sep 12, 2018

Choose a reason for hiding this comment

Harvtronix Sep 12, 2018 • edited Loading

Choose a reason for hiding this comment

emlove Sep 12, 2018

Choose a reason for hiding this comment

emlove left a comment

Choose a reason for hiding this comment

emlove Sep 12, 2018

Choose a reason for hiding this comment

Harvtronix commented Sep 12, 2018

Harvtronix Sep 13, 2018

Choose a reason for hiding this comment

emlove Sep 13, 2018

Choose a reason for hiding this comment

emlove commented Sep 13, 2018

Harvtronix commented Sep 17, 2018

Harvtronix commented Sep 4, 2018 •

edited

Loading

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

Harvtronix Sep 12, 2018 •

edited

Loading