From a901c594a9b4c491971ab9d122fcdbd7ad40ceca Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= <joasoe@gmail.com>
Date: Mon, 5 Nov 2018 09:28:02 +0100
Subject: [PATCH] Add Traccar device tracker (#18200)

* Add Traccar device tracker.

* Updated pytraccar to 0.1.1

* Adds default values for optional options.

* Use dict[key] for options.

* remove logging, duplicate by core
---
 .coveragerc                                   |  1 +
 .../components/device_tracker/traccar.py      | 90 +++++++++++++++++++
 requirements_all.txt                          |  3 +
 3 files changed, 94 insertions(+)
 create mode 100644 homeassistant/components/device_tracker/traccar.py

diff --git a/.coveragerc b/.coveragerc
index f5103867688..17fcb505fc0 100644
--- a/.coveragerc
+++ b/.coveragerc
@@ -499,6 +499,7 @@ omit =
     homeassistant/components/device_tracker/tile.py
     homeassistant/components/device_tracker/tomato.py
     homeassistant/components/device_tracker/tplink.py
+    homeassistant/components/device_tracker/traccar.py
     homeassistant/components/device_tracker/trackr.py
     homeassistant/components/device_tracker/ubus.py
     homeassistant/components/downloader.py
diff --git a/homeassistant/components/device_tracker/traccar.py b/homeassistant/components/device_tracker/traccar.py
new file mode 100644
index 00000000000..982a572fd94
--- /dev/null
+++ b/homeassistant/components/device_tracker/traccar.py
@@ -0,0 +1,90 @@
+"""
+Support for Traccar device tracking.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/device_tracker.traccar/
+"""
+from datetime import timedelta
+import logging
+
+import voluptuous as vol
+
+from homeassistant.components.device_tracker import PLATFORM_SCHEMA
+from homeassistant.const import (
+    CONF_HOST, CONF_PORT, CONF_SSL, CONF_VERIFY_SSL,
+    CONF_PASSWORD, CONF_USERNAME)
+import homeassistant.helpers.config_validation as cv
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
+from homeassistant.helpers.event import async_track_time_interval
+from homeassistant.util import slugify
+
+
+REQUIREMENTS = ['pytraccar==0.1.2']
+
+_LOGGER = logging.getLogger(__name__)
+
+ATTR_ADDRESS = 'address'
+ATTR_CATEGORY = 'category'
+ATTR_GEOFENCE = 'geofence'
+ATTR_TRACKER = 'tracker'
+
+DEFAULT_SCAN_INTERVAL = timedelta(seconds=30)
+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Required(CONF_PASSWORD): cv.string,
+    vol.Required(CONF_USERNAME): cv.string,
+    vol.Required(CONF_HOST): cv.string,
+    vol.Optional(CONF_PORT, default=8082): cv.port,
+    vol.Optional(CONF_SSL, default=False): cv.boolean,
+    vol.Optional(CONF_VERIFY_SSL, default=True): cv.boolean,
+})
+
+
+async def async_setup_scanner(hass, config, async_see, discovery_info=None):
+    """Validate the configuration and return a Traccar scanner."""
+    from pytraccar.api import API
+
+    session = async_get_clientsession(hass, config[CONF_VERIFY_SSL])
+
+    api = API(hass.loop, session, config[CONF_USERNAME], config[CONF_PASSWORD],
+              config[CONF_HOST], config[CONF_PORT], config[CONF_SSL])
+    scanner = TraccarScanner(api, hass, async_see)
+    return await scanner.async_init()
+
+
+class TraccarScanner:
+    """Define an object to retrieve Traccar data."""
+
+    def __init__(self, api, hass, async_see):
+        """Initialize."""
+        self._async_see = async_see
+        self._api = api
+        self._hass = hass
+
+    async def async_init(self):
+        """Further initialize connection to Traccar."""
+        await self._api.test_connection()
+        if self._api.authenticated:
+            await self._async_update()
+            async_track_time_interval(self._hass,
+                                      self._async_update,
+                                      DEFAULT_SCAN_INTERVAL)
+
+        return self._api.authenticated
+
+    async def _async_update(self, now=None):
+        """Update info from Traccar."""
+        _LOGGER.debug('Updating device data.')
+        await self._api.get_device_info()
+        for devicename in self._api.device_info:
+            device = self._api.device_info[devicename]
+            device_attributes = {
+                ATTR_ADDRESS: device['address'],
+                ATTR_GEOFENCE: device['geofence'],
+                ATTR_CATEGORY: device['category'],
+                ATTR_TRACKER: 'traccar'
+                }
+            await self._async_see(
+                dev_id=slugify(device['device_id']),
+                gps=(device['latitude'], device['longitude']),
+                attributes=device_attributes)
diff --git a/requirements_all.txt b/requirements_all.txt
index 6bf7ff0c98e..1cde93097f6 100644
--- a/requirements_all.txt
+++ b/requirements_all.txt
@@ -1245,6 +1245,9 @@ pytile==2.0.2
 # homeassistant.components.climate.touchline
 pytouchline==0.7
 
+# homeassistant.components.device_tracker.traccar
+pytraccar==0.1.2
+
 # homeassistant.components.device_tracker.trackr
 pytrackr==0.0.5