Use instance attributes in ign_sismologia (#74399)
This commit is contained in:
epenet
GitHub
parent
0b1f29b2b9
commit
7cac1ae6a3
1 changed files with 43 additions and 69 deletions
|
|
@ -1,15 +1,19 @@
|
|||
"""Support for IGN Sismologia (Earthquakes) Feeds."""
|
||||
from __future__ import annotations
|
||||
|
||||
from collections.abc import Callable
|
||||
from datetime import timedelta
|
||||
import logging
|
||||
from typing import Any
|
||||
|
||||
from georss_ign_sismologia_client import IgnSismologiaFeedManager
|
||||
from georss_ign_sismologia_client import (
|
||||
IgnSismologiaFeedEntry,
|
||||
IgnSismologiaFeedManager,
|
||||
)
|
||||
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,
|
||||
|
|
@ -17,7 +21,7 @@ from homeassistant.const import (
|
|||
EVENT_HOMEASSISTANT_START,
|
||||
LENGTH_KILOMETERS,
|
||||
)
|
||||
from homeassistant.core import HomeAssistant, callback
|
||||
from homeassistant.core import Event, HomeAssistant, callback
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.helpers.dispatcher import async_dispatcher_connect, dispatcher_send
|
||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||
|
|
@ -61,19 +65,19 @@ def setup_platform(
|
|||
discovery_info: DiscoveryInfoType | None = None,
|
||||
) -> None:
|
||||
"""Set up the IGN Sismologia Feed platform."""
|
||||
scan_interval = config.get(CONF_SCAN_INTERVAL, SCAN_INTERVAL)
|
||||
coordinates = (
|
||||
scan_interval: timedelta = config.get(CONF_SCAN_INTERVAL, SCAN_INTERVAL)
|
||||
coordinates: tuple[float, float] = (
|
||||
config.get(CONF_LATITUDE, hass.config.latitude),
|
||||
config.get(CONF_LONGITUDE, hass.config.longitude),
|
||||
)
|
||||
radius_in_km = config[CONF_RADIUS]
|
||||
minimum_magnitude = config[CONF_MINIMUM_MAGNITUDE]
|
||||
radius_in_km: float = config[CONF_RADIUS]
|
||||
minimum_magnitude: float = config[CONF_MINIMUM_MAGNITUDE]
|
||||
# Initialize the entity manager.
|
||||
feed = IgnSismologiaFeedEntityManager(
|
||||
hass, add_entities, scan_interval, coordinates, radius_in_km, minimum_magnitude
|
||||
)
|
||||
|
||||
def start_feed_manager(event):
|
||||
def start_feed_manager(event: Event) -> None:
|
||||
"""Start feed manager."""
|
||||
feed.startup()
|
||||
|
||||
|
|
@ -85,13 +89,13 @@ class IgnSismologiaFeedEntityManager:
|
|||
|
||||
def __init__(
|
||||
self,
|
||||
hass,
|
||||
add_entities,
|
||||
scan_interval,
|
||||
coordinates,
|
||||
radius_in_km,
|
||||
minimum_magnitude,
|
||||
):
|
||||
hass: HomeAssistant,
|
||||
add_entities: AddEntitiesCallback,
|
||||
scan_interval: timedelta,
|
||||
coordinates: tuple[float, float],
|
||||
radius_in_km: float,
|
||||
minimum_magnitude: float,
|
||||
) -> None:
|
||||
"""Initialize the Feed Entity Manager."""
|
||||
|
||||
self._hass = hass
|
||||
|
|
@ -106,32 +110,32 @@ class IgnSismologiaFeedEntityManager:
|
|||
self._add_entities = add_entities
|
||||
self._scan_interval = scan_interval
|
||||
|
||||
def startup(self):
|
||||
def startup(self) -> None:
|
||||
"""Start up this manager."""
|
||||
self._feed_manager.update()
|
||||
self._init_regular_updates()
|
||||
|
||||
def _init_regular_updates(self):
|
||||
def _init_regular_updates(self) -> None:
|
||||
"""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):
|
||||
def get_entry(self, external_id: str) -> IgnSismologiaFeedEntry | None:
|
||||
"""Get feed entry by 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."""
|
||||
new_entity = IgnSismologiaLocationEvent(self, external_id)
|
||||
# Add new entities to HA.
|
||||
self._add_entities([new_entity], True)
|
||||
|
||||
def _update_entity(self, external_id):
|
||||
def _update_entity(self, external_id: str) -> None:
|
||||
"""Update entity."""
|
||||
dispatcher_send(self._hass, f"ign_sismologia_update_{external_id}")
|
||||
|
||||
def _remove_entity(self, external_id):
|
||||
def _remove_entity(self, external_id: str) -> None:
|
||||
"""Remove entity."""
|
||||
dispatcher_send(self._hass, f"ign_sismologia_delete_{external_id}")
|
||||
|
||||
|
|
@ -139,25 +143,26 @@ class IgnSismologiaFeedEntityManager:
|
|||
class IgnSismologiaLocationEvent(GeolocationEvent):
|
||||
"""This represents an external event with IGN Sismologia feed data."""
|
||||
|
||||
_attr_icon = "mdi:pulse"
|
||||
_attr_should_poll = False
|
||||
_attr_source = SOURCE
|
||||
_attr_unit_of_measurement = LENGTH_KILOMETERS
|
||||
|
||||
def __init__(self, feed_manager, external_id):
|
||||
def __init__(
|
||||
self, feed_manager: IgnSismologiaFeedEntityManager, external_id: str
|
||||
) -> None:
|
||||
"""Initialize entity with data from feed entry."""
|
||||
self._feed_manager = feed_manager
|
||||
self._external_id = external_id
|
||||
self._title = None
|
||||
self._distance = None
|
||||
self._latitude = None
|
||||
self._longitude = None
|
||||
self._attribution = None
|
||||
self._region = None
|
||||
self._magnitude = None
|
||||
self._publication_date = None
|
||||
self._image_url = None
|
||||
self._remove_signal_delete = None
|
||||
self._remove_signal_update = None
|
||||
self._remove_signal_delete: Callable[[], 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."""
|
||||
self._remove_signal_delete = async_dispatcher_connect(
|
||||
self.hass,
|
||||
|
|
@ -171,51 +176,36 @@ class IgnSismologiaLocationEvent(GeolocationEvent):
|
|||
)
|
||||
|
||||
@callback
|
||||
def _delete_callback(self):
|
||||
def _delete_callback(self) -> None:
|
||||
"""Remove this entity."""
|
||||
self._remove_signal_delete()
|
||||
self._remove_signal_update()
|
||||
self.hass.async_create_task(self.async_remove(force_remove=True))
|
||||
|
||||
@callback
|
||||
def _update_callback(self):
|
||||
def _update_callback(self) -> None:
|
||||
"""Call update method."""
|
||||
self.async_schedule_update_ha_state(True)
|
||||
|
||||
@property
|
||||
def should_poll(self):
|
||||
"""No polling needed for IGN Sismologia feed location events."""
|
||||
return False
|
||||
|
||||
async def async_update(self):
|
||||
async def async_update(self) -> None:
|
||||
"""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):
|
||||
def _update_from_feed(self, feed_entry: IgnSismologiaFeedEntry) -> None:
|
||||
"""Update the internal state from the provided feed entry."""
|
||||
self._title = 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._attr_distance = feed_entry.distance_to_home
|
||||
self._attr_latitude = feed_entry.coordinates[0]
|
||||
self._attr_longitude = feed_entry.coordinates[1]
|
||||
self._attr_attribution = feed_entry.attribution
|
||||
self._region = feed_entry.region
|
||||
self._magnitude = feed_entry.magnitude
|
||||
self._publication_date = feed_entry.published
|
||||
self._image_url = feed_entry.image_url
|
||||
|
||||
@property
|
||||
def icon(self):
|
||||
"""Return the icon to use in the frontend."""
|
||||
return "mdi:pulse"
|
||||
|
||||
@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."""
|
||||
|
|
@ -228,22 +218,7 @@ class IgnSismologiaLocationEvent(GeolocationEvent):
|
|||
return self._title
|
||||
|
||||
@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 extra_state_attributes(self):
|
||||
def extra_state_attributes(self) -> dict[str, Any]:
|
||||
"""Return the device state attributes."""
|
||||
attributes = {}
|
||||
for key, value in (
|
||||
|
|
@ -251,7 +226,6 @@ class IgnSismologiaLocationEvent(GeolocationEvent):
|
|||
(ATTR_TITLE, self._title),
|
||||
(ATTR_REGION, self._region),
|
||||
(ATTR_MAGNITUDE, self._magnitude),
|
||||
(ATTR_ATTRIBUTION, self._attribution),
|
||||
(ATTR_PUBLICATION_DATE, self._publication_date),
|
||||
(ATTR_IMAGE_URL, self._image_url),
|
||||
):
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue