diff --git a/.coveragerc b/.coveragerc index ec6aad90628..84aed9dfb14 100644 --- a/.coveragerc +++ b/.coveragerc @@ -160,6 +160,7 @@ omit = homeassistant/components/emulated_hue/upnp.py homeassistant/components/enigma2/media_player.py homeassistant/components/enocean/* + homeassistant/components/entur_public_transport/* homeassistant/components/envisalink/* homeassistant/components/esphome/__init__.py homeassistant/components/esphome/binary_sensor.py diff --git a/homeassistant/components/entur_public_transport/__init__.py b/homeassistant/components/entur_public_transport/__init__.py index 7d8e0a18d0b..0bdce1909f4 100644 --- a/homeassistant/components/entur_public_transport/__init__.py +++ b/homeassistant/components/entur_public_transport/__init__.py @@ -1 +1 @@ -"""The entur_public_transport component.""" +"""Component for integrating entur public transport.""" diff --git a/homeassistant/components/entur_public_transport/sensor.py b/homeassistant/components/entur_public_transport/sensor.py index 330f5f8cc56..b2e22867690 100644 --- a/homeassistant/components/entur_public_transport/sensor.py +++ b/homeassistant/components/entur_public_transport/sensor.py @@ -1,9 +1,4 @@ -""" -Real-time information about public transport departures in Norway. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.entur_public_transport/ -""" +"""Real-time information about public transport departures in Norway.""" from datetime import datetime, timedelta import logging @@ -13,17 +8,16 @@ from homeassistant.components.sensor import PLATFORM_SCHEMA from homeassistant.const import ( ATTR_ATTRIBUTION, CONF_LATITUDE, CONF_LONGITUDE, CONF_NAME, CONF_SHOW_ON_MAP) +from homeassistant.helpers.aiohttp_client import async_get_clientsession import homeassistant.helpers.config_validation as cv from homeassistant.helpers.entity import Entity from homeassistant.util import Throttle import homeassistant.util.dt as dt_util -REQUIREMENTS = ['enturclient==0.1.3'] +REQUIREMENTS = ['enturclient==0.2.0'] _LOGGER = logging.getLogger(__name__) -ATTR_NEXT_UP_IN = 'next_due_in' - API_CLIENT_NAME = 'homeassistant-homeassistant' ATTRIBUTION = "Data provided by entur.org under NLOD" @@ -31,6 +25,8 @@ ATTRIBUTION = "Data provided by entur.org under NLOD" CONF_STOP_IDS = 'stop_ids' CONF_EXPAND_PLATFORMS = 'expand_platforms' CONF_WHITELIST_LINES = 'line_whitelist' +CONF_OMIT_NON_BOARDING = 'omit_non_boarding' +CONF_NUMBER_OF_DEPARTURES = 'number_of_departures' DEFAULT_NAME = 'Entur' DEFAULT_ICON_KEY = 'bus' @@ -44,7 +40,7 @@ ICONS = { 'water': 'mdi:ferry', } -SCAN_INTERVAL = timedelta(minutes=1) +SCAN_INTERVAL = timedelta(seconds=45) PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ vol.Required(CONF_STOP_IDS): vol.All(cv.ensure_list, [cv.string]), @@ -52,58 +48,80 @@ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string, vol.Optional(CONF_SHOW_ON_MAP, default=False): cv.boolean, vol.Optional(CONF_WHITELIST_LINES, default=[]): cv.ensure_list, + vol.Optional(CONF_OMIT_NON_BOARDING, default=True): cv.boolean, + vol.Optional(CONF_NUMBER_OF_DEPARTURES, default=2): + vol.All(cv.positive_int, vol.Range(min=2, max=10)) }) -def due_in_minutes(timestamp: str) -> str: - """Get the time in minutes from a timestamp. +ATTR_STOP_ID = 'stop_id' - The timestamp should be in the format - year-month-yearThour:minute:second+timezone - """ +ATTR_ROUTE = 'route' +ATTR_ROUTE_ID = 'route_id' +ATTR_EXPECTED_AT = 'due_at' +ATTR_DELAY = 'delay' +ATTR_REALTIME = 'real_time' + +ATTR_NEXT_UP_IN = 'next_due_in' +ATTR_NEXT_UP_ROUTE = 'next_route' +ATTR_NEXT_UP_ROUTE_ID = 'next_route_id' +ATTR_NEXT_UP_AT = 'next_due_at' +ATTR_NEXT_UP_DELAY = 'next_delay' +ATTR_NEXT_UP_REALTIME = 'next_real_time' + +ATTR_TRANSPORT_MODE = 'transport_mode' + + +def due_in_minutes(timestamp: datetime) -> int: + """Get the time in minutes from a timestamp.""" if timestamp is None: return None - diff = datetime.strptime( - timestamp, "%Y-%m-%dT%H:%M:%S%z") - dt_util.now() - - return str(int(diff.total_seconds() / 60)) + diff = timestamp - dt_util.now() + return int(diff.total_seconds() / 60) -def setup_platform(hass, config, add_entities, discovery_info=None): +async def async_setup_platform( + hass, config, async_add_entities, discovery_info=None): """Set up the Entur public transport sensor.""" from enturclient import EnturPublicTransportData - from enturclient.consts import CONF_NAME as API_NAME expand = config.get(CONF_EXPAND_PLATFORMS) line_whitelist = config.get(CONF_WHITELIST_LINES) name = config.get(CONF_NAME) show_on_map = config.get(CONF_SHOW_ON_MAP) stop_ids = config.get(CONF_STOP_IDS) + omit_non_boarding = config.get(CONF_OMIT_NON_BOARDING) + number_of_departures = config.get(CONF_NUMBER_OF_DEPARTURES) stops = [s for s in stop_ids if "StopPlace" in s] quays = [s for s in stop_ids if "Quay" in s] data = EnturPublicTransportData(API_CLIENT_NAME, - stops, - quays, - expand, - line_whitelist) - data.update() + stops=stops, + quays=quays, + line_whitelist=line_whitelist, + omit_non_boarding=omit_non_boarding, + number_of_departures=number_of_departures, + web_session=async_get_clientsession(hass)) + + if expand: + await data.expand_all_quays() + await data.update() proxy = EnturProxy(data) entities = [] - for item in data.all_stop_places_quays(): + for place in data.all_stop_places_quays(): try: given_name = "{} {}".format( - name, data.get_stop_info(item)[API_NAME]) + name, data.get_stop_info(place).name) except KeyError: - given_name = "{} {}".format(name, item) + given_name = "{} {}".format(name, place) entities.append( - EnturPublicTransportSensor(proxy, given_name, item, show_on_map)) + EnturPublicTransportSensor(proxy, given_name, place, show_on_map)) - add_entities(entities, True) + async_add_entities(entities, True) class EnturProxy: @@ -116,10 +134,10 @@ class EnturProxy: """Initialize the proxy.""" self._api = api - @Throttle(SCAN_INTERVAL) - def update(self) -> None: + @Throttle(timedelta(seconds=15)) + async def async_update(self) -> None: """Update data in client.""" - self._api.update() + await self._api.update() def get_stop_info(self, stop_id: str) -> dict: """Get info about specific stop place.""" @@ -132,18 +150,13 @@ class EnturPublicTransportSensor(Entity): def __init__( self, api: EnturProxy, name: str, stop: str, show_on_map: bool): """Initialize the sensor.""" - from enturclient.consts import ATTR_STOP_ID - self.api = api self._stop = stop self._show_on_map = show_on_map self._name = name self._state = None self._icon = ICONS[DEFAULT_ICON_KEY] - self._attributes = { - ATTR_ATTRIBUTION: ATTRIBUTION, - ATTR_STOP_ID: self._stop, - } + self._attributes = {} @property def name(self) -> str: @@ -158,6 +171,8 @@ class EnturPublicTransportSensor(Entity): @property def device_state_attributes(self) -> dict: """Return the state attributes.""" + self._attributes[ATTR_ATTRIBUTION] = ATTRIBUTION + self._attributes[ATTR_STOP_ID] = self._stop return self._attributes @property @@ -170,33 +185,56 @@ class EnturPublicTransportSensor(Entity): """Icon to use in the frontend.""" return self._icon - def update(self) -> None: + async def async_update(self) -> None: """Get the latest data and update the states.""" - from enturclient.consts import ( - ATTR, ATTR_EXPECTED_AT, ATTR_NEXT_UP_AT, CONF_LOCATION, - CONF_LATITUDE as LAT, CONF_LONGITUDE as LONG, CONF_TRANSPORT_MODE) + await self.api.async_update() - self.api.update() + self._attributes = {} data = self.api.get_stop_info(self._stop) - if data is not None and ATTR in data: - attrs = data[ATTR] - self._attributes.update(attrs) - - if ATTR_NEXT_UP_AT in attrs: - self._attributes[ATTR_NEXT_UP_IN] = \ - due_in_minutes(attrs[ATTR_NEXT_UP_AT]) - - if CONF_LOCATION in data and self._show_on_map: - self._attributes[CONF_LATITUDE] = data[CONF_LOCATION][LAT] - self._attributes[CONF_LONGITUDE] = data[CONF_LOCATION][LONG] - - if ATTR_EXPECTED_AT in attrs: - self._state = due_in_minutes(attrs[ATTR_EXPECTED_AT]) - else: - self._state = None - - self._icon = ICONS.get( - data[CONF_TRANSPORT_MODE], ICONS[DEFAULT_ICON_KEY]) - else: + if data is None: self._state = None + return + + if self._show_on_map and data.latitude and data.longitude: + self._attributes[CONF_LATITUDE] = data.latitude + self._attributes[CONF_LONGITUDE] = data.longitude + + calls = data.estimated_calls + if not calls: + self._state = None + return + + self._state = due_in_minutes(calls[0].expected_departure_time) + self._icon = ICONS.get( + calls[0].transport_mode, ICONS[DEFAULT_ICON_KEY]) + + self._attributes[ATTR_ROUTE] = calls[0].front_display + self._attributes[ATTR_ROUTE_ID] = calls[0].line_id + self._attributes[ATTR_EXPECTED_AT] = calls[0]\ + .expected_departure_time.strftime("%H:%M") + self._attributes[ATTR_REALTIME] = calls[0].is_realtime + self._attributes[ATTR_DELAY] = calls[0].delay_in_min + + number_of_calls = len(calls) + if number_of_calls < 2: + return + + self._attributes[ATTR_NEXT_UP_ROUTE] = calls[1].front_display + self._attributes[ATTR_NEXT_UP_ROUTE_ID] = calls[1].line_id + self._attributes[ATTR_NEXT_UP_AT] = calls[1]\ + .expected_departure_time.strftime("%H:%M") + self._attributes[ATTR_NEXT_UP_IN] = "{} min"\ + .format(due_in_minutes(calls[1].expected_departure_time)) + self._attributes[ATTR_NEXT_UP_REALTIME] = calls[1].is_realtime + self._attributes[ATTR_NEXT_UP_DELAY] = calls[1].delay_in_min + + if number_of_calls < 3: + return + + for i, call in enumerate(calls[2:]): + key_name = "departure_#" + str(i + 3) + self._attributes[key_name] = "{}{} {}".format( + "" if bool(call.is_realtime) else "ca. ", + call.expected_departure_time.strftime("%H:%M"), + call.front_display) diff --git a/requirements_all.txt b/requirements_all.txt index 51aac4420b1..9dfac8a2130 100644 --- a/requirements_all.txt +++ b/requirements_all.txt @@ -388,7 +388,7 @@ emulated_roku==0.1.8 enocean==0.40 # homeassistant.components.entur_public_transport.sensor -enturclient==0.1.3 +enturclient==0.2.0 # homeassistant.components.envirophat.sensor # envirophat==0.0.6 diff --git a/requirements_test_all.txt b/requirements_test_all.txt index 08466d922b8..7721c236d99 100644 --- a/requirements_test_all.txt +++ b/requirements_test_all.txt @@ -86,9 +86,6 @@ eebrightbox==0.0.4 # homeassistant.components.emulated_roku emulated_roku==0.1.8 -# homeassistant.components.entur_public_transport.sensor -enturclient==0.1.3 - # homeassistant.components.season.sensor ephem==3.7.6.0 diff --git a/script/gen_requirements_all.py b/script/gen_requirements_all.py index 5d21681aeda..d2d6588672f 100755 --- a/script/gen_requirements_all.py +++ b/script/gen_requirements_all.py @@ -54,7 +54,6 @@ TEST_REQUIREMENTS = ( 'dsmr_parser', 'eebrightbox', 'emulated_roku', - 'enturclient', 'ephem', 'evohomeclient', 'feedparser-homeassistant', diff --git a/tests/components/entur_public_transport/__init__.py b/tests/components/entur_public_transport/__init__.py deleted file mode 100644 index 015a5e9103c..00000000000 --- a/tests/components/entur_public_transport/__init__.py +++ /dev/null @@ -1 +0,0 @@ -"""Tests for the entur_public_transport component.""" diff --git a/tests/components/entur_public_transport/test_sensor.py b/tests/components/entur_public_transport/test_sensor.py deleted file mode 100644 index 98e72d19e81..00000000000 --- a/tests/components/entur_public_transport/test_sensor.py +++ /dev/null @@ -1,66 +0,0 @@ -"""The tests for the entur platform.""" -from datetime import datetime -import unittest -from unittest.mock import patch - -from enturclient.api import RESOURCE -from enturclient.consts import ATTR_EXPECTED_AT, ATTR_ROUTE, ATTR_STOP_ID -import requests_mock - -from homeassistant.components.entur_public_transport.sensor import ( - CONF_EXPAND_PLATFORMS, CONF_STOP_IDS) -from homeassistant.setup import setup_component -import homeassistant.util.dt as dt_util - -from tests.common import get_test_home_assistant, load_fixture - -VALID_CONFIG = { - 'platform': 'entur_public_transport', - CONF_EXPAND_PLATFORMS: False, - CONF_STOP_IDS: [ - 'NSR:StopPlace:548', - 'NSR:Quay:48550', - ] -} - -FIXTURE_FILE = 'entur_public_transport.json' -TEST_TIMESTAMP = datetime(2018, 10, 10, 7, tzinfo=dt_util.UTC) - - -class TestEnturPublicTransportSensor(unittest.TestCase): - """Test the entur platform.""" - - def setUp(self): - """Initialize values for this testcase class.""" - self.hass = get_test_home_assistant() - - def tearDown(self): - """Stop everything that was started.""" - self.hass.stop() - - @requests_mock.Mocker() - @patch( - 'homeassistant.components.entur_public_transport.sensor.dt_util.now', - return_value=TEST_TIMESTAMP) - def test_setup(self, mock_req, mock_patch): - """Test for correct sensor setup with state and proper attributes.""" - mock_req.post(RESOURCE, - text=load_fixture(FIXTURE_FILE), - status_code=200) - self.assertTrue( - setup_component(self.hass, 'sensor', {'sensor': VALID_CONFIG})) - - state = self.hass.states.get('sensor.entur_bergen_stasjon') - assert state.state == '28' - assert state.attributes.get(ATTR_STOP_ID) == 'NSR:StopPlace:548' - assert state.attributes.get(ATTR_ROUTE) == "59 Bergen" - assert state.attributes.get(ATTR_EXPECTED_AT) \ - == '2018-10-10T09:28:00+0200' - - state = self.hass.states.get('sensor.entur_fiskepiren_platform_2') - assert state.state == '0' - assert state.attributes.get(ATTR_STOP_ID) == 'NSR:Quay:48550' - assert state.attributes.get(ATTR_ROUTE) \ - == "5 Stavanger Airport via Forum" - assert state.attributes.get(ATTR_EXPECTED_AT) \ - == '2018-10-10T09:00:00+0200' diff --git a/tests/fixtures/entur_public_transport.json b/tests/fixtures/entur_public_transport.json deleted file mode 100644 index 24eafe94b23..00000000000 --- a/tests/fixtures/entur_public_transport.json +++ /dev/null @@ -1,111 +0,0 @@ -{ - "data": { - "stopPlaces": [ - { - "id": "NSR:StopPlace:548", - "name": "Bergen stasjon", - "estimatedCalls": [ - { - "realtime": false, - "aimedArrivalTime": "2018-10-10T09:28:00+0200", - "aimedDepartureTime": "2018-10-10T09:28:00+0200", - "expectedArrivalTime": "2018-10-10T09:28:00+0200", - "expectedDepartureTime": "2018-10-10T09:28:00+0200", - "requestStop": false, - "notices": [], - "destinationDisplay": { - "frontText": "Bergen" - }, - "serviceJourney": { - "journeyPattern": { - "line": { - "id": "NSB:Line:45", - "name": "Vossabanen", - "transportMode": "rail", - "publicCode": "59" - } - } - } - }, - { - "realtime": false, - "aimedArrivalTime": "2018-10-10T09:35:00+0200", - "aimedDepartureTime": "2018-10-10T09:35:00+0200", - "expectedArrivalTime": "2018-10-10T09:35:00+0200", - "expectedDepartureTime": "2018-10-10T09:35:00+0200", - "requestStop": false, - "notices": [], - "destinationDisplay": { - "frontText": "Arna" - }, - "serviceJourney": { - "journeyPattern": { - "line": { - "id": "NSB:Line:45", - "name": "Vossabanen", - "transportMode": "rail", - "publicCode": "58" - } - } - } - } - ] - } - ], - "quays": [ - { - "id": "NSR:Quay:48550", - "name": "Fiskepiren", - "publicCode": "2", - "latitude": 59.960904, - "longitude": 10.882942, - "estimatedCalls": [ - { - "realtime": false, - "aimedArrivalTime": "2018-10-10T09:00:00+0200", - "aimedDepartureTime": "2018-10-10T09:00:00+0200", - "expectedArrivalTime": "2018-10-10T09:00:00+0200", - "expectedDepartureTime": "2018-10-10T09:00:00+0200", - "requestStop": false, - "notices": [], - "destinationDisplay": { - "frontText": "Stavanger Airport via Forum" - }, - "serviceJourney": { - "journeyPattern": { - "line": { - "id": "KOL:Line:2900_234", - "name": "Flybussen", - "transportMode": "bus", - "publicCode": "5" - } - } - } - }, - { - "realtime": false, - "aimedArrivalTime": "2018-10-10T09:06:00+0200", - "aimedDepartureTime": "2018-10-10T09:06:00+0200", - "expectedArrivalTime": "2018-10-10T09:06:00+0200", - "expectedDepartureTime": "2018-10-10T09:06:00+0200", - "requestStop": false, - "notices": [], - "destinationDisplay": { - "frontText": "Stavanger" - }, - "serviceJourney": { - "journeyPattern": { - "line": { - "id": "KOL:Line:1000_234", - "name": "1", - "transportMode": "bus", - "publicCode": "1" - } - } - } - } - ] - } - ] - } -} \ No newline at end of file