103 lines
3.5 KiB
Python
103 lines
3.5 KiB
Python
"""
|
|
Support for FRITZ!Box routers.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/device_tracker.fritz/
|
|
"""
|
|
import logging
|
|
from datetime import timedelta
|
|
|
|
import voluptuous as vol
|
|
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.components.device_tracker import DOMAIN, PLATFORM_SCHEMA
|
|
from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
|
|
from homeassistant.util import Throttle
|
|
|
|
REQUIREMENTS = ['https://github.com/deisi/fritzconnection/archive/'
|
|
'b5c14515e1c8e2652b06b6316a7f3913df942841.zip'
|
|
'#fritzconnection==0.4.6']
|
|
|
|
# Return cached results if last scan was less then this time ago.
|
|
MIN_TIME_BETWEEN_SCANS = timedelta(seconds=5)
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
CONF_DEFAULT_IP = '169.254.1.1' # This IP is valid for all FRITZ!Box routers.
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Optional(CONF_HOST, default=CONF_DEFAULT_IP): cv.string,
|
|
vol.Optional(CONF_PASSWORD, default='admin'): cv.string,
|
|
vol.Optional(CONF_USERNAME, default=''): cv.string
|
|
})
|
|
|
|
|
|
def get_scanner(hass, config):
|
|
"""Validate the configuration and return FritzBoxScanner."""
|
|
scanner = FritzBoxScanner(config[DOMAIN])
|
|
return scanner if scanner.success_init else None
|
|
|
|
|
|
class FritzBoxScanner(object):
|
|
"""This class queries a FRITZ!Box router."""
|
|
|
|
def __init__(self, config):
|
|
"""Initialize the scanner."""
|
|
self.last_results = []
|
|
self.host = config[CONF_HOST]
|
|
self.username = config[CONF_USERNAME]
|
|
self.password = config[CONF_PASSWORD]
|
|
self.success_init = True
|
|
|
|
# pylint: disable=import-error
|
|
import fritzconnection as fc
|
|
|
|
# Establish a connection to the FRITZ!Box.
|
|
try:
|
|
self.fritz_box = fc.FritzHosts(address=self.host,
|
|
user=self.username,
|
|
password=self.password)
|
|
except (ValueError, TypeError):
|
|
self.fritz_box = None
|
|
|
|
# At this point it is difficult to tell if a connection is established.
|
|
# So just check for null objects.
|
|
if self.fritz_box is None or not self.fritz_box.modelname:
|
|
self.success_init = False
|
|
|
|
if self.success_init:
|
|
_LOGGER.info('Successfully connected to %s',
|
|
self.fritz_box.modelname)
|
|
self._update_info()
|
|
else:
|
|
_LOGGER.error('Failed to establish connection to FRITZ!Box '
|
|
'with IP: %s', self.host)
|
|
|
|
def scan_devices(self):
|
|
"""Scan for new devices and return a list of found device ids."""
|
|
self._update_info()
|
|
active_hosts = []
|
|
for known_host in self.last_results:
|
|
if known_host['status'] == '1' and known_host.get('mac'):
|
|
active_hosts.append(known_host['mac'])
|
|
return active_hosts
|
|
|
|
def get_device_name(self, mac):
|
|
"""Return the name of the given device or None if is not known."""
|
|
ret = self.fritz_box.get_specific_host_entry(mac).get(
|
|
'NewHostName'
|
|
)
|
|
if ret == {}:
|
|
return None
|
|
return ret
|
|
|
|
@Throttle(MIN_TIME_BETWEEN_SCANS)
|
|
def _update_info(self):
|
|
"""Retrieve latest information from the FRITZ!Box."""
|
|
if not self.success_init:
|
|
return False
|
|
|
|
_LOGGER.info('Scanning')
|
|
self.last_results = self.fritz_box.get_hosts_info()
|
|
return True
|