mirror of
https://github.com/home-assistant/core.git
synced 2025-07-16 09:47:13 +00:00
Use instance attributes in qld_bushfire (#74402)
This commit is contained in:
parent
bb974ebf7e
commit
e529ef7b0e
@ -1,15 +1,19 @@
|
|||||||
"""Support for Queensland Bushfire Alert Feeds."""
|
"""Support for Queensland Bushfire Alert Feeds."""
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from collections.abc import Callable
|
||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
import logging
|
import logging
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
from georss_qld_bushfire_alert_client import QldBushfireAlertFeedManager
|
from georss_qld_bushfire_alert_client import (
|
||||||
|
QldBushfireAlertFeedEntry,
|
||||||
|
QldBushfireAlertFeedManager,
|
||||||
|
)
|
||||||
import voluptuous as vol
|
import voluptuous as vol
|
||||||
|
|
||||||
from homeassistant.components.geo_location import PLATFORM_SCHEMA, GeolocationEvent
|
from homeassistant.components.geo_location import PLATFORM_SCHEMA, GeolocationEvent
|
||||||
from homeassistant.const import (
|
from homeassistant.const import (
|
||||||
ATTR_ATTRIBUTION,
|
|
||||||
CONF_LATITUDE,
|
CONF_LATITUDE,
|
||||||
CONF_LONGITUDE,
|
CONF_LONGITUDE,
|
||||||
CONF_RADIUS,
|
CONF_RADIUS,
|
||||||
@ -17,7 +21,7 @@ from homeassistant.const import (
|
|||||||
EVENT_HOMEASSISTANT_START,
|
EVENT_HOMEASSISTANT_START,
|
||||||
LENGTH_KILOMETERS,
|
LENGTH_KILOMETERS,
|
||||||
)
|
)
|
||||||
from homeassistant.core import HomeAssistant, callback
|
from homeassistant.core import Event, HomeAssistant, callback
|
||||||
import homeassistant.helpers.config_validation as cv
|
import homeassistant.helpers.config_validation as cv
|
||||||
from homeassistant.helpers.dispatcher import async_dispatcher_connect, dispatcher_send
|
from homeassistant.helpers.dispatcher import async_dispatcher_connect, dispatcher_send
|
||||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||||
@ -70,19 +74,19 @@ def setup_platform(
|
|||||||
discovery_info: DiscoveryInfoType | None = None,
|
discovery_info: DiscoveryInfoType | None = None,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Set up the Queensland Bushfire Alert Feed platform."""
|
"""Set up the Queensland Bushfire Alert Feed platform."""
|
||||||
scan_interval = config.get(CONF_SCAN_INTERVAL, SCAN_INTERVAL)
|
scan_interval: timedelta = config.get(CONF_SCAN_INTERVAL, SCAN_INTERVAL)
|
||||||
coordinates = (
|
coordinates: tuple[float, float] = (
|
||||||
config.get(CONF_LATITUDE, hass.config.latitude),
|
config.get(CONF_LATITUDE, hass.config.latitude),
|
||||||
config.get(CONF_LONGITUDE, hass.config.longitude),
|
config.get(CONF_LONGITUDE, hass.config.longitude),
|
||||||
)
|
)
|
||||||
radius_in_km = config[CONF_RADIUS]
|
radius_in_km: float = config[CONF_RADIUS]
|
||||||
categories = config[CONF_CATEGORIES]
|
categories: list[str] = config[CONF_CATEGORIES]
|
||||||
# Initialize the entity manager.
|
# Initialize the entity manager.
|
||||||
feed = QldBushfireFeedEntityManager(
|
feed = QldBushfireFeedEntityManager(
|
||||||
hass, add_entities, scan_interval, coordinates, radius_in_km, categories
|
hass, add_entities, scan_interval, coordinates, radius_in_km, categories
|
||||||
)
|
)
|
||||||
|
|
||||||
def start_feed_manager(event):
|
def start_feed_manager(event: Event) -> None:
|
||||||
"""Start feed manager."""
|
"""Start feed manager."""
|
||||||
feed.startup()
|
feed.startup()
|
||||||
|
|
||||||
@ -93,8 +97,14 @@ class QldBushfireFeedEntityManager:
|
|||||||
"""Feed Entity Manager for Qld Bushfire Alert GeoRSS feed."""
|
"""Feed Entity Manager for Qld Bushfire Alert GeoRSS feed."""
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self, hass, add_entities, scan_interval, coordinates, radius_in_km, categories
|
self,
|
||||||
):
|
hass: HomeAssistant,
|
||||||
|
add_entities: AddEntitiesCallback,
|
||||||
|
scan_interval: timedelta,
|
||||||
|
coordinates: tuple[float, float],
|
||||||
|
radius_in_km: float,
|
||||||
|
categories: list[str],
|
||||||
|
) -> None:
|
||||||
"""Initialize the Feed Entity Manager."""
|
"""Initialize the Feed Entity Manager."""
|
||||||
self._hass = hass
|
self._hass = hass
|
||||||
self._feed_manager = QldBushfireAlertFeedManager(
|
self._feed_manager = QldBushfireAlertFeedManager(
|
||||||
@ -108,32 +118,32 @@ class QldBushfireFeedEntityManager:
|
|||||||
self._add_entities = add_entities
|
self._add_entities = add_entities
|
||||||
self._scan_interval = scan_interval
|
self._scan_interval = scan_interval
|
||||||
|
|
||||||
def startup(self):
|
def startup(self) -> None:
|
||||||
"""Start up this manager."""
|
"""Start up this manager."""
|
||||||
self._feed_manager.update()
|
self._feed_manager.update()
|
||||||
self._init_regular_updates()
|
self._init_regular_updates()
|
||||||
|
|
||||||
def _init_regular_updates(self):
|
def _init_regular_updates(self) -> None:
|
||||||
"""Schedule regular updates at the specified interval."""
|
"""Schedule regular updates at the specified interval."""
|
||||||
track_time_interval(
|
track_time_interval(
|
||||||
self._hass, lambda now: self._feed_manager.update(), self._scan_interval
|
self._hass, lambda now: self._feed_manager.update(), self._scan_interval
|
||||||
)
|
)
|
||||||
|
|
||||||
def get_entry(self, external_id):
|
def get_entry(self, external_id: str) -> QldBushfireAlertFeedEntry | None:
|
||||||
"""Get feed entry by external id."""
|
"""Get feed entry by external id."""
|
||||||
return self._feed_manager.feed_entries.get(external_id)
|
return self._feed_manager.feed_entries.get(external_id)
|
||||||
|
|
||||||
def _generate_entity(self, external_id):
|
def _generate_entity(self, external_id: str) -> None:
|
||||||
"""Generate new entity."""
|
"""Generate new entity."""
|
||||||
new_entity = QldBushfireLocationEvent(self, external_id)
|
new_entity = QldBushfireLocationEvent(self, external_id)
|
||||||
# Add new entities to HA.
|
# Add new entities to HA.
|
||||||
self._add_entities([new_entity], True)
|
self._add_entities([new_entity], True)
|
||||||
|
|
||||||
def _update_entity(self, external_id):
|
def _update_entity(self, external_id: str) -> None:
|
||||||
"""Update entity."""
|
"""Update entity."""
|
||||||
dispatcher_send(self._hass, SIGNAL_UPDATE_ENTITY.format(external_id))
|
dispatcher_send(self._hass, SIGNAL_UPDATE_ENTITY.format(external_id))
|
||||||
|
|
||||||
def _remove_entity(self, external_id):
|
def _remove_entity(self, external_id: str) -> None:
|
||||||
"""Remove entity."""
|
"""Remove entity."""
|
||||||
dispatcher_send(self._hass, SIGNAL_DELETE_ENTITY.format(external_id))
|
dispatcher_send(self._hass, SIGNAL_DELETE_ENTITY.format(external_id))
|
||||||
|
|
||||||
@ -141,23 +151,25 @@ class QldBushfireFeedEntityManager:
|
|||||||
class QldBushfireLocationEvent(GeolocationEvent):
|
class QldBushfireLocationEvent(GeolocationEvent):
|
||||||
"""This represents an external event with Qld Bushfire feed data."""
|
"""This represents an external event with Qld Bushfire feed data."""
|
||||||
|
|
||||||
def __init__(self, feed_manager, external_id):
|
_attr_icon = "mdi:fire"
|
||||||
|
_attr_should_poll = False
|
||||||
|
_attr_source = SOURCE
|
||||||
|
_attr_unit_of_measurement = LENGTH_KILOMETERS
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self, feed_manager: QldBushfireFeedEntityManager, external_id: str
|
||||||
|
) -> None:
|
||||||
"""Initialize entity with data from feed entry."""
|
"""Initialize entity with data from feed entry."""
|
||||||
self._feed_manager = feed_manager
|
self._feed_manager = feed_manager
|
||||||
self._external_id = external_id
|
self._external_id = external_id
|
||||||
self._name = None
|
|
||||||
self._distance = None
|
|
||||||
self._latitude = None
|
|
||||||
self._longitude = None
|
|
||||||
self._attribution = None
|
|
||||||
self._category = None
|
self._category = None
|
||||||
self._publication_date = None
|
self._publication_date = None
|
||||||
self._updated_date = None
|
self._updated_date = None
|
||||||
self._status = None
|
self._status = None
|
||||||
self._remove_signal_delete = None
|
self._remove_signal_delete: Callable[[], None]
|
||||||
self._remove_signal_update = None
|
self._remove_signal_update: Callable[[], None]
|
||||||
|
|
||||||
async def async_added_to_hass(self):
|
async def async_added_to_hass(self) -> None:
|
||||||
"""Call when entity is added to hass."""
|
"""Call when entity is added to hass."""
|
||||||
self._remove_signal_delete = async_dispatcher_connect(
|
self._remove_signal_delete = async_dispatcher_connect(
|
||||||
self.hass,
|
self.hass,
|
||||||
@ -171,84 +183,43 @@ class QldBushfireLocationEvent(GeolocationEvent):
|
|||||||
)
|
)
|
||||||
|
|
||||||
@callback
|
@callback
|
||||||
def _delete_callback(self):
|
def _delete_callback(self) -> None:
|
||||||
"""Remove this entity."""
|
"""Remove this entity."""
|
||||||
self._remove_signal_delete()
|
self._remove_signal_delete()
|
||||||
self._remove_signal_update()
|
self._remove_signal_update()
|
||||||
self.hass.async_create_task(self.async_remove(force_remove=True))
|
self.hass.async_create_task(self.async_remove(force_remove=True))
|
||||||
|
|
||||||
@callback
|
@callback
|
||||||
def _update_callback(self):
|
def _update_callback(self) -> None:
|
||||||
"""Call update method."""
|
"""Call update method."""
|
||||||
self.async_schedule_update_ha_state(True)
|
self.async_schedule_update_ha_state(True)
|
||||||
|
|
||||||
@property
|
async def async_update(self) -> None:
|
||||||
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."""
|
"""Update this entity from the data held in the feed manager."""
|
||||||
_LOGGER.debug("Updating %s", self._external_id)
|
_LOGGER.debug("Updating %s", self._external_id)
|
||||||
feed_entry = self._feed_manager.get_entry(self._external_id)
|
feed_entry = self._feed_manager.get_entry(self._external_id)
|
||||||
if feed_entry:
|
if feed_entry:
|
||||||
self._update_from_feed(feed_entry)
|
self._update_from_feed(feed_entry)
|
||||||
|
|
||||||
def _update_from_feed(self, feed_entry):
|
def _update_from_feed(self, feed_entry: QldBushfireAlertFeedEntry) -> None:
|
||||||
"""Update the internal state from the provided feed entry."""
|
"""Update the internal state from the provided feed entry."""
|
||||||
self._name = feed_entry.title
|
self._attr_name = feed_entry.title
|
||||||
self._distance = feed_entry.distance_to_home
|
self._attr_distance = feed_entry.distance_to_home
|
||||||
self._latitude = feed_entry.coordinates[0]
|
self._attr_latitude = feed_entry.coordinates[0]
|
||||||
self._longitude = feed_entry.coordinates[1]
|
self._attr_longitude = feed_entry.coordinates[1]
|
||||||
self._attribution = feed_entry.attribution
|
self._attr_attribution = feed_entry.attribution
|
||||||
self._category = feed_entry.category
|
self._category = feed_entry.category
|
||||||
self._publication_date = feed_entry.published
|
self._publication_date = feed_entry.published
|
||||||
self._updated_date = feed_entry.updated
|
self._updated_date = feed_entry.updated
|
||||||
self._status = feed_entry.status
|
self._status = feed_entry.status
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def icon(self):
|
def extra_state_attributes(self) -> dict[str, Any]:
|
||||||
"""Return the icon to use in the frontend."""
|
|
||||||
return "mdi:fire"
|
|
||||||
|
|
||||||
@property
|
|
||||||
def source(self) -> str:
|
|
||||||
"""Return source value of this external event."""
|
|
||||||
return SOURCE
|
|
||||||
|
|
||||||
@property
|
|
||||||
def name(self) -> str | None:
|
|
||||||
"""Return the name of the entity."""
|
|
||||||
return self._name
|
|
||||||
|
|
||||||
@property
|
|
||||||
def distance(self) -> float | None:
|
|
||||||
"""Return distance value of this external event."""
|
|
||||||
return self._distance
|
|
||||||
|
|
||||||
@property
|
|
||||||
def latitude(self) -> float | None:
|
|
||||||
"""Return latitude value of this external event."""
|
|
||||||
return self._latitude
|
|
||||||
|
|
||||||
@property
|
|
||||||
def longitude(self) -> float | None:
|
|
||||||
"""Return longitude value of this external event."""
|
|
||||||
return self._longitude
|
|
||||||
|
|
||||||
@property
|
|
||||||
def unit_of_measurement(self):
|
|
||||||
"""Return the unit of measurement."""
|
|
||||||
return LENGTH_KILOMETERS
|
|
||||||
|
|
||||||
@property
|
|
||||||
def extra_state_attributes(self):
|
|
||||||
"""Return the device state attributes."""
|
"""Return the device state attributes."""
|
||||||
attributes = {}
|
attributes = {}
|
||||||
for key, value in (
|
for key, value in (
|
||||||
(ATTR_EXTERNAL_ID, self._external_id),
|
(ATTR_EXTERNAL_ID, self._external_id),
|
||||||
(ATTR_CATEGORY, self._category),
|
(ATTR_CATEGORY, self._category),
|
||||||
(ATTR_ATTRIBUTION, self._attribution),
|
|
||||||
(ATTR_PUBLICATION_DATE, self._publication_date),
|
(ATTR_PUBLICATION_DATE, self._publication_date),
|
||||||
(ATTR_UPDATED_DATE, self._updated_date),
|
(ATTR_UPDATED_DATE, self._updated_date),
|
||||||
(ATTR_STATUS, self._status),
|
(ATTR_STATUS, self._status),
|
||||||
|
Loading…
x
Reference in New Issue
Block a user