binary_sensor.py

Go to the documentation of this file.

"""Support for Lutron Caseta Occupancy/Vacancy Sensors."""
 
from pylutron_caseta import OCCUPANCY_GROUP_OCCUPIED
 
from homeassistant.components.binary_sensor import (
    BinarySensorDeviceClass,
    BinarySensorEntity,
)
from homeassistant.const import ATTR_SUGGESTED_AREA
from homeassistant.core import HomeAssistant
from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from . import DOMAIN as CASETA_DOMAIN
from .const import CONFIG_URL, MANUFACTURER, UNASSIGNED_AREA
from .entity import LutronCasetaEntity
from .models import LutronCasetaConfigEntry
from .util import area_name_from_id
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: LutronCasetaConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the Lutron Caseta binary_sensor platform.
 
    Adds occupancy groups from the Caseta bridge associated with the
    config_entry as binary_sensor entities.
    """
    data = config_entry.runtime_data
    bridge = data.bridge
    occupancy_groups = bridge.occupancy_groups
    async_add_entities(
        LutronOccupancySensor(occupancy_group, data)
        for occupancy_group in occupancy_groups.values()
    )
 
 
class LutronOccupancySensor(LutronCasetaEntity, BinarySensorEntity):
    """Representation of a Lutron occupancy group."""
 
    _attr_device_class = BinarySensorDeviceClass.OCCUPANCY
 
    def __init__(self, device, data):
        """Init an occupancy sensor."""
        super().__init__(device, data)
        area = area_name_from_id(self._smartbridge_smartbridge.areas, device["area"])
        name = f"{area} {device['device_name']}"
        self._attr_name_attr_name_attr_name = name
        self._attr_device_info_attr_device_info_attr_device_info = DeviceInfo(
            identifiers={(CASETA_DOMAIN, self.unique_idunique_idunique_idunique_id)},
            manufacturer=MANUFACTURER,
            model="Lutron Occupancy",
            name=self.namename,
            via_device=(CASETA_DOMAIN, self._bridge_device_bridge_device["serial"]),
            configuration_url=CONFIG_URL,
            entry_type=DeviceEntryType.SERVICE,
        )
        if area != UNASSIGNED_AREA:
            self._attr_device_info_attr_device_info_attr_device_info[ATTR_SUGGESTED_AREA] = area
 
    @property
    def is_on(self):
        """Return the brightness of the light."""
        return self._device_device["status"] == OCCUPANCY_GROUP_OCCUPIED
 
    # pylint: disable-next=hass-missing-super-call
    async def async_added_to_hass(self) -> None:
        """Register callbacks."""
        self._smartbridge_smartbridge.add_occupancy_subscriber(
            self.device_iddevice_iddevice_id, self.async_write_ha_stateasync_write_ha_state
        )
 
    @property
    def device_id(self):
        """Return the device ID used for calling pylutron_caseta."""
        return self._device_device["occupancy_group_id"]
 
    @property
    def unique_id(self):
        """Return a unique identifier."""
        return f"occupancygroup_{self._bridge_unique_id}_{self.device_id}"
 
    @property
    def extra_state_attributes(self):
        """Return the state attributes."""
        return {"device_id": self.device_iddevice_iddevice_id}