From 9e6de48a221750393f9c409d026c114dc3681742 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludovic=20BOU=C3=89?= Date: Thu, 22 May 2025 12:53:08 +0200 Subject: [PATCH] Matter Device Energy Management cluster ESAState attribute (#144430) * ESAState * Update strings.json * Add test --- homeassistant/components/matter/sensor.py | 21 +++ homeassistant/components/matter/strings.json | 10 ++ .../matter/snapshots/test_sensor.ambr | 126 ++++++++++++++++++ tests/components/matter/test_sensor.py | 12 ++ 4 files changed, 169 insertions(+) diff --git a/homeassistant/components/matter/sensor.py b/homeassistant/components/matter/sensor.py index 83248955279..381ecc480da 100644 --- a/homeassistant/components/matter/sensor.py +++ b/homeassistant/components/matter/sensor.py @@ -83,6 +83,14 @@ BOOST_STATE_MAP = { clusters.WaterHeaterManagement.Enums.BoostStateEnum.kUnknownEnumValue: None, } +ESA_STATE_MAP = { + clusters.DeviceEnergyManagement.Enums.ESAStateEnum.kOffline: "offline", + clusters.DeviceEnergyManagement.Enums.ESAStateEnum.kOnline: "online", + clusters.DeviceEnergyManagement.Enums.ESAStateEnum.kFault: "fault", + clusters.DeviceEnergyManagement.Enums.ESAStateEnum.kPowerAdjustActive: "power_adjust_active", + clusters.DeviceEnergyManagement.Enums.ESAStateEnum.kPaused: "paused", +} + EVSE_FAULT_STATE_MAP = { clusters.EnergyEvse.Enums.FaultStateEnum.kNoError: "no_error", clusters.EnergyEvse.Enums.FaultStateEnum.kMeterFailure: "meter_failure", @@ -1097,4 +1105,17 @@ DISCOVERY_SCHEMAS = [ clusters.WaterHeaterManagement.Attributes.EstimatedHeatRequired, ), ), + MatterDiscoverySchema( + platform=Platform.SENSOR, + entity_description=MatterSensorEntityDescription( + key="ESAState", + translation_key="esa_state", + device_class=SensorDeviceClass.ENUM, + entity_category=EntityCategory.DIAGNOSTIC, + options=list(ESA_STATE_MAP.values()), + measurement_to_ha=ESA_STATE_MAP.get, + ), + entity_class=MatterSensor, + required_attributes=(clusters.DeviceEnergyManagement.Attributes.ESAState,), + ), ] diff --git a/homeassistant/components/matter/strings.json b/homeassistant/components/matter/strings.json index daff0115505..325e8d1f26c 100644 --- a/homeassistant/components/matter/strings.json +++ b/homeassistant/components/matter/strings.json @@ -321,6 +321,16 @@ "energy_exported": { "name": "Energy exported" }, + "esa_state": { + "name": "Appliance energy state", + "state": { + "offline": "Offline", + "online": "Online", + "fault": "[%key:common::state::fault%]", + "power_adjust_active": "Power adjust", + "paused": "[%key:common::state::paused%]" + } + }, "evse_fault_state": { "name": "Fault state", "state": { diff --git a/tests/components/matter/snapshots/test_sensor.ambr b/tests/components/matter/snapshots/test_sensor.ambr index 00c9a178c2b..bf22986d6df 100644 --- a/tests/components/matter/snapshots/test_sensor.ambr +++ b/tests/components/matter/snapshots/test_sensor.ambr @@ -3603,6 +3603,69 @@ 'state': '120.0', }) # --- +# name: test_sensors[silabs_evse_charging][sensor.evse_appliance_energy_state-entry] + EntityRegistryEntrySnapshot({ + 'aliases': set({ + }), + 'area_id': None, + 'capabilities': dict({ + 'options': list([ + 'offline', + 'online', + 'fault', + 'power_adjust_active', + 'paused', + ]), + }), + 'config_entry_id': , + 'config_subentry_id': , + 'device_class': None, + 'device_id': , + 'disabled_by': None, + 'domain': 'sensor', + 'entity_category': , + 'entity_id': 'sensor.evse_appliance_energy_state', + 'has_entity_name': True, + 'hidden_by': None, + 'icon': None, + 'id': , + 'labels': set({ + }), + 'name': None, + 'options': dict({ + }), + 'original_device_class': , + 'original_icon': None, + 'original_name': 'Appliance energy state', + 'platform': 'matter', + 'previous_unique_id': None, + 'supported_features': 0, + 'translation_key': 'esa_state', + 'unique_id': '00000000000004D2-0000000000000017-MatterNodeDevice-1-ESAState-152-2', + 'unit_of_measurement': None, + }) +# --- +# name: test_sensors[silabs_evse_charging][sensor.evse_appliance_energy_state-state] + StateSnapshot({ + 'attributes': ReadOnlyDict({ + 'device_class': 'enum', + 'friendly_name': 'evse Appliance energy state', + 'options': list([ + 'offline', + 'online', + 'fault', + 'power_adjust_active', + 'paused', + ]), + }), + 'context': , + 'entity_id': 'sensor.evse_appliance_energy_state', + 'last_changed': , + 'last_reported': , + 'last_updated': , + 'state': 'online', + }) +# --- # name: test_sensors[silabs_evse_charging][sensor.evse_circuit_capacity-entry] EntityRegistryEntrySnapshot({ 'aliases': set({ @@ -4272,6 +4335,69 @@ 'state': '120.0', }) # --- +# name: test_sensors[silabs_water_heater][sensor.water_heater_appliance_energy_state-entry] + EntityRegistryEntrySnapshot({ + 'aliases': set({ + }), + 'area_id': None, + 'capabilities': dict({ + 'options': list([ + 'offline', + 'online', + 'fault', + 'power_adjust_active', + 'paused', + ]), + }), + 'config_entry_id': , + 'config_subentry_id': , + 'device_class': None, + 'device_id': , + 'disabled_by': None, + 'domain': 'sensor', + 'entity_category': , + 'entity_id': 'sensor.water_heater_appliance_energy_state', + 'has_entity_name': True, + 'hidden_by': None, + 'icon': None, + 'id': , + 'labels': set({ + }), + 'name': None, + 'options': dict({ + }), + 'original_device_class': , + 'original_icon': None, + 'original_name': 'Appliance energy state', + 'platform': 'matter', + 'previous_unique_id': None, + 'supported_features': 0, + 'translation_key': 'esa_state', + 'unique_id': '00000000000004D2-0000000000000019-MatterNodeDevice-2-ESAState-152-2', + 'unit_of_measurement': None, + }) +# --- +# name: test_sensors[silabs_water_heater][sensor.water_heater_appliance_energy_state-state] + StateSnapshot({ + 'attributes': ReadOnlyDict({ + 'device_class': 'enum', + 'friendly_name': 'Water Heater Appliance energy state', + 'options': list([ + 'offline', + 'online', + 'fault', + 'power_adjust_active', + 'paused', + ]), + }), + 'context': , + 'entity_id': 'sensor.water_heater_appliance_energy_state', + 'last_changed': , + 'last_reported': , + 'last_updated': , + 'state': 'online', + }) +# --- # name: test_sensors[silabs_water_heater][sensor.water_heater_current-entry] EntityRegistryEntrySnapshot({ 'aliases': set({ diff --git a/tests/components/matter/test_sensor.py b/tests/components/matter/test_sensor.py index 868c73a1dff..feb604bd365 100644 --- a/tests/components/matter/test_sensor.py +++ b/tests/components/matter/test_sensor.py @@ -511,3 +511,15 @@ async def test_water_heater( state = hass.states.get("sensor.water_heater_hot_water_level") assert state assert state.state == "50" + + # DeviceEnergyManagement -> ESAState attribute + state = hass.states.get("sensor.water_heater_appliance_energy_state") + assert state + assert state.state == "online" + + set_node_attribute(matter_node, 2, 152, 2, 0) + await trigger_subscription_callback(hass, matter_client) + + state = hass.states.get("sensor.water_heater_appliance_energy_state") + assert state + assert state.state == "offline"