Black
This commit is contained in:
1 parent
da05dfe708
commit
4de97abc3a
2676 files changed
+163166
-140084
No files matched your search
@@ -14,7 +14,8 @@ from homeassistant.const import ATTR_GPS_ACCURACY, STATE_HOME
|
||||
|
||||
from . import legacy, setup
|
||||
from .config_entry import ( # noqa # pylint: disable=unused-import
|
||||
async_setup_entry, async_unload_entry
|
||||
async_setup_entry,
|
||||
async_unload_entry,
|
||||
)
|
||||
from .legacy import DeviceScanner # noqa # pylint: disable=unused-import
|
||||
from .const import (
|
||||
@@ -43,43 +44,57 @@ from .const import (
|
||||
SOURCE_TYPE_ROUTER,
|
||||
)
|
||||
|
||||
ENTITY_ID_ALL_DEVICES = group.ENTITY_ID_FORMAT.format('all_devices')
|
||||
ENTITY_ID_ALL_DEVICES = group.ENTITY_ID_FORMAT.format("all_devices")
|
||||
|
||||
SERVICE_SEE = 'see'
|
||||
SERVICE_SEE = "see"
|
||||
|
||||
SOURCE_TYPES = (SOURCE_TYPE_GPS, SOURCE_TYPE_ROUTER,
|
||||
SOURCE_TYPE_BLUETOOTH, SOURCE_TYPE_BLUETOOTH_LE)
|
||||
SOURCE_TYPES = (
|
||||
SOURCE_TYPE_GPS,
|
||||
SOURCE_TYPE_ROUTER,
|
||||
SOURCE_TYPE_BLUETOOTH,
|
||||
SOURCE_TYPE_BLUETOOTH_LE,
|
||||
)
|
||||
|
||||
NEW_DEVICE_DEFAULTS_SCHEMA = vol.Any(None, vol.Schema({
|
||||
vol.Optional(CONF_TRACK_NEW, default=DEFAULT_TRACK_NEW): cv.boolean,
|
||||
vol.Optional(CONF_AWAY_HIDE, default=DEFAULT_AWAY_HIDE): cv.boolean,
|
||||
}))
|
||||
PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA.extend({
|
||||
vol.Optional(CONF_SCAN_INTERVAL): cv.time_period,
|
||||
vol.Optional(CONF_TRACK_NEW): cv.boolean,
|
||||
vol.Optional(CONF_CONSIDER_HOME,
|
||||
default=DEFAULT_CONSIDER_HOME): vol.All(
|
||||
cv.time_period, cv.positive_timedelta),
|
||||
vol.Optional(CONF_NEW_DEVICE_DEFAULTS,
|
||||
default={}): NEW_DEVICE_DEFAULTS_SCHEMA
|
||||
})
|
||||
NEW_DEVICE_DEFAULTS_SCHEMA = vol.Any(
|
||||
None,
|
||||
vol.Schema(
|
||||
{
|
||||
vol.Optional(CONF_TRACK_NEW, default=DEFAULT_TRACK_NEW): cv.boolean,
|
||||
vol.Optional(CONF_AWAY_HIDE, default=DEFAULT_AWAY_HIDE): cv.boolean,
|
||||
}
|
||||
),
|
||||
)
|
||||
PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA.extend(
|
||||
{
|
||||
vol.Optional(CONF_SCAN_INTERVAL): cv.time_period,
|
||||
vol.Optional(CONF_TRACK_NEW): cv.boolean,
|
||||
vol.Optional(CONF_CONSIDER_HOME, default=DEFAULT_CONSIDER_HOME): vol.All(
|
||||
cv.time_period, cv.positive_timedelta
|
||||
),
|
||||
vol.Optional(CONF_NEW_DEVICE_DEFAULTS, default={}): NEW_DEVICE_DEFAULTS_SCHEMA,
|
||||
}
|
||||
)
|
||||
PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE.extend(PLATFORM_SCHEMA.schema)
|
||||
SERVICE_SEE_PAYLOAD_SCHEMA = vol.Schema(vol.All(
|
||||
cv.has_at_least_one_key(ATTR_MAC, ATTR_DEV_ID), {
|
||||
ATTR_MAC: cv.string,
|
||||
ATTR_DEV_ID: cv.string,
|
||||
ATTR_HOST_NAME: cv.string,
|
||||
ATTR_LOCATION_NAME: cv.string,
|
||||
ATTR_GPS: cv.gps,
|
||||
ATTR_GPS_ACCURACY: cv.positive_int,
|
||||
ATTR_BATTERY: cv.positive_int,
|
||||
ATTR_ATTRIBUTES: dict,
|
||||
ATTR_SOURCE_TYPE: vol.In(SOURCE_TYPES),
|
||||
ATTR_CONSIDER_HOME: cv.time_period,
|
||||
# Temp workaround for iOS app introduced in 0.65
|
||||
vol.Optional('battery_status'): str,
|
||||
vol.Optional('hostname'): str,
|
||||
}))
|
||||
SERVICE_SEE_PAYLOAD_SCHEMA = vol.Schema(
|
||||
vol.All(
|
||||
cv.has_at_least_one_key(ATTR_MAC, ATTR_DEV_ID),
|
||||
{
|
||||
ATTR_MAC: cv.string,
|
||||
ATTR_DEV_ID: cv.string,
|
||||
ATTR_HOST_NAME: cv.string,
|
||||
ATTR_LOCATION_NAME: cv.string,
|
||||
ATTR_GPS: cv.gps,
|
||||
ATTR_GPS_ACCURACY: cv.positive_int,
|
||||
ATTR_BATTERY: cv.positive_int,
|
||||
ATTR_ATTRIBUTES: dict,
|
||||
ATTR_SOURCE_TYPE: vol.In(SOURCE_TYPES),
|
||||
ATTR_CONSIDER_HOME: cv.time_period,
|
||||
# Temp workaround for iOS app introduced in 0.65
|
||||
vol.Optional("battery_status"): str,
|
||||
vol.Optional("hostname"): str,
|
||||
},
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
@bind_hass
|
||||
@@ -90,19 +105,31 @@ def is_on(hass: HomeAssistantType, entity_id: str = None):
|
||||
return hass.states.is_state(entity, STATE_HOME)
|
||||
|
||||
|
||||
def see(hass: HomeAssistantType, mac: str = None, dev_id: str = None,
|
||||
host_name: str = None, location_name: str = None,
|
||||
gps: GPSType = None, gps_accuracy=None,
|
||||
battery: int = None, attributes: dict = None):
|
||||
def see(
|
||||
hass: HomeAssistantType,
|
||||
mac: str = None,
|
||||
dev_id: str = None,
|
||||
host_name: str = None,
|
||||
location_name: str = None,
|
||||
gps: GPSType = None,
|
||||
gps_accuracy=None,
|
||||
battery: int = None,
|
||||
attributes: dict = None,
|
||||
):
|
||||
"""Call service to notify you see device."""
|
||||
data = {key: value for key, value in
|
||||
((ATTR_MAC, mac),
|
||||
(ATTR_DEV_ID, dev_id),
|
||||
(ATTR_HOST_NAME, host_name),
|
||||
(ATTR_LOCATION_NAME, location_name),
|
||||
(ATTR_GPS, gps),
|
||||
(ATTR_GPS_ACCURACY, gps_accuracy),
|
||||
(ATTR_BATTERY, battery)) if value is not None}
|
||||
data = {
|
||||
key: value
|
||||
for key, value in (
|
||||
(ATTR_MAC, mac),
|
||||
(ATTR_DEV_ID, dev_id),
|
||||
(ATTR_HOST_NAME, host_name),
|
||||
(ATTR_LOCATION_NAME, location_name),
|
||||
(ATTR_GPS, gps),
|
||||
(ATTR_GPS_ACCURACY, gps_accuracy),
|
||||
(ATTR_BATTERY, battery),
|
||||
)
|
||||
if value is not None
|
||||
}
|
||||
if attributes:
|
||||
data[ATTR_ATTRIBUTES] = attributes
|
||||
hass.services.call(DOMAIN, SERVICE_SEE, data)
|
||||
@@ -126,8 +153,7 @@ async def async_setup(hass: HomeAssistantType, config: ConfigType):
|
||||
|
||||
async def async_platform_discovered(p_type, info):
|
||||
"""Load a platform."""
|
||||
platform = await setup.async_create_platform_type(
|
||||
hass, config, p_type, {})
|
||||
platform = await setup.async_create_platform_type(hass, config, p_type, {})
|
||||
|
||||
if platform is None or platform.type != PLATFORM_TYPE_LEGACY:
|
||||
return
|
||||
@@ -138,18 +164,20 @@ async def async_setup(hass: HomeAssistantType, config: ConfigType):
|
||||
|
||||
# Clean up stale devices
|
||||
async_track_utc_time_change(
|
||||
hass, tracker.async_update_stale, second=range(0, 60, 5))
|
||||
hass, tracker.async_update_stale, second=range(0, 60, 5)
|
||||
)
|
||||
|
||||
async def async_see_service(call):
|
||||
"""Service to see a device."""
|
||||
# Temp workaround for iOS, introduced in 0.65
|
||||
data = dict(call.data)
|
||||
data.pop('hostname', None)
|
||||
data.pop('battery_status', None)
|
||||
data.pop("hostname", None)
|
||||
data.pop("battery_status", None)
|
||||
await tracker.async_see(**data)
|
||||
|
||||
hass.services.async_register(
|
||||
DOMAIN, SERVICE_SEE, async_see_service, SERVICE_SEE_PAYLOAD_SCHEMA)
|
||||
DOMAIN, SERVICE_SEE, async_see_service, SERVICE_SEE_PAYLOAD_SCHEMA
|
||||
)
|
||||
|
||||
# restore
|
||||
await tracker.async_setup_tracked_device()
|
||||
|
||||
@@ -13,11 +13,7 @@ from homeassistant.const import (
|
||||
from homeassistant.helpers.entity import Entity
|
||||
from homeassistant.helpers.entity_component import EntityComponent
|
||||
|
||||
from .const import (
|
||||
ATTR_SOURCE_TYPE,
|
||||
DOMAIN,
|
||||
LOGGER,
|
||||
)
|
||||
from .const import ATTR_SOURCE_TYPE, DOMAIN, LOGGER
|
||||
|
||||
|
||||
async def async_setup_entry(hass, entry):
|
||||
@@ -25,9 +21,7 @@ async def async_setup_entry(hass, entry):
|
||||
component = hass.data.get(DOMAIN) # type: Optional[EntityComponent]
|
||||
|
||||
if component is None:
|
||||
component = hass.data[DOMAIN] = EntityComponent(
|
||||
LOGGER, DOMAIN, hass
|
||||
)
|
||||
component = hass.data[DOMAIN] = EntityComponent(LOGGER, DOMAIN, hass)
|
||||
|
||||
return await component.async_setup_entry(entry)
|
||||
|
||||
@@ -56,9 +50,7 @@ class BaseTrackerEntity(Entity):
|
||||
@property
|
||||
def state_attributes(self):
|
||||
"""Return the device state attributes."""
|
||||
attr = {
|
||||
ATTR_SOURCE_TYPE: self.source_type
|
||||
}
|
||||
attr = {ATTR_SOURCE_TYPE: self.source_type}
|
||||
|
||||
if self.battery_level:
|
||||
attr[ATTR_BATTERY_LEVEL] = self.battery_level
|
||||
@@ -100,8 +92,8 @@ class TrackerEntity(BaseTrackerEntity):
|
||||
|
||||
if self.latitude is not None:
|
||||
zone_state = zone.async_active_zone(
|
||||
self.hass, self.latitude, self.longitude,
|
||||
self.location_accuracy)
|
||||
self.hass, self.latitude, self.longitude, self.location_accuracy
|
||||
)
|
||||
if zone_state is None:
|
||||
state = STATE_NOT_HOME
|
||||
elif zone_state.entity_id == zone.ENTITY_ID_HOME:
|
||||
|
||||
@@ -4,37 +4,37 @@ import logging
|
||||
|
||||
LOGGER = logging.getLogger(__package__)
|
||||
|
||||
DOMAIN = 'device_tracker'
|
||||
ENTITY_ID_FORMAT = DOMAIN + '.{}'
|
||||
DOMAIN = "device_tracker"
|
||||
ENTITY_ID_FORMAT = DOMAIN + ".{}"
|
||||
|
||||
PLATFORM_TYPE_LEGACY = 'legacy'
|
||||
PLATFORM_TYPE_ENTITY = 'entity_platform'
|
||||
PLATFORM_TYPE_LEGACY = "legacy"
|
||||
PLATFORM_TYPE_ENTITY = "entity_platform"
|
||||
|
||||
SOURCE_TYPE_GPS = 'gps'
|
||||
SOURCE_TYPE_ROUTER = 'router'
|
||||
SOURCE_TYPE_BLUETOOTH = 'bluetooth'
|
||||
SOURCE_TYPE_BLUETOOTH_LE = 'bluetooth_le'
|
||||
SOURCE_TYPE_GPS = "gps"
|
||||
SOURCE_TYPE_ROUTER = "router"
|
||||
SOURCE_TYPE_BLUETOOTH = "bluetooth"
|
||||
SOURCE_TYPE_BLUETOOTH_LE = "bluetooth_le"
|
||||
|
||||
CONF_SCAN_INTERVAL = 'interval_seconds'
|
||||
CONF_SCAN_INTERVAL = "interval_seconds"
|
||||
SCAN_INTERVAL = timedelta(seconds=12)
|
||||
|
||||
CONF_TRACK_NEW = 'track_new_devices'
|
||||
CONF_TRACK_NEW = "track_new_devices"
|
||||
DEFAULT_TRACK_NEW = True
|
||||
|
||||
CONF_AWAY_HIDE = 'hide_if_away'
|
||||
CONF_AWAY_HIDE = "hide_if_away"
|
||||
DEFAULT_AWAY_HIDE = False
|
||||
|
||||
CONF_CONSIDER_HOME = 'consider_home'
|
||||
CONF_CONSIDER_HOME = "consider_home"
|
||||
DEFAULT_CONSIDER_HOME = timedelta(seconds=180)
|
||||
|
||||
CONF_NEW_DEVICE_DEFAULTS = 'new_device_defaults'
|
||||
CONF_NEW_DEVICE_DEFAULTS = "new_device_defaults"
|
||||
|
||||
ATTR_ATTRIBUTES = 'attributes'
|
||||
ATTR_BATTERY = 'battery'
|
||||
ATTR_DEV_ID = 'dev_id'
|
||||
ATTR_GPS = 'gps'
|
||||
ATTR_HOST_NAME = 'host_name'
|
||||
ATTR_LOCATION_NAME = 'location_name'
|
||||
ATTR_MAC = 'mac'
|
||||
ATTR_SOURCE_TYPE = 'source_type'
|
||||
ATTR_CONSIDER_HOME = 'consider_home'
|
||||
ATTR_ATTRIBUTES = "attributes"
|
||||
ATTR_BATTERY = "battery"
|
||||
ATTR_DEV_ID = "dev_id"
|
||||
ATTR_GPS = "gps"
|
||||
ATTR_HOST_NAME = "host_name"
|
||||
ATTR_LOCATION_NAME = "location_name"
|
||||
ATTR_MAC = "mac"
|
||||
ATTR_SOURCE_TYPE = "source_type"
|
||||
ATTR_CONSIDER_HOME = "consider_home"
|
||||
@@ -8,8 +8,13 @@ import voluptuous as vol
|
||||
from homeassistant.core import callback
|
||||
from homeassistant.components import zone
|
||||
from homeassistant.components.group import (
|
||||
ATTR_ADD_ENTITIES, ATTR_ENTITIES, ATTR_OBJECT_ID, ATTR_VISIBLE,
|
||||
DOMAIN as DOMAIN_GROUP, SERVICE_SET)
|
||||
ATTR_ADD_ENTITIES,
|
||||
ATTR_ENTITIES,
|
||||
ATTR_OBJECT_ID,
|
||||
ATTR_VISIBLE,
|
||||
DOMAIN as DOMAIN_GROUP,
|
||||
SERVICE_SET,
|
||||
)
|
||||
from homeassistant.components.zone import async_active_zone
|
||||
from homeassistant.config import load_yaml_config_file, async_log_exception
|
||||
from homeassistant.exceptions import HomeAssistantError
|
||||
@@ -22,9 +27,19 @@ import homeassistant.util.dt as dt_util
|
||||
from homeassistant.util.yaml import dump
|
||||
|
||||
from homeassistant.const import (
|
||||
ATTR_ENTITY_ID, ATTR_GPS_ACCURACY, ATTR_ICON, ATTR_LATITUDE,
|
||||
ATTR_LONGITUDE, ATTR_NAME, CONF_ICON, CONF_MAC, CONF_NAME,
|
||||
DEVICE_DEFAULT_NAME, STATE_NOT_HOME, STATE_HOME)
|
||||
ATTR_ENTITY_ID,
|
||||
ATTR_GPS_ACCURACY,
|
||||
ATTR_ICON,
|
||||
ATTR_LATITUDE,
|
||||
ATTR_LONGITUDE,
|
||||
ATTR_NAME,
|
||||
CONF_ICON,
|
||||
CONF_MAC,
|
||||
CONF_NAME,
|
||||
DEVICE_DEFAULT_NAME,
|
||||
STATE_NOT_HOME,
|
||||
STATE_HOME,
|
||||
)
|
||||
|
||||
from .const import (
|
||||
ATTR_BATTERY,
|
||||
@@ -44,9 +59,9 @@ from .const import (
|
||||
SOURCE_TYPE_GPS,
|
||||
)
|
||||
|
||||
YAML_DEVICES = 'known_devices.yaml'
|
||||
GROUP_NAME_ALL_DEVICES = 'all devices'
|
||||
EVENT_NEW_DEVICE = 'device_tracker_new_device'
|
||||
YAML_DEVICES = "known_devices.yaml"
|
||||
GROUP_NAME_ALL_DEVICES = "all devices"
|
||||
EVENT_NEW_DEVICE = "device_tracker_new_device"
|
||||
|
||||
|
||||
async def get_tracker(hass, config):
|
||||
@@ -63,75 +78,116 @@ async def get_tracker(hass, config):
|
||||
track_new = defaults.get(CONF_TRACK_NEW, DEFAULT_TRACK_NEW)
|
||||
|
||||
devices = await async_load_config(yaml_path, hass, consider_home)
|
||||
tracker = DeviceTracker(
|
||||
hass, consider_home, track_new, defaults, devices)
|
||||
tracker = DeviceTracker(hass, consider_home, track_new, defaults, devices)
|
||||
return tracker
|
||||
|
||||
|
||||
class DeviceTracker:
|
||||
"""Representation of a device tracker."""
|
||||
|
||||
def __init__(self, hass: HomeAssistantType, consider_home: timedelta,
|
||||
track_new: bool, defaults: dict,
|
||||
devices: Sequence) -> None:
|
||||
def __init__(
|
||||
self,
|
||||
hass: HomeAssistantType,
|
||||
consider_home: timedelta,
|
||||
track_new: bool,
|
||||
defaults: dict,
|
||||
devices: Sequence,
|
||||
) -> None:
|
||||
"""Initialize a device tracker."""
|
||||
self.hass = hass
|
||||
self.devices = {dev.dev_id: dev for dev in devices}
|
||||
self.mac_to_dev = {dev.mac: dev for dev in devices if dev.mac}
|
||||
self.consider_home = consider_home
|
||||
self.track_new = track_new if track_new is not None \
|
||||
self.track_new = (
|
||||
track_new
|
||||
if track_new is not None
|
||||
else defaults.get(CONF_TRACK_NEW, DEFAULT_TRACK_NEW)
|
||||
)
|
||||
self.defaults = defaults
|
||||
self.group = None
|
||||
self._is_updating = asyncio.Lock()
|
||||
|
||||
for dev in devices:
|
||||
if self.devices[dev.dev_id] is not dev:
|
||||
LOGGER.warning('Duplicate device IDs detected %s', dev.dev_id)
|
||||
LOGGER.warning("Duplicate device IDs detected %s", dev.dev_id)
|
||||
if dev.mac and self.mac_to_dev[dev.mac] is not dev:
|
||||
LOGGER.warning('Duplicate device MAC addresses detected %s',
|
||||
dev.mac)
|
||||
LOGGER.warning("Duplicate device MAC addresses detected %s", dev.mac)
|
||||
|
||||
def see(self, mac: str = None, dev_id: str = None, host_name: str = None,
|
||||
location_name: str = None, gps: GPSType = None,
|
||||
gps_accuracy: int = None, battery: int = None,
|
||||
attributes: dict = None, source_type: str = SOURCE_TYPE_GPS,
|
||||
picture: str = None, icon: str = None,
|
||||
consider_home: timedelta = None):
|
||||
def see(
|
||||
self,
|
||||
mac: str = None,
|
||||
dev_id: str = None,
|
||||
host_name: str = None,
|
||||
location_name: str = None,
|
||||
gps: GPSType = None,
|
||||
gps_accuracy: int = None,
|
||||
battery: int = None,
|
||||
attributes: dict = None,
|
||||
source_type: str = SOURCE_TYPE_GPS,
|
||||
picture: str = None,
|
||||
icon: str = None,
|
||||
consider_home: timedelta = None,
|
||||
):
|
||||
"""Notify the device tracker that you see a device."""
|
||||
self.hass.add_job(
|
||||
self.async_see(mac, dev_id, host_name, location_name, gps,
|
||||
gps_accuracy, battery, attributes, source_type,
|
||||
picture, icon, consider_home)
|
||||
self.async_see(
|
||||
mac,
|
||||
dev_id,
|
||||
host_name,
|
||||
location_name,
|
||||
gps,
|
||||
gps_accuracy,
|
||||
battery,
|
||||
attributes,
|
||||
source_type,
|
||||
picture,
|
||||
icon,
|
||||
consider_home,
|
||||
)
|
||||
)
|
||||
|
||||
async def async_see(
|
||||
self, mac: str = None, dev_id: str = None, host_name: str = None,
|
||||
location_name: str = None, gps: GPSType = None,
|
||||
gps_accuracy: int = None, battery: int = None,
|
||||
attributes: dict = None, source_type: str = SOURCE_TYPE_GPS,
|
||||
picture: str = None, icon: str = None,
|
||||
consider_home: timedelta = None):
|
||||
self,
|
||||
mac: str = None,
|
||||
dev_id: str = None,
|
||||
host_name: str = None,
|
||||
location_name: str = None,
|
||||
gps: GPSType = None,
|
||||
gps_accuracy: int = None,
|
||||
battery: int = None,
|
||||
attributes: dict = None,
|
||||
source_type: str = SOURCE_TYPE_GPS,
|
||||
picture: str = None,
|
||||
icon: str = None,
|
||||
consider_home: timedelta = None,
|
||||
):
|
||||
"""Notify the device tracker that you see a device.
|
||||
|
||||
This method is a coroutine.
|
||||
"""
|
||||
registry = await async_get_registry(self.hass)
|
||||
if mac is None and dev_id is None:
|
||||
raise HomeAssistantError('Neither mac or device id passed in')
|
||||
raise HomeAssistantError("Neither mac or device id passed in")
|
||||
if mac is not None:
|
||||
mac = str(mac).upper()
|
||||
device = self.mac_to_dev.get(mac)
|
||||
if not device:
|
||||
dev_id = util.slugify(host_name or '') or util.slugify(mac)
|
||||
dev_id = util.slugify(host_name or "") or util.slugify(mac)
|
||||
else:
|
||||
dev_id = cv.slug(str(dev_id).lower())
|
||||
device = self.devices.get(dev_id)
|
||||
|
||||
if device:
|
||||
await device.async_seen(
|
||||
host_name, location_name, gps, gps_accuracy, battery,
|
||||
attributes, source_type, consider_home)
|
||||
host_name,
|
||||
location_name,
|
||||
gps,
|
||||
gps_accuracy,
|
||||
battery,
|
||||
attributes,
|
||||
source_type,
|
||||
consider_home,
|
||||
)
|
||||
if device.track:
|
||||
await device.async_update_ha_state()
|
||||
return
|
||||
@@ -140,24 +196,36 @@ class DeviceTracker:
|
||||
entity_id = ENTITY_ID_FORMAT.format(dev_id)
|
||||
if registry.async_is_registered(entity_id):
|
||||
LOGGER.error(
|
||||
"The see service is not supported for this entity %s",
|
||||
entity_id)
|
||||
"The see service is not supported for this entity %s", entity_id
|
||||
)
|
||||
return
|
||||
|
||||
# If no device can be found, create it
|
||||
dev_id = util.ensure_unique_string(dev_id, self.devices.keys())
|
||||
device = Device(
|
||||
self.hass, consider_home or self.consider_home, self.track_new,
|
||||
dev_id, mac, (host_name or dev_id).replace('_', ' '),
|
||||
picture=picture, icon=icon,
|
||||
hide_if_away=self.defaults.get(CONF_AWAY_HIDE, DEFAULT_AWAY_HIDE))
|
||||
self.hass,
|
||||
consider_home or self.consider_home,
|
||||
self.track_new,
|
||||
dev_id,
|
||||
mac,
|
||||
(host_name or dev_id).replace("_", " "),
|
||||
picture=picture,
|
||||
icon=icon,
|
||||
hide_if_away=self.defaults.get(CONF_AWAY_HIDE, DEFAULT_AWAY_HIDE),
|
||||
)
|
||||
self.devices[dev_id] = device
|
||||
if mac is not None:
|
||||
self.mac_to_dev[mac] = device
|
||||
|
||||
await device.async_seen(
|
||||
host_name, location_name, gps, gps_accuracy, battery, attributes,
|
||||
source_type)
|
||||
host_name,
|
||||
location_name,
|
||||
gps,
|
||||
gps_accuracy,
|
||||
battery,
|
||||
attributes,
|
||||
source_type,
|
||||
)
|
||||
|
||||
if device.track:
|
||||
await device.async_update_ha_state()
|
||||
@@ -166,22 +234,31 @@ class DeviceTracker:
|
||||
if self.group and self.track_new:
|
||||
self.hass.async_create_task(
|
||||
self.hass.async_call(
|
||||
DOMAIN_GROUP, SERVICE_SET, {
|
||||
DOMAIN_GROUP,
|
||||
SERVICE_SET,
|
||||
{
|
||||
ATTR_OBJECT_ID: util.slugify(GROUP_NAME_ALL_DEVICES),
|
||||
ATTR_VISIBLE: False,
|
||||
ATTR_NAME: GROUP_NAME_ALL_DEVICES,
|
||||
ATTR_ADD_ENTITIES: [device.entity_id]}))
|
||||
ATTR_ADD_ENTITIES: [device.entity_id],
|
||||
},
|
||||
)
|
||||
)
|
||||
|
||||
self.hass.bus.async_fire(EVENT_NEW_DEVICE, {
|
||||
ATTR_ENTITY_ID: device.entity_id,
|
||||
ATTR_HOST_NAME: device.host_name,
|
||||
ATTR_MAC: device.mac,
|
||||
})
|
||||
self.hass.bus.async_fire(
|
||||
EVENT_NEW_DEVICE,
|
||||
{
|
||||
ATTR_ENTITY_ID: device.entity_id,
|
||||
ATTR_HOST_NAME: device.host_name,
|
||||
ATTR_MAC: device.mac,
|
||||
},
|
||||
)
|
||||
|
||||
# update known_devices.yaml
|
||||
self.hass.async_create_task(
|
||||
self.async_update_config(
|
||||
self.hass.config.path(YAML_DEVICES), dev_id, device)
|
||||
self.hass.config.path(YAML_DEVICES), dev_id, device
|
||||
)
|
||||
)
|
||||
|
||||
async def async_update_config(self, path, dev_id, device):
|
||||
@@ -191,8 +268,8 @@ class DeviceTracker:
|
||||
"""
|
||||
async with self._is_updating:
|
||||
await self.hass.async_add_executor_job(
|
||||
update_config, self.hass.config.path(YAML_DEVICES),
|
||||
dev_id, device)
|
||||
update_config, self.hass.config.path(YAML_DEVICES), dev_id, device
|
||||
)
|
||||
|
||||
@callback
|
||||
def async_setup_group(self):
|
||||
@@ -200,16 +277,20 @@ class DeviceTracker:
|
||||
|
||||
This method must be run in the event loop.
|
||||
"""
|
||||
entity_ids = [dev.entity_id for dev in self.devices.values()
|
||||
if dev.track]
|
||||
entity_ids = [dev.entity_id for dev in self.devices.values() if dev.track]
|
||||
|
||||
self.hass.async_create_task(
|
||||
self.hass.services.async_call(
|
||||
DOMAIN_GROUP, SERVICE_SET, {
|
||||
DOMAIN_GROUP,
|
||||
SERVICE_SET,
|
||||
{
|
||||
ATTR_OBJECT_ID: util.slugify(GROUP_NAME_ALL_DEVICES),
|
||||
ATTR_VISIBLE: False,
|
||||
ATTR_NAME: GROUP_NAME_ALL_DEVICES,
|
||||
ATTR_ENTITIES: entity_ids}))
|
||||
ATTR_ENTITIES: entity_ids,
|
||||
},
|
||||
)
|
||||
)
|
||||
|
||||
@callback
|
||||
def async_update_stale(self, now: dt_util.dt.datetime):
|
||||
@@ -218,8 +299,7 @@ class DeviceTracker:
|
||||
This method must be run in the event loop.
|
||||
"""
|
||||
for device in self.devices.values():
|
||||
if (device.track and device.last_update_home) and \
|
||||
device.stale(now):
|
||||
if (device.track and device.last_update_home) and device.stale(now):
|
||||
self.hass.async_create_task(device.async_update_ha_state(True))
|
||||
|
||||
async def async_setup_tracked_device(self):
|
||||
@@ -227,6 +307,7 @@ class DeviceTracker:
|
||||
|
||||
This method is a coroutine.
|
||||
"""
|
||||
|
||||
async def async_init_single_device(dev):
|
||||
"""Init a single device_tracker entity."""
|
||||
await dev.async_added_to_hass()
|
||||
@@ -235,8 +316,9 @@ class DeviceTracker:
|
||||
tasks = []
|
||||
for device in self.devices.values():
|
||||
if device.track and not device.last_seen:
|
||||
tasks.append(self.hass.async_create_task(
|
||||
async_init_single_device(device)))
|
||||
tasks.append(
|
||||
self.hass.async_create_task(async_init_single_device(device))
|
||||
)
|
||||
|
||||
if tasks:
|
||||
await asyncio.wait(tasks)
|
||||
@@ -259,10 +341,19 @@ class Device(RestoreEntity):
|
||||
last_update_home = False
|
||||
_state = STATE_NOT_HOME
|
||||
|
||||
def __init__(self, hass: HomeAssistantType, consider_home: timedelta,
|
||||
track: bool, dev_id: str, mac: str, name: str = None,
|
||||
picture: str = None, gravatar: str = None, icon: str = None,
|
||||
hide_if_away: bool = False) -> None:
|
||||
def __init__(
|
||||
self,
|
||||
hass: HomeAssistantType,
|
||||
consider_home: timedelta,
|
||||
track: bool,
|
||||
dev_id: str,
|
||||
mac: str,
|
||||
name: str = None,
|
||||
picture: str = None,
|
||||
gravatar: str = None,
|
||||
icon: str = None,
|
||||
hide_if_away: bool = False,
|
||||
) -> None:
|
||||
"""Initialize a device."""
|
||||
self.hass = hass
|
||||
self.entity_id = ENTITY_ID_FORMAT.format(dev_id)
|
||||
@@ -313,9 +404,7 @@ class Device(RestoreEntity):
|
||||
@property
|
||||
def state_attributes(self):
|
||||
"""Return the device state attributes."""
|
||||
attr = {
|
||||
ATTR_SOURCE_TYPE: self.source_type
|
||||
}
|
||||
attr = {ATTR_SOURCE_TYPE: self.source_type}
|
||||
|
||||
if self.gps:
|
||||
attr[ATTR_LATITUDE] = self.gps[0]
|
||||
@@ -338,11 +427,16 @@ class Device(RestoreEntity):
|
||||
return self.away_hide and self.state != STATE_HOME
|
||||
|
||||
async def async_seen(
|
||||
self, host_name: str = None, location_name: str = None,
|
||||
gps: GPSType = None, gps_accuracy=0, battery: int = None,
|
||||
attributes: dict = None,
|
||||
source_type: str = SOURCE_TYPE_GPS,
|
||||
consider_home: timedelta = None):
|
||||
self,
|
||||
host_name: str = None,
|
||||
location_name: str = None,
|
||||
gps: GPSType = None,
|
||||
gps_accuracy=0,
|
||||
battery: int = None,
|
||||
attributes: dict = None,
|
||||
source_type: str = SOURCE_TYPE_GPS,
|
||||
consider_home: timedelta = None,
|
||||
):
|
||||
"""Mark the device as seen."""
|
||||
self.source_type = source_type
|
||||
self.last_seen = dt_util.utcnow()
|
||||
@@ -364,8 +458,7 @@ class Device(RestoreEntity):
|
||||
except (ValueError, TypeError, IndexError):
|
||||
self.gps = None
|
||||
self.gps_accuracy = 0
|
||||
LOGGER.warning(
|
||||
"Could not parse gps value for %s: %s", self.dev_id, gps)
|
||||
LOGGER.warning("Could not parse gps value for %s: %s", self.dev_id, gps)
|
||||
|
||||
# pylint: disable=not-an-iterable
|
||||
await self.async_update()
|
||||
@@ -375,8 +468,10 @@ class Device(RestoreEntity):
|
||||
|
||||
Async friendly.
|
||||
"""
|
||||
return self.last_seen is None or \
|
||||
(now or dt_util.utcnow()) - self.last_seen > self.consider_home
|
||||
return (
|
||||
self.last_seen is None
|
||||
or (now or dt_util.utcnow()) - self.last_seen > self.consider_home
|
||||
)
|
||||
|
||||
def mark_stale(self):
|
||||
"""Mark the device state as stale."""
|
||||
@@ -395,7 +490,8 @@ class Device(RestoreEntity):
|
||||
self._state = self.location_name
|
||||
elif self.gps is not None and self.source_type == SOURCE_TYPE_GPS:
|
||||
zone_state = async_active_zone(
|
||||
self.hass, self.gps[0], self.gps[1], self.gps_accuracy)
|
||||
self.hass, self.gps[0], self.gps[1], self.gps_accuracy
|
||||
)
|
||||
if zone_state is None:
|
||||
self._state = STATE_NOT_HOME
|
||||
elif zone_state.entity_id == zone.ENTITY_ID_HOME:
|
||||
@@ -415,20 +511,22 @@ class Device(RestoreEntity):
|
||||
if not state:
|
||||
return
|
||||
self._state = state.state
|
||||
self.last_update_home = (state.state == STATE_HOME)
|
||||
self.last_update_home = state.state == STATE_HOME
|
||||
self.last_seen = dt_util.utcnow()
|
||||
|
||||
for attr, var in (
|
||||
(ATTR_SOURCE_TYPE, 'source_type'),
|
||||
(ATTR_GPS_ACCURACY, 'gps_accuracy'),
|
||||
(ATTR_BATTERY, 'battery'),
|
||||
(ATTR_SOURCE_TYPE, "source_type"),
|
||||
(ATTR_GPS_ACCURACY, "gps_accuracy"),
|
||||
(ATTR_BATTERY, "battery"),
|
||||
):
|
||||
if attr in state.attributes:
|
||||
setattr(self, var, state.attributes[attr])
|
||||
|
||||
if ATTR_LONGITUDE in state.attributes:
|
||||
self.gps = (state.attributes[ATTR_LATITUDE],
|
||||
state.attributes[ATTR_LONGITUDE])
|
||||
self.gps = (
|
||||
state.attributes[ATTR_LATITUDE],
|
||||
state.attributes[ATTR_LONGITUDE],
|
||||
)
|
||||
|
||||
|
||||
class DeviceScanner:
|
||||
@@ -470,28 +568,32 @@ class DeviceScanner:
|
||||
return self.hass.async_add_job(self.get_extra_attributes, device)
|
||||
|
||||
|
||||
async def async_load_config(path: str, hass: HomeAssistantType,
|
||||
consider_home: timedelta):
|
||||
async def async_load_config(
|
||||
path: str, hass: HomeAssistantType, consider_home: timedelta
|
||||
):
|
||||
"""Load devices from YAML configuration file.
|
||||
|
||||
This method is a coroutine.
|
||||
"""
|
||||
dev_schema = vol.Schema({
|
||||
vol.Required(CONF_NAME): cv.string,
|
||||
vol.Optional(CONF_ICON, default=None): vol.Any(None, cv.icon),
|
||||
vol.Optional('track', default=False): cv.boolean,
|
||||
vol.Optional(CONF_MAC, default=None):
|
||||
vol.Any(None, vol.All(cv.string, vol.Upper)),
|
||||
vol.Optional(CONF_AWAY_HIDE, default=DEFAULT_AWAY_HIDE): cv.boolean,
|
||||
vol.Optional('gravatar', default=None): vol.Any(None, cv.string),
|
||||
vol.Optional('picture', default=None): vol.Any(None, cv.string),
|
||||
vol.Optional(CONF_CONSIDER_HOME, default=consider_home): vol.All(
|
||||
cv.time_period, cv.positive_timedelta),
|
||||
})
|
||||
dev_schema = vol.Schema(
|
||||
{
|
||||
vol.Required(CONF_NAME): cv.string,
|
||||
vol.Optional(CONF_ICON, default=None): vol.Any(None, cv.icon),
|
||||
vol.Optional("track", default=False): cv.boolean,
|
||||
vol.Optional(CONF_MAC, default=None): vol.Any(
|
||||
None, vol.All(cv.string, vol.Upper)
|
||||
),
|
||||
vol.Optional(CONF_AWAY_HIDE, default=DEFAULT_AWAY_HIDE): cv.boolean,
|
||||
vol.Optional("gravatar", default=None): vol.Any(None, cv.string),
|
||||
vol.Optional("picture", default=None): vol.Any(None, cv.string),
|
||||
vol.Optional(CONF_CONSIDER_HOME, default=consider_home): vol.All(
|
||||
cv.time_period, cv.positive_timedelta
|
||||
),
|
||||
}
|
||||
)
|
||||
result = []
|
||||
try:
|
||||
devices = await hass.async_add_job(
|
||||
load_yaml_config_file, path)
|
||||
devices = await hass.async_add_job(load_yaml_config_file, path)
|
||||
except HomeAssistantError as err:
|
||||
LOGGER.error("Unable to load %s: %s", path, str(err))
|
||||
return []
|
||||
@@ -500,10 +602,10 @@ async def async_load_config(path: str, hass: HomeAssistantType,
|
||||
|
||||
for dev_id, device in devices.items():
|
||||
# Deprecated option. We just ignore it to avoid breaking change
|
||||
device.pop('vendor', None)
|
||||
device.pop("vendor", None)
|
||||
try:
|
||||
device = dev_schema(device)
|
||||
device['dev_id'] = cv.slugify(dev_id)
|
||||
device["dev_id"] = cv.slugify(dev_id)
|
||||
except vol.Invalid as exp:
|
||||
async_log_exception(exp, dev_id, devices, hass)
|
||||
else:
|
||||
@@ -513,16 +615,18 @@ async def async_load_config(path: str, hass: HomeAssistantType,
|
||||
|
||||
def update_config(path: str, dev_id: str, device: Device):
|
||||
"""Add device to YAML configuration file."""
|
||||
with open(path, 'a') as out:
|
||||
device = {device.dev_id: {
|
||||
ATTR_NAME: device.name,
|
||||
ATTR_MAC: device.mac,
|
||||
ATTR_ICON: device.icon,
|
||||
'picture': device.config_picture,
|
||||
'track': device.track,
|
||||
CONF_AWAY_HIDE: device.away_hide,
|
||||
}}
|
||||
out.write('\n')
|
||||
with open(path, "a") as out:
|
||||
device = {
|
||||
device.dev_id: {
|
||||
ATTR_NAME: device.name,
|
||||
ATTR_MAC: device.mac,
|
||||
ATTR_ICON: device.icon,
|
||||
"picture": device.config_picture,
|
||||
"track": device.track,
|
||||
CONF_AWAY_HIDE: device.away_hide,
|
||||
}
|
||||
}
|
||||
out.write("\n")
|
||||
out.write(dump(device))
|
||||
|
||||
|
||||
@@ -532,5 +636,6 @@ def get_gravatar_for_email(email: str):
|
||||
Async friendly.
|
||||
"""
|
||||
import hashlib
|
||||
url = 'https://www.gravatar.com/avatar/{}.jpg?s=80&d=wavatar'
|
||||
return url.format(hashlib.md5(email.encode('utf-8').lower()).hexdigest())
|
||||
|
||||
url = "https://www.gravatar.com/avatar/{}.jpg?s=80&d=wavatar"
|
||||
return url.format(hashlib.md5(email.encode("utf-8").lower()).hexdigest())
|
||||
@@ -12,10 +12,7 @@ from homeassistant.exceptions import HomeAssistantError
|
||||
from homeassistant.helpers.typing import ConfigType, HomeAssistantType
|
||||
from homeassistant.helpers.event import async_track_time_interval
|
||||
from homeassistant.util import dt as dt_util
|
||||
from homeassistant.const import (
|
||||
ATTR_LATITUDE,
|
||||
ATTR_LONGITUDE,
|
||||
)
|
||||
from homeassistant.const import ATTR_LATITUDE, ATTR_LONGITUDE
|
||||
|
||||
|
||||
from .const import (
|
||||
@@ -33,10 +30,10 @@ class DeviceTrackerPlatform:
|
||||
"""Class to hold platform information."""
|
||||
|
||||
LEGACY_SETUP = (
|
||||
'async_get_scanner',
|
||||
'get_scanner',
|
||||
'async_setup_scanner',
|
||||
'setup_scanner',
|
||||
"async_get_scanner",
|
||||
"get_scanner",
|
||||
"async_setup_scanner",
|
||||
"setup_scanner",
|
||||
)
|
||||
|
||||
name = attr.ib(type=str)
|
||||
@@ -46,9 +43,7 @@ class DeviceTrackerPlatform:
|
||||
@property
|
||||
def type(self):
|
||||
"""Return platform type."""
|
||||
for methods, platform_type in (
|
||||
(self.LEGACY_SETUP, PLATFORM_TYPE_LEGACY),
|
||||
):
|
||||
for methods, platform_type in ((self.LEGACY_SETUP, PLATFORM_TYPE_LEGACY),):
|
||||
for meth in methods:
|
||||
if hasattr(self.platform, meth):
|
||||
return platform_type
|
||||
@@ -61,26 +56,33 @@ class DeviceTrackerPlatform:
|
||||
try:
|
||||
scanner = None
|
||||
setup = None
|
||||
if hasattr(self.platform, 'async_get_scanner'):
|
||||
if hasattr(self.platform, "async_get_scanner"):
|
||||
scanner = await self.platform.async_get_scanner(
|
||||
hass, {DOMAIN: self.config})
|
||||
elif hasattr(self.platform, 'get_scanner'):
|
||||
hass, {DOMAIN: self.config}
|
||||
)
|
||||
elif hasattr(self.platform, "get_scanner"):
|
||||
scanner = await hass.async_add_job(
|
||||
self.platform.get_scanner, hass, {DOMAIN: self.config})
|
||||
elif hasattr(self.platform, 'async_setup_scanner'):
|
||||
self.platform.get_scanner, hass, {DOMAIN: self.config}
|
||||
)
|
||||
elif hasattr(self.platform, "async_setup_scanner"):
|
||||
setup = await self.platform.async_setup_scanner(
|
||||
hass, self.config, tracker.async_see, discovery_info)
|
||||
elif hasattr(self.platform, 'setup_scanner'):
|
||||
hass, self.config, tracker.async_see, discovery_info
|
||||
)
|
||||
elif hasattr(self.platform, "setup_scanner"):
|
||||
setup = await hass.async_add_job(
|
||||
self.platform.setup_scanner, hass, self.config,
|
||||
tracker.see, discovery_info)
|
||||
self.platform.setup_scanner,
|
||||
hass,
|
||||
self.config,
|
||||
tracker.see,
|
||||
discovery_info,
|
||||
)
|
||||
else:
|
||||
raise HomeAssistantError(
|
||||
"Invalid legacy device_tracker platform.")
|
||||
raise HomeAssistantError("Invalid legacy device_tracker platform.")
|
||||
|
||||
if scanner:
|
||||
async_setup_scanner_platform(
|
||||
hass, self.config, scanner, tracker.async_see, self.type)
|
||||
hass, self.config, scanner, tracker.async_see, self.type
|
||||
)
|
||||
return
|
||||
|
||||
if not setup:
|
||||
@@ -95,27 +97,32 @@ async def async_extract_config(hass, config):
|
||||
"""Extract device tracker config and split between legacy and modern."""
|
||||
legacy = []
|
||||
|
||||
for platform in await asyncio.gather(*(
|
||||
for platform in await asyncio.gather(
|
||||
*(
|
||||
async_create_platform_type(hass, config, p_type, p_config)
|
||||
for p_type, p_config in config_per_platform(config, DOMAIN)
|
||||
)):
|
||||
)
|
||||
):
|
||||
if platform is None:
|
||||
continue
|
||||
|
||||
if platform.type == PLATFORM_TYPE_LEGACY:
|
||||
legacy.append(platform)
|
||||
else:
|
||||
raise ValueError("Unable to determine type for {}: {}".format(
|
||||
platform.name, platform.type))
|
||||
raise ValueError(
|
||||
"Unable to determine type for {}: {}".format(
|
||||
platform.name, platform.type
|
||||
)
|
||||
)
|
||||
|
||||
return legacy
|
||||
|
||||
|
||||
async def async_create_platform_type(hass, config, p_type, p_config) \
|
||||
-> Optional[DeviceTrackerPlatform]:
|
||||
async def async_create_platform_type(
|
||||
hass, config, p_type, p_config
|
||||
) -> Optional[DeviceTrackerPlatform]:
|
||||
"""Determine type of platform."""
|
||||
platform = await async_prepare_setup_platform(
|
||||
hass, config, DOMAIN, p_type)
|
||||
platform = await async_prepare_setup_platform(hass, config, DOMAIN, p_type)
|
||||
|
||||
if platform is None:
|
||||
return None
|
||||
@@ -124,9 +131,13 @@ async def async_create_platform_type(hass, config, p_type, p_config) \
|
||||
|
||||
|
||||
@callback
|
||||
def async_setup_scanner_platform(hass: HomeAssistantType, config: ConfigType,
|
||||
scanner: Any, async_see_device: Callable,
|
||||
platform: str):
|
||||
def async_setup_scanner_platform(
|
||||
hass: HomeAssistantType,
|
||||
config: ConfigType,
|
||||
scanner: Any,
|
||||
async_see_device: Callable,
|
||||
platform: str,
|
||||
):
|
||||
"""Set up the connect scanner-based platform to device tracker.
|
||||
|
||||
This method must be run in the event loop.
|
||||
@@ -143,7 +154,10 @@ def async_setup_scanner_platform(hass: HomeAssistantType, config: ConfigType,
|
||||
if update_lock.locked():
|
||||
LOGGER.warning(
|
||||
"Updating device list from %s took longer than the scheduled "
|
||||
"scan interval %s", platform, interval)
|
||||
"scan interval %s",
|
||||
platform,
|
||||
interval,
|
||||
)
|
||||
return
|
||||
|
||||
async with update_lock:
|
||||
@@ -157,26 +171,27 @@ def async_setup_scanner_platform(hass: HomeAssistantType, config: ConfigType,
|
||||
seen.add(mac)
|
||||
|
||||
try:
|
||||
extra_attributes = \
|
||||
await scanner.async_get_extra_attributes(mac)
|
||||
extra_attributes = await scanner.async_get_extra_attributes(mac)
|
||||
except NotImplementedError:
|
||||
extra_attributes = dict()
|
||||
|
||||
kwargs = {
|
||||
'mac': mac,
|
||||
'host_name': host_name,
|
||||
'source_type': SOURCE_TYPE_ROUTER,
|
||||
'attributes': {
|
||||
'scanner': scanner.__class__.__name__,
|
||||
**extra_attributes
|
||||
}
|
||||
"mac": mac,
|
||||
"host_name": host_name,
|
||||
"source_type": SOURCE_TYPE_ROUTER,
|
||||
"attributes": {
|
||||
"scanner": scanner.__class__.__name__,
|
||||
**extra_attributes,
|
||||
},
|
||||
}
|
||||
|
||||
zone_home = hass.states.get(hass.components.zone.ENTITY_ID_HOME)
|
||||
if zone_home:
|
||||
kwargs['gps'] = [zone_home.attributes[ATTR_LATITUDE],
|
||||
zone_home.attributes[ATTR_LONGITUDE]]
|
||||
kwargs['gps_accuracy'] = 0
|
||||
kwargs["gps"] = [
|
||||
zone_home.attributes[ATTR_LATITUDE],
|
||||
zone_home.attributes[ATTR_LONGITUDE],
|
||||
]
|
||||
kwargs["gps_accuracy"] = 0
|
||||
|
||||
hass.async_create_task(async_see_device(**kwargs))
|
||||
|
||||
|
||||
Reference in new issue
Block a user