mirror of
https://github.com/home-assistant/core.git
synced 2025-07-13 08:17:08 +00:00
Add max_age to statistics sensor (#8790)
* Add max_age to statistics sensor * Allow only non-zero sampling sizes * Fix long line * Fix style
This commit is contained in:
parent
56f9ccb877
commit
3a0e38aa73
@ -18,6 +18,7 @@ from homeassistant.const import (
|
|||||||
from homeassistant.core import callback
|
from homeassistant.core import callback
|
||||||
from homeassistant.helpers.entity import Entity
|
from homeassistant.helpers.entity import Entity
|
||||||
from homeassistant.helpers.event import async_track_state_change
|
from homeassistant.helpers.event import async_track_state_change
|
||||||
|
from homeassistant.util import dt as dt_util
|
||||||
|
|
||||||
_LOGGER = logging.getLogger(__name__)
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
@ -34,6 +35,8 @@ ATTR_SAMPLING_SIZE = 'sampling_size'
|
|||||||
ATTR_TOTAL = 'total'
|
ATTR_TOTAL = 'total'
|
||||||
|
|
||||||
CONF_SAMPLING_SIZE = 'sampling_size'
|
CONF_SAMPLING_SIZE = 'sampling_size'
|
||||||
|
CONF_MAX_AGE = 'max_age'
|
||||||
|
|
||||||
DEFAULT_NAME = 'Stats'
|
DEFAULT_NAME = 'Stats'
|
||||||
DEFAULT_SIZE = 20
|
DEFAULT_SIZE = 20
|
||||||
ICON = 'mdi:calculator'
|
ICON = 'mdi:calculator'
|
||||||
@ -41,7 +44,9 @@ ICON = 'mdi:calculator'
|
|||||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||||
vol.Required(CONF_ENTITY_ID): cv.entity_id,
|
vol.Required(CONF_ENTITY_ID): cv.entity_id,
|
||||||
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
||||||
vol.Optional(CONF_SAMPLING_SIZE, default=DEFAULT_SIZE): cv.positive_int,
|
vol.Optional(CONF_SAMPLING_SIZE, default=DEFAULT_SIZE):
|
||||||
|
vol.All(vol.Coerce(int), vol.Range(min=1)),
|
||||||
|
vol.Optional(CONF_MAX_AGE): cv.time_period
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|
||||||
@ -51,16 +56,18 @@ def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
|
|||||||
entity_id = config.get(CONF_ENTITY_ID)
|
entity_id = config.get(CONF_ENTITY_ID)
|
||||||
name = config.get(CONF_NAME)
|
name = config.get(CONF_NAME)
|
||||||
sampling_size = config.get(CONF_SAMPLING_SIZE)
|
sampling_size = config.get(CONF_SAMPLING_SIZE)
|
||||||
|
max_age = config.get(CONF_MAX_AGE, None)
|
||||||
|
|
||||||
async_add_devices(
|
async_add_devices(
|
||||||
[StatisticsSensor(hass, entity_id, name, sampling_size)], True)
|
[StatisticsSensor(hass, entity_id, name, sampling_size, max_age)],
|
||||||
|
True)
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
class StatisticsSensor(Entity):
|
class StatisticsSensor(Entity):
|
||||||
"""Representation of a Statistics sensor."""
|
"""Representation of a Statistics sensor."""
|
||||||
|
|
||||||
def __init__(self, hass, entity_id, name, sampling_size):
|
def __init__(self, hass, entity_id, name, sampling_size, max_age):
|
||||||
"""Initialize the Statistics sensor."""
|
"""Initialize the Statistics sensor."""
|
||||||
self._hass = hass
|
self._hass = hass
|
||||||
self._entity_id = entity_id
|
self._entity_id = entity_id
|
||||||
@ -71,11 +78,12 @@ class StatisticsSensor(Entity):
|
|||||||
else:
|
else:
|
||||||
self._name = '{} {}'.format(name, ATTR_COUNT)
|
self._name = '{} {}'.format(name, ATTR_COUNT)
|
||||||
self._sampling_size = sampling_size
|
self._sampling_size = sampling_size
|
||||||
|
self._max_age = max_age
|
||||||
self._unit_of_measurement = None
|
self._unit_of_measurement = None
|
||||||
if self._sampling_size == 0:
|
self.states = deque(maxlen=self._sampling_size)
|
||||||
self.states = deque()
|
if self._max_age is not None:
|
||||||
else:
|
self.ages = deque(maxlen=self._sampling_size)
|
||||||
self.states = deque(maxlen=self._sampling_size)
|
|
||||||
self.median = self.mean = self.variance = self.stdev = 0
|
self.median = self.mean = self.variance = self.stdev = 0
|
||||||
self.min = self.max = self.total = self.count = 0
|
self.min = self.max = self.total = self.count = 0
|
||||||
self.average_change = self.change = 0
|
self.average_change = self.change = 0
|
||||||
@ -89,6 +97,9 @@ class StatisticsSensor(Entity):
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
self.states.append(float(new_state.state))
|
self.states.append(float(new_state.state))
|
||||||
|
if self._max_age is not None:
|
||||||
|
now = dt_util.utcnow()
|
||||||
|
self.ages.append(now)
|
||||||
self.count = self.count + 1
|
self.count = self.count + 1
|
||||||
except ValueError:
|
except ValueError:
|
||||||
self.count = self.count + 1
|
self.count = self.count + 1
|
||||||
@ -128,8 +139,7 @@ class StatisticsSensor(Entity):
|
|||||||
ATTR_MAX_VALUE: self.max,
|
ATTR_MAX_VALUE: self.max,
|
||||||
ATTR_MEDIAN: self.median,
|
ATTR_MEDIAN: self.median,
|
||||||
ATTR_MIN_VALUE: self.min,
|
ATTR_MIN_VALUE: self.min,
|
||||||
ATTR_SAMPLING_SIZE: 'unlimited' if self._sampling_size is
|
ATTR_SAMPLING_SIZE: self._sampling_size,
|
||||||
0 else self._sampling_size,
|
|
||||||
ATTR_STANDARD_DEVIATION: self.stdev,
|
ATTR_STANDARD_DEVIATION: self.stdev,
|
||||||
ATTR_TOTAL: self.total,
|
ATTR_TOTAL: self.total,
|
||||||
ATTR_VARIANCE: self.variance,
|
ATTR_VARIANCE: self.variance,
|
||||||
@ -142,9 +152,20 @@ class StatisticsSensor(Entity):
|
|||||||
"""Return the icon to use in the frontend, if any."""
|
"""Return the icon to use in the frontend, if any."""
|
||||||
return ICON
|
return ICON
|
||||||
|
|
||||||
|
def _purge_old(self):
|
||||||
|
"""Remove states which are older than self._max_age."""
|
||||||
|
now = dt_util.utcnow()
|
||||||
|
|
||||||
|
while (len(self.ages) > 0) and (now - self.ages[0]) > self._max_age:
|
||||||
|
self.ages.popleft()
|
||||||
|
self.states.popleft()
|
||||||
|
|
||||||
@asyncio.coroutine
|
@asyncio.coroutine
|
||||||
def async_update(self):
|
def async_update(self):
|
||||||
"""Get the latest data and updates the states."""
|
"""Get the latest data and updates the states."""
|
||||||
|
if self._max_age is not None:
|
||||||
|
self._purge_old()
|
||||||
|
|
||||||
if not self.is_binary:
|
if not self.is_binary:
|
||||||
try:
|
try:
|
||||||
self.mean = round(statistics.mean(self.states), 2)
|
self.mean = round(statistics.mean(self.states), 2)
|
||||||
|
@ -4,7 +4,10 @@ import statistics
|
|||||||
|
|
||||||
from homeassistant.setup import setup_component
|
from homeassistant.setup import setup_component
|
||||||
from homeassistant.const import (ATTR_UNIT_OF_MEASUREMENT, TEMP_CELSIUS)
|
from homeassistant.const import (ATTR_UNIT_OF_MEASUREMENT, TEMP_CELSIUS)
|
||||||
|
from homeassistant.util import dt as dt_util
|
||||||
from tests.common import get_test_home_assistant
|
from tests.common import get_test_home_assistant
|
||||||
|
from unittest.mock import patch
|
||||||
|
from datetime import datetime, timedelta
|
||||||
|
|
||||||
|
|
||||||
class TestStatisticsSensor(unittest.TestCase):
|
class TestStatisticsSensor(unittest.TestCase):
|
||||||
@ -100,3 +103,35 @@ class TestStatisticsSensor(unittest.TestCase):
|
|||||||
|
|
||||||
self.assertEqual(3.8, state.attributes.get('min_value'))
|
self.assertEqual(3.8, state.attributes.get('min_value'))
|
||||||
self.assertEqual(14, state.attributes.get('max_value'))
|
self.assertEqual(14, state.attributes.get('max_value'))
|
||||||
|
|
||||||
|
def test_max_age(self):
|
||||||
|
"""Test value deprecation."""
|
||||||
|
mock_data = {
|
||||||
|
'return_time': datetime(2017, 8, 2, 12, 23, tzinfo=dt_util.UTC),
|
||||||
|
}
|
||||||
|
|
||||||
|
def mock_now():
|
||||||
|
return mock_data['return_time']
|
||||||
|
|
||||||
|
with patch('homeassistant.components.sensor.statistics.dt_util.utcnow',
|
||||||
|
new=mock_now):
|
||||||
|
assert setup_component(self.hass, 'sensor', {
|
||||||
|
'sensor': {
|
||||||
|
'platform': 'statistics',
|
||||||
|
'name': 'test',
|
||||||
|
'entity_id': 'sensor.test_monitored',
|
||||||
|
'max_age': {'minutes': 3}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
for value in self.values:
|
||||||
|
self.hass.states.set('sensor.test_monitored', value,
|
||||||
|
{ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS})
|
||||||
|
self.hass.block_till_done()
|
||||||
|
# insert the next value one minute later
|
||||||
|
mock_data['return_time'] += timedelta(minutes=1)
|
||||||
|
|
||||||
|
state = self.hass.states.get('sensor.test_mean')
|
||||||
|
|
||||||
|
self.assertEqual(6, state.attributes.get('min_value'))
|
||||||
|
self.assertEqual(14, state.attributes.get('max_value'))
|
||||||
|
Loading…
x
Reference in New Issue
Block a user