374 lines
13 KiB
Python
374 lines
13 KiB
Python
"""Support for the NextDNS service."""
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Callable
|
|
from dataclasses import dataclass
|
|
from typing import Generic
|
|
|
|
from nextdns import (
|
|
AnalyticsDnssec,
|
|
AnalyticsEncryption,
|
|
AnalyticsIpVersions,
|
|
AnalyticsProtocols,
|
|
AnalyticsStatus,
|
|
)
|
|
|
|
from homeassistant.components.sensor import (
|
|
SensorEntity,
|
|
SensorEntityDescription,
|
|
SensorStateClass,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import PERCENTAGE
|
|
from homeassistant.core import HomeAssistant, callback
|
|
from homeassistant.helpers.entity import EntityCategory
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.helpers.typing import StateType
|
|
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
|
|
|
from . import CoordinatorDataT, NextDnsUpdateCoordinator
|
|
from .const import (
|
|
ATTR_DNSSEC,
|
|
ATTR_ENCRYPTION,
|
|
ATTR_IP_VERSIONS,
|
|
ATTR_PROTOCOLS,
|
|
ATTR_STATUS,
|
|
DOMAIN,
|
|
)
|
|
|
|
PARALLEL_UPDATES = 1
|
|
|
|
|
|
@dataclass
|
|
class NextDnsSensorRequiredKeysMixin(Generic[CoordinatorDataT]):
|
|
"""Class for NextDNS entity required keys."""
|
|
|
|
coordinator_type: str
|
|
value: Callable[[CoordinatorDataT], StateType]
|
|
|
|
|
|
@dataclass
|
|
class NextDnsSensorEntityDescription(
|
|
SensorEntityDescription,
|
|
NextDnsSensorRequiredKeysMixin[CoordinatorDataT],
|
|
):
|
|
"""NextDNS sensor entity description."""
|
|
|
|
|
|
SENSORS: tuple[NextDnsSensorEntityDescription, ...] = (
|
|
NextDnsSensorEntityDescription[AnalyticsStatus](
|
|
key="all_queries",
|
|
coordinator_type=ATTR_STATUS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
icon="mdi:dns",
|
|
name="DNS queries",
|
|
native_unit_of_measurement="queries",
|
|
state_class=SensorStateClass.TOTAL,
|
|
value=lambda data: data.all_queries,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsStatus](
|
|
key="blocked_queries",
|
|
coordinator_type=ATTR_STATUS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
icon="mdi:dns",
|
|
name="DNS queries blocked",
|
|
native_unit_of_measurement="queries",
|
|
state_class=SensorStateClass.TOTAL,
|
|
value=lambda data: data.blocked_queries,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsStatus](
|
|
key="relayed_queries",
|
|
coordinator_type=ATTR_STATUS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
icon="mdi:dns",
|
|
name="DNS queries relayed",
|
|
native_unit_of_measurement="queries",
|
|
state_class=SensorStateClass.TOTAL,
|
|
value=lambda data: data.relayed_queries,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsStatus](
|
|
key="blocked_queries_ratio",
|
|
coordinator_type=ATTR_STATUS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
icon="mdi:dns",
|
|
name="DNS queries blocked ratio",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value=lambda data: data.blocked_queries_ratio,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsProtocols](
|
|
key="doh_queries",
|
|
coordinator_type=ATTR_PROTOCOLS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:dns",
|
|
name="DNS-over-HTTPS queries",
|
|
native_unit_of_measurement="queries",
|
|
state_class=SensorStateClass.TOTAL,
|
|
value=lambda data: data.doh_queries,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsProtocols](
|
|
key="doh3_queries",
|
|
coordinator_type=ATTR_PROTOCOLS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:dns",
|
|
name="DNS-over-HTTP/3 queries",
|
|
native_unit_of_measurement="queries",
|
|
state_class=SensorStateClass.TOTAL,
|
|
value=lambda data: data.doh3_queries,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsProtocols](
|
|
key="dot_queries",
|
|
coordinator_type=ATTR_PROTOCOLS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:dns",
|
|
name="DNS-over-TLS queries",
|
|
native_unit_of_measurement="queries",
|
|
state_class=SensorStateClass.TOTAL,
|
|
value=lambda data: data.dot_queries,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsProtocols](
|
|
key="doq_queries",
|
|
coordinator_type=ATTR_PROTOCOLS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:dns",
|
|
name="DNS-over-QUIC queries",
|
|
native_unit_of_measurement="queries",
|
|
state_class=SensorStateClass.TOTAL,
|
|
value=lambda data: data.doq_queries,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsProtocols](
|
|
key="tcp_queries",
|
|
coordinator_type=ATTR_PROTOCOLS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:dns",
|
|
name="TCP queries",
|
|
native_unit_of_measurement="queries",
|
|
state_class=SensorStateClass.TOTAL,
|
|
value=lambda data: data.tcp_queries,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsProtocols](
|
|
key="udp_queries",
|
|
coordinator_type=ATTR_PROTOCOLS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:dns",
|
|
name="UDP queries",
|
|
native_unit_of_measurement="queries",
|
|
state_class=SensorStateClass.TOTAL,
|
|
value=lambda data: data.udp_queries,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsProtocols](
|
|
key="doh_queries_ratio",
|
|
coordinator_type=ATTR_PROTOCOLS,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:dns",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
name="DNS-over-HTTPS queries ratio",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value=lambda data: data.doh_queries_ratio,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsProtocols](
|
|
key="doh3_queries_ratio",
|
|
coordinator_type=ATTR_PROTOCOLS,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:dns",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
name="DNS-over-HTTP/3 queries ratio",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value=lambda data: data.doh3_queries_ratio,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsProtocols](
|
|
key="dot_queries_ratio",
|
|
coordinator_type=ATTR_PROTOCOLS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:dns",
|
|
name="DNS-over-TLS queries ratio",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value=lambda data: data.dot_queries_ratio,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsProtocols](
|
|
key="doq_queries_ratio",
|
|
coordinator_type=ATTR_PROTOCOLS,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:dns",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
name="DNS-over-QUIC queries ratio",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value=lambda data: data.doq_queries_ratio,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsProtocols](
|
|
key="tcp_queries_ratio",
|
|
coordinator_type=ATTR_PROTOCOLS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:dns",
|
|
name="TCP queries ratio",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value=lambda data: data.tcp_queries_ratio,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsProtocols](
|
|
key="udp_queries_ratio",
|
|
coordinator_type=ATTR_PROTOCOLS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:dns",
|
|
name="UDP queries ratio",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value=lambda data: data.udp_queries_ratio,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsEncryption](
|
|
key="encrypted_queries",
|
|
coordinator_type=ATTR_ENCRYPTION,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:lock",
|
|
name="Encrypted queries",
|
|
native_unit_of_measurement="queries",
|
|
state_class=SensorStateClass.TOTAL,
|
|
value=lambda data: data.encrypted_queries,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsEncryption](
|
|
key="unencrypted_queries",
|
|
coordinator_type=ATTR_ENCRYPTION,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:lock-open",
|
|
name="Unencrypted queries",
|
|
native_unit_of_measurement="queries",
|
|
state_class=SensorStateClass.TOTAL,
|
|
value=lambda data: data.unencrypted_queries,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsEncryption](
|
|
key="encrypted_queries_ratio",
|
|
coordinator_type=ATTR_ENCRYPTION,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:lock",
|
|
name="Encrypted queries ratio",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value=lambda data: data.encrypted_queries_ratio,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsIpVersions](
|
|
key="ipv4_queries",
|
|
coordinator_type=ATTR_IP_VERSIONS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:ip",
|
|
name="IPv4 queries",
|
|
native_unit_of_measurement="queries",
|
|
state_class=SensorStateClass.TOTAL,
|
|
value=lambda data: data.ipv4_queries,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsIpVersions](
|
|
key="ipv6_queries",
|
|
coordinator_type=ATTR_IP_VERSIONS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:ip",
|
|
name="IPv6 queries",
|
|
native_unit_of_measurement="queries",
|
|
state_class=SensorStateClass.TOTAL,
|
|
value=lambda data: data.ipv6_queries,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsIpVersions](
|
|
key="ipv6_queries_ratio",
|
|
coordinator_type=ATTR_IP_VERSIONS,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:ip",
|
|
name="IPv6 queries ratio",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value=lambda data: data.ipv6_queries_ratio,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsDnssec](
|
|
key="validated_queries",
|
|
coordinator_type=ATTR_DNSSEC,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:lock-check",
|
|
name="DNSSEC validated queries",
|
|
native_unit_of_measurement="queries",
|
|
state_class=SensorStateClass.TOTAL,
|
|
value=lambda data: data.validated_queries,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsDnssec](
|
|
key="not_validated_queries",
|
|
coordinator_type=ATTR_DNSSEC,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:lock-alert",
|
|
name="DNSSEC not validated queries",
|
|
native_unit_of_measurement="queries",
|
|
state_class=SensorStateClass.TOTAL,
|
|
value=lambda data: data.not_validated_queries,
|
|
),
|
|
NextDnsSensorEntityDescription[AnalyticsDnssec](
|
|
key="validated_queries_ratio",
|
|
coordinator_type=ATTR_DNSSEC,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
icon="mdi:lock-check",
|
|
name="DNSSEC validated queries ratio",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value=lambda data: data.validated_queries_ratio,
|
|
),
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Add a NextDNS entities from a config_entry."""
|
|
sensors: list[NextDnsSensor] = []
|
|
coordinators = hass.data[DOMAIN][entry.entry_id]
|
|
|
|
for description in SENSORS:
|
|
sensors.append(
|
|
NextDnsSensor(coordinators[description.coordinator_type], description)
|
|
)
|
|
|
|
async_add_entities(sensors)
|
|
|
|
|
|
class NextDnsSensor(
|
|
CoordinatorEntity[NextDnsUpdateCoordinator[CoordinatorDataT]], SensorEntity
|
|
):
|
|
"""Define an NextDNS sensor."""
|
|
|
|
_attr_has_entity_name = True
|
|
|
|
def __init__(
|
|
self,
|
|
coordinator: NextDnsUpdateCoordinator[CoordinatorDataT],
|
|
description: NextDnsSensorEntityDescription,
|
|
) -> None:
|
|
"""Initialize."""
|
|
super().__init__(coordinator)
|
|
self._attr_device_info = coordinator.device_info
|
|
self._attr_unique_id = f"{coordinator.profile_id}_{description.key}"
|
|
self._attr_native_value = description.value(coordinator.data)
|
|
self.entity_description: NextDnsSensorEntityDescription = description
|
|
|
|
@callback
|
|
def _handle_coordinator_update(self) -> None:
|
|
"""Handle updated data from the coordinator."""
|
|
self._attr_native_value = self.entity_description.value(self.coordinator.data)
|
|
self.async_write_ha_state()
|