Queensland bushfire alert feed platform (#24473)
* initial version of qfes bushfire geolocation platform * removed all occurrences of legally protected names; using new georss library * regenerated codeowners * fixed pylint * added one more valid category * moved library import to top and ran isort
This commit is contained in:
1 parent
9413b5a415
commit
03bb3d9ddc
9 files changed
+439
No files matched your search
@@ -0,0 +1 @@
|
||||
"""The qld_bushfire component."""
|
||||
@@ -0,0 +1,228 @@
|
||||
"""Support for Queensland Bushfire Alert Feeds."""
|
||||
from datetime import timedelta
|
||||
import logging
|
||||
from typing import Optional
|
||||
|
||||
from georss_qld_bushfire_alert_client import QldBushfireAlertFeedManager
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant.components.geo_location import (
|
||||
PLATFORM_SCHEMA, GeolocationEvent)
|
||||
from homeassistant.const import (
|
||||
ATTR_ATTRIBUTION, CONF_LATITUDE, CONF_LONGITUDE, CONF_RADIUS,
|
||||
CONF_SCAN_INTERVAL, EVENT_HOMEASSISTANT_START)
|
||||
from homeassistant.core import callback
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.helpers.dispatcher import (
|
||||
async_dispatcher_connect, dispatcher_send)
|
||||
from homeassistant.helpers.event import track_time_interval
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
ATTR_CATEGORY = 'category'
|
||||
ATTR_EXTERNAL_ID = 'external_id'
|
||||
ATTR_PUBLICATION_DATE = 'publication_date'
|
||||
ATTR_STATUS = 'status'
|
||||
ATTR_UPDATED_DATE = 'updated_date'
|
||||
|
||||
CONF_CATEGORIES = 'categories'
|
||||
|
||||
DEFAULT_RADIUS_IN_KM = 20.0
|
||||
DEFAULT_UNIT_OF_MEASUREMENT = 'km'
|
||||
|
||||
SCAN_INTERVAL = timedelta(minutes=5)
|
||||
|
||||
SIGNAL_DELETE_ENTITY = 'qld_bushfire_delete_{}'
|
||||
SIGNAL_UPDATE_ENTITY = 'qld_bushfire_update_{}'
|
||||
|
||||
SOURCE = 'qld_bushfire'
|
||||
|
||||
VALID_CATEGORIES = [
|
||||
'Emergency Warning',
|
||||
'Watch and Act',
|
||||
'Advice',
|
||||
'Notification',
|
||||
'Information',
|
||||
]
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||
vol.Optional(CONF_LATITUDE): cv.latitude,
|
||||
vol.Optional(CONF_LONGITUDE): cv.longitude,
|
||||
vol.Optional(CONF_RADIUS, default=DEFAULT_RADIUS_IN_KM): vol.Coerce(float),
|
||||
vol.Optional(CONF_CATEGORIES, default=[]):
|
||||
vol.All(cv.ensure_list, [vol.In(VALID_CATEGORIES)]),
|
||||
})
|
||||
|
||||
|
||||
def setup_platform(hass, config, add_entities, discovery_info=None):
|
||||
"""Set up the Queensland Bushfire Alert Feed platform."""
|
||||
scan_interval = config.get(CONF_SCAN_INTERVAL, SCAN_INTERVAL)
|
||||
coordinates = (config.get(CONF_LATITUDE, hass.config.latitude),
|
||||
config.get(CONF_LONGITUDE, hass.config.longitude))
|
||||
radius_in_km = config[CONF_RADIUS]
|
||||
categories = config[CONF_CATEGORIES]
|
||||
# Initialize the entity manager.
|
||||
feed = QldBushfireFeedEntityManager(
|
||||
hass, add_entities, scan_interval, coordinates, radius_in_km,
|
||||
categories)
|
||||
|
||||
def start_feed_manager(event):
|
||||
"""Start feed manager."""
|
||||
feed.startup()
|
||||
|
||||
hass.bus.listen_once(EVENT_HOMEASSISTANT_START, start_feed_manager)
|
||||
|
||||
|
||||
class QldBushfireFeedEntityManager:
|
||||
"""Feed Entity Manager for Qld Bushfire Alert GeoRSS feed."""
|
||||
|
||||
def __init__(self, hass, add_entities, scan_interval, coordinates,
|
||||
radius_in_km, categories):
|
||||
"""Initialize the Feed Entity Manager."""
|
||||
self._hass = hass
|
||||
self._feed_manager = QldBushfireAlertFeedManager(
|
||||
self._generate_entity, self._update_entity, self._remove_entity,
|
||||
coordinates, filter_radius=radius_in_km,
|
||||
filter_categories=categories)
|
||||
self._add_entities = add_entities
|
||||
self._scan_interval = scan_interval
|
||||
|
||||
def startup(self):
|
||||
"""Start up this manager."""
|
||||
self._feed_manager.update()
|
||||
self._init_regular_updates()
|
||||
|
||||
def _init_regular_updates(self):
|
||||
"""Schedule regular updates at the specified interval."""
|
||||
track_time_interval(
|
||||
self._hass, lambda now: self._feed_manager.update(),
|
||||
self._scan_interval)
|
||||
|
||||
def get_entry(self, external_id):
|
||||
"""Get feed entry by external id."""
|
||||
return self._feed_manager.feed_entries.get(external_id)
|
||||
|
||||
def _generate_entity(self, external_id):
|
||||
"""Generate new entity."""
|
||||
new_entity = QldBushfireLocationEvent(self, external_id)
|
||||
# Add new entities to HA.
|
||||
self._add_entities([new_entity], True)
|
||||
|
||||
def _update_entity(self, external_id):
|
||||
"""Update entity."""
|
||||
dispatcher_send(self._hass, SIGNAL_UPDATE_ENTITY.format(external_id))
|
||||
|
||||
def _remove_entity(self, external_id):
|
||||
"""Remove entity."""
|
||||
dispatcher_send(self._hass, SIGNAL_DELETE_ENTITY.format(external_id))
|
||||
|
||||
|
||||
class QldBushfireLocationEvent(GeolocationEvent):
|
||||
"""This represents an external event with Qld Bushfire feed data."""
|
||||
|
||||
def __init__(self, feed_manager, external_id):
|
||||
"""Initialize entity with data from feed entry."""
|
||||
self._feed_manager = feed_manager
|
||||
self._external_id = external_id
|
||||
self._name = None
|
||||
self._distance = None
|
||||
self._latitude = None
|
||||
self._longitude = None
|
||||
self._attribution = None
|
||||
self._category = None
|
||||
self._publication_date = None
|
||||
self._updated_date = None
|
||||
self._status = None
|
||||
self._remove_signal_delete = None
|
||||
self._remove_signal_update = None
|
||||
|
||||
async def async_added_to_hass(self):
|
||||
"""Call when entity is added to hass."""
|
||||
self._remove_signal_delete = async_dispatcher_connect(
|
||||
self.hass, SIGNAL_DELETE_ENTITY.format(self._external_id),
|
||||
self._delete_callback)
|
||||
self._remove_signal_update = async_dispatcher_connect(
|
||||
self.hass, SIGNAL_UPDATE_ENTITY.format(self._external_id),
|
||||
self._update_callback)
|
||||
|
||||
@callback
|
||||
def _delete_callback(self):
|
||||
"""Remove this entity."""
|
||||
self._remove_signal_delete()
|
||||
self._remove_signal_update()
|
||||
self.hass.async_create_task(self.async_remove())
|
||||
|
||||
@callback
|
||||
def _update_callback(self):
|
||||
"""Call update method."""
|
||||
self.async_schedule_update_ha_state(True)
|
||||
|
||||
@property
|
||||
def should_poll(self):
|
||||
"""No polling needed for Qld Bushfire Alert feed location events."""
|
||||
return False
|
||||
|
||||
async def async_update(self):
|
||||
"""Update this entity from the data held in the feed manager."""
|
||||
_LOGGER.debug("Updating %s", self._external_id)
|
||||
feed_entry = self._feed_manager.get_entry(self._external_id)
|
||||
if feed_entry:
|
||||
self._update_from_feed(feed_entry)
|
||||
|
||||
def _update_from_feed(self, feed_entry):
|
||||
"""Update the internal state from the provided feed entry."""
|
||||
self._name = feed_entry.title
|
||||
self._distance = feed_entry.distance_to_home
|
||||
self._latitude = feed_entry.coordinates[0]
|
||||
self._longitude = feed_entry.coordinates[1]
|
||||
self._attribution = feed_entry.attribution
|
||||
self._category = feed_entry.category
|
||||
self._publication_date = feed_entry.published
|
||||
self._updated_date = feed_entry.updated
|
||||
self._status = feed_entry.status
|
||||
|
||||
@property
|
||||
def source(self) -> str:
|
||||
"""Return source value of this external event."""
|
||||
return SOURCE
|
||||
|
||||
@property
|
||||
def name(self) -> Optional[str]:
|
||||
"""Return the name of the entity."""
|
||||
return self._name
|
||||
|
||||
@property
|
||||
def distance(self) -> Optional[float]:
|
||||
"""Return distance value of this external event."""
|
||||
return self._distance
|
||||
|
||||
@property
|
||||
def latitude(self) -> Optional[float]:
|
||||
"""Return latitude value of this external event."""
|
||||
return self._latitude
|
||||
|
||||
@property
|
||||
def longitude(self) -> Optional[float]:
|
||||
"""Return longitude value of this external event."""
|
||||
return self._longitude
|
||||
|
||||
@property
|
||||
def unit_of_measurement(self):
|
||||
"""Return the unit of measurement."""
|
||||
return DEFAULT_UNIT_OF_MEASUREMENT
|
||||
|
||||
@property
|
||||
def device_state_attributes(self):
|
||||
"""Return the device state attributes."""
|
||||
attributes = {}
|
||||
for key, value in (
|
||||
(ATTR_EXTERNAL_ID, self._external_id),
|
||||
(ATTR_CATEGORY, self._category),
|
||||
(ATTR_ATTRIBUTION, self._attribution),
|
||||
(ATTR_PUBLICATION_DATE, self._publication_date),
|
||||
(ATTR_UPDATED_DATE, self._updated_date),
|
||||
(ATTR_STATUS, self._status)
|
||||
):
|
||||
if value or isinstance(value, bool):
|
||||
attributes[key] = value
|
||||
return attributes
|
||||
@@ -0,0 +1,12 @@
|
||||
{
|
||||
"domain": "qld_bushfire",
|
||||
"name": "Queensland Bushfire Alert",
|
||||
"documentation": "https://www.home-assistant.io/components/qld_bushfire",
|
||||
"requirements": [
|
||||
"georss_qld_bushfire_alert_client==0.3"
|
||||
],
|
||||
"dependencies": [],
|
||||
"codeowners": [
|
||||
"@exxamalte"
|
||||
]
|
||||
}
|
||||
Reference in new issue
Block a user