sensor.py

Go to the documentation of this file.

"""Support for Ombi."""
 
from __future__ import annotations
 
from datetime import timedelta
import logging
 
from pyombi import OmbiError
 
from homeassistant.components.sensor import SensorEntity, SensorEntityDescription
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
from .const import DOMAIN
 
_LOGGER = logging.getLogger(__name__)
 
SCAN_INTERVAL = timedelta(seconds=60)
 
 
SENSOR_TYPES: tuple[SensorEntityDescription, ...] = (
    SensorEntityDescription(
        key="movies",
        name="Movie requests",
        icon="mdi:movie",
    ),
    SensorEntityDescription(
        key="tv",
        name="TV show requests",
        icon="mdi:television-classic",
    ),
    SensorEntityDescription(
        key="music",
        name="Music album requests",
        icon="mdi:album",
    ),
    SensorEntityDescription(
        key="pending",
        name="Pending requests",
        icon="mdi:clock-alert-outline",
    ),
    SensorEntityDescription(
        key="approved",
        name="Approved requests",
        icon="mdi:check",
    ),
    SensorEntityDescription(
        key="available",
        name="Available requests",
        icon="mdi:download",
    ),
)
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the Ombi sensor platform."""
    if discovery_info is None:
        return
 
    ombi = hass.data[DOMAIN]["instance"]
 
    entities = [OmbiSensor(ombi, description) for description in SENSOR_TYPES]
 
    add_entities(entities, True)
 
 
class OmbiSensor(SensorEntity):
    """Representation of an Ombi sensor."""
 
    def __init__(self, ombi, description: SensorEntityDescription) -> None:
        """Initialize the sensor."""
        self.entity_descriptionentity_description = description
        self._ombi_ombi = ombi
 
        self._attr_name_attr_name = f"Ombi {description.name}"
 
    def update(self) -> None:
        """Update the sensor."""
        try:
            sensor_type = self.entity_descriptionentity_description.key
            if sensor_type == "movies":
                self._attr_native_value_attr_native_value = self._ombi_ombi.movie_requests
            elif sensor_type == "tv":
                self._attr_native_value_attr_native_value = self._ombi_ombi.tv_requests
            elif sensor_type == "music":
                self._attr_native_value_attr_native_value = self._ombi_ombi.music_requests
            elif sensor_type == "pending":
                self._attr_native_value_attr_native_value = self._ombi_ombi.total_requests["pending"]
            elif sensor_type == "approved":
                self._attr_native_value_attr_native_value = self._ombi_ombi.total_requests["approved"]
            elif sensor_type == "available":
                self._attr_native_value_attr_native_value = self._ombi_ombi.total_requests["available"]
        except OmbiError as err:
            _LOGGER.warning("Unable to update Ombi sensor: %s", err)
            self._attr_native_value_attr_native_value = None