6a8c732b37
* Add Tailscale integration * Use DeviceEntryType * Fix tests * Adjust to new Pylint version * Use enums for device classes * Update homeassistant/components/tailscale/config_flow.py Co-authored-by: Martin Hjelmare <marhje52@gmail.com> * Pass empty string as default Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
112 lines
3.4 KiB
Python
112 lines
3.4 KiB
Python
"""Support for Tailscale binary sensors."""
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Callable
|
|
from dataclasses import dataclass
|
|
|
|
from tailscale import Device as TailscaleDevice
|
|
|
|
from homeassistant.components.binary_sensor import (
|
|
BinarySensorDeviceClass,
|
|
BinarySensorEntity,
|
|
BinarySensorEntityDescription,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.device_registry import DeviceEntryType
|
|
from homeassistant.helpers.entity import DeviceInfo
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.helpers.update_coordinator import (
|
|
CoordinatorEntity,
|
|
DataUpdateCoordinator,
|
|
)
|
|
|
|
from .const import DOMAIN
|
|
|
|
|
|
@dataclass
|
|
class TailscaleBinarySensorEntityDescriptionMixin:
|
|
"""Mixin for required keys."""
|
|
|
|
is_on_fn: Callable[[TailscaleDevice], bool | None]
|
|
|
|
|
|
@dataclass
|
|
class TailscaleBinarySensorEntityDescription(
|
|
BinarySensorEntityDescription, TailscaleBinarySensorEntityDescriptionMixin
|
|
):
|
|
"""Describes a Tailscale binary sensor entity."""
|
|
|
|
|
|
BINARY_SENSORS: tuple[TailscaleBinarySensorEntityDescription, ...] = (
|
|
TailscaleBinarySensorEntityDescription(
|
|
key="update_available",
|
|
name="Client",
|
|
device_class=BinarySensorDeviceClass.UPDATE,
|
|
is_on_fn=lambda device: device.update_available,
|
|
),
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up a Tailscale binary sensors based on a config entry."""
|
|
coordinator = hass.data[DOMAIN][entry.entry_id]
|
|
async_add_entities(
|
|
TailscaleBinarySensorEntity(
|
|
coordinator=coordinator,
|
|
device=device,
|
|
description=description,
|
|
)
|
|
for device in coordinator.data.values()
|
|
for description in BINARY_SENSORS
|
|
)
|
|
|
|
|
|
class TailscaleBinarySensorEntity(CoordinatorEntity, BinarySensorEntity):
|
|
"""Defines a Tailscale binary sensor."""
|
|
|
|
entity_description: TailscaleBinarySensorEntityDescription
|
|
|
|
def __init__(
|
|
self,
|
|
*,
|
|
coordinator: DataUpdateCoordinator,
|
|
device: TailscaleDevice,
|
|
description: TailscaleBinarySensorEntityDescription,
|
|
) -> None:
|
|
"""Initialize a Tailscale binary sensor."""
|
|
super().__init__(coordinator=coordinator)
|
|
self.entity_description = description
|
|
self.device_id = device.device_id
|
|
self._attr_name = f"{device.hostname} {description.name}"
|
|
self._attr_unique_id = f"{device.device_id}_{description.key}"
|
|
|
|
@property
|
|
def device_info(self) -> DeviceInfo:
|
|
"""Return the device info."""
|
|
device: TailscaleDevice = self.coordinator.data[self.device_id]
|
|
|
|
configuration_url = "https://login.tailscale.com/admin/machines/"
|
|
if device.addresses:
|
|
configuration_url += device.addresses[0]
|
|
|
|
return DeviceInfo(
|
|
configuration_url=configuration_url,
|
|
entry_type=DeviceEntryType.SERVICE,
|
|
identifiers={(DOMAIN, device.device_id)},
|
|
manufacturer="Tailscale Inc.",
|
|
model=device.os,
|
|
name=device.hostname,
|
|
sw_version=device.client_version,
|
|
)
|
|
|
|
@property
|
|
def is_on(self) -> bool:
|
|
"""Return the state of the sensor."""
|
|
return bool(
|
|
self.entity_description.is_on_fn(self.coordinator.data[self.device_id])
|
|
)
|