sensor.py

Go to the documentation of this file.

"""Support for a Emonitor channel sensor."""
 
from __future__ import annotations
 
from aioemonitor.monitor import EmonitorChannel, EmonitorStatus
 
from homeassistant.components.sensor import (
    SensorDeviceClass,
    SensorEntity,
    SensorEntityDescription,
    SensorStateClass,
)
from homeassistant.const import UnitOfPower
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers import device_registry as dr
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import (
    CoordinatorEntity,
    DataUpdateCoordinator,
)
 
from . import EmonitorConfigEntry, name_short_mac
 
SENSORS = (
    SensorEntityDescription(key="inst_power"),
    SensorEntityDescription(
        key="avg_power",
        translation_key="average",
        entity_registry_enabled_default=False,
    ),
    SensorEntityDescription(
        key="max_power", translation_key="max", entity_registry_enabled_default=False
    ),
)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: EmonitorConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up entry."""
    coordinator = config_entry.runtime_data
    channels = coordinator.data.channels
    entities: list[EmonitorPowerSensor] = []
    seen_channels = set()
    for channel_number, channel in channels.items():
        seen_channels.add(channel_number)
        if not channel.active:
            continue
        if channel.paired_with_channel in seen_channels:
            continue
 
        entities.extend(
            EmonitorPowerSensor(coordinator, description, channel_number)
            for description in SENSORS
        )
 
    async_add_entities(entities)
 
 
class EmonitorPowerSensor(CoordinatorEntity[EmonitorStatus], SensorEntity):
    """Representation of an Emonitor power sensor entity."""
 
    _attr_device_class = SensorDeviceClass.POWER
    _attr_native_unit_of_measurement = UnitOfPower.WATT
    _attr_state_class = SensorStateClass.MEASUREMENT
    _attr_has_entity_name = True
 
    def __init__(
        self,
        coordinator: DataUpdateCoordinator,
        description: SensorEntityDescription,
        channel_number: int,
    ) -> None:
        """Initialize the channel sensor."""
        self.entity_descriptionentity_description = description
        self.channel_numberchannel_number = channel_number
        super().__init__(coordinator)
        emonitor_status = self.coordinator.data
        mac_address = emonitor_status.network.mac_address
        device_name = name_short_mac(mac_address[-6:])
        label = self.channel_datachannel_data.label or str(channel_number)
        if description.translation_key is not None:
            self._attr_translation_placeholders_attr_translation_placeholders = {"label": label}
            self._attr_unique_id_attr_unique_id = f"{mac_address}_{channel_number}_{description.key}"
        else:
            self._attr_name_attr_name = label
            self._attr_unique_id_attr_unique_id = f"{mac_address}_{channel_number}"
        self._attr_device_info_attr_device_info = DeviceInfo(
            connections={(dr.CONNECTION_NETWORK_MAC, mac_address)},
            manufacturer="Powerhouse Dynamics, Inc.",
            name=device_name,
            sw_version=emonitor_status.hardware.firmware_version,
        )
        self._attr_extra_state_attributes_attr_extra_state_attributes = {"channel": channel_number}
        self._attr_native_value_attr_native_value = self._paired_attr_paired_attr(self.entity_descriptionentity_description.key)
 
    @property
    def channels(self) -> dict[int, EmonitorChannel]:
        """Return the channels dict."""
        channels: dict[int, EmonitorChannel] = self.coordinator.data.channels
        return channels
 
    @property
    def channel_data(self) -> EmonitorChannel:
        """Return the channel data."""
        return self.channelschannels[self.channel_numberchannel_number]
 
    def _paired_attr(self, attr_name: str) -> float:
        """Cumulative attributes for channel and paired channel."""
        channel_data = self.channelschannels[self.channel_numberchannel_number]
        attr_val = getattr(channel_data, attr_name)
        if paired_channel := channel_data.paired_with_channel:
            attr_val += getattr(self.channelschannels[paired_channel], attr_name)
        return attr_val
 
    @callback
    def _handle_coordinator_update(self) -> None:
        """Handle updated data from the coordinator."""
        self._attr_native_value_attr_native_value = self._paired_attr_paired_attr(self.entity_descriptionentity_description.key)
        return super()._handle_coordinator_update()