58 lines
1.8 KiB
Python
58 lines
1.8 KiB
Python
"""Base classes for Renault entities."""
|
|
from __future__ import annotations
|
|
|
|
from dataclasses import dataclass
|
|
from typing import Optional, cast
|
|
|
|
from homeassistant.const import ATTR_NAME
|
|
from homeassistant.helpers.entity import Entity, EntityDescription
|
|
from homeassistant.helpers.typing import StateType
|
|
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
|
|
|
from .renault_coordinator import T
|
|
from .renault_vehicle import RenaultVehicleProxy
|
|
|
|
|
|
@dataclass
|
|
class RenaultRequiredKeysMixin:
|
|
"""Mixin for required keys."""
|
|
|
|
coordinator: str
|
|
|
|
|
|
@dataclass
|
|
class RenaultEntityDescription(EntityDescription, RenaultRequiredKeysMixin):
|
|
"""Class describing Renault entities."""
|
|
|
|
|
|
class RenaultDataEntity(CoordinatorEntity[Optional[T]], Entity):
|
|
"""Implementation of a Renault entity with a data coordinator."""
|
|
|
|
entity_description: RenaultEntityDescription
|
|
|
|
def __init__(
|
|
self,
|
|
vehicle: RenaultVehicleProxy,
|
|
description: RenaultEntityDescription,
|
|
) -> None:
|
|
"""Initialise entity."""
|
|
super().__init__(vehicle.coordinators[description.coordinator])
|
|
self.vehicle = vehicle
|
|
self.entity_description = description
|
|
self._attr_device_info = self.vehicle.device_info
|
|
self._attr_unique_id = f"{self.vehicle.details.vin}_{description.key}".lower()
|
|
|
|
def _get_data_attr(self, key: str) -> StateType:
|
|
"""Return the attribute value from the coordinator data."""
|
|
if self.coordinator.data is None:
|
|
return None
|
|
return cast(StateType, getattr(self.coordinator.data, key))
|
|
|
|
@property
|
|
def name(self) -> str:
|
|
"""Return the name of the entity.
|
|
|
|
Overridden to include the device name.
|
|
"""
|
|
return f"{self.vehicle.device_info[ATTR_NAME]} {self.entity_description.name}"
|