Add GTT Sensor (#18449)

* added gtt sensor

* removed trailing space

* updated requirements_all

* fixed two errors in the code style

* fixed imperative in docstring

* disabled pylint false positive

* fixed description on top of the file

* added files to .coveragerc

* fixes

* linting

* fixed linting 👍

* left a trailing space, now it's gone.

* fix

.coveragerc

@@ -748,6 +748,7 @@ omit =
     homeassistant/components/sensor/google_travel_time.py
     homeassistant/components/sensor/gpsd.py
     homeassistant/components/sensor/gtfs.py
+    homeassistant/components/sensor/gtt.py
     homeassistant/components/sensor/haveibeenpwned.py
     homeassistant/components/sensor/hp_ilo.py
     homeassistant/components/sensor/htu21d.py

homeassistant/components/sensor/gtt.py

@@ -0,0 +1,115 @@
+"""
+Sensor to get GTT's timetable for a stop.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/sensor.gtt/
+"""
+import logging
+from datetime import timedelta, datetime
+
+import voluptuous as vol
+
+from homeassistant.components.sensor import PLATFORM_SCHEMA
+from homeassistant.const import DEVICE_CLASS_TIMESTAMP
+from homeassistant.helpers.entity import Entity
+import homeassistant.helpers.config_validation as cv
+import homeassistant.util.dt as dt_util
+
+REQUIREMENTS = ['pygtt==1.1.2']
+
+_LOGGER = logging.getLogger(__name__)
+
+CONF_STOP = 'stop'
+CONF_BUS_NAME = 'bus_name'
+
+ICON = 'mdi:train'
+
+SCAN_INTERVAL = timedelta(minutes=2)
+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Required(CONF_STOP): cv.string,
+    vol.Optional(CONF_BUS_NAME): cv.string
+})
+
+
+def setup_platform(hass, config, add_entities, discovery_info=None):
+    """Set up the Gtt platform."""
+    stop = config[CONF_STOP]
+    bus_name = config.get(CONF_BUS_NAME)
+
+    add_entities([GttSensor(stop, bus_name)], True)
+
+
+class GttSensor(Entity):
+    """Representation of a Gtt Sensor."""
+
+    def __init__(self, stop, bus_name):
+        """Initialize the Gtt sensor."""
+        self.data = GttData(stop, bus_name)
+        self._state = None
+        self._name = 'Stop {}'.format(stop)
+
+    @property
+    def name(self):
+        """Return the name of the sensor."""
+        return self._name
+
+    @property
+    def icon(self):
+        """Return the icon of the sensor."""
+        return ICON
+
+    @property
+    def state(self):
+        """Return the state of the sensor."""
+        return self._state
+
+    @property
+    def device_class(self):
+        """Return the device class."""
+        return DEVICE_CLASS_TIMESTAMP
+
+    @property
+    def device_state_attributes(self):
+        """Return the state attributes of the sensor."""
+        attr = {
+            'bus_name': self.data.state_bus['bus_name']
+        }
+        return attr
+
+    def update(self):
+        """Update device state."""
+        self.data.get_data()
+        next_time = dt_util.parse_time(self.data.state_bus['time'][0]['run'])
+        self._state = next_time.isoformat()
+
+
+class GttData:
+    """Inteface to PyGTT."""
+
+    def __init__(self, stop, bus_name):
+        """Initialize the GttData class."""
+        from pygtt import PyGTT
+        self._pygtt = PyGTT()
+        self._stop = stop
+        self._bus_name = bus_name
+        self.bus_list = {}
+        self.state_bus = {}
+
+    def get_data(self):
+        """Get the data from the api."""
+        self.bus_list = self._pygtt.get_by_stop(self._stop)
+        self.bus_list.sort(key=lambda b:
+                           datetime.strptime(b['time'][0]['run'], "%H:%M"))
+
+        if self._bus_name is not None:
+            self.state_bus = self.get_bus_by_name()
+            return
+
+        self.state_bus = self.bus_list[0]
+
+    def get_bus_by_name(self):
+        """Get the bus by name."""
+        for bus in self.bus_list:
+            if bus['bus_name'] == self._bus_name:
+                return bus

requirements_all.txt

@@ -980,6 +980,9 @@ pygogogate2==0.1.1
 # homeassistant.components.sensor.gtfs
 pygtfs==0.1.5
 
+# homeassistant.components.sensor.gtt
+pygtt==1.1.2
+
 # homeassistant.components.remote.harmony
 pyharmony==1.0.20