entity.py

Go to the documentation of this file.

"""A entity class for Tractive integration."""
 
from __future__ import annotations
 
from typing import Any
 
from homeassistant.core import callback
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.dispatcher import async_dispatcher_connect
from homeassistant.helpers.entity import Entity
 
from . import TractiveClient
from .const import DOMAIN, SERVER_UNAVAILABLE
 
 
class TractiveEntity(Entity):
    """Tractive entity class."""
 
    _attr_has_entity_name = True
 
    def __init__(
        self,
        client: TractiveClient,
        trackable: dict[str, Any],
        tracker_details: dict[str, Any],
        dispatcher_signal: str,
    ) -> None:
        """Initialize tracker entity."""
        self._attr_device_info_attr_device_info = DeviceInfo(
            configuration_url="https://my.tractive.com/",
            identifiers={(DOMAIN, tracker_details["_id"])},
            name=trackable["details"]["name"],
            manufacturer="Tractive GmbH",
            sw_version=tracker_details["fw_version"],
            model=tracker_details["model_number"],
        )
        self._user_id_user_id = client.user_id
        self._tracker_id_tracker_id = tracker_details["_id"]
        self._client_client = client
        self._dispatcher_signal_dispatcher_signal = dispatcher_signal
 
    async def async_added_to_hass(self) -> None:
        """Handle entity which will be added."""
        if not self._client_client.subscribed:
            self._client_client.subscribe()
 
        self.async_on_removeasync_on_remove(
            async_dispatcher_connect(
                self.hasshass,
                self._dispatcher_signal_dispatcher_signal,
                self.handle_status_updatehandle_status_update,
            )
        )
 
        self.async_on_removeasync_on_remove(
            async_dispatcher_connect(
                self.hasshass,
                f"{SERVER_UNAVAILABLE}-{self._user_id}",
                self.handle_server_unavailablehandle_server_unavailable,
            )
        )
 
    @callback
    def handle_status_update(self, event: dict[str, Any]) -> None:
        """Handle status update."""
        self._attr_available_attr_available = event[self.entity_description.key] is not None
        self.async_write_ha_stateasync_write_ha_state()
 
    @callback
    def handle_server_unavailable(self) -> None:
        """Handle server unavailable."""
        self._attr_available_attr_available = False
        self.async_write_ha_stateasync_write_ha_state()