entity.py

Go to the documentation of this file.

"""Support for the Nissan Leaf Carwings/Nissan Connect API."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
from homeassistant.core import callback
from homeassistant.helpers.dispatcher import async_dispatcher_connect
from homeassistant.helpers.entity import Entity
 
from . import LeafDataStore
from .const import SIGNAL_UPDATE_LEAF
 
_LOGGER = logging.getLogger(__name__)
 
 
class LeafEntity(Entity):
    """Base class for Nissan Leaf entity."""
 
    def __init__(self, car: LeafDataStore) -> None:
        """Store LeafDataStore upon init."""
        self.carcar = car
 
    def log_registration(self) -> None:
        """Log registration."""
        _LOGGER.debug(
            "Registered %s integration for VIN %s",
            self.__class__.__name__,
            self.carcar.leaf.vin,
        )
 
    @property
    def extra_state_attributes(self) -> dict[str, Any]:
        """Return default attributes for Nissan leaf entities."""
        return {
            "next_update": self.carcar.next_update,
            "last_attempt": self.carcar.last_check,
            "updated_on": self.carcar.last_battery_response,
            "update_in_progress": self.carcar.request_in_progress,
            "vin": self.carcar.leaf.vin,
        }
 
    async def async_added_to_hass(self) -> None:
        """Register callbacks."""
        self.log_registrationlog_registration()
        self.async_on_removeasync_on_remove(
            async_dispatcher_connect(
                self.carcar.hass, SIGNAL_UPDATE_LEAF, self._update_callback_update_callback
            )
        )
 
    @callback
    def _update_callback(self) -> None:
        """Update the state."""
        self.async_schedule_update_ha_stateasync_schedule_update_ha_state(True)