1
mirror of https://github.com/home-assistant/core synced 2024-08-28 03:36:46 +02:00
ha-core/homeassistant/components/plugwise/select.py
Erik Montnemery 0c2485bc03
Freeze integration entity descriptions (#105984)
Co-authored-by: J. Nick Koston <nick@koston.org>
2023-12-18 16:28:13 -10:00

106 lines
3.5 KiB
Python

"""Plugwise Select component for Home Assistant."""
from __future__ import annotations
from collections.abc import Awaitable, Callable
from dataclasses import dataclass
from plugwise import Smile
from homeassistant.components.select import SelectEntity, SelectEntityDescription
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import STATE_ON, EntityCategory
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .const import DOMAIN, SelectOptionsType, SelectType
from .coordinator import PlugwiseDataUpdateCoordinator
from .entity import PlugwiseEntity
@dataclass(frozen=True, kw_only=True)
class PlugwiseSelectEntityDescription(SelectEntityDescription):
"""Class describing Plugwise Select entities."""
command: Callable[[Smile, str, str], Awaitable[None]]
key: SelectType
options_key: SelectOptionsType
SELECT_TYPES = (
PlugwiseSelectEntityDescription(
key="select_schedule",
translation_key="select_schedule",
icon="mdi:calendar-clock",
command=lambda api, loc, opt: api.set_schedule_state(loc, STATE_ON, opt),
options_key="available_schedules",
),
PlugwiseSelectEntityDescription(
key="select_regulation_mode",
translation_key="regulation_mode",
icon="mdi:hvac",
entity_category=EntityCategory.CONFIG,
command=lambda api, loc, opt: api.set_regulation_mode(opt),
options_key="regulation_modes",
),
PlugwiseSelectEntityDescription(
key="select_dhw_mode",
translation_key="dhw_mode",
icon="mdi:shower",
entity_category=EntityCategory.CONFIG,
command=lambda api, loc, opt: api.set_dhw_mode(opt),
options_key="dhw_modes",
),
)
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up the Smile selector from a config entry."""
coordinator: PlugwiseDataUpdateCoordinator = hass.data[DOMAIN][
config_entry.entry_id
]
entities: list[PlugwiseSelectEntity] = []
for device_id, device in coordinator.data.devices.items():
for description in SELECT_TYPES:
if description.options_key in device:
entities.append(
PlugwiseSelectEntity(coordinator, device_id, description)
)
async_add_entities(entities)
class PlugwiseSelectEntity(PlugwiseEntity, SelectEntity):
"""Represent Smile selector."""
entity_description: PlugwiseSelectEntityDescription
def __init__(
self,
coordinator: PlugwiseDataUpdateCoordinator,
device_id: str,
entity_description: PlugwiseSelectEntityDescription,
) -> None:
"""Initialise the selector."""
super().__init__(coordinator, device_id)
self.entity_description = entity_description
self._attr_unique_id = f"{device_id}-{entity_description.key}"
self._attr_options = self.device[entity_description.options_key]
@property
def current_option(self) -> str:
"""Return the selected entity option to represent the entity state."""
return self.device[self.entity_description.key]
async def async_select_option(self, option: str) -> None:
"""Change to the selected entity option."""
await self.entity_description.command(
self.coordinator.api, self.device["location"], option
)
await self.coordinator.async_request_refresh()