153 lines
4.2 KiB
Python
153 lines
4.2 KiB
Python
"""Support for Washington State Department of Transportation (WSDOT) data."""
|
|
from datetime import datetime, timedelta, timezone
|
|
import logging
|
|
import re
|
|
|
|
import requests
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA, SensorEntity
|
|
from homeassistant.const import (
|
|
ATTR_ATTRIBUTION,
|
|
ATTR_NAME,
|
|
CONF_API_KEY,
|
|
CONF_ID,
|
|
CONF_NAME,
|
|
HTTP_OK,
|
|
TIME_MINUTES,
|
|
)
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
ATTR_ACCESS_CODE = "AccessCode"
|
|
ATTR_AVG_TIME = "AverageTime"
|
|
ATTR_CURRENT_TIME = "CurrentTime"
|
|
ATTR_DESCRIPTION = "Description"
|
|
ATTR_TIME_UPDATED = "TimeUpdated"
|
|
ATTR_TRAVEL_TIME_ID = "TravelTimeID"
|
|
|
|
ATTRIBUTION = "Data provided by WSDOT"
|
|
|
|
CONF_TRAVEL_TIMES = "travel_time"
|
|
|
|
ICON = "mdi:car"
|
|
|
|
RESOURCE = (
|
|
"http://www.wsdot.wa.gov/Traffic/api/TravelTimes/"
|
|
"TravelTimesREST.svc/GetTravelTimeAsJson"
|
|
)
|
|
|
|
SCAN_INTERVAL = timedelta(minutes=3)
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_API_KEY): cv.string,
|
|
vol.Optional(CONF_TRAVEL_TIMES): [
|
|
{vol.Required(CONF_ID): cv.string, vol.Optional(CONF_NAME): cv.string}
|
|
],
|
|
}
|
|
)
|
|
|
|
|
|
def setup_platform(hass, config, add_entities, discovery_info=None):
|
|
"""Set up the WSDOT sensor."""
|
|
sensors = []
|
|
for travel_time in config.get(CONF_TRAVEL_TIMES):
|
|
name = travel_time.get(CONF_NAME) or travel_time.get(CONF_ID)
|
|
sensors.append(
|
|
WashingtonStateTravelTimeSensor(
|
|
name, config.get(CONF_API_KEY), travel_time.get(CONF_ID)
|
|
)
|
|
)
|
|
|
|
add_entities(sensors, True)
|
|
|
|
|
|
class WashingtonStateTransportSensor(SensorEntity):
|
|
"""
|
|
Sensor that reads the WSDOT web API.
|
|
|
|
WSDOT provides ferry schedules, toll rates, weather conditions,
|
|
mountain pass conditions, and more. Subclasses of this
|
|
can read them and make them available.
|
|
"""
|
|
|
|
def __init__(self, name, access_code):
|
|
"""Initialize the sensor."""
|
|
self._data = {}
|
|
self._access_code = access_code
|
|
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 icon(self):
|
|
"""Icon to use in the frontend, if any."""
|
|
return ICON
|
|
|
|
|
|
class WashingtonStateTravelTimeSensor(WashingtonStateTransportSensor):
|
|
"""Travel time sensor from WSDOT."""
|
|
|
|
def __init__(self, name, access_code, travel_time_id):
|
|
"""Construct a travel time sensor."""
|
|
self._travel_time_id = travel_time_id
|
|
WashingtonStateTransportSensor.__init__(self, name, access_code)
|
|
|
|
def update(self):
|
|
"""Get the latest data from WSDOT."""
|
|
params = {
|
|
ATTR_ACCESS_CODE: self._access_code,
|
|
ATTR_TRAVEL_TIME_ID: self._travel_time_id,
|
|
}
|
|
|
|
response = requests.get(RESOURCE, params, timeout=10)
|
|
if response.status_code != HTTP_OK:
|
|
_LOGGER.warning("Invalid response from WSDOT API")
|
|
else:
|
|
self._data = response.json()
|
|
self._state = self._data.get(ATTR_CURRENT_TIME)
|
|
|
|
@property
|
|
def extra_state_attributes(self):
|
|
"""Return other details about the sensor state."""
|
|
if self._data is not None:
|
|
attrs = {ATTR_ATTRIBUTION: ATTRIBUTION}
|
|
for key in [
|
|
ATTR_AVG_TIME,
|
|
ATTR_NAME,
|
|
ATTR_DESCRIPTION,
|
|
ATTR_TRAVEL_TIME_ID,
|
|
]:
|
|
attrs[key] = self._data.get(key)
|
|
attrs[ATTR_TIME_UPDATED] = _parse_wsdot_timestamp(
|
|
self._data.get(ATTR_TIME_UPDATED)
|
|
)
|
|
return attrs
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
"""Return the unit this state is expressed in."""
|
|
return TIME_MINUTES
|
|
|
|
|
|
def _parse_wsdot_timestamp(timestamp):
|
|
"""Convert WSDOT timestamp to datetime."""
|
|
if not timestamp:
|
|
return None
|
|
# ex: Date(1485040200000-0800)
|
|
milliseconds, tzone = re.search(r"Date\((\d+)([+-]\d\d)\d\d\)", timestamp).groups()
|
|
return datetime.fromtimestamp(
|
|
int(milliseconds) / 1000, tz=timezone(timedelta(hours=int(tzone)))
|
|
)
|