-
-
Notifications
You must be signed in to change notification settings - Fork 29
/
sensor.py
570 lines (497 loc) · 19.2 KB
/
sensor.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# Copyright (c) 2019-2022, Andrey "Limych" Khrolenok <andrey@khrolenok.ru>
# Creative Commons BY-NC-SA 4.0 International Public License
# (see LICENSE.md or https://creativecommons.org/licenses/by-nc-sa/4.0/)
"""The Average Sensor.
For more details about this sensor, please refer to the documentation at
https://github.com/Limych/ha-average/
"""
from __future__ import annotations
from collections.abc import Mapping
import datetime
import logging
import math
import numbers
from typing import Any
from _sha1 import sha1
import voluptuous as vol
from homeassistant.components.climate import DOMAIN as CLIMATE_DOMAIN
from homeassistant.components.group import expand_entity_ids
from homeassistant.components.recorder import get_instance, history
from homeassistant.components.sensor import (
SensorDeviceClass,
SensorEntity,
SensorStateClass,
)
from homeassistant.components.water_heater import DOMAIN as WATER_HEATER_DOMAIN
from homeassistant.components.weather import DOMAIN as WEATHER_DOMAIN
from homeassistant.const import (
ATTR_DEVICE_CLASS,
ATTR_ICON,
ATTR_UNIT_OF_MEASUREMENT,
CONF_ENTITIES,
CONF_NAME,
CONF_UNIQUE_ID,
EVENT_HOMEASSISTANT_START,
STATE_UNAVAILABLE,
STATE_UNKNOWN,
)
from homeassistant.core import (
Event,
EventStateChangedData,
HomeAssistant,
State,
callback,
split_entity_id,
)
from homeassistant.exceptions import TemplateError
from homeassistant.helpers import config_validation as cv
from homeassistant.helpers.config_validation import PLATFORM_SCHEMA
from homeassistant.helpers.event import async_track_state_change_event
from homeassistant.util import Throttle
import homeassistant.util.dt as dt_util
from homeassistant.util.unit_conversion import TemperatureConverter
from homeassistant.util.unit_system import TEMPERATURE_UNITS
from .const import (
ATTR_AVAILABLE_SOURCES,
ATTR_COUNT,
ATTR_COUNT_SOURCES,
ATTR_END,
ATTR_MAX_VALUE,
ATTR_MIN_VALUE,
ATTR_START,
ATTR_TO_PROPERTY,
CONF_DURATION,
CONF_END,
CONF_PERIOD_KEYS,
CONF_PRECISION,
CONF_PROCESS_UNDEF_AS,
CONF_START,
DEFAULT_NAME,
DEFAULT_PRECISION,
UPDATE_MIN_TIME,
)
_LOGGER = logging.getLogger(__name__)
def check_period_keys(conf):
"""Ensure maximum 2 of CONF_PERIOD_KEYS are provided."""
count = sum(param in conf for param in CONF_PERIOD_KEYS)
if (count == 1 and CONF_DURATION not in conf) or count > 2:
raise vol.Invalid(
"You must provide none, only "
+ CONF_DURATION
+ " or maximum 2 of the following: "
", ".join(CONF_PERIOD_KEYS)
)
return conf
PLATFORM_SCHEMA = vol.All(
PLATFORM_SCHEMA.extend(
{
vol.Required(CONF_ENTITIES): cv.entity_ids,
vol.Optional(CONF_UNIQUE_ID): cv.string,
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Optional(CONF_START): cv.template,
vol.Optional(CONF_END): cv.template,
vol.Optional(CONF_DURATION): cv.positive_time_period,
vol.Optional(CONF_PRECISION, default=DEFAULT_PRECISION): int,
vol.Optional(CONF_PROCESS_UNDEF_AS): vol.Any(int, float),
}
),
check_period_keys,
)
# pylint: disable=unused-argument
async def async_setup_platform(
hass: HomeAssistant, config, async_add_entities, discovery_info=None
):
"""Set up platform."""
start = config.get(CONF_START)
end = config.get(CONF_END)
for template in [start, end]:
if template is not None:
template.hass = hass
async_add_entities(
[
AverageSensor(
hass,
config.get(CONF_UNIQUE_ID),
config.get(CONF_NAME),
start,
end,
config.get(CONF_DURATION),
config.get(CONF_ENTITIES),
config.get(CONF_PRECISION),
config.get(CONF_PROCESS_UNDEF_AS),
)
]
)
# pylint: disable=too-many-instance-attributes
class AverageSensor(SensorEntity):
"""Implementation of an Average sensor."""
_unrecorded_attributes = frozenset(
{
ATTR_START,
ATTR_END,
ATTR_COUNT_SOURCES,
ATTR_AVAILABLE_SOURCES,
ATTR_COUNT,
ATTR_MAX_VALUE,
ATTR_MIN_VALUE,
}
)
# pylint: disable=too-many-arguments
def __init__(
self,
hass: HomeAssistant,
unique_id: str | None,
name: str,
start,
end,
duration,
entity_ids: list,
precision: int,
undef,
):
"""Initialize the sensor."""
self._start_template = start
self._end_template = end
self._duration = duration
self._period = self.start = self.end = None
self._precision = precision
self._undef = undef
self._temperature_mode = None
self.sources = expand_entity_ids(hass, entity_ids)
self.count_sources = len(self.sources)
self.available_sources = 0
self.count = 0
self.min_value = self.max_value = None
self._attr_name = name
self._attr_native_value = None
self._attr_native_unit_of_measurement = None
self._attr_icon = None
self._attr_state_class = SensorStateClass.MEASUREMENT
self._attr_device_class = None
#
self._attr_unique_id = (
str(
sha1(
";".join(
[str(start), str(duration), str(end), ",".join(self.sources)]
).encode("utf-8")
).hexdigest()
)
if unique_id == "__legacy__"
else unique_id
)
@property
def _has_period(self) -> bool:
"""Return True if sensor has any period setting."""
return (
self._start_template is not None
or self._end_template is not None
or self._duration is not None
)
@property
def should_poll(self) -> bool:
"""Return the polling state."""
return self._has_period
@property
def available(self) -> bool:
"""Return True if entity is available."""
return self.available_sources > 0 and self._has_state(self._attr_native_value)
@property
def extra_state_attributes(self) -> Mapping[str, Any] | None:
"""Return entity specific state attributes."""
state_attr = {
attr: getattr(self, attr)
for attr in ATTR_TO_PROPERTY
if getattr(self, attr) is not None
}
return state_attr
async def async_added_to_hass(self) -> None:
"""Register callbacks."""
# pylint: disable=unused-argument
@callback
async def async_sensor_state_listener(
event: Event[EventStateChangedData],
) -> None:
"""Handle device state changes."""
last_state = self._attr_native_value
await self._async_update_state()
if last_state != self._attr_native_value:
self.async_schedule_update_ha_state(True)
# pylint: disable=unused-argument
@callback
async def async_sensor_startup(event):
"""Update template on startup."""
if self._has_period:
self.async_schedule_update_ha_state(True)
else:
async_track_state_change_event(
self.hass, self.sources, async_sensor_state_listener
)
await async_sensor_state_listener(Event("startup"))
self.hass.bus.async_listen_once(EVENT_HOMEASSISTANT_START, async_sensor_startup)
@staticmethod
def _has_state(state) -> bool:
"""Return True if state has any value."""
return state is not None and state not in [
STATE_UNKNOWN,
STATE_UNAVAILABLE,
"None",
"",
]
def _get_temperature(self, state: State) -> float | None:
"""Get temperature value from entity."""
ha_unit = self.hass.config.units.temperature_unit
domain = split_entity_id(state.entity_id)[0]
if domain == WEATHER_DOMAIN:
temperature = state.attributes.get("temperature")
entity_unit = ha_unit
elif domain in (CLIMATE_DOMAIN, WATER_HEATER_DOMAIN):
temperature = state.attributes.get("current_temperature")
entity_unit = ha_unit
else:
temperature = state.state
entity_unit = state.attributes.get(ATTR_UNIT_OF_MEASUREMENT)
if not self._has_state(temperature):
return None
try:
temperature = TemperatureConverter.convert(
float(temperature), entity_unit, ha_unit
)
except ValueError as exc:
_LOGGER.error('Could not convert value "%s" to float: %s', state, exc)
return None
return temperature
def _get_state_value(self, state: State) -> float | None:
"""Return value of given entity state and count some sensor attributes."""
state = self._get_temperature(state) if self._temperature_mode else state.state
if not self._has_state(state):
return self._undef
try:
state = float(state)
except ValueError as exc:
_LOGGER.error('Could not convert value "%s" to float: %s', state, exc)
return None
self.count += 1
rstate = round(state, self._precision)
if self.min_value is None:
self.min_value = self.max_value = rstate
else:
self.min_value = min(self.min_value, rstate)
self.max_value = max(self.max_value, rstate)
return state
@Throttle(UPDATE_MIN_TIME)
async def async_update(self):
"""Update the sensor state if it needed."""
if self._has_period:
await self._async_update_state()
@staticmethod
def handle_template_exception(exc, field):
"""Log an error nicely if the template cannot be interpreted."""
if exc.args and exc.args[0].startswith(
"UndefinedError: 'None' has no attribute"
):
# Common during HA startup - so just a warning
_LOGGER.warning(exc)
else:
_LOGGER.error('Error parsing template for field "%s": %s', field, exc)
async def _async_update_period(self): # pylint: disable=too-many-branches
"""Parse the templates and calculate a datetime tuples."""
start = end = None
now = dt_util.now()
# Parse start
if self._start_template is not None:
_LOGGER.debug("Process start template: %s", self._start_template)
try:
start_rendered = self._start_template.async_render()
except (TemplateError, TypeError) as ex:
self.handle_template_exception(ex, "start")
return
if isinstance(start_rendered, str):
start = dt_util.parse_datetime(start_rendered)
if start is None:
try:
start = dt_util.as_local(
dt_util.utc_from_timestamp(math.floor(float(start_rendered)))
)
except ValueError:
_LOGGER.error(
'Parsing error: field "start" must be a datetime or a timestamp'
)
return
# Parse end
if self._end_template is not None:
_LOGGER.debug("Process end template: %s", self._end_template)
try:
end_rendered = self._end_template.async_render()
except (TemplateError, TypeError) as ex:
self.handle_template_exception(ex, "end")
return
if isinstance(end_rendered, str):
end = dt_util.parse_datetime(end_rendered)
if end is None:
try:
end = dt_util.as_local(
dt_util.utc_from_timestamp(math.floor(float(end_rendered)))
)
except ValueError:
_LOGGER.error(
'Parsing error: field "end" must be a datetime or a timestamp'
)
return
# Calculate start or end using the duration
if self._duration is not None:
_LOGGER.debug("Process duration: %s", self._duration)
if start is None:
if end is None:
end = now
start = end - self._duration
else:
end = start + self._duration
_LOGGER.debug("Calculation period: start=%s, end=%s", start, end)
if start is None or end is None:
return
if start > end:
start, end = end, start
if start > now:
# History hasn't been written yet for this period
return
end = min(end, now) # No point in making stats of the future
self._period = start, end
self.start = start.replace(microsecond=0).isoformat()
self.end = end.replace(microsecond=0).isoformat()
def _init_mode(self, state: State):
"""Initialize sensor mode."""
if self._temperature_mode is not None:
return
domain = split_entity_id(state.entity_id)[0]
self._attr_device_class = state.attributes.get(ATTR_DEVICE_CLASS)
self._attr_native_unit_of_measurement = state.attributes.get(
ATTR_UNIT_OF_MEASUREMENT
)
self._temperature_mode = (
self._attr_device_class == SensorDeviceClass.TEMPERATURE
or domain in (WEATHER_DOMAIN, CLIMATE_DOMAIN, WATER_HEATER_DOMAIN)
or self._attr_native_unit_of_measurement in TEMPERATURE_UNITS
)
if self._temperature_mode:
_LOGGER.debug("%s is a temperature entity.", state.entity_id)
self._attr_device_class = SensorDeviceClass.TEMPERATURE
self._attr_native_unit_of_measurement = (
self.hass.config.units.temperature_unit
)
else:
_LOGGER.debug("%s is NOT a temperature entity.", state.entity_id)
self._attr_icon = state.attributes.get(ATTR_ICON)
async def _async_update_state(
self,
): # pylint: disable=too-many-locals,too-many-branches,too-many-statements
"""Update the sensor state."""
_LOGGER.debug('Updating sensor "%s"', self.name)
start = end = start_ts = end_ts = None
p_period = self._period
# Parse templates
await self._async_update_period()
if self._period is not None:
now = datetime.datetime.now()
start, end = self._period
if p_period is None:
p_start = p_end = now
else:
p_start, p_end = p_period
# Convert times to UTC
start = dt_util.as_utc(start)
end = dt_util.as_utc(end)
p_start = dt_util.as_utc(p_start)
p_end = dt_util.as_utc(p_end)
# Compute integer timestamps
now_ts = math.floor(dt_util.as_timestamp(now))
start_ts = math.floor(dt_util.as_timestamp(start))
end_ts = math.floor(dt_util.as_timestamp(end))
p_start_ts = math.floor(dt_util.as_timestamp(p_start))
p_end_ts = math.floor(dt_util.as_timestamp(p_end))
# If period has not changed and current time after the period end..
if start_ts == p_start_ts and end_ts == p_end_ts and end_ts <= now_ts:
# Don't compute anything as the value cannot have changed
return
self.available_sources = 0
values = []
self.count = 0
self.min_value = self.max_value = None
# pylint: disable=too-many-nested-blocks
for entity_id in self.sources:
_LOGGER.debug('Processing entity "%s"', entity_id)
state = self.hass.states.get(entity_id) # type: State
if state is None:
_LOGGER.error('Unable to find an entity "%s"', entity_id)
continue
self._init_mode(state)
value = 0
elapsed = 0
if self._period is None:
# Get current state
value = self._get_state_value(state)
_LOGGER.debug("Current state: %s", value)
else:
# Get history between start and now
history_list = await get_instance(self.hass).async_add_executor_job(
history.state_changes_during_period,
self.hass,
start,
end,
str(entity_id),
)
if (
entity_id not in history_list
or history_list[entity_id] is None
or len(history_list[entity_id]) == 0
):
value = self._get_state_value(state)
_LOGGER.warning(
'Historical data not found for entity "%s". '
"Current state used: %s",
entity_id,
value,
)
else:
# Get the first state
item = history_list[entity_id][0]
_LOGGER.debug("Initial historical state: %s", item)
last_state = None
last_time = start_ts
if item is not None and self._has_state(item.state):
last_state = self._get_state_value(item)
# Get the other states
for item in history_list.get(entity_id):
_LOGGER.debug("Historical state: %s", item)
current_state = self._get_state_value(item)
current_time = item.last_changed.timestamp()
if last_state is not None:
last_elapsed = current_time - last_time
value += last_state * last_elapsed
elapsed += last_elapsed
last_state = current_state
last_time = current_time
# Count time elapsed between last history state and now
if last_state is None:
value = None
else:
last_elapsed = end_ts - last_time
value += last_state * last_elapsed
elapsed += last_elapsed
if elapsed:
value /= elapsed
_LOGGER.debug("Historical average state: %s", value)
if isinstance(value, numbers.Number):
values.append(value)
self.available_sources += 1
if values:
self._attr_native_value = round(sum(values) / len(values), self._precision)
if self._precision < 1:
self._attr_native_value = int(self._attr_native_value)
else:
self._attr_native_value = None
_LOGGER.debug(
"Total average state: %s %s",
self._attr_native_value,
self._attr_native_unit_of_measurement,
)