button.py

Go to the documentation of this file.

"""Support for the NextDNS service."""
 
from __future__ import annotations
 
from nextdns import AnalyticsStatus
 
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 homeassistant.helpers.update_coordinator import CoordinatorEntity
 
from . import NextDnsConfigEntry
from .coordinator import NextDnsUpdateCoordinator
 
PARALLEL_UPDATES = 1
 
CLEAR_LOGS_BUTTON = ButtonEntityDescription(
    key="clear_logs",
    translation_key="clear_logs",
    entity_category=EntityCategory.CONFIG,
)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    entry: NextDnsConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Add aNextDNS entities from a config_entry."""
    coordinator = entry.runtime_data.status
 
    async_add_entities([NextDnsButton(coordinator, CLEAR_LOGS_BUTTON)])
 
 
class NextDnsButton(
    CoordinatorEntity[NextDnsUpdateCoordinator[AnalyticsStatus]], ButtonEntity
):
    """Define an NextDNS button."""
 
    _attr_has_entity_name = True
 
    def __init__(
        self,
        coordinator: NextDnsUpdateCoordinator[AnalyticsStatus],
        description: ButtonEntityDescription,
    ) -> None:
        """Initialize."""
        super().__init__(coordinator)
        self._attr_device_info_attr_device_info = coordinator.device_info
        self._attr_unique_id_attr_unique_id = f"{coordinator.profile_id}_{description.key}"
        self.entity_descriptionentity_description = description
 
    async def async_press(self) -> None:
        """Trigger cleaning logs."""
        await self.coordinator.nextdns.clear_logs(self.coordinator.profile_id)