mirror of
https://github.com/home-assistant/core.git
synced 2025-11-13 04:50:17 +00:00
Add apsystems diagnostic binary sensors (#123045)
* add diagnostic sensors * select output_data from data * split sensor and binary_sensor configurations * adjust module description * convert values to bool * add strings * add tests * add tests * update translations * remove already available _attr_has_entity_name * use dataclass instead of TypedDict * Update tests/components/apsystems/test_binary_sensor.py --------- Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
This commit is contained in:
102
homeassistant/components/apsystems/binary_sensor.py
Normal file
102
homeassistant/components/apsystems/binary_sensor.py
Normal file
@@ -0,0 +1,102 @@
|
||||
"""The read-only binary sensors for APsystems local API integration."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from collections.abc import Callable
|
||||
from dataclasses import dataclass
|
||||
|
||||
from APsystemsEZ1 import ReturnAlarmInfo
|
||||
|
||||
from homeassistant.components.binary_sensor import (
|
||||
BinarySensorDeviceClass,
|
||||
BinarySensorEntity,
|
||||
BinarySensorEntityDescription,
|
||||
)
|
||||
from homeassistant.const import EntityCategory
|
||||
from homeassistant.core import HomeAssistant
|
||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
||||
|
||||
from . import ApSystemsConfigEntry, ApSystemsData
|
||||
from .coordinator import ApSystemsDataCoordinator
|
||||
from .entity import ApSystemsEntity
|
||||
|
||||
|
||||
@dataclass(frozen=True, kw_only=True)
|
||||
class ApsystemsLocalApiBinarySensorDescription(BinarySensorEntityDescription):
|
||||
"""Describes Apsystens Inverter binary sensor entity."""
|
||||
|
||||
is_on: Callable[[ReturnAlarmInfo], bool | None]
|
||||
|
||||
|
||||
BINARY_SENSORS: tuple[ApsystemsLocalApiBinarySensorDescription, ...] = (
|
||||
ApsystemsLocalApiBinarySensorDescription(
|
||||
key="off_grid_status",
|
||||
translation_key="off_grid_status",
|
||||
device_class=BinarySensorDeviceClass.PROBLEM,
|
||||
entity_category=EntityCategory.DIAGNOSTIC,
|
||||
is_on=lambda c: bool(c.og),
|
||||
),
|
||||
ApsystemsLocalApiBinarySensorDescription(
|
||||
key="dc_1_short_circuit_error_status",
|
||||
translation_key="dc_1_short_circuit_error_status",
|
||||
device_class=BinarySensorDeviceClass.PROBLEM,
|
||||
entity_category=EntityCategory.DIAGNOSTIC,
|
||||
is_on=lambda c: bool(c.isce1),
|
||||
),
|
||||
ApsystemsLocalApiBinarySensorDescription(
|
||||
key="dc_2_short_circuit_error_status",
|
||||
translation_key="dc_2_short_circuit_error_status",
|
||||
device_class=BinarySensorDeviceClass.PROBLEM,
|
||||
entity_category=EntityCategory.DIAGNOSTIC,
|
||||
is_on=lambda c: bool(c.isce2),
|
||||
),
|
||||
ApsystemsLocalApiBinarySensorDescription(
|
||||
key="output_fault_status",
|
||||
translation_key="output_fault_status",
|
||||
device_class=BinarySensorDeviceClass.PROBLEM,
|
||||
entity_category=EntityCategory.DIAGNOSTIC,
|
||||
is_on=lambda c: bool(c.oe),
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
async def async_setup_entry(
|
||||
hass: HomeAssistant,
|
||||
config_entry: ApSystemsConfigEntry,
|
||||
add_entities: AddEntitiesCallback,
|
||||
) -> None:
|
||||
"""Set up the binary sensor platform."""
|
||||
config = config_entry.runtime_data
|
||||
|
||||
add_entities(
|
||||
ApSystemsBinarySensorWithDescription(
|
||||
data=config,
|
||||
entity_description=desc,
|
||||
)
|
||||
for desc in BINARY_SENSORS
|
||||
)
|
||||
|
||||
|
||||
class ApSystemsBinarySensorWithDescription(
|
||||
CoordinatorEntity[ApSystemsDataCoordinator], ApSystemsEntity, BinarySensorEntity
|
||||
):
|
||||
"""Base binary sensor to be used with description."""
|
||||
|
||||
entity_description: ApsystemsLocalApiBinarySensorDescription
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
data: ApSystemsData,
|
||||
entity_description: ApsystemsLocalApiBinarySensorDescription,
|
||||
) -> None:
|
||||
"""Initialize the sensor."""
|
||||
super().__init__(data.coordinator)
|
||||
ApSystemsEntity.__init__(self, data)
|
||||
self.entity_description = entity_description
|
||||
self._attr_unique_id = f"{data.device_id}_{entity_description.key}"
|
||||
|
||||
@property
|
||||
def is_on(self) -> bool | None:
|
||||
"""Return value of sensor."""
|
||||
return self.entity_description.is_on(self.coordinator.data.alarm_info)
|
||||
Reference in New Issue
Block a user