"""Support for 1-Wire binary sensors.""" from __future__ import annotations from dataclasses import dataclass from datetime import timedelta import os from homeassistant.components.binary_sensor import ( BinarySensorDeviceClass, BinarySensorEntity, BinarySensorEntityDescription, ) from homeassistant.const import EntityCategory from homeassistant.core import HomeAssistant from homeassistant.helpers.dispatcher import async_dispatcher_connect from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback from .const import DEVICE_KEYS_0_3, DEVICE_KEYS_0_7, DEVICE_KEYS_A_B, READ_MODE_INT from .entity import OneWireEntity, OneWireEntityDescription from .onewirehub import ( SIGNAL_NEW_DEVICE_CONNECTED, OneWireConfigEntry, OneWireHub, OWDeviceDescription, ) # the library uses non-persistent connections # and concurrent access to the bus is managed by the server PARALLEL_UPDATES = 0 SCAN_INTERVAL = timedelta(seconds=30) @dataclass(frozen=True) class OneWireBinarySensorEntityDescription( OneWireEntityDescription, BinarySensorEntityDescription ): """Class describing OneWire binary sensor entities.""" read_mode = READ_MODE_INT DEVICE_BINARY_SENSORS: dict[str, tuple[OneWireBinarySensorEntityDescription, ...]] = { "12": tuple( OneWireBinarySensorEntityDescription( key=f"sensed.{device_key}", entity_registry_enabled_default=False, translation_key="sensed_id", translation_placeholders={"id": str(device_key)}, ) for device_key in DEVICE_KEYS_A_B ), "29": tuple( OneWireBinarySensorEntityDescription( key=f"sensed.{device_key}", entity_registry_enabled_default=False, translation_key="sensed_id", translation_placeholders={"id": str(device_key)}, ) for device_key in DEVICE_KEYS_0_7 ), "3A": tuple( OneWireBinarySensorEntityDescription( key=f"sensed.{device_key}", entity_registry_enabled_default=False, translation_key="sensed_id", translation_placeholders={"id": str(device_key)}, ) for device_key in DEVICE_KEYS_A_B ), "EF": (), # "HobbyBoard": special } # EF sensors are usually hobbyboards specialized sensors. HOBBYBOARD_EF: dict[str, tuple[OneWireBinarySensorEntityDescription, ...]] = { "HB_HUB": tuple( OneWireBinarySensorEntityDescription( key=f"hub/short.{device_key}", entity_registry_enabled_default=False, entity_category=EntityCategory.DIAGNOSTIC, device_class=BinarySensorDeviceClass.PROBLEM, translation_key="hub_short_id", translation_placeholders={"id": str(device_key)}, ) for device_key in DEVICE_KEYS_0_3 ), } def get_sensor_types( device_sub_type: str, ) -> dict[str, tuple[OneWireBinarySensorEntityDescription, ...]]: """Return the proper info array for the device type.""" if "HobbyBoard" in device_sub_type: return HOBBYBOARD_EF return DEVICE_BINARY_SENSORS async def async_setup_entry( hass: HomeAssistant, config_entry: OneWireConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback, ) -> None: """Set up 1-Wire platform.""" async def _add_entities( hub: OneWireHub, devices: list[OWDeviceDescription] ) -> None: """Add 1-Wire entities for all devices.""" if not devices: return async_add_entities(get_entities(hub, devices), True) hub = config_entry.runtime_data await _add_entities(hub, hub.devices) config_entry.async_on_unload( async_dispatcher_connect(hass, SIGNAL_NEW_DEVICE_CONNECTED, _add_entities) ) def get_entities( onewire_hub: OneWireHub, devices: list[OWDeviceDescription] ) -> list[OneWireBinarySensorEntity]: """Get a list of entities.""" entities: list[OneWireBinarySensorEntity] = [] for device in devices: family = device.family device_id = device.id device_type = device.type device_info = device.device_info device_sub_type = "std" if device_type and "EF" in family: device_sub_type = "HobbyBoard" family = device_type if family not in get_sensor_types(device_sub_type): continue for description in get_sensor_types(device_sub_type)[family]: device_file = os.path.join(os.path.split(device.path)[0], description.key) entities.append( OneWireBinarySensorEntity( description=description, device_id=device_id, device_file=device_file, device_info=device_info, owproxy=onewire_hub.owproxy, ) ) return entities class OneWireBinarySensorEntity(OneWireEntity, BinarySensorEntity): """Implementation of a 1-Wire binary sensor.""" entity_description: OneWireBinarySensorEntityDescription @property def is_on(self) -> bool | None: """Return true if sensor is on.""" if self._state is None: return None return self._state == 1