Support KNX climate entity configuration from UI (home-assistant#154162)

Co-authored-by: Copilot <[email protected]>

Author: farmio

homeassistant/components/knx/climate.py

@@ -160,6 +160,7 @@ class FanZeroMode(StrEnum):
 
 SUPPORTED_PLATFORMS_UI: Final = {
     Platform.BINARY_SENSOR,
+    Platform.CLIMATE,
     Platform.COVER,
     Platform.LIGHT,
     Platform.SWITCH,
@@ -193,3 +194,23 @@ class CoverConf:
     INVERT_UPDOWN: Final = "invert_updown"
     INVERT_POSITION: Final = "invert_position"
     INVERT_ANGLE: Final = "invert_angle"
+
+
+class ClimateConf:
+    """Common config keys for climate."""
+
+    MIN_TEMP: Final = "min_temp"
+    MAX_TEMP: Final = "max_temp"
+    TEMPERATURE_STEP: Final = "temperature_step"
+    SETPOINT_SHIFT_MAX: Final = "setpoint_shift_max"
+    SETPOINT_SHIFT_MIN: Final = "setpoint_shift_min"
+
+    ON_OFF_INVERT: Final = "on_off_invert"
+
+    OPERATION_MODES: Final = "operation_modes"
+    CONTROLLER_MODES: Final = "controller_modes"
+    DEFAULT_CONTROLLER_MODE: Final = "default_controller_mode"
+
+    FAN_MAX_STEP: Final = "fan_max_step"
+    FAN_SPEED_MODE: Final = "fan_speed_mode"
+    FAN_ZERO_MODE: Final = "fan_zero_mode"

homeassistant/components/knx/const.py

@@ -56,6 +56,7 @@
     CONF_STATE_ADDRESS,
     CONF_SYNC_STATE,
     KNX_ADDRESS,
+    ClimateConf,
     ColorTempModes,
     CoverConf,
     FanZeroMode,
@@ -306,10 +307,7 @@ class ClimateSchema(KNXPlatformSchema):
     CONF_SETPOINT_SHIFT_ADDRESS = "setpoint_shift_address"
     CONF_SETPOINT_SHIFT_STATE_ADDRESS = "setpoint_shift_state_address"
     CONF_SETPOINT_SHIFT_MODE = "setpoint_shift_mode"
-    CONF_SETPOINT_SHIFT_MAX = "setpoint_shift_max"
-    CONF_SETPOINT_SHIFT_MIN = "setpoint_shift_min"
     CONF_TEMPERATURE_ADDRESS = "temperature_address"
-    CONF_TEMPERATURE_STEP = "temperature_step"
     CONF_TARGET_TEMPERATURE_ADDRESS = "target_temperature_address"
     CONF_TARGET_TEMPERATURE_STATE_ADDRESS = "target_temperature_state_address"
     CONF_OPERATION_MODE_ADDRESS = "operation_mode_address"
@@ -327,19 +325,10 @@ class ClimateSchema(KNXPlatformSchema):
     CONF_OPERATION_MODE_NIGHT_ADDRESS = "operation_mode_night_address"
     CONF_OPERATION_MODE_COMFORT_ADDRESS = "operation_mode_comfort_address"
     CONF_OPERATION_MODE_STANDBY_ADDRESS = "operation_mode_standby_address"
-    CONF_OPERATION_MODES = "operation_modes"
-    CONF_CONTROLLER_MODES = "controller_modes"
-    CONF_DEFAULT_CONTROLLER_MODE = "default_controller_mode"
     CONF_ON_OFF_ADDRESS = "on_off_address"
     CONF_ON_OFF_STATE_ADDRESS = "on_off_state_address"
-    CONF_ON_OFF_INVERT = "on_off_invert"
-    CONF_MIN_TEMP = "min_temp"
-    CONF_MAX_TEMP = "max_temp"
     CONF_FAN_SPEED_ADDRESS = "fan_speed_address"
     CONF_FAN_SPEED_STATE_ADDRESS = "fan_speed_state_address"
-    CONF_FAN_MAX_STEP = "fan_max_step"
-    CONF_FAN_SPEED_MODE = "fan_speed_mode"
-    CONF_FAN_ZERO_MODE = "fan_zero_mode"
     CONF_HUMIDITY_STATE_ADDRESS = "humidity_state_address"
     CONF_SWING_ADDRESS = "swing_address"
     CONF_SWING_STATE_ADDRESS = "swing_state_address"
@@ -359,13 +348,13 @@ class ClimateSchema(KNXPlatformSchema):
             {
                 vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
                 vol.Optional(
-                    CONF_SETPOINT_SHIFT_MAX, default=DEFAULT_SETPOINT_SHIFT_MAX
+                    ClimateConf.SETPOINT_SHIFT_MAX, default=DEFAULT_SETPOINT_SHIFT_MAX
                 ): vol.All(int, vol.Range(min=0, max=32)),
                 vol.Optional(
-                    CONF_SETPOINT_SHIFT_MIN, default=DEFAULT_SETPOINT_SHIFT_MIN
+                    ClimateConf.SETPOINT_SHIFT_MIN, default=DEFAULT_SETPOINT_SHIFT_MIN
                 ): vol.All(int, vol.Range(min=-32, max=0)),
                 vol.Optional(
-                    CONF_TEMPERATURE_STEP, default=DEFAULT_TEMPERATURE_STEP
+                    ClimateConf.TEMPERATURE_STEP, default=DEFAULT_TEMPERATURE_STEP
                 ): vol.All(float, vol.Range(min=0, max=2)),
                 vol.Required(CONF_TEMPERATURE_ADDRESS): ga_list_validator,
                 vol.Required(CONF_TARGET_TEMPERATURE_STATE_ADDRESS): ga_list_validator,
@@ -408,29 +397,29 @@ class ClimateSchema(KNXPlatformSchema):
                 vol.Optional(CONF_ON_OFF_ADDRESS): ga_list_validator,
                 vol.Optional(CONF_ON_OFF_STATE_ADDRESS): ga_list_validator,
                 vol.Optional(
-                    CONF_ON_OFF_INVERT, default=DEFAULT_ON_OFF_INVERT
+                    ClimateConf.ON_OFF_INVERT, default=DEFAULT_ON_OFF_INVERT
                 ): cv.boolean,
-                vol.Optional(CONF_OPERATION_MODES): vol.All(
+                vol.Optional(ClimateConf.OPERATION_MODES): vol.All(
                     cv.ensure_list,
                     [backwards_compatible_xknx_climate_enum_member(HVACOperationMode)],
                 ),
-                vol.Optional(CONF_CONTROLLER_MODES): vol.All(
+                vol.Optional(ClimateConf.CONTROLLER_MODES): vol.All(
                     cv.ensure_list,
                     [backwards_compatible_xknx_climate_enum_member(HVACControllerMode)],
                 ),
                 vol.Optional(
-                    CONF_DEFAULT_CONTROLLER_MODE, default=HVACMode.HEAT
+                    ClimateConf.DEFAULT_CONTROLLER_MODE, default=HVACMode.HEAT
                 ): vol.Coerce(HVACMode),
-                vol.Optional(CONF_MIN_TEMP): vol.Coerce(float),
-                vol.Optional(CONF_MAX_TEMP): vol.Coerce(float),
+                vol.Optional(ClimateConf.MIN_TEMP): vol.Coerce(float),
+                vol.Optional(ClimateConf.MAX_TEMP): vol.Coerce(float),
                 vol.Optional(CONF_ENTITY_CATEGORY): ENTITY_CATEGORIES_SCHEMA,
                 vol.Optional(CONF_FAN_SPEED_ADDRESS): ga_list_validator,
                 vol.Optional(CONF_FAN_SPEED_STATE_ADDRESS): ga_list_validator,
-                vol.Optional(CONF_FAN_MAX_STEP, default=3): cv.byte,
+                vol.Optional(ClimateConf.FAN_MAX_STEP, default=3): cv.byte,
                 vol.Optional(
-                    CONF_FAN_SPEED_MODE, default=DEFAULT_FAN_SPEED_MODE
+                    ClimateConf.FAN_SPEED_MODE, default=DEFAULT_FAN_SPEED_MODE
                 ): vol.All(vol.Upper, cv.enum(FanSpeedMode)),
-                vol.Optional(CONF_FAN_ZERO_MODE, default=FAN_OFF): vol.Coerce(
+                vol.Optional(ClimateConf.FAN_ZERO_MODE, default=FAN_OFF): vol.Coerce(
                     FanZeroMode
                 ),
                 vol.Optional(CONF_SWING_ADDRESS): ga_list_validator,

homeassistant/components/knx/schema.py

@@ -14,6 +14,28 @@
 CONF_GA_SENSOR: Final = "ga_sensor"
 CONF_GA_SWITCH: Final = "ga_switch"
 
+# Climate
+CONF_GA_TEMPERATURE_CURRENT: Final = "ga_temperature_current"
+CONF_GA_HUMIDITY_CURRENT: Final = "ga_humidity_current"
+CONF_TARGET_TEMPERATURE: Final = "target_temperature"
+CONF_GA_TEMPERATURE_TARGET: Final = "ga_temperature_target"
+CONF_GA_SETPOINT_SHIFT: Final = "ga_setpoint_shift"
+CONF_GA_ACTIVE: Final = "ga_active"
+CONF_GA_VALVE: Final = "ga_valve"
+CONF_GA_OPERATION_MODE: Final = "ga_operation_mode"
+CONF_IGNORE_AUTO_MODE: Final = "ignore_auto_mode"
+CONF_GA_OP_MODE_COMFORT: Final = "ga_operation_mode_comfort"
+CONF_GA_OP_MODE_ECO: Final = "ga_operation_mode_economy"
+CONF_GA_OP_MODE_STANDBY: Final = "ga_operation_mode_standby"
+CONF_GA_OP_MODE_PROTECTION: Final = "ga_operation_mode_protection"
+CONF_GA_HEAT_COOL: Final = "ga_heat_cool"
+CONF_GA_ON_OFF: Final = "ga_on_off"
+CONF_GA_CONTROLLER_MODE: Final = "ga_controller_mode"
+CONF_GA_CONTROLLER_STATUS: Final = "ga_controller_status"
+CONF_GA_FAN_SPEED: Final = "ga_fan_speed"
+CONF_GA_FAN_SWING: Final = "ga_fan_swing"
+CONF_GA_FAN_SWING_HORIZONTAL: Final = "ga_fan_swing_horizontal"
+
 # Cover
 CONF_GA_UP_DOWN: Final = "ga_up_down"
 CONF_GA_STOP: Final = "ga_stop"

homeassistant/components/knx/storage/const.py

@@ -4,6 +4,7 @@
 
 import voluptuous as vol
 
+from homeassistant.components.climate import HVACMode
 from homeassistant.const import (
     CONF_ENTITY_CATEGORY,
     CONF_ENTITY_ID,
@@ -24,8 +25,10 @@
     CONF_SYNC_STATE,
     DOMAIN,
     SUPPORTED_PLATFORMS_UI,
+    ClimateConf,
     ColorTempModes,
     CoverConf,
+    FanZeroMode,
 )
 from .const import (
     CONF_COLOR,
@@ -34,27 +37,47 @@
     CONF_DATA,
     CONF_DEVICE_INFO,
     CONF_ENTITY,
+    CONF_GA_ACTIVE,
     CONF_GA_ANGLE,
     CONF_GA_BLUE_BRIGHTNESS,
     CONF_GA_BLUE_SWITCH,
     CONF_GA_BRIGHTNESS,
     CONF_GA_COLOR,
     CONF_GA_COLOR_TEMP,
+    CONF_GA_CONTROLLER_MODE,
+    CONF_GA_CONTROLLER_STATUS,
+    CONF_GA_FAN_SPEED,
+    CONF_GA_FAN_SWING,
+    CONF_GA_FAN_SWING_HORIZONTAL,
     CONF_GA_GREEN_BRIGHTNESS,
     CONF_GA_GREEN_SWITCH,
+    CONF_GA_HEAT_COOL,
     CONF_GA_HUE,
+    CONF_GA_HUMIDITY_CURRENT,
+    CONF_GA_ON_OFF,
+    CONF_GA_OP_MODE_COMFORT,
+    CONF_GA_OP_MODE_ECO,
+    CONF_GA_OP_MODE_PROTECTION,
+    CONF_GA_OP_MODE_STANDBY,
+    CONF_GA_OPERATION_MODE,
     CONF_GA_POSITION_SET,
     CONF_GA_POSITION_STATE,
     CONF_GA_RED_BRIGHTNESS,
     CONF_GA_RED_SWITCH,
     CONF_GA_SATURATION,
     CONF_GA_SENSOR,
+    CONF_GA_SETPOINT_SHIFT,
     CONF_GA_STEP,
     CONF_GA_STOP,
     CONF_GA_SWITCH,
+    CONF_GA_TEMPERATURE_CURRENT,
+    CONF_GA_TEMPERATURE_TARGET,
     CONF_GA_UP_DOWN,
+    CONF_GA_VALVE,
     CONF_GA_WHITE_BRIGHTNESS,
     CONF_GA_WHITE_SWITCH,
+    CONF_IGNORE_AUTO_MODE,
+    CONF_TARGET_TEMPERATURE,
 )
 from .knx_selector import (
     AllSerializeFirst,
@@ -313,8 +336,151 @@ class LightColorMode(StrEnum):
     },
 )
 
+
+@unique
+class ConfSetpointShiftMode(StrEnum):
+    """Enum for setpoint shift mode."""
+
+    COUNT = "6.010"
+    FLOAT = "9.002"
+
+
+@unique
+class ConfClimateFanSpeedMode(StrEnum):
+    """Enum for climate fan speed mode."""
+
+    PERCENTAGE = "5.001"
+    STEPS = "5.010"
+
+
+CLIMATE_KNX_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_GA_TEMPERATURE_CURRENT): GASelector(
+            write=False, state_required=True, valid_dpt="9.001"
+        ),
+        vol.Optional(CONF_GA_HUMIDITY_CURRENT): GASelector(
+            write=False, valid_dpt="9.002"
+        ),
+        vol.Required(CONF_TARGET_TEMPERATURE): GroupSelect(
+            GroupSelectOption(
+                translation_key="group_direct_temp",
+                schema={
+                    vol.Required(CONF_GA_TEMPERATURE_TARGET): GASelector(
+                        write_required=True, valid_dpt="9.001"
+                    ),
+                    vol.Required(
+                        ClimateConf.MIN_TEMP, default=7
+                    ): selector.NumberSelector(
+                        selector.NumberSelectorConfig(
+                            min=-20, max=80, step=1, unit_of_measurement="°C"
+                        )
+                    ),
+                    vol.Required(
+                        ClimateConf.MAX_TEMP, default=28
+                    ): selector.NumberSelector(
+                        selector.NumberSelectorConfig(
+                            min=0, max=100, step=1, unit_of_measurement="°C"
+                        )
+                    ),
+                    vol.Required(
+                        ClimateConf.TEMPERATURE_STEP, default=0.1
+                    ): selector.NumberSelector(
+                        selector.NumberSelectorConfig(
+                            min=0.1, max=2, step=0.1, unit_of_measurement="K"
+                        ),
+                    ),
+                },
+            ),
+            GroupSelectOption(
+                translation_key="group_setpoint_shift",
+                schema={
+                    vol.Required(CONF_GA_TEMPERATURE_TARGET): GASelector(
+                        write=False, state_required=True, valid_dpt="9.001"
+                    ),
+                    vol.Required(CONF_GA_SETPOINT_SHIFT): GASelector(
+                        write_required=True,
+                        state_required=True,
+                        dpt=ConfSetpointShiftMode,
+                    ),
+                    vol.Required(
+                        ClimateConf.SETPOINT_SHIFT_MIN, default=-6
+                    ): selector.NumberSelector(
+                        selector.NumberSelectorConfig(
+                            min=-32, max=0, step=1, unit_of_measurement="K"
+                        )
+                    ),
+                    vol.Required(
+                        ClimateConf.SETPOINT_SHIFT_MAX, default=6
+                    ): selector.NumberSelector(
+                        selector.NumberSelectorConfig(
+                            min=0, max=32, step=1, unit_of_measurement="K"
+                        )
+                    ),
+                    vol.Required(
+                        ClimateConf.TEMPERATURE_STEP, default=0.1
+                    ): selector.NumberSelector(
+                        selector.NumberSelectorConfig(
+                            min=0.1, max=2, step=0.1, unit_of_measurement="K"
+                        ),
+                    ),
+                },
+            ),
+            collapsible=False,
+        ),
+        "section_activity": KNXSectionFlat(collapsible=True),
+        vol.Optional(CONF_GA_ACTIVE): GASelector(write=False, valid_dpt="1"),
+        vol.Optional(CONF_GA_VALVE): GASelector(write=False, valid_dpt="5.001"),
+        "section_operation_mode": KNXSectionFlat(collapsible=True),
+        vol.Optional(CONF_GA_OPERATION_MODE): GASelector(valid_dpt="20.102"),
+        vol.Optional(CONF_IGNORE_AUTO_MODE): selector.BooleanSelector(),
+        "section_operation_mode_individual": KNXSectionFlat(collapsible=True),
+        vol.Optional(CONF_GA_OP_MODE_COMFORT): GASelector(state=False, valid_dpt="1"),
+        vol.Optional(CONF_GA_OP_MODE_ECO): GASelector(state=False, valid_dpt="1"),
+        vol.Optional(CONF_GA_OP_MODE_STANDBY): GASelector(state=False, valid_dpt="1"),
+        vol.Optional(CONF_GA_OP_MODE_PROTECTION): GASelector(
+            state=False, valid_dpt="1"
+        ),
+        "section_heat_cool": KNXSectionFlat(collapsible=True),
+        vol.Optional(CONF_GA_HEAT_COOL): GASelector(valid_dpt="1.100"),
+        "section_on_off": KNXSectionFlat(collapsible=True),
+        vol.Optional(CONF_GA_ON_OFF): GASelector(valid_dpt="1"),
+        vol.Optional(ClimateConf.ON_OFF_INVERT): selector.BooleanSelector(),
+        "section_controller_mode": KNXSectionFlat(collapsible=True),
+        vol.Optional(CONF_GA_CONTROLLER_MODE): GASelector(valid_dpt="20.105"),
+        vol.Optional(CONF_GA_CONTROLLER_STATUS): GASelector(write=False),
+        vol.Required(
+            ClimateConf.DEFAULT_CONTROLLER_MODE, default=HVACMode.HEAT
+        ): selector.SelectSelector(
+            selector.SelectSelectorConfig(
+                options=list(HVACMode),
+                translation_key="component.climate.selector.hvac_mode",
+            )
+        ),
+        "section_fan": KNXSectionFlat(collapsible=True),
+        vol.Optional(CONF_GA_FAN_SPEED): GASelector(dpt=ConfClimateFanSpeedMode),
+        vol.Required(ClimateConf.FAN_MAX_STEP, default=3): AllSerializeFirst(
+            selector.NumberSelector(
+                selector.NumberSelectorConfig(min=1, max=100, step=1)
+            ),
+            vol.Coerce(int),
+        ),
+        vol.Required(
+            ClimateConf.FAN_ZERO_MODE, default=FanZeroMode.OFF
+        ): selector.SelectSelector(
+            selector.SelectSelectorConfig(
+                options=list(FanZeroMode),
+                translation_key="component.knx.config_panel.entities.create.climate.knx.fan_zero_mode",
+            )
+        ),
+        vol.Optional(CONF_GA_FAN_SWING): GASelector(valid_dpt="1"),
+        vol.Optional(CONF_GA_FAN_SWING_HORIZONTAL): GASelector(valid_dpt="1"),
+        vol.Optional(CONF_SYNC_STATE, default=True): SyncStateSelector(),
+    },
+)
+
 KNX_SCHEMA_FOR_PLATFORM = {
     Platform.BINARY_SENSOR: BINARY_SENSOR_KNX_SCHEMA,
+    Platform.CLIMATE: CLIMATE_KNX_SCHEMA,
     Platform.COVER: COVER_KNX_SCHEMA,
     Platform.LIGHT: LIGHT_KNX_SCHEMA,
     Platform.SWITCH: SWITCH_KNX_SCHEMA,