mirror of
https://github.com/home-assistant/core
synced 2024-09-03 08:14:07 +02:00
5987266e56
* Refactor template entity to allow reuse * Fix schema and default name * Add tests * Update requirements * Improve test * Tweak TemplateSensor initializer * Drop attributes and availability from TemplateEntity * Use rest sensor for proof of concept * Revert changes in SNMP sensor * Don't set _attr_should_poll in mixin class * Update requirements
96 lines
2.8 KiB
Python
96 lines
2.8 KiB
Python
"""The base entity for the rest component."""
|
|
|
|
from abc import abstractmethod
|
|
from typing import Any
|
|
|
|
from homeassistant.core import callback
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
|
|
|
|
from .data import RestData
|
|
|
|
|
|
class BaseRestEntity(Entity):
|
|
"""A class for entities using DataUpdateCoordinator or rest data directly."""
|
|
|
|
def __init__(
|
|
self,
|
|
coordinator: DataUpdateCoordinator[Any],
|
|
rest: RestData,
|
|
resource_template,
|
|
force_update,
|
|
) -> None:
|
|
"""Create the entity that may have a coordinator."""
|
|
self.coordinator = coordinator
|
|
self.rest = rest
|
|
self._resource_template = resource_template
|
|
self._force_update = force_update
|
|
|
|
@property
|
|
def force_update(self):
|
|
"""Force update."""
|
|
return self._force_update
|
|
|
|
@property
|
|
def should_poll(self) -> bool:
|
|
"""Poll only if we do not have a coordinator."""
|
|
return not self.coordinator
|
|
|
|
@property
|
|
def available(self):
|
|
"""Return the availability of this sensor."""
|
|
if self.coordinator and not self.coordinator.last_update_success:
|
|
return False
|
|
return self.rest.data is not None
|
|
|
|
async def async_added_to_hass(self) -> None:
|
|
"""When entity is added to hass."""
|
|
await super().async_added_to_hass()
|
|
self._update_from_rest_data()
|
|
if self.coordinator:
|
|
self.async_on_remove(
|
|
self.coordinator.async_add_listener(self._handle_coordinator_update)
|
|
)
|
|
|
|
@callback
|
|
def _handle_coordinator_update(self) -> None:
|
|
"""Handle updated data from the coordinator."""
|
|
self._update_from_rest_data()
|
|
self.async_write_ha_state()
|
|
|
|
async def async_update(self):
|
|
"""Get the latest data from REST API and update the state."""
|
|
if self.coordinator:
|
|
await self.coordinator.async_request_refresh()
|
|
return
|
|
|
|
if self._resource_template is not None:
|
|
self.rest.set_url(self._resource_template.async_render(parse_result=False))
|
|
await self.rest.async_update()
|
|
self._update_from_rest_data()
|
|
|
|
@abstractmethod
|
|
def _update_from_rest_data(self):
|
|
"""Update state from the rest data."""
|
|
|
|
|
|
class RestEntity(BaseRestEntity):
|
|
"""A class for entities using DataUpdateCoordinator or rest data directly."""
|
|
|
|
def __init__(
|
|
self,
|
|
coordinator: DataUpdateCoordinator[Any],
|
|
rest: RestData,
|
|
name,
|
|
resource_template,
|
|
force_update,
|
|
) -> None:
|
|
"""Create the entity that may have a coordinator."""
|
|
self._name = name
|
|
super().__init__(coordinator, rest, resource_template, force_update)
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return self._name
|