number.py

Go to the documentation of this file.

"""Number platform for BMW."""
 
from collections.abc import Callable, Coroutine
from dataclasses import dataclass
import logging
from typing import Any
 
from bimmer_connected.models import MyBMWAPIError
from bimmer_connected.vehicle import MyBMWVehicle
 
from homeassistant.components.number import (
    NumberDeviceClass,
    NumberEntity,
    NumberEntityDescription,
    NumberMode,
)
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from . import BMWConfigEntry
from .coordinator import BMWDataUpdateCoordinator
from .entity import BMWBaseEntity
 
_LOGGER = logging.getLogger(__name__)
 
 
@dataclass(frozen=True, kw_only=True)
class BMWNumberEntityDescription(NumberEntityDescription):
    """Describes BMW number entity."""
 
    value_fn: Callable[[MyBMWVehicle], float | int | None]
    remote_service: Callable[[MyBMWVehicle, float | int], Coroutine[Any, Any, Any]]
    is_available: Callable[[MyBMWVehicle], bool] = lambda _: False
    dynamic_options: Callable[[MyBMWVehicle], list[str]] | None = None
 
 
NUMBER_TYPES: list[BMWNumberEntityDescription] = [
    BMWNumberEntityDescription(
        key="target_soc",
        translation_key="target_soc",
        device_class=NumberDeviceClass.BATTERY,
        is_available=lambda v: v.is_remote_set_target_soc_enabled,
        native_max_value=100.0,
        native_min_value=20.0,
        native_step=5.0,
        mode=NumberMode.SLIDER,
        value_fn=lambda v: v.fuel_and_battery.charging_target,
        remote_service=lambda v, o: v.remote_services.trigger_charging_settings_update(
            target_soc=int(o)
        ),
    ),
]
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: BMWConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the MyBMW number from config entry."""
    coordinator = config_entry.runtime_data.coordinator
 
    entities: list[BMWNumber] = []
 
    for vehicle in coordinator.account.vehicles:
        if not coordinator.read_only:
            entities.extend(
                [
                    BMWNumber(coordinator, vehicle, description)
                    for description in NUMBER_TYPES
                    if description.is_available(vehicle)
                ]
            )
    async_add_entities(entities)
 
 
class BMWNumber(BMWBaseEntity, NumberEntity):
    """Representation of BMW Number entity."""
 
    entity_description: BMWNumberEntityDescription
 
    def __init__(
        self,
        coordinator: BMWDataUpdateCoordinator,
        vehicle: MyBMWVehicle,
        description: BMWNumberEntityDescription,
    ) -> None:
        """Initialize an BMW Number."""
        super().__init__(coordinator, vehicle)
        self.entity_descriptionentity_description = description
        self._attr_unique_id_attr_unique_id = f"{vehicle.vin}-{description.key}"
 
    @property
    def native_value(self) -> float | None:
        """Return the entity value to represent the entity state."""
        return self.entity_descriptionentity_description.value_fn(self.vehiclevehicle)
 
    async def async_set_native_value(self, value: float) -> None:
        """Update to the vehicle."""
        _LOGGER.debug(
            "Executing '%s' on vehicle '%s' to value '%s'",
            self.entity_descriptionentity_description.key,
            self.vehiclevehicle.vin,
            value,
        )
        try:
            await self.entity_descriptionentity_description.remote_service(self.vehiclevehicle, value)
        except MyBMWAPIError as ex:
            raise HomeAssistantError(ex) from ex
 
        self.coordinator.async_update_listeners()