140 lines
3.8 KiB
Python
140 lines
3.8 KiB
Python
"""
|
|
homeassistant.helpers.entity
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Provides ABC for entities in HA.
|
|
"""
|
|
|
|
from homeassistant import NoEntitySpecifiedError
|
|
|
|
from homeassistant.const import (
|
|
ATTR_FRIENDLY_NAME, ATTR_UNIT_OF_MEASUREMENT, STATE_ON, STATE_OFF,
|
|
DEVICE_DEFAULT_NAME, TEMP_CELCIUS, TEMP_FAHRENHEIT)
|
|
|
|
|
|
class Entity(object):
|
|
""" ABC for Home Assistant entities. """
|
|
# pylint: disable=no-self-use
|
|
|
|
hass = None
|
|
entity_id = None
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""
|
|
Return True if entity has to be polled for state.
|
|
False if entity pushes its state to HA.
|
|
"""
|
|
return True
|
|
|
|
@property
|
|
def unique_id(self):
|
|
""" Returns a unique id. """
|
|
return "{}.{}".format(self.__class__, id(self))
|
|
|
|
@property
|
|
def name(self):
|
|
""" Returns the name of the entity. """
|
|
return self.get_name()
|
|
|
|
@property
|
|
def state(self):
|
|
""" Returns the state of the entity. """
|
|
return self.get_state()
|
|
|
|
@property
|
|
def state_attributes(self):
|
|
""" Returns the state attributes. """
|
|
return {}
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
""" Unit of measurement of this entity, if any. """
|
|
return None
|
|
|
|
# DEPRECATION NOTICE:
|
|
# Device is moving from getters to properties.
|
|
# For now the new properties will call the old functions
|
|
# This will be removed in the future.
|
|
|
|
def get_name(self):
|
|
""" Returns the name of the entity if any. """
|
|
return DEVICE_DEFAULT_NAME
|
|
|
|
def get_state(self):
|
|
""" Returns state of the entity. """
|
|
return "Unknown"
|
|
|
|
def get_state_attributes(self):
|
|
""" Returns optional state attributes. """
|
|
return None
|
|
|
|
def update(self):
|
|
""" Retrieve latest state. """
|
|
pass
|
|
|
|
def update_ha_state(self, force_refresh=False):
|
|
"""
|
|
Updates Home Assistant with current state of entity.
|
|
If force_refresh == True will update entity before setting state.
|
|
"""
|
|
if self.hass is None:
|
|
raise RuntimeError("Attribute hass is None for {}".format(self))
|
|
|
|
if self.entity_id is None:
|
|
raise NoEntitySpecifiedError(
|
|
"No entity id specified for entity {}".format(self.name))
|
|
|
|
if force_refresh:
|
|
self.update()
|
|
|
|
state = str(self.state)
|
|
attr = self.state_attributes or {}
|
|
|
|
if ATTR_FRIENDLY_NAME not in attr and self.name:
|
|
attr[ATTR_FRIENDLY_NAME] = self.name
|
|
|
|
if ATTR_UNIT_OF_MEASUREMENT not in attr and self.unit_of_measurement:
|
|
attr[ATTR_UNIT_OF_MEASUREMENT] = self.unit_of_measurement
|
|
|
|
# Convert temperature if we detect one
|
|
if attr.get(ATTR_UNIT_OF_MEASUREMENT) in (TEMP_CELCIUS,
|
|
TEMP_FAHRENHEIT):
|
|
|
|
state, attr[ATTR_UNIT_OF_MEASUREMENT] = \
|
|
self.hass.config.temperature(
|
|
state, attr[ATTR_UNIT_OF_MEASUREMENT])
|
|
state = str(state)
|
|
|
|
return self.hass.states.set(self.entity_id, state, attr)
|
|
|
|
def __eq__(self, other):
|
|
return (isinstance(other, Entity) and
|
|
other.unique_id == self.unique_id)
|
|
|
|
def __repr__(self):
|
|
return "<Entity {}: {}>".format(self.name, self.state)
|
|
|
|
|
|
class ToggleEntity(Entity):
|
|
""" ABC for entities that can be turned on and off. """
|
|
# pylint: disable=no-self-use
|
|
|
|
@property
|
|
def state(self):
|
|
""" Returns the state. """
|
|
return STATE_ON if self.is_on else STATE_OFF
|
|
|
|
@property
|
|
def is_on(self):
|
|
""" True if entity is on. """
|
|
return False
|
|
|
|
def turn_on(self, **kwargs):
|
|
""" Turn the entity on. """
|
|
pass
|
|
|
|
def turn_off(self, **kwargs):
|
|
""" Turn the entity off. """
|
|
pass
|