Add De Lijn (Flemish Public Transport) component (#24265)

* Initial commit of De Lijn (Flemish Public Transport) component

* Code corrections as per HA dev's requests

* changes to variable naming, setting attribution and states, plus some smaller optimizations

* Overlooked some linting issues, these are now fixed

* Updated pydelijn version requirement to 0.5.1 so UTC timestamps can be used instead of relative/local times.
Removed unused definition

* Updated pydelijn version requirement to 0.5.1 in requirements_all.txt

* Update the self._attributes dict directly instead of replacing it
Assign ATTRIBUTION while creating the _attributes dict
Remove the ATTRIBUTION assignment in device_state_attributes as it's updated in the async_update now.

* Linting issue (lenght of 2 lines) solved

* Removed a relative time attribute
Updated a linting issue in the LOGGER (used % instead of the format)

.coveragerc

@@ -123,6 +123,7 @@ omit =
     homeassistant/components/ddwrt/device_tracker.py
     homeassistant/components/decora/light.py
     homeassistant/components/decora_wifi/light.py
+    homeassistant/components/delijn/*
     homeassistant/components/deluge/sensor.py
     homeassistant/components/deluge/switch.py
     homeassistant/components/denon/media_player.py

CODEOWNERS

@@ -66,6 +66,7 @@ homeassistant/components/cups/* @fabaff
 homeassistant/components/daikin/* @fredrike @rofrantz
 homeassistant/components/darksky/* @fabaff
 homeassistant/components/deconz/* @kane610
+homeassistant/components/delijn/* @bollewolle
 homeassistant/components/demo/* @home-assistant/core
 homeassistant/components/device_automation/* @home-assistant/core
 homeassistant/components/digital_ocean/* @fabaff

homeassistant/components/delijn/__init__.py

@@ -0,0 +1 @@
+"""The delijn component."""

homeassistant/components/delijn/manifest.json

@@ -0,0 +1,8 @@
+{
+  "domain": "delijn",
+  "name": "De Lijn",
+  "documentation": "https://www.home-assistant.io/components/delijn",
+  "dependencies": [],
+  "codeowners": ["@bollewolle"],
+  "requirements": ["pydelijn==0.5.1"]
+}

homeassistant/components/delijn/sensor.py

@@ -0,0 +1,119 @@
+"""Support for De Lijn (Flemish public transport) information."""
+import logging
+
+from pydelijn.api import Passages
+import voluptuous as vol
+
+from homeassistant.components.sensor import PLATFORM_SCHEMA
+from homeassistant.const import (
+    ATTR_ATTRIBUTION, DEVICE_CLASS_TIMESTAMP)
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
+import homeassistant.helpers.config_validation as cv
+from homeassistant.helpers.entity import Entity
+
+_LOGGER = logging.getLogger(__name__)
+
+ATTRIBUTION = "Data provided by data.delijn.be"
+
+CONF_NEXT_DEPARTURE = 'next_departure'
+CONF_STOP_ID = 'stop_id'
+CONF_API_KEY = 'api_key'
+CONF_NUMBER_OF_DEPARTURES = 'number_of_departures'
+
+DEFAULT_NAME = 'De Lijn'
+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Required(CONF_API_KEY): cv.string,
+    vol.Required(CONF_NEXT_DEPARTURE): [{
+        vol.Required(CONF_STOP_ID): cv.string,
+        vol.Optional(CONF_NUMBER_OF_DEPARTURES, default=5): cv.positive_int}]
+})
+
+
+async def async_setup_platform(
+        hass, config, async_add_entities, discovery_info=None):
+    """Create the sensor."""
+    api_key = config[CONF_API_KEY]
+    name = DEFAULT_NAME
+
+    session = async_get_clientsession(hass)
+
+    sensors = []
+    for nextpassage in config[CONF_NEXT_DEPARTURE]:
+        stop_id = nextpassage[CONF_STOP_ID]
+        number_of_departures = nextpassage[CONF_NUMBER_OF_DEPARTURES]
+        line = Passages(hass.loop,
+                        stop_id,
+                        number_of_departures,
+                        api_key,
+                        session,
+                        True)
+        await line.get_passages()
+        if line.passages is None:
+            _LOGGER.warning("No data recieved from De Lijn")
+            return
+        sensors.append(DeLijnPublicTransportSensor(line, name))
+
+    async_add_entities(sensors, True)
+
+
+class DeLijnPublicTransportSensor(Entity):
+    """Representation of a Ruter sensor."""
+
+    def __init__(self, line, name):
+        """Initialize the sensor."""
+        self.line = line
+        self._attributes = {ATTR_ATTRIBUTION: ATTRIBUTION}
+        self._name = name
+        self._state = None
+
+    async def async_update(self):
+        """Get the latest data from the De Lijn API."""
+        await self.line.get_passages()
+        if self.line.passages is None:
+            _LOGGER.warning("No data recieved from De Lijn")
+            return
+        try:
+            first = self.line.passages[0]
+            if first['due_at_realtime'] is not None:
+                first_passage = first['due_at_realtime']
+            else:
+                first_passage = first['due_at_schedule']
+            self._state = first_passage
+            self._name = first['stopname']
+            self._attributes['stopname'] = first['stopname']
+            self._attributes['line_number_public'] = first[
+                'line_number_public']
+            self._attributes['line_transport_type'] = first[
+                'line_transport_type']
+            self._attributes['final_destination'] = first['final_destination']
+            self._attributes['due_at_schedule'] = first['due_at_schedule']
+            self._attributes['due_at_realtime'] = first['due_at_realtime']
+            self._attributes['next_passages'] = self.line.passages
+        except (KeyError, IndexError) as error:
+            _LOGGER.debug("Error getting data from De Lijn: %s", error)
+
+    @property
+    def device_class(self):
+        """Return the device class."""
+        return DEVICE_CLASS_TIMESTAMP
+
+    @property
+    def name(self):
+        """Return the name of the sensor."""
+        return self._name
+
+    @property
+    def state(self):
+        """Return the state of the sensor."""
+        return self._state
+
+    @property
+    def icon(self):
+        """Return the icon of the sensor."""
+        return 'mdi:bus'
+
+    @property
+    def device_state_attributes(self):
+        """Return attributes for the sensor."""
+        return self._attributes

requirements_all.txt

@@ -1098,6 +1098,9 @@ pydanfossair==0.1.0
 # homeassistant.components.deconz
 pydeconz==60
 
+# homeassistant.components.delijn
+pydelijn==0.5.1
+
 # homeassistant.components.zwave
 pydispatcher==2.0.5