mirror of
https://github.com/home-assistant/core.git
synced 2025-07-26 06:37:52 +00:00
Added Waze travel time sensor (#12387)
* Added Waze travel time sensor * Update according PR comments and simplification
This commit is contained in:
parent
3b4faa74a0
commit
7bf8d4ab12
136
homeassistant/components/sensor/waze_travel_time.py
Normal file
136
homeassistant/components/sensor/waze_travel_time.py
Normal file
@ -0,0 +1,136 @@
|
|||||||
|
"""
|
||||||
|
Support for Waze travel time sensor.
|
||||||
|
|
||||||
|
For more details about this platform, please refer to the documentation at
|
||||||
|
https://home-assistant.io/components/sensor.waze_travel_time/
|
||||||
|
"""
|
||||||
|
from datetime import timedelta
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import requests
|
||||||
|
import voluptuous as vol
|
||||||
|
|
||||||
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
||||||
|
from homeassistant.const import ATTR_ATTRIBUTION, CONF_NAME, CONF_REGION
|
||||||
|
import homeassistant.helpers.config_validation as cv
|
||||||
|
from homeassistant.helpers.entity import Entity
|
||||||
|
from homeassistant.util import Throttle
|
||||||
|
|
||||||
|
REQUIREMENTS = ['WazeRouteCalculator==0.5']
|
||||||
|
|
||||||
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
ATTR_DISTANCE = 'distance'
|
||||||
|
ATTR_ROUTE = 'route'
|
||||||
|
|
||||||
|
CONF_ATTRIBUTION = "Data provided by the Waze.com"
|
||||||
|
CONF_DESTINATION = 'destination'
|
||||||
|
CONF_ORIGIN = 'origin'
|
||||||
|
|
||||||
|
DEFAULT_NAME = 'Waze Travel Time'
|
||||||
|
|
||||||
|
ICON = 'mdi:car'
|
||||||
|
|
||||||
|
REGIONS = ['US', 'NA', 'EU', 'IL']
|
||||||
|
|
||||||
|
SCAN_INTERVAL = timedelta(minutes=5)
|
||||||
|
|
||||||
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||||
|
vol.Required(CONF_ORIGIN): cv.string,
|
||||||
|
vol.Required(CONF_DESTINATION): cv.string,
|
||||||
|
vol.Required(CONF_REGION): vol.In(REGIONS),
|
||||||
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
||||||
|
})
|
||||||
|
|
||||||
|
|
||||||
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
||||||
|
"""Set up the Waze travel time sensor platform."""
|
||||||
|
destination = config.get(CONF_DESTINATION)
|
||||||
|
name = config.get(CONF_NAME)
|
||||||
|
origin = config.get(CONF_ORIGIN)
|
||||||
|
region = config.get(CONF_REGION)
|
||||||
|
|
||||||
|
try:
|
||||||
|
waze_data = WazeRouteData(origin, destination, region)
|
||||||
|
except requests.exceptions.HTTPError as error:
|
||||||
|
_LOGGER.error("%s", error)
|
||||||
|
return
|
||||||
|
|
||||||
|
add_devices([WazeTravelTime(waze_data, name)], True)
|
||||||
|
|
||||||
|
|
||||||
|
class WazeTravelTime(Entity):
|
||||||
|
"""Representation of a Waze travel time sensor."""
|
||||||
|
|
||||||
|
def __init__(self, waze_data, name):
|
||||||
|
"""Initialize the Waze travel time sensor."""
|
||||||
|
self._name = name
|
||||||
|
self._state = None
|
||||||
|
self.waze_data = waze_data
|
||||||
|
|
||||||
|
@property
|
||||||
|
def name(self):
|
||||||
|
"""Return the name of the sensor."""
|
||||||
|
return self._name
|
||||||
|
|
||||||
|
@property
|
||||||
|
def state(self):
|
||||||
|
"""Return the state of the sensor."""
|
||||||
|
return round(self._state['duration'])
|
||||||
|
|
||||||
|
@property
|
||||||
|
def unit_of_measurement(self):
|
||||||
|
"""Return the unit of measurement."""
|
||||||
|
return 'min'
|
||||||
|
|
||||||
|
@property
|
||||||
|
def icon(self):
|
||||||
|
"""Icon to use in the frontend, if any."""
|
||||||
|
return ICON
|
||||||
|
|
||||||
|
@property
|
||||||
|
def device_state_attributes(self):
|
||||||
|
"""Return the state attributes of the last update."""
|
||||||
|
return {
|
||||||
|
ATTR_ATTRIBUTION: CONF_ATTRIBUTION,
|
||||||
|
ATTR_DISTANCE: round(self._state['distance']),
|
||||||
|
ATTR_ROUTE: self._state['route'],
|
||||||
|
}
|
||||||
|
|
||||||
|
def update(self):
|
||||||
|
"""Fetch new state data for the sensor."""
|
||||||
|
try:
|
||||||
|
self.waze_data.update()
|
||||||
|
self._state = self.waze_data.data
|
||||||
|
except KeyError:
|
||||||
|
_LOGGER.error("Error retrieving data from server")
|
||||||
|
|
||||||
|
|
||||||
|
class WazeRouteData(object):
|
||||||
|
"""Get data from Waze."""
|
||||||
|
|
||||||
|
def __init__(self, origin, destination, region):
|
||||||
|
"""Initialize the data object."""
|
||||||
|
self._destination = destination
|
||||||
|
self._origin = origin
|
||||||
|
self._region = region
|
||||||
|
self.data = {}
|
||||||
|
|
||||||
|
@Throttle(SCAN_INTERVAL)
|
||||||
|
def update(self):
|
||||||
|
"""Fetch latest data from Waze."""
|
||||||
|
import WazeRouteCalculator
|
||||||
|
_LOGGER.debug("Update in progress...")
|
||||||
|
try:
|
||||||
|
params = WazeRouteCalculator.WazeRouteCalculator(
|
||||||
|
self._origin, self._destination, self._region, None)
|
||||||
|
results = params.calc_all_routes_info()
|
||||||
|
best_route = next(iter(results))
|
||||||
|
(duration, distance) = results[best_route]
|
||||||
|
best_route_str = bytes(best_route, 'ISO-8859-1').decode('UTF-8')
|
||||||
|
self.data['duration'] = duration
|
||||||
|
self.data['distance'] = distance
|
||||||
|
self.data['route'] = best_route_str
|
||||||
|
except WazeRouteCalculator.WRCError as exp:
|
||||||
|
_LOGGER.error("Error on retrieving data: %s", exp)
|
||||||
|
return
|
@ -54,6 +54,9 @@ TravisPy==0.3.5
|
|||||||
# homeassistant.components.notify.twitter
|
# homeassistant.components.notify.twitter
|
||||||
TwitterAPI==2.5.0
|
TwitterAPI==2.5.0
|
||||||
|
|
||||||
|
# homeassistant.components.sensor.waze_travel_time
|
||||||
|
WazeRouteCalculator==0.5
|
||||||
|
|
||||||
# homeassistant.components.notify.yessssms
|
# homeassistant.components.notify.yessssms
|
||||||
YesssSMS==0.1.1b3
|
YesssSMS==0.1.1b3
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user