sensor.py

Go to the documentation of this file.

"""Support for Flick Electric Pricing data."""
 
import asyncio
from datetime import timedelta
import logging
from typing import Any
 
from pyflick import FlickAPI, FlickPrice
 
from homeassistant.components.sensor import SensorEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CURRENCY_CENT, UnitOfEnergy
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.util.dt import utcnow
 
from .const import ATTR_COMPONENTS, ATTR_END_AT, ATTR_START_AT, DOMAIN
 
_LOGGER = logging.getLogger(__name__)
 
SCAN_INTERVAL = timedelta(minutes=5)
 
 
async def async_setup_entry(
    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
    """Flick Sensor Setup."""
    api: FlickAPI = hass.data[DOMAIN][entry.entry_id]
 
    async_add_entities([FlickPricingSensor(api)], True)
 
 
class FlickPricingSensor(SensorEntity):
    """Entity object for Flick Electric sensor."""
 
    _attr_attribution = "Data provided by Flick Electric"
    _attr_native_unit_of_measurement = f"{CURRENCY_CENT}/{UnitOfEnergy.KILO_WATT_HOUR}"
    _attr_has_entity_name = True
    _attr_translation_key = "power_price"
    _attributes: dict[str, Any] = {}
 
    def __init__(self, api: FlickAPI) -> None:
        """Entity object for Flick Electric sensor."""
        self._api: FlickAPI = api
        self._price_price: FlickPrice = None
 
    @property
    def native_value(self):
        """Return the state of the sensor."""
        return self._price_price.price
 
    @property
    def extra_state_attributes(self):
        """Return the state attributes."""
        return self._attributes
 
    async def async_update(self) -> None:
        """Get the Flick Pricing data from the web service."""
        if self._price_price and self._price_price.end_at >= utcnow():
            return  # Power price data is still valid
 
        async with asyncio.timeout(60):
            self._price_price = await self._api.getPricing()
 
        _LOGGER.debug("Pricing data: %s", self._price_price)
 
        self._attributes[ATTR_START_AT] = self._price_price.start_at
        self._attributes[ATTR_END_AT] = self._price_price.end_at
        for component in self._price_price.components:
            if component.charge_setter not in ATTR_COMPONENTS:
                _LOGGER.warning("Found unknown component: %s", component.charge_setter)
                continue
 
            self._attributes[component.charge_setter] = float(component.value)