Add Norwegian Public Transportation sensor (Ruter). (#18237)
* Add Norwegian Public Transportation sensor (Ruter). * Corrected typo. * change stopid to stop_id, actually use attributes, changed logging, corrected link, removed unused variable. * Change to RuterSensor for the class, and move logic to me more readable. * Use correct sensor class. * Add return if blank list, remove else
This commit is contained in:
parent
917ebed4c9
commit
c41ca37a04
3 changed files with 96 additions and 0 deletions
|
@ -768,6 +768,7 @@ omit =
|
|||
homeassistant/components/sensor/rainbird.py
|
||||
homeassistant/components/sensor/ripple.py
|
||||
homeassistant/components/sensor/rtorrent.py
|
||||
homeassistant/components/sensor/ruter.py
|
||||
homeassistant/components/sensor/scrape.py
|
||||
homeassistant/components/sensor/sensehat.py
|
||||
homeassistant/components/sensor/serial_pm.py
|
||||
|
|
92
homeassistant/components/sensor/ruter.py
Normal file
92
homeassistant/components/sensor/ruter.py
Normal file
|
@ -0,0 +1,92 @@
|
|||
"""
|
||||
A sensor platform that give you information about next departures from Ruter.
|
||||
|
||||
For more details about this platform, please refer to the documentation at
|
||||
https://www.home-assistant.io/components/sensor.ruter/
|
||||
"""
|
||||
import logging
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
||||
from homeassistant.const import CONF_NAME
|
||||
from homeassistant.helpers.entity import Entity
|
||||
|
||||
REQUIREMENTS = ['pyruter==1.0.2']
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
CONF_STOP_ID = 'stop_id'
|
||||
CONF_DESTINATION = 'destination'
|
||||
CONF_OFFSET = 'offset'
|
||||
|
||||
DEFAULT_NAME = 'Ruter'
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||
vol.Required(CONF_STOP_ID): cv.positive_int,
|
||||
vol.Optional(CONF_DESTINATION): cv.string,
|
||||
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
||||
vol.Optional(CONF_OFFSET, default=1): cv.positive_int,
|
||||
})
|
||||
|
||||
|
||||
async def async_setup_platform(
|
||||
hass, config, async_add_entities, discovery_info=None):
|
||||
"""Create the sensor."""
|
||||
from pyruter.api import Departures
|
||||
|
||||
stop_id = config[CONF_STOP_ID]
|
||||
destination = config.get(CONF_DESTINATION)
|
||||
name = config[CONF_NAME]
|
||||
offset = config[CONF_OFFSET]
|
||||
|
||||
ruter = Departures(hass.loop, stop_id, destination)
|
||||
sensor = [RuterSensor(ruter, name, offset)]
|
||||
async_add_entities(sensor, True)
|
||||
|
||||
|
||||
class RuterSensor(Entity):
|
||||
"""Representation of a Ruter sensor."""
|
||||
|
||||
def __init__(self, ruter, name, offset):
|
||||
"""Initialize the sensor."""
|
||||
self.ruter = ruter
|
||||
self._attributes = {}
|
||||
self._name = name
|
||||
self._offset = offset
|
||||
self._state = None
|
||||
|
||||
async def async_update(self):
|
||||
"""Get the latest data from the Ruter API."""
|
||||
await self.ruter.get_departures()
|
||||
if self.ruter.departures is None:
|
||||
_LOGGER.error("No data recieved from Ruter.")
|
||||
return
|
||||
try:
|
||||
data = self.ruter.departures[self._offset]
|
||||
self._state = data['time']
|
||||
self._attributes['line'] = data['line']
|
||||
self._attributes['destination'] = data['destination']
|
||||
except (KeyError, IndexError) as error:
|
||||
_LOGGER.debug("Error getting data from Ruter, %s", error)
|
||||
|
||||
@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
|
|
@ -1080,6 +1080,9 @@ pyrainbird==0.1.6
|
|||
# homeassistant.components.switch.recswitch
|
||||
pyrecswitch==1.0.2
|
||||
|
||||
# homeassistant.components.sensor.ruter
|
||||
pyruter==1.0.2
|
||||
|
||||
# homeassistant.components.sabnzbd
|
||||
pysabnzbd==1.1.0
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue