core/homeassistant/components/onewire/binary_sensor.py

122 lines
3.6 KiB
Python

"""Support for 1-Wire binary sensors."""
from __future__ import annotations
from dataclasses import dataclass
import os
from typing import TYPE_CHECKING
from homeassistant.components.binary_sensor import (
BinarySensorEntity,
BinarySensorEntityDescription,
)
from homeassistant.components.onewire.model import OWServerDeviceDescription
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_TYPE
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .const import (
CONF_TYPE_OWSERVER,
DEVICE_KEYS_0_7,
DEVICE_KEYS_A_B,
DOMAIN,
READ_MODE_BOOL,
)
from .onewire_entities import OneWireEntityDescription, OneWireProxyEntity
from .onewirehub import OneWireHub
@dataclass
class OneWireBinarySensorEntityDescription(
OneWireEntityDescription, BinarySensorEntityDescription
):
"""Class describing OneWire binary sensor entities."""
DEVICE_BINARY_SENSORS: dict[str, tuple[OneWireBinarySensorEntityDescription, ...]] = {
"12": tuple(
OneWireBinarySensorEntityDescription(
key=f"sensed.{id}",
entity_registry_enabled_default=False,
name=f"Sensed {id}",
read_mode=READ_MODE_BOOL,
)
for id in DEVICE_KEYS_A_B
),
"29": tuple(
OneWireBinarySensorEntityDescription(
key=f"sensed.{id}",
entity_registry_enabled_default=False,
name=f"Sensed {id}",
read_mode=READ_MODE_BOOL,
)
for id in DEVICE_KEYS_0_7
),
"3A": tuple(
OneWireBinarySensorEntityDescription(
key=f"sensed.{id}",
entity_registry_enabled_default=False,
name=f"Sensed {id}",
read_mode=READ_MODE_BOOL,
)
for id in DEVICE_KEYS_A_B
),
}
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up 1-Wire platform."""
# Only OWServer implementation works with binary sensors
if config_entry.data[CONF_TYPE] == CONF_TYPE_OWSERVER:
onewirehub = hass.data[DOMAIN][config_entry.entry_id]
entities = await hass.async_add_executor_job(get_entities, onewirehub)
async_add_entities(entities, True)
def get_entities(onewirehub: OneWireHub) -> list[BinarySensorEntity]:
"""Get a list of entities."""
if not onewirehub.devices:
return []
entities: list[BinarySensorEntity] = []
for device in onewirehub.devices:
if TYPE_CHECKING:
assert isinstance(device, OWServerDeviceDescription)
family = device.family
device_id = device.id
device_info = device.device_info
if family not in DEVICE_BINARY_SENSORS:
continue
for description in DEVICE_BINARY_SENSORS[family]:
device_file = os.path.join(os.path.split(device.path)[0], description.key)
name = f"{device_id} {description.name}"
entities.append(
OneWireProxyBinarySensor(
description=description,
device_id=device_id,
device_file=device_file,
device_info=device_info,
name=name,
owproxy=onewirehub.owproxy,
)
)
return entities
class OneWireProxyBinarySensor(OneWireProxyEntity, BinarySensorEntity):
"""Implementation of a 1-Wire binary sensor."""
entity_description: OneWireBinarySensorEntityDescription
@property
def is_on(self) -> bool:
"""Return true if sensor is on."""
return bool(self._state)