Skip to content

Add button platform to miele #143508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Apr 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions homeassistant/components/miele/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
from .coordinator import MieleConfigEntry, MieleDataUpdateCoordinator

PLATFORMS: list[Platform] = [
Platform.BUTTON,
Platform.LIGHT,
Platform.SENSOR,
Platform.SWITCH,
Expand Down
163 changes: 163 additions & 0 deletions homeassistant/components/miele/button.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
"""Platform for Miele button integration."""

from __future__ import annotations

from dataclasses import dataclass
import logging
from typing import Final

import aiohttp

from homeassistant.components.button import ButtonEntity, ButtonEntityDescription
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback

from .const import DOMAIN, PROCESS_ACTION, MieleActions, MieleAppliance
from .coordinator import MieleConfigEntry, MieleDataUpdateCoordinator
from .entity import MieleEntity

_LOGGER = logging.getLogger(__name__)


@dataclass(frozen=True, kw_only=True)
class MieleButtonDescription(ButtonEntityDescription):
"""Class describing Miele button entities."""

press_data: MieleActions


@dataclass
class MieleButtonDefinition:
"""Class for defining button entities."""

types: tuple[MieleAppliance, ...]
description: MieleButtonDescription


BUTTON_TYPES: Final[tuple[MieleButtonDefinition, ...]] = (
MieleButtonDefinition(
types=(
MieleAppliance.WASHING_MACHINE,
MieleAppliance.WASHING_MACHINE_SEMI_PROFESSIONAL,
MieleAppliance.TUMBLE_DRYER,
MieleAppliance.TUMBLE_DRYER_SEMI_PROFESSIONAL,
MieleAppliance.DISHWASHER,
MieleAppliance.OVEN,
MieleAppliance.OVEN_MICROWAVE,
MieleAppliance.STEAM_OVEN,
MieleAppliance.MICROWAVE,
MieleAppliance.WASHER_DRYER,
MieleAppliance.STEAM_OVEN_COMBI,
MieleAppliance.STEAM_OVEN_MICRO,
MieleAppliance.STEAM_OVEN_MK2,
MieleAppliance.DIALOG_OVEN,
),
description=MieleButtonDescription(
key="start",
translation_key="start",
press_data=MieleActions.START,
entity_registry_enabled_default=False,
),
),
MieleButtonDefinition(
types=(
MieleAppliance.WASHING_MACHINE,
MieleAppliance.WASHING_MACHINE_SEMI_PROFESSIONAL,
MieleAppliance.TUMBLE_DRYER,
MieleAppliance.TUMBLE_DRYER_SEMI_PROFESSIONAL,
MieleAppliance.DISHWASHER,
MieleAppliance.OVEN,
MieleAppliance.OVEN_MICROWAVE,
MieleAppliance.STEAM_OVEN,
MieleAppliance.MICROWAVE,
MieleAppliance.HOOD,
MieleAppliance.WASHER_DRYER,
MieleAppliance.STEAM_OVEN_COMBI,
MieleAppliance.STEAM_OVEN_MICRO,
MieleAppliance.STEAM_OVEN_MK2,
MieleAppliance.DIALOG_OVEN,
),
description=MieleButtonDescription(
key="stop",
translation_key="stop",
press_data=MieleActions.STOP,
entity_registry_enabled_default=False,
),
),
MieleButtonDefinition(
types=(
MieleAppliance.WASHING_MACHINE,
MieleAppliance.WASHING_MACHINE_SEMI_PROFESSIONAL,
MieleAppliance.TUMBLE_DRYER,
MieleAppliance.TUMBLE_DRYER_SEMI_PROFESSIONAL,
MieleAppliance.DISHWASHER,
MieleAppliance.WASHER_DRYER,
),
description=MieleButtonDescription(
key="pause",
translation_key="pause",
press_data=MieleActions.PAUSE,
entity_registry_enabled_default=False,
),
),
)


async def async_setup_entry(
hass: HomeAssistant,
config_entry: MieleConfigEntry,
async_add_entities: AddConfigEntryEntitiesCallback,
) -> None:
"""Set up the button platform."""
coordinator = config_entry.runtime_data

async_add_entities(
MieleButton(coordinator, device_id, definition.description)
for device_id, device in coordinator.data.devices.items()
for definition in BUTTON_TYPES
if device.device_type in definition.types
)


class MieleButton(MieleEntity, ButtonEntity):
"""Representation of a Button."""

entity_description: MieleButtonDescription

def __init__(
self,
coordinator: MieleDataUpdateCoordinator,
device_id: str,
description: MieleButtonDescription,
) -> None:
"""Initialize the button."""
super().__init__(coordinator, device_id, description)
self.api = coordinator.api

@property
def available(self) -> bool:
"""Return the availability of the entity."""

return (
super().available
and self.entity_description.press_data
in self.coordinator.data.actions[self._device_id].process_actions
)

async def async_press(self) -> None:
"""Press the button."""
_LOGGER.debug("Press: %s", self.entity_description.key)
try:
await self.api.send_action(
self._device_id,
{PROCESS_ACTION: self.entity_description.press_data},
)
except aiohttp.ClientResponseError as ex:
raise HomeAssistantError(
translation_domain=DOMAIN,
translation_key="set_state_error",
translation_placeholders={
"entity": self.entity_id,
},
) from ex
11 changes: 11 additions & 0 deletions homeassistant/components/miele/icons.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
{
"entity": {
"button": {
"start": {
"default": "mdi:play"
},
"stop": {
"default": "mdi:stop"
},
"pause": {
"default": "mdi:pause"
}
},
"switch": {
"power": {
"default": "mdi:power"
Expand Down
11 changes: 11 additions & 0 deletions homeassistant/components/miele/strings.json
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,17 @@
}
},
"entity": {
"button": {
"start": {
"name": "[%key:common::action::start%]"
},
"stop": {
"name": "[%key:common::action::stop%]"
},
"pause": {
"name": "[%key:common::action::pause%]"
}
},
"light": {
"ambient_light": {
"name": "Ambient light"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"processAction": [],
"processAction": [1, 2, 3],
"light": [],
"ambientLight": [],
"startTime": [],
Expand Down
Loading