core/homeassistant/components/compensation/sensor.py

163 lines
4.5 KiB
Python

"""Support for compensation sensor."""
import logging
from homeassistant.components.sensor import SensorEntity
from homeassistant.const import (
ATTR_UNIT_OF_MEASUREMENT,
CONF_ATTRIBUTE,
CONF_SOURCE,
CONF_UNIQUE_ID,
CONF_UNIT_OF_MEASUREMENT,
STATE_UNKNOWN,
)
from homeassistant.core import callback
from homeassistant.helpers.event import async_track_state_change_event
from .const import (
CONF_COMPENSATION,
CONF_POLYNOMIAL,
CONF_PRECISION,
DATA_COMPENSATION,
DEFAULT_NAME,
)
_LOGGER = logging.getLogger(__name__)
ATTR_COEFFICIENTS = "coefficients"
ATTR_SOURCE = "source"
ATTR_SOURCE_ATTRIBUTE = "source_attribute"
async def async_setup_platform(hass, config, async_add_entities, discovery_info=None):
"""Set up the Compensation sensor."""
if discovery_info is None:
return
compensation = discovery_info[CONF_COMPENSATION]
conf = hass.data[DATA_COMPENSATION][compensation]
source = conf[CONF_SOURCE]
attribute = conf.get(CONF_ATTRIBUTE)
name = f"{DEFAULT_NAME} {source}"
if attribute is not None:
name = f"{name} {attribute}"
async_add_entities(
[
CompensationSensor(
conf.get(CONF_UNIQUE_ID),
name,
source,
attribute,
conf[CONF_PRECISION],
conf[CONF_POLYNOMIAL],
conf.get(CONF_UNIT_OF_MEASUREMENT),
)
]
)
class CompensationSensor(SensorEntity):
"""Representation of a Compensation sensor."""
def __init__(
self,
unique_id,
name,
source,
attribute,
precision,
polynomial,
unit_of_measurement,
):
"""Initialize the Compensation sensor."""
self._source_entity_id = source
self._precision = precision
self._source_attribute = attribute
self._unit_of_measurement = unit_of_measurement
self._poly = polynomial
self._coefficients = polynomial.coefficients.tolist()
self._state = None
self._unique_id = unique_id
self._name = name
async def async_added_to_hass(self):
"""Handle added to Hass."""
self.async_on_remove(
async_track_state_change_event(
self.hass,
[self._source_entity_id],
self._async_compensation_sensor_state_listener,
)
)
@property
def unique_id(self):
"""Return the unique id of this sensor."""
return self._unique_id
@property
def name(self):
"""Return the name of the sensor."""
return self._name
@property
def should_poll(self):
"""No polling needed."""
return False
@property
def native_value(self):
"""Return the state of the sensor."""
return self._state
@property
def extra_state_attributes(self):
"""Return the state attributes of the sensor."""
ret = {
ATTR_SOURCE: self._source_entity_id,
ATTR_COEFFICIENTS: self._coefficients,
}
if self._source_attribute:
ret[ATTR_SOURCE_ATTRIBUTE] = self._source_attribute
return ret
@property
def native_unit_of_measurement(self):
"""Return the unit the value is expressed in."""
return self._unit_of_measurement
@callback
def _async_compensation_sensor_state_listener(self, event):
"""Handle sensor state changes."""
new_state = event.data.get("new_state")
if new_state is None:
return
if self._unit_of_measurement is None and self._source_attribute is None:
self._unit_of_measurement = new_state.attributes.get(
ATTR_UNIT_OF_MEASUREMENT
)
try:
if self._source_attribute:
value = float(new_state.attributes.get(self._source_attribute))
else:
value = (
None if new_state.state == STATE_UNKNOWN else float(new_state.state)
)
self._state = round(self._poly(value), self._precision)
except (ValueError, TypeError):
self._state = None
if self._source_attribute:
_LOGGER.warning(
"%s attribute %s is not numerical",
self._source_entity_id,
self._source_attribute,
)
else:
_LOGGER.warning("%s state is not numerical", self._source_entity_id)
self.async_write_ha_state()