forked from home-assistant/core
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add select platform to IronOS (home-assistant#132218)
- Loading branch information
Showing
7 changed files
with
963 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,208 @@ | ||
| """Select platform for IronOS integration.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from collections.abc import Callable | ||
| from dataclasses import dataclass | ||
| from enum import Enum, StrEnum | ||
| from typing import Any | ||
|
|
||
| from pynecil import ( | ||
| AnimationSpeed, | ||
| AutostartMode, | ||
| BatteryType, | ||
| CharSetting, | ||
| CommunicationError, | ||
| LockingMode, | ||
| LogoDuration, | ||
| ScreenOrientationMode, | ||
| ScrollSpeed, | ||
| SettingsDataResponse, | ||
| TempUnit, | ||
| ) | ||
|
|
||
| from homeassistant.components.select import SelectEntity, SelectEntityDescription | ||
| from homeassistant.const import EntityCategory | ||
| from homeassistant.core import HomeAssistant | ||
| from homeassistant.exceptions import ServiceValidationError | ||
| from homeassistant.helpers.entity_platform import AddEntitiesCallback | ||
|
|
||
| from . import IronOSConfigEntry | ||
| from .const import DOMAIN | ||
| from .coordinator import IronOSCoordinators | ||
| from .entity import IronOSBaseEntity | ||
|
|
||
| PARALLEL_UPDATES = 0 | ||
|
|
||
|
|
||
| @dataclass(frozen=True, kw_only=True) | ||
| class IronOSSelectEntityDescription(SelectEntityDescription): | ||
| """Describes IronOS select entity.""" | ||
|
|
||
| value_fn: Callable[[SettingsDataResponse], str | None] | ||
| characteristic: CharSetting | ||
| raw_value_fn: Callable[[str], Any] | None = None | ||
|
|
||
|
|
||
| class PinecilSelect(StrEnum): | ||
| """Select controls for Pinecil device.""" | ||
|
|
||
| MIN_DC_VOLTAGE_CELLS = "min_dc_voltage_cells" | ||
| ORIENTATION_MODE = "orientation_mode" | ||
| ANIMATION_SPEED = "animation_speed" | ||
| AUTOSTART_MODE = "autostart_mode" | ||
| TEMP_UNIT = "temp_unit" | ||
| DESC_SCROLL_SPEED = "desc_scroll_speed" | ||
| LOCKING_MODE = "locking_mode" | ||
| LOGO_DURATION = "logo_duration" | ||
|
|
||
|
|
||
| def enum_to_str(enum: Enum | None) -> str | None: | ||
| """Convert enum name to lower-case string.""" | ||
| return enum.name.lower() if isinstance(enum, Enum) else None | ||
|
|
||
|
|
||
| PINECIL_SELECT_DESCRIPTIONS: tuple[IronOSSelectEntityDescription, ...] = ( | ||
| IronOSSelectEntityDescription( | ||
| key=PinecilSelect.MIN_DC_VOLTAGE_CELLS, | ||
| translation_key=PinecilSelect.MIN_DC_VOLTAGE_CELLS, | ||
| characteristic=CharSetting.MIN_DC_VOLTAGE_CELLS, | ||
| value_fn=lambda x: enum_to_str(x.get("min_dc_voltage_cells")), | ||
| raw_value_fn=lambda value: BatteryType[value.upper()], | ||
| options=[x.name.lower() for x in BatteryType], | ||
| entity_category=EntityCategory.CONFIG, | ||
| entity_registry_enabled_default=False, | ||
| ), | ||
| IronOSSelectEntityDescription( | ||
| key=PinecilSelect.ORIENTATION_MODE, | ||
| translation_key=PinecilSelect.ORIENTATION_MODE, | ||
| characteristic=CharSetting.ORIENTATION_MODE, | ||
| value_fn=lambda x: enum_to_str(x.get("orientation_mode")), | ||
| raw_value_fn=lambda value: ScreenOrientationMode[value.upper()], | ||
| options=[x.name.lower() for x in ScreenOrientationMode], | ||
| entity_category=EntityCategory.CONFIG, | ||
| ), | ||
| IronOSSelectEntityDescription( | ||
| key=PinecilSelect.ANIMATION_SPEED, | ||
| translation_key=PinecilSelect.ANIMATION_SPEED, | ||
| characteristic=CharSetting.ANIMATION_SPEED, | ||
| value_fn=lambda x: enum_to_str(x.get("animation_speed")), | ||
| raw_value_fn=lambda value: AnimationSpeed[value.upper()], | ||
| options=[x.name.lower() for x in AnimationSpeed], | ||
| entity_category=EntityCategory.CONFIG, | ||
| entity_registry_enabled_default=False, | ||
| ), | ||
| IronOSSelectEntityDescription( | ||
| key=PinecilSelect.AUTOSTART_MODE, | ||
| translation_key=PinecilSelect.AUTOSTART_MODE, | ||
| characteristic=CharSetting.AUTOSTART_MODE, | ||
| value_fn=lambda x: enum_to_str(x.get("autostart_mode")), | ||
| raw_value_fn=lambda value: AutostartMode[value.upper()], | ||
| options=[x.name.lower() for x in AutostartMode], | ||
| entity_category=EntityCategory.CONFIG, | ||
| ), | ||
| IronOSSelectEntityDescription( | ||
| key=PinecilSelect.TEMP_UNIT, | ||
| translation_key=PinecilSelect.TEMP_UNIT, | ||
| characteristic=CharSetting.TEMP_UNIT, | ||
| value_fn=lambda x: enum_to_str(x.get("temp_unit")), | ||
| raw_value_fn=lambda value: TempUnit[value.upper()], | ||
| options=[x.name.lower() for x in TempUnit], | ||
| entity_category=EntityCategory.CONFIG, | ||
| entity_registry_enabled_default=False, | ||
| ), | ||
| IronOSSelectEntityDescription( | ||
| key=PinecilSelect.DESC_SCROLL_SPEED, | ||
| translation_key=PinecilSelect.DESC_SCROLL_SPEED, | ||
| characteristic=CharSetting.DESC_SCROLL_SPEED, | ||
| value_fn=lambda x: enum_to_str(x.get("desc_scroll_speed")), | ||
| raw_value_fn=lambda value: ScrollSpeed[value.upper()], | ||
| options=[x.name.lower() for x in ScrollSpeed], | ||
| entity_category=EntityCategory.CONFIG, | ||
| entity_registry_enabled_default=False, | ||
| ), | ||
| IronOSSelectEntityDescription( | ||
| key=PinecilSelect.LOCKING_MODE, | ||
| translation_key=PinecilSelect.LOCKING_MODE, | ||
| characteristic=CharSetting.LOCKING_MODE, | ||
| value_fn=lambda x: enum_to_str(x.get("locking_mode")), | ||
| raw_value_fn=lambda value: LockingMode[value.upper()], | ||
| options=[x.name.lower() for x in LockingMode], | ||
| entity_category=EntityCategory.CONFIG, | ||
| ), | ||
| IronOSSelectEntityDescription( | ||
| key=PinecilSelect.LOGO_DURATION, | ||
| translation_key=PinecilSelect.LOGO_DURATION, | ||
| characteristic=CharSetting.LOGO_DURATION, | ||
| value_fn=lambda x: enum_to_str(x.get("logo_duration")), | ||
| raw_value_fn=lambda value: LogoDuration[value.upper()], | ||
| options=[x.name.lower() for x in LogoDuration], | ||
| entity_category=EntityCategory.CONFIG, | ||
| entity_registry_enabled_default=False, | ||
| ), | ||
| ) | ||
|
|
||
|
|
||
| async def async_setup_entry( | ||
| hass: HomeAssistant, | ||
| entry: IronOSConfigEntry, | ||
| async_add_entities: AddEntitiesCallback, | ||
| ) -> None: | ||
| """Set up select entities from a config entry.""" | ||
| coordinator = entry.runtime_data | ||
|
|
||
| async_add_entities( | ||
| IronOSSelectEntity(coordinator, description) | ||
| for description in PINECIL_SELECT_DESCRIPTIONS | ||
| ) | ||
|
|
||
|
|
||
| class IronOSSelectEntity(IronOSBaseEntity, SelectEntity): | ||
| """Implementation of a IronOS select entity.""" | ||
|
|
||
| entity_description: IronOSSelectEntityDescription | ||
|
|
||
| def __init__( | ||
| self, | ||
| coordinator: IronOSCoordinators, | ||
| entity_description: IronOSSelectEntityDescription, | ||
| ) -> None: | ||
| """Initialize the select entity.""" | ||
| super().__init__( | ||
| coordinator.live_data, entity_description, entity_description.characteristic | ||
| ) | ||
|
|
||
| self.settings = coordinator.settings | ||
|
|
||
| @property | ||
| def current_option(self) -> str | None: | ||
| """Return the selected entity option to represent the entity state.""" | ||
|
|
||
| return self.entity_description.value_fn(self.settings.data) | ||
|
|
||
| async def async_select_option(self, option: str) -> None: | ||
| """Change the selected option.""" | ||
|
|
||
| if raw_value_fn := self.entity_description.raw_value_fn: | ||
| value = raw_value_fn(option) | ||
| try: | ||
| await self.coordinator.device.write( | ||
| self.entity_description.characteristic, value | ||
| ) | ||
| except CommunicationError as e: | ||
| raise ServiceValidationError( | ||
| translation_domain=DOMAIN, | ||
| translation_key="submit_setting_failed", | ||
| ) from e | ||
| await self.settings.async_request_refresh() | ||
|
|
||
| async def async_added_to_hass(self) -> None: | ||
| """Run when entity about to be added to hass.""" | ||
|
|
||
| await super().async_added_to_hass() | ||
| self.async_on_remove( | ||
| self.settings.async_add_listener( | ||
| self._handle_coordinator_update, self.entity_description.characteristic | ||
| ) | ||
| ) | ||
| await self.settings.async_request_refresh() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.