binary_sensor.py

Go to the documentation of this file.

"""Hue binary sensor entities."""
 
from aiohue.v1.sensors import TYPE_ZLL_PRESENCE
 
from homeassistant.components.binary_sensor import (
    BinarySensorDeviceClass,
    BinarySensorEntity,
)
 
from ..const import DOMAIN as HUE_DOMAIN
from .sensor_base import SENSOR_CONFIG_MAP, GenericZLLSensor
 
PRESENCE_NAME_FORMAT = "{} motion"
 
 
async def async_setup_entry(hass, config_entry, async_add_entities):
    """Defer binary sensor setup to the shared sensor module."""
    bridge = hass.data[HUE_DOMAIN][config_entry.entry_id]
 
    if not bridge.sensor_manager:
        return
 
    await bridge.sensor_manager.async_register_component(
        "binary_sensor", async_add_entities
    )
 
 
# pylint: disable-next=hass-enforce-class-module
class HuePresence(GenericZLLSensor, BinarySensorEntity):
    """The presence sensor entity for a Hue motion sensor device."""
 
    _attr_device_class = BinarySensorDeviceClass.MOTION
 
    @property
    def is_on(self):
        """Return true if the binary sensor is on."""
        return self.sensorsensor.presence
 
    @property
    def extra_state_attributes(self):
        """Return the device state attributes."""
        attributes = super().extra_state_attributes
        if "sensitivity" in self.sensorsensor.config:
            attributes["sensitivity"] = self.sensorsensor.config["sensitivity"]
        if "sensitivitymax" in self.sensorsensor.config:
            attributes["sensitivity_max"] = self.sensorsensor.config["sensitivitymax"]
        return attributes
 
 
SENSOR_CONFIG_MAP.update(
    {
        TYPE_ZLL_PRESENCE: {
            "platform": "binary_sensor",
            "name_format": PRESENCE_NAME_FORMAT,
            "class": HuePresence,
        }
    }
)