Add Matter battery replacement description (#132974)

This commit is contained in:
Ludovic BOUÉ 2024-12-17 00:03:32 +01:00 committed by GitHub
parent 73e3e91af2
commit 1512cd5fb7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 316 additions and 0 deletions

View File

@ -43,6 +43,9 @@
"air_quality": {
"default": "mdi:air-filter"
},
"bat_replacement_description": {
"default": "mdi:battery-sync"
},
"hepa_filter_condition": {
"default": "mdi:filter-check"
},

View File

@ -231,6 +231,20 @@ DISCOVERY_SCHEMAS = [
entity_class=MatterSensor,
required_attributes=(clusters.PowerSource.Attributes.BatVoltage,),
),
MatterDiscoverySchema(
platform=Platform.SENSOR,
entity_description=MatterSensorEntityDescription(
key="PowerSourceBatReplacementDescription",
translation_key="battery_replacement_description",
native_unit_of_measurement=None,
device_class=None,
entity_category=EntityCategory.DIAGNOSTIC,
),
entity_class=MatterSensor,
required_attributes=(
clusters.PowerSource.Attributes.BatReplacementDescription,
),
),
MatterDiscoverySchema(
platform=Platform.SENSOR,
entity_description=MatterSensorEntityDescription(

View File

@ -245,6 +245,9 @@
},
"valve_position": {
"name": "Valve position"
},
"battery_replacement_description": {
"name": "Battery type"
}
},
"switch": {

View File

@ -1145,6 +1145,98 @@
'state': '189.0',
})
# ---
# name: test_sensors[door_lock][sensor.mock_door_lock_battery_type-entry]
EntityRegistryEntrySnapshot({
'aliases': set({
}),
'area_id': None,
'capabilities': None,
'config_entry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'sensor.mock_door_lock_battery_type',
'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': 'Battery type',
'platform': 'matter',
'previous_unique_id': None,
'supported_features': 0,
'translation_key': 'battery_replacement_description',
'unique_id': '00000000000004D2-0000000000000001-MatterNodeDevice-1-PowerSourceBatReplacementDescription-47-19',
'unit_of_measurement': None,
})
# ---
# name: test_sensors[door_lock][sensor.mock_door_lock_battery_type-state]
StateSnapshot({
'attributes': ReadOnlyDict({
'friendly_name': 'Mock Door Lock Battery type',
}),
'context': <ANY>,
'entity_id': 'sensor.mock_door_lock_battery_type',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': '',
})
# ---
# name: test_sensors[door_lock_with_unbolt][sensor.mock_door_lock_battery_type-entry]
EntityRegistryEntrySnapshot({
'aliases': set({
}),
'area_id': None,
'capabilities': None,
'config_entry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'sensor.mock_door_lock_battery_type',
'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': 'Battery type',
'platform': 'matter',
'previous_unique_id': None,
'supported_features': 0,
'translation_key': 'battery_replacement_description',
'unique_id': '00000000000004D2-0000000000000001-MatterNodeDevice-1-PowerSourceBatReplacementDescription-47-19',
'unit_of_measurement': None,
})
# ---
# name: test_sensors[door_lock_with_unbolt][sensor.mock_door_lock_battery_type-state]
StateSnapshot({
'attributes': ReadOnlyDict({
'friendly_name': 'Mock Door Lock Battery type',
}),
'context': <ANY>,
'entity_id': 'sensor.mock_door_lock_battery_type',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': '',
})
# ---
# name: test_sensors[eve_contact_sensor][sensor.eve_door_battery-entry]
EntityRegistryEntrySnapshot({
'aliases': set({
@ -1196,6 +1288,52 @@
'state': '100',
})
# ---
# name: test_sensors[eve_contact_sensor][sensor.eve_door_battery_type-entry]
EntityRegistryEntrySnapshot({
'aliases': set({
}),
'area_id': None,
'capabilities': None,
'config_entry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'sensor.eve_door_battery_type',
'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': 'Battery type',
'platform': 'matter',
'previous_unique_id': None,
'supported_features': 0,
'translation_key': 'battery_replacement_description',
'unique_id': '00000000000004D2-0000000000000001-MatterNodeDevice-1-PowerSourceBatReplacementDescription-47-19',
'unit_of_measurement': None,
})
# ---
# name: test_sensors[eve_contact_sensor][sensor.eve_door_battery_type-state]
StateSnapshot({
'attributes': ReadOnlyDict({
'friendly_name': 'Eve Door Battery type',
}),
'context': <ANY>,
'entity_id': 'sensor.eve_door_battery_type',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': '',
})
# ---
# name: test_sensors[eve_contact_sensor][sensor.eve_door_voltage-entry]
EntityRegistryEntrySnapshot({
'aliases': set({
@ -1733,6 +1871,52 @@
'state': '100',
})
# ---
# name: test_sensors[eve_thermo][sensor.eve_thermo_battery_type-entry]
EntityRegistryEntrySnapshot({
'aliases': set({
}),
'area_id': None,
'capabilities': None,
'config_entry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'sensor.eve_thermo_battery_type',
'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': 'Battery type',
'platform': 'matter',
'previous_unique_id': None,
'supported_features': 0,
'translation_key': 'battery_replacement_description',
'unique_id': '00000000000004D2-0000000000000021-MatterNodeDevice-0-PowerSourceBatReplacementDescription-47-19',
'unit_of_measurement': None,
})
# ---
# name: test_sensors[eve_thermo][sensor.eve_thermo_battery_type-state]
StateSnapshot({
'attributes': ReadOnlyDict({
'friendly_name': 'Eve Thermo Battery type',
}),
'context': <ANY>,
'entity_id': 'sensor.eve_thermo_battery_type',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': '',
})
# ---
# name: test_sensors[eve_thermo][sensor.eve_thermo_valve_position-entry]
EntityRegistryEntrySnapshot({
'aliases': set({
@ -1882,6 +2066,52 @@
'state': '100',
})
# ---
# name: test_sensors[eve_weather_sensor][sensor.eve_weather_battery_type-entry]
EntityRegistryEntrySnapshot({
'aliases': set({
}),
'area_id': None,
'capabilities': None,
'config_entry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'sensor.eve_weather_battery_type',
'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': 'Battery type',
'platform': 'matter',
'previous_unique_id': None,
'supported_features': 0,
'translation_key': 'battery_replacement_description',
'unique_id': '00000000000004D2-000000000000001D-MatterNodeDevice-0-PowerSourceBatReplacementDescription-47-19',
'unit_of_measurement': None,
})
# ---
# name: test_sensors[eve_weather_sensor][sensor.eve_weather_battery_type-state]
StateSnapshot({
'attributes': ReadOnlyDict({
'friendly_name': 'Eve Weather Battery type',
}),
'context': <ANY>,
'entity_id': 'sensor.eve_weather_battery_type',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': '',
})
# ---
# name: test_sensors[eve_weather_sensor][sensor.eve_weather_humidity-entry]
EntityRegistryEntrySnapshot({
'aliases': set({
@ -2735,6 +2965,52 @@
'state': '94',
})
# ---
# name: test_sensors[smoke_detector][sensor.smoke_sensor_battery_type-entry]
EntityRegistryEntrySnapshot({
'aliases': set({
}),
'area_id': None,
'capabilities': None,
'config_entry_id': <ANY>,
'device_class': None,
'device_id': <ANY>,
'disabled_by': None,
'domain': 'sensor',
'entity_category': <EntityCategory.DIAGNOSTIC: 'diagnostic'>,
'entity_id': 'sensor.smoke_sensor_battery_type',
'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': 'Battery type',
'platform': 'matter',
'previous_unique_id': None,
'supported_features': 0,
'translation_key': 'battery_replacement_description',
'unique_id': '00000000000004D2-0000000000000001-MatterNodeDevice-1-PowerSourceBatReplacementDescription-47-19',
'unit_of_measurement': None,
})
# ---
# name: test_sensors[smoke_detector][sensor.smoke_sensor_battery_type-state]
StateSnapshot({
'attributes': ReadOnlyDict({
'friendly_name': 'Smoke sensor Battery type',
}),
'context': <ANY>,
'entity_id': 'sensor.smoke_sensor_battery_type',
'last_changed': <ANY>,
'last_reported': <ANY>,
'last_updated': <ANY>,
'state': 'CR123A',
})
# ---
# name: test_sensors[smoke_detector][sensor.smoke_sensor_voltage-entry]
EntityRegistryEntrySnapshot({
'aliases': set({

View File

@ -174,6 +174,26 @@ async def test_battery_sensor_voltage(
assert entry.entity_category == EntityCategory.DIAGNOSTIC
@pytest.mark.parametrize("node_fixture", ["smoke_detector"])
async def test_battery_sensor_description(
hass: HomeAssistant,
entity_registry: er.EntityRegistry,
matter_client: MagicMock,
matter_node: MatterNode,
) -> None:
"""Test battery replacement description sensor."""
state = hass.states.get("sensor.smoke_sensor_battery_type")
assert state
assert state.state == "CR123A"
set_node_attribute(matter_node, 1, 47, 19, "CR2032")
await trigger_subscription_callback(hass, matter_client)
state = hass.states.get("sensor.smoke_sensor_battery_type")
assert state
assert state.state == "CR2032"
@pytest.mark.parametrize("node_fixture", ["eve_thermo"])
async def test_eve_thermo_sensor(
hass: HomeAssistant,