Add bridge device support with connectivity sensor and via_device linking (#379)

- Register bridge (Wi-Fi Hub) devices in Home Assistant with a connectivity
  binary sensor showing online/offline status
- Link child devices (sprinklers, flood sensors) to their bridge via
  via_device using device_gateway_topic mapping
- Expose MAC address on all devices via CONNECTION_NETWORK_MAC
- Always include bridge devices regardless of user device selection
- Exclude bridges from config flow device picker and device removal logic

Author: sebr

custom_components/bhyve/__init__.py

@@ -18,14 +18,15 @@
 )
 from homeassistant.helpers import device_registry as dr
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
-from homeassistant.helpers.device_registry import DeviceInfo
+from homeassistant.helpers.device_registry import CONNECTION_NETWORK_MAC, DeviceInfo
 from homeassistant.helpers.typing import ConfigType
 from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
 from custom_components.bhyve.pybhyve.typings import BHyveDevice
 
 from .const import (
     CONF_DEVICES,
+    DEVICE_BRIDGE,
     DOMAIN,
     EVENT_PROGRAM_CHANGED,
     LOGGER,
@@ -103,6 +104,17 @@ async def async_update_callback(data: dict) -> None:
     programs = await client.timer_programs
     devices = filter_configured_devices(entry, all_devices)
 
+    # Build a mapping from device_gateway_topic to bridge device ID
+    # so child devices can reference their bridge via via_device.
+    # Bridges are always included by filter_configured_devices.
+    gateway_to_bridge: dict[str, str] = {}
+    for device in devices:
+        if device.get("type") == DEVICE_BRIDGE:
+            gateway_topic = device.get("device_gateway_topic")
+            if gateway_topic:
+                gateway_to_bridge[gateway_topic] = device.get("id", "")
+    coordinator.gateway_to_bridge = gateway_to_bridge
+
     hass.data.setdefault(DOMAIN, {})[entry.entry_id] = {
         "client": client,
         "coordinator": coordinator,
@@ -146,9 +158,12 @@ async def update_listener(hass: HomeAssistant, entry: ConfigEntry) -> None:
             # Get currently configured device IDs
             configured_ids = set(entry.options.get(CONF_DEVICES, []))
 
-            # Find devices that were removed from configuration
-            all_device_ids = {str(d["id"]) for d in all_devices}
-            removed_device_ids = all_device_ids - configured_ids
+            # Find leaf devices that were removed from configuration
+            # (bridges are always included and not user-selectable)
+            leaf_device_ids = {
+                str(d["id"]) for d in all_devices if d.get("type") != DEVICE_BRIDGE
+            }
+            removed_device_ids = leaf_device_ids - configured_ids
 
             if removed_device_ids:
                 # Remove devices from Home Assistant
@@ -183,8 +198,16 @@ def __init__(
         self._mac_address = device.get("mac_address")
 
         # Device info for grouping
-        self._attr_device_info = DeviceInfo(
+        connections: set[tuple[str, str]] = set()
+        if self._mac_address:
+            # Format raw MAC (e.g. "4467552a366e") with colons
+            raw = self._mac_address.replace(":", "").replace("-", "").lower()
+            formatted_mac = ":".join(raw[i : i + 2] for i in range(0, len(raw), 2))
+            connections.add((CONNECTION_NETWORK_MAC, formatted_mac))
+
+        device_info = DeviceInfo(
             identifiers={(DOMAIN, self._device_id)},
+            connections=connections,
             manufacturer=MANUFACTURER,
             configuration_url=f"https://techsupport.orbitbhyve.com/dashboard/support/device/{self._device_id}",
             name=self._device_name,
@@ -193,6 +216,16 @@ def __init__(
             sw_version=device.get("firmware_version"),
         )
 
+        # Link non-bridge devices to their bridge via device_gateway_topic
+        if self._device_type != DEVICE_BRIDGE:
+            gateway_topic = device.get("device_gateway_topic")
+            gateway_to_bridge = getattr(coordinator, "gateway_to_bridge", {})
+            bridge_id = gateway_to_bridge.get(gateway_topic) if gateway_topic else None
+            if bridge_id:
+                device_info["via_device"] = (DOMAIN, bridge_id)
+
+        self._attr_device_info = device_info
+
         LOGGER.debug(
             "Creating %s: %s - %s",
             self.__class__.__name__,

custom_components/bhyve/binary_sensor.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-import logging
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Any
 
@@ -13,7 +12,7 @@
 )
 
 from . import BHyveCoordinatorEntity
-from .const import DEVICE_FLOOD, DEVICE_SPRINKLER, DOMAIN
+from .const import DEVICE_BRIDGE, DEVICE_FLOOD, DEVICE_SPRINKLER, DOMAIN
 
 if TYPE_CHECKING:
     from homeassistant.config_entries import ConfigEntry
@@ -23,8 +22,6 @@
     from .coordinator import BHyveDataUpdateCoordinator
     from .pybhyve.typings import BHyveDevice
 
-_LOGGER = logging.getLogger(__name__)
-
 
 @dataclass(frozen=True, kw_only=True)
 class BHyveBinarySensorEntityDescription(BinarySensorEntityDescription):
@@ -84,6 +81,15 @@ class BHyveBinarySensorEntityDescription(BinarySensorEntityDescription):
             "station_faults": data.get("status", {}).get("station_faults", []),
         },
     ),
+    BHyveBinarySensorEntityDescription(
+        key="connectivity",
+        translation_key="connectivity",
+        name="Connected",
+        device_class=BinarySensorDeviceClass.CONNECTIVITY,
+        unique_id_suffix="connectivity",
+        device_types=(DEVICE_BRIDGE,),
+        value_fn=lambda data: data.get("is_connected", False),
+    ),
 )
 
 

custom_components/bhyve/coordinator.py

@@ -52,6 +52,7 @@ def __init__(
         )
         self.client = client
         self.entry = entry
+        self.gateway_to_bridge: dict[str, str] = {}
 
     async def _async_update_data(self) -> dict[str, Any]:
         """Fetch data from API (periodic polling)."""

custom_components/bhyve/strings.json

@@ -157,6 +157,9 @@
           "on": "Fault",
           "off": "OK"
         }
+      },
+      "connectivity": {
+        "name": "Connected"
       }
     },
     "sensor": {

custom_components/bhyve/util.py

@@ -5,7 +5,7 @@
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.util import dt
 
-from .const import CONF_DEVICES
+from .const import CONF_DEVICES, DEVICE_BRIDGE
 
 
 def orbit_time_to_local_time(timestamp: str | None) -> datetime | None:
@@ -18,9 +18,18 @@ def orbit_time_to_local_time(timestamp: str | None) -> datetime | None:
 
 
 def filter_configured_devices(entry: ConfigEntry, all_devices: list) -> list:
-    """Filter the device list to those that are enabled in options."""
+    """
+    Filter the device list to those that are enabled in options.
+
+    Bridge devices are always included since they are not user-selectable
+    but are needed to register the hub in Home Assistant.
+    """
     configured_devices = entry.options.get(CONF_DEVICES, [])
-    filtered_devices = [d for d in all_devices if str(d["id"]) in configured_devices]
+    filtered_devices = [
+        d
+        for d in all_devices
+        if str(d["id"]) in configured_devices or d.get("type") == DEVICE_BRIDGE
+    ]
 
     # Ensure that all devices have a name
     for device in filtered_devices: