mirror of
https://github.com/home-assistant/core.git
synced 2025-10-08 19:29:38 +00:00
40 lines
1.4 KiB
Python
40 lines
1.4 KiB
Python
"""Sensor entities for Geocaching."""
|
|
|
|
from typing import cast
|
|
|
|
from geocachingapi.models import GeocachingCache
|
|
|
|
from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
|
|
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
|
|
|
from .const import DOMAIN
|
|
from .coordinator import GeocachingDataUpdateCoordinator
|
|
|
|
|
|
# Base class for all platforms
|
|
class GeocachingBaseEntity(CoordinatorEntity[GeocachingDataUpdateCoordinator]):
|
|
"""Base class for Geocaching sensors."""
|
|
|
|
_attr_has_entity_name = True
|
|
|
|
|
|
# Base class for cache entities
|
|
class GeocachingCacheEntity(GeocachingBaseEntity):
|
|
"""Base class for Geocaching cache entities."""
|
|
|
|
def __init__(
|
|
self, coordinator: GeocachingDataUpdateCoordinator, cache: GeocachingCache
|
|
) -> None:
|
|
"""Initialize the Geocaching cache entity."""
|
|
super().__init__(coordinator)
|
|
self.cache = cache
|
|
|
|
# A device can have multiple entities, and for a cache which requires multiple entities we want to group them together.
|
|
# Therefore, we create a device for each cache, which holds all related entities.
|
|
self._attr_device_info = DeviceInfo(
|
|
name=f"Geocache {cache.name}",
|
|
identifiers={(DOMAIN, cast(str, cache.reference_code))},
|
|
entry_type=DeviceEntryType.SERVICE,
|
|
manufacturer=cache.owner.username,
|
|
)
|