Add support for HmIP-WKP (#481)

* Bump hahomematic to 2023.7.2 * Add entity descriptions and translations for HmIP-WKP
danielperna84 · Jul 12, 2023 · ded84fa · ded84fa
1 parent c94803e
commit ded84fa
Show file tree

Hide file tree

Showing 6 changed files with 152 additions and 9 deletions.
diff --git a/changelog.md b/changelog.md
@@ -2,6 +2,9 @@
 
 - Bump hahomematic to 2023.7.1
   - Log an error about the ping/pong count mismatch
+- Bump hahomematic to 2023.7.2
+  - Add new Events PRESS_LOCK and PRESS_UNLOCK for HmIP-WKP
+- Add entity descriptions and translations for HmIP-WKP
 
 # Version 1.39.0 (2023-07-07)
 

diff --git a/custom_components/homematicip_local/entity_helpers.py b/custom_components/homematicip_local/entity_helpers.py
@@ -109,6 +109,9 @@
         state_class=SensorStateClass.MEASUREMENT,
         entity_category=EntityCategory.DIAGNOSTIC,
     ),
+    "CODE_ID": HmSensorEntityDescription(
+        key="CODE_ID",
+    ),
     "CONCENTRATION": HmSensorEntityDescription(
         key="CONCENTRATION",
         native_unit_of_measurement=CONCENTRATION_PARTS_PER_MILLION,
@@ -356,6 +359,14 @@
 _SENSOR_DESCRIPTIONS_BY_DEVICE_AND_PARAM: dict[
     tuple[str | tuple[str, ...], str], EntityDescription
 ] = {
+    (
+        "HmIP-WKP",
+        "CODE_STATE",
+    ): HmSensorEntityDescription(
+        key="WKP_CODE_STATE",
+        device_class=SensorDeviceClass.ENUM,
+        translation_key="wkp_code_state",
+    ),
     (
         ("HmIP-SRH", "HM-Sec-RHS", "HM-Sec-xx", "ZEL STG RM FDK"),
         "STATE",
@@ -455,6 +466,12 @@
         key="ACOUSTIC_ALARM_ACTIVE",
         device_class=BinarySensorDeviceClass.SAFETY,
     ),
+    ("BLOCKED_PERMANENT", "BLOCKED_TEMPORARY"): HmBinarySensorEntityDescription(
+        key="BLOCKED",
+        device_class=BinarySensorDeviceClass.PROBLEM,
+        entity_category=EntityCategory.DIAGNOSTIC,
+        entity_registry_enabled_default=False,
+    ),
     "BURST_LIMIT_WARNING": HmBinarySensorEntityDescription(
         key="BURST_LIMIT_WARNING",
         device_class=BinarySensorDeviceClass.PROBLEM,
@@ -519,7 +536,7 @@
         key="RAINING",
         device_class=BinarySensorDeviceClass.MOISTURE,
     ),
-    "SABOTAGE": HmBinarySensorEntityDescription(
+    ("SABOTAGE", "SABOTAGE_STICKY"): HmBinarySensorEntityDescription(
         key="SABOTAGE",
         device_class=BinarySensorDeviceClass.TAMPER,
         entity_category=EntityCategory.DIAGNOSTIC,

diff --git a/custom_components/homematicip_local/manifest.json b/custom_components/homematicip_local/manifest.json
@@ -10,7 +10,7 @@
   "iot_class": "local_push",
   "issue_tracker": "https://github.com/danielperna84/hahomematic/issues",
   "loggers": ["hahomematic"],
-  "requirements": ["hahomematic==2023.7.1"],
+  "requirements": ["hahomematic==2023.7.2"],
   "ssdp": [
     {
       "manufacturer": "EQ3",

diff --git a/custom_components/homematicip_local/strings.json b/custom_components/homematicip_local/strings.json
@@ -49,10 +49,12 @@
     "trigger_type": {
       "press": "Button \"{subtype}\" pressed",
       "press_cont": "Button \"{subtype}\" continuously pressed",
+      "press_lock": "Lock button \"{subtype}\" pressed",
       "press_long": "Button \"{subtype}\" long pressed",
       "press_long_release": "Button \"{subtype}\" long press released",
       "press_long_start": "Button \"{subtype}\" started long press",
-      "press_short": "Button \"{subtype}\" pressed"
+      "press_short": "Button \"{subtype}\" pressed",
+      "press_unlock": "Unlock button \"{subtype}\" pressed"
     }
   },
   "entity": {
@@ -63,8 +65,11 @@
       "alarmstate": {
         "name": "Alarmstate"
       },
-      "burst_limit_warning": {
-        "name": "Burst Limit Warning"
+      "blocked_permanent": {
+        "name": "Blocked permanent"
+      },
+      "blocked_temporary": {
+        "name": "Blocked temporary"
       },
       "current_passage_direction": {
         "name": "Passage Direction"
@@ -126,9 +131,36 @@
       "sabotage": {
         "name": "Sabotage"
       },
+      "sabotage_sticky": {
+        "name": "Sabotage sticky"
+      },
       "state": {
         "name": ""
       },
+      "user_authorization_01": {
+        "name": "User authorization 1"
+      },
+      "user_authorization_02": {
+        "name": "User authorization 2"
+      },
+      "user_authorization_03": {
+        "name": "User authorization 3"
+      },
+      "user_authorization_04": {
+        "name": "User authorization 4"
+      },
+      "user_authorization_05": {
+        "name": "User authorization 5"
+      },
+      "user_authorization_06": {
+        "name": "User authorization 6"
+      },
+      "user_authorization_07": {
+        "name": "User authorization 7"
+      },
+      "user_authorization_08": {
+        "name": "User authorization 8"
+      },
       "waterlevel_detected": {
         "name": "Waterlevel Detected"
       },
@@ -428,6 +460,14 @@
       },
       "wind_speed": {
         "name": "Wind Speed"
+      },
+      "wkp_code_state": {
+        "name": "Code Status",
+        "state": {
+          "idle": "idle",
+          "known_code_id_received": "known code id received",
+          "unknown_code_detected": "unknown code detected"
+        }
       }
     },
     "switch": {

diff --git a/custom_components/homematicip_local/translations/de.json b/custom_components/homematicip_local/translations/de.json
@@ -49,10 +49,12 @@
     "trigger_type": {
       "press": "Taster \"{subtype}\" wurde gedrückt",
       "press_cont": "Taster \"{subtype}\" wird dauerhaft gedrückt",
+      "press_lock": "Sperrtaster \"{subtype}\" wurde gedrückt",
       "press_long": "Taster \"{subtype}\" wurde lange gedrückt",
       "press_long_release": "Taster \"{subtype}\" wurde nach langem Tastendruck los gelassen",
       "press_long_start": "Taster \"{subtype}\" hat langen Tastendruck gestartet",
-      "press_short": "Taster \"{subtype}\" wurde gedrückt"
+      "press_short": "Taster \"{subtype}\" wurde gedrückt",
+      "press_unlock": "Entsperrtaster \"{subtype}\" wurde gedrückt"
     }
   },
   "entity": {
@@ -63,6 +65,12 @@
       "alarmstate": {
         "name": "Alarmzustand"
       },
+      "blocked_permanent": {
+        "name": "Dauerhaft gesperrt"
+      },
+      "blocked_temporary": {
+        "name": "Vorübergehend gesperrt"
+      },
       "burst_limit_warning": {
         "name": "Burst-Limit-Warnung"
       },
@@ -126,9 +134,36 @@
       "sabotage": {
         "name": "Sabotage"
       },
+      "sabotage_sticky": {
+        "name": "Sabotage festgesetzt"
+      },
       "state": {
         "name": ""
       },
+      "user_authorization_01": {
+        "name": "Benutzerautorisierung 1"
+      },
+      "user_authorization_02": {
+        "name": "Benutzerautorisierung 2"
+      },
+      "user_authorization_03": {
+        "name": "Benutzerautorisierung 3"
+      },
+      "user_authorization_04": {
+        "name": "Benutzerautorisierung 4"
+      },
+      "user_authorization_05": {
+        "name": "Benutzerautorisierung 5"
+      },
+      "user_authorization_06": {
+        "name": "Benutzerautorisierung 6"
+      },
+      "user_authorization_07": {
+        "name": "Benutzerautorisierung 7"
+      },
+      "user_authorization_08": {
+        "name": "Benutzerautorisierung 8"
+      },
       "waterlevel_detected": {
         "name": "Wasserstand erkannt"
       },
@@ -428,6 +463,14 @@
       },
       "wind_speed": {
         "name": "Windgeschwindigkeit"
+      },
+      "wkp_code_state": {
+        "name": "Code Status",
+        "state": {
+          "idle": "Leerlauf",
+          "known_code_id_received": "Bekannte Code-ID erhalten",
+          "unknown_code_detected": "Unbekannter Code erkannt"
+        }
       }
     },
     "switch": {

diff --git a/custom_components/homematicip_local/translations/en.json b/custom_components/homematicip_local/translations/en.json
@@ -49,10 +49,12 @@
     "trigger_type": {
       "press": "Button \"{subtype}\" pressed",
       "press_cont": "Button \"{subtype}\" continuously pressed",
+      "press_lock": "Lock button \"{subtype}\" pressed",
       "press_long": "Button \"{subtype}\" long pressed",
       "press_long_release": "Button \"{subtype}\" long press released",
       "press_long_start": "Button \"{subtype}\" started long press",
-      "press_short": "Button \"{subtype}\" pressed"
+      "press_short": "Button \"{subtype}\" pressed",
+      "press_unlock": "Unlock button \"{subtype}\" pressed"
     }
   },
   "entity": {
@@ -63,8 +65,11 @@
       "alarmstate": {
         "name": "Alarmstate"
       },
-      "burst_limit_warning": {
-        "name": "Burst Limit Warning"
+      "blocked_permanent": {
+        "name": "Blocked permanent"
+      },
+      "blocked_temporary": {
+        "name": "Blocked temporary"
       },
       "current_passage_direction": {
         "name": "Passage Direction"
@@ -126,9 +131,36 @@
       "sabotage": {
         "name": "Sabotage"
       },
+      "sabotage_sticky": {
+        "name": "Sabotage sticky"
+      },
       "state": {
         "name": ""
       },
+      "user_authorization_01": {
+        "name": "User authorization 1"
+      },
+      "user_authorization_02": {
+        "name": "User authorization 2"
+      },
+      "user_authorization_03": {
+        "name": "User authorization 3"
+      },
+      "user_authorization_04": {
+        "name": "User authorization 4"
+      },
+      "user_authorization_05": {
+        "name": "User authorization 5"
+      },
+      "user_authorization_06": {
+        "name": "User authorization 6"
+      },
+      "user_authorization_07": {
+        "name": "User authorization 7"
+      },
+      "user_authorization_08": {
+        "name": "User authorization 8"
+      },
       "waterlevel_detected": {
         "name": "Waterlevel Detected"
       },
@@ -199,6 +231,14 @@
       "carrier_sense_level": {
         "name": "Carrier Sense Level"
       },
+      "code_state": {
+        "name": "Code Status",
+        "state": {
+          "idle": "idle",
+          "known_code_id_received": "known code id received",
+          "unknown_code_detected": "unknown code detected"
+        }
+      },
       "color": {
         "name": "Color"
       },