Google Maps location sharing device tracker. #12301

michaelarnauts · 2018-02-11T12:32:56Z

Description:

This component uses Google Maps location sharing to track device location. This allows to track android devices without battery impact or having to install another app.

Uses https://github.com/costastf/locationsharinglib to fetch the locations of shared accounts.

Documentation is available at: home-assistant/home-assistant.io#4646

Example entry for `configuration.yaml` (if applicable):

device_tracker:
  - platform: google_maps
    username: username@gmail.com
    password: password

Checklist:

The code change is tested and works locally.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
Tests have been added to verify that the new code works.

OttoWinter · 2018-02-11T12:55:42Z

homeassistant/components/device_tracker/google_maps.py

+})
+
+
+def setup_scanner(hass, config: dict, see, discovery_info=None):


There's a special ConfigType in helpers/typing that should probably be used instead of dict.

OttoWinter · 2018-02-11T12:57:16Z

homeassistant/components/device_tracker/google_maps.py

+        try:
+            # Check if we already have cached credentials
+            if os.path.isfile(CREDENTIALS_FILE):
+                _LOGGER.info('Authenticating with credentials file.')


I'm no expert, but this seems more like a debug log entry to me.

michaelarnauts · 2018-02-14T07:05:04Z

homeassistant/components/device_tracker/google_maps.py

+
+REQUIREMENTS = ['locationsharinglib==0.3.0']
+
+CONF_IGNORED_DEVICES = 'ignored_devices'


Just noticed these two are not used. I will remove them.

jurriaan · 2018-02-17T11:06:47Z

homeassistant/components/device_tracker/google_maps.py

+
+    def _update_info(self, now=None):
+        for person in self.service.get_all_people():
+            dev_id = 'google_maps_{0}'.format(slugify(person.id))


Is it somehow possible to change these identifiers in for example the entity registry? (cc @balloob)

Out of scope 😉

I think that we should be able to use this ID as a unique ID inside the device tracker.

michaelarnauts · 2018-02-24T13:44:47Z

Does this needs changing anything?

Esiravegna · 2018-02-26T01:23:57Z

THing is, if we can use the ID as an internal tracker (check the MAC address for the router based tracking), we could name the device in a sensible way (my_phone, wife_phone, etc) as opposed to the current names required in know_devices.yaml, that are hard to remember.

dshokouhi · 2018-02-26T19:00:40Z

won't the entity_registry let us rename the entities created with a unique id? really looking forward to this integration getting added :)

fanaticDavid · 2018-02-27T14:56:18Z

@Esiravegna Slightly off-topic, but even without the entity registry you can already influence the entity_id of the devices in the known_devices.yaml file:

001710xxxxxx:               => changing this to abc will change the entity_id from device_tracker.001710xxxxxx to device_tracker.abc
  hide_if_away: false
  icon:
  mac: 00:17:10:xx:xx:xx
  name: 001710xxxxxx        => this is used as the device's friendly_name in the UI
  picture:
  track: false
  vendor: Casa Systems Inc.

Changes are applied after restarting Home Assistant.

Esiravegna · 2018-02-27T15:03:02Z

@fanaticDavid Thanks I'm aware of that. Thing is, somewhere in the structure the id generated by this component must reside, otherwise the tracking will not be there. I don't think is the MAC here, and if it is, problem is that the router presence detector also uses them, and thus we won't be able to use both methods.

TL;DR: I'd like to see a way to rename the device, keeping the google maps id and also use the other presence detectors, hence muy point.

balloob · 2018-03-01T01:55:37Z

homeassistant/components/device_tracker/google_maps.py

+
+REQUIREMENTS = ['locationsharinglib==0.3.0']
+
+CREDENTIALS_FILE = 'google_maps_location_sharing.conf'


Please add a . in front of the name

balloob · 2018-03-01T01:59:34Z

homeassistant/components/device_tracker/google_maps.py

+                                   hass.config.path(CREDENTIALS_FILE))
+            self._update_info()
+
+            track_utc_time_change(


It seems you just want to call track_time_interval(hass, action, interval)

MartinHjelmare · 2018-03-02T07:05:57Z

homeassistant/components/device_tracker/google_maps.py

+                attributes=attrs
+            )
+
+        return True


Nothing is checking this return value.

MartinHjelmare · 2018-03-02T07:06:57Z

homeassistant/components/device_tracker/google_maps.py

+        from locationsharinglib import Service
+        from locationsharinglib.locationsharinglibexceptions import InvalidUser
+
+        self.hass = hass


Nothing is using the instance attribute outside this method. Please remove the attribute and just use hass locally in this method.

MartinHjelmare · 2018-03-02T07:07:48Z

homeassistant/components/device_tracker/google_maps.py

+            self.success_init = True
+
+        except InvalidUser:
+            _LOGGER.error('You have specified invalid login credentials.')


Remove period at the end.

I have updated locationsharinglib to 0.4.0 fixing a bug with single quotes of the json payload and exposing gps accuracy as an attribute. The dependency should be updated to this version. I also suggest to change the .conf extension to the more semantically correct .cookies

GPS accuracy is not fetched from the correct field. I get an accuracy of 1500 when google maps locates me spot on with no blue accuract circle. I've not included this information.

michaelarnauts · 2018-03-17T19:55:55Z

@MartinHjelmare i've addressed your remarks.
@andrey-git do you need to review this?

MartinHjelmare

Just a minor comment for clarity.

MartinHjelmare · 2018-03-18T00:23:48Z

homeassistant/components/device_tracker/google_maps.py

+def setup_scanner(hass, config: ConfigType, see, discovery_info=None):
+    """Set up the scanner."""
+    scanner = GoogleMapsScanner(hass, config, see)
+    return scanner if scanner.success_init else None


setup_scanner doesn't want the scanner instance, it just wants a boolean, where true means successful platform setup.

This will work, but it's less clear.

A lot of device_tracker platforms seem to do exactly this. I don't think this is blocking the merge of this component? Anyway, I will make the change...

homeassistant/components/device_tracker/actiontec.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/aruba.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/asuswrt.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/bbox.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/bt_home_hub_5.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/cisco_ios.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/fritz.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/google_maps.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/hitron_coda.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/keenetic_ndms2.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/luci.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/mikrotik.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/netgear.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/nmap_tracker.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/sky_hub.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/snmp.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/swisscom.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/tado.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/thomson.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/ubus.py: return scanner if scanner.success_init else None homeassistant/components/device_tracker/xiaomi.py: return scanner if scanner.success_init else None

get_scanner should return the scanner instance but not setup_scanner. Platforms that use that latter should not behave like platforms that use the former.

MartinHjelmare

Thanks!

disrupted · 2018-04-07T12:58:12Z

this is awesome ! I was only just tweeting the other day how much I would love a Google location history device tracker and here it is already, gotta love this community ❤️

proximus-983 · 2018-04-09T11:18:39Z

I have this error in /config/.google_maps_location_sharing.cookies
'utf-8' codec can't decode byte 0x80 in position 0: invalid start byte
and no device appears in known_devices.yaml

MartinHjelmare · 2018-04-09T15:47:51Z

Please open an issue if you suspect a bug. If you need help please use our help channels:
https://home-assistant.io/help/#communication-channels

Merged PRs should not be used for support or bug reports. Thanks!

Google Maps location sharing device tracker.

2fb1ecf

michaelarnauts requested a review from andrey-git as a code owner February 11, 2018 12:32

homeassistant added cla-signed new-platform platform: device_tracker.google_maps labels Feb 11, 2018

michaelarnauts changed the title ~~Google Maps location sharing device tracker.~~ WIP: Google Maps location sharing device tracker. Feb 11, 2018

OttoWinter reviewed Feb 11, 2018

View reviewed changes

Danielhiversen added the docs-missing label Feb 12, 2018

Use ConfigType and change debug logging to _LOGGER.debug()

65001ab

homeassistant added the cla-signed label Feb 12, 2018

Update to locationsharinglib 0.3.0

811699c

michaelarnauts mentioned this pull request Feb 12, 2018

New Component: Add docs for Google Maps Location Sharing home-assistant/home-assistant.io#4646

Merged

2 tasks

michaelarnauts changed the title ~~WIP: Google Maps location sharing device tracker.~~ Google Maps location sharing device tracker. Feb 12, 2018

michaelarnauts removed the docs-missing label Feb 12, 2018

michaelarnauts commented Feb 14, 2018

View reviewed changes

Remove unneeded lines.

68dcf59

homeassistant added the cla-signed label Feb 14, 2018

Use hass.config.path for config file location.

c360466

jurriaan reviewed Feb 17, 2018

View reviewed changes

balloob reviewed Mar 1, 2018

View reviewed changes

MartinHjelmare requested changes Mar 2, 2018

View reviewed changes

Fixed remarks

06b424b

homeassistant added the cla-signed label Mar 5, 2018

MartinHjelmare reviewed Mar 18, 2018

View reviewed changes

Return boolean in setup_scanner

b2c1bfa

homeassistant added the cla-signed label Mar 30, 2018

MartinHjelmare approved these changes Mar 30, 2018

View reviewed changes

MartinHjelmare merged commit 0f24fea into dev Mar 30, 2018

Molodax mentioned this pull request Apr 3, 2018

First name is picked up as a nickname costastf/locationsharinglib#10

Closed

Danielhiversen deleted the google_maps_device_tracker branch April 4, 2018 12:15

home-assistant locked and limited conversation to collaborators Apr 9, 2018

ghost added integration: google_maps and removed platform: device_tracker.google_maps labels Mar 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Google Maps location sharing device tracker. #12301

Google Maps location sharing device tracker. #12301

michaelarnauts commented Feb 11, 2018 •

edited

Loading

OttoWinter Feb 11, 2018

OttoWinter Feb 11, 2018

michaelarnauts Feb 14, 2018

jurriaan Feb 17, 2018

balloob Feb 18, 2018

michaelarnauts commented Feb 24, 2018

Esiravegna commented Feb 26, 2018

dshokouhi commented Feb 26, 2018

fanaticDavid commented Feb 27, 2018

Esiravegna commented Feb 27, 2018

balloob Mar 1, 2018

balloob Mar 1, 2018

MartinHjelmare Mar 2, 2018

MartinHjelmare Mar 2, 2018

MartinHjelmare Mar 2, 2018

costastf Mar 4, 2018

michaelarnauts Mar 5, 2018

michaelarnauts commented Mar 17, 2018

MartinHjelmare left a comment

MartinHjelmare Mar 18, 2018

michaelarnauts Mar 30, 2018

MartinHjelmare Mar 30, 2018 •

edited

Loading

MartinHjelmare left a comment

disrupted commented Apr 7, 2018

proximus-983 commented Apr 9, 2018

MartinHjelmare commented Apr 9, 2018

		})


		def setup_scanner(hass, config: dict, see, discovery_info=None):


		REQUIREMENTS = ['locationsharinglib==0.3.0']

		CONF_IGNORED_DEVICES = 'ignored_devices'


		REQUIREMENTS = ['locationsharinglib==0.3.0']

		CREDENTIALS_FILE = 'google_maps_location_sharing.conf'

Google Maps location sharing device tracker. #12301

Google Maps location sharing device tracker. #12301

Conversation

michaelarnauts commented Feb 11, 2018 • edited Loading

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michaelarnauts commented Feb 24, 2018

Esiravegna commented Feb 26, 2018

dshokouhi commented Feb 26, 2018

fanaticDavid commented Feb 27, 2018

Esiravegna commented Feb 27, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michaelarnauts commented Mar 17, 2018

MartinHjelmare left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MartinHjelmare Mar 30, 2018 • edited Loading

Choose a reason for hiding this comment

MartinHjelmare left a comment

Choose a reason for hiding this comment

disrupted commented Apr 7, 2018

proximus-983 commented Apr 9, 2018

MartinHjelmare commented Apr 9, 2018

michaelarnauts commented Feb 11, 2018 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):

MartinHjelmare Mar 30, 2018 •

edited

Loading