/
daily_energy.py
260 lines (224 loc) · 9.07 KB
/
daily_energy.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
from __future__ import annotations
import logging
from datetime import datetime, timedelta
from decimal import Decimal
from typing import Any
import homeassistant.helpers.config_validation as cv
import homeassistant.util.dt as dt_util
import voluptuous as vol
from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN
from homeassistant.components.sensor import (
SensorDeviceClass,
SensorEntity,
SensorStateClass,
)
from homeassistant.const import (
CONF_NAME,
CONF_UNIQUE_ID,
CONF_UNIT_OF_MEASUREMENT,
ENERGY_KILO_WATT_HOUR,
ENERGY_MEGA_WATT_HOUR,
ENERGY_WATT_HOUR,
POWER_WATT,
)
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity import async_generate_entity_id
from homeassistant.helpers.event import async_track_time_interval
from homeassistant.helpers.restore_state import RestoreEntity
from homeassistant.helpers.template import Template
from homeassistant.helpers.typing import ConfigType
from ..common import SourceEntity
from ..const import (
CONF_DAILY_FIXED_ENERGY,
CONF_ENERGY_SENSOR_CATEGORY,
CONF_ENERGY_SENSOR_PRECISION,
CONF_ENERGY_SENSOR_UNIT_PREFIX,
CONF_FIXED,
CONF_ON_TIME,
CONF_POWER,
CONF_START_TIME,
CONF_UPDATE_FREQUENCY,
CONF_VALUE,
UnitPrefix,
)
from ..migrate import async_migrate_entity_id
from .abstract import generate_energy_sensor_entity_id, generate_energy_sensor_name
from .energy import EnergySensor
from .power import VirtualPowerSensor, create_virtual_power_sensor
ENERGY_ICON = "mdi:lightning-bolt"
ENTITY_ID_FORMAT = SENSOR_DOMAIN + ".{}"
DEFAULT_DAILY_UPDATE_FREQUENCY = 1800
DAILY_FIXED_ENERGY_SCHEMA = vol.Schema(
{
vol.Required(CONF_VALUE): vol.Any(vol.Coerce(float), cv.template),
vol.Optional(CONF_UNIT_OF_MEASUREMENT, default=ENERGY_KILO_WATT_HOUR): vol.In(
[ENERGY_KILO_WATT_HOUR, POWER_WATT]
),
vol.Optional(CONF_ON_TIME, default=timedelta(days=1)): cv.time_period,
vol.Optional(CONF_START_TIME): cv.time,
vol.Optional(
CONF_UPDATE_FREQUENCY, default=DEFAULT_DAILY_UPDATE_FREQUENCY
): vol.Coerce(int),
}
)
_LOGGER = logging.getLogger(__name__)
async def create_daily_fixed_energy_sensor(
hass: HomeAssistant, sensor_config: ConfigType, source_entity: SourceEntity | None = None
) -> DailyEnergySensor:
mode_config: dict = sensor_config.get(CONF_DAILY_FIXED_ENERGY)
name = generate_energy_sensor_name(sensor_config, sensor_config.get(CONF_NAME), source_entity)
unique_id = sensor_config.get(CONF_UNIQUE_ID) or None
entity_id = generate_energy_sensor_entity_id(
hass, sensor_config, unique_id=unique_id, source_entity=source_entity
)
if not unique_id:
old_entity_id = async_generate_entity_id(
ENTITY_ID_FORMAT, sensor_config.get(CONF_NAME), hass=hass
)
async_migrate_entity_id(
hass, SENSOR_DOMAIN, old_entity_id=old_entity_id, new_entity_id=entity_id
)
_LOGGER.debug(
"Creating daily_fixed_energy energy sensor (name=%s, entity_id=%s, unique_id=%s)",
name,
entity_id,
unique_id,
)
if CONF_ON_TIME in mode_config:
on_time = mode_config.get(CONF_ON_TIME)
if not isinstance(on_time, timedelta):
on_time = timedelta(seconds=on_time)
else:
on_time = timedelta(days=1)
return DailyEnergySensor(
hass,
name,
entity_id,
mode_config.get(CONF_VALUE),
mode_config.get(CONF_UNIT_OF_MEASUREMENT),
mode_config.get(CONF_UPDATE_FREQUENCY),
sensor_config,
on_time=on_time,
start_time=mode_config.get(CONF_START_TIME),
rounding_digits=sensor_config.get(CONF_ENERGY_SENSOR_PRECISION),
)
async def create_daily_fixed_energy_power_sensor(
hass: HomeAssistant, sensor_config: dict, source_entity: SourceEntity
) -> VirtualPowerSensor | None:
mode_config: dict = sensor_config.get(CONF_DAILY_FIXED_ENERGY)
if mode_config.get(CONF_UNIT_OF_MEASUREMENT) != POWER_WATT:
return None
if mode_config.get(CONF_ON_TIME) != timedelta(days=1):
return None
power_sensor_config = sensor_config.copy()
power_sensor_config[CONF_FIXED] = {CONF_POWER: mode_config.get(CONF_VALUE)}
unique_id = sensor_config.get(CONF_UNIQUE_ID)
if unique_id:
power_sensor_config[CONF_UNIQUE_ID] = f"{unique_id}_power"
_LOGGER.debug(
"Creating daily_fixed_energy power sensor (base_name=%s unique_id=%s)",
sensor_config.get(CONF_NAME),
unique_id,
)
return await create_virtual_power_sensor(hass, power_sensor_config, source_entity)
class DailyEnergySensor(RestoreEntity, SensorEntity, EnergySensor):
_attr_device_class = SensorDeviceClass.ENERGY
_attr_state_class = SensorStateClass.TOTAL
_attr_should_poll = False
_attr_icon = ENERGY_ICON
def __init__(
self,
hass: HomeAssistant,
name: str,
entity_id: str,
value: float | Template,
user_unit_of_measurement: str,
update_frequency: int,
sensor_config: dict[str, Any],
on_time: timedelta = None,
start_time=None,
rounding_digits: int = 4,
):
self._hass = hass
self._attr_name = name
self._attr_entity_category = sensor_config.get(CONF_ENERGY_SENSOR_CATEGORY)
self._value = value
self._user_unit_of_measurement = user_unit_of_measurement
self._update_frequency = update_frequency
self._sensor_config = sensor_config
self._on_time = on_time or timedelta(days=1)
self._start_time = start_time
self._rounding_digits = rounding_digits
self._attr_unique_id = sensor_config.get(CONF_UNIQUE_ID)
self.entity_id = entity_id
self._last_updated: float = dt_util.utcnow().timestamp()
self._last_delta_calculate: float | None = None
self.set_native_unit_of_measurement()
def set_native_unit_of_measurement(self):
"""Set the native unit of measurement"""
unit_prefix = (
self._sensor_config.get(CONF_ENERGY_SENSOR_UNIT_PREFIX) or UnitPrefix.KILO
)
if unit_prefix == UnitPrefix.KILO:
self._attr_native_unit_of_measurement = ENERGY_KILO_WATT_HOUR
elif unit_prefix == UnitPrefix.NONE:
self._attr_native_unit_of_measurement = ENERGY_WATT_HOUR
elif unit_prefix == UnitPrefix.MEGA:
self._attr_native_unit_of_measurement = ENERGY_MEGA_WATT_HOUR
async def async_added_to_hass(self):
"""Handle entity which will be added."""
if state := await self.async_get_last_state():
self._state = Decimal(state.state)
self._last_updated = state.last_changed.timestamp()
delta = self.calculate_delta()
self._state = self._state + delta
self.async_schedule_update_ha_state()
else:
self._state = Decimal(0)
_LOGGER.debug(f"{self.entity_id}: Restoring state: {self._state}")
@callback
def refresh(now: datetime):
"""Update the energy sensor state."""
delta = self.calculate_delta(self._update_frequency)
if delta > 0:
self._state = self._state + delta
_LOGGER.debug(
f"{self.entity_id}: Updating daily_fixed_energy sensor: {round(self._state, 4)}"
)
self.async_schedule_update_ha_state()
self._last_updated = dt_util.now().timestamp()
self._timer = async_track_time_interval(
self.hass, refresh, timedelta(seconds=self._update_frequency)
)
def calculate_delta(self, elapsed_seconds: int = 0) -> Decimal:
if self._last_delta_calculate is None:
self._last_delta_calculate = self._last_updated
elapsed_seconds = (
self._last_delta_calculate - self._last_updated
) + elapsed_seconds
self._last_delta_calculate = dt_util.utcnow().timestamp()
value = self._value
if isinstance(value, Template):
value.hass = self.hass
value = value.async_render()
if self._user_unit_of_measurement == ENERGY_KILO_WATT_HOUR:
wh_per_day = value * 1000
elif self._user_unit_of_measurement == POWER_WATT:
wh_per_day = value * (self._on_time.total_seconds() / 3600)
# Convert Wh to the native measurement unit
energy_per_day = wh_per_day
if self._attr_native_unit_of_measurement == ENERGY_KILO_WATT_HOUR:
energy_per_day = wh_per_day / 1000
elif self._attr_native_unit_of_measurement == ENERGY_MEGA_WATT_HOUR:
energy_per_day = wh_per_day / 1000000
return Decimal((energy_per_day / 86400) * elapsed_seconds)
@property
def native_value(self):
"""Return the state of the sensor."""
return round(self._state, self._rounding_digits)
@callback
def async_reset_energy(self) -> None:
_LOGGER.debug(f"{self.entity_id}: Reset energy sensor")
self._state = 0
self._attr_last_reset = dt_util.utcnow()
self.async_write_ha_state()