Add Homee climate platform (#141616)

* Add climate platform

* Add climate tests

* Add service tests

* Add snapshot test

* Code optimazitions 1

* Add test for current preset mode.

* code optimization 2

* code optimization 3

* small tweaks

* another small tweak

* Last minute changes

* Update tests/components/homee/test_climate.py

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* fix review comments

* typo

* more review fixes.

* maybe final review fixes.

---------

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
This commit is contained in:
Markus Adrario 2025-04-01 18:08:36 +02:00 committed by GitHub
parent 935db1308f
commit 426e9846d9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
11 changed files with 1124 additions and 0 deletions

View File

@ -17,6 +17,7 @@ _LOGGER = logging.getLogger(__name__)
PLATFORMS = [
Platform.BINARY_SENSOR,
Platform.BUTTON,
Platform.CLIMATE,
Platform.COVER,
Platform.LIGHT,
Platform.LOCK,

View File

@ -0,0 +1,200 @@
"""The Homee climate platform."""
from typing import Any
from pyHomee.const import AttributeType, NodeProfile
from pyHomee.model import HomeeNode
from homeassistant.components.climate import (
ATTR_TEMPERATURE,
PRESET_BOOST,
PRESET_ECO,
PRESET_NONE,
ClimateEntity,
ClimateEntityFeature,
HVACAction,
HVACMode,
)
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
from . import HomeeConfigEntry
from .const import CLIMATE_PROFILES, DOMAIN, HOMEE_UNIT_TO_HA_UNIT, PRESET_MANUAL
from .entity import HomeeNodeEntity
PARALLEL_UPDATES = 0
ROOM_THERMOSTATS = {
NodeProfile.ROOM_THERMOSTAT,
NodeProfile.ROOM_THERMOSTAT_WITH_HUMIDITY_SENSOR,
NodeProfile.WIFI_ROOM_THERMOSTAT,
}
async def async_setup_entry(
hass: HomeAssistant,
config_entry: HomeeConfigEntry,
async_add_devices: AddConfigEntryEntitiesCallback,
) -> None:
"""Add the Homee platform for the climate component."""
async_add_devices(
HomeeClimate(node, config_entry)
for node in config_entry.runtime_data.nodes
if node.profile in CLIMATE_PROFILES
)
class HomeeClimate(HomeeNodeEntity, ClimateEntity):
"""Representation of a Homee climate entity."""
_attr_name = None
_attr_translation_key = DOMAIN
def __init__(self, node: HomeeNode, entry: HomeeConfigEntry) -> None:
"""Initialize a Homee climate entity."""
super().__init__(node, entry)
(
self._attr_supported_features,
self._attr_hvac_modes,
self._attr_preset_modes,
) = get_climate_features(self._node)
self._target_temp = self._node.get_attribute_by_type(
AttributeType.TARGET_TEMPERATURE
)
assert self._target_temp is not None
self._attr_temperature_unit = str(HOMEE_UNIT_TO_HA_UNIT[self._target_temp.unit])
self._attr_target_temperature_step = self._target_temp.step_value
self._attr_unique_id = f"{self._attr_unique_id}-{self._target_temp.id}"
self._heating_mode = self._node.get_attribute_by_type(
AttributeType.HEATING_MODE
)
self._temperature = self._node.get_attribute_by_type(AttributeType.TEMPERATURE)
self._valve_position = self._node.get_attribute_by_type(
AttributeType.CURRENT_VALVE_POSITION
)
@property
def hvac_mode(self) -> HVACMode:
"""Return the hvac operation mode."""
if ClimateEntityFeature.TURN_OFF in self.supported_features and (
self._heating_mode is not None
):
if self._heating_mode.current_value == 0:
return HVACMode.OFF
return HVACMode.HEAT
@property
def hvac_action(self) -> HVACAction:
"""Return the hvac action."""
if self._heating_mode is not None and self._heating_mode.current_value == 0:
return HVACAction.OFF
if (
self._valve_position is not None and self._valve_position.current_value == 0
) or (
self._temperature is not None
and self._temperature.current_value >= self.target_temperature
):
return HVACAction.IDLE
return HVACAction.HEATING
@property
def preset_mode(self) -> str:
"""Return the present preset mode."""
if (
ClimateEntityFeature.PRESET_MODE in self.supported_features
and self._heating_mode is not None
and self._heating_mode.current_value > 0
):
assert self._attr_preset_modes is not None
return self._attr_preset_modes[int(self._heating_mode.current_value) - 1]
return PRESET_NONE
@property
def current_temperature(self) -> float | None:
"""Return the current temperature."""
if self._temperature is not None:
return self._temperature.current_value
return None
@property
def target_temperature(self) -> float:
"""Return the temperature we try to reach."""
assert self._target_temp is not None
return self._target_temp.current_value
@property
def min_temp(self) -> float:
"""Return the lowest settable target temperature."""
assert self._target_temp is not None
return self._target_temp.minimum
@property
def max_temp(self) -> float:
"""Return the lowest settable target temperature."""
assert self._target_temp is not None
return self._target_temp.maximum
async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
"""Set new target hvac mode."""
# Currently only HEAT and OFF are supported.
assert self._heating_mode is not None
await self.async_set_homee_value(
self._heating_mode, float(hvac_mode == HVACMode.HEAT)
)
async def async_set_preset_mode(self, preset_mode: str) -> None:
"""Set new target preset mode."""
assert self._heating_mode is not None and self._attr_preset_modes is not None
await self.async_set_homee_value(
self._heating_mode, self._attr_preset_modes.index(preset_mode) + 1
)
async def async_set_temperature(self, **kwargs: Any) -> None:
"""Set new target temperature."""
assert self._target_temp is not None
if ATTR_TEMPERATURE in kwargs:
await self.async_set_homee_value(
self._target_temp, kwargs[ATTR_TEMPERATURE]
)
async def async_turn_on(self) -> None:
"""Turn the entity on."""
assert self._heating_mode is not None
await self.async_set_homee_value(self._heating_mode, 1)
async def async_turn_off(self) -> None:
"""Turn the entity on."""
assert self._heating_mode is not None
await self.async_set_homee_value(self._heating_mode, 0)
def get_climate_features(
node: HomeeNode,
) -> tuple[ClimateEntityFeature, list[HVACMode], list[str] | None]:
"""Determine supported climate features of a node based on the available attributes."""
features = ClimateEntityFeature.TARGET_TEMPERATURE
hvac_modes = [HVACMode.HEAT]
preset_modes: list[str] = []
if (
attribute := node.get_attribute_by_type(AttributeType.HEATING_MODE)
) is not None:
features |= ClimateEntityFeature.TURN_ON | ClimateEntityFeature.TURN_OFF
hvac_modes.append(HVACMode.OFF)
if attribute.maximum > 1:
# Node supports more modes than off and heating.
features |= ClimateEntityFeature.PRESET_MODE
preset_modes.extend([PRESET_ECO, PRESET_BOOST, PRESET_MANUAL])
if len(preset_modes) > 0:
preset_modes.insert(0, PRESET_NONE)
return (features, hvac_modes, preset_modes if len(preset_modes) > 0 else None)

View File

@ -95,3 +95,6 @@ LIGHT_PROFILES = [
NodeProfile.WIFI_DIMMABLE_LIGHT,
NodeProfile.WIFI_ON_OFF_DIMMABLE_METERING_SWITCH,
]
# Climate Presets
PRESET_MANUAL = "manual"

View File

@ -1,5 +1,16 @@
{
"entity": {
"climate": {
"homee": {
"state_attributes": {
"preset_mode": {
"state": {
"manual": "mdi:hand-back-left"
}
}
}
}
},
"sensor": {
"brightness": {
"default": "mdi:brightness-5"

View File

@ -131,6 +131,17 @@
"name": "Ventilate"
}
},
"climate": {
"homee": {
"state_attributes": {
"preset_mode": {
"state": {
"manual": "Manual"
}
}
}
}
},
"light": {
"light_instance": {
"name": "Light {instance}"

View File

@ -0,0 +1,52 @@
{
"id": 1,
"name": "Test Thermostat 1",
"profile": 3003,
"image": "default",
"favorite": 0,
"order": 32,
"protocol": 1,
"routing": 0,
"state": 1,
"state_changed": 1712840187,
"added": 1655274291,
"history": 1,
"cube_type": 1,
"note": "",
"services": 7,
"phonetic_name": "",
"owner": 2,
"security": 0,
"attributes": [
{
"id": 1,
"node_id": 1,
"instance": 0,
"minimum": 12,
"maximum": 28,
"current_value": 20.0,
"target_value": 13.0,
"last_value": 12.0,
"unit": "°C",
"step_value": 0.1,
"editable": 1,
"type": 6,
"state": 2,
"last_changed": 1713695529,
"changed_by": 3,
"changed_by_id": 0,
"based_on": 1,
"data": "",
"name": "",
"options": {
"automations": ["step"],
"history": {
"day": 35,
"week": 5,
"month": 1,
"stepped": true
}
}
}
]
}

View File

@ -0,0 +1,77 @@
{
"id": 2,
"name": "Test Thermostat 2",
"profile": 3003,
"image": "default",
"favorite": 0,
"order": 32,
"protocol": 1,
"routing": 0,
"state": 1,
"state_changed": 1712840187,
"added": 1655274291,
"history": 1,
"cube_type": 1,
"note": "",
"services": 7,
"phonetic_name": "",
"owner": 2,
"security": 0,
"attributes": [
{
"id": 1,
"node_id": 2,
"instance": 0,
"minimum": 15,
"maximum": 30,
"current_value": 22.0,
"target_value": 13.0,
"last_value": 12.0,
"unit": "°C",
"step_value": 0.1,
"editable": 1,
"type": 6,
"state": 2,
"last_changed": 1713695529,
"changed_by": 3,
"changed_by_id": 0,
"based_on": 1,
"data": "",
"name": "",
"options": {
"automations": ["step"],
"history": {
"day": 35,
"week": 5,
"month": 1,
"stepped": true
}
}
},
{
"id": 2,
"node_id": 2,
"instance": 0,
"minimum": -50,
"maximum": 125,
"current_value": 19.55,
"target_value": 19.55,
"last_value": 21.07,
"unit": "°C",
"step_value": 0.1,
"editable": 0,
"type": 5,
"state": 1,
"last_changed": 1713695528,
"changed_by": 1,
"changed_by_id": 0,
"based_on": 1,
"data": "",
"name": "",
"options": {
"observed_by": [240],
"history": { "day": 1, "week": 26, "month": 6 }
}
}
]
}

View File

@ -0,0 +1,127 @@
{
"id": 3,
"name": "Test Thermostat 3",
"profile": 3006,
"image": "default",
"favorite": 0,
"order": 32,
"protocol": 1,
"routing": 0,
"state": 1,
"state_changed": 1712840187,
"added": 1655274291,
"history": 1,
"cube_type": 1,
"note": "",
"services": 7,
"phonetic_name": "",
"owner": 2,
"security": 0,
"attributes": [
{
"id": 1,
"node_id": 3,
"instance": 0,
"minimum": 14,
"maximum": 25,
"current_value": 24.0,
"target_value": 13.0,
"last_value": 12.0,
"unit": "°C",
"step_value": 0.1,
"editable": 1,
"type": 6,
"state": 2,
"last_changed": 1713695529,
"changed_by": 3,
"changed_by_id": 0,
"based_on": 1,
"data": "",
"name": "",
"options": {
"automations": ["step"],
"history": {
"day": 35,
"week": 5,
"month": 1,
"stepped": true
}
}
},
{
"id": 2,
"node_id": 3,
"instance": 0,
"minimum": -50,
"maximum": 125,
"current_value": 19.55,
"target_value": 19.55,
"last_value": 21.07,
"unit": "°C",
"step_value": 0.1,
"editable": 0,
"type": 5,
"state": 1,
"last_changed": 1713695528,
"changed_by": 1,
"changed_by_id": 0,
"based_on": 1,
"data": "",
"name": "",
"options": {
"observed_by": [240],
"history": { "day": 1, "week": 26, "month": 6 }
}
},
{
"id": 3,
"node_id": 3,
"instance": 0,
"minimum": 0,
"maximum": 1,
"current_value": 1.0,
"target_value": 1.0,
"last_value": 1.0,
"unit": "",
"step_value": 1.0,
"editable": 1,
"type": 258,
"state": 1,
"last_changed": 1711796635,
"changed_by": 1,
"changed_by_id": 0,
"based_on": 1,
"data": "",
"name": ""
},
{
"id": 4,
"node_id": 3,
"instance": 0,
"minimum": 0,
"maximum": 100,
"current_value": 70.0,
"target_value": 0.0,
"last_value": 0.0,
"unit": "%",
"step_value": 1.0,
"editable": 0,
"type": 18,
"state": 1,
"last_changed": 1711796633,
"changed_by": 1,
"changed_by_id": 0,
"based_on": 1,
"data": "",
"name": "",
"options": {
"automations": ["step"],
"history": {
"day": 1,
"week": 26,
"month": 6
}
}
}
]
}

View File

@ -0,0 +1,98 @@
{
"id": 4,
"name": "Test Thermostat 4",
"profile": 3033,
"image": "default",
"favorite": 0,
"order": 32,
"protocol": 1,
"routing": 0,
"state": 1,
"state_changed": 1712840187,
"added": 1655274291,
"history": 1,
"cube_type": 1,
"note": "",
"services": 7,
"phonetic_name": "",
"owner": 2,
"security": 0,
"attributes": [
{
"id": 1,
"node_id": 4,
"instance": 0,
"minimum": 10,
"maximum": 32,
"current_value": 12.0,
"target_value": 13.0,
"last_value": 12.0,
"unit": "°C",
"step_value": 0.5,
"editable": 1,
"type": 6,
"state": 2,
"last_changed": 1713695529,
"changed_by": 3,
"changed_by_id": 0,
"based_on": 1,
"data": "",
"name": "",
"options": {
"automations": ["step"],
"history": {
"day": 35,
"week": 5,
"month": 1,
"stepped": true
}
}
},
{
"id": 2,
"node_id": 4,
"instance": 0,
"minimum": -50,
"maximum": 125,
"current_value": 19.55,
"target_value": 19.55,
"last_value": 21.07,
"unit": "°C",
"step_value": 0.1,
"editable": 0,
"type": 5,
"state": 1,
"last_changed": 1713695528,
"changed_by": 1,
"changed_by_id": 0,
"based_on": 1,
"data": "",
"name": "",
"options": {
"observed_by": [240],
"history": { "day": 1, "week": 26, "month": 6 }
}
},
{
"id": 3,
"node_id": 4,
"instance": 0,
"minimum": 0,
"maximum": 4,
"current_value": 1.0,
"target_value": 1.0,
"last_value": 1.0,
"unit": "",
"step_value": 1.0,
"editable": 1,
"type": 258,
"state": 1,
"last_changed": 1711796635,
"changed_by": 1,
"changed_by_id": 0,
"based_on": 1,
"data": "",
"name": ""
}
]
}

View File

@ -0,0 +1,274 @@
# serializer version: 1
# name: test_climate_snapshot[climate.test_thermostat_1-entry]
EntityRegistryEntrySnapshot({
'aliases': set({
}),
'area_id': None,
'capabilities': dict({
'hvac_modes': list([
<HVACMode.HEAT: 'heat'>,
]),
'max_temp': 28,
'min_temp': 12,
'target_temp_step': 0.1,
}),
'config_entry_id': <ANY>,
'config_subentry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'climate',
'entity_category': None,
'entity_id': 'climate.test_thermostat_1',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'options': dict({
}),
'original_device_class': None,
'original_icon': None,
'original_name': None,
'platform': 'homee',
'previous_unique_id': None,
'supported_features': <ClimateEntityFeature: 1>,
'translation_key': 'homee',
'unique_id': '00055511EECC-1-1',
'unit_of_measurement': None,
})
# ---
# name: test_climate_snapshot[climate.test_thermostat_1-state]
StateSnapshot({
'attributes': ReadOnlyDict({
'current_temperature': None,
'friendly_name': 'Test Thermostat 1',
'hvac_action': <HVACAction.HEATING: 'heating'>,
'hvac_modes': list([
<HVACMode.HEAT: 'heat'>,
]),
'max_temp': 28,
'min_temp': 12,
'supported_features': <ClimateEntityFeature: 1>,
'target_temp_step': 0.1,
'temperature': 20.0,
}),
'context': <ANY>,
'entity_id': 'climate.test_thermostat_1',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': 'heat',
})
# ---
# name: test_climate_snapshot[climate.test_thermostat_2-entry]
EntityRegistryEntrySnapshot({
'aliases': set({
}),
'area_id': None,
'capabilities': dict({
'hvac_modes': list([
<HVACMode.HEAT: 'heat'>,
]),
'max_temp': 30,
'min_temp': 15,
'target_temp_step': 0.1,
}),
'config_entry_id': <ANY>,
'config_subentry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'climate',
'entity_category': None,
'entity_id': 'climate.test_thermostat_2',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'options': dict({
}),
'original_device_class': None,
'original_icon': None,
'original_name': None,
'platform': 'homee',
'previous_unique_id': None,
'supported_features': <ClimateEntityFeature: 1>,
'translation_key': 'homee',
'unique_id': '00055511EECC-2-1',
'unit_of_measurement': None,
})
# ---
# name: test_climate_snapshot[climate.test_thermostat_2-state]
StateSnapshot({
'attributes': ReadOnlyDict({
'current_temperature': 19.6,
'friendly_name': 'Test Thermostat 2',
'hvac_action': <HVACAction.HEATING: 'heating'>,
'hvac_modes': list([
<HVACMode.HEAT: 'heat'>,
]),
'max_temp': 30,
'min_temp': 15,
'supported_features': <ClimateEntityFeature: 1>,
'target_temp_step': 0.1,
'temperature': 22.0,
}),
'context': <ANY>,
'entity_id': 'climate.test_thermostat_2',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': 'heat',
})
# ---
# name: test_climate_snapshot[climate.test_thermostat_3-entry]
EntityRegistryEntrySnapshot({
'aliases': set({
}),
'area_id': None,
'capabilities': dict({
'hvac_modes': list([
<HVACMode.HEAT: 'heat'>,
<HVACMode.OFF: 'off'>,
]),
'max_temp': 25,
'min_temp': 14,
'target_temp_step': 0.1,
}),
'config_entry_id': <ANY>,
'config_subentry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'climate',
'entity_category': None,
'entity_id': 'climate.test_thermostat_3',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'options': dict({
}),
'original_device_class': None,
'original_icon': None,
'original_name': None,
'platform': 'homee',
'previous_unique_id': None,
'supported_features': <ClimateEntityFeature: 385>,
'translation_key': 'homee',
'unique_id': '00055511EECC-3-1',
'unit_of_measurement': None,
})
# ---
# name: test_climate_snapshot[climate.test_thermostat_3-state]
StateSnapshot({
'attributes': ReadOnlyDict({
'current_temperature': 19.6,
'friendly_name': 'Test Thermostat 3',
'hvac_action': <HVACAction.HEATING: 'heating'>,
'hvac_modes': list([
<HVACMode.HEAT: 'heat'>,
<HVACMode.OFF: 'off'>,
]),
'max_temp': 25,
'min_temp': 14,
'supported_features': <ClimateEntityFeature: 385>,
'target_temp_step': 0.1,
'temperature': 24.0,
}),
'context': <ANY>,
'entity_id': 'climate.test_thermostat_3',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': 'heat',
})
# ---
# name: test_climate_snapshot[climate.test_thermostat_4-entry]
EntityRegistryEntrySnapshot({
'aliases': set({
}),
'area_id': None,
'capabilities': dict({
'hvac_modes': list([
<HVACMode.HEAT: 'heat'>,
<HVACMode.OFF: 'off'>,
]),
'max_temp': 32,
'min_temp': 10,
'preset_modes': list([
'none',
'eco',
'boost',
'manual',
]),
'target_temp_step': 0.5,
}),
'config_entry_id': <ANY>,
'config_subentry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'climate',
'entity_category': None,
'entity_id': 'climate.test_thermostat_4',
'has_entity_name': True,
'hidden_by': None,
'icon': None,
'id': <ANY>,
'labels': set({
}),
'name': None,
'options': dict({
}),
'original_device_class': None,
'original_icon': None,
'original_name': None,
'platform': 'homee',
'previous_unique_id': None,
'supported_features': <ClimateEntityFeature: 401>,
'translation_key': 'homee',
'unique_id': '00055511EECC-4-1',
'unit_of_measurement': None,
})
# ---
# name: test_climate_snapshot[climate.test_thermostat_4-state]
StateSnapshot({
'attributes': ReadOnlyDict({
'current_temperature': 19.6,
'friendly_name': 'Test Thermostat 4',
'hvac_action': <HVACAction.IDLE: 'idle'>,
'hvac_modes': list([
<HVACMode.HEAT: 'heat'>,
<HVACMode.OFF: 'off'>,
]),
'max_temp': 32,
'min_temp': 10,
'preset_mode': 'none',
'preset_modes': list([
'none',
'eco',
'boost',
'manual',
]),
'supported_features': <ClimateEntityFeature: 401>,
'target_temp_step': 0.5,
'temperature': 12.0,
}),
'context': <ANY>,
'entity_id': 'climate.test_thermostat_4',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': 'heat',
})
# ---

View File

@ -0,0 +1,270 @@
"""Test Homee climate entities."""
from unittest.mock import MagicMock, patch
from pyHomee.const import AttributeType
import pytest
from syrupy.assertion import SnapshotAssertion
from homeassistant.components.climate import (
ATTR_HVAC_ACTION,
ATTR_HVAC_MODE,
ATTR_HVAC_MODES,
ATTR_PRESET_MODE,
ATTR_PRESET_MODES,
ATTR_TEMPERATURE,
DOMAIN as CLIMATE_DOMAIN,
PRESET_BOOST,
PRESET_ECO,
PRESET_NONE,
SERVICE_SET_HVAC_MODE,
SERVICE_SET_PRESET_MODE,
SERVICE_SET_TEMPERATURE,
SERVICE_TURN_OFF,
SERVICE_TURN_ON,
ClimateEntityFeature,
HVACAction,
HVACMode,
)
from homeassistant.components.homee.const import PRESET_MANUAL
from homeassistant.const import ATTR_ENTITY_ID, Platform
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er
from . import build_mock_node, setup_integration
from tests.common import MockConfigEntry, snapshot_platform
async def setup_mock_climate(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_homee: MagicMock,
file: str,
) -> None:
"""Setups a climate node for the tests."""
mock_homee.nodes = [build_mock_node(file)]
mock_homee.get_node_by_id.return_value = mock_homee.nodes[0]
await setup_integration(hass, mock_config_entry)
@pytest.mark.parametrize(
("file", "entity_id", "features", "hvac_modes"),
[
(
"thermostat_only_targettemp.json",
"climate.test_thermostat_1",
ClimateEntityFeature.TARGET_TEMPERATURE,
[HVACMode.HEAT],
),
(
"thermostat_with_currenttemp.json",
"climate.test_thermostat_2",
ClimateEntityFeature.TARGET_TEMPERATURE,
[HVACMode.HEAT],
),
(
"thermostat_with_heating_mode.json",
"climate.test_thermostat_3",
ClimateEntityFeature.TARGET_TEMPERATURE
| ClimateEntityFeature.TURN_ON
| ClimateEntityFeature.TURN_OFF,
[HVACMode.HEAT, HVACMode.OFF],
),
(
"thermostat_with_preset.json",
"climate.test_thermostat_4",
ClimateEntityFeature.TARGET_TEMPERATURE
| ClimateEntityFeature.TURN_ON
| ClimateEntityFeature.TURN_OFF
| ClimateEntityFeature.PRESET_MODE,
[HVACMode.HEAT, HVACMode.OFF],
),
],
)
async def test_climate_features(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_homee: MagicMock,
file: str,
entity_id: str,
features: ClimateEntityFeature,
hvac_modes: list[HVACMode],
) -> None:
"""Test available features of climate entities."""
await setup_mock_climate(hass, mock_config_entry, mock_homee, file)
attributes = hass.states.get(entity_id).attributes
assert attributes["supported_features"] == features
assert attributes[ATTR_HVAC_MODES] == hvac_modes
async def test_climate_preset_modes(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_homee: MagicMock,
) -> None:
"""Test available preset modes of climate entities."""
await setup_mock_climate(
hass, mock_config_entry, mock_homee, "thermostat_with_preset.json"
)
attributes = hass.states.get("climate.test_thermostat_4").attributes
assert attributes[ATTR_PRESET_MODES] == [
PRESET_NONE,
PRESET_ECO,
PRESET_BOOST,
PRESET_MANUAL,
]
@pytest.mark.parametrize(
("attribute_type", "value", "expected"),
[
(AttributeType.HEATING_MODE, 0.0, HVACAction.OFF),
(AttributeType.CURRENT_VALVE_POSITION, 0.0, HVACAction.IDLE),
(AttributeType.TEMPERATURE, 25.0, HVACAction.IDLE),
(AttributeType.TEMPERATURE, 18.0, HVACAction.HEATING),
],
)
async def test_hvac_action(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_homee: MagicMock,
attribute_type: AttributeType,
value: float,
expected: HVACAction,
) -> None:
"""Test hvac action of climate entities."""
mock_homee.nodes = [build_mock_node("thermostat_with_heating_mode.json")]
mock_homee.get_node_by_id.return_value = mock_homee.nodes[0]
node = mock_homee.nodes[0]
# set target temperature to 24.0
node.attributes[0].current_value = 24.0
attribute = node.get_attribute_by_type(attribute_type)
attribute.current_value = value
await setup_integration(hass, mock_config_entry)
attributes = hass.states.get("climate.test_thermostat_3").attributes
assert attributes[ATTR_HVAC_ACTION] == expected
@pytest.mark.parametrize(
("preset_mode_int", "expected"),
[
(0, PRESET_NONE),
(1, PRESET_NONE),
(2, PRESET_ECO),
(3, PRESET_BOOST),
(4, PRESET_MANUAL),
],
)
async def test_current_preset_mode(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_homee: MagicMock,
preset_mode_int: int,
expected: str,
) -> None:
"""Test current preset mode of climate entities."""
mock_homee.nodes = [build_mock_node("thermostat_with_preset.json")]
mock_homee.get_node_by_id.return_value = mock_homee.nodes[0]
node = mock_homee.nodes[0]
node.attributes[2].current_value = preset_mode_int
await setup_integration(hass, mock_config_entry)
attributes = hass.states.get("climate.test_thermostat_4").attributes
assert attributes[ATTR_PRESET_MODE] == expected
@pytest.mark.parametrize(
("service", "service_data", "expected"),
[
(
SERVICE_TURN_ON,
{},
(4, 3, 1),
),
(
SERVICE_TURN_OFF,
{},
(4, 3, 0),
),
(
SERVICE_SET_HVAC_MODE,
{ATTR_HVAC_MODE: HVACMode.HEAT},
(4, 3, 1),
),
(
SERVICE_SET_HVAC_MODE,
{ATTR_HVAC_MODE: HVACMode.OFF},
(4, 3, 0),
),
(
SERVICE_SET_TEMPERATURE,
{ATTR_TEMPERATURE: 20},
(4, 1, 20),
),
(
SERVICE_SET_PRESET_MODE,
{ATTR_PRESET_MODE: PRESET_NONE},
(4, 3, 1),
),
(
SERVICE_SET_PRESET_MODE,
{ATTR_PRESET_MODE: PRESET_ECO},
(4, 3, 2),
),
(
SERVICE_SET_PRESET_MODE,
{ATTR_PRESET_MODE: PRESET_BOOST},
(4, 3, 3),
),
(
SERVICE_SET_PRESET_MODE,
{ATTR_PRESET_MODE: PRESET_MANUAL},
(4, 3, 4),
),
],
)
async def test_climate_services(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
mock_homee: MagicMock,
service: str,
service_data: dict,
expected: tuple[int, int, int],
) -> None:
"""Test available services of climate entities."""
await setup_mock_climate(
hass, mock_config_entry, mock_homee, "thermostat_with_preset.json"
)
await hass.services.async_call(
CLIMATE_DOMAIN,
service,
{ATTR_ENTITY_ID: "climate.test_thermostat_4", **service_data},
blocking=True,
)
mock_homee.set_value.assert_called_once_with(*expected)
async def test_climate_snapshot(
hass: HomeAssistant,
mock_homee: MagicMock,
mock_config_entry: MockConfigEntry,
entity_registry: er.EntityRegistry,
snapshot: SnapshotAssertion,
) -> None:
"""Test snapshot of climates."""
mock_homee.nodes = [
build_mock_node("thermostat_only_targettemp.json"),
build_mock_node("thermostat_with_currenttemp.json"),
build_mock_node("thermostat_with_heating_mode.json"),
build_mock_node("thermostat_with_preset.json"),
]
with patch("homeassistant.components.homee.PLATFORMS", [Platform.CLIMATE]):
await setup_integration(hass, mock_config_entry)
await snapshot_platform(hass, entity_registry, snapshot, mock_config_entry.entry_id)