Merge pull request #55 from plugwise/refactor_stick_api

0.9.0 - API change for stick

Author: brefra

CHANGELOG.md

@@ -1,5 +1,50 @@
 # Changelog
 
+## 0.9.0 - API change for stick
+
+- Improvement: Debounce relay state
+- Improvement: Prioritize request so requests like switching a relay get send out before power measurement requests.
+- Improvement: Dynamically change the refresh interval based on the actual discovered nodes with power measurement capabilities
+- Added: New property attributes for USB-stick.
+  The old methods are still available but will give a deprecate warning
+  - Stick
+    - `devices` (dict) - All discovered and supported plugwise devices with the MAC address as their key
+    - `joined_nodes` (integer) - Total number of registered nodes at Plugwise Circle+
+    - `mac` (string) - The MAC address of the USB-Stick
+    - `network_state` (boolean) - The state (on-line/off-line) of the Plugwise network.
+    - `network_id` (integer) - The ID of the Plugwise network.
+    - `port` (string) - The port connection string
+  - All plugwise devices
+    - `available` (boolean) - The current network availability state of the device
+    - `battery_powered` (boolean) - Indicates if device is battery powered
+    - `features` (tuple) - List of supported attribute IDs
+    - `firmware_version` (string) - Firmware version device is running
+    - `hardware_model` (string) - Hardware model name
+    - `hardware_version` (string) - Hardware version of device
+    - `last_update` (datetime) - Date/time stamp of last received update from device
+    - `mac` (string) - MAC address of device
+    - `measures_power` (boolean) - Indicates if device supports power measurement
+    - `name` (string) - Name of device based om hardware model and MAC address
+    - `ping` (integer) - Network roundtrip time in milliseconds
+    - `rssi_in` (integer) - Inbound RSSI level in DBm
+    - `rssi_out` (integer) - Outbound RSSI level based on the received inbound RSSI level of the neighbor node in DBm
+  - Scan devices
+    - `motion` (boolean) - Current detection state of motion.
+  - Sense devices
+    - `humidity`  (integer) - Last reported humidity value.
+    - `temperature` (integer) - Last reported temperature value.
+  - Circle/Circle+/Stealth devices
+    - `current_power_usage` (float) - Current power usage (Watts) during the last second
+    - `current_power_usage_8_sec` (float) - Current power usage (Watts) during the last 8 seconds
+    - `power_consumption_current_hour` (float) - Total power consumption (kWh) this running hour
+    - `power_consumption_previous_hour` (float) - Total power consumption (kWh) during the previous hour
+    - `power_consumption_today` (float) - Total power consumption (kWh) of today
+    - `power_consumption_yesterday` (float) - Total power consumption (kWh) during yesterday
+    - `power_production_current_hour` (float) - Total power production (kWh) this hour
+    - `relay_state` (boolean) - State of the output power relay. Setting this property will operate the relay
+  - Switch devices
+    - `switch`  (boolean) - Last reported state of switch
+
 ## 0.8.6 - Code quality improvements for stick
 
 - Bug-fix: Power history was not reported (0 value) during last week of the month
@@ -17,9 +62,10 @@
 - Improvement: Resolves all flake8 comments
 
 ## 0.8.5 - Fix sensor scaling
-  - Fix for via HA Core issue #44349
-  - Fix other value scaling bugs
-  - Remove aiohttp-workaround - issue solved in aiohttp 3.7.1
+
+- Fix for via HA Core issue #44349
+- Fix other value scaling bugs
+- Remove aiohttp-workaround - issue solved in aiohttp 3.7.1
 
 (## 0.8.4 - Not released: Fix "Gas Consumed Interval stays 0" )
 

plugwise/__init__.py

@@ -1,6 +1,6 @@
 """Plugwise module."""
 
-__version__ = "0.8.6"
+__version__ = "0.9.0"
 
 from plugwise.smile import Smile
 from plugwise.stick import stick

plugwise/constants.py

@@ -136,6 +136,11 @@
 # Default sleep between sending messages
 SLEEP_TIME = 150 / 1000
 
+# Message priority levels
+PRIORITY_HIGH = 1
+PRIORITY_LOW = 3
+PRIORITY_MEDIUM = 2
+
 # Max seconds the internal clock of plugwise nodes
 # are allowed to drift in seconds
 MAX_TIME_DRIFT = 30
@@ -220,120 +225,112 @@
 CB_NEW_NODE = "NEW_NODE"
 CB_JOIN_REQUEST = "JOIN_REQUEST"
 
-# Sensors
-SENSOR_AVAILABLE = {
+# Stick device features
+FEATURE_AVAILABLE = {
     "id": "available",
     "name": "Available",
-    "state": "get_available",
+    "state": "available",
     "unit": "state",
 }
-SENSOR_HUMIDITY = {
+FEATURE_HUMIDITY = {
     "id": "humidity",
     "name": "Humidity",
-    "state": "get_humidity",
+    "state": "humidity",
     "unit": "%",
 }
-SENSOR_MOTION = {
+FEATURE_MOTION = {
     "id": "motion",
     "name": "Motion",
-    "state": "get_motion",
+    "state": "motion",
     "unit": "state",
 }
-SENSOR_PING = {
+FEATURE_PING = {
     "id": "ping",
     "name": "Ping roundtrip",
-    "state": "get_ping",
+    "state": "ping",
     "unit": TIME_MILLISECONDS,
 }
-SENSOR_POWER_USE = {
+FEATURE_POWER_USE = {
     "id": "power_1s",
     "name": "Power usage",
-    "state": "get_power_usage",
+    "state": "current_power_usage",
     "unit": POWER_WATT,
 }
-SENSOR_POWER_USE_LAST_8_SEC = {
+FEATURE_POWER_USE_LAST_8_SEC = {
     "id": "power_8s",
     "name": "Power usage 8 seconds",
-    "state": "get_power_usage_8_sec",
+    "state": "current_power_usage_8_sec",
     "unit": POWER_WATT,
 }
-SENSOR_POWER_CONSUMPTION_CURRENT_HOUR = {
+FEATURE_POWER_CONSUMPTION_CURRENT_HOUR = {
     "id": "power_con_cur_hour",
     "name": "Power consumption current hour",
-    "state": "get_power_consumption_current_hour",
+    "state": "power_consumption_current_hour",
     "unit": ENERGY_KILO_WATT_HOUR,
 }
-SENSOR_POWER_CONSUMPTION_PREVIOUS_HOUR = {
+FEATURE_POWER_CONSUMPTION_PREVIOUS_HOUR = {
     "id": "power_con_prev_hour",
     "name": "Power consumption previous hour",
-    "state": "get_power_consumption_previous_hour",
+    "state": "power_consumption_previous_hour",
     "unit": ENERGY_KILO_WATT_HOUR,
 }
-SENSOR_POWER_CONSUMPTION_TODAY = {
+FEATURE_POWER_CONSUMPTION_TODAY = {
     "id": "power_con_today",
     "name": "Power consumption today",
-    "state": "get_power_consumption_today",
+    "state": "power_consumption_today",
     "unit": ENERGY_KILO_WATT_HOUR,
 }
-SENSOR_POWER_CONSUMPTION_YESTERDAY = {
+FEATURE_POWER_CONSUMPTION_YESTERDAY = {
     "id": "power_con_yesterday",
     "name": "Power consumption yesterday",
-    "state": "get_power_consumption_yesterday",
+    "state": "power_consumption_yesterday",
     "unit": ENERGY_KILO_WATT_HOUR,
 }
-SENSOR_POWER_PRODUCTION_CURRENT_HOUR = {
+FEATURE_POWER_PRODUCTION_CURRENT_HOUR = {
     "id": "power_prod_cur_hour",
     "name": "Power production current hour",
-    "state": "get_power_production_current_hour",
+    "state": "power_production_current_hour",
     "unit": ENERGY_KILO_WATT_HOUR,
 }
-SENSOR_POWER_PRODUCTION_PREVIOUS_HOUR = {
+FEATURE_POWER_PRODUCTION_PREVIOUS_HOUR = {
     "id": "power_prod_prev_hour",
     "name": "Power production previous hour",
-    "state": "get_power_production_previous_hour",
+    "state": "power_production_previous_hour",
     "unit": ENERGY_KILO_WATT_HOUR,
 }
-SENSOR_SWITCH = {
+FEATURE_RELAY = {
+    "id": "relay",
+    "name": "Relay state",
+    "state": "relay_state",
+    "unit": "state",
+}
+FEATURE_SWITCH = {
     "id": "switch",
-    "name": "switch",
-    "state": "get_switch_state",
+    "name": "Switch state",
+    "state": "switch_state",
     "unit": "state",
 }
-SENSOR_TEMPERATURE = {
+FEATURE_TEMPERATURE = {
     "id": "temperature",
     "name": "Temperature",
-    "state": "get_temperature",
+    "state": "temperature",
     "unit": TEMP_CELSIUS,
 }
 
 # TODO: Need to validate RSSI sensors
-SENSOR_RSSI_IN = {
+FEATURE_RSSI_IN = {
     "id": "RSSI_in",
     "name": "RSSI in",
-    "state": "get_rssi_in",
+    "state": "rssi_in",
     "unit": "Unknown",
 }
-SENSOR_RSSI_OUT = {
+FEATURE_RSSI_OUT = {
     "id": "RSSI_out",
     "name": "RSSI out",
-    "state": "get_rssi_out",
+    "state": "rssi_out",
     "unit": "Unknown",
 }
 
-# Switches
-SWITCH_RELAY = {
-    "id": "relay",
-    "name": "Relay state",
-    "state": "get_relay_state",
-    "switch": "set_relay_state",
-}
-
-# Home Assistant entities
-HA_SWITCH = "switch"
-HA_SENSOR = "sensor"
-HA_BINARY_SENSOR = "binary_sensor"
-
-
 ### Smile constants ###
 
 APPLIANCES = "/core/appliances"

plugwise/controller.py

@@ -5,15 +5,15 @@
 - handle the connection (connect/disconnect) to the USB-Stick
 - take care for message acknowledgements based on sequence id's
 - resend message requests when timeouts occurs
-- holds a sending queue (fifo)
+- holds a sending queue and submit messages based on the message priority (high, medium, low)
 - passes received messages back to message processor (stick.py)
 - execution of callbacks after processing the response message
 
 """
 
 from datetime import datetime, timedelta
 import logging
-import queue
+from queue import Empty, PriorityQueue
 import threading
 import time
 
@@ -22,6 +22,7 @@
 from .constants import (
     MESSAGE_RETRY,
     MESSAGE_TIME_OUT,
+    PRIORITY_MEDIUM,
     REQUEST_FAILED,
     REQUEST_SUCCESS,
     SLEEP_TIME,
@@ -62,7 +63,7 @@ def connect_to_stick(self, callback=None) -> bool:
         """
         Connect to USB-Stick and startup all worker threads
 
-        Return: True when if successfully.
+        Return: True when connection is successful.
         """
         self.init_callback = callback
         # Open connection to USB Stick
@@ -77,7 +78,7 @@ def connect_to_stick(self, callback=None) -> bool:
         if self.connection.connect():
             _LOGGER.debug("Starting message controller threads...")
             # send daemon
-            self._send_message_queue = queue.Queue()
+            self._send_message_queue = PriorityQueue()
             self._run_send_message_thread = True
             self._send_message_thread = threading.Thread(
                 None, self._send_message_loop, "send_messages_thread", (), {}
@@ -96,20 +97,32 @@ def connect_to_stick(self, callback=None) -> bool:
             _LOGGER.warning("Failed to connect to USB stick")
         return self.connection.is_connected()
 
-    def send(self, request: NodeRequest, callback=None, retry_counter=0):
+    def send(
+        self,
+        request: NodeRequest,
+        callback=None,
+        retry_counter=0,
+        priority=PRIORITY_MEDIUM,
+    ):
         """Queue request message to be sent into Plugwise Zigbee network."""
         _LOGGER.debug(
-            "Queue %s to be send with retry counter %s",
+            "Queue %s to be send with retry counter %s and priority %s",
             request.__class__.__name__,
             str(retry_counter),
+            str(priority),
         )
         self._send_message_queue.put(
-            [
-                request,
-                callback,
+            (
+                priority,
                 retry_counter,
-                None,
-            ]
+                datetime.now(),
+                [
+                    request,
+                    callback,
+                    retry_counter,
+                    None,
+                ],
+            )
         )
 
     def resend(self, seq_id):
@@ -142,7 +155,7 @@ def resend(self, seq_id):
                     if self.expected_responses[seq_id][1]:
                         self.expected_responses[seq_id][1]()
                 else:
-                    _LOGGER.warning(
+                    _LOGGER.info(
                         "Resend %s for %s, retry %s of %s",
                         _request,
                         _mac,
@@ -180,8 +193,10 @@ def _send_message_loop(self):
         """Daemon to send messages waiting in queue."""
         while self._run_send_message_thread:
             try:
-                request_set = self._send_message_queue.get(block=True, timeout=1)
-            except queue.Empty:
+                _prio, _retry, _dt, request_set = self._send_message_queue.get(
+                    block=True, timeout=1
+                )
+            except Empty:
                 time.sleep(SLEEP_TIME)
             else:
                 # Calc next seq_id based last received ack message

plugwise/messages/responses.py

@@ -495,7 +495,7 @@ class NodeFeaturesResponse(NodeResponse):
 
     def __init__(self):
         super().__init__()
-        self.features = Int(0, 16)
+        self.features = String(None, length=16)
         self.params += [self.features]