entity.py

Go to the documentation of this file.

"""Support for Volvo On Call."""
 
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
from .const import DOMAIN
from .coordinator import VolvoUpdateCoordinator
 
 
class VolvoEntity(CoordinatorEntity[VolvoUpdateCoordinator]):
    """Base class for all VOC entities."""
 
    def __init__(
        self,
        vin: str,
        component: str,
        attribute: str,
        slug_attr: str,
        coordinator: VolvoUpdateCoordinator,
    ) -> None:
        """Initialize the entity."""
        super().__init__(coordinator)
 
        self.vinvin = vin
        self.componentcomponent = component
        self.attributeattribute = attribute
        self.slug_attrslug_attr = slug_attr
 
    @property
    def instrument(self):
        """Return corresponding instrument."""
        return self.coordinator.volvo_data.instrument(
            self.vinvin, self.componentcomponent, self.attributeattribute, self.slug_attrslug_attr
        )
 
    @property
    def icon(self):
        """Return the icon."""
        return self.instrumentinstrument.icon
 
    @property
    def vehicle(self):
        """Return vehicle."""
        return self.instrumentinstrument.vehicle
 
    @property
    def _entity_name(self):
        return self.instrumentinstrument.name
 
    @property
    def _vehicle_name(self):
        return self.coordinator.volvo_data.vehicle_name(self.vehiclevehicle)
 
    @property
    def name(self):
        """Return full name of the entity."""
        return f"{self._vehicle_name} {self._entity_name}"
 
    @property
    def assumed_state(self):
        """Return true if unable to access real state of entity."""
        return True
 
    @property
    def device_info(self) -> DeviceInfo:
        """Return a inique set of attributes for each vehicle."""
        return DeviceInfo(
            identifiers={(DOMAIN, self.vehiclevehicle.vin)},
            name=self._vehicle_name_vehicle_name,
            model=self.vehiclevehicle.vehicle_type,
            manufacturer="Volvo",
        )
 
    @property
    def extra_state_attributes(self):
        """Return device specific state attributes."""
        return dict(
            self.instrumentinstrument.attributes,
            model=f"{self.vehicle.vehicle_type}/{self.vehicle.model_year}",
        )
 
    @property
    def unique_id(self) -> str:
        """Return a unique ID."""
        slug_override = ""
        if self.instrumentinstrument.slug_override is not None:
            slug_override = f"-{self.instrument.slug_override}"
        return f"{self.vin}-{self.component}-{self.attribute}{slug_override}"