Add binary sensor entity to Overkiz integration (#62913)
This commit is contained in:
parent
68acf13f48
commit
41c497ee6e
3 changed files with 151 additions and 0 deletions
|
@ -803,6 +803,7 @@ omit =
|
|||
homeassistant/components/osramlightify/light.py
|
||||
homeassistant/components/otp/sensor.py
|
||||
homeassistant/components/overkiz/__init__.py
|
||||
homeassistant/components/overkiz/binary_sensor.py
|
||||
homeassistant/components/overkiz/button.py
|
||||
homeassistant/components/overkiz/coordinator.py
|
||||
homeassistant/components/overkiz/entity.py
|
||||
|
|
149
homeassistant/components/overkiz/binary_sensor.py
Normal file
149
homeassistant/components/overkiz/binary_sensor.py
Normal file
|
@ -0,0 +1,149 @@
|
|||
"""Support for Overkiz binary sensors."""
|
||||
from __future__ import annotations
|
||||
|
||||
from collections.abc import Callable
|
||||
from dataclasses import dataclass
|
||||
|
||||
from pyoverkiz.enums import OverkizCommandParam, OverkizState
|
||||
|
||||
from homeassistant.components.binary_sensor import (
|
||||
BinarySensorDeviceClass,
|
||||
BinarySensorEntity,
|
||||
BinarySensorEntityDescription,
|
||||
)
|
||||
from homeassistant.config_entries import ConfigEntry
|
||||
from homeassistant.core import HomeAssistant
|
||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||
|
||||
from . import HomeAssistantOverkizData
|
||||
from .const import DOMAIN, IGNORED_OVERKIZ_DEVICES
|
||||
from .entity import OverkizDescriptiveEntity
|
||||
|
||||
|
||||
@dataclass
|
||||
class OverkizBinarySensorDescriptionMixin:
|
||||
"""Define an entity description mixin for binary sensor entities."""
|
||||
|
||||
value_fn: Callable[[str], bool]
|
||||
|
||||
|
||||
@dataclass
|
||||
class OverkizBinarySensorDescription(
|
||||
BinarySensorEntityDescription, OverkizBinarySensorDescriptionMixin
|
||||
):
|
||||
"""Class to describe an Overkiz binary sensor."""
|
||||
|
||||
|
||||
BINARY_SENSOR_DESCRIPTIONS: list[OverkizBinarySensorDescription] = [
|
||||
# RainSensor/RainSensor
|
||||
OverkizBinarySensorDescription(
|
||||
key=OverkizState.CORE_RAIN,
|
||||
name="Rain",
|
||||
icon="mdi:weather-rainy",
|
||||
value_fn=lambda state: state == OverkizCommandParam.DETECTED,
|
||||
),
|
||||
# SmokeSensor/SmokeSensor
|
||||
OverkizBinarySensorDescription(
|
||||
key=OverkizState.CORE_SMOKE,
|
||||
name="Smoke",
|
||||
device_class=BinarySensorDeviceClass.SMOKE,
|
||||
value_fn=lambda state: state == OverkizCommandParam.DETECTED,
|
||||
),
|
||||
# WaterSensor/WaterDetectionSensor
|
||||
OverkizBinarySensorDescription(
|
||||
key=OverkizState.CORE_WATER_DETECTION,
|
||||
name="Water",
|
||||
icon="mdi:water",
|
||||
value_fn=lambda state: state == OverkizCommandParam.DETECTED,
|
||||
),
|
||||
# AirSensor/AirFlowSensor
|
||||
OverkizBinarySensorDescription(
|
||||
key=OverkizState.CORE_GAS_DETECTION,
|
||||
name="Gas",
|
||||
device_class=BinarySensorDeviceClass.GAS,
|
||||
value_fn=lambda state: state == OverkizCommandParam.DETECTED,
|
||||
),
|
||||
# OccupancySensor/OccupancySensor
|
||||
# OccupancySensor/MotionSensor
|
||||
OverkizBinarySensorDescription(
|
||||
key=OverkizState.CORE_OCCUPANCY,
|
||||
name="Occupancy",
|
||||
device_class=BinarySensorDeviceClass.OCCUPANCY,
|
||||
value_fn=lambda state: state == OverkizCommandParam.PERSON_INSIDE,
|
||||
),
|
||||
# ContactSensor/WindowWithTiltSensor
|
||||
OverkizBinarySensorDescription(
|
||||
key=OverkizState.CORE_VIBRATION,
|
||||
name="Vibration",
|
||||
device_class=BinarySensorDeviceClass.VIBRATION,
|
||||
value_fn=lambda state: state == OverkizCommandParam.DETECTED,
|
||||
),
|
||||
# ContactSensor/ContactSensor
|
||||
OverkizBinarySensorDescription(
|
||||
key=OverkizState.CORE_CONTACT,
|
||||
name="Contact",
|
||||
device_class=BinarySensorDeviceClass.DOOR,
|
||||
value_fn=lambda state: state == OverkizCommandParam.OPEN,
|
||||
),
|
||||
# Siren/SirenStatus
|
||||
OverkizBinarySensorDescription(
|
||||
key=OverkizState.CORE_ASSEMBLY,
|
||||
name="Assembly",
|
||||
device_class=BinarySensorDeviceClass.PROBLEM,
|
||||
value_fn=lambda state: state == OverkizCommandParam.OPEN,
|
||||
),
|
||||
# Unknown
|
||||
OverkizBinarySensorDescription(
|
||||
key=OverkizState.IO_VIBRATION_DETECTED,
|
||||
name="Vibration",
|
||||
device_class=BinarySensorDeviceClass.VIBRATION,
|
||||
value_fn=lambda state: state == OverkizCommandParam.DETECTED,
|
||||
),
|
||||
]
|
||||
|
||||
|
||||
async def async_setup_entry(
|
||||
hass: HomeAssistant,
|
||||
entry: ConfigEntry,
|
||||
async_add_entities: AddEntitiesCallback,
|
||||
):
|
||||
"""Set up the Overkiz binary sensors from a config entry."""
|
||||
data: HomeAssistantOverkizData = hass.data[DOMAIN][entry.entry_id]
|
||||
entities: list[OverkizBinarySensor] = []
|
||||
|
||||
key_supported_states = {
|
||||
description.key: description for description in BINARY_SENSOR_DESCRIPTIONS
|
||||
}
|
||||
|
||||
for device in data.coordinator.data.values():
|
||||
if (
|
||||
device.widget in IGNORED_OVERKIZ_DEVICES
|
||||
or device.ui_class in IGNORED_OVERKIZ_DEVICES
|
||||
):
|
||||
continue
|
||||
|
||||
for state in device.definition.states:
|
||||
if description := key_supported_states.get(state.qualified_name):
|
||||
entities.append(
|
||||
OverkizBinarySensor(
|
||||
device.device_url,
|
||||
data.coordinator,
|
||||
description,
|
||||
)
|
||||
)
|
||||
|
||||
async_add_entities(entities)
|
||||
|
||||
|
||||
class OverkizBinarySensor(OverkizDescriptiveEntity, BinarySensorEntity):
|
||||
"""Representation of an Overkiz Binary Sensor."""
|
||||
|
||||
entity_description: OverkizBinarySensorDescription
|
||||
|
||||
@property
|
||||
def is_on(self) -> bool | None:
|
||||
"""Return the state of the sensor."""
|
||||
if state := self.device.states.get(self.entity_description.key):
|
||||
return self.entity_description.value_fn(state.value)
|
||||
|
||||
return None
|
|
@ -18,6 +18,7 @@ UPDATE_INTERVAL: Final = timedelta(seconds=30)
|
|||
UPDATE_INTERVAL_ALL_ASSUMED_STATE: Final = timedelta(minutes=60)
|
||||
|
||||
PLATFORMS: list[Platform] = [
|
||||
Platform.BINARY_SENSOR,
|
||||
Platform.BUTTON,
|
||||
Platform.LIGHT,
|
||||
Platform.LOCK,
|
||||
|
|
Loading…
Add table
Reference in a new issue