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 Norwegian Public Transportation sensor (Ruter). #18237
Merged
Merged
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
8966498
Add Norwegian Public Transportation sensor (Ruter).
ludeeus b332daa
Corrected typo.
ludeeus 9bba144
change stopid to stop_id, actually use attributes, changed logging, c…
ludeeus 9efcefa
Change to RuterSensor for the class, and move logic to me more readable.
ludeeus c9c16b7
Use correct sensor class.
ludeeus b0e66e0
Add return if blank list, remove else
ludeeus File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 = [TautulliSensor(ruter, name, offset)] | ||
ludeeus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
async_add_entities(sensor, True) | ||
|
||
|
||
class TautulliSensor(Entity): | ||
ludeeus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"""Representation of a Sensor.""" | ||
ludeeus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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 not None: | ||
ludeeus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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) | ||
else: | ||
_LOGGER.error("No data recieved from Ruter.") | ||
|
||
@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): | ||
ludeeus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"""Return attributes for the sensor.""" | ||
return self._attributes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We want all libraries that use aiohttp to take a session argument so that we can reuse the home assistant session throughout the app.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was not aware of that, will change it that and create a new PR later today :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Isn't it more like "we would like"? I believe that part of the deal with using third party libraries is that we don't get to dictate their interface.
Still, @ludeeus, please do continue with implementing that :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@amelchio we don't have to dictate their interface, but very much like if they do take in an optional aiohttp session instead of creating their own if they use aiohttp.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, and for a library created for Home Assistant that is no biggie. I was more concerned about rejecting a new platform because an existing library does not support passing in the session.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah no, we wouldn't do that.