From ed490b1c11f127915d5861979528b71317982797 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Per=20Sandstr=C3=B6m?= <per.j.sandstrom@gmail.com>
Date: Wed, 5 Oct 2016 07:37:45 +0200
Subject: [PATCH] =?UTF-8?q?Add=20v=C3=A4sttrafik=20sensor=20(#3640)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .coveragerc                                   |   1 +
 homeassistant/components/sensor/vasttrafik.py | 120 ++++++++++++++++++
 requirements_all.txt                          |   3 +
 3 files changed, 124 insertions(+)
 create mode 100644 homeassistant/components/sensor/vasttrafik.py

diff --git a/.coveragerc b/.coveragerc
index c58938cf866..467950e16e8 100644
--- a/.coveragerc
+++ b/.coveragerc
@@ -269,6 +269,7 @@ omit =
     homeassistant/components/sensor/transmission.py
     homeassistant/components/sensor/twitch.py
     homeassistant/components/sensor/uber.py
+    homeassistant/components/sensor/vasttrafik.py
     homeassistant/components/sensor/worldclock.py
     homeassistant/components/sensor/xbox_live.py
     homeassistant/components/sensor/yahoo_finance.py
diff --git a/homeassistant/components/sensor/vasttrafik.py b/homeassistant/components/sensor/vasttrafik.py
new file mode 100644
index 00000000000..de14b1813e0
--- /dev/null
+++ b/homeassistant/components/sensor/vasttrafik.py
@@ -0,0 +1,120 @@
+"""
+Support for Västtrafik public transport.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/sensor.vasttrafik/
+"""
+from datetime import datetime
+from datetime import timedelta
+import logging
+import voluptuous as vol
+
+from homeassistant.components.sensor import PLATFORM_SCHEMA
+import homeassistant.helpers.config_validation as cv
+from homeassistant.helpers.entity import Entity
+from homeassistant.util import Throttle
+
+REQUIREMENTS = ['vtjp==0.1.11']
+
+_LOGGER = logging.getLogger(__name__)
+
+CONF_DELAY = 'delay'
+CONF_DEPARTURES = 'departures'
+CONF_FROM = 'from'
+CONF_HEADING = 'heading'
+CONF_KEY = 'key'
+CONF_NAME = 'name'
+CONF_SECRET = 'secret'
+
+ICON = 'mdi:train'
+
+MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=120)
+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Required(CONF_KEY): cv.string,
+    vol.Required(CONF_SECRET): cv.string,
+    vol.Optional(CONF_DEPARTURES): [{
+        vol.Required(CONF_FROM): cv.string,
+        vol.Optional(CONF_DELAY, default=0): cv.positive_int,
+        vol.Optional(CONF_HEADING): cv.string,
+        vol.Optional(CONF_NAME): cv.string}]
+})
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Setup the departure sensor."""
+    from vasttrafik import JournyPlanner
+    planner = JournyPlanner(
+        config.get(CONF_KEY),
+        config.get(CONF_SECRET))
+    sensors = []
+    for departure in config.get(CONF_DEPARTURES):
+        sensors.append(
+            VasttrafikDepartureSensor(
+                planner,
+                departure.get(CONF_NAME),
+                departure.get(CONF_FROM),
+                departure.get(CONF_HEADING),
+                departure.get(CONF_DELAY)))
+    add_devices(sensors)
+
+
+class VasttrafikDepartureSensor(Entity):
+    """Implementation of a Vasttrafik Departure Sensor."""
+
+    # pylint: disable=too-many-arguments
+    def __init__(self, planner, name, departure, heading, delay):
+        """Initialize the sensor."""
+        self._planner = planner
+        self._name = name or departure
+        self._departure = planner.location_name(departure)[0]
+        self._heading = (planner.location_name(heading)[0]
+                         if heading else None)
+        self._delay = timedelta(minutes=delay)
+        self._departureboard = None
+        self.update()
+
+    @property
+    def name(self):
+        """Return the name of the sensor."""
+        return self._name
+
+    @property
+    def icon(self):
+        """Return the icon for the frontend."""
+        return ICON
+
+    @property
+    def device_state_attributes(self):
+        """Return the state attributes."""
+        if not self._departureboard:
+            return
+        departure = self._departureboard[0]
+        params = {
+            'Line': departure.get('sname', None),
+            'Track': departure.get('track', None),
+            'Direction': departure.get('direction', None),
+            'Accessibility': departure.get('accessibility', None)
+            }
+        return {k: v for k, v in params.items() if v}
+
+    @property
+    def state(self):
+        """Return the next departure time."""
+        if not self._departureboard:
+            _LOGGER.warning(
+                'No departures from "%s" heading "%s"',
+                self._departure['name'],
+                self._heading['name'] if self._heading else 'ANY')
+            return
+        if 'rtTime' in self._departureboard[0]:
+            return self._departureboard[0]['rtTime']
+        return self._departureboard[0]['time']
+
+    @Throttle(MIN_TIME_BETWEEN_UPDATES)
+    def update(self):
+        """Get the departure board."""
+        self._departureboard = self._planner.departureboard(
+            self._departure['id'],
+            direction=self._heading['id'] if self._heading else None,
+            date=datetime.now()+self._delay)
diff --git a/requirements_all.txt b/requirements_all.txt
index b4ede599c85..2cf6e33051e 100644
--- a/requirements_all.txt
+++ b/requirements_all.txt
@@ -502,6 +502,9 @@ uvcclient==0.9.0
 # homeassistant.components.verisure
 vsure==0.10.3
 
+# homeassistant.components.sensor.vasttrafik
+vtjp==0.1.11
+
 # homeassistant.components.switch.wake_on_lan
 wakeonlan==0.2.2