hassio-bluetti-bt/custom_components/bluetti_bt/sensor.py

"""Bluetti BT sensors."""

from __future__ import annotations
from enum import Enum

import logging
from decimal import Decimal

from homeassistant.components.sensor import SensorEntity, CONF_STATE_CLASS
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.const import (
    CONF_ADDRESS,
    CONF_NAME,
    CONF_UNIT_OF_MEASUREMENT,
    CONF_DEVICE_CLASS,
    EntityCategory,
)
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.entity import DeviceInfo
from homeassistant.helpers.update_coordinator import (
    CoordinatorEntity,
)

from bluetti_mqtt.bluetooth import build_device
from bluetti_mqtt.mqtt_client import (
    NORMAL_DEVICE_FIELDS,
    DC_INPUT_FIELDS,
    MqttFieldType,
)

from . import device_info as dev_info, get_unique_id
from .const import DATA_COORDINATOR, DOMAIN, CONF_OPTIONS, DIAGNOSTIC_FIELDS, ADDITIONAL_DEVICE_FIELDS
from .coordinator import PollingCoordinator, DummyDevice
from .utils import unique_id_loggable

_LOGGER = logging.getLogger(__name__)


async def async_setup_entry(
    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
    """Setup sensor entities."""

    device_name = entry.data.get(CONF_NAME)
    address = entry.data.get(CONF_ADDRESS)
    if address is None:
        _LOGGER.error("Device has no address")

    # Generate device info
    _LOGGER.info("Creating sensors for device with address %s", address)
    device_info = dev_info(entry)

    # Add sensors according to device_info
    bluetti_device = build_device(address, device_name)
    bluetti_device = DummyDevice(bluetti_device)

    sensors_to_add = []
    all_fields = NORMAL_DEVICE_FIELDS
    all_fields.update(DC_INPUT_FIELDS)
    all_fields.update(ADDITIONAL_DEVICE_FIELDS)
    for field_key, field_config in all_fields.items():
        if bluetti_device.has_field(field_key):
            category = None
            if field_config.setter is True or field_key in DIAGNOSTIC_FIELDS:
                category = EntityCategory.DIAGNOSTIC
            if field_config.type == MqttFieldType.NUMERIC:
                sensors_to_add.append(
                    BluettiSensor(
                        hass.data[DOMAIN][entry.entry_id][DATA_COORDINATOR],
                        device_info,
                        address,
                        field_key,
                        field_config.home_assistant_extra.get(CONF_NAME, ""),
                        field_config.home_assistant_extra.get(CONF_UNIT_OF_MEASUREMENT),
                        field_config.home_assistant_extra.get(CONF_DEVICE_CLASS),
                        field_config.home_assistant_extra.get(CONF_STATE_CLASS),
                        category=category,
                    )
                )
            elif field_config.type == MqttFieldType.ENUM:
                sensors_to_add.append(
                    BluettiSensor(
                        hass.data[DOMAIN][entry.entry_id][DATA_COORDINATOR],
                        device_info,
                        address,
                        field_key,
                        field_config.home_assistant_extra.get(CONF_NAME, ""),
                        options=field_config.home_assistant_extra.get(CONF_OPTIONS),
                        category=category,
                    )
                )

    async_add_entities(sensors_to_add)


class BluettiSensor(CoordinatorEntity, SensorEntity):
    """Bluetti universal sensor."""

    def __init__(
        self,
        coordinator: PollingCoordinator,
        device_info: DeviceInfo,
        address,
        response_key: str,
        name: str,
        unit_of_measurement: str | None = None,
        device_class: str | None = None,
        state_class: str | None = None,
        category: EntityCategory | None = None,
        options: list[str] | None = None,
    ):
        """Init battery entity."""
        super().__init__(coordinator)

        e_name = f"{device_info.get('name')} {name}"
        self._address = address
        self._response_key = response_key

        self._attr_device_info = device_info
        self._attr_name = e_name
        self._attr_available = False
        self._attr_unique_id = get_unique_id(e_name)
        self._attr_native_unit_of_measurement = unit_of_measurement
        self._attr_device_class = device_class
        self._attr_state_class = state_class
        self._attr_entity_category = category
        self._options = options

    @callback
    def _handle_coordinator_update(self) -> None:
        """Handle updated data from the coordinator."""

        if not self.coordinator.client.is_connected:
            return

        _LOGGER.debug("Updating state of %s", unique_id_loggable(self._attr_unique_id))
        if not isinstance(self.coordinator.data, dict):
            _LOGGER.debug(
                "Invalid data from coordinator (sensor.%s)", unique_id_loggable(self._attr_unique_id)
            )
            self._attr_available = False
            return

        response_data = self.coordinator.data.get(self._response_key)
        if response_data is None:
            self._attr_available = False
            return

        if (
            not isinstance(response_data, int)
            and not isinstance(response_data, float)
            and not isinstance(response_data, complex)
            and not isinstance(response_data, Decimal)
            and not isinstance(response_data, Enum)
        ):
            _LOGGER.warning(
                "Invalid response data type from coordinator (sensor.%s): %s has type %s",
                unique_id_loggable(self._attr_unique_id),
                response_data,
                type(response_data),
            )
            self._attr_available = False
            return

        self._attr_available = True

        # Different for enum and numeric
        if (
            self._options is not None
            and isinstance(response_data, Enum)
            and response_data.value < len(self._options)
        ):
            # Enum
            self._attr_native_value = self._options[response_data.value]
        else:
            # Numeric
            self._attr_native_value = response_data
        self.async_write_ha_state()