home-assistant-core/homeassistant/components/bond/utils.py

"""Reusable utilities for the Bond component."""

from typing import List

from bond import Bond

from homeassistant.core import HomeAssistant


class BondDevice:
    """Helper device class to hold ID and attributes together."""

    def __init__(self, device_id: str, attrs: dict):
        """Create a helper device from ID and attributes returned by API."""
        self.device_id = device_id
        self._attrs = attrs

    @property
    def name(self):
        """Get the name of this device."""
        return self._attrs["name"]

    @property
    def type(self):
        """Get the type of this device."""
        return self._attrs["type"]


async def get_bond_devices(hass: HomeAssistant, bond: Bond) -> List[BondDevice]:
    """Fetch all available devices using Bond API."""
    device_ids = await hass.async_add_executor_job(bond.getDeviceIds)
    devices = [
        BondDevice(
            device_id, await hass.async_add_executor_job(bond.getDevice, device_id)
        )
        for device_id in device_ids
    ]
    return devices