core/homeassistant/components/oncue/entity.py

83 lines
3.1 KiB
Python

"""Support for Oncue sensors."""
from __future__ import annotations
from aiooncue import OncueDevice, OncueSensor
from homeassistant.const import ATTR_CONNECTIONS
from homeassistant.helpers import device_registry as dr
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity import Entity, EntityDescription
from homeassistant.helpers.update_coordinator import (
CoordinatorEntity,
DataUpdateCoordinator,
)
from .const import CONNECTION_ESTABLISHED_KEY, DOMAIN, VALUE_UNAVAILABLE
class OncueEntity(
CoordinatorEntity[DataUpdateCoordinator[dict[str, OncueDevice]]], Entity
):
"""Representation of an Oncue entity."""
_attr_has_entity_name = True
def __init__(
self,
coordinator: DataUpdateCoordinator[dict[str, OncueDevice]],
device_id: str,
device: OncueDevice,
sensor: OncueSensor,
description: EntityDescription,
) -> None:
"""Initialize the sensor."""
super().__init__(coordinator)
self.entity_description = description
self._device_id = device_id
self._attr_unique_id = f"{device_id}_{description.key}"
self._attr_name = sensor.display_name
self._attr_device_info = DeviceInfo(
identifiers={(DOMAIN, device_id)},
name=device.name,
hw_version=device.hardware_version,
sw_version=device.sensors["FirmwareVersion"].display_value,
model=device.sensors["GensetModelNumberSelect"].display_value,
manufacturer="Kohler",
)
try:
mac_address_hex = hex(int(device.sensors["MacAddress"].value))[2:]
except ValueError: # MacAddress may be invalid if the gateway is offline
return
self._attr_device_info[ATTR_CONNECTIONS] = {
(dr.CONNECTION_NETWORK_MAC, mac_address_hex)
}
@property
def _oncue_value(self) -> str:
"""Return the sensor value."""
device: OncueDevice = self.coordinator.data[self._device_id]
sensor: OncueSensor = device.sensors[self.entity_description.key]
return sensor.value
@property
def available(self) -> bool:
"""Return if entity is available."""
# The binary sensor that tracks the connection should not go unavailable.
if self.entity_description.key != CONNECTION_ESTABLISHED_KEY:
# If Kohler returns -- the entity is unavailable.
if self._oncue_value == VALUE_UNAVAILABLE:
return False
# If the cloud is reporting that the generator is not connected
# this also indicates the data is not available.
# The battery voltage sensor reports 0.0 rather than
# -- hence the purpose of this check.
device: OncueDevice = self.coordinator.data[self._device_id]
conn_established: OncueSensor = device.sensors[CONNECTION_ESTABLISHED_KEY]
if (
conn_established is not None
and conn_established.value == VALUE_UNAVAILABLE
):
return False
return super().available