1
mirror of https://github.com/home-assistant/core synced 2024-08-28 03:36:46 +02:00
ha-core/homeassistant/components/tailscale/sensor.py
Erik Montnemery 0c2485bc03
Freeze integration entity descriptions (#105984)
Co-authored-by: J. Nick Koston <nick@koston.org>
2023-12-18 16:28:13 -10:00

82 lines
2.4 KiB
Python

"""Support for Tailscale sensors."""
from __future__ import annotations
from collections.abc import Callable
from dataclasses import dataclass
from datetime import datetime
from tailscale import Device as TailscaleDevice
from homeassistant.components.sensor import (
SensorDeviceClass,
SensorEntity,
SensorEntityDescription,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import TailscaleEntity
from .const import DOMAIN
@dataclass(frozen=True, kw_only=True)
class TailscaleSensorEntityDescription(SensorEntityDescription):
"""Describes a Tailscale sensor entity."""
value_fn: Callable[[TailscaleDevice], datetime | str | None]
SENSORS: tuple[TailscaleSensorEntityDescription, ...] = (
TailscaleSensorEntityDescription(
key="expires",
translation_key="expires",
device_class=SensorDeviceClass.TIMESTAMP,
entity_category=EntityCategory.DIAGNOSTIC,
value_fn=lambda device: device.expires,
),
TailscaleSensorEntityDescription(
key="ip",
translation_key="ip",
icon="mdi:ip-network",
entity_category=EntityCategory.DIAGNOSTIC,
value_fn=lambda device: device.addresses[0] if device.addresses else None,
),
TailscaleSensorEntityDescription(
key="last_seen",
translation_key="last_seen",
device_class=SensorDeviceClass.TIMESTAMP,
value_fn=lambda device: device.last_seen,
),
)
async def async_setup_entry(
hass: HomeAssistant,
entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up a Tailscale sensors based on a config entry."""
coordinator = hass.data[DOMAIN][entry.entry_id]
async_add_entities(
TailscaleSensorEntity(
coordinator=coordinator,
device=device,
description=description,
)
for device in coordinator.data.values()
for description in SENSORS
)
class TailscaleSensorEntity(TailscaleEntity, SensorEntity):
"""Defines a Tailscale sensor."""
entity_description: TailscaleSensorEntityDescription
@property
def native_value(self) -> datetime | str | None:
"""Return the state of the sensor."""
return self.entity_description.value_fn(self.coordinator.data[self.device_id])