153 lines
5.0 KiB
Python
153 lines
5.0 KiB
Python
"""Plugwise Binary Sensor component for Home Assistant."""
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Mapping
|
|
from dataclasses import dataclass
|
|
from typing import Any
|
|
|
|
from homeassistant.components.binary_sensor import (
|
|
BinarySensorEntity,
|
|
BinarySensorEntityDescription,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity import EntityCategory
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
|
|
from .const import DOMAIN
|
|
from .coordinator import PlugwiseDataUpdateCoordinator
|
|
from .entity import PlugwiseEntity
|
|
|
|
SEVERITIES = ["other", "info", "warning", "error"]
|
|
|
|
|
|
@dataclass
|
|
class PlugwiseBinarySensorEntityDescription(BinarySensorEntityDescription):
|
|
"""Describes a Plugwise binary sensor entity."""
|
|
|
|
icon_off: str | None = None
|
|
|
|
|
|
BINARY_SENSORS: tuple[PlugwiseBinarySensorEntityDescription, ...] = (
|
|
PlugwiseBinarySensorEntityDescription(
|
|
key="dhw_state",
|
|
name="DHW State",
|
|
icon="mdi:water-pump",
|
|
icon_off="mdi:water-pump-off",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
),
|
|
PlugwiseBinarySensorEntityDescription(
|
|
key="flame_state",
|
|
name="Flame State",
|
|
icon="mdi:fire",
|
|
icon_off="mdi:fire-off",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
),
|
|
PlugwiseBinarySensorEntityDescription(
|
|
key="heating_state",
|
|
name="Heating",
|
|
icon="mdi:radiator",
|
|
icon_off="mdi:radiator-off",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
),
|
|
PlugwiseBinarySensorEntityDescription(
|
|
key="cooling_state",
|
|
name="Cooling",
|
|
icon="mdi:snowflake",
|
|
icon_off="mdi:snowflake-off",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
),
|
|
PlugwiseBinarySensorEntityDescription(
|
|
key="slave_boiler_state",
|
|
name="Secondary Boiler State",
|
|
icon="mdi:fire",
|
|
icon_off="mdi:circle-off-outline",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
),
|
|
PlugwiseBinarySensorEntityDescription(
|
|
key="plugwise_notification",
|
|
name="Plugwise Notification",
|
|
icon="mdi:mailbox-up-outline",
|
|
icon_off="mdi:mailbox-outline",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
),
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up the Smile binary_sensors from a config entry."""
|
|
coordinator: PlugwiseDataUpdateCoordinator = hass.data[DOMAIN][
|
|
config_entry.entry_id
|
|
]
|
|
|
|
entities: list[PlugwiseBinarySensorEntity] = []
|
|
for device_id, device in coordinator.data.devices.items():
|
|
for description in BINARY_SENSORS:
|
|
if description.key not in device and (
|
|
"binary_sensors" not in device
|
|
or description.key not in device["binary_sensors"]
|
|
):
|
|
continue
|
|
|
|
entities.append(
|
|
PlugwiseBinarySensorEntity(
|
|
coordinator,
|
|
device_id,
|
|
description,
|
|
)
|
|
)
|
|
async_add_entities(entities)
|
|
|
|
|
|
class PlugwiseBinarySensorEntity(PlugwiseEntity, BinarySensorEntity):
|
|
"""Represent Smile Binary Sensors."""
|
|
|
|
entity_description: PlugwiseBinarySensorEntityDescription
|
|
|
|
def __init__(
|
|
self,
|
|
coordinator: PlugwiseDataUpdateCoordinator,
|
|
device_id: str,
|
|
description: PlugwiseBinarySensorEntityDescription,
|
|
) -> None:
|
|
"""Initialise the binary_sensor."""
|
|
super().__init__(coordinator, device_id)
|
|
self.entity_description = description
|
|
self._attr_unique_id = f"{device_id}-{description.key}"
|
|
self._attr_name = (f"{self.device.get('name', '')} {description.name}").lstrip()
|
|
|
|
@property
|
|
def is_on(self) -> bool | None:
|
|
"""Return true if the binary sensor is on."""
|
|
if self.entity_description.key in self.device:
|
|
return self.device[self.entity_description.key]
|
|
return self.device["binary_sensors"].get(self.entity_description.key)
|
|
|
|
@property
|
|
def icon(self) -> str | None:
|
|
"""Return the icon to use in the frontend, if any."""
|
|
if (icon_off := self.entity_description.icon_off) and self.is_on is False:
|
|
return icon_off
|
|
return self.entity_description.icon
|
|
|
|
@property
|
|
def extra_state_attributes(self) -> Mapping[str, Any] | None:
|
|
"""Return entity specific state attributes."""
|
|
if self.entity_description.key != "plugwise_notification":
|
|
return None
|
|
|
|
attrs: dict[str, list[str]] = {f"{severity}_msg": [] for severity in SEVERITIES}
|
|
if notify := self.coordinator.data.gateway["notifications"]:
|
|
for details in notify.values():
|
|
for msg_type, msg in details.items():
|
|
msg_type = msg_type.lower()
|
|
if msg_type not in SEVERITIES:
|
|
msg_type = "other"
|
|
attrs[f"{msg_type}_msg"].append(msg)
|
|
|
|
return attrs
|