Fix support for legacy Z-Wave thermostats (home-assistant#29955)

This brings back support for Z-Wave thermostats
of SETPOINT_THERMOSTAT specific device class.
Such devices don't have COMMAND_CLASS_THERMOSTAT_MODE
and are now handled separately.

Author: oandrew

homeassistant/components/zwave/climate.py

@@ -1,7 +1,7 @@
 """Support for Z-Wave climate devices."""
 # Because we do not compile openzwave on CI
 import logging
-from typing import Optional
+from typing import Optional, Tuple
 
 from homeassistant.components.climate import ClimateDevice
 from homeassistant.components.climate.const import (
@@ -34,7 +34,7 @@
 from homeassistant.core import callback
 from homeassistant.helpers.dispatcher import async_dispatcher_connect
 
-from . import ZWaveDeviceEntity
+from . import ZWaveDeviceEntity, const
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -147,10 +147,14 @@ def async_add_climate(climate):
 def get_device(hass, values, **kwargs):
     """Create Z-Wave entity device."""
     temp_unit = hass.config.units.temperature_unit
-    return ZWaveClimate(values, temp_unit)
+    if values.primary.command_class == const.COMMAND_CLASS_THERMOSTAT_SETPOINT:
+        return ZWaveClimateSingleSetpoint(values, temp_unit)
+    if values.primary.command_class == const.COMMAND_CLASS_THERMOSTAT_MODE:
+        return ZWaveClimateMultipleSetpoint(values, temp_unit)
+    return None
 
 
-class ZWaveClimate(ZWaveDeviceEntity, ClimateDevice):
+class ZWaveClimateBase(ZWaveDeviceEntity, ClimateDevice):
     """Representation of a Z-Wave Climate device."""
 
     def __init__(self, values, temp_unit):
@@ -188,18 +192,21 @@ def __init__(self, values, temp_unit):
                     self._zxt_120 = 1
         self.update_properties()
 
-    def _current_mode_setpoints(self):
-        current_mode = str(self.values.primary.data).lower()
-        setpoints_names = MODE_SETPOINT_MAPPINGS.get(current_mode, ())
-        return tuple(getattr(self.values, name, None) for name in setpoints_names)
+    def _mode(self) -> None:
+        """Return thermostat mode Z-Wave value."""
+        raise NotImplementedError()
+
+    def _current_mode_setpoints(self) -> Tuple:
+        """Return a tuple of current setpoint Z-Wave value(s)."""
+        raise NotImplementedError()
 
     @property
     def supported_features(self):
         """Return the list of supported features."""
         support = SUPPORT_TARGET_TEMPERATURE
-        if HVAC_MODE_HEAT_COOL in self._hvac_list:
+        if self._hvac_list and HVAC_MODE_HEAT_COOL in self._hvac_list:
             support |= SUPPORT_TARGET_TEMPERATURE_RANGE
-        if PRESET_AWAY in self._preset_list:
+        if self._preset_list and PRESET_AWAY in self._preset_list:
             support |= SUPPORT_TARGET_TEMPERATURE_RANGE
 
         if self.values.fan_mode:
@@ -237,13 +244,13 @@ def update_properties(self):
 
     def _update_operation_mode(self):
         """Update hvac and preset modes."""
-        if self.values.primary:
+        if self._mode():
             self._hvac_list = []
             self._hvac_mapping = {}
             self._preset_list = []
             self._preset_mapping = {}
 
-            mode_list = self.values.primary.data_items
+            mode_list = self._mode().data_items
             if mode_list:
                 for mode in mode_list:
                     ha_mode = HVAC_STATE_MAPPINGS.get(str(mode).lower())
@@ -271,7 +278,7 @@ def _update_operation_mode(self):
                 # Presets are supported
                 self._preset_list.append(PRESET_NONE)
 
-            current_mode = self.values.primary.data
+            current_mode = self._mode().data
             _LOGGER.debug("current_mode=%s", current_mode)
             _hvac_temp = next(
                 (
@@ -424,7 +431,7 @@ def hvac_mode(self):
 
         Need to be one of HVAC_MODE_*.
         """
-        if self.values.primary:
+        if self._mode():
             return self._hvac_mode
         return self._default_hvac_mode
 
@@ -434,7 +441,7 @@ def hvac_modes(self):
 
         Need to be a subset of HVAC_MODES.
         """
-        if self.values.primary:
+        if self._mode():
             return self._hvac_list
         return []
 
@@ -451,7 +458,7 @@ def is_aux_heat(self):
         """Return true if aux heater."""
         if not self._aux_heat:
             return None
-        if self.values.primary.data == AUX_HEAT_ZWAVE_MODE:
+        if self._mode().data == AUX_HEAT_ZWAVE_MODE:
             return True
         return False
 
@@ -461,7 +468,7 @@ def preset_mode(self):
 
         Need to be one of PRESET_*.
         """
-        if self.values.primary:
+        if self._mode():
             return self._preset_mode
         return PRESET_NONE
 
@@ -471,7 +478,7 @@ def preset_modes(self):
 
         Need to be a subset of PRESET_MODES.
         """
-        if self.values.primary:
+        if self._mode():
             return self._preset_list
         return []
 
@@ -520,19 +527,19 @@ def set_fan_mode(self, fan_mode):
     def set_hvac_mode(self, hvac_mode):
         """Set new target hvac mode."""
         _LOGGER.debug("Set hvac_mode to %s", hvac_mode)
-        if not self.values.primary:
+        if not self._mode():
             return
         operation_mode = self._hvac_mapping.get(hvac_mode)
         _LOGGER.debug("Set operation_mode to %s", operation_mode)
-        self.values.primary.data = operation_mode
+        self._mode().data = operation_mode
 
     def turn_aux_heat_on(self):
         """Turn auxillary heater on."""
         if not self._aux_heat:
             return
         operation_mode = AUX_HEAT_ZWAVE_MODE
         _LOGGER.debug("Aux heat on. Set operation mode to %s", operation_mode)
-        self.values.primary.data = operation_mode
+        self._mode().data = operation_mode
 
     def turn_aux_heat_off(self):
         """Turn auxillary heater off."""
@@ -543,23 +550,23 @@ def turn_aux_heat_off(self):
         else:
             operation_mode = self._hvac_mapping.get(HVAC_MODE_OFF)
         _LOGGER.debug("Aux heat off. Set operation mode to %s", operation_mode)
-        self.values.primary.data = operation_mode
+        self._mode().data = operation_mode
 
     def set_preset_mode(self, preset_mode):
         """Set new target preset mode."""
         _LOGGER.debug("Set preset_mode to %s", preset_mode)
-        if not self.values.primary:
+        if not self._mode():
             return
         if preset_mode == PRESET_NONE:
             # Activate the current hvac mode
             self._update_operation_mode()
             operation_mode = self._hvac_mapping.get(self.hvac_mode)
             _LOGGER.debug("Set operation_mode to %s", operation_mode)
-            self.values.primary.data = operation_mode
+            self._mode().data = operation_mode
         else:
             operation_mode = self._preset_mapping.get(preset_mode, preset_mode)
             _LOGGER.debug("Set operation_mode to %s", operation_mode)
-            self.values.primary.data = operation_mode
+            self._mode().data = operation_mode
 
     def set_swing_mode(self, swing_mode):
         """Set new target swing mode."""
@@ -575,3 +582,37 @@ def device_state_attributes(self):
         if self._fan_action:
             data[ATTR_FAN_ACTION] = self._fan_action
         return data
+
+
+class ZWaveClimateSingleSetpoint(ZWaveClimateBase):
+    """Representation of a single setpoint Z-Wave thermostat device."""
+
+    def __init__(self, values, temp_unit):
+        """Initialize the Z-Wave climate device."""
+        ZWaveClimateBase.__init__(self, values, temp_unit)
+
+    def _mode(self) -> None:
+        """Return thermostat mode Z-Wave value."""
+        return self.values.mode
+
+    def _current_mode_setpoints(self) -> Tuple:
+        """Return a tuple of current setpoint Z-Wave value(s)."""
+        return (self.values.primary,)
+
+
+class ZWaveClimateMultipleSetpoint(ZWaveClimateBase):
+    """Representation of a multiple setpoint Z-Wave thermostat device."""
+
+    def __init__(self, values, temp_unit):
+        """Initialize the Z-Wave climate device."""
+        ZWaveClimateBase.__init__(self, values, temp_unit)
+
+    def _mode(self) -> None:
+        """Return thermostat mode Z-Wave value."""
+        return self.values.primary
+
+    def _current_mode_setpoints(self) -> Tuple:
+        """Return a tuple of current setpoint Z-Wave value(s)."""
+        current_mode = str(self.values.primary.data).lower()
+        setpoints_names = MODE_SETPOINT_MAPPINGS.get(current_mode, ())
+        return tuple(getattr(self.values, name, None) for name in setpoints_names)

homeassistant/components/zwave/discovery_schemas.py

@@ -48,11 +48,60 @@
         ),
     },
     {
-        const.DISC_COMPONENT: "climate",
+        const.DISC_COMPONENT: "climate",  # thermostat without COMMAND_CLASS_THERMOSTAT_MODE
         const.DISC_GENERIC_DEVICE_CLASS: [
             const.GENERIC_TYPE_THERMOSTAT,
             const.GENERIC_TYPE_SENSOR_MULTILEVEL,
         ],
+        const.DISC_SPECIFIC_DEVICE_CLASS: [
+            const.SPECIFIC_TYPE_THERMOSTAT_HEATING,
+            const.SPECIFIC_TYPE_SETPOINT_THERMOSTAT,
+        ],
+        const.DISC_VALUES: dict(
+            DEFAULT_VALUES_SCHEMA,
+            **{
+                const.DISC_PRIMARY: {
+                    const.DISC_COMMAND_CLASS: [const.COMMAND_CLASS_THERMOSTAT_SETPOINT]
+                },
+                "temperature": {
+                    const.DISC_COMMAND_CLASS: [const.COMMAND_CLASS_SENSOR_MULTILEVEL],
+                    const.DISC_INDEX: [const.INDEX_SENSOR_MULTILEVEL_TEMPERATURE],
+                    const.DISC_OPTIONAL: True,
+                },
+                "fan_mode": {
+                    const.DISC_COMMAND_CLASS: [const.COMMAND_CLASS_THERMOSTAT_FAN_MODE],
+                    const.DISC_OPTIONAL: True,
+                },
+                "operating_state": {
+                    const.DISC_COMMAND_CLASS: [
+                        const.COMMAND_CLASS_THERMOSTAT_OPERATING_STATE
+                    ],
+                    const.DISC_OPTIONAL: True,
+                },
+                "fan_action": {
+                    const.DISC_COMMAND_CLASS: [
+                        const.COMMAND_CLASS_THERMOSTAT_FAN_ACTION
+                    ],
+                    const.DISC_OPTIONAL: True,
+                },
+                "mode": {
+                    const.DISC_COMMAND_CLASS: [const.COMMAND_CLASS_THERMOSTAT_MODE],
+                    const.DISC_OPTIONAL: True,
+                },
+            },
+        ),
+    },
+    {
+        const.DISC_COMPONENT: "climate",  # thermostat with COMMAND_CLASS_THERMOSTAT_MODE
+        const.DISC_GENERIC_DEVICE_CLASS: [
+            const.GENERIC_TYPE_THERMOSTAT,
+            const.GENERIC_TYPE_SENSOR_MULTILEVEL,
+        ],
+        const.DISC_SPECIFIC_DEVICE_CLASS: [
+            const.SPECIFIC_TYPE_THERMOSTAT_GENERAL,
+            const.SPECIFIC_TYPE_THERMOSTAT_GENERAL_V2,
+            const.SPECIFIC_TYPE_SETBACK_THERMOSTAT,
+        ],
         const.DISC_VALUES: dict(
             DEFAULT_VALUES_SCHEMA,
             **{