def __init__(self, config):
"""Initialize the scanner."""
from ndms2_client import Client, TelnetConnection
self.last_results = []
self._interface = config[CONF_INTERFACE]
self._client = Client(
TelnetConnection(
config.get(CONF_HOST),
config.get(CONF_PORT),
config.get(CONF_USERNAME),
config.get(CONF_PASSWORD),
))
self.success_init = self._update_info()
_LOGGER.info("Scanner initialized")
class KeeneticNDMS2DeviceScanner(DeviceScanner):
"""This class scans for devices using keenetic NDMS2 web interface."""
def __init__(self, config):
"""Initialize the scanner."""
self.last_results = []
self._interface = config[CONF_INTERFACE]
self._client = Client(
TelnetConnection(
config.get(CONF_HOST),
config.get(CONF_PORT),
config.get(CONF_USERNAME),
config.get(CONF_PASSWORD),
))
self.success_init = self._update_info()
_LOGGER.info("Scanner initialized")
def scan_devices(self):
"""Scan for new devices and return a list with found device IDs."""
self._update_info()
return [device.mac for device in self.last_results]
def get_device_name(self, device):
"""Return the name of the given device or None if we don't know."""
name = next((result.name
for result in self.last_results if result.mac == device),
None)
return name
def get_extra_attributes(self, device):
"""Return the IP of the given device."""
attributes = next(
({
"ip": result.ip
} for result in self.last_results if result.mac == device),
{},
)
return attributes
def _update_info(self):
"""Get ARP from keenetic router."""
_LOGGER.debug("Fetching devices from router...")
try:
self.last_results = [
dev for dev in self._client.get_devices()
if dev.interface == self._interface
]
_LOGGER.debug("Successfully fetched data from router")
return True
except ConnectionException:
_LOGGER.error("Error fetching data from router")
return False
class KeeneticNDMS2DeviceScanner(DeviceScanner):
"""This class scans for devices using keenetic NDMS2 web interface."""
def __init__(self, config):
"""Initialize the scanner."""
from ndms2_client import Client, TelnetConnection
self.last_results = []
self._interface = config[CONF_INTERFACE]
self._client = Client(TelnetConnection(
config.get(CONF_HOST),
config.get(CONF_PORT),
config.get(CONF_USERNAME),
config.get(CONF_PASSWORD),
))
self.success_init = self._update_info()
_LOGGER.info("Scanner initialized")
def scan_devices(self):
"""Scan for new devices and return a list with found device IDs."""
self._update_info()
return [device.mac for device in self.last_results]
def get_device_name(self, device):
"""Return the name of the given device or None if we don't know."""
name = next((
result.name for result in self.last_results
if result.mac == device), None)
return name
def get_extra_attributes(self, device):
"""Return the IP of the given device."""
attributes = next((
{'ip': result.ip} for result in self.last_results
if result.mac == device), {})
return attributes
def _update_info(self):
"""Get ARP from keenetic router."""
_LOGGER.debug("Fetching devices from router...")
from ndms2_client import ConnectionException
try:
self.last_results = [
dev
for dev in self._client.get_devices()
if dev.interface == self._interface
]
_LOGGER.debug("Successfully fetched data from router")
return True
except ConnectionException:
_LOGGER.error("Error fetching data from router")
return False
async def async_setup(self):
"""Set up the connection."""
self._connection = TelnetConnection(
self.config_entry.data[CONF_HOST],
self.config_entry.data[CONF_PORT],
self.config_entry.data[CONF_USERNAME],
self.config_entry.data[CONF_PASSWORD],
)
self._client = Client(self._connection)
try:
await self.hass.async_add_executor_job(self._update_router_info)
except ConnectionException as error:
raise ConfigEntryNotReady from error
async def async_update_data(_now):
await self.request_update()
self._cancel_periodic_update = async_call_later(
self.hass,
self.config_entry.options[CONF_SCAN_INTERVAL],
async_update_data,
)
await async_update_data(dt_util.utcnow())
def __init__(self, config):
"""Initialize the scanner."""
from ndms2_client import Client, TelnetConnection
self.last_results = []
self._interface = config[CONF_INTERFACE]
self._client = Client(TelnetConnection(
config.get(CONF_HOST),
config.get(CONF_PORT),
config.get(CONF_USERNAME),
config.get(CONF_PASSWORD),
))
self.success_init = self._update_info()
_LOGGER.info("Scanner initialized")
async def async_step_user(self,
user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Handle a flow initialized by the user."""
errors = {}
if user_input is not None:
host = self.context.get(CONF_HOST) or user_input[CONF_HOST]
self._async_abort_entries_match({CONF_HOST: host})
_client = Client(
TelnetConnection(
host,
user_input[CONF_PORT],
user_input[CONF_USERNAME],
user_input[CONF_PASSWORD],
timeout=10,
))
try:
router_info = await self.hass.async_add_executor_job(
_client.get_router_info)
except ConnectionException:
errors["base"] = "cannot_connect"
else:
return self.async_create_entry(title=router_info.name,
data={
CONF_HOST: host,
**user_input
})
host_schema = ({
vol.Required(CONF_HOST): str
} if CONF_HOST not in self.context else {})
return self.async_show_form(
step_id="user",
data_schema=vol.Schema({
**host_schema,
vol.Required(CONF_USERNAME):
str,
vol.Required(CONF_PASSWORD):
str,
vol.Optional(CONF_PORT, default=DEFAULT_TELNET_PORT):
int,
}),
errors=errors,
)
async def async_step_user(self, user_input=None):
"""Handle a flow initialized by the user."""
errors = {}
if user_input is not None:
for entry in self.hass.config_entries.async_entries(DOMAIN):
if entry.data[CONF_HOST] == user_input[CONF_HOST]:
return self.async_abort(reason="already_configured")
_client = Client(
TelnetConnection(
user_input[CONF_HOST],
user_input[CONF_PORT],
user_input[CONF_USERNAME],
user_input[CONF_PASSWORD],
timeout=10,
))
try:
router_info = await self.hass.async_add_executor_job(
_client.get_router_info)
except ConnectionException:
errors["base"] = "cannot_connect"
else:
return self.async_create_entry(title=router_info.name,
data=user_input)
return self.async_show_form(
step_id="user",
data_schema=vol.Schema({
vol.Required(CONF_HOST):
str,
vol.Required(CONF_USERNAME):
str,
vol.Required(CONF_PASSWORD):
str,
vol.Optional(CONF_PORT, default=DEFAULT_TELNET_PORT):
int,
}),
errors=errors,
)
class KeeneticRouter:
"""Keenetic client Object."""
def __init__(self, hass: HomeAssistant, config_entry: ConfigEntry) -> None:
"""Initialize the Client."""
self.hass = hass
self.config_entry = config_entry
self._last_devices: dict[str, Device] = {}
self._router_info: RouterInfo | None = None
self._connection: TelnetConnection | None = None
self._client: Client | None = None
self._cancel_periodic_update: Callable | None = None
self._available = False
self._progress = None
self._tracked_interfaces = set(config_entry.options[CONF_INTERFACES])
@property
def client(self):
"""Read-only accessor for the client connection."""
return self._client
@property
def last_devices(self):
"""Read-only accessor for last_devices."""
return self._last_devices
@property
def host(self):
"""Return the host of this hub."""
return self.config_entry.data[CONF_HOST]
@property
def device_info(self):
"""Return the host of this hub."""
return {
"identifiers": {(DOMAIN, f"router-{self.config_entry.entry_id}")},
"manufacturer": self.manufacturer,
"model": self.model,
"name": self.name,
"sw_version": self.firmware,
}
@property
def name(self):
"""Return the name of the hub."""
return self._router_info.name if self._router_info else self.host
@property
def model(self):
"""Return the model of the hub."""
return self._router_info.model if self._router_info else None
@property
def firmware(self):
"""Return the firmware of the hub."""
return self._router_info.fw_version if self._router_info else None
@property
def manufacturer(self):
"""Return the firmware of the hub."""
return self._router_info.manufacturer if self._router_info else None
@property
def available(self):
"""Return if the hub is connected."""
return self._available
@property
def consider_home_interval(self):
"""Config entry option defining number of seconds from last seen to away."""
return timedelta(seconds=self.config_entry.options[CONF_CONSIDER_HOME])
@property
def tracked_interfaces(self):
"""Tracked interfaces."""
return self._tracked_interfaces
@property
def signal_update(self):
"""Event specific per router entry to signal updates."""
return f"keenetic-update-{self.config_entry.entry_id}"
async def request_update(self):
"""Request an update."""
if self._progress is not None:
await self._progress
return
self._progress = self.hass.async_create_task(self.async_update())
await self._progress
self._progress = None
async def async_update(self):
"""Update devices information."""
await self.hass.async_add_executor_job(self._update_devices)
async_dispatcher_send(self.hass, self.signal_update)
async def async_setup(self):
"""Set up the connection."""
self._connection = TelnetConnection(
self.config_entry.data[CONF_HOST],
self.config_entry.data[CONF_PORT],
self.config_entry.data[CONF_USERNAME],
self.config_entry.data[CONF_PASSWORD],
)
self._client = Client(self._connection)
try:
await self.hass.async_add_executor_job(self._update_router_info)
except ConnectionException as error:
raise ConfigEntryNotReady from error
async def async_update_data(_now):
await self.request_update()
self._cancel_periodic_update = async_call_later(
self.hass,
self.config_entry.options[CONF_SCAN_INTERVAL],
async_update_data,
)
await async_update_data(dt_util.utcnow())
async def async_teardown(self):
"""Teardown up the connection."""
if self._cancel_periodic_update:
self._cancel_periodic_update()
self._connection.disconnect()
def _update_router_info(self):
try:
self._router_info = self._client.get_router_info()
self._available = True
except Exception:
self._available = False
raise
def _update_devices(self):
"""Get ARP from keenetic router."""
_LOGGER.debug("Fetching devices from router")
try:
_response = self._client.get_devices(
try_hotspot=self.config_entry.options[CONF_TRY_HOTSPOT],
include_arp=self.config_entry.options[CONF_INCLUDE_ARP],
include_associated=self.config_entry.
options[CONF_INCLUDE_ASSOCIATED],
)
self._last_devices = {
dev.mac: dev
for dev in _response
if dev.interface in self._tracked_interfaces
}
_LOGGER.debug("Successfully fetched data from router: %s",
str(_response))
self._router_info = self._client.get_router_info()
self._available = True
except ConnectionException:
_LOGGER.error("Error fetching data from router")
self._available = False
