Merge pull request #671 from plugwise/anna-control-state

bouwew · web-flow · commit ea0946e8c069 · 2024-12-14T09:52:13.000+01:00
Add control_state to Anna output
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,12 +1,13 @@
 # Changelog
 
-## Ongoing
+## v1.6.4
 
 - Continuous improvements [#662](https://github.com/plugwise/python-plugwise/pull/662)
 - Rework tooling [#664](https://github.com/plugwise/python-plugwise/pull/664)
 - Archive p1v4 userdata [#666](https://github.com/plugwise/python-plugwise/pull/666)
 - Correct manual_fixtures script [#668](https://github.com/plugwise/python-plugwise/pull/668)
 - Improve P1 fault-handling, continuous improvements [#670](https://github.com/plugwise/python-plugwise/pull/670)
+- Add control_state to Anna output [#671](https://github.com/plugwise/python-plugwise/pull/671)
 
 ## v1.6.3
 
diff --git a/fixtures/anna_elga_2/all_data.json b/fixtures/anna_elga_2/all_data.json
@@ -39,6 +39,7 @@
       "active_preset": "home",
       "available_schedules": ["Thermostat schedule", "off"],
       "climate_mode": "auto",
+      "control_state": "idle",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/anna_elga_2_cooling/all_data.json b/fixtures/anna_elga_2_cooling/all_data.json
@@ -39,6 +39,7 @@
       "active_preset": "home",
       "available_schedules": ["Thermostat schedule", "off"],
       "climate_mode": "auto",
+      "control_state": "cooling",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/anna_elga_2_schedule_off/all_data.json b/fixtures/anna_elga_2_schedule_off/all_data.json
@@ -39,6 +39,7 @@
       "active_preset": "home",
       "available_schedules": ["Thermostat schedule", "off"],
       "climate_mode": "heat_cool",
+      "control_state": "idle",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/anna_elga_no_cooling/all_data.json b/fixtures/anna_elga_no_cooling/all_data.json
@@ -60,6 +60,7 @@
       "active_preset": "home",
       "available_schedules": ["standaard", "off"],
       "climate_mode": "auto",
+      "control_state": "heating",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/anna_heatpump_cooling/all_data.json b/fixtures/anna_heatpump_cooling/all_data.json
@@ -57,6 +57,7 @@
       "active_preset": "home",
       "available_schedules": ["standaard", "off"],
       "climate_mode": "heat_cool",
+      "control_state": "cooling",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/anna_heatpump_cooling_fake_firmware/all_data.json b/fixtures/anna_heatpump_cooling_fake_firmware/all_data.json
@@ -57,6 +57,7 @@
       "active_preset": "home",
       "available_schedules": ["standaard", "off"],
       "climate_mode": "heat_cool",
+      "control_state": "cooling",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/anna_heatpump_heating/all_data.json b/fixtures/anna_heatpump_heating/all_data.json
@@ -62,6 +62,7 @@
       "active_preset": "home",
       "available_schedules": ["standaard", "off"],
       "climate_mode": "auto",
+      "control_state": "heating",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/anna_loria_cooling_active/all_data.json b/fixtures/anna_loria_cooling_active/all_data.json
@@ -4,6 +4,7 @@
       "active_preset": "home",
       "available_schedules": ["Winter", "Test ", "off"],
       "climate_mode": "auto",
+      "control_state": "cooling",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/anna_loria_driessens/all_data.json b/fixtures/anna_loria_driessens/all_data.json
@@ -27,6 +27,7 @@
         "off"
       ],
       "climate_mode": "auto",
+      "control_state": "idle",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/anna_loria_heating_idle/all_data.json b/fixtures/anna_loria_heating_idle/all_data.json
@@ -4,6 +4,7 @@
       "active_preset": "home",
       "available_schedules": ["Winter", "Test ", "off"],
       "climate_mode": "auto",
+      "control_state": "idle",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/anna_v4/all_data.json b/fixtures/anna_v4/all_data.json
@@ -4,6 +4,7 @@
       "active_preset": "home",
       "available_schedules": ["Standaard", "Thuiswerken", "off"],
       "climate_mode": "heat",
+      "control_state": "heating",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/anna_v4_dhw/all_data.json b/fixtures/anna_v4_dhw/all_data.json
@@ -4,6 +4,7 @@
       "active_preset": "home",
       "available_schedules": ["Standaard", "Thuiswerken", "off"],
       "climate_mode": "heat",
+      "control_state": "idle",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/anna_v4_no_tag/all_data.json b/fixtures/anna_v4_no_tag/all_data.json
@@ -4,6 +4,7 @@
       "active_preset": "home",
       "available_schedules": ["Standaard", "Thuiswerken", "off"],
       "climate_mode": "auto",
+      "control_state": "heating",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/anna_without_boiler_fw441/all_data.json b/fixtures/anna_without_boiler_fw441/all_data.json
@@ -4,6 +4,7 @@
       "active_preset": "home",
       "available_schedules": ["Test", "Normaal", "off"],
       "climate_mode": "auto",
+      "control_state": "idle",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/legacy_anna/all_data.json b/fixtures/legacy_anna/all_data.json
@@ -37,6 +37,7 @@
     "0d266432d64443e283b5d708ae98b455": {
       "active_preset": "home",
       "climate_mode": "heat",
+      "control_state": "heating",
       "dev_class": "thermostat",
       "firmware": "2017-03-13T11:54:58+01:00",
       "hardware": "6539-1301-500",
diff --git a/fixtures/legacy_anna_2/all_data.json b/fixtures/legacy_anna_2/all_data.json
@@ -4,6 +4,7 @@
       "active_preset": null,
       "available_schedules": ["Thermostat schedule", "off"],
       "climate_mode": "heat",
+      "control_state": "idle",
       "dev_class": "thermostat",
       "firmware": "2017-03-13T11:54:58+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/m_adam_jip/all_data.json b/fixtures/m_adam_jip/all_data.json
@@ -3,7 +3,6 @@
     "06aecb3d00354375924f50c47af36bd2": {
       "active_preset": "no_frost",
       "climate_mode": "off",
-      "control_state": "idle",
       "dev_class": "climate",
       "model": "ThermoZone",
       "name": "Slaapkamer",
diff --git a/fixtures/m_anna_heatpump_cooling/all_data.json b/fixtures/m_anna_heatpump_cooling/all_data.json
@@ -62,6 +62,7 @@
       "active_preset": "home",
       "available_schedules": ["standaard", "off"],
       "climate_mode": "auto",
+      "control_state": "cooling",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/fixtures/m_anna_heatpump_idle/all_data.json b/fixtures/m_anna_heatpump_idle/all_data.json
@@ -62,6 +62,7 @@
       "active_preset": "home",
       "available_schedules": ["standaard", "off"],
       "climate_mode": "auto",
+      "control_state": "idle",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/plugwise/data.py b/plugwise/data.py
@@ -167,13 +167,14 @@ def _get_location_data(self, loc_id: str) -> GwEntityData:
         """
         zone = self._zones[loc_id]
         data = self._get_zone_data(loc_id)
-        if ctrl_state := self._control_state(data, loc_id):
-            if str(ctrl_state) in ("cooling", "heating", "preheating"):
-                data["control_state"] = str(ctrl_state)
-                self._count += 1
-            if str(ctrl_state) == "off":
-                data["control_state"] = "idle"
-                self._count += 1
+        data["control_state"] = "idle"
+        self._count += 1
+        if (ctrl_state := self._control_state(data, loc_id)) and str(ctrl_state) in (
+            "cooling",
+            "heating",
+            "preheating",
+        ):
+            data["control_state"] = str(ctrl_state)
 
         data["sensors"].pop("setpoint")  # remove, only used in _control_state()
         self._count -= 1
@@ -211,6 +212,7 @@ def _get_entity_data(self, entity_id: str) -> GwEntityData:
         # Thermostat data for Anna (presets, temperatures etc)
         if self.smile(ANNA) and entity["dev_class"] == "thermostat":
             self._climate_data(entity_id, entity, data)
+            self._get_anna_control_state(data)
 
         return data
 
@@ -308,6 +310,19 @@ def check_reg_mode(self, mode: str) -> bool:
             "regulation_modes" in gateway and gateway["select_regulation_mode"] == mode
         )
 
+    def _get_anna_control_state(self, data: GwEntityData) -> None:
+        """Set the thermostat control_state based on the opentherm/onoff device state."""
+        data["control_state"] = "idle"
+        for entity in self.gw_entities.values():
+            if entity["dev_class"] != "heater_central":
+                continue
+
+            binary_sensors = entity["binary_sensors"]
+            if binary_sensors["heating_state"]:
+                data["control_state"] = "heating"
+            if binary_sensors.get("cooling_state"):
+                data["control_state"] = "cooling"
+
     def _get_schedule_states_with_off(
         self, location: str, schedules: list[str], selected: str, data: GwEntityData
     ) -> None:
diff --git a/plugwise/legacy/data.py b/plugwise/legacy/data.py
@@ -64,6 +64,7 @@ def _get_entity_data(self, entity_id: str) -> GwEntityData:
 
         # Thermostat data (presets, temperatures etc)
         self._climate_data(entity, data)
+        self._get_anna_control_state(data)
 
         return data
 
@@ -92,3 +93,14 @@ def _climate_data(self, entity: GwEntityData, data: GwEntityData) -> None:
         self._count += 1
         if sel_schedule in (NONE, OFF):
             data["climate_mode"] = "heat"
+
+    def _get_anna_control_state(self, data: GwEntityData) -> None:
+        """Set the thermostat control_state based on the opentherm/onoff device state."""
+        data["control_state"] = "idle"
+        for entity in self.gw_entities.values():
+            if entity["dev_class"] != "heater_central":
+                continue
+
+            binary_sensors = entity["binary_sensors"]
+            if binary_sensors["heating_state"]:
+                data["control_state"] = "heating"
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name            = "plugwise"
-version         = "1.6.3"
+version         = "1.6.4"
 license         = {file = "LICENSE"}
 description     = "Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3."
 readme          = "README.md"
diff --git a/scripts/manual_fixtures.py b/scripts/manual_fixtures.py
@@ -49,8 +49,10 @@ def json_writer(manual_name: str, all_data: dict) -> None:
 
 adam_jip = base.copy()
 
-# Change mode to off for "06aecb3d00354375924f50c47af36bd2"
+# Change mode to off for "06aecb3d00354375924f50c47af36bd2" for testcoverage in HA Core
 adam_jip["devices"]["06aecb3d00354375924f50c47af36bd2"]["climate_mode"] = "off"
+# Remove control_state for testcoverage of missing control_state in HA Core
+adam_jip["devices"]["06aecb3d00354375924f50c47af36bd2"].pop("control_state")
 
 json_writer("m_adam_jip", adam_jip)
 
@@ -298,6 +300,7 @@ def json_writer(manual_name: str, all_data: dict) -> None:
 ] = 28.2
 
 # Go for 3cb7
+m_anna_heatpump_cooling["devices"]["3cb70739631c4d17a86b8b12e8a5161b"]["control_state"] = "cooling"
 m_anna_heatpump_cooling["devices"]["3cb70739631c4d17a86b8b12e8a5161b"]["thermostat"][
     "setpoint_low"
 ] = 20.5
@@ -350,7 +353,7 @@ def json_writer(manual_name: str, all_data: dict) -> None:
 
 
 # Go for 3cb7
-
+m_anna_heatpump_idle["devices"]["3cb70739631c4d17a86b8b12e8a5161b"]["control_state"] = "idle"
 m_anna_heatpump_idle["devices"]["3cb70739631c4d17a86b8b12e8a5161b"]["sensors"][
     "temperature"
 ] = 23.0
diff --git a/tests/data/anna/anna_elga_2.json b/tests/data/anna/anna_elga_2.json
@@ -39,6 +39,7 @@
       "active_preset": "home",
       "available_schedules": ["Thermostat schedule", "off"],
       "climate_mode": "auto",
+      "control_state": "idle",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/tests/data/anna/anna_elga_2_cooling.json b/tests/data/anna/anna_elga_2_cooling.json
@@ -39,6 +39,7 @@
       "active_preset": "home",
       "available_schedules": ["Thermostat schedule", "off"],
       "climate_mode": "auto",
+      "control_state": "cooling",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/tests/data/anna/anna_elga_2_cooling_UPDATED_DATA.json b/tests/data/anna/anna_elga_2_cooling_UPDATED_DATA.json
@@ -39,6 +39,7 @@
       "active_preset": "home",
       "available_schedules": ["Thermostat schedule", "off"],
       "climate_mode": "auto",
+      "control_state": "heating",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/tests/data/anna/anna_elga_2_schedule_off.json b/tests/data/anna/anna_elga_2_schedule_off.json
@@ -39,6 +39,7 @@
       "active_preset": "home",
       "available_schedules": ["Thermostat schedule", "off"],
       "climate_mode": "heat_cool",
+      "control_state": "idle",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/tests/data/anna/anna_elga_no_cooling.json b/tests/data/anna/anna_elga_no_cooling.json
@@ -60,6 +60,7 @@
       "active_preset": "home",
       "available_schedules": ["standaard", "off"],
       "climate_mode": "auto",
+      "control_state": "heating",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/tests/data/anna/anna_heatpump_cooling.json b/tests/data/anna/anna_heatpump_cooling.json
@@ -57,6 +57,7 @@
       "active_preset": "home",
       "available_schedules": ["standaard", "off"],
       "climate_mode": "heat_cool",
+      "control_state": "cooling",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/tests/data/anna/anna_heatpump_cooling_fake_firmware.json b/tests/data/anna/anna_heatpump_cooling_fake_firmware.json
@@ -57,6 +57,7 @@
       "active_preset": "home",
       "available_schedules": ["standaard", "off"],
       "climate_mode": "heat_cool",
+      "control_state": "cooling",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/tests/data/anna/anna_heatpump_heating.json b/tests/data/anna/anna_heatpump_heating.json
@@ -62,6 +62,7 @@
       "active_preset": "home",
       "available_schedules": ["standaard", "off"],
       "climate_mode": "auto",
+      "control_state": "heating",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/tests/data/anna/anna_loria_cooling_active.json b/tests/data/anna/anna_loria_cooling_active.json
@@ -4,6 +4,7 @@
       "active_preset": "home",
       "available_schedules": ["Winter", "Test ", "off"],
       "climate_mode": "auto",
+      "control_state": "cooling",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/tests/data/anna/anna_loria_driessens.json b/tests/data/anna/anna_loria_driessens.json
@@ -27,6 +27,7 @@
         "off"
       ],
       "climate_mode": "auto",
+      "control_state": "idle",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/tests/data/anna/anna_loria_heating_idle.json b/tests/data/anna/anna_loria_heating_idle.json
@@ -4,6 +4,7 @@
       "active_preset": "home",
       "available_schedules": ["Winter", "Test ", "off"],
       "climate_mode": "auto",
+      "control_state": "idle",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/tests/data/anna/anna_v4.json b/tests/data/anna/anna_v4.json
@@ -4,6 +4,7 @@
       "active_preset": "home",
       "available_schedules": ["Standaard", "Thuiswerken", "off"],
       "climate_mode": "heat",
+      "control_state": "heating",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/tests/data/anna/anna_v4_UPDATED_DATA.json b/tests/data/anna/anna_v4_UPDATED_DATA.json
@@ -39,6 +39,7 @@
       "active_preset": "away",
       "select_schedule": "Standaard",
       "climate_mode": "auto",
+      "control_state": "idle",
       "sensors": {
         "temperature": 19.5,
         "setpoint": 19.5,
diff --git a/tests/data/anna/anna_v4_dhw.json b/tests/data/anna/anna_v4_dhw.json
@@ -4,6 +4,7 @@
       "active_preset": "home",
       "available_schedules": ["Standaard", "Thuiswerken", "off"],
       "climate_mode": "heat",
+      "control_state": "idle",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/tests/data/anna/anna_v4_no_tag.json b/tests/data/anna/anna_v4_no_tag.json
@@ -4,6 +4,7 @@
       "active_preset": "home",
       "available_schedules": ["Standaard", "Thuiswerken", "off"],
       "climate_mode": "auto",
+      "control_state": "heating",
       "dev_class": "thermostat",
       "firmware": "2018-02-08T11:15:53+01:00",
       "hardware": "6539-1301-5002",
diff --git a/tests/data/anna/anna_without_boiler_fw441.json b/tests/data/anna/anna_without_boiler_fw441.json
diff --git a/tests/data/anna/legacy_anna.json b/tests/data/anna/legacy_anna.json
diff --git a/tests/data/anna/legacy_anna_2.json b/tests/data/anna/legacy_anna_2.json
