-
-
Notifications
You must be signed in to change notification settings - Fork 29.9k
/
binary_sensor.py
91 lines (70 loc) · 2.64 KB
/
binary_sensor.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
"""Support for getting status from a Pi-hole system."""
from __future__ import annotations
from collections.abc import Callable
from dataclasses import dataclass
from typing import Any
from hole import Hole
from homeassistant.components.binary_sensor import (
BinarySensorEntity,
BinarySensorEntityDescription,
)
from homeassistant.const import CONF_NAME
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
from . import PiHoleConfigEntry, PiHoleEntity
@dataclass(frozen=True, kw_only=True)
class PiHoleBinarySensorEntityDescription(BinarySensorEntityDescription):
"""Describes PiHole binary sensor entity."""
state_value: Callable[[Hole], bool]
extra_value: Callable[[Hole], dict[str, Any] | None] = lambda api: None
BINARY_SENSOR_TYPES: tuple[PiHoleBinarySensorEntityDescription, ...] = (
PiHoleBinarySensorEntityDescription(
key="status",
translation_key="status",
state_value=lambda api: bool(api.data.get("status") == "enabled"),
),
)
async def async_setup_entry(
hass: HomeAssistant,
entry: PiHoleConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up the Pi-hole binary sensor."""
name = entry.data[CONF_NAME]
hole_data = entry.runtime_data
binary_sensors = [
PiHoleBinarySensor(
hole_data.api,
hole_data.coordinator,
name,
entry.entry_id,
description,
)
for description in BINARY_SENSOR_TYPES
]
async_add_entities(binary_sensors, True)
class PiHoleBinarySensor(PiHoleEntity, BinarySensorEntity):
"""Representation of a Pi-hole binary sensor."""
entity_description: PiHoleBinarySensorEntityDescription
_attr_has_entity_name = True
def __init__(
self,
api: Hole,
coordinator: DataUpdateCoordinator[None],
name: str,
server_unique_id: str,
description: PiHoleBinarySensorEntityDescription,
) -> None:
"""Initialize a Pi-hole sensor."""
super().__init__(api, coordinator, name, server_unique_id)
self.entity_description = description
self._attr_unique_id = f"{self._server_unique_id}/{description.key}"
@property
def is_on(self) -> bool:
"""Return if the service is on."""
return self.entity_description.state_value(self.api)
@property
def extra_state_attributes(self) -> dict[str, Any] | None:
"""Return the state attributes of the Pi-hole."""
return self.entity_description.extra_value(self.api)