device_tracker.py

Go to the documentation of this file.

"""Support for Netgear routers."""
 
from __future__ import annotations
 
import logging
 
from homeassistant.components.device_tracker import ScannerEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
 
from .const import DEVICE_ICONS, DOMAIN, KEY_COORDINATOR, KEY_ROUTER
from .entity import NetgearDeviceEntity
from .router import NetgearRouter
 
_LOGGER = logging.getLogger(__name__)
 
 
async def async_setup_entry(
    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
    """Set up device tracker for Netgear component."""
    router = hass.data[DOMAIN][entry.entry_id][KEY_ROUTER]
    coordinator = hass.data[DOMAIN][entry.entry_id][KEY_COORDINATOR]
    tracked = set()
 
    @callback
    def new_device_callback() -> None:
        """Add new devices if needed."""
        if not coordinator.data:
            return
 
        new_entities = []
 
        for mac, device in router.devices.items():
            if mac in tracked:
                continue
 
            new_entities.append(NetgearScannerEntity(coordinator, router, device))
            tracked.add(mac)
 
        async_add_entities(new_entities)
 
    entry.async_on_unload(coordinator.async_add_listener(new_device_callback))
 
    coordinator.data = True
    new_device_callback()
 
 
class NetgearScannerEntity(NetgearDeviceEntity, ScannerEntity):
    """Representation of a device connected to a Netgear router."""
 
    _attr_has_entity_name = False
 
    def __init__(
        self, coordinator: DataUpdateCoordinator, router: NetgearRouter, device: dict
    ) -> None:
        """Initialize a Netgear device."""
        super().__init__(coordinator, router, device)
        self._hostname_hostname = self.get_hostnameget_hostname()
        self._icon_icon = DEVICE_ICONS.get(device["device_type"], "mdi:help-network")
        self._attr_name_attr_name = self._device_name_device_name
 
    def get_hostname(self) -> str | None:
        """Return the hostname of the given device or None if we don't know."""
        if (hostname := self._device_device_device["name"]) == "--":
            return None
 
        return hostname
 
    @callback
    def async_update_device(self) -> None:
        """Update the Netgear device."""
        self._device_device_device = self._router_router.devices[self._mac_mac]
        self._active_active_active = self._device_device_device["active"]
        self._icon_icon = DEVICE_ICONS.get(self._device_device_device["device_type"], "mdi:help-network")
 
    @property
    def is_connected(self) -> bool:
        """Return true if the device is connected to the router."""
        return self._active_active_active
 
    @property
    def ip_address(self) -> str:
        """Return the IP address."""
        return self._device_device_device["ip"]
 
    @property
    def mac_address(self) -> str:
        """Return the mac address."""
        return self._mac_mac
 
    @property
    def hostname(self) -> str | None:
        """Return the hostname."""
        return self._hostname_hostname
 
    @property
    def icon(self) -> str:
        """Return the icon."""
        return self._icon_icon