geo_location.py

Go to the documentation of this file.

"""Geolocation support for GeoNet NZ Quakes Feeds."""
 
from __future__ import annotations
 
from collections.abc import Callable
import logging
from typing import Any
 
from aio_geojson_geonetnz_quakes.feed_entry import GeonetnzQuakesFeedEntry
 
from homeassistant.components.geo_location import GeolocationEvent
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import ATTR_TIME, UnitOfLength
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers import entity_registry as er
from homeassistant.helpers.dispatcher import async_dispatcher_connect
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.util.unit_conversion import DistanceConverter
from homeassistant.util.unit_system import US_CUSTOMARY_SYSTEM
 
from . import GeonetnzQuakesFeedEntityManager
from .const import DOMAIN, FEED
 
_LOGGER = logging.getLogger(__name__)
 
ATTR_DEPTH = "depth"
ATTR_EXTERNAL_ID = "external_id"
ATTR_LOCALITY = "locality"
ATTR_MAGNITUDE = "magnitude"
ATTR_MMI = "mmi"
ATTR_PUBLICATION_DATE = "publication_date"
ATTR_QUALITY = "quality"
 
# An update of this entity is not making a web request, but uses internal data only.
PARALLEL_UPDATES = 0
 
SOURCE = "geonetnz_quakes"
 
 
async def async_setup_entry(
    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
    """Set up the GeoNet NZ Quakes Feed platform."""
    manager: GeonetnzQuakesFeedEntityManager = hass.data[DOMAIN][FEED][entry.entry_id]
 
    @callback
    def async_add_geolocation(
        feed_manager: GeonetnzQuakesFeedEntityManager,
        integration_id: str,
        external_id: str,
    ) -> None:
        """Add geolocation entity from feed."""
        new_entity = GeonetnzQuakesEvent(feed_manager, integration_id, external_id)
        _LOGGER.debug("Adding geolocation %s", new_entity)
        async_add_entities([new_entity], True)
 
    manager.listeners.append(
        async_dispatcher_connect(
            hass, manager.async_event_new_entity(), async_add_geolocation
        )
    )
    # Do not wait for update here so that the setup can be completed and because an
    # update will fetch data from the feed via HTTP and then process that data.
    hass.async_create_task(manager.async_update())
    _LOGGER.debug("Geolocation setup done")
 
 
class GeonetnzQuakesEvent(GeolocationEvent):
    """Represents an external event with GeoNet NZ Quakes feed data."""
 
    _attr_icon = "mdi:pulse"
    _attr_should_poll = False
    _attr_source = SOURCE
 
    def __init__(
        self,
        feed_manager: GeonetnzQuakesFeedEntityManager,
        integration_id: str,
        external_id: str,
    ) -> None:
        """Initialize entity with data from feed entry."""
        self._feed_manager_feed_manager = feed_manager
        self._external_id_external_id = external_id
        self._attr_unique_id_attr_unique_id = f"{integration_id}_{external_id}"
        self._attr_unit_of_measurement_attr_unit_of_measurement = UnitOfLength.KILOMETERS
        self._depth_depth = None
        self._locality_locality = None
        self._magnitude_magnitude = None
        self._mmi_mmi = None
        self._quality_quality = None
        self._time_time = None
        self._remove_signal_delete_remove_signal_delete: Callable[[], None]
        self._remove_signal_update_remove_signal_update: Callable[[], None]
 
    async def async_added_to_hass(self) -> None:
        """Call when entity is added to hass."""
        if self.hasshass.config.units is US_CUSTOMARY_SYSTEM:
            self._attr_unit_of_measurement_attr_unit_of_measurement = UnitOfLength.MILES
        self._remove_signal_delete_remove_signal_delete = async_dispatcher_connect(
            self.hasshass,
            f"geonetnz_quakes_delete_{self._external_id}",
            self._delete_callback_delete_callback,
        )
        self._remove_signal_update_remove_signal_update = async_dispatcher_connect(
            self.hasshass,
            f"geonetnz_quakes_update_{self._external_id}",
            self._update_callback_update_callback,
        )
 
    async def async_will_remove_from_hass(self) -> None:
        """Call when entity will be removed from hass."""
        self._remove_signal_delete_remove_signal_delete()
        self._remove_signal_update_remove_signal_update()
        # Remove from entity registry.
        entity_registry = er.async_get(self.hasshass)
        if self.entity_identity_id in entity_registry.entities:
            entity_registry.async_remove(self.entity_identity_id)
 
    @callback
    def _delete_callback(self) -> None:
        """Remove this entity."""
        self.hasshass.async_create_task(self.async_removeasync_remove(force_remove=True))
 
    @callback
    def _update_callback(self) -> None:
        """Call update method."""
        self.async_schedule_update_ha_stateasync_schedule_update_ha_state(True)
 
    async def async_update(self) -> None:
        """Update this entity from the data held in the feed manager."""
        _LOGGER.debug("Updating %s", self._external_id_external_id)
        feed_entry = self._feed_manager_feed_manager.get_entry(self._external_id_external_id)
        if feed_entry:
            self._update_from_feed_update_from_feed(feed_entry)
 
    def _update_from_feed(self, feed_entry: GeonetnzQuakesFeedEntry) -> None:
        """Update the internal state from the provided feed entry."""
        self._attr_name_attr_name = feed_entry.title
        # Convert distance if not metric system.
        if self.hasshass.config.units is US_CUSTOMARY_SYSTEM:
            self._attr_distance_attr_distance = DistanceConverter.convert(
                feed_entry.distance_to_home, UnitOfLength.KILOMETERS, UnitOfLength.MILES
            )
        else:
            self._attr_distance_attr_distance = feed_entry.distance_to_home
        self._attr_latitude_attr_latitude = feed_entry.coordinates[0]
        self._attr_longitude_attr_longitude = feed_entry.coordinates[1]
        self._attr_attribution_attr_attribution = feed_entry.attribution
        self._depth_depth = feed_entry.depth
        self._locality_locality = feed_entry.locality
        self._magnitude_magnitude = feed_entry.magnitude
        self._mmi_mmi = feed_entry.mmi
        self._quality_quality = feed_entry.quality
        self._time_time = feed_entry.time
 
    @property
    def extra_state_attributes(self) -> dict[str, Any]:
        """Return the device state attributes."""
        return {
            key: value
            for key, value in (
                (ATTR_EXTERNAL_ID, self._external_id_external_id),
                (ATTR_DEPTH, self._depth_depth),
                (ATTR_LOCALITY, self._locality_locality),
                (ATTR_MAGNITUDE, self._magnitude_magnitude),
                (ATTR_MMI, self._mmi_mmi),
                (ATTR_QUALITY, self._quality_quality),
                (ATTR_TIME, self._time_time),
            )
            if value or isinstance(value, bool)
        }