evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Parametrize deCONZ binary sensors (#65012)

Browse source 
* Improve test coverage prior to improving deCONZ binary sensor platform

* Define all relevant binary sensors as DeconzBinarySensorDescription

* Fix review comment

* Allow providing extra update keys if sensor provides extra attributes

* Minor touch up of naming

* Remove duplicate assert
This commit is contained in:
Robert Svensson 2022-02-04 12:58:07 +01:00 • committed by GitHub
parent b7007b364a
commit 96c4e33b24
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 623 additions and 300 deletions
Download patch file Download diff file Expand all files Collapse all files

242
homeassistant/components/deconz/binary_sensor.py
View file

@ -7,7 +7,6 @@ from dataclasses import dataclass
from pydeconz.sensor import (
Alarm,
CarbonMonoxide,
DeconzBinarySensor as PydeconzBinarySensor,
DeconzSensor as PydeconzSensor,
Fire,
GenericFlag,
@ -34,21 +33,21 @@ from .const import ATTR_DARK, ATTR_ON
from .deconz_device import DeconzDevice
from .gateway import DeconzGateway, get_gateway_from_config_entry
DECONZ_BINARY_SENSORS = (
Alarm,
CarbonMonoxide,
Fire,
GenericFlag,
OpenClose,
Presence,
Vibration,
Water,
)
ATTR_ORIENTATION = "orientation"
ATTR_TILTANGLE = "tiltangle"
ATTR_VIBRATIONSTRENGTH = "vibrationstrength"
PROVIDES_EXTRA_ATTRIBUTES = (
"alarm",
"carbon_monoxide",
"fire",
"flag",
"open",
"presence",
"vibration",
"water",
)
@dataclass
class DeconzBinarySensorDescriptionMixin:
@ -56,7 +55,6 @@ class DeconzBinarySensorDescriptionMixin:
suffix: str
update_key: str
required_attr: str
value_fn: Callable[[PydeconzSensor], bool | None]
@ -69,41 +67,90 @@ class DeconzBinarySensorDescription(
ENTITY_DESCRIPTIONS = {
Alarm: BinarySensorEntityDescription(
key="alarm",
device_class=BinarySensorDeviceClass.SAFETY,
),
CarbonMonoxide: BinarySensorEntityDescription(
key="carbonmonoxide",
device_class=BinarySensorDeviceClass.CO,
),
Fire: BinarySensorEntityDescription(
key="fire",
device_class=BinarySensorDeviceClass.SMOKE,
),
OpenClose: BinarySensorEntityDescription(
key="openclose",
device_class=BinarySensorDeviceClass.OPENING,
),
Presence: BinarySensorEntityDescription(
key="presence",
device_class=BinarySensorDeviceClass.MOTION,
),
Vibration: BinarySensorEntityDescription(
key="vibration",
device_class=BinarySensorDeviceClass.VIBRATION,
),
Water: BinarySensorEntityDescription(
key="water",
device_class=BinarySensorDeviceClass.MOISTURE,
),
Alarm: [
DeconzBinarySensorDescription(
key="alarm",
value_fn=lambda device: device.alarm,
suffix="",
update_key="alarm",
device_class=BinarySensorDeviceClass.SAFETY,
)
],
CarbonMonoxide: [
DeconzBinarySensorDescription(
key="carbon_monoxide",
value_fn=lambda device: device.carbon_monoxide,
suffix="",
update_key="carbonmonoxide",
device_class=BinarySensorDeviceClass.CO,
)
],
Fire: [
DeconzBinarySensorDescription(
key="fire",
value_fn=lambda device: device.fire,
suffix="",
update_key="fire",
device_class=BinarySensorDeviceClass.SMOKE,
),
DeconzBinarySensorDescription(
key="in_test_mode",
value_fn=lambda device: device.in_test_mode,
suffix="Test Mode",
update_key="test",
device_class=BinarySensorDeviceClass.SMOKE,
entity_category=EntityCategory.DIAGNOSTIC,
),
],
GenericFlag: [
DeconzBinarySensorDescription(
key="flag",
value_fn=lambda device: device.flag,
suffix="",
update_key="flag",
)
],
OpenClose: [
DeconzBinarySensorDescription(
key="open",
value_fn=lambda device: device.open,
suffix="",
update_key="open",
device_class=BinarySensorDeviceClass.OPENING,
)
],
Presence: [
DeconzBinarySensorDescription(
key="presence",
value_fn=lambda device: device.presence,
suffix="",
update_key="presence",
device_class=BinarySensorDeviceClass.MOTION,
)
],
Vibration: [
DeconzBinarySensorDescription(
key="vibration",
value_fn=lambda device: device.vibration,
suffix="",
update_key="vibration",
device_class=BinarySensorDeviceClass.VIBRATION,
)
],
Water: [
DeconzBinarySensorDescription(
key="water",
value_fn=lambda device: device.water,
suffix="",
update_key="water",
device_class=BinarySensorDeviceClass.MOISTURE,
)
],
}
BINARY_SENSOR_DESCRIPTIONS = [
DeconzBinarySensorDescription(
key="tamper",
required_attr="tampered",
key="tampered",
value_fn=lambda device: device.tampered,
suffix="Tampered",
update_key="tampered",
@ -112,22 +159,12 @@ BINARY_SENSOR_DESCRIPTIONS = [
),
DeconzBinarySensorDescription(
key="low_battery",
required_attr="low_battery",
value_fn=lambda device: device.low_battery,
suffix="Low Battery",
update_key="lowbattery",
device_class=BinarySensorDeviceClass.BATTERY,
entity_category=EntityCategory.DIAGNOSTIC,
),
DeconzBinarySensorDescription(
key="in_test_mode",
required_attr="in_test_mode",
value_fn=lambda device: device.in_test_mode,
suffix="Test Mode",
update_key="test",
device_class=BinarySensorDeviceClass.SMOKE,
entity_category=EntityCategory.DIAGNOSTIC,
),
]
@ -146,32 +183,26 @@ async def async_setup_entry(
| ValuesView[PydeconzSensor] = gateway.api.sensors.values(),
) -> None:
"""Add binary sensor from deCONZ."""
entities: list[DeconzBinarySensor | DeconzPropertyBinarySensor] = []
entities: list[DeconzBinarySensor] = []
for sensor in sensors:
if not gateway.option_allow_clip_sensor and sensor.type.startswith("CLIP"):
continue
if (
isinstance(sensor, DECONZ_BINARY_SENSORS)
and sensor.unique_id not in gateway.entities[DOMAIN]
known_entities = set(gateway.entities[DOMAIN])
for description in (
ENTITY_DESCRIPTIONS.get(type(sensor), []) + BINARY_SENSOR_DESCRIPTIONS
):
entities.append(DeconzBinarySensor(sensor, gateway))
known_sensor_entities = set(gateway.entities[DOMAIN])
for sensor_description in BINARY_SENSOR_DESCRIPTIONS:
if (
not hasattr(sensor, sensor_description.required_attr)
or sensor_description.value_fn(sensor) is None
not hasattr(sensor, description.key)
or description.value_fn(sensor) is None
):
continue
new_sensor = DeconzPropertyBinarySensor(
sensor, gateway, sensor_description
)
if new_sensor.unique_id not in known_sensor_entities:
new_sensor = DeconzBinarySensor(sensor, gateway, description)
if new_sensor.unique_id not in known_entities:
entities.append(new_sensor)
if entities:
@ -194,30 +225,50 @@ class DeconzBinarySensor(DeconzDevice, BinarySensorEntity):
"""Representation of a deCONZ binary sensor."""
TYPE = DOMAIN
_device: PydeconzBinarySensor
_device: PydeconzSensor
entity_description: DeconzBinarySensorDescription
def __init__(self, device: PydeconzBinarySensor, gateway: DeconzGateway) -> None:
def __init__(
self,
device: PydeconzSensor,
gateway: DeconzGateway,
description: DeconzBinarySensorDescription,
) -> None:
"""Initialize deCONZ binary sensor."""
self.entity_description: DeconzBinarySensorDescription = description
super().__init__(device, gateway)
if entity_description := ENTITY_DESCRIPTIONS.get(type(device)):
self.entity_description = entity_description
if description.suffix:
self._attr_name = f"{self._device.name} {description.suffix}"
self._update_keys = {description.update_key, "reachable"}
if self.entity_description.key in PROVIDES_EXTRA_ATTRIBUTES:
self._update_keys.update({"on", "state"})
@property
def unique_id(self) -> str:
"""Return a unique identifier for this device."""
if self.entity_description.suffix:
return f"{self.serial}-{self.entity_description.suffix.lower()}"
return super().unique_id
@callback
def async_update_callback(self) -> None:
"""Update the sensor's state."""
keys = {"on", "reachable", "state"}
if self._device.changed_keys.intersection(keys):
if self._device.changed_keys.intersection(self._update_keys):
super().async_update_callback()
@property
def is_on(self) -> bool:
"""Return true if sensor is on."""
return self._device.state # type: ignore[no-any-return]
def is_on(self) -> bool | None:
"""Return the state of the sensor."""
return self.entity_description.value_fn(self._device)
@property
def extra_state_attributes(self) -> dict[str, bool | float | int | list | None]:
"""Return the state attributes of the sensor."""
if self.entity_description.key not in PROVIDES_EXTRA_ATTRIBUTES:
return
attr: dict[str, bool | float | int | list | None] = {}
if self._device.on is not None:
@ -237,40 +288,3 @@ class DeconzBinarySensor(DeconzDevice, BinarySensorEntity):
attr[ATTR_VIBRATIONSTRENGTH] = self._device.vibration_strength
return attr
class DeconzPropertyBinarySensor(DeconzDevice, BinarySensorEntity):
"""Representation of a deCONZ Property sensor."""
TYPE = DOMAIN
_device: PydeconzSensor
entity_description: DeconzBinarySensorDescription
def __init__(
self,
device: PydeconzSensor,
gateway: DeconzGateway,
description: DeconzBinarySensorDescription,
) -> None:
"""Initialize deCONZ binary sensor."""
self.entity_description = description
super().__init__(device, gateway)
self._attr_name = f"{self._device.name} {description.suffix}"
self._update_keys = {description.update_key, "reachable"}
@property
def unique_id(self) -> str:
"""Return a unique identifier for this device."""
return f"{self.serial}-{self.entity_description.suffix.lower()}"
@callback
def async_update_callback(self) -> None:
"""Update the sensor's state."""
if self._device.changed_keys.intersection(self._update_keys):
super().async_update_callback()
@property
def is_on(self) -> bool | None:
"""Return the state of the sensor."""
return self.entity_description.value_fn(self._device)