Merge pull request #42 from plugwise/add-model

Add model-info to smile-output

Author: bouwew

.github/workflows/verify.yml

@@ -11,8 +11,9 @@ env:
 on: 
   schedule:
     - cron: '0 0 * * 0' # weekly
+  workflow_dispatch:
   push:
-  #pull_request:
+# pull_request:
 
 jobs:
   # Prepare default python version environment

plugwise/__init__.py

@@ -1,6 +1,6 @@
 """Plugwise module."""
 
-__version__ = "0.8.2a4"
+__version__ = "0.8.2a5"
 
 from plugwise.smile import Smile
 from plugwise.stick import stick

plugwise/constants.py

@@ -279,11 +279,13 @@
 APPLIANCES = "/core/appliances"
 DOMAIN_OBJECTS = "/core/domain_objects"
 LOCATIONS = "/core/locations"
+MODULES = "/core/modules"
 NOTIFICATIONS = "/core/notifications"
 RULES = "/core/rules"
 SYSTEM = "/system"
 STATUS = "/system/status.xml"
 
+ATTR_TYPE = "type"
 DEFAULT_TIMEOUT = 30
 DEFAULT_USERNAME = "smile"
 DEFAULT_PORT = 80
@@ -292,19 +294,19 @@
 
 HOME_MEASUREMENTS = {
     "electricity_consumed": {
-        ATTR_NAME: "power",
+        ATTR_TYPE: "power",
         ATTR_UNIT_OF_MEASUREMENT: POWER_WATT,
     },
     "electricity_produced": {
-        ATTR_NAME: "power",
+        ATTR_TYPE: "power",
         ATTR_UNIT_OF_MEASUREMENT: POWER_WATT,
     },
     "gas_consumed": {
-        ATTR_NAME: "gas",
+        ATTR_TYPE: "gas",
         ATTR_UNIT_OF_MEASUREMENT: VOLUME_CUBIC_METERS,
     },
     "outdoor_temperature": {
-        ATTR_NAME: "temperature",
+        ATTR_TYPE: "temperature",
         ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS,
     },
 }
@@ -314,86 +316,48 @@
 # radiator_valve 'uncorrected_temperature', 'temperature_offset'
 DEVICE_MEASUREMENTS = {
     # HA Core current_temperature
-    "temperature": {ATTR_NAME: "temperature", ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
+    "temperature": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
     # HA Core setpoint
-    "thermostat": {ATTR_NAME: "setpoint", ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
+    "thermostat": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
     # Anna/Adam
-    "boiler_temperature": {
-        ATTR_NAME: "water_temperature",
-        ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS,
-    },
-    "domestic_hot_water_state": {
-        ATTR_NAME: "dhw_state",
-        ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS,
-    },
+    "boiler_temperature": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
+    "domestic_hot_water_state": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
     "intended_boiler_temperature": {
-        ATTR_NAME: "intended_boiler_temperature",
-        ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS,
+        ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS
     },  # non-zero when heating, zero when dhw-heating
     "intended_central_heating_state": {
-        ATTR_NAME: "heating_state",
-        ATTR_UNIT_OF_MEASUREMENT: None,
+        ATTR_UNIT_OF_MEASUREMENT: None
     },  # use intended_c_h_state, this key shows the heating-behavior better than c-h_state
-    "modulation_level": {
-        ATTR_NAME: "modulation_level",
-        ATTR_UNIT_OF_MEASUREMENT: PERCENTAGE,
-    },
-    "return_water_temperature": {
-        ATTR_NAME: "return_temperature",
-        ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS,
-    },
+    "modulation_level": {ATTR_UNIT_OF_MEASUREMENT: PERCENTAGE},
+    "return_water_temperature": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
     # Used with the Elga heatpump - marcelveldt
-    "compressor_state": {ATTR_NAME: "compressor_state", ATTR_UNIT_OF_MEASUREMENT: None},
-    "cooling_state": {ATTR_NAME: "cooling_state", ATTR_UNIT_OF_MEASUREMENT: None},
+    "compressor_state": {ATTR_UNIT_OF_MEASUREMENT: None},
+    "cooling_state": {ATTR_UNIT_OF_MEASUREMENT: None},
     # Next 2 keys are used to show the state of the gas-heater used next to the Elga heatpump - marcelveldt
-    "slave_boiler_state": {
-        ATTR_NAME: "slave_boiler_state",
-        ATTR_UNIT_OF_MEASUREMENT: None,
-    },
+    "slave_boiler_state": {ATTR_UNIT_OF_MEASUREMENT: None},
     "flame_state": {
-        ATTR_NAME: "flame_state",
-        ATTR_UNIT_OF_MEASUREMENT: None,
+        ATTR_UNIT_OF_MEASUREMENT: None
     },  # also present when there is a single gas-heater
     # Anna only
-    "central_heater_water_pressure": {
-        ATTR_NAME: "water_pressure",
-        ATTR_UNIT_OF_MEASUREMENT: PRESSURE_BAR,
-    },
+    "central_heater_water_pressure": {ATTR_UNIT_OF_MEASUREMENT: PRESSURE_BAR},
     "outdoor_temperature": {
-        ATTR_NAME: "outdoor_temperature",
-        ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS,
+        ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS
     },  # Outdoor temp as reported on the Anna, in the App
     "schedule_temperature": {
-        ATTR_NAME: "schedule_temperature",
-        ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS,
+        ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS
     },  # Only present on legacy Anna and Anna_v3
     # Legacy Anna: similar to flame-state on Anna/Adam
-    "boiler_state": {ATTR_NAME: "boiler_state", ATTR_UNIT_OF_MEASUREMENT: None},
+    "boiler_state": {ATTR_UNIT_OF_MEASUREMENT: None},
     # Legacy Anna: shows when heating is active, don't show dhw_state, cannot be determined reliably
-    "intended_boiler_state": {
-        ATTR_NAME: "intended_boiler_state",
-        ATTR_UNIT_OF_MEASUREMENT: None,
-    },
+    "intended_boiler_state": {ATTR_UNIT_OF_MEASUREMENT: None},
     # Lisa and Tom
-    "battery": {ATTR_NAME: "battery", ATTR_UNIT_OF_MEASUREMENT: PERCENTAGE},
-    "temperature_difference": {
-        ATTR_NAME: "temperature_difference",
-        ATTR_UNIT_OF_MEASUREMENT: DEGREE,
-    },
-    "valve_position": {
-        ATTR_NAME: "valve_position",
-        ATTR_UNIT_OF_MEASUREMENT: PERCENTAGE,
-    },
+    "battery": {ATTR_UNIT_OF_MEASUREMENT: PERCENTAGE},
+    "temperature_difference": {ATTR_UNIT_OF_MEASUREMENT: DEGREE},
+    "valve_position": {ATTR_UNIT_OF_MEASUREMENT: PERCENTAGE},
     # Plug
-    "electricity_consumed": {
-        ATTR_NAME: "electricity_consumed",
-        ATTR_UNIT_OF_MEASUREMENT: POWER_WATT,
-    },
-    "electricity_produced": {
-        ATTR_NAME: "electricity_produced",
-        ATTR_UNIT_OF_MEASUREMENT: POWER_WATT,
-    },
-    "relay": {ATTR_NAME: "relay", ATTR_UNIT_OF_MEASUREMENT: None},
+    "electricity_consumed": {ATTR_UNIT_OF_MEASUREMENT: POWER_WATT},
+    "electricity_produced": {ATTR_UNIT_OF_MEASUREMENT: POWER_WATT},
+    "relay": {ATTR_UNIT_OF_MEASUREMENT: None},
 }
 
 SMILES = {

plugwise/node.py

@@ -3,7 +3,6 @@
 import logging
 
 from plugwise.constants import (
-    HW_MODELS,
     SENSOR_AVAILABLE,
     SENSOR_PING,
     SENSOR_RSSI_IN,
@@ -22,7 +21,7 @@
     NodeInfoResponse,
     NodePingResponse,
 )
-from plugwise.util import validate_mac
+from plugwise.util import validate_mac, version_to_model
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -62,20 +61,8 @@ def __init__(self, mac, address, stick):
     def get_node_type(self) -> str:
         """Return hardware model."""
         if self._hardware_version:
-            hw_model = HW_MODELS.get(self._hardware_version[4:10], None)
-            if hw_model:
-                return hw_model
-
-            # Try again with reversed order
-            hw_model = HW_MODELS.get(
-                self._hardware_version[-2:]
-                + self._hardware_version[-4:-2]
-                + self._hardware_version[-6:-4],
-                None,
-            )
-            if hw_model:
-                return hw_model
-        return "Unknown"
+            return version_to_model(self._hardware_version)
+        return None
 
     def is_sed(self) -> bool:
         """Return True if node SED (battery powered)."""