button.py

Go to the documentation of this file.

"""Support for Synology DSM buttons."""
 
from __future__ import annotations
 
from collections.abc import Callable, Coroutine
from dataclasses import dataclass
import logging
from typing import Any, Final
 
from homeassistant.components.button import (
    ButtonDeviceClass,
    ButtonEntity,
    ButtonEntityDescription,
)
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 . import SynoApi
from .const import DOMAIN
from .models import SynologyDSMData
 
LOGGER = logging.getLogger(__name__)
 
 
@dataclass(frozen=True, kw_only=True)
class SynologyDSMbuttonDescription(ButtonEntityDescription):
    """Class to describe a Synology DSM button entity."""
 
    press_action: Callable[[SynoApi], Callable[[], Coroutine[Any, Any, None]]]
 
 
BUTTONS: Final = [
    SynologyDSMbuttonDescription(
        key="reboot",
        name="Reboot",
        device_class=ButtonDeviceClass.RESTART,
        entity_category=EntityCategory.CONFIG,
        press_action=lambda syno_api: syno_api.async_reboot,
    ),
    SynologyDSMbuttonDescription(
        key="shutdown",
        name="Shutdown",
        icon="mdi:power",
        entity_category=EntityCategory.CONFIG,
        press_action=lambda syno_api: syno_api.async_shutdown,
    ),
]
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set buttons for device."""
    data: SynologyDSMData = hass.data[DOMAIN][entry.unique_id]
    async_add_entities(SynologyDSMButton(data.api, button) for button in BUTTONS)
 
 
class SynologyDSMButton(ButtonEntity):
    """Defines a Synology DSM button."""
 
    entity_description: SynologyDSMbuttonDescription
 
    def __init__(
        self,
        api: SynoApi,
        description: SynologyDSMbuttonDescription,
    ) -> None:
        """Initialize the Synology DSM binary_sensor entity."""
        self.entity_descriptionentity_description = description
        self.syno_apisyno_api = api
        assert api.network is not None
        assert api.information is not None
        self._attr_name_attr_name = f"{api.network.hostname} {description.name}"
        self._attr_unique_id_attr_unique_id = f"{api.information.serial}_{description.key}"
        self._attr_device_info_attr_device_info = DeviceInfo(
            identifiers={(DOMAIN, api.information.serial)}
        )
 
    async def async_press(self) -> None:
        """Triggers the Synology DSM button press service."""
        assert self.syno_apisyno_api.network is not None
        LOGGER.debug(
            "Trigger %s for %s",
            self.entity_descriptionentity_description.key,
            self.syno_apisyno_api.network.hostname,
        )
        await self.entity_descriptionentity_description.press_action(self.syno_apisyno_api)()