mirror of
https://github.com/home-assistant/core
synced 2024-09-03 08:14:07 +02:00
95 lines
2.8 KiB
Python
95 lines
2.8 KiB
Python
"""Tracks devices by sending a ICMP echo request (ping)."""
|
|
from datetime import timedelta
|
|
import logging
|
|
import subprocess
|
|
import sys
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant import const, util
|
|
from homeassistant.components.device_tracker import PLATFORM_SCHEMA
|
|
from homeassistant.components.device_tracker.const import (
|
|
CONF_SCAN_INTERVAL,
|
|
SCAN_INTERVAL,
|
|
SOURCE_TYPE_ROUTER,
|
|
)
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
CONF_PING_COUNT = "count"
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Required(const.CONF_HOSTS): {cv.slug: cv.string},
|
|
vol.Optional(CONF_PING_COUNT, default=1): cv.positive_int,
|
|
}
|
|
)
|
|
|
|
|
|
class Host:
|
|
"""Host object with ping detection."""
|
|
|
|
def __init__(self, ip_address, dev_id, hass, config):
|
|
"""Initialize the Host pinger."""
|
|
self.hass = hass
|
|
self.ip_address = ip_address
|
|
self.dev_id = dev_id
|
|
self._count = config[CONF_PING_COUNT]
|
|
if sys.platform == "win32":
|
|
self._ping_cmd = ["ping", "-n", "1", "-w", "1000", self.ip_address]
|
|
else:
|
|
self._ping_cmd = ["ping", "-n", "-q", "-c1", "-W1", self.ip_address]
|
|
|
|
def ping(self):
|
|
"""Send an ICMP echo request and return True if success."""
|
|
pinger = subprocess.Popen(
|
|
self._ping_cmd, stdout=subprocess.PIPE, stderr=subprocess.DEVNULL
|
|
)
|
|
try:
|
|
pinger.communicate()
|
|
return pinger.returncode == 0
|
|
except subprocess.CalledProcessError:
|
|
return False
|
|
|
|
def update(self, see):
|
|
"""Update device state by sending one or more ping messages."""
|
|
failed = 0
|
|
while failed < self._count: # check more times if host is unreachable
|
|
if self.ping():
|
|
see(dev_id=self.dev_id, source_type=SOURCE_TYPE_ROUTER)
|
|
return True
|
|
failed += 1
|
|
|
|
_LOGGER.debug("No response from %s failed=%d", self.ip_address, failed)
|
|
|
|
|
|
def setup_scanner(hass, config, see, discovery_info=None):
|
|
"""Set up the Host objects and return the update function."""
|
|
hosts = [
|
|
Host(ip, dev_id, hass, config)
|
|
for (dev_id, ip) in config[const.CONF_HOSTS].items()
|
|
]
|
|
interval = config.get(
|
|
CONF_SCAN_INTERVAL,
|
|
timedelta(seconds=len(hosts) * config[CONF_PING_COUNT]) + SCAN_INTERVAL,
|
|
)
|
|
_LOGGER.debug(
|
|
"Started ping tracker with interval=%s on hosts: %s",
|
|
interval,
|
|
",".join([host.ip_address for host in hosts]),
|
|
)
|
|
|
|
def update_interval(now):
|
|
"""Update all the hosts on every interval time."""
|
|
try:
|
|
for host in hosts:
|
|
host.update(see)
|
|
finally:
|
|
hass.helpers.event.track_point_in_utc_time(
|
|
update_interval, util.dt.utcnow() + interval
|
|
)
|
|
|
|
update_interval(None)
|
|
return True
|