binary_sensor.py

Go to the documentation of this file.

"""Support for MAX! binary sensors via MAX! Cube."""
 
from __future__ import annotations
 
from homeassistant.components.binary_sensor import (
    BinarySensorDeviceClass,
    BinarySensorEntity,
)
from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
from . import DATA_KEY
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Iterate through all MAX! Devices and add window shutters."""
    devices: list[MaxCubeBinarySensorBase] = []
    for handler in hass.data[DATA_KEY].values():
        for device in handler.cube.devices:
            devices.append(MaxCubeBattery(handler, device))
            # Only add Window Shutters
            if device.is_windowshutter():
                devices.append(MaxCubeShutter(handler, device))
 
    add_entities(devices)
 
 
class MaxCubeBinarySensorBase(BinarySensorEntity):
    """Base class for maxcube binary sensors."""
 
    _attr_entity_category = EntityCategory.DIAGNOSTIC
 
    def __init__(self, handler, device):
        """Initialize MAX! Cube BinarySensorEntity."""
        self._cubehandle_cubehandle = handler
        self._device_device = device
        self._room_room = handler.cube.room_by_id(device.room_id)
 
    def update(self) -> None:
        """Get latest data from MAX! Cube."""
        self._cubehandle_cubehandle.update()
 
 
class MaxCubeShutter(MaxCubeBinarySensorBase):
    """Representation of a MAX! Cube Binary Sensor device."""
 
    _attr_device_class = BinarySensorDeviceClass.WINDOW
 
    def __init__(self, handler, device):
        """Initialize MAX! Cube BinarySensorEntity."""
        super().__init__(handler, device)
 
        self._attr_name_attr_name = f"{self._room.name} {self._device.name}"
        self._attr_unique_id_attr_unique_id = self._device_device.serial
 
    @property
    def is_on(self):
        """Return true if the binary sensor is on/open."""
        return self._device_device.is_open
 
 
class MaxCubeBattery(MaxCubeBinarySensorBase):
    """Representation of a MAX! Cube Binary Sensor device."""
 
    _attr_device_class = BinarySensorDeviceClass.BATTERY
 
    def __init__(self, handler, device):
        """Initialize MAX! Cube BinarySensorEntity."""
        super().__init__(handler, device)
 
        self._attr_name_attr_name = f"{self._room.name} {device.name} battery"
        self._attr_unique_id_attr_unique_id = f"{self._device.serial}_battery"
 
    @property
    def is_on(self):
        """Return true if the binary sensor is on/open."""
        return self._device_device.battery == 1