GeoRSS sensor (#9331)
* new geo rss events sensor * SCAN_INTERVAL instead of DEFAULT_SCAN_INTERVAL * removed redefinition CONF_SCAN_INTERVAL * definition of self._name not required * removed unnecessary check and unnecessary parameter * changed log levels * fixed default name not used * streamlined sensor name and entity id generation, removed unnecessary parameter * fixed issue for entries without geometry data * fixed tests after code changes * simplified code * simplified code; removed unnecessary imports * fixed invalid variable name * shorter sensor name and in turn entity id * increasing test coverage for previously untested code * fixed indentation and variable usage * simplified test code * merged two similar tests * fixed an issue if no data could be fetched from external service; added test case for this case
This commit is contained in:
1 parent
499382a9a9
commit
0d75cd484b
6 files changed
+475
No files matched your search
@@ -0,0 +1,243 @@
|
||||
"""
|
||||
Generic GeoRSS events service.
|
||||
|
||||
Retrieves current events (typically incidents or alerts) in GeoRSS format, and
|
||||
shows information on events filtered by distance to the HA instance's location
|
||||
and grouped by category.
|
||||
|
||||
For more details about this platform, please refer to the documentation at
|
||||
https://home-assistant.io/components/sensor.geo_rss_events/
|
||||
"""
|
||||
|
||||
import logging
|
||||
from collections import namedtuple
|
||||
from datetime import timedelta
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
||||
from homeassistant.const import (STATE_UNKNOWN, CONF_UNIT_OF_MEASUREMENT,
|
||||
CONF_NAME)
|
||||
from homeassistant.helpers.entity import Entity
|
||||
from homeassistant.util import Throttle
|
||||
|
||||
REQUIREMENTS = ['feedparser==5.2.1', 'haversine==0.4.5']
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
ATTR_CATEGORY = 'category'
|
||||
ATTR_DISTANCE = 'distance'
|
||||
ATTR_TITLE = 'title'
|
||||
|
||||
CONF_CATEGORIES = 'categories'
|
||||
CONF_RADIUS = 'radius'
|
||||
CONF_URL = 'url'
|
||||
|
||||
DEFAULT_ICON = 'mdi:alert'
|
||||
DEFAULT_NAME = "Event Service"
|
||||
DEFAULT_RADIUS_IN_KM = 20.0
|
||||
DEFAULT_UNIT_OF_MEASUREMENT = 'Events'
|
||||
|
||||
DOMAIN = 'geo_rss_events'
|
||||
|
||||
# Minimum time between updates from the source.
|
||||
MIN_TIME_BETWEEN_UPDATES = timedelta(minutes=1)
|
||||
|
||||
SCAN_INTERVAL = timedelta(minutes=5)
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||
vol.Required(CONF_URL): cv.string,
|
||||
vol.Optional(CONF_RADIUS, default=DEFAULT_RADIUS_IN_KM): vol.Coerce(float),
|
||||
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
||||
vol.Optional(CONF_CATEGORIES, default=[]): vol.All(cv.ensure_list,
|
||||
[cv.string]),
|
||||
vol.Optional(CONF_UNIT_OF_MEASUREMENT,
|
||||
default=DEFAULT_UNIT_OF_MEASUREMENT): cv.string,
|
||||
})
|
||||
|
||||
|
||||
def setup_platform(hass, config, add_devices, discovery_info=None):
|
||||
"""Set up the GeoRSS component."""
|
||||
# Grab location from config
|
||||
home_latitude = hass.config.latitude
|
||||
home_longitude = hass.config.longitude
|
||||
url = config.get(CONF_URL)
|
||||
radius_in_km = config.get(CONF_RADIUS)
|
||||
name = config.get(CONF_NAME)
|
||||
categories = config.get(CONF_CATEGORIES)
|
||||
unit_of_measurement = config.get(CONF_UNIT_OF_MEASUREMENT)
|
||||
|
||||
_LOGGER.debug("latitude=%s, longitude=%s, url=%s, radius=%s",
|
||||
home_latitude, home_longitude, url, radius_in_km)
|
||||
|
||||
# Initialise update service.
|
||||
data = GeoRssServiceData(home_latitude, home_longitude, url, radius_in_km)
|
||||
data.update()
|
||||
|
||||
# Create all sensors based on categories.
|
||||
devices = []
|
||||
if not categories:
|
||||
device = GeoRssServiceSensor(None, data, name, unit_of_measurement)
|
||||
devices.append(device)
|
||||
else:
|
||||
for category in categories:
|
||||
device = GeoRssServiceSensor(category, data, name,
|
||||
unit_of_measurement)
|
||||
devices.append(device)
|
||||
add_devices(devices, True)
|
||||
|
||||
|
||||
class GeoRssServiceSensor(Entity):
|
||||
"""Representation of a Sensor."""
|
||||
|
||||
def __init__(self, category, data, service_name, unit_of_measurement):
|
||||
"""Initialize the sensor."""
|
||||
self._category = category
|
||||
self._data = data
|
||||
self._service_name = service_name
|
||||
self._state = STATE_UNKNOWN
|
||||
self._state_attributes = None
|
||||
self._unit_of_measurement = unit_of_measurement
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""Return the name of the sensor."""
|
||||
return '{} {}'.format(self._service_name,
|
||||
'Any' if self._category is None
|
||||
else self._category)
|
||||
|
||||
@property
|
||||
def state(self):
|
||||
"""Return the state of the sensor."""
|
||||
return self._state
|
||||
|
||||
@property
|
||||
def unit_of_measurement(self):
|
||||
"""Return the unit of measurement."""
|
||||
return self._unit_of_measurement
|
||||
|
||||
@property
|
||||
def icon(self):
|
||||
"""Return the default icon to use in the frontend."""
|
||||
return DEFAULT_ICON
|
||||
|
||||
@property
|
||||
def device_state_attributes(self):
|
||||
"""Return the state attributes."""
|
||||
return self._state_attributes
|
||||
|
||||
def update(self):
|
||||
"""Update this sensor from the GeoRSS service."""
|
||||
_LOGGER.debug("About to update sensor %s", self.entity_id)
|
||||
self._data.update()
|
||||
# If no events were found due to an error then just set state to zero.
|
||||
if self._data.events is None:
|
||||
self._state = 0
|
||||
else:
|
||||
if self._category is None:
|
||||
# Add all events regardless of category.
|
||||
my_events = self._data.events
|
||||
else:
|
||||
# Only keep events that belong to sensor's category.
|
||||
my_events = [event for event in self._data.events if
|
||||
event[ATTR_CATEGORY] == self._category]
|
||||
_LOGGER.debug("Adding events to sensor %s: %s", self.entity_id,
|
||||
my_events)
|
||||
self._state = len(my_events)
|
||||
# And now compute the attributes from the filtered events.
|
||||
matrix = {}
|
||||
for event in my_events:
|
||||
matrix[event[ATTR_TITLE]] = '{:.0f}km'.format(
|
||||
event[ATTR_DISTANCE])
|
||||
self._state_attributes = matrix
|
||||
|
||||
|
||||
class GeoRssServiceData(object):
|
||||
"""Provides access to GeoRSS feed and stores the latest data."""
|
||||
|
||||
def __init__(self, home_latitude, home_longitude, url, radius_in_km):
|
||||
"""Initialize the update service."""
|
||||
self._home_coordinates = [home_latitude, home_longitude]
|
||||
self._url = url
|
||||
self._radius_in_km = radius_in_km
|
||||
self.events = None
|
||||
|
||||
@Throttle(MIN_TIME_BETWEEN_UPDATES)
|
||||
def update(self):
|
||||
"""Retrieve data from GeoRSS feed and store events."""
|
||||
import feedparser
|
||||
feed_data = feedparser.parse(self._url)
|
||||
if not feed_data:
|
||||
_LOGGER.error("Error fetching feed data from %s", self._url)
|
||||
else:
|
||||
events = self.filter_entries(feed_data)
|
||||
self.events = events
|
||||
|
||||
def filter_entries(self, feed_data):
|
||||
"""Filter entries by distance from home coordinates."""
|
||||
events = []
|
||||
_LOGGER.debug("%s entri(es) available in feed %s",
|
||||
len(feed_data.entries), self._url)
|
||||
for entry in feed_data.entries:
|
||||
geometry = None
|
||||
if hasattr(entry, 'where'):
|
||||
geometry = entry.where
|
||||
elif hasattr(entry, 'geo_lat') and hasattr(entry, 'geo_long'):
|
||||
coordinates = (float(entry.geo_long), float(entry.geo_lat))
|
||||
point = namedtuple('Point', ['type', 'coordinates'])
|
||||
geometry = point('Point', coordinates)
|
||||
if geometry:
|
||||
distance = self.calculate_distance_to_geometry(geometry)
|
||||
if distance <= self._radius_in_km:
|
||||
event = {
|
||||
ATTR_CATEGORY: None if not hasattr(
|
||||
entry, 'category') else entry.category,
|
||||
ATTR_TITLE: None if not hasattr(
|
||||
entry, 'title') else entry.title,
|
||||
ATTR_DISTANCE: distance
|
||||
}
|
||||
events.append(event)
|
||||
_LOGGER.debug("%s events found nearby", len(events))
|
||||
return events
|
||||
|
||||
def calculate_distance_to_geometry(self, geometry):
|
||||
"""Calculate the distance between HA and provided geometry."""
|
||||
distance = float("inf")
|
||||
if geometry.type == 'Point':
|
||||
distance = self.calculate_distance_to_point(geometry)
|
||||
elif geometry.type == 'Polygon':
|
||||
distance = self.calculate_distance_to_polygon(
|
||||
geometry.coordinates[0])
|
||||
else:
|
||||
_LOGGER.warning("Not yet implemented: %s", geometry.type)
|
||||
return distance
|
||||
|
||||
def calculate_distance_to_point(self, point):
|
||||
"""Calculate the distance between HA and the provided point."""
|
||||
# Swap coordinates to match: (lat, lon).
|
||||
coordinates = (point.coordinates[1], point.coordinates[0])
|
||||
return self.calculate_distance_to_coords(coordinates)
|
||||
|
||||
def calculate_distance_to_coords(self, coordinates):
|
||||
"""Calculate the distance between HA and the provided coordinates."""
|
||||
# Expecting coordinates in format: (lat, lon).
|
||||
from haversine import haversine
|
||||
distance = haversine(coordinates, self._home_coordinates)
|
||||
_LOGGER.debug("Distance from %s to %s: %s km", self._home_coordinates,
|
||||
coordinates, distance)
|
||||
return distance
|
||||
|
||||
def calculate_distance_to_polygon(self, polygon):
|
||||
"""Calculate the distance between HA and the provided polygon."""
|
||||
distance = float("inf")
|
||||
# Calculate distance from polygon by calculating the distance
|
||||
# to each point of the polygon but not to each edge of the
|
||||
# polygon; should be good enough
|
||||
for polygon_point in polygon:
|
||||
coordinates = (polygon_point[1], polygon_point[0])
|
||||
distance = min(distance,
|
||||
self.calculate_distance_to_coords(coordinates))
|
||||
_LOGGER.debug("Distance from %s to %s: %s km", self._home_coordinates,
|
||||
polygon, distance)
|
||||
return distance
|
||||
Reference in new issue
Block a user