Add Starlink reboot button

homeassistant/components/starlink/__init__.py

@@ -8,7 +8,7 @@
 from .const import DOMAIN
 from .coordinator import StarlinkUpdateCoordinator
 
-PLATFORMS: list[Platform] = [Platform.BINARY_SENSOR, Platform.SENSOR]
+PLATFORMS: list[Platform] = [Platform.BINARY_SENSOR, Platform.BUTTON, Platform.SENSOR]
 
 
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:

homeassistant/components/starlink/button.py

@@ -0,0 +1,76 @@
+"""Contains buttons exposed by the Starlink ingegration."""
+
+from __future__ import annotations
+
+from collections.abc import Awaitable, Callable
+from dataclasses import dataclass
+
+from homeassistant.components.button import (
+    ButtonDeviceClass,
+    ButtonEntity,
+    ButtonEntityDescription,
+)
+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 StarlinkUpdateCoordinator
+from .entity import StarlinkEntity
+
+
+async def async_setup_entry(
+    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
+) -> None:
+    """Set up all binary sensors for this entry."""
+    coordinator = hass.data[DOMAIN][entry.entry_id]
+
+    async_add_entities(
+        StarlinkButtonEntity(coordinator, description) for description in BUTTONS
+    )
+
+
+@dataclass
+class StarlinkButtonEntityDescriptionMixin:
+    """Mixin for required keys."""
+
+    press_fn: Callable[[StarlinkUpdateCoordinator], Awaitable[None]]
+
+
+@dataclass
+class StarlinkButtonEntityDescription(
+    ButtonEntityDescription, StarlinkButtonEntityDescriptionMixin
+):
+    """Describes a Starlink button entity."""
+
+
+class StarlinkButtonEntity(StarlinkEntity, ButtonEntity):
+    """A ButtonEntity for Starlink devices. Handles creating unique IDs."""
+
+    entity_description: StarlinkButtonEntityDescription
+
+    def __init__(
+        self,
+        coordinator: StarlinkUpdateCoordinator,
+        description: StarlinkButtonEntityDescription,
+    ) -> None:
+        """Initialize the button."""
+        super().__init__(coordinator)
+        self.entity_description = description
+        self._attr_unique_id = f"{self.coordinator.data.status['id']}_{description.key}"
+
+    async def async_press(self) -> None:
+        """Press the button."""
+        return await self.entity_description.press_fn(self.coordinator)
+
+
+BUTTONS = [
+    StarlinkButtonEntityDescription(
+        key="reboot",
+        name="Reboot",
+        device_class=ButtonDeviceClass.RESTART,
+        entity_category=EntityCategory.DIAGNOSTIC,
+        press_fn=lambda coordinator: coordinator.reboot_starlink(),
+    )
+]

homeassistant/components/starlink/coordinator.py

@@ -12,6 +12,7 @@
     GrpcError,
     ObstructionDict,
     StatusDict,
+    reboot,
     status_data,
 )
 
@@ -53,3 +54,11 @@ async def _async_update_data(self) -> StarlinkData:
                 return StarlinkData(*status)
             except GrpcError as exc:
                 raise UpdateFailed from exc
+
+    async def reboot_starlink(self):
+        """Reboot the Starlink system tied to this coordinator."""
+        async with async_timeout.timeout(4):
+            try:
+                await self.hass.async_add_executor_job(reboot, self.channel_context)
+            except GrpcError as exc:
+                raise UpdateFailed from exc