binary_sensor.py

Go to the documentation of this file.

"""Support for the NextDNS service."""
 
from __future__ import annotations
 
from collections.abc import Callable
from dataclasses import dataclass
 
from nextdns import ConnectionStatus
 
from homeassistant.components.binary_sensor import (
    BinarySensorDeviceClass,
    BinarySensorEntity,
    BinarySensorEntityDescription,
)
from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
from . import NextDnsConfigEntry
from .coordinator import NextDnsUpdateCoordinator
 
PARALLEL_UPDATES = 1
 
 
@dataclass(frozen=True, kw_only=True)
class NextDnsBinarySensorEntityDescription(BinarySensorEntityDescription):
    """NextDNS binary sensor entity description."""
 
    state: Callable[[ConnectionStatus, str], bool]
 
 
SENSORS = (
    NextDnsBinarySensorEntityDescription(
        key="this_device_nextdns_connection_status",
        entity_category=EntityCategory.DIAGNOSTIC,
        translation_key="device_connection_status",
        device_class=BinarySensorDeviceClass.CONNECTIVITY,
        state=lambda data, _: data.connected,
    ),
    NextDnsBinarySensorEntityDescription(
        key="this_device_profile_connection_status",
        entity_category=EntityCategory.DIAGNOSTIC,
        translation_key="device_profile_connection_status",
        device_class=BinarySensorDeviceClass.CONNECTIVITY,
        state=lambda data, profile_id: profile_id == data.profile_id,
    ),
)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    entry: NextDnsConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Add NextDNS entities from a config_entry."""
    coordinator = entry.runtime_data.connection
 
    async_add_entities(
        NextDnsBinarySensor(coordinator, description) for description in SENSORS
    )
 
 
class NextDnsBinarySensor(
    CoordinatorEntity[NextDnsUpdateCoordinator[ConnectionStatus]], BinarySensorEntity
):
    """Define an NextDNS binary sensor."""
 
    _attr_has_entity_name = True
    entity_description: NextDnsBinarySensorEntityDescription
 
    def __init__(
        self,
        coordinator: NextDnsUpdateCoordinator[ConnectionStatus],
        description: NextDnsBinarySensorEntityDescription,
    ) -> None:
        """Initialize."""
        super().__init__(coordinator)
        self._attr_device_info_attr_device_info = coordinator.device_info
        self._attr_unique_id_attr_unique_id = f"{coordinator.profile_id}_{description.key}"
        self._attr_is_on_attr_is_on = description.state(coordinator.data, coordinator.profile_id)
        self.entity_descriptionentity_description = description
 
    @callback
    def _handle_coordinator_update(self) -> None:
        """Handle updated data from the coordinator."""
        self._attr_is_on_attr_is_on = self.entity_descriptionentity_description.state(
            self.coordinator.data, self.coordinator.profile_id
        )
        self.async_write_ha_stateasync_write_ha_state()