Update toon to use CoordinatorEntity (#39441)

This commit is contained in:
springstan 2020-08-30 18:26:37 +02:00 committed by GitHub
parent 225743a620
commit cceaa088cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -2,7 +2,7 @@
import logging import logging
from typing import Any, Dict, Optional from typing import Any, Dict, Optional
from homeassistant.helpers.entity import Entity from homeassistant.helpers.update_coordinator import CoordinatorEntity
from .const import DOMAIN from .const import DOMAIN
from .coordinator import ToonDataUpdateCoordinator from .coordinator import ToonDataUpdateCoordinator
@ -10,7 +10,7 @@ from .coordinator import ToonDataUpdateCoordinator
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
class ToonEntity(Entity): class ToonEntity(CoordinatorEntity):
"""Defines a base Toon entity.""" """Defines a base Toon entity."""
def __init__( def __init__(
@ -22,11 +22,11 @@ class ToonEntity(Entity):
enabled_default: bool = True, enabled_default: bool = True,
) -> None: ) -> None:
"""Initialize the Toon entity.""" """Initialize the Toon entity."""
super().__init__(coordinator)
self._enabled_default = enabled_default self._enabled_default = enabled_default
self._icon = icon self._icon = icon
self._name = name self._name = name
self._state = None self._state = None
self.coordinator = coordinator
@property @property
def name(self) -> str: def name(self) -> str:
@ -38,31 +38,11 @@ class ToonEntity(Entity):
"""Return the mdi icon of the entity.""" """Return the mdi icon of the entity."""
return self._icon return self._icon
@property
def available(self) -> bool:
"""Return True if entity is available."""
return self.coordinator.last_update_success
@property @property
def entity_registry_enabled_default(self) -> bool: def entity_registry_enabled_default(self) -> bool:
"""Return if the entity should be enabled when first added to the entity registry.""" """Return if the entity should be enabled when first added to the entity registry."""
return self._enabled_default return self._enabled_default
@property
def should_poll(self) -> bool:
"""Return the polling requirement of the entity."""
return False
async def async_added_to_hass(self) -> None:
"""Connect to dispatcher listening for entity data notifications."""
self.async_on_remove(
self.coordinator.async_add_listener(self.async_write_ha_state)
)
async def async_update(self) -> None:
"""Update Toon entity."""
await self.coordinator.async_request_refresh()
class ToonDisplayDeviceEntity(ToonEntity): class ToonDisplayDeviceEntity(ToonEntity):
"""Defines a Toon display device entity.""" """Defines a Toon display device entity."""