number.py

Go to the documentation of this file.

"""Support for EZVIZ number controls."""
 
from __future__ import annotations
 
from dataclasses import dataclass
from datetime import timedelta
import logging
 
from pyezviz.constants import SupportExt
from pyezviz.exceptions import (
    EzvizAuthTokenExpired,
    EzvizAuthVerificationCode,
    HTTPError,
    InvalidURL,
    PyEzvizError,
)
 
from homeassistant.components.number import NumberEntity, NumberEntityDescription
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from .const import DATA_COORDINATOR, DOMAIN
from .coordinator import EzvizDataUpdateCoordinator
from .entity import EzvizBaseEntity
 
SCAN_INTERVAL = timedelta(seconds=3600)
PARALLEL_UPDATES = 0
_LOGGER = logging.getLogger(__name__)
 
 
@dataclass(frozen=True, kw_only=True)
class EzvizNumberEntityDescription(NumberEntityDescription):
    """Describe a EZVIZ Number."""
 
    supported_ext: str
    supported_ext_value: list
 
 
NUMBER_TYPE = EzvizNumberEntityDescription(
    key="detection_sensibility",
    translation_key="detection_sensibility",
    entity_category=EntityCategory.CONFIG,
    native_min_value=0,
    native_step=1,
    supported_ext=str(SupportExt.SupportSensibilityAdjust.value),
    supported_ext_value=["1", "3"],
)
 
 
async def async_setup_entry(
    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
    """Set up EZVIZ sensors based on a config entry."""
    coordinator: EzvizDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id][
        DATA_COORDINATOR
    ]
 
    async_add_entities(
        EzvizNumber(coordinator, camera, value, entry.entry_id)
        for camera in coordinator.data
        for capability, value in coordinator.data[camera]["supportExt"].items()
        if capability == NUMBER_TYPE.supported_ext
        if value in NUMBER_TYPE.supported_ext_value
    )
 
 
class EzvizNumber(EzvizBaseEntity, NumberEntity):
    """Representation of a EZVIZ number entity."""
 
    def __init__(
        self,
        coordinator: EzvizDataUpdateCoordinator,
        serial: str,
        value: str,
        config_entry_id: str,
    ) -> None:
        """Initialize the entity."""
        super().__init__(coordinator, serial)
        self.sensitivity_typesensitivity_type = 3 if value == "3" else 0
        self._attr_native_max_value_attr_native_max_value = 100 if value == "3" else 6
        self._attr_unique_id_attr_unique_id = f"{serial}_{NUMBER_TYPE.key}"
        self.entity_descriptionentity_description = NUMBER_TYPE
        self.config_entry_idconfig_entry_id = config_entry_id
        self.sensor_valuesensor_value: int | None = None
 
    async def async_added_to_hass(self) -> None:
        """Run when about to be added to hass."""
        self.async_schedule_update_ha_stateasync_schedule_update_ha_state(True)
 
    @property
    def native_value(self) -> float | None:
        """Return the state of the entity."""
        if self.sensor_valuesensor_value is not None:
            return float(self.sensor_valuesensor_value)
        return None
 
    def set_native_value(self, value: float) -> None:
        """Set camera detection sensitivity."""
        level = int(value)
        try:
            self.coordinatorcoordinator.ezviz_client.detection_sensibility(
                self._serial_serial,
                level,
                self.sensitivity_typesensitivity_type,
            )
 
        except (HTTPError, PyEzvizError) as err:
            raise HomeAssistantError(
                f"Cannot set detection sensitivity level on {self.name}"
            ) from err
 
        self.sensor_valuesensor_value = level
 
    def update(self) -> None:
        """Fetch data from EZVIZ."""
        _LOGGER.debug("Updating %s", self.namename)
        try:
            self.sensor_valuesensor_value = self.coordinatorcoordinator.ezviz_client.get_detection_sensibility(
                self._serial_serial,
                str(self.sensitivity_typesensitivity_type),
            )
 
        except (EzvizAuthTokenExpired, EzvizAuthVerificationCode):
            _LOGGER.debug("Failed to login to EZVIZ API")
            self.hasshass.async_create_task(
                self.hasshass.config_entries.async_reload(self.config_entry_idconfig_entry_id)
            )
            return
 
        except (InvalidURL, HTTPError, PyEzvizError) as error:
            raise HomeAssistantError(f"Invalid response from API: {error}") from error