Merge pull request #92 from plugwise/usb_energy

Add energy support for Stick

Author: brefra

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.12.0 - Energy support and bugfixes
+
+- Stick: Add new properties `energy_consumption_today` counter and `energy_consumption_today_last_reset` timestamp. These properties can be used to properly measure the used energy. Very useful for the 'Energy' capabilities introduced in Home Assistant 2021.8
+- Stick: Synchronize clock of all plugwise devices once a day
+- Stick: Reduced local clock drift from 30 to 5 seconds
+- Stick: Optimized retrieval and handling of energy history
+
 ## 0.11.2 - Fix new and remaining pylint warnings
 
 ## 0.11.1 - Code improvements

plugwise/constants.py

@@ -157,7 +157,7 @@
 
 # Max seconds the internal clock of plugwise nodes
 # are allowed to drift in seconds
-MAX_TIME_DRIFT = 30
+MAX_TIME_DRIFT = 5
 
 # Default sleep time in seconds for watchdog daemon
 WATCHDOG_DEAMON = 60
@@ -251,6 +251,12 @@
     "state": "available",
     "unit": "state",
 }
+FEATURE_ENERGY_CONSUMPTION_TODAY = {
+    "id": "energy_consumption_today",
+    "name": "Energy consumption today",
+    "state": "Energy_consumption_today",
+    "unit": ENERGY_KILO_WATT_HOUR,
+}
 FEATURE_HUMIDITY = {
     "id": "humidity",
     "name": "Humidity",

plugwise/messages/requests.py

@@ -339,11 +339,11 @@ def __init__(self, group_mac, switch_state: bool):
         self.args.append(Int(val, length=2))
 
 
-class CirclePowerBufferRequest(NodeRequest):
+class CircleEnergyCountersRequest(NodeRequest):
     """
-    Request power usage storaged a given memory address
+    Request energy usage counters storaged a given memory address
 
-    Response message: CirclePowerBufferResponse
+    Response message: CircleEnergyCountersResponse
     """
 
     ID = b"0048"

plugwise/messages/responses.py

@@ -406,12 +406,12 @@ def __init__(self):
         self.params += [self.time, self.day_of_week, self.unknown, self.unknown2]
 
 
-class CirclePowerBufferResponse(NodeResponse):
+class CircleEnergyCountersResponse(NodeResponse):
     """
-    returns information about historical power usage
-    each response contains 4 log buffers and each log buffer contains data for 1 hour
+    Returns historical energy usage of requested memory address
+    Each response contains 4 energy counters at specified 1 hour timestamp
 
-    Response to: CirclePowerBufferRequest
+    Response to: CircleEnergyCountersRequest
     """
 
     ID = b"0049"
@@ -576,7 +576,7 @@ def __init__(self):
     b"0027": CircleCalibrationResponse(),
     b"003A": CirclePlusRealTimeClockResponse(),
     b"003F": CircleClockResponse(),
-    b"0049": CirclePowerBufferResponse(),
+    b"0049": CircleEnergyCountersResponse(),
     b"0060": NodeFeaturesResponse(),
     b"0100": NodeAckResponse(),
     b"0105": SenseReportResponse(),

plugwise/nodes/__init__.py

@@ -30,7 +30,7 @@ class PlugwiseNode:
     def __init__(self, mac, address, message_sender):
         mac = mac.upper()
         if not validate_mac(mac):
-            _LOGGER.debug(
+            _LOGGER.warning(
                 "MAC address is in unexpected format: %s",
                 str(mac),
             )
@@ -51,7 +51,6 @@ def __init__(self, mac, address, message_sender):
         self._firmware_version = None
         self._relay_state = False
         self._last_log_address = None
-        self.last_info_message = None
         self._device_features = None
 
     @property
@@ -266,7 +265,11 @@ def _process_ping_response(self, message):
 
     def _process_info_response(self, message):
         """Process info response message."""
-        _LOGGER.debug("Response info message for node %s", self.mac)
+        _LOGGER.debug(
+            "Response info message for node %s, last log address %s",
+            self.mac,
+            str(message.last_logaddr.value),
+        )
         if message.relay_state.serialize() == b"01":
             if not self._relay_state:
                 self._relay_state = True
@@ -278,7 +281,6 @@ def _process_info_response(self, message):
         self._hardware_version = message.hw_ver.value.decode(UTF8_DECODE)
         self._firmware_version = message.fw_ver.value
         self._node_type = message.node_type.value
-        self.last_info_message = message.timestamp
         if self._last_log_address != message.last_logaddr.value:
             self._last_log_address = message.last_logaddr.value
         _LOGGER.debug("Node type        = %s", self.hardware_model)