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
|
"""Models for the Quby ToonAPI."""
from __future__ import annotations
from dataclasses import dataclass
from datetime import datetime, timezone
from typing import Any, Callable
from .const import (
ACTIVE_STATE_HOLIDAY,
BURNER_STATE_ON,
BURNER_STATE_PREHEATING,
BURNER_STATE_TAP_WATER,
PROGRAM_STATE_ON,
PROGRAM_STATE_OVERRIDE,
)
from .util import (
convert_boolean,
convert_cm3,
convert_datetime,
convert_kwh,
convert_lmin,
convert_m3,
convert_negative_none,
convert_temperature,
)
def process_data(
data: dict[str, Any],
key: str,
current_value: Any,
conversion: Callable[[Any], Any] | None = None,
) -> Any:
"""test."""
if key not in data:
return current_value
if data[key] is None:
return current_value
if conversion is None:
return data[key]
return conversion(data[key])
@dataclass
class Agreement:
"""Object holding a Toon customer utility Agreement."""
agreement_id_checksum: str | None = None
agreement_id: str | None = None
city: str | None = None
display_common_name: str | None = None
display_hardware_version: str | None = None
display_software_version: str | None = None
heating_type: str | None = None
house_number: str | None = None
is_toon_solar: bool | None = None
is_toonly: bool | None = None
postal_code: str | None = None
street: str | None = None
@staticmethod
def from_dict(data: dict[str, Any]) -> Agreement:
"""Return an Agreement object from a data dictionary."""
return Agreement(
agreement_id_checksum=data.get("agreementIdChecksum"),
agreement_id=data.get("agreementId"),
city=data.get("city"),
display_common_name=data.get("displayCommonName"),
display_hardware_version=data.get("displayHardwareVersion"),
display_software_version=data.get("displaySoftwareVersion"),
heating_type=data.get("heatingType"),
house_number=data.get("houseNumber"),
is_toon_solar=data.get("isToonSolar"),
is_toonly=data.get("isToonly"),
postal_code=data.get("postalCode"),
street=data.get("street"),
)
@dataclass
class ThermostatInfo:
"""Object holding Toon thermostat information."""
active_state: int | None = None
boiler_module_connected: bool | None = None
burner_state: int | None = None
current_display_temperature: float | None = None
current_humidity: int | None = None
current_modulation_level: int | None = None
current_setpoint: float | None = None
error_found: bool | None = None
has_boiler_fault: bool | None = None
have_opentherm_boiler: bool | None = None
holiday_mode: bool | None = None
next_program: int | None = None
next_setpoint: float | None = None
next_state: int | None = None
next_time: datetime | None = None
opentherm_communication_error: bool | None = None
program_state: int | None = None
real_setpoint: float | None = None
set_by_load_shifthing: int | None = None
last_updated_from_display: datetime | None = None
last_updated: datetime = datetime.now(tz=timezone.utc).replace(tzinfo=None)
@property
def burner(self) -> bool | None:
"""Return if burner is on based on its state."""
if self.burner_state is None:
return None
return bool(self.burner_state)
@property
def hot_tapwater(self) -> bool | None:
"""Return if burner is on based on its state."""
if self.burner_state is None:
return None
return self.burner_state == BURNER_STATE_TAP_WATER
@property
def heating(self) -> bool | None:
"""Return if burner is pre heating based on its state."""
if self.burner_state is None:
return None
return self.burner_state == BURNER_STATE_ON
@property
def pre_heating(self) -> bool | None:
"""Return if burner is pre heating based on its state."""
if self.burner_state is None:
return None
return self.burner_state == BURNER_STATE_PREHEATING
@property
def program(self) -> bool | None:
"""Return if program mode is turned on."""
if self.program_state is None:
return None
return self.program_state in [PROGRAM_STATE_ON, PROGRAM_STATE_OVERRIDE]
@property
def program_overridden(self) -> bool | None:
"""Return if program mode is overriden."""
if self.program_state is None:
return None
return self.program_state == PROGRAM_STATE_OVERRIDE
def update_from_dict(self, data: dict[str, Any]) -> None:
"""Update this ThermostatInfo object with data from a dictionary."""
self.active_state = process_data(
data, "activeState", self.active_state, convert_negative_none
)
self.boiler_module_connected = process_data(
data, "boilerModuleConnected", self.boiler_module_connected, convert_boolean
)
self.burner_state = process_data(data, "burnerInfo", self.burner_state, int)
self.current_display_temperature = process_data(
data,
"currentDisplayTemp",
self.current_display_temperature,
convert_temperature,
)
self.current_humidity = process_data(
data, "currentHumidity", self.current_humidity
)
self.current_modulation_level = process_data(
data, "currentModulationLevel", self.current_modulation_level
)
self.current_setpoint = process_data(
data, "currentSetpoint", self.current_setpoint, convert_temperature
)
self.error_found = process_data(
data, "errorFound", self.error_found, lambda x: x != 255
)
self.has_boiler_fault = process_data(
data, "hasBoilerFault", self.has_boiler_fault, convert_boolean
)
self.have_opentherm_boiler = process_data(
data, "haveOTBoiler", self.have_opentherm_boiler, convert_boolean
)
self.holiday_mode = process_data(
data, "activeState", self.holiday_mode, lambda x: x == ACTIVE_STATE_HOLIDAY
)
self.next_program = process_data(
data, "nextProgram", self.next_program, convert_negative_none
)
self.next_setpoint = process_data(
data, "nextSetpoint", self.next_setpoint, convert_temperature
)
self.next_state = process_data(
data, "nextState", self.next_state, convert_negative_none
)
self.next_time = process_data(
data, "nextTime", self.next_state, convert_datetime
)
self.opentherm_communication_error = process_data(
data, "otCommError", self.opentherm_communication_error, convert_boolean
)
self.program_state = process_data(data, "programState", self.program_state)
self.real_setpoint = process_data(
data, "realSetpoint", self.real_setpoint, convert_temperature
)
self.set_by_load_shifthing = process_data(
data, "setByLoadShifting", self.set_by_load_shifthing, convert_boolean
)
self.last_updated_from_display = process_data(
data,
"lastUpdatedFromDisplay",
self.last_updated_from_display,
convert_datetime,
)
self.last_updated = datetime.now(tz=timezone.utc).replace(tzinfo=None)
@dataclass
class PowerUsage:
"""Object holding Toon power usage information."""
average_produced: float | None = None
average_solar: float | None = None
average: float | None = None
current_produced: int | None = None
current_solar: int | None = None
current: int | None = None
day_average: float | None = None
day_cost: float | None = None
day_high_usage: float | None = None
day_low_usage: float | None = None
day_max_solar: int | None = None
day_produced_solar: float | None = None
is_smart: bool | None = None
meter_high: float | None = None
meter_low: float | None = None
meter_produced_high: float | None = None
meter_produced_low: float | None = None
last_updated_from_display: datetime | None = None
last_updated: datetime = datetime.now(tz=timezone.utc).replace(tzinfo=None)
@property
def day_usage(self) -> float | None:
"""Calculate day total usage."""
if self.day_high_usage is None or self.day_low_usage is None:
return None
return round(self.day_high_usage + self.day_low_usage, 2)
@property
def day_to_grid_usage(self) -> float | None:
"""Calculate day total to grid."""
if self.day_usage is None or self.day_produced_solar is None:
return None
return abs(min(0.0, round(self.day_usage - self.day_produced_solar, 2)))
@property
def day_from_grid_usage(self) -> float | None:
"""Calculate day total to grid."""
if self.day_produced_solar is None or self.day_usage is None:
return None
return abs(min(0.0, round(self.day_produced_solar - self.day_usage, 2)))
@property
def current_covered_by_solar(self) -> int | None:
"""Calculate current solar covering current usage."""
if self.current_solar is None or self.current is None:
return None
if self.current == 0:
return 0
return min(100, round((self.current_solar / self.current) * 100))
def update_from_dict(self, data: dict[str, Any]) -> None:
"""Update this PowerUsage object with data from a dictionary."""
self.average = process_data(data, "avgValue", self.average)
self.average_produced = process_data(
data, "avgProduValue", self.average_produced
)
self.average_solar = process_data(data, "avgSolarValue", self.average_solar)
self.current = process_data(data, "value", self.current, round)
self.current_produced = process_data(
data, "valueProduced", self.current_produced, round
)
self.current_solar = process_data(data, "valueSolar", self.current_solar, round)
self.day_average = process_data(
data, "avgDayValue", self.day_average, convert_kwh
)
self.day_cost = process_data(data, "dayCost", self.day_cost)
self.day_high_usage = process_data(
data, "dayUsage", self.day_high_usage, convert_kwh
)
self.day_low_usage = process_data(
data, "dayLowUsage", self.day_low_usage, convert_kwh
)
self.day_max_solar = process_data(data, "maxSolar", self.day_max_solar)
self.day_produced_solar = process_data(
data, "solarProducedToday", self.day_produced_solar, convert_kwh
)
self.is_smart = process_data(data, "isSmart", self.is_smart, convert_boolean)
self.meter_high = process_data(
data, "meterReading", self.meter_high, convert_kwh
)
self.meter_low = process_data(
data, "meterReadingLow", self.meter_low, convert_kwh
)
self.meter_produced_high = process_data(
data, "meterReadingProdu", self.meter_high, convert_kwh
)
self.meter_produced_low = process_data(
data, "meterReadingLowProdu", self.meter_produced_low, convert_kwh
)
self.last_updated_from_display = process_data(
data,
"lastUpdatedFromDisplay",
self.last_updated_from_display,
convert_datetime,
)
self.last_updated = datetime.now(tz=timezone.utc).replace(tzinfo=None)
@dataclass
class GasUsage:
"""Object holding Toon gas usage information."""
average: float | None = None
current: float | None = None
day_average: float | None = None
day_cost: float | None = None
day_usage: float | None = None
is_smart: bool | None = None
meter: float | None = None
last_updated_from_display: datetime | None = None
last_updated: datetime = datetime.now(tz=timezone.utc).replace(tzinfo=None)
def update_from_dict(self, data: dict[str, Any]) -> None:
"""Update this GasUsage object with data from a dictionary."""
self.average = process_data(data, "avgValue", self.average, convert_cm3)
self.current = process_data(data, "value", self.current, convert_cm3)
self.day_average = process_data(
data, "avgDayValue", self.day_average, convert_cm3
)
self.day_cost = process_data(data, "dayCost", self.day_cost)
self.day_usage = process_data(data, "dayUsage", self.day_usage, convert_cm3)
self.is_smart = process_data(data, "isSmart", self.is_smart, convert_boolean)
self.meter = process_data(data, "meterReading", self.meter, convert_cm3)
self.last_updated_from_display = process_data(
data,
"lastUpdatedFromDisplay",
self.last_updated_from_display,
convert_datetime,
)
self.last_update = datetime.now(tz=timezone.utc).replace(tzinfo=None)
@dataclass
class WaterUsage:
"""Object holding Toon water usage information."""
average: float | None = None
current: float | None = None
day_average: float | None = None
day_cost: float | None = None
day_usage: float | None = None
installed: bool | None = None
is_smart: bool | None = None
meter: float | None = None
last_updated_from_display: datetime | None = None
last_updated = datetime.now(tz=timezone.utc).replace(tzinfo=None)
def update_from_dict(self, data: dict[str, Any]) -> None:
"""Update this WaterUsage object with data from a dictionary."""
self.average = process_data(data, "avgValue", self.average, convert_lmin)
self.current = process_data(data, "value", self.current, convert_lmin)
self.day_average = process_data(
data, "avgDayValue", self.day_average, convert_m3
)
self.day_cost = process_data(data, "dayCost", self.day_cost)
self.day_usage = process_data(data, "dayUsage", self.day_usage, convert_m3)
self.installed = process_data(
data, "installed", self.installed, convert_boolean
)
self.is_smart = process_data(data, "isSmart", self.is_smart, convert_boolean)
self.meter = process_data(data, "meterReading", self.meter, convert_m3)
self.last_updated_from_display = process_data(
data,
"lastUpdatedFromDisplay",
self.last_updated_from_display,
convert_datetime,
)
self.last_update = datetime.now(tz=timezone.utc).replace(tzinfo=None)
class Status:
"""Object holding all status information for this ToonAPI instance."""
agreement: Agreement
thermostat: ThermostatInfo = ThermostatInfo()
power_usage: PowerUsage = PowerUsage()
gas_usage: GasUsage = GasUsage()
water_usage: WaterUsage = WaterUsage()
last_updated_from_display: datetime | None = None
last_updated: datetime = datetime.now(tz=timezone.utc).replace(tzinfo=None)
server_time: datetime | None = None
def __init__(self, agreement: Agreement):
"""Initialize an empty ToonAPI Status class."""
self.agreement = agreement
def update_from_dict(self, data: dict[str, Any]) -> Status:
"""Update the status object with data received from the ToonAPI."""
if "thermostatInfo" in data:
self.thermostat.update_from_dict(data["thermostatInfo"])
if "powerUsage" in data:
self.power_usage.update_from_dict(data["powerUsage"])
if "gasUsage" in data:
self.gas_usage.update_from_dict(data["gasUsage"])
if "waterUsage" in data:
self.water_usage.update_from_dict(data["waterUsage"])
if "lastUpdateFromDisplay" in data:
self.last_updated_from_display = convert_datetime(
data["lastUpdateFromDisplay"]
)
if "serverTime" in data:
self.server_time = convert_datetime(data["serverTime"])
self.last_updated = datetime.now(tz=timezone.utc).replace(tzinfo=None)
return self
|