239 lines
9.3 KiB
Python
239 lines
9.3 KiB
Python
"""
|
|
Support for the Uber API.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/sensor.uber/
|
|
"""
|
|
import logging
|
|
from datetime import timedelta
|
|
|
|
import voluptuous as vol
|
|
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.util import Throttle
|
|
|
|
REQUIREMENTS = ['uber_rides==0.6.0']
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
CONF_END_LATITUDE = 'end_latitude'
|
|
CONF_END_LONGITUDE = 'end_longitude'
|
|
CONF_PRODUCT_IDS = 'product_ids'
|
|
CONF_SERVER_TOKEN = 'server_token'
|
|
CONF_START_LATITUDE = 'start_latitude'
|
|
CONF_START_LONGITUDE = 'start_longitude'
|
|
|
|
ICON = 'mdi:taxi'
|
|
|
|
MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=60)
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Required(CONF_SERVER_TOKEN): cv.string,
|
|
vol.Optional(CONF_START_LATITUDE): cv.latitude,
|
|
vol.Optional(CONF_START_LONGITUDE): cv.longitude,
|
|
vol.Optional(CONF_END_LATITUDE): cv.latitude,
|
|
vol.Optional(CONF_END_LONGITUDE): cv.longitude,
|
|
vol.Optional(CONF_PRODUCT_IDS): vol.All(cv.ensure_list, [cv.string]),
|
|
})
|
|
|
|
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
"""Set up the Uber sensor."""
|
|
from uber_rides.session import Session
|
|
|
|
session = Session(server_token=config.get(CONF_SERVER_TOKEN))
|
|
start_latitude = config.get(CONF_START_LATITUDE, hass.config.latitude)
|
|
start_longitude = config.get(CONF_START_LONGITUDE, hass.config.longitude)
|
|
end_latitude = config.get(CONF_END_LATITUDE)
|
|
end_longitude = config.get(CONF_END_LONGITUDE)
|
|
wanted_product_ids = config.get(CONF_PRODUCT_IDS)
|
|
|
|
dev = []
|
|
timeandpriceest = UberEstimate(
|
|
session, start_latitude, start_longitude, end_latitude, end_longitude)
|
|
|
|
for product_id, product in timeandpriceest.products.items():
|
|
if (wanted_product_ids is not None) and \
|
|
(product_id not in wanted_product_ids):
|
|
continue
|
|
dev.append(UberSensor('time', timeandpriceest, product_id, product))
|
|
|
|
if product.get('price_details') is not None \
|
|
and product['display_name'] != 'TAXI':
|
|
dev.append(UberSensor(
|
|
'price', timeandpriceest, product_id, product))
|
|
|
|
add_devices(dev, True)
|
|
|
|
|
|
class UberSensor(Entity):
|
|
"""Implementation of an Uber sensor."""
|
|
|
|
def __init__(self, sensorType, products, product_id, product):
|
|
"""Initialize the Uber sensor."""
|
|
self.data = products
|
|
self._product_id = product_id
|
|
self._product = product
|
|
self._sensortype = sensorType
|
|
self._name = '{} {}'.format(
|
|
self._product['display_name'], self._sensortype)
|
|
if self._sensortype == 'time':
|
|
self._unit_of_measurement = 'min'
|
|
time_estimate = self._product.get('time_estimate_seconds', 0)
|
|
self._state = int(time_estimate / 60)
|
|
elif self._sensortype == 'price':
|
|
if self._product.get('price_details') is not None:
|
|
price_details = self._product['price_details']
|
|
self._unit_of_measurement = price_details.get('currency_code')
|
|
try:
|
|
if price_details.get('low_estimate') is not None:
|
|
statekey = 'minimum'
|
|
else:
|
|
statekey = 'low_estimate'
|
|
self._state = int(price_details.get(statekey))
|
|
except TypeError:
|
|
self._state = 0
|
|
else:
|
|
self._state = 0
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
if 'uber' not in self._name.lower():
|
|
self._name = 'Uber{}'.format(self._name)
|
|
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 this entity, if any."""
|
|
return self._unit_of_measurement
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
"""Return the state attributes."""
|
|
time_estimate = self._product.get('time_estimate_seconds')
|
|
params = {
|
|
'Product ID': self._product['product_id'],
|
|
'Product short description': self._product['short_description'],
|
|
'Product display name': self._product['display_name'],
|
|
'Product description': self._product['description'],
|
|
'Pickup time estimate (in seconds)': time_estimate,
|
|
'Trip duration (in seconds)': self._product.get('duration'),
|
|
'Vehicle Capacity': self._product['capacity']
|
|
}
|
|
|
|
if self._product.get('price_details') is not None:
|
|
price_details = self._product['price_details']
|
|
dunit = price_details.get('distance_unit')
|
|
distance_key = 'Trip distance (in {}s)'.format(dunit)
|
|
distance_val = self._product.get('distance')
|
|
params['Cost per minute'] = price_details.get('cost_per_minute')
|
|
params['Distance units'] = price_details.get('distance_unit')
|
|
params['Cancellation fee'] = price_details.get('cancellation_fee')
|
|
cpd = price_details.get('cost_per_distance')
|
|
params['Cost per distance'] = cpd
|
|
params['Base price'] = price_details.get('base')
|
|
params['Minimum price'] = price_details.get('minimum')
|
|
params['Price estimate'] = price_details.get('estimate')
|
|
params['Price currency code'] = price_details.get('currency_code')
|
|
params['High price estimate'] = price_details.get('high_estimate')
|
|
params['Low price estimate'] = price_details.get('low_estimate')
|
|
params['Surge multiplier'] = price_details.get('surge_multiplier')
|
|
else:
|
|
distance_key = 'Trip distance (in miles)'
|
|
distance_val = self._product.get('distance')
|
|
|
|
params[distance_key] = distance_val
|
|
|
|
return {k: v for k, v in params.items() if v is not None}
|
|
|
|
@property
|
|
def icon(self):
|
|
"""Icon to use in the frontend, if any."""
|
|
return ICON
|
|
|
|
def update(self):
|
|
"""Get the latest data from the Uber API and update the states."""
|
|
self.data.update()
|
|
self._product = self.data.products[self._product_id]
|
|
if self._sensortype == 'time':
|
|
time_estimate = self._product.get('time_estimate_seconds', 0)
|
|
self._state = int(time_estimate / 60)
|
|
elif self._sensortype == 'price':
|
|
price_details = self._product.get('price_details')
|
|
if price_details is not None:
|
|
min_price = price_details.get('minimum')
|
|
self._state = int(price_details.get('low_estimate', min_price))
|
|
else:
|
|
self._state = 0
|
|
|
|
|
|
class UberEstimate(object):
|
|
"""The class for handling the time and price estimate."""
|
|
|
|
def __init__(self, session, start_latitude, start_longitude,
|
|
end_latitude=None, end_longitude=None):
|
|
"""Initialize the UberEstimate object."""
|
|
self._session = session
|
|
self.start_latitude = start_latitude
|
|
self.start_longitude = start_longitude
|
|
self.end_latitude = end_latitude
|
|
self.end_longitude = end_longitude
|
|
self.products = None
|
|
self.update()
|
|
|
|
@Throttle(MIN_TIME_BETWEEN_UPDATES)
|
|
def update(self):
|
|
"""Get the latest product info and estimates from the Uber API."""
|
|
from uber_rides.client import UberRidesClient
|
|
client = UberRidesClient(self._session)
|
|
|
|
self.products = {}
|
|
|
|
products_response = client.get_products(
|
|
self.start_latitude, self.start_longitude)
|
|
|
|
products = products_response.json.get('products')
|
|
|
|
for product in products:
|
|
self.products[product['product_id']] = product
|
|
|
|
if self.end_latitude is not None and self.end_longitude is not None:
|
|
price_response = client.get_price_estimates(
|
|
self.start_latitude, self.start_longitude,
|
|
self.end_latitude, self.end_longitude)
|
|
|
|
prices = price_response.json.get('prices', [])
|
|
|
|
for price in prices:
|
|
product = self.products[price['product_id']]
|
|
product['duration'] = price.get('duration', '0')
|
|
product['distance'] = price.get('distance', '0')
|
|
price_details = product.get('price_details')
|
|
if product.get('price_details') is None:
|
|
price_details = {}
|
|
price_details['estimate'] = price.get('estimate', '0')
|
|
price_details['high_estimate'] = price.get(
|
|
'high_estimate', '0')
|
|
price_details['low_estimate'] = price.get('low_estimate', '0')
|
|
price_details['currency_code'] = price.get('currency_code')
|
|
surge_multiplier = price.get('surge_multiplier', '0')
|
|
price_details['surge_multiplier'] = surge_multiplier
|
|
product['price_details'] = price_details
|
|
|
|
estimate_response = client.get_pickup_time_estimates(
|
|
self.start_latitude, self.start_longitude)
|
|
|
|
estimates = estimate_response.json.get('times')
|
|
|
|
for estimate in estimates:
|
|
self.products[estimate['product_id']][
|
|
'time_estimate_seconds'] = estimate.get('estimate', '0')
|