mirror of
https://github.com/home-assistant/core
synced 2024-10-07 10:13:38 +02:00
a12cf7211d
* Upgrade pydocstyle to 5.0.1 http://www.pydocstyle.org/en/5.0.1/release_notes.html * Pydocstyle and other docstring fixes
62 lines
1.8 KiB
Python
62 lines
1.8 KiB
Python
"""StarLine base entity."""
|
|
from typing import Callable, Optional
|
|
|
|
from homeassistant.helpers.entity import Entity
|
|
|
|
from .account import StarlineAccount, StarlineDevice
|
|
|
|
|
|
class StarlineEntity(Entity):
|
|
"""StarLine base entity class."""
|
|
|
|
def __init__(
|
|
self, account: StarlineAccount, device: StarlineDevice, key: str, name: str
|
|
):
|
|
"""Initialize StarLine entity."""
|
|
self._account = account
|
|
self._device = device
|
|
self._key = key
|
|
self._name = name
|
|
self._unsubscribe_api: Optional[Callable] = None
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""No polling needed."""
|
|
return False
|
|
|
|
@property
|
|
def available(self):
|
|
"""Return True if entity is available."""
|
|
return self._account.api.available
|
|
|
|
@property
|
|
def unique_id(self):
|
|
"""Return the unique ID of the entity."""
|
|
return f"starline-{self._key}-{self._device.device_id}"
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the entity."""
|
|
return f"{self._device.name} {self._name}"
|
|
|
|
@property
|
|
def device_info(self):
|
|
"""Return the device info."""
|
|
return self._account.device_info(self._device)
|
|
|
|
def update(self):
|
|
"""Read new state data."""
|
|
self.schedule_update_ha_state()
|
|
|
|
async def async_added_to_hass(self):
|
|
"""Call when entity about to be added to Home Assistant."""
|
|
await super().async_added_to_hass()
|
|
self._unsubscribe_api = self._account.api.add_update_listener(self.update)
|
|
|
|
async def async_will_remove_from_hass(self):
|
|
"""Call when entity is being removed from Home Assistant."""
|
|
await super().async_will_remove_from_hass()
|
|
if self._unsubscribe_api is not None:
|
|
self._unsubscribe_api()
|
|
self._unsubscribe_api = None
|