device_tracker.py

Go to the documentation of this file.

"""Support for OpenWRT (luci) routers."""
 
from __future__ import annotations
 
import logging
 
from openwrt_luci_rpc import OpenWrtRpc
import voluptuous as vol
 
from homeassistant.components.device_tracker import (
    DOMAIN as DEVICE_TRACKER_DOMAIN,
    PLATFORM_SCHEMA as DEVICE_TRACKER_PLATFORM_SCHEMA,
    DeviceScanner,
)
from homeassistant.const import (
    CONF_HOST,
    CONF_PASSWORD,
    CONF_SSL,
    CONF_USERNAME,
    CONF_VERIFY_SSL,
)
from homeassistant.core import HomeAssistant
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.typing import ConfigType
 
_LOGGER = logging.getLogger(__name__)
 
DEFAULT_SSL = False
DEFAULT_VERIFY_SSL = True
 
PLATFORM_SCHEMA = DEVICE_TRACKER_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_HOST): cv.string,
        vol.Required(CONF_USERNAME): cv.string,
        vol.Required(CONF_PASSWORD): cv.string,
        vol.Optional(CONF_SSL, default=DEFAULT_SSL): cv.boolean,
        vol.Optional(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): cv.boolean,
    }
)
 
 
def get_scanner(hass: HomeAssistant, config: ConfigType) -> LuciDeviceScanner | None:
    """Validate the configuration and return a Luci scanner."""
    scanner = LuciDeviceScanner(config[DEVICE_TRACKER_DOMAIN])
 
    return scanner if scanner.success_init else None
 
 
class LuciDeviceScanner(DeviceScanner):
    """Scanner for devices connected to an OpenWrt router."""
 
    def __init__(self, config):
        """Initialize the scanner."""
 
        self.routerrouter = OpenWrtRpc(
            config[CONF_HOST],
            config[CONF_USERNAME],
            config[CONF_PASSWORD],
            config[CONF_SSL],
            config[CONF_VERIFY_SSL],
        )
 
        self.last_resultslast_results = {}
        self.success_initsuccess_init = self.routerrouter.is_logged_in()
 
    def scan_devices(self):
        """Scan for new devices and return a list with found device IDs."""
        self._update_info_update_info()
 
        return [device.mac for device in self.last_resultslast_results]
 
    def get_device_name(self, device):
        """Return the name of the given device or None if we don't know."""
        return next(
            (result.hostname for result in self.last_resultslast_results if result.mac == device),
            None,
        )
 
    def get_extra_attributes(self, device):
        """Get extra attributes of a device.
 
        Some known extra attributes that may be returned in the device tuple
        include MAC address (mac), network device (dev), IP address
        (ip), reachable status (reachable), associated router
        (host), hostname if known (hostname) among others.
        """
        device = next(
            (result for result in self.last_resultslast_results if result.mac == device), None
        )
        return device._asdict()
 
    def _update_info(self):
        """Check the Luci router for devices."""
        result = self.routerrouter.get_all_connected_devices(only_reachable=True)
 
        _LOGGER.debug("Luci get_all_connected_devices returned: %s", result)
 
        self.last_resultslast_results = [
            device
            for device in result
            if not hasattr(self.routerrouter.router.owrt_version, "release")
            or not self.routerrouter.router.owrt_version.release
            or self.routerrouter.router.owrt_version.release[0] < 19
            or device.reachable
        ]