[WIP] Add dual thermostat actor, for climate integrations with a temperature range

docs/apps/schedy/actors/dualthermostat/config.yaml

@@ -0,0 +1,33 @@
+# Delta that is added to the temperature value sent to this
+# thermostat in order to correct potential inaccuracies of
+# the temperature sensor.
+#high_delta: 0
+#low_delta: 0
+
+# The minimum/maximum temperature the thermostat supports.
+# If configured, temperatures outside the supported range are changed
+# to the minimum/maximum value before they're sent to the thermostat.
+# null means there is no limitation.
+#high_min_temp: null
+#high_max_temp: null
+#low_min_temp: null
+#low_max_temp: null
+
+# When this is set to something different than "OFF", Schedy will
+# rewrite the value OFF into this temperature before sending it to
+# the thermostat. You can set it to 4.0 degrees (if your thermostat
+# supports this low value) in order to prevent frost-induced damage
+# to your heating setup.
+# This setting is required when you want to send OFF to thermostats with
+# disabled HVAC mode support.
+#off_temp: "OFF"
+
+# Set this to false if your thermostat doesn't support HVAC modes.
+# Please note that you won't be able to turn it off completely without
+# HVAC mode support. Remember to also configure off_temp when you
+# disable this feature.
+#supports_hvac_modes: true
+
+# These two settings can be used to tweak the names of the HVAC modes.
+#hvac_mode_on: "heat_cool"
+#hvac_mode_off: "off"

docs/apps/schedy/actors/dualthermostat/index.rst

@@ -0,0 +1,99 @@
+Dual Thermostat
+==========
+
+The ``dualthermostat`` actor is used to control the temperature of climate
+entities.
+
+Often, people ask me whether Schedy can be used with their particular
+heating setup. I always tend to repeat myself in these situations,
+hence I want to explain here what the exact preconditions for using
+Schedy for heating control actually are.
+
+1. You need at least one thermostat in each room you want to control.
+   Such a thermostat must be recognized as a climate entity in Home
+   Assistant, and setting the target temperature from the Home Assistant
+   web interface should work reliably. Wall thermostats can be controlled
+   the same way as radiator thermostats, as long as they fulfill these
+   conditions as well. If you only have a switchable heater and an
+   external temperature sensor, have a look at Home Assistant's `Generic
+   Thermostat platform`_ to build a virtual thermostat first.
+
+2. If your thermostat is used for both heating and cooling, there has
+   to be an automatic HVAC mode which does heating/cooling based
+   on the difference between current and set target temperature. Schedy
+   will only switch the HVAC mode between on and off (exact names
+   can be configured) and set the target temperature according to the
+   room's schedule.
+
+.. _`Generic Thermostat platform`: https://home-assistant.io/components/climate.generic_thermostat/
+
+If you are happy with these points and your setup fulfills them, there
+should be nothing stopping you from integrating Schedy's great scheduling
+capabilities with your home's heating. You can then go on and create a
+Schedy configuration with thermostat actors.
+
+
+Configuration
+-------------
+
+.. include:: ../config.rst.inc
+
+
+Supported Values
+----------------
+
+Your schedules must generate tuples of valid temperature values. Those can be
+integers (``(18, 20)``), floats (``(19.5, 21.5)``), or a mixture of both (``(18.5, 21)``).
+
+A special value is ``OFF``, which is an object available in the evaluation
+environment when using the thermostat actor type. If this object is
+returned from an expression, it will turn the thermostats off. The
+equivalent for the ``OFF`` object to use when using plain values instead
+of expressions is the string ``"OFF"`` (case-insensitive).
+
+.. note::
+
+   When working with the ``Add()`` :doc:`postprocessor
+   <../../schedules/expressions/postprocessors>` and the result is
+   ``OFF``, it will stay ``OFF``, no matter what's being added to it.
+
+
+Statistical Parameters
+----------------------
+
+.. include:: ../statistics-intro.rst.inc
+
+
+``high_temp_delta``
+~~~~~~~~~~~~~~
+
+This parameter measures the difference between the high target and current
+temperature for all thermostats in the associated rooms. It can be used
+to control a source of heating energy, such as a fuel oven, with Home
+Assistant automations.
+
+Options provided because this is a ``TempDeltaParameter``:
+
+* ``off_value``: Specify how to handle thermostats which are turned
+  off. Specify either the number to assume as the delta or ``null``, which
+  causes the thermostat to be excluded from statistics collection. The
+  default value is ``0``.
+
+``low_temp_delta``
+~~~~~~~~~~~~~~
+
+This parameter measures the difference between the low target and current
+temperature for all thermostats in the associated rooms. It can be used
+to control a source of heating energy, such as a compressor, with Home
+Assistant automations.
+
+Options provided because this is a ``TempDeltaParameter``:
+
+* ``off_value``: Specify how to handle thermostats which are turned
+  off. Specify either the number to assume as the delta or ``null``, which
+  causes the thermostat to be excluded from statistics collection. The
+  default value is ``0``.
+
+.. include:: ../../statistics/actor-value-collector.rst.inc
+
+.. include:: ../../statistics/min-avg-max-parameter.rst.inc

hass_apps/schedy/__init__.py

@@ -3,4 +3,4 @@
 various sub-modules.
 """
 
-__version__ = "0.8.3"
+__version__ = "0.8.3_JM"

hass_apps/schedy/actor/__init__.py

@@ -10,6 +10,7 @@
 from .generic2 import Generic2Actor
 from .switch import SwitchActor
 from .thermostat import ThermostatActor
+from .dualthermostat import DualThermostatActor
 
 
 __all__ = [
@@ -19,6 +20,7 @@
     "Generic2Actor",
     "SwitchActor",
     "ThermostatActor",
+    "DualThermostatActor",
 ]