Centralizes Toon data, reducing API calls (#23988)
* Centralizes Toon data, reducing API calls Fixes #21825 Signed-off-by: Franck Nijhof <frenck@addons.community> * Fixes bad copy past action in services.yaml Signed-off-by: Franck Nijhof <frenck@addons.community> * Addresses review comments Signed-off-by: Franck Nijhof <frenck@addons.community> * 👕 Fixes too many blank lines * Unsub dispatcher
This commit is contained in:
1 parent
f3e542542a
commit
3ce1049d21
6 files changed
+538
-198
No files matched your search
@@ -1,113 +1,232 @@
|
||||
"""Support for Toon sensors."""
|
||||
from datetime import timedelta
|
||||
import logging
|
||||
|
||||
from homeassistant.config_entries import ConfigEntry
|
||||
from homeassistant.helpers.typing import HomeAssistantType
|
||||
from homeassistant.const import ENERGY_KILO_WATT_HOUR, POWER_WATT
|
||||
|
||||
from . import (ToonEntity, ToonElectricityMeterDeviceEntity,
|
||||
ToonGasMeterDeviceEntity, ToonSolarDeviceEntity,
|
||||
ToonBoilerDeviceEntity)
|
||||
from .const import (CURRENCY_EUR, DATA_TOON_CLIENT, DOMAIN, POWER_KWH,
|
||||
POWER_WATT, VOLUME_CM3, VOLUME_M3, RATIO_PERCENT)
|
||||
from . import (
|
||||
ToonData,
|
||||
ToonEntity,
|
||||
ToonElectricityMeterDeviceEntity,
|
||||
ToonGasMeterDeviceEntity,
|
||||
ToonSolarDeviceEntity,
|
||||
ToonBoilerDeviceEntity,
|
||||
)
|
||||
from .const import (
|
||||
CURRENCY_EUR,
|
||||
DATA_TOON,
|
||||
DOMAIN,
|
||||
VOLUME_CM3,
|
||||
VOLUME_M3,
|
||||
RATIO_PERCENT,
|
||||
)
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=5)
|
||||
SCAN_INTERVAL = timedelta(seconds=300)
|
||||
|
||||
|
||||
async def async_setup_entry(hass: HomeAssistantType, entry: ConfigEntry,
|
||||
async_add_entities) -> None:
|
||||
async def async_setup_entry(
|
||||
hass: HomeAssistantType, entry: ConfigEntry, async_add_entities
|
||||
) -> None:
|
||||
"""Set up Toon sensors based on a config entry."""
|
||||
toon = hass.data[DATA_TOON_CLIENT][entry.entry_id]
|
||||
toon = hass.data[DATA_TOON][entry.entry_id]
|
||||
|
||||
sensors = [
|
||||
ToonElectricityMeterDeviceSensor(toon, 'power', 'value',
|
||||
"Current Power Usage",
|
||||
'mdi:power-plug', POWER_WATT),
|
||||
ToonElectricityMeterDeviceSensor(toon, 'power', 'average',
|
||||
"Average Power Usage",
|
||||
'mdi:power-plug', POWER_WATT),
|
||||
ToonElectricityMeterDeviceSensor(toon, 'power', 'daily_value',
|
||||
"Power Usage Today",
|
||||
'mdi:power-plug', POWER_KWH),
|
||||
ToonElectricityMeterDeviceSensor(toon, 'power', 'daily_cost',
|
||||
"Power Cost Today",
|
||||
'mdi:power-plug', CURRENCY_EUR),
|
||||
ToonElectricityMeterDeviceSensor(toon, 'power', 'average_daily',
|
||||
"Average Daily Power Usage",
|
||||
'mdi:power-plug', POWER_KWH),
|
||||
ToonElectricityMeterDeviceSensor(toon, 'power', 'meter_reading',
|
||||
"Power Meter Feed IN Tariff 1",
|
||||
'mdi:power-plug', POWER_KWH),
|
||||
ToonElectricityMeterDeviceSensor(toon, 'power', 'meter_reading_low',
|
||||
"Power Meter Feed IN Tariff 2",
|
||||
'mdi:power-plug', POWER_KWH),
|
||||
ToonElectricityMeterDeviceSensor(
|
||||
toon,
|
||||
'power',
|
||||
'value',
|
||||
"Current Power Usage",
|
||||
'mdi:power-plug',
|
||||
POWER_WATT,
|
||||
),
|
||||
ToonElectricityMeterDeviceSensor(
|
||||
toon,
|
||||
'power',
|
||||
'average',
|
||||
"Average Power Usage",
|
||||
'mdi:power-plug',
|
||||
POWER_WATT,
|
||||
),
|
||||
ToonElectricityMeterDeviceSensor(
|
||||
toon,
|
||||
'power',
|
||||
'daily_value',
|
||||
"Power Usage Today",
|
||||
'mdi:power-plug',
|
||||
ENERGY_KILO_WATT_HOUR,
|
||||
),
|
||||
ToonElectricityMeterDeviceSensor(
|
||||
toon,
|
||||
'power',
|
||||
'daily_cost',
|
||||
"Power Cost Today",
|
||||
'mdi:power-plug',
|
||||
CURRENCY_EUR,
|
||||
),
|
||||
ToonElectricityMeterDeviceSensor(
|
||||
toon,
|
||||
'power',
|
||||
'average_daily',
|
||||
"Average Daily Power Usage",
|
||||
'mdi:power-plug',
|
||||
ENERGY_KILO_WATT_HOUR,
|
||||
),
|
||||
ToonElectricityMeterDeviceSensor(
|
||||
toon,
|
||||
'power',
|
||||
'meter_reading',
|
||||
"Power Meter Feed IN Tariff 1",
|
||||
'mdi:power-plug',
|
||||
ENERGY_KILO_WATT_HOUR,
|
||||
),
|
||||
ToonElectricityMeterDeviceSensor(
|
||||
toon,
|
||||
'power',
|
||||
'meter_reading_low',
|
||||
"Power Meter Feed IN Tariff 2",
|
||||
'mdi:power-plug',
|
||||
ENERGY_KILO_WATT_HOUR,
|
||||
),
|
||||
]
|
||||
|
||||
if toon.gas:
|
||||
sensors.extend([
|
||||
ToonGasMeterDeviceSensor(toon, 'gas', 'value', "Current Gas Usage",
|
||||
'mdi:gas-cylinder', VOLUME_CM3),
|
||||
ToonGasMeterDeviceSensor(toon, 'gas', 'average',
|
||||
"Average Gas Usage", 'mdi:gas-cylinder',
|
||||
VOLUME_CM3),
|
||||
ToonGasMeterDeviceSensor(toon, 'gas', 'daily_usage',
|
||||
"Gas Usage Today", 'mdi:gas-cylinder',
|
||||
VOLUME_M3),
|
||||
ToonGasMeterDeviceSensor(toon, 'gas', 'average_daily',
|
||||
"Average Daily Gas Usage",
|
||||
'mdi:gas-cylinder', VOLUME_M3),
|
||||
ToonGasMeterDeviceSensor(toon, 'gas', 'meter_reading', "Gas Meter",
|
||||
'mdi:gas-cylinder', VOLUME_M3),
|
||||
ToonGasMeterDeviceSensor(toon, 'gas', 'daily_cost',
|
||||
"Gas Cost Today", 'mdi:gas-cylinder',
|
||||
CURRENCY_EUR),
|
||||
])
|
||||
sensors.extend(
|
||||
[
|
||||
ToonGasMeterDeviceSensor(
|
||||
toon,
|
||||
'gas',
|
||||
'value',
|
||||
"Current Gas Usage",
|
||||
'mdi:gas-cylinder',
|
||||
VOLUME_CM3,
|
||||
),
|
||||
ToonGasMeterDeviceSensor(
|
||||
toon,
|
||||
'gas',
|
||||
'average',
|
||||
"Average Gas Usage",
|
||||
'mdi:gas-cylinder',
|
||||
VOLUME_CM3,
|
||||
),
|
||||
ToonGasMeterDeviceSensor(
|
||||
toon,
|
||||
'gas',
|
||||
'daily_usage',
|
||||
"Gas Usage Today",
|
||||
'mdi:gas-cylinder',
|
||||
VOLUME_M3,
|
||||
),
|
||||
ToonGasMeterDeviceSensor(
|
||||
toon,
|
||||
'gas',
|
||||
'average_daily',
|
||||
"Average Daily Gas Usage",
|
||||
'mdi:gas-cylinder',
|
||||
VOLUME_M3,
|
||||
),
|
||||
ToonGasMeterDeviceSensor(
|
||||
toon,
|
||||
'gas',
|
||||
'meter_reading',
|
||||
"Gas Meter",
|
||||
'mdi:gas-cylinder',
|
||||
VOLUME_M3,
|
||||
),
|
||||
ToonGasMeterDeviceSensor(
|
||||
toon,
|
||||
'gas',
|
||||
'daily_cost',
|
||||
"Gas Cost Today",
|
||||
'mdi:gas-cylinder',
|
||||
CURRENCY_EUR,
|
||||
),
|
||||
]
|
||||
)
|
||||
|
||||
if toon.solar:
|
||||
sensors.extend([
|
||||
ToonSolarDeviceSensor(toon, 'solar', 'value',
|
||||
"Current Solar Production",
|
||||
'mdi:solar-power', POWER_WATT),
|
||||
ToonSolarDeviceSensor(toon, 'solar', 'maximum',
|
||||
"Max Solar Production", 'mdi:solar-power',
|
||||
POWER_WATT),
|
||||
ToonSolarDeviceSensor(toon, 'solar', 'produced',
|
||||
"Solar Production to Grid",
|
||||
'mdi:solar-power', POWER_WATT),
|
||||
ToonSolarDeviceSensor(toon, 'solar', 'average_produced',
|
||||
"Average Solar Production to Grid",
|
||||
'mdi:solar-power', POWER_WATT),
|
||||
ToonElectricityMeterDeviceSensor(toon, 'solar',
|
||||
'meter_reading_produced',
|
||||
"Power Meter Feed OUT Tariff 1",
|
||||
'mdi:solar-power',
|
||||
POWER_KWH),
|
||||
ToonElectricityMeterDeviceSensor(toon, 'solar',
|
||||
'meter_reading_low_produced',
|
||||
"Power Meter Feed OUT Tariff 2",
|
||||
'mdi:solar-power', POWER_KWH),
|
||||
])
|
||||
sensors.extend(
|
||||
[
|
||||
ToonSolarDeviceSensor(
|
||||
toon,
|
||||
'solar',
|
||||
'value',
|
||||
"Current Solar Production",
|
||||
'mdi:solar-power',
|
||||
POWER_WATT,
|
||||
),
|
||||
ToonSolarDeviceSensor(
|
||||
toon,
|
||||
'solar',
|
||||
'maximum',
|
||||
"Max Solar Production",
|
||||
'mdi:solar-power',
|
||||
POWER_WATT,
|
||||
),
|
||||
ToonSolarDeviceSensor(
|
||||
toon,
|
||||
'solar',
|
||||
'produced',
|
||||
"Solar Production to Grid",
|
||||
'mdi:solar-power',
|
||||
POWER_WATT,
|
||||
),
|
||||
ToonSolarDeviceSensor(
|
||||
toon,
|
||||
'solar',
|
||||
'average_produced',
|
||||
"Average Solar Production to Grid",
|
||||
'mdi:solar-power',
|
||||
POWER_WATT,
|
||||
),
|
||||
ToonElectricityMeterDeviceSensor(
|
||||
toon,
|
||||
'solar',
|
||||
'meter_reading_produced',
|
||||
"Power Meter Feed OUT Tariff 1",
|
||||
'mdi:solar-power',
|
||||
ENERGY_KILO_WATT_HOUR,
|
||||
),
|
||||
ToonElectricityMeterDeviceSensor(
|
||||
toon,
|
||||
'solar',
|
||||
'meter_reading_low_produced',
|
||||
"Power Meter Feed OUT Tariff 2",
|
||||
'mdi:solar-power',
|
||||
ENERGY_KILO_WATT_HOUR,
|
||||
),
|
||||
]
|
||||
)
|
||||
|
||||
if toon.thermostat_info.have_ot_boiler:
|
||||
sensors.extend([
|
||||
ToonBoilerDeviceSensor(toon, 'thermostat_info',
|
||||
'current_modulation_level',
|
||||
"Boiler Modulation Level",
|
||||
'mdi:percent',
|
||||
RATIO_PERCENT),
|
||||
])
|
||||
sensors.extend(
|
||||
[
|
||||
ToonBoilerDeviceSensor(
|
||||
toon,
|
||||
'thermostat_info',
|
||||
'current_modulation_level',
|
||||
"Boiler Modulation Level",
|
||||
'mdi:percent',
|
||||
RATIO_PERCENT,
|
||||
)
|
||||
]
|
||||
)
|
||||
|
||||
async_add_entities(sensors)
|
||||
async_add_entities(sensors, True)
|
||||
|
||||
|
||||
class ToonSensor(ToonEntity):
|
||||
"""Defines a Toon sensor."""
|
||||
|
||||
def __init__(self, toon, section: str, measurement: str,
|
||||
name: str, icon: str, unit_of_measurement: str) -> None:
|
||||
def __init__(
|
||||
self,
|
||||
toon: ToonData,
|
||||
section: str,
|
||||
measurement: str,
|
||||
name: str,
|
||||
icon: str,
|
||||
unit_of_measurement: str,
|
||||
) -> None:
|
||||
"""Initialize the Toon sensor."""
|
||||
self._state = None
|
||||
self._unit_of_measurement = unit_of_measurement
|
||||
@@ -119,8 +238,15 @@ class ToonSensor(ToonEntity):
|
||||
@property
|
||||
def unique_id(self) -> str:
|
||||
"""Return the unique ID for this sensor."""
|
||||
return '_'.join([DOMAIN, self.toon.agreement.id, 'sensor',
|
||||
self.section, self.measurement])
|
||||
return '_'.join(
|
||||
[
|
||||
DOMAIN,
|
||||
self.toon.agreement.id,
|
||||
'sensor',
|
||||
self.section,
|
||||
self.measurement,
|
||||
]
|
||||
)
|
||||
|
||||
@property
|
||||
def state(self):
|
||||
@@ -137,34 +263,46 @@ class ToonSensor(ToonEntity):
|
||||
section = getattr(self.toon, self.section)
|
||||
value = None
|
||||
|
||||
if not section:
|
||||
return
|
||||
|
||||
if self.section == 'power' and self.measurement == 'daily_value':
|
||||
value = round((float(section.daily_usage)
|
||||
+ float(section.daily_usage_low)) / 1000.0, 2)
|
||||
value = round(
|
||||
(float(section.daily_usage) + float(section.daily_usage_low))
|
||||
/ 1000.0,
|
||||
2,
|
||||
)
|
||||
|
||||
if value is None:
|
||||
value = getattr(section, self.measurement)
|
||||
|
||||
if self.section == 'power' and \
|
||||
self.measurement in ['meter_reading', 'meter_reading_low',
|
||||
'average_daily']:
|
||||
value = round(float(value)/1000.0, 2)
|
||||
if self.section == 'power' and self.measurement in [
|
||||
'meter_reading',
|
||||
'meter_reading_low',
|
||||
'average_daily',
|
||||
]:
|
||||
value = round(float(value) / 1000.0, 2)
|
||||
|
||||
if self.section == 'solar' and \
|
||||
self.measurement in ['meter_reading_produced',
|
||||
'meter_reading_low_produced']:
|
||||
value = float(value)/1000.0
|
||||
if self.section == 'solar' and self.measurement in [
|
||||
'meter_reading_produced',
|
||||
'meter_reading_low_produced',
|
||||
]:
|
||||
value = float(value) / 1000.0
|
||||
|
||||
if self.section == 'gas' and \
|
||||
self.measurement in ['average_daily', 'daily_usage',
|
||||
'meter_reading']:
|
||||
value = round(float(value)/1000.0, 2)
|
||||
if self.section == 'gas' and self.measurement in [
|
||||
'average_daily',
|
||||
'daily_usage',
|
||||
'meter_reading',
|
||||
]:
|
||||
value = round(float(value) / 1000.0, 2)
|
||||
|
||||
self._state = max(0, value)
|
||||
|
||||
|
||||
class ToonElectricityMeterDeviceSensor(ToonSensor,
|
||||
ToonElectricityMeterDeviceEntity):
|
||||
"""Defines a Eletricity Meter sensor."""
|
||||
class ToonElectricityMeterDeviceSensor(
|
||||
ToonSensor, ToonElectricityMeterDeviceEntity
|
||||
):
|
||||
"""Defines a Electricity Meter sensor."""
|
||||
|
||||
pass
|
||||
|
||||
|
||||
Reference in new issue
Block a user