sensor.py

Go to the documentation of this file.

"""Support for Smart Meter Texas sensors."""
 
from smart_meter_texas import Meter
 
from homeassistant.components.sensor import (
    SensorDeviceClass,
    SensorEntity,
    SensorStateClass,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_ADDRESS, UnitOfEnergy
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.restore_state import RestoreEntity
from homeassistant.helpers.update_coordinator import (
    CoordinatorEntity,
    DataUpdateCoordinator,
)
 
from .const import (
    DATA_COORDINATOR,
    DATA_SMART_METER,
    DOMAIN,
    ELECTRIC_METER,
    ESIID,
    METER_NUMBER,
)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the Smart Meter Texas sensors."""
    coordinator = hass.data[DOMAIN][config_entry.entry_id][DATA_COORDINATOR]
    meters = hass.data[DOMAIN][config_entry.entry_id][DATA_SMART_METER].meters
 
    async_add_entities(
        [SmartMeterTexasSensor(meter, coordinator) for meter in meters], False
    )
 
 
# pylint: disable-next=hass-invalid-inheritance # needs fixing
class SmartMeterTexasSensor(CoordinatorEntity, RestoreEntity, SensorEntity):
    """Representation of an Smart Meter Texas sensor."""
 
    _attr_device_class = SensorDeviceClass.ENERGY
    _attr_state_class = SensorStateClass.TOTAL_INCREASING
    _attr_native_unit_of_measurement = UnitOfEnergy.KILO_WATT_HOUR
    _attr_available = False
 
    def __init__(self, meter: Meter, coordinator: DataUpdateCoordinator) -> None:
        """Initialize the sensor."""
        super().__init__(coordinator)
        self.metermeter = meter
        self._attr_name_attr_name = f"{ELECTRIC_METER} {meter.meter}"
        self._attr_unique_id_attr_unique_id = f"{meter.esiid}_{meter.meter}"
 
    @property
    def extra_state_attributes(self):
        """Return the device specific state attributes."""
        return {
            METER_NUMBER: self.metermeter.meter,
            ESIID: self.metermeter.esiid,
            CONF_ADDRESS: self.metermeter.address,
        }
 
    @callback
    def _state_update(self):
        """Call when the coordinator has an update."""
        self._attr_available_attr_available_attr_available = self.coordinator.last_update_success
        if self._attr_available_attr_available_attr_available:
            self._attr_native_value_attr_native_value = self.metermeter.reading
        self.async_write_ha_stateasync_write_ha_state()
 
    async def async_added_to_hass(self):
        """Subscribe to updates."""
        await super().async_added_to_hass()
        self.async_on_removeasync_on_remove(self.coordinator.async_add_listener(self._state_update_state_update))
 
        # If the background update finished before
        # we added the entity, there is no need to restore
        # state.
        if self.coordinator.last_update_success:
            return
 
        if last_state := await self.async_get_last_stateasync_get_last_state():
            self._attr_native_value_attr_native_value = last_state.state
            self._attr_available_attr_available_attr_available = True