mirror of
https://github.com/home-assistant/core
synced 2024-08-02 23:40:32 +02:00
129 lines
4.3 KiB
Python
129 lines
4.3 KiB
Python
"""Support for Google Maps location sharing."""
|
|
from __future__ import annotations
|
|
|
|
from datetime import timedelta
|
|
import logging
|
|
|
|
from locationsharinglib import Service
|
|
from locationsharinglib.locationsharinglibexceptions import InvalidCookies
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.device_tracker import (
|
|
PLATFORM_SCHEMA as PLATFORM_SCHEMA_BASE,
|
|
SOURCE_TYPE_GPS,
|
|
)
|
|
from homeassistant.const import (
|
|
ATTR_BATTERY_CHARGING,
|
|
ATTR_BATTERY_LEVEL,
|
|
ATTR_ID,
|
|
CONF_SCAN_INTERVAL,
|
|
CONF_USERNAME,
|
|
)
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.event import track_time_interval
|
|
from homeassistant.helpers.typing import ConfigType
|
|
from homeassistant.util import dt as dt_util, slugify
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
ATTR_ADDRESS = "address"
|
|
ATTR_FULL_NAME = "full_name"
|
|
ATTR_LAST_SEEN = "last_seen"
|
|
ATTR_NICKNAME = "nickname"
|
|
|
|
CONF_MAX_GPS_ACCURACY = "max_gps_accuracy"
|
|
|
|
CREDENTIALS_FILE = ".google_maps_location_sharing.cookies"
|
|
|
|
# the parent "device_tracker" have marked the schemas as legacy, so this
|
|
# need to be refactored as part of a bigger rewrite.
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA_BASE.extend(
|
|
{
|
|
vol.Required(CONF_USERNAME): cv.string,
|
|
vol.Optional(CONF_MAX_GPS_ACCURACY, default=100000): vol.Coerce(float),
|
|
}
|
|
)
|
|
|
|
|
|
def setup_scanner(hass, config: ConfigType, see, discovery_info=None):
|
|
"""Set up the Google Maps Location sharing scanner."""
|
|
scanner = GoogleMapsScanner(hass, config, see)
|
|
return scanner.success_init
|
|
|
|
|
|
class GoogleMapsScanner:
|
|
"""Representation of an Google Maps location sharing account."""
|
|
|
|
def __init__(self, hass, config: ConfigType, see) -> None:
|
|
"""Initialize the scanner."""
|
|
self.see = see
|
|
self.username = config[CONF_USERNAME]
|
|
self.max_gps_accuracy = config[CONF_MAX_GPS_ACCURACY]
|
|
self.scan_interval = config.get(CONF_SCAN_INTERVAL) or timedelta(seconds=60)
|
|
self._prev_seen: dict[str, str] = {}
|
|
|
|
credfile = f"{hass.config.path(CREDENTIALS_FILE)}.{slugify(self.username)}"
|
|
try:
|
|
self.service = Service(credfile, self.username)
|
|
self._update_info()
|
|
|
|
track_time_interval(hass, self._update_info, self.scan_interval)
|
|
|
|
self.success_init = True
|
|
|
|
except InvalidCookies:
|
|
_LOGGER.error(
|
|
"The cookie file provided does not provide a valid session. Please create another one and try again"
|
|
)
|
|
self.success_init = False
|
|
|
|
def _update_info(self, now=None):
|
|
for person in self.service.get_all_people():
|
|
try:
|
|
dev_id = f"google_maps_{slugify(person.id)}"
|
|
except TypeError:
|
|
_LOGGER.warning("No location(s) shared with this account")
|
|
return
|
|
|
|
if (
|
|
self.max_gps_accuracy is not None
|
|
and person.accuracy > self.max_gps_accuracy
|
|
):
|
|
_LOGGER.info(
|
|
"Ignoring %s update because expected GPS "
|
|
"accuracy %s is not met: %s",
|
|
person.nickname,
|
|
self.max_gps_accuracy,
|
|
person.accuracy,
|
|
)
|
|
continue
|
|
|
|
last_seen = dt_util.as_utc(person.datetime)
|
|
if last_seen < self._prev_seen.get(dev_id, last_seen):
|
|
_LOGGER.warning(
|
|
"Ignoring %s update because timestamp "
|
|
"is older than last timestamp",
|
|
person.nickname,
|
|
)
|
|
_LOGGER.debug("%s < %s", last_seen, self._prev_seen[dev_id])
|
|
continue
|
|
self._prev_seen[dev_id] = last_seen
|
|
|
|
attrs = {
|
|
ATTR_ADDRESS: person.address,
|
|
ATTR_FULL_NAME: person.full_name,
|
|
ATTR_ID: person.id,
|
|
ATTR_LAST_SEEN: last_seen,
|
|
ATTR_NICKNAME: person.nickname,
|
|
ATTR_BATTERY_CHARGING: person.charging,
|
|
ATTR_BATTERY_LEVEL: person.battery_level,
|
|
}
|
|
self.see(
|
|
dev_id=dev_id,
|
|
gps=(person.latitude, person.longitude),
|
|
picture=person.picture_url,
|
|
source_type=SOURCE_TYPE_GPS,
|
|
gps_accuracy=person.accuracy,
|
|
attributes=attrs,
|
|
)
|