select.py

Go to the documentation of this file.

"""Platform for Kostal Plenticore select widgets."""
 
from __future__ import annotations
 
from dataclasses import dataclass
from datetime import timedelta
import logging
 
from homeassistant.components.select import SelectEntity, SelectEntityDescription
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
from .const import DOMAIN
from .coordinator import Plenticore, SelectDataUpdateCoordinator
 
_LOGGER = logging.getLogger(__name__)
 
 
@dataclass(frozen=True, kw_only=True)
class PlenticoreSelectEntityDescription(SelectEntityDescription):
    """A class that describes plenticore select entities."""
 
    module_id: str
 
 
SELECT_SETTINGS_DATA = [
    PlenticoreSelectEntityDescription(
        module_id="devices:local",
        key="battery_charge",
        name="Battery Charging / Usage mode",
        options=[
            "None",
            "Battery:SmartBatteryControl:Enable",
            "Battery:TimeControl:Enable",
        ],
    )
]
 
 
async def async_setup_entry(
    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
    """Add kostal plenticore Select widget."""
    plenticore: Plenticore = hass.data[DOMAIN][entry.entry_id]
 
    available_settings_data = await plenticore.client.get_settings()
    select_data_update_coordinator = SelectDataUpdateCoordinator(
        hass,
        _LOGGER,
        "Settings Data",
        timedelta(seconds=30),
        plenticore,
    )
 
    entities = []
    for description in SELECT_SETTINGS_DATA:
        assert description.options is not None
        if description.module_id not in available_settings_data:
            continue
        needed_data_ids = {
            data_id for data_id in description.options if data_id != "None"
        }
        available_data_ids = {
            setting.id for setting in available_settings_data[description.module_id]
        }
        if not needed_data_ids <= available_data_ids:
            continue
        entities.append(
            PlenticoreDataSelect(
                select_data_update_coordinator,
                description,
                entry_id=entry.entry_id,
                platform_name=entry.title,
                device_info=plenticore.device_info,
            )
        )
 
    async_add_entities(entities)
 
 
class PlenticoreDataSelect(
    CoordinatorEntity[SelectDataUpdateCoordinator], SelectEntity
):
    """Representation of a Plenticore Select."""
 
    _attr_entity_category = EntityCategory.CONFIG
    entity_description: PlenticoreSelectEntityDescription
 
    def __init__(
        self,
        coordinator: SelectDataUpdateCoordinator,
        description: PlenticoreSelectEntityDescription,
        entry_id: str,
        platform_name: str,
        device_info: DeviceInfo,
    ) -> None:
        """Create a new Select Entity for Plenticore process data."""
        super().__init__(coordinator)
        self.entity_descriptionentity_description = description
        self.entry_identry_id = entry_id
        self.platform_nameplatform_name = platform_name
        self.module_idmodule_id = description.module_id
        self.data_iddata_id = description.key
        self._attr_device_info_attr_device_info = device_info
        self._attr_unique_id_attr_unique_id = f"{entry_id}_{description.module_id}"
 
    @property
    def available(self) -> bool:
        """Return if entity is available."""
        return (
            super().available
            and self.coordinator.data is not None
            and self.module_idmodule_id in self.coordinator.data
            and self.data_iddata_id in self.coordinator.data[self.module_idmodule_id]
        )
 
    async def async_added_to_hass(self) -> None:
        """Register this entity on the Update Coordinator."""
        await super().async_added_to_hass()
        self.async_on_removeasync_on_remove(
            self.coordinator.start_fetch_data(
                self.module_idmodule_id, self.data_iddata_id, self.optionsoptions
            )
        )
 
    async def async_will_remove_from_hass(self) -> None:
        """Unregister this entity from the Update Coordinator."""
        self.coordinator.stop_fetch_data(self.module_idmodule_id, self.data_iddata_id, self.optionsoptions)
        await super().async_will_remove_from_hass()
 
    async def async_select_option(self, option: str) -> None:
        """Update the current selected option."""
        for all_option in self.optionsoptions:
            if all_option != "None":
                await self.coordinator.async_write_data(
                    self.module_idmodule_id, {all_option: "0"}
                )
        if option != "None":
            await self.coordinator.async_write_data(self.module_idmodule_id, {option: "1"})
        self.async_write_ha_stateasync_write_ha_state()
 
    @property
    def current_option(self) -> str | None:
        """Return the selected entity option to represent the entity state."""
        if self.availableavailableavailableavailable:
            return self.coordinator.data[self.module_idmodule_id][self.data_iddata_id]
 
        return None