289ccc7bb7
* implementing max_on_percent setting * remove % sign from log message * README updated: created new export-mode section, moved self-regulation expert settings to new section, added new section about on-time clamping
230 lines
8.4 KiB
Python
230 lines
8.4 KiB
Python
""" The TPI calculation module """
|
|
# pylint: disable='line-too-long'
|
|
import logging
|
|
|
|
from homeassistant.components.climate import HVACMode
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
PROPORTIONAL_FUNCTION_ATAN = "atan"
|
|
PROPORTIONAL_FUNCTION_LINEAR = "linear"
|
|
PROPORTIONAL_FUNCTION_TPI = "tpi"
|
|
|
|
PROPORTIONAL_MIN_DURATION_SEC = 10
|
|
|
|
FUNCTION_TYPE = [PROPORTIONAL_FUNCTION_ATAN, PROPORTIONAL_FUNCTION_LINEAR]
|
|
|
|
|
|
def is_number(value):
|
|
"""check if value is a number"""
|
|
return isinstance(value, (int, float))
|
|
|
|
|
|
class PropAlgorithm:
|
|
"""This class aims to do all calculation of the Proportional alogorithm"""
|
|
|
|
def __init__(
|
|
self,
|
|
function_type: str,
|
|
tpi_coef_int,
|
|
tpi_coef_ext,
|
|
cycle_min: int,
|
|
minimal_activation_delay: int,
|
|
vtherm_entity_id: str = None,
|
|
max_on_percent: float = None,
|
|
) -> None:
|
|
"""Initialisation of the Proportional Algorithm"""
|
|
_LOGGER.debug(
|
|
"%s - Creation new PropAlgorithm function_type: %s, tpi_coef_int: %s, tpi_coef_ext: %s, cycle_min:%d, minimal_activation_delay:%d", # pylint: disable=line-too-long
|
|
vtherm_entity_id,
|
|
function_type,
|
|
tpi_coef_int,
|
|
tpi_coef_ext,
|
|
cycle_min,
|
|
minimal_activation_delay,
|
|
)
|
|
|
|
# Issue 506 - check parameters
|
|
if (
|
|
vtherm_entity_id is None
|
|
or not is_number(tpi_coef_int)
|
|
or not is_number(tpi_coef_ext)
|
|
or not is_number(cycle_min)
|
|
or not is_number(minimal_activation_delay)
|
|
or function_type != PROPORTIONAL_FUNCTION_TPI
|
|
):
|
|
_LOGGER.error(
|
|
"%s - configuration is wrong. function_type=%s, entity_id is %s, tpi_coef_int is %s, tpi_coef_ext is %s, cycle_min is %s, minimal_activation_delay is %s",
|
|
vtherm_entity_id,
|
|
function_type,
|
|
vtherm_entity_id,
|
|
tpi_coef_int,
|
|
tpi_coef_ext,
|
|
cycle_min,
|
|
minimal_activation_delay,
|
|
)
|
|
raise TypeError(
|
|
"TPI parameters are not set correctly. VTherm will not work as expected. Please reconfigure it correctly. See previous log for values"
|
|
)
|
|
|
|
self._vtherm_entity_id = vtherm_entity_id
|
|
self._function = function_type
|
|
self._tpi_coef_int = tpi_coef_int
|
|
self._tpi_coef_ext = tpi_coef_ext
|
|
self._cycle_min = cycle_min
|
|
self._minimal_activation_delay = minimal_activation_delay
|
|
self._on_percent = 0
|
|
self._calculated_on_percent = 0
|
|
self._on_time_sec = 0
|
|
self._off_time_sec = self._cycle_min * 60
|
|
self._security = False
|
|
self._default_on_percent = 0
|
|
self._max_on_percent = max_on_percent
|
|
|
|
def calculate(
|
|
self,
|
|
target_temp: float | None,
|
|
current_temp: float | None,
|
|
ext_current_temp: float | None,
|
|
hvac_mode: HVACMode,
|
|
):
|
|
"""Do the calculation of the duration"""
|
|
if target_temp is None or current_temp is None:
|
|
log = _LOGGER.debug if hvac_mode == HVACMode.OFF else _LOGGER.warning
|
|
log(
|
|
"%s - Proportional algorithm: calculation is not possible cause target_temp (%s) or current_temp (%s) is null. Heating/cooling will be disabled. This could be normal at startup", # pylint: disable=line-too-long
|
|
self._vtherm_entity_id,
|
|
target_temp,
|
|
current_temp,
|
|
)
|
|
self._calculated_on_percent = 0
|
|
else:
|
|
if hvac_mode == HVACMode.COOL:
|
|
delta_temp = current_temp - target_temp
|
|
delta_ext_temp = (
|
|
ext_current_temp - target_temp
|
|
if ext_current_temp is not None
|
|
else 0
|
|
)
|
|
else:
|
|
delta_temp = target_temp - current_temp
|
|
delta_ext_temp = (
|
|
target_temp - ext_current_temp
|
|
if ext_current_temp is not None
|
|
else 0
|
|
)
|
|
|
|
if self._function == PROPORTIONAL_FUNCTION_TPI:
|
|
self._calculated_on_percent = (
|
|
self._tpi_coef_int * delta_temp
|
|
+ self._tpi_coef_ext * delta_ext_temp
|
|
)
|
|
else:
|
|
_LOGGER.warning(
|
|
"%s - Proportional algorithm: unknown %s function. Heating will be disabled",
|
|
self._vtherm_entity_id,
|
|
self._function,
|
|
)
|
|
self._calculated_on_percent = 0
|
|
|
|
self._calculate_internal()
|
|
|
|
_LOGGER.debug(
|
|
"%s - heating percent calculated for current_temp %.1f, ext_current_temp %.1f and target_temp %.1f is %.2f, on_time is %d (sec), off_time is %d (sec)", # pylint: disable=line-too-long
|
|
self._vtherm_entity_id,
|
|
current_temp if current_temp else -9999.0,
|
|
ext_current_temp if ext_current_temp else -9999.0,
|
|
target_temp if target_temp else -9999.0,
|
|
self._calculated_on_percent,
|
|
self.on_time_sec,
|
|
self.off_time_sec,
|
|
)
|
|
|
|
def _calculate_internal(self):
|
|
"""Finish the calculation to get the on_percent in seconds"""
|
|
|
|
# calculated on_time duration in seconds
|
|
if self._calculated_on_percent > 1:
|
|
self._calculated_on_percent = 1
|
|
if self._calculated_on_percent < 0:
|
|
self._calculated_on_percent = 0
|
|
|
|
if self._security:
|
|
self._on_percent = self._default_on_percent
|
|
_LOGGER.info(
|
|
"%s - Security is On using the default_on_percent %f",
|
|
self._vtherm_entity_id,
|
|
self._on_percent,
|
|
)
|
|
else:
|
|
_LOGGER.debug(
|
|
"Security is Off using the calculated_on_percent %f",
|
|
self._calculated_on_percent,
|
|
)
|
|
self._on_percent = self._calculated_on_percent
|
|
|
|
if self._max_on_percent is not None and self._on_percent > self._max_on_percent:
|
|
_LOGGER.debug(
|
|
"%s - Heating period clamped to %s (instead of %s) due to max_on_percent setting.",
|
|
self._vtherm_entity_id,
|
|
self._max_on_percent,
|
|
self._on_percent,
|
|
)
|
|
self._on_percent = self._max_on_percent
|
|
|
|
self._on_time_sec = self._on_percent * self._cycle_min * 60
|
|
|
|
# Do not heat for less than xx sec
|
|
if self._on_time_sec < self._minimal_activation_delay:
|
|
if self._on_time_sec > 0:
|
|
_LOGGER.info(
|
|
"%s - No heating period due to heating period too small (%f < %f)",
|
|
self._vtherm_entity_id,
|
|
self._on_time_sec,
|
|
self._minimal_activation_delay,
|
|
)
|
|
self._on_time_sec = 0
|
|
|
|
self._off_time_sec = self._cycle_min * 60 - self._on_time_sec
|
|
|
|
def set_security(self, default_on_percent: float):
|
|
"""Set a default value for on_percent (used for safety mode)"""
|
|
_LOGGER.info(
|
|
"%s - Proportional Algo - set security to ON", self._vtherm_entity_id
|
|
)
|
|
self._security = True
|
|
self._default_on_percent = default_on_percent
|
|
self._calculate_internal()
|
|
|
|
def unset_security(self):
|
|
"""Unset the safety mode"""
|
|
_LOGGER.info(
|
|
"%s - Proportional Algo - set security to OFF", self._vtherm_entity_id
|
|
)
|
|
self._security = False
|
|
self._calculate_internal()
|
|
|
|
@property
|
|
def on_percent(self) -> float:
|
|
"""Returns the percentage the heater must be ON
|
|
In safety mode this value is overriden with the _default_on_percent
|
|
(1 means the heater will be always on, 0 never on)""" # pylint: disable=line-too-long
|
|
return round(self._on_percent, 2)
|
|
|
|
@property
|
|
def calculated_on_percent(self) -> float:
|
|
"""Returns the calculated percentage the heater must be ON
|
|
Calculated means NOT overriden even in safety mode
|
|
(1 means the heater will be always on, 0 never on)""" # pylint: disable=line-too-long
|
|
return round(self._calculated_on_percent, 2)
|
|
|
|
@property
|
|
def on_time_sec(self) -> int:
|
|
"""Returns the calculated time in sec the heater must be ON"""
|
|
return int(self._on_time_sec)
|
|
|
|
@property
|
|
def off_time_sec(self) -> int:
|
|
"""Returns the calculated time in sec the heater must be OFF"""
|
|
return int(self._off_time_sec)
|