sensor.py

"""Platform for sensor integration."""
from __future__ import annotations

import logging

from homeassistant.components.sensor import (
    SensorDeviceClass,
    SensorEntity,
    SensorStateClass
)
from homeassistant.const import CURRENCY_CENT
from homeassistant.core import HomeAssistant
from homeassistant.helpers.typing import DiscoveryInfoType
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.config_entries import ConfigEntry

from fuelwatcher import FuelWatch
from .const import DOMAIN

_LOGGER = logging.getLogger(DOMAIN)

async def async_setup_entry(
    hass: HomeAssistant,
    config: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None
) -> None:
    """Set up the sensor platform."""
    async_add_entities([
        FuelPrice(hass, config),
        FuelStationName(hass, config),
        FuelStationLocation(hass, config),
        FuelStationAddress(hass, config)
    ])

class FuelWatchSensor(SensorEntity):
    """Base class for FuelWatch sensors."""

    api = FuelWatch()

    def __init__(
            self,
            hass: HomeAssistant,
            config_entries: ConfigEntry,
            attr_name: str,
            xml_key: str
        ):

        self._hass = hass
        self._attr_name = attr_name
        self._attr_unique_id = f"sensor.fuelwatchwa_{xml_key.lower()}"
        self.xml_query = None
        self._attr_native_value = None

        self._fuel_type = config_entries.data['product']
        self._suburb = config_entries.data['suburb']
        self._day = config_entries.data['day']
        self._xml_key = xml_key

    @property
    def fuel_type(self) -> int:
        """Return the Fuel Type specified"""
        return self._fuel_type

    @property
    def suburb(self) -> str:
        """Return the Suburb for the fuel search"""
        return self._suburb

    @property
    def day(self) -> str:
        """Return the day of the fuel price"""
        return self._day

    def update(self) -> None:
        """Fetch new state data for the sensor.
        This is the only method that should fetch new data for Home Assistant.
        """
        self.api.query(product=self._fuel_type, suburb=self._suburb, day=self._day)
        self.xml_query = self.api.get_xml
        self._attr_native_value = self.xml_query[0][self._xml_key]


class FuelPrice(FuelWatchSensor):
    """Representation of a Sensor for the cheapest fuel price today."""

    _attr_native_unit_of_measurement = CURRENCY_CENT
    _attr_device_class = SensorDeviceClass.MONETARY
    _attr_state_class = SensorStateClass.MEASUREMENT

    def __init__(self, hass: HomeAssistant, config_entries: ConfigEntry) -> None:
        super().__init__(
            hass=hass,
            config_entries=config_entries,
            attr_name="Fuel Cheapest Price",
            xml_key="price"
        )


class FuelStationName(FuelWatchSensor):
    """Representation of a Sensor for the station name."""

    def __init__(self, hass: HomeAssistant, config_entries: ConfigEntry) -> None:
        super().__init__(
            hass=hass,
            config_entries=config_entries,
            attr_name="Fuel Station Name",
            xml_key="brand"
        )


class FuelStationLocation(FuelWatchSensor):
    """Representation of a Sensor for the station location."""

    def __init__(self, hass: HomeAssistant, config_entries: ConfigEntry) -> None:
        super().__init__(
            hass=hass,
            config_entries=config_entries,
            attr_name="Fuel Station Suburb",
            xml_key="location"
        )


class FuelStationAddress(FuelWatchSensor):
    """Representation of a Sensor for the station address."""

    def __init__(self, hass: HomeAssistant, config_entries: ConfigEntry) -> None:
        super().__init__(
            hass=hass,
            config_entries=config_entries,
            attr_name="Fuel Station Address",
            xml_key="address"
        )