Support for zwave light transitions

homeassistant/components/light/zwave.py

@@ -10,7 +10,7 @@
 # pylint: disable=import-error
 from threading import Timer
 from homeassistant.components.light import ATTR_BRIGHTNESS, ATTR_COLOR_TEMP, \
-    ATTR_RGB_COLOR, SUPPORT_BRIGHTNESS, SUPPORT_COLOR_TEMP, \
+    ATTR_RGB_COLOR, ATTR_TRANSITION, SUPPORT_BRIGHTNESS, SUPPORT_COLOR_TEMP, \
     SUPPORT_RGB_COLOR, DOMAIN, Light
 from homeassistant.components import zwave
 from homeassistant.components.zwave import async_setup_platform  # noqa # pylint: disable=unused-import
@@ -72,6 +72,13 @@ def brightness_state(value):
         return 0, STATE_OFF
 
 
+def ct_to_rgb(temp):
+    """Convert color temperature (mireds) to RGB."""
+    colorlist = list(
+        color_temperature_to_rgb(color_temperature_mired_to_kelvin(temp)))
+    return [int(val) for val in colorlist]
+
+
 class ZwaveDimmer(zwave.ZWaveDeviceEntity, Light):
     """Representation of a Z-Wave dimmer."""
 
@@ -141,8 +148,41 @@ def supported_features(self):
         """Flag supported features."""
         return SUPPORT_ZWAVE_DIMMER
 
+    def _set_duration(self, **kwargs):
+        """Set the transition time for the brightness value.
+
+        Zwave Dimming Duration values:
+        0x00      = instant
+        0x01-0x7F = 1 second to 127 seconds
+        0x80-0xFE = 1 minute to 127 minutes
+        0xFF      = factory default
+        """
+        if self.values.dimming_duration is None:
+            if ATTR_TRANSITION in kwargs:
+                _LOGGER.debug("Dimming not supported by %s.", self.entity_id)
+            return
+
+        if ATTR_TRANSITION not in kwargs:
+            self.values.dimming_duration.data = 0xFF
+            return
+
+        transition = kwargs[ATTR_TRANSITION]
+        if transition <= 127:
+            self.values.dimming_duration.data = int(transition)
+        elif transition > 7620:
+            self.values.dimming_duration.data = 0xFE
+            _LOGGER.warning("Transition clipped to 127 minutes for %s.",
+                            self.entity_id)
+        else:
+            minutes = int(transition / 60)
+            _LOGGER.debug("Transition rounded to %d minutes for %s.",
+                          minutes, self.entity_id)
+            self.values.dimming_duration.data = minutes + 0x7F
+
     def turn_on(self, **kwargs):
         """Turn the device on."""
+        self._set_duration(**kwargs)
+
         # Zwave multilevel switches use a range of [0, 99] to control
         # brightness. Level 255 means to set it to previous value.
         if ATTR_BRIGHTNESS in kwargs:
@@ -156,17 +196,12 @@ def turn_on(self, **kwargs):
 
     def turn_off(self, **kwargs):
         """Turn the device off."""
+        self._set_duration(**kwargs)
+
         if self.node.set_dimmer(self.values.primary.value_id, 0):
             self._state = STATE_OFF
 
 
-def ct_to_rgb(temp):
-    """Convert color temperature (mireds) to RGB."""
-    colorlist = list(
-        color_temperature_to_rgb(color_temperature_mired_to_kelvin(temp)))
-    return [int(val) for val in colorlist]
-
-
 class ZwaveColorLight(ZwaveDimmer):
     """Representation of a Z-Wave color changing light."""
 

homeassistant/components/zwave/discovery_schemas.py

@@ -121,6 +121,13 @@
              const.DISC_GENRE: const.GENRE_USER,
              const.DISC_TYPE: const.TYPE_BYTE,
          },
+         'dimming_duration': {
+             const.DISC_COMMAND_CLASS: [const.COMMAND_CLASS_SWITCH_MULTILEVEL],
+             const.DISC_GENRE: const.GENRE_SYSTEM,
+             const.DISC_TYPE: const.TYPE_BYTE,
+             const.DISC_LABEL: 'Dimming Duration',
+             const.DISC_OPTIONAL: True,
+         },
          'color': {
              const.DISC_COMMAND_CLASS: [const.COMMAND_CLASS_SWITCH_COLOR],
              const.DISC_GENRE: const.GENRE_USER,

tests/components/light/test_zwave.py

@@ -4,7 +4,7 @@
 import homeassistant.components.zwave
 from homeassistant.components.zwave import const
 from homeassistant.components.light import (
-    zwave, ATTR_BRIGHTNESS, ATTR_COLOR_TEMP, ATTR_RGB_COLOR)
+    zwave, ATTR_BRIGHTNESS, ATTR_COLOR_TEMP, ATTR_RGB_COLOR, ATTR_TRANSITION)
 
 from tests.mock.zwave import (
     MockNode, MockValue, MockEntityValues, value_changed)
@@ -15,6 +15,7 @@ class MockLightValues(MockEntityValues):
 
     def __init__(self, **kwargs):
         """Initialize the mock zwave values."""
+        self.dimming_duration = None
         self.color = None
         self.color_channels = None
         super().__init__(**kwargs)
@@ -77,6 +78,56 @@ def test_dimmer_turn_on(mock_openzwave):
     assert value_id == value.value_id
     assert brightness == 46  # int(120 / 255 * 99)
 
+    with patch.object(zwave, '_LOGGER', MagicMock()) as mock_logger:
+        device.turn_on(**{ATTR_TRANSITION: 35})
+        assert mock_logger.debug.called
+        assert node.set_dimmer.called
+        msg, entity_id = mock_logger.debug.mock_calls[0][1]
+        assert entity_id == device.entity_id
+
+
+def test_dimmer_transitions(mock_openzwave):
+    """Test dimming transition on a dimmable Z-Wave light."""
+    node = MockNode()
+    value = MockValue(data=0, node=node)
+    duration = MockValue(data=0, node=node)
+    values = MockLightValues(primary=value, dimming_duration=duration)
+    device = zwave.get_device(node=node, values=values, node_config={})
+
+    # Test turn_on
+    # Factory Default
+    device.turn_on()
+    assert duration.data == 0xFF
+
+    # Seconds transition
+    device.turn_on(**{ATTR_TRANSITION: 45})
+    assert duration.data == 45
+
+    # Minutes transition
+    device.turn_on(**{ATTR_TRANSITION: 245})
+    assert duration.data == 0x83
+
+    # Clipped transition
+    device.turn_on(**{ATTR_TRANSITION: 10000})
+    assert duration.data == 0xFE
+
+    # Test turn_off
+    # Factory Default
+    device.turn_off()
+    assert duration.data == 0xFF
+
+    # Seconds transition
+    device.turn_off(**{ATTR_TRANSITION: 45})
+    assert duration.data == 45
+
+    # Minutes transition
+    device.turn_off(**{ATTR_TRANSITION: 245})
+    assert duration.data == 0x83
+
+    # Clipped transition
+    device.turn_off(**{ATTR_TRANSITION: 10000})
+    assert duration.data == 0xFE
+
 
 def test_dimmer_turn_off(mock_openzwave):
     """Test turning off a dimmable Z-Wave light."""