Add select platform to LaMetric (#79803)

This commit is contained in:
Franck Nijhof 2022-10-10 09:28:36 +02:00 committed by GitHub
parent 7fae85ee85
commit 575501d26a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 185 additions and 1 deletions

View File

@ -7,7 +7,13 @@ from typing import Final
from homeassistant.const import Platform
DOMAIN: Final = "lametric"
PLATFORMS = [Platform.BUTTON, Platform.NUMBER, Platform.SENSOR, Platform.SWITCH]
PLATFORMS = [
Platform.BUTTON,
Platform.NUMBER,
Platform.SELECT,
Platform.SENSOR,
Platform.SWITCH,
]
LOGGER = logging.getLogger(__package__)
SCAN_INTERVAL = timedelta(seconds=30)

View File

@ -0,0 +1,91 @@
"""Support for LaMetric selects."""
from __future__ import annotations
from collections.abc import Awaitable, Callable
from dataclasses import dataclass
from typing import Any
from demetriek import BrightnessMode, Device, LaMetricDevice
from homeassistant.components.select import SelectEntity, SelectEntityDescription
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity import EntityCategory
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from .const import DOMAIN
from .coordinator import LaMetricDataUpdateCoordinator
from .entity import LaMetricEntity
@dataclass
class LaMetricEntityDescriptionMixin:
"""Mixin values for LaMetric entities."""
options: list[str]
current_fn: Callable[[Device], str]
select_fn: Callable[[LaMetricDevice, str], Awaitable[Any]]
@dataclass
class LaMetricSelectEntityDescription(
SelectEntityDescription, LaMetricEntityDescriptionMixin
):
"""Class describing LaMetric select entities."""
SELECTS = [
LaMetricSelectEntityDescription(
key="brightness_mode",
name="Brightness mode",
icon="mdi:brightness-auto",
entity_category=EntityCategory.CONFIG,
device_class="lametric__brightness_mode",
options=["auto", "manual"],
current_fn=lambda device: device.display.brightness_mode.value,
select_fn=lambda api, opt: api.display(brightness_mode=BrightnessMode(opt)),
),
]
async def async_setup_entry(
hass: HomeAssistant,
entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up LaMetric select based on a config entry."""
coordinator: LaMetricDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
async_add_entities(
LaMetricSelectEntity(
coordinator=coordinator,
description=description,
)
for description in SELECTS
)
class LaMetricSelectEntity(LaMetricEntity, SelectEntity):
"""Representation of a LaMetric select."""
entity_description: LaMetricSelectEntityDescription
def __init__(
self,
coordinator: LaMetricDataUpdateCoordinator,
description: LaMetricSelectEntityDescription,
) -> None:
"""Initiate LaMetric Select."""
super().__init__(coordinator)
self.entity_description = description
self._attr_options = description.options
self._attr_unique_id = f"{coordinator.data.serial_number}-{description.key}"
@property
def current_option(self) -> str | None:
"""Return the selected entity option to represent the entity state."""
return self.entity_description.current_fn(self.coordinator.data)
async def async_select_option(self, option: str) -> None:
"""Change the selected option."""
await self.entity_description.select_fn(self.coordinator.lametric, option)
await self.coordinator.async_request_refresh()

View File

@ -0,0 +1,8 @@
{
"state": {
"lametric__brightness_mode": {
"auto": "Automatic",
"manual": "Manual"
}
}
}

View File

@ -0,0 +1,8 @@
{
"state": {
"lametric__brightness_mode": {
"auto": "Automatic",
"manual": "Manual"
}
}
}

View File

@ -0,0 +1,71 @@
"""Tests for the LaMetric select platform."""
from unittest.mock import MagicMock
from demetriek import BrightnessMode
from homeassistant.components.lametric.const import DOMAIN
from homeassistant.components.select import (
ATTR_OPTIONS,
DOMAIN as SELECT_DOMAIN,
SERVICE_SELECT_OPTION,
)
from homeassistant.const import (
ATTR_ENTITY_ID,
ATTR_FRIENDLY_NAME,
ATTR_ICON,
ATTR_OPTION,
)
from homeassistant.core import HomeAssistant
from homeassistant.helpers import device_registry as dr, entity_registry as er
from homeassistant.helpers.entity import EntityCategory
from tests.common import MockConfigEntry
async def test_brightness_mode(
hass: HomeAssistant,
init_integration: MockConfigEntry,
mock_lametric: MagicMock,
) -> None:
"""Test the LaMetric brightness mode controls."""
device_registry = dr.async_get(hass)
entity_registry = er.async_get(hass)
state = hass.states.get("select.frenck_s_lametric_brightness_mode")
assert state
assert (
state.attributes.get(ATTR_FRIENDLY_NAME) == "Frenck's LaMetric Brightness mode"
)
assert state.attributes.get(ATTR_ICON) == "mdi:brightness-auto"
assert state.attributes.get(ATTR_OPTIONS) == ["auto", "manual"]
assert state.state == BrightnessMode.AUTO
entry = entity_registry.async_get(state.entity_id)
assert entry
assert entry.device_id
assert entry.entity_category is EntityCategory.CONFIG
assert entry.unique_id == "SA110405124500W00BS9-brightness_mode"
device = device_registry.async_get(entry.device_id)
assert device
assert device.configuration_url is None
assert device.connections == {(dr.CONNECTION_NETWORK_MAC, "aa:bb:cc:dd:ee:ff")}
assert device.entry_type is None
assert device.hw_version is None
assert device.identifiers == {(DOMAIN, "SA110405124500W00BS9")}
assert device.manufacturer == "LaMetric Inc."
assert device.name == "Frenck's LaMetric"
assert device.sw_version == "2.2.2"
await hass.services.async_call(
SELECT_DOMAIN,
SERVICE_SELECT_OPTION,
{
ATTR_ENTITY_ID: "select.frenck_s_lametric_brightness_mode",
ATTR_OPTION: "manual",
},
blocking=True,
)
assert len(mock_lametric.display.mock_calls) == 1
mock_lametric.display.assert_called_once_with(brightness_mode=BrightnessMode.MANUAL)