device_tracker.py

Go to the documentation of this file.

"""Device tracker support for OPNSense routers."""
 
from __future__ import annotations
 
from homeassistant.components.device_tracker import DeviceScanner
from homeassistant.core import HomeAssistant
from homeassistant.helpers.typing import ConfigType
 
from . import CONF_TRACKER_INTERFACE, OPNSENSE_DATA
 
 
async def async_get_scanner(
    hass: HomeAssistant, config: ConfigType
) -> OPNSenseDeviceScanner:
    """Configure the OPNSense device_tracker."""
    interface_client = hass.data[OPNSENSE_DATA]["interfaces"]
    return OPNSenseDeviceScanner(
        interface_client, hass.data[OPNSENSE_DATA][CONF_TRACKER_INTERFACE]
    )
 
 
class OPNSenseDeviceScanner(DeviceScanner):
    """Class which queries a router running OPNsense."""
 
    def __init__(self, client, interfaces):
        """Initialize the scanner."""
        self.last_resultslast_results = {}
        self.clientclient = client
        self.interfacesinterfaces = interfaces
 
    def _get_mac_addrs(self, devices):
        """Create dict with mac address keys from list of devices."""
        out_devices = {}
        for device in devices:
            if not self.interfacesinterfaces or device["intf_description"] in self.interfacesinterfaces:
                out_devices[device["mac"]] = device
        return out_devices
 
    def scan_devices(self):
        """Scan for new devices and return a list with found device IDs."""
        self.update_infoupdate_info()
        return list(self.last_resultslast_results)
 
    def get_device_name(self, device):
        """Return the name of the given device or None if we don't know."""
        if device not in self.last_resultslast_results:
            return None
        return self.last_resultslast_results[device].get("hostname") or None
 
    def update_info(self):
        """Ensure the information from the OPNSense router is up to date.
 
        Return boolean if scanning successful.
        """
 
        devices = self.clientclient.get_arp()
        self.last_resultslast_results = self._get_mac_addrs_get_mac_addrs(devices)
 
    def get_extra_attributes(self, device):
        """Return the extra attrs of the given device."""
        if device not in self.last_resultslast_results:
            return None
        if not (mfg := self.last_resultslast_results[device].get("manufacturer")):
            return {}
        return {"manufacturer": mfg}