button.py

Go to the documentation of this file.

"""Support for button entities."""
 
from __future__ import annotations
 
from dataclasses import dataclass, field
 
from gardena_bluetooth.const import Reset
from gardena_bluetooth.parse import CharacteristicBool
 
from homeassistant.components.button import ButtonEntity, ButtonEntityDescription
from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from . import GardenaBluetoothConfigEntry
from .entity import GardenaBluetoothDescriptorEntity
 
 
@dataclass(frozen=True)
class GardenaBluetoothButtonEntityDescription(ButtonEntityDescription):
    """Description of entity."""
 
    char: CharacteristicBool = field(default_factory=lambda: CharacteristicBool(""))
 
    @property
    def context(self) -> set[str]:
        """Context needed for update coordinator."""
        return {self.char.uuid}
 
 
DESCRIPTIONS = (
    GardenaBluetoothButtonEntityDescription(
        key=Reset.factory_reset.uuid,
        translation_key="factory_reset",
        entity_category=EntityCategory.DIAGNOSTIC,
        entity_registry_enabled_default=False,
        char=Reset.factory_reset,
    ),
)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    entry: GardenaBluetoothConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up button based on a config entry."""
    coordinator = entry.runtime_data
    entities = [
        GardenaBluetoothButton(coordinator, description, description.context)
        for description in DESCRIPTIONS
        if description.key in coordinator.characteristics
    ]
    async_add_entities(entities)
 
 
class GardenaBluetoothButton(GardenaBluetoothDescriptorEntity, ButtonEntity):
    """Representation of a button."""
 
    entity_description: GardenaBluetoothButtonEntityDescription
 
    async def async_press(self) -> None:
        """Trigger button action."""
        await self.coordinator.write(self.entity_descriptionentity_description.char, True)