Refactor method that logs cube state

Author: unaiur

maxcube/cube.py

@@ -64,55 +64,15 @@ def use_persistent_connection(self, value: bool) -> None:
     def disconnect(self):
         self.__commander.disconnect()
 
+    def __str__(self):
+        return self.describe("CUBE", f"firmware={self.firmware_version}")
+
     def log(self):
-        logger.info(
-            "Cube (rf=%s, firmware=%s)" % (self.rf_address, self.firmware_version)
-        )
-        for device in self.devices:
-            if device.is_thermostat():
-                logger.info(
-                    "Thermostat (type=%s, rf=%s, room=%s, name=%s, mode=%s, min=%s, max=%s, actual=%s, target=%s, valve=%s)"
-                    % (
-                        device.type,
-                        device.rf_address,
-                        self.room_by_id(device.room_id).name,
-                        device.name,
-                        device.mode,
-                        device.min_temperature,
-                        device.max_temperature,
-                        device.actual_temperature,
-                        device.target_temperature,
-                        device.valve_position,
-                    )
-                )
-            elif device.is_wallthermostat():
-                logger.info(
-                    "WallThermostat (type=%s, rf=%s, room=%s, name=%s, min=%s, max=%s, actual=%s, target=%s)"
-                    % (
-                        device.type,
-                        device.rf_address,
-                        self.room_by_id(device.room_id).name,
-                        device.name,
-                        device.min_temperature,
-                        device.max_temperature,
-                        device.actual_temperature,
-                        device.target_temperature,
-                    )
-                )
-            elif device.is_windowshutter():
-                logger.info(
-                    "WindowShutter (type=%s, rf=%s, room=%s, name=%s, init=%s, open=%s)"
-                    % (
-                        device.type,
-                        device.rf_address,
-                        self.room_by_id(device.room_id).name,
-                        device.name,
-                        device.initialized,
-                        device.is_open,
-                    )
-                )
-            else:
-                logger.info("Device (rf=%s, name=%s" % (device.rf_address, device.name))
+        logger.info(str(self))
+        for room in self.rooms:
+            logger.info(f" * ROOM {room.name}")
+            for device in self.devices_by_room(room):
+                logger.info(" --- " + str(device))
 
     def update(self):
         self.__parse_responses(self.__commander.update())

maxcube/device.py

@@ -1,3 +1,5 @@
+from typing import Tuple
+
 MAX_CUBE = 0
 MAX_THERMOSTAT = 1
 MAX_THERMOSTAT_PLUS = 2
@@ -13,6 +15,13 @@
 MAX_DEVICE_BATTERY_OK = 0
 MAX_DEVICE_BATTERY_LOW = 1
 
+MODE_NAMES = {
+    MAX_DEVICE_MODE_AUTOMATIC: "auto",
+    MAX_DEVICE_MODE_MANUAL: "manual",
+    MAX_DEVICE_MODE_VACATION: "away",
+    MAX_DEVICE_MODE_BOOST: "boost",
+}
+
 
 class MaxDevice(object):
     def __init__(self):
@@ -36,6 +45,15 @@ def is_windowshutter(self):
     def is_room(self):
         return False
 
+    def describe(self, kind: str, *args: Tuple[str]):
+        state = "".join("," + s for s in args if s)
+        if self.battery == MAX_DEVICE_BATTERY_LOW:
+            state = ",LOW_BATT" + state
+        return f"{kind} sn={self.serial},rf={self.rf_address},name={self.name}" + state
+
+    def __str__(self):
+        return self.describe(str(self.type))
+
     def to_dict(self):
         data = {}
         keys = [

maxcube/thermostat.py

@@ -1,7 +1,7 @@
 from time import localtime
 from typing import Dict, List
 
-from maxcube.device import MaxDevice
+from maxcube.device import MODE_NAMES, MaxDevice
 
 PROG_DAYS = [
     "monday",
@@ -27,6 +27,18 @@ def __init__(self):
         self.mode = None
         self.programme: Dict[str, List[Dict[str, int]]] = {}
 
+    def __str__(self):
+        return self.describe(
+            "THERMOSTAT",
+            f"mode={MODE_NAMES.get(self.mode, str(self.mode))}",
+            f"actual={self.actual_temperature}",
+            f"target={self.target_temperature}",
+            f"eco={self.eco_temperature}",
+            f"comfort={self.comfort_temperature}",
+            f"range=[{self.min_temperature},{self.max_temperature}]",
+            f"valve={self.valve_position}",
+        )
+
     def get_current_temp_in_auto_mode(self):
         t = localtime()
         weekday = PROG_DAYS[t.tm_wday]

maxcube/wallthermostat.py

@@ -1,4 +1,4 @@
-from maxcube.device import MaxDevice
+from maxcube.device import MODE_NAMES, MaxDevice
 
 
 class MaxWallThermostat(MaxDevice):
@@ -11,3 +11,14 @@ def __init__(self):
         self.actual_temperature = None
         self.target_temperature = None
         self.mode = None
+
+    def __str__(self):
+        return self.describe(
+            "WALLTHERMO",
+            f"mode={MODE_NAMES.get(self.mode, str(self.mode))}",
+            f"actual={self.actual_temperature}",
+            f"target={self.target_temperature}",
+            f"eco={self.eco_temperature}",
+            f"comfort={self.comfort_temperature}",
+            f"range=[{self.min_temperature},{self.max_temperature}]",
+        )

maxcube/windowshutter.py

@@ -6,3 +6,6 @@ def __init__(self):
         super(MaxWindowShutter, self).__init__()
         self.is_open = False
         self.initialized = None
+
+    def __str__(self):
+        return self.describe("WINDOW", f"open={self.is_open}")

tests/test_cube.py

@@ -6,6 +6,7 @@
 from maxcube.cube import MaxCube
 from maxcube.device import (
     MAX_CUBE,
+    MAX_DEVICE_BATTERY_LOW,
     MAX_DEVICE_MODE_AUTOMATIC,
     MAX_DEVICE_MODE_MANUAL,
     MAX_THERMOSTAT,
@@ -61,7 +62,7 @@ def to_messages(lines):
         b"C:0e2eba,0g4uugEBEKBLRVExMDg2NDM3KyE9CQcYAzAM/wAgYFR4ISAhICEgISAhIEUgRSBFIEUgRSBFICBgVHghICEgISAhICEgRSBFIEUgR"
         b"SBFIEUgIEJUTiEfISAhICEgISBFIEUgRSBFIEUgRSAgQlROIR8hICEgISAhIEUgRSBFIEUgRSBFICBCVE4hHyEgISAhICEgRSBFIEUgRSBFIEU"
         b"gIEJUTiEfISAhICEgISBFIEUgRSBFIEUgRSAgQlROIR8hICEgISAhIEUgRSBFIEUgRSBFIA==",
-        b"L:DAoIgewSGAQQAAAA5QYMorL3EhALDi66ChIYABAAAAA=",
+        b"L:DAoIgewSGAQQAAAA5QYMorL3EpALDi66ChIYABAAAAA=",
     ]
 )
 
@@ -288,6 +289,7 @@ def test_init_2(self, ClassMock):
 
         device = self.cube.devices[2]
         self.assertFalse(device.is_open)
+        self.assertTrue(device.battery == MAX_DEVICE_BATTERY_LOW)
 
     def test_parse_m_message(self, ClassMock):
         self.init(ClassMock, INIT_RESPONSE_2)