Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Bizkaibus, Biscays (Spain) bus service component #22934

Merged
merged 19 commits into from May 5, 2019
Merged
Changes from all commits
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

@@ -53,6 +53,7 @@ omit =
homeassistant/components/bbox/sensor.py
homeassistant/components/bh1750/sensor.py
homeassistant/components/bitcoin/sensor.py
homeassistant/components/bizkaibus/sensor.py
homeassistant/components/blink/*
homeassistant/components/blinksticklight/light.py
homeassistant/components/blinkt/light.py
@@ -32,6 +32,7 @@ homeassistant/components/automation/* @home-assistant/core
homeassistant/components/aws/* @awarecan @robbiet480
homeassistant/components/axis/* @kane610
homeassistant/components/bitcoin/* @fabaff
homeassistant/components/bizkaibus/* @UgaitzEtxebarria
homeassistant/components/blink/* @fronzbot
homeassistant/components/bmw_connected_drive/* @ChristianKuehnel
homeassistant/components/braviatv/* @robbiet480
@@ -0,0 +1 @@
"""The Bizkaibus bus tracker component."""
@@ -0,0 +1,8 @@
{
"domain": "bizkaibus",
"name": "Bizkaibus",
"documentation": "https://www.home-assistant.io/components/bizkaibus",
"dependencies": [],
"codeowners": ["@UgaitzEtxebarria"],
"requirements": ["bizkaibus==0.1.1"]
}
@@ -0,0 +1,88 @@
"""Support for Bizkaibus, Biscay (Basque Country, Spain) Bus service."""

import logging

import voluptuous as vol
from bizkaibus.bizkaibus import BizkaibusData
import homeassistant.helpers.config_validation as cv

from homeassistant.const import CONF_NAME
from homeassistant.components.sensor import PLATFORM_SCHEMA
from homeassistant.helpers.entity import Entity


_LOGGER = logging.getLogger(__name__)

ATTR_DUE_IN = 'Due in'

CONF_STOP_ID = 'stopid'
CONF_ROUTE = 'route'

DEFAULT_NAME = 'Next bus'

PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Required(CONF_STOP_ID): cv.string,
vol.Required(CONF_ROUTE): cv.string,
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
})


def setup_platform(hass, config, add_entities, discovery_info=None):
"""Set up the Bizkaibus public transport sensor."""
name = config.get(CONF_NAME)
This conversation was marked as resolved by ludeeus

This comment has been minimized.

Copy link
@ludeeus

ludeeus Apr 18, 2019

Contributor

For required options, you should use dict['key'] instead of dict.get('key')

stop = config[CONF_STOP_ID]
route = config[CONF_ROUTE]

data = Bizkaibus(stop, route)
add_entities([BizkaibusSensor(data, stop, route, name)], True)


class BizkaibusSensor(Entity):
"""The class for handling the data."""

def __init__(self, data, stop, route, name):
"""Initialize the sensor."""
self.data = data
self.stop = stop
self.route = route
self._name = name
self._state = None

@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 unit_of_measurement(self):
"""Return the unit of measurement of the sensor."""
return 'minutes'

def update(self):
"""Get the latest data from the webservice."""
self.data.update()
try:
self._state = self.data.info[0][ATTR_DUE_IN]

This comment has been minimized.

Copy link
@MartinHjelmare

MartinHjelmare May 5, 2019

Member

We're trying to move new departure time type sensors over to use the timestamp device class. That means reporting an absolute utc ISO timestamp instead of a relative time as state.

We should keep this in mind for the future development of this platform.

https://developers.home-assistant.io/docs/en/entity_sensor.html#available-device-classes

https://www.home-assistant.io/lovelace/entities/#format

except TypeError:
pass


class Bizkaibus:
"""The class for handling the data retrieval."""

def __init__(self, stop, route):
"""Initialize the data object."""
self.stop = stop
self.route = route
self.info = None

def update(self):
"""Retrieve the information from API."""
bridge = BizkaibusData(self.stop, self.route)
bridge.getNextBus()
self.info = bridge.info
@@ -217,6 +217,9 @@ bellows-homeassistant==0.7.2
# homeassistant.components.bmw_connected_drive
bimmer_connected==0.5.3

# homeassistant.components.bizkaibus
bizkaibus==0.1.1

# homeassistant.components.blink
blinkpy==0.13.1

ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.