Decoding presets in status messages (#33)

* Modified status structure to process presets where available.

* Enhanced client to use presets.

* Enhanced CLI to display current presets.

* Updated readme.

* Cleaned up imports.

Author: merll

README.md

@@ -11,10 +11,10 @@ with support for more features and better device handling.
 * Writing settings: target temperature, auto mode presets, temperature offset
 * Setting the active mode: auto, manual, boost, away
 * Reading the device serial number and firmware version
+* Reading presets and temperature offset in more recent firmware versions.
 
 ## Not (yet) supported)
 
-* Reading presets, temperature offset. This may not be possible.
 * No easy-to-use interface for setting schedules.
 
 # Installation
@@ -71,8 +71,12 @@ eq3cli
 Locked: False
 Batter low: False
 Window open: False
+Window open temp: 12.0
+Window open time: 0:15:00
 Boost: False
 Current target temp: 17.0
+Current comfort temp: 20.0
+Current eco temp: 17.0
 Current mode: auto dst locked
 Valve: 0
 ```

eq3bt/eq3btsmart.py

@@ -10,11 +10,12 @@
 import logging
 import struct
 import codecs
-from datetime import datetime, timedelta, time
+from datetime import datetime, timedelta
+from construct import Byte
 from enum import IntEnum
 
 from .connection import BTLEConnection
-from .structures import *
+from .structures import AwayDataAdapter, DeviceId, Schedule, Status
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -80,6 +81,12 @@ def __init__(self, _mac, connection_cls=BTLEConnection):
 
         self._schedule = {}
 
+        self._window_open_temperature = None
+        self._window_open_time = None
+        self._comfort_temperature = None
+        self._eco_temperature = None
+        self._temperature_offset = None
+
         self._away_temp = EQ3BT_AWAY_TEMP
         self._away_duration = timedelta(days=30)
         self._away_end = None
@@ -143,10 +150,30 @@ def handle_notification(self, data):
             else:
                 self._mode = Mode.Auto
 
-            _LOGGER.debug("Valve state: %s", self._valve_state)
-            _LOGGER.debug("Mode:        %s", self.mode_readable)
-            _LOGGER.debug("Target temp: %s", self._target_temperature)
-            _LOGGER.debug("Away end:    %s", self._away_end)
+            presets = status.presets
+            if presets:
+                self._window_open_temperature = presets.window_open_temp
+                self._window_open_time = presets.window_open_time
+                self._comfort_temperature = presets.comfort_temp
+                self._eco_temperature = presets.eco_temp
+                self._temperature_offset = presets.offset
+            else:
+                self._window_open_temperature = None
+                self._window_open_time = None
+                self._comfort_temperature = None
+                self._eco_temperature = None
+                self._temperature_offset = None
+
+            _LOGGER.debug("Valve state:      %s", self._valve_state)
+            _LOGGER.debug("Mode:             %s", self.mode_readable)
+            _LOGGER.debug("Target temp:      %s", self._target_temperature)
+            _LOGGER.debug("Away end:         %s", self._away_end)
+            _LOGGER.debug("Window open temp: %s",
+                          self._window_open_temperature)
+            _LOGGER.debug("Window open time: %s", self._window_open_time)
+            _LOGGER.debug("Comfort temp:     %s", self._comfort_temperature)
+            _LOGGER.debug("Eco temp:         %s", self._eco_temperature)
+            _LOGGER.debug("Temp offset:      %s", self._temperature_offset)
 
         elif data[0] == PROP_SCHEDULE_RETURN:
             parsed = self.parse_schedule(data)
@@ -338,6 +365,16 @@ def window_open_config(self, temperature, duration):
                             int(temperature * 2), int(duration.seconds / 300))
         self._conn.make_request(PROP_WRITE_HANDLE, value)
 
+    @property
+    def window_open_temperature(self):
+        """The temperature to set when an open window is detected."""
+        return self._window_open_temperature
+
+    @property
+    def window_open_time(self):
+        """Timeout to reset the thermostat after an open window is detected."""
+        return self._window_open_time
+
     @property
     def locked(self):
         """Returns True if the thermostat is locked."""
@@ -365,6 +402,22 @@ def temperature_presets(self, comfort, eco):
                             int(eco * 2))
         self._conn.make_request(PROP_WRITE_HANDLE, value)
 
+    @property
+    def comfort_temperature(self):
+        """Returns the comfort temperature preset of the thermostat."""
+        return self._comfort_temperature
+
+    @property
+    def eco_temperature(self):
+        """Returns the eco temperature preset of the thermostat."""
+        return self._eco_temperature
+
+    @property
+    def temperature_offset(self):
+        """Returns the thermostat's temperature offset."""
+        return self._temperature_offset
+
+    @temperature_offset.setter
     def temperature_offset(self, offset):
         """Sets the thermostat's temperature offset."""
         _LOGGER.debug("Setting offset: %s", offset)

eq3bt/eq3cli.py

@@ -103,19 +103,29 @@ def low_battery(dev):
 def window_open(dev, temp, duration):
     """ Gets and sets the window open settings. """
     click.echo("Window open: %s" % dev.window_open)
+    if dev.window_open_temperature is not None:
+        click.echo("Window open temp: %s" % dev.window_open_temperature)
+    if dev.window_open_time is not None:
+        click.echo("Window open time: %s" % dev.window_open_time)
     if temp and duration:
         click.echo("Setting window open conf, temp: %s duration: %s" % (temp, duration))
         dev.window_open_config(temp, duration)
 
 
 @cli.command()
-@click.option('--comfort', type=float)
-@click.option('--eco', type=float)
+@click.option('--comfort', type=float, required=False)
+@click.option('--eco', type=float, required=False)
 @pass_dev
 def presets(dev, comfort, eco):
     """ Sets the preset temperatures for auto mode. """
-    click.echo("Setting presets: comfort %s, eco %s" % (comfort, eco))
-    dev.temperature_presets(comfort, eco)
+    if dev.comfort_temperature is not None:
+        click.echo("Current comfort temp: %s" % dev.comfort_temperature)
+    if dev.eco_temperature is not None:
+        click.echo("Current eco temp: %s" % dev.eco_temperature)
+    if comfort and eco:
+        click.echo("Setting presets: comfort %s, eco %s" % (comfort, eco))
+        dev.temperature_presets(comfort, eco)
+
 
 @cli.command()
 @pass_dev
@@ -132,13 +142,18 @@ def schedule(dev):
             click.echo("\t[%s-%s] %s" % (current_hour, hour.next_change_at, hour.target_temp))
             current_hour = hour.next_change_at
 
+
 @cli.command()
-@click.argument('offset', type=float)
+@click.argument('offset', type=float, required=False)
 @pass_dev
 def offset(dev, offset):
     """ Sets the temperature offset [-3,5 3,5] """
-    click.echo("Setting the offset to %s" % offset)
-    dev.temperature_offset(offset)
+    if dev.temperature_offset is not None:
+        click.echo("Current temp offset: %s" % dev.temperature_offset)
+    if offset is not None:
+        click.echo("Setting the offset to %s" % offset)
+        dev.temperature_offset = offset
+
 
 @cli.command()
 @click.argument('away_end', type=Datetime(format='%Y-%m-%d %H:%M'), default=None, required=False)
@@ -173,7 +188,8 @@ def state(ctx):
     ctx.forward(window_open)
     ctx.forward(boost)
     ctx.forward(temp)
-    # ctx.forward(presets)
+    ctx.forward(presets)
+    ctx.forward(offset)
     ctx.forward(mode)
     ctx.forward(valve_state)
 

eq3bt/structures.py

@@ -1,7 +1,7 @@
 """ Contains construct adapters and structures. """
 from construct import (Struct, Adapter, Int8ub, Enum, FlagsEnum, Const,
-                       GreedyRange, GreedyBytes, IfThenElse, Bytes, Byte)
-from datetime import datetime, time
+                       GreedyRange, IfThenElse, Bytes, Optional)
+from datetime import datetime, time, timedelta
 
 
 PROP_ID_RETURN = 1
@@ -37,6 +37,33 @@ def _decode(self, obj, ctx, path):
     def _encode(self, obj, ctx, path):
         return int(obj * 2.0)
 
+
+class WindowOpenTimeAdapter(Adapter):
+    """ Adapter to encode and decode window open times (5 min increments). """
+    def _decode(self, obj, context, path):
+        return timedelta(minutes=float(obj * 5.0))
+
+    def _encode(self, obj, context, path):
+        if isinstance(obj, timedelta):
+            obj = obj.seconds
+        if 0 <= obj <= 3600.0:
+            return int(obj / 300.0)
+        raise ValueError("Window open time must be between 0 and 60 minutes "
+                         "in intervals of 5 minutes.")
+
+
+class TempOffsetAdapter(Adapter):
+    """ Adapter to encode and decode the temperature offset. """
+    def _decode(self, obj, context, path):
+        return float((obj - 7) / 2.0)
+
+    def _encode(self, obj, context, path):
+        if -3.5 <= obj <= 3.5:
+            return int(obj * 2.0) + 7
+        raise ValueError("Temperature offset must be between -3.5 and 3.5 (in "
+                         "intervals of 0.5).")
+
+
 ModeFlags = "ModeFlags" / FlagsEnum(Int8ub,
                                     AUTO=0x00, # always True, doesnt affect building
                                     MANUAL=0x01,
@@ -86,9 +113,16 @@ def _decode(self, obj, context, path):
     "valve" / Int8ub,
     Const(0x04, Int8ub),
     "target_temp" / TempAdapter(Int8ub),
-    "away" / IfThenElse(lambda ctx: ctx.mode.AWAY, 
-        AwayDataAdapter(Byte[4]),
-        GreedyBytes),
+    "away" / IfThenElse(lambda ctx: ctx.mode.AWAY,
+                        AwayDataAdapter(Bytes(4)),
+                        Optional(Bytes(4))),
+    "presets" / Optional(Struct(
+        "window_open_temp" / TempAdapter(Int8ub),
+        "window_open_time" / WindowOpenTimeAdapter(Int8ub),
+        "comfort_temp" / TempAdapter(Int8ub),
+        "eco_temp" / TempAdapter(Int8ub),
+        "offset" / TempOffsetAdapter(Int8ub),
+    ))
 )
 
 Schedule = "Schedule" / Struct(

eq3bt/tests/test_thermostat.py

@@ -1,7 +1,7 @@
 from unittest import TestCase
 
 import codecs
-from datetime import datetime
+from datetime import datetime, timedelta
 
 from eq3bt import Thermostat, TemperatureException
 from eq3bt.eq3btsmart import (PROP_NTFY_HANDLE, PROP_ID_QUERY,
@@ -17,6 +17,7 @@
     'boost': b'020104000428',
     'low_batt': b'020180000428',
     'valve_at_22': b'020100160428',
+    'presets': b'020100000422000000001803282207',
 }
 
 
@@ -100,6 +101,16 @@ def test_update(self):
         self.assertTrue(th.boost)
         self.assertEqual(th.mode, Mode.Boost)
 
+    def test_presets(self):
+        th = self.thermostat
+        self.thermostat._conn.set_status('presets')
+        self.thermostat.update()
+        self.assertEqual(th.window_open_temperature, 12.0)
+        self.assertEqual(th.window_open_time, timedelta(minutes=15.0))
+        self.assertEqual(th.comfort_temperature, 20.0)
+        self.assertEqual(th.eco_temperature, 17.0)
+        self.assertEqual(th.temperature_offset, 0)
+
     def test_query_schedule(self):
         self.fail()