147 lines
4.0 KiB
Python
147 lines
4.0 KiB
Python
"""Component to count within automations."""
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.const import ATTR_ENTITY_ID, CONF_ICON, CONF_NAME
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.entity_component import EntityComponent
|
|
from homeassistant.helpers.restore_state import RestoreEntity
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
ATTR_INITIAL = 'initial'
|
|
ATTR_STEP = 'step'
|
|
|
|
CONF_INITIAL = 'initial'
|
|
CONF_RESTORE = 'restore'
|
|
CONF_STEP = 'step'
|
|
|
|
DEFAULT_INITIAL = 0
|
|
DEFAULT_STEP = 1
|
|
DOMAIN = 'counter'
|
|
|
|
ENTITY_ID_FORMAT = DOMAIN + '.{}'
|
|
|
|
SERVICE_DECREMENT = 'decrement'
|
|
SERVICE_INCREMENT = 'increment'
|
|
SERVICE_RESET = 'reset'
|
|
|
|
SERVICE_SCHEMA = vol.Schema({
|
|
vol.Optional(ATTR_ENTITY_ID): cv.comp_entity_ids,
|
|
})
|
|
|
|
CONFIG_SCHEMA = vol.Schema({
|
|
DOMAIN: cv.schema_with_slug_keys(
|
|
vol.Any({
|
|
vol.Optional(CONF_ICON): cv.icon,
|
|
vol.Optional(CONF_INITIAL, default=DEFAULT_INITIAL):
|
|
cv.positive_int,
|
|
vol.Optional(CONF_NAME): cv.string,
|
|
vol.Optional(CONF_RESTORE, default=True): cv.boolean,
|
|
vol.Optional(CONF_STEP, default=DEFAULT_STEP): cv.positive_int,
|
|
}, None)
|
|
)
|
|
}, extra=vol.ALLOW_EXTRA)
|
|
|
|
|
|
async def async_setup(hass, config):
|
|
"""Set up the counters."""
|
|
component = EntityComponent(_LOGGER, DOMAIN, hass)
|
|
|
|
entities = []
|
|
|
|
for object_id, cfg in config[DOMAIN].items():
|
|
if not cfg:
|
|
cfg = {}
|
|
|
|
name = cfg.get(CONF_NAME)
|
|
initial = cfg.get(CONF_INITIAL)
|
|
restore = cfg.get(CONF_RESTORE)
|
|
step = cfg.get(CONF_STEP)
|
|
icon = cfg.get(CONF_ICON)
|
|
|
|
entities.append(Counter(object_id, name, initial, restore, step, icon))
|
|
|
|
if not entities:
|
|
return False
|
|
|
|
component.async_register_entity_service(
|
|
SERVICE_INCREMENT, SERVICE_SCHEMA,
|
|
'async_increment')
|
|
component.async_register_entity_service(
|
|
SERVICE_DECREMENT, SERVICE_SCHEMA,
|
|
'async_decrement')
|
|
component.async_register_entity_service(
|
|
SERVICE_RESET, SERVICE_SCHEMA,
|
|
'async_reset')
|
|
|
|
await component.async_add_entities(entities)
|
|
return True
|
|
|
|
|
|
class Counter(RestoreEntity):
|
|
"""Representation of a counter."""
|
|
|
|
def __init__(self, object_id, name, initial, restore, step, icon):
|
|
"""Initialize a counter."""
|
|
self.entity_id = ENTITY_ID_FORMAT.format(object_id)
|
|
self._name = name
|
|
self._restore = restore
|
|
self._step = step
|
|
self._state = self._initial = initial
|
|
self._icon = icon
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""If entity should be polled."""
|
|
return False
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return name of the counter."""
|
|
return self._name
|
|
|
|
@property
|
|
def icon(self):
|
|
"""Return the icon to be used for this entity."""
|
|
return self._icon
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the current value of the counter."""
|
|
return self._state
|
|
|
|
@property
|
|
def state_attributes(self):
|
|
"""Return the state attributes."""
|
|
return {
|
|
ATTR_INITIAL: self._initial,
|
|
ATTR_STEP: self._step,
|
|
}
|
|
|
|
async def async_added_to_hass(self):
|
|
"""Call when entity about to be added to Home Assistant."""
|
|
await super().async_added_to_hass()
|
|
# __init__ will set self._state to self._initial, only override
|
|
# if needed.
|
|
if self._restore:
|
|
state = await self.async_get_last_state()
|
|
if state is not None:
|
|
self._state = int(state.state)
|
|
|
|
async def async_decrement(self):
|
|
"""Decrement the counter."""
|
|
self._state -= self._step
|
|
await self.async_update_ha_state()
|
|
|
|
async def async_increment(self):
|
|
"""Increment a counter."""
|
|
self._state += self._step
|
|
await self.async_update_ha_state()
|
|
|
|
async def async_reset(self):
|
|
"""Reset a counter."""
|
|
self._state = self._initial
|
|
await self.async_update_ha_state()
|