Merge pull request #161 from athombv/siren

Add siren support
athombv · Aug 22, 2024 · dc22b39 · dc22b39
2 parents 99ef081 + 6f9589e
commit dc22b39
Show file tree

Hide file tree

Showing 31 changed files with 493 additions and 68 deletions.
diff --git a/.homeycompose/app.json b/.homeycompose/app.json
@@ -1,7 +1,7 @@
 {
   "id": "com.tuya",
   "version": "1.2.3",
-  "compatibility": ">=10.0.0",
+  "compatibility": ">=12.0.0",
   "brandColor": "#FF4800",
   "sdk": 3,
   "platforms": [
@@ -305,4 +305,4 @@
   },
   "support": "https://homey.app/support",
   "source": "https://github.com/athombv/com.tuya"
-}
+}
diff --git a/.homeycompose/flow/actions/send_command_boolean.json b/.homeycompose/flow/actions/send_command_boolean.json
@@ -13,7 +13,7 @@
       "name": "device",
       "type": "device",
       "filter": {
-        "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|heater|camera"
+        "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
       },
       "title": {
         "en": "Device"

diff --git a/.homeycompose/flow/actions/send_command_json.json b/.homeycompose/flow/actions/send_command_json.json
@@ -13,7 +13,7 @@
       "name": "device",
       "type": "device",
       "filter": {
-        "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|heater|camera"
+        "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
       },
       "title": {
         "en": "Device"

diff --git a/.homeycompose/flow/actions/send_command_number.json b/.homeycompose/flow/actions/send_command_number.json
@@ -13,7 +13,7 @@
       "name": "device",
       "type": "device",
       "filter": {
-        "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|heater|camera"
+        "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
       },
       "title": {
         "en": "Device"

diff --git a/.homeycompose/flow/actions/send_command_string.json b/.homeycompose/flow/actions/send_command_string.json
@@ -13,7 +13,7 @@
       "name": "device",
       "type": "device",
       "filter": {
-        "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|heater|camera"
+        "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
       },
       "title": {
         "en": "Device"

diff --git a/.homeycompose/flow/triggers/receive_status_boolean.json b/.homeycompose/flow/triggers/receive_status_boolean.json
@@ -13,7 +13,7 @@
       "name": "device",
       "type": "device",
       "filter": {
-        "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|heater|camera"
+        "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
       },
       "title": {
         "en": "Device"

diff --git a/.homeycompose/flow/triggers/receive_status_json.json b/.homeycompose/flow/triggers/receive_status_json.json
@@ -13,7 +13,7 @@
       "name": "device",
       "type": "device",
       "filter": {
-        "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|heater|camera"
+        "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
       },
       "title": {
         "en": "Device"

diff --git a/.homeycompose/flow/triggers/receive_status_number.json b/.homeycompose/flow/triggers/receive_status_number.json
@@ -13,7 +13,7 @@
       "name": "device",
       "type": "device",
       "filter": {
-        "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|camera"
+        "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
       },
       "title": {
         "en": "Device"

diff --git a/.homeycompose/flow/triggers/receive_status_string.json b/.homeycompose/flow/triggers/receive_status_string.json
@@ -13,7 +13,7 @@
       "name": "device",
       "type": "device",
       "filter": {
-        "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|heater|camera"
+        "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
       },
       "title": {
         "en": "Device"

diff --git a/app.json b/app.json
@@ -2,7 +2,7 @@
   "_comment": "This file is generated. Please edit .homeycompose/app.json instead.",
   "id": "com.tuya",
   "version": "1.2.3",
-  "compatibility": ">=10.0.0",
+  "compatibility": ">=12.0.0",
   "brandColor": "#FF4800",
   "sdk": 3,
   "platforms": [
@@ -399,7 +399,7 @@
             "name": "device",
             "type": "device",
             "filter": {
-              "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|heater|camera"
+              "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
             },
             "title": {
               "en": "Device"
@@ -440,7 +440,7 @@
             "name": "device",
             "type": "device",
             "filter": {
-              "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|heater|camera"
+              "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
             },
             "title": {
               "en": "Device"
@@ -481,7 +481,7 @@
             "name": "device",
             "type": "device",
             "filter": {
-              "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|camera"
+              "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
             },
             "title": {
               "en": "Device"
@@ -522,7 +522,7 @@
             "name": "device",
             "type": "device",
             "filter": {
-              "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|heater|camera"
+              "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
             },
             "title": {
               "en": "Device"
@@ -870,7 +870,7 @@
             "name": "device",
             "type": "device",
             "filter": {
-              "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|heater|camera"
+              "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
             },
             "title": {
               "en": "Device"
@@ -908,7 +908,7 @@
             "name": "device",
             "type": "device",
             "filter": {
-              "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|heater|camera"
+              "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
             },
             "title": {
               "en": "Device"
@@ -946,7 +946,7 @@
             "name": "device",
             "type": "device",
             "filter": {
-              "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|heater|camera"
+              "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
             },
             "title": {
               "en": "Device"
@@ -984,7 +984,7 @@
             "name": "device",
             "type": "device",
             "filter": {
-              "driver_id": "doorbell|fan|light|other|sensor_contact|sensor_motion|sensor_smoke|socket|dimmer|heater|camera"
+              "driver_id": "camera|dimmer|doorbell|fan|heater|light|other|sensor_contact|sensor_motion|sensor_smoke|siren|socket"
             },
             "title": {
               "en": "Device"
@@ -1494,6 +1494,55 @@
           }
         ]
       },
+      {
+        "id": "siren_alarm_volume",
+        "title": {
+          "en": "Set alarm volume"
+        },
+        "titleFormatted": {
+          "en": "Set alarm volume to [[value]]"
+        },
+        "args": [
+          {
+            "type": "device",
+            "name": "device",
+            "filter": "driver_id=siren"
+          },
+          {
+            "name": "value",
+            "type": "dropdown",
+            "title": {
+              "en": "Alarm volume"
+            },
+            "values": [
+              {
+                "id": "low",
+                "label": {
+                  "en": "Low"
+                }
+              },
+              {
+                "id": "middle",
+                "label": {
+                  "en": "Middle"
+                }
+              },
+              {
+                "id": "high",
+                "label": {
+                  "en": "High"
+                }
+              },
+              {
+                "id": "mute",
+                "label": {
+                  "en": "Muted"
+                }
+              }
+            ]
+          }
+        ]
+      },
       {
         "id": "socket_sub_switch_off",
         "highlight": true,
@@ -2898,6 +2947,108 @@
         }
       ]
     },
+    {
+      "capabilities": [
+        "onoff"
+      ],
+      "connectivity": [
+        "cloud"
+      ],
+      "platforms": [
+        "local",
+        "cloud"
+      ],
+      "images": {
+        "small": "/drivers/siren/assets/images/small.png",
+        "large": "/drivers/siren/assets/images/large.png",
+        "xlarge": "/drivers/siren/assets/images/xlarge.png"
+      },
+      "pair": [
+        {
+          "id": "welcome",
+          "navigation": {
+            "next": "login_oauth2"
+          }
+        },
+        {
+          "id": "login_oauth2",
+          "template": "login_oauth2"
+        },
+        {
+          "id": "list_devices",
+          "template": "list_devices",
+          "navigation": {
+            "next": "add_devices"
+          }
+        },
+        {
+          "id": "add_devices",
+          "template": "add_devices"
+        }
+      ],
+      "repair": [
+        {
+          "id": "login_oauth2",
+          "template": "login_oauth2"
+        }
+      ],
+      "class": "siren",
+      "name": {
+        "en": "Siren",
+        "nl": "Sirene"
+      },
+      "id": "siren",
+      "settings": [
+        {
+          "id": "alarm_volume",
+          "type": "dropdown",
+          "label": {
+            "en": "Alarm volume level"
+          },
+          "hint": {
+            "en": "The volume level of the siren."
+          },
+          "value": "middle",
+          "values": [
+            {
+              "id": "low",
+              "label": {
+                "en": "Low"
+              }
+            },
+            {
+              "id": "middle",
+              "label": {
+                "en": "Middle"
+              }
+            },
+            {
+              "id": "high",
+              "label": {
+                "en": "High"
+              }
+            },
+            {
+              "id": "mute",
+              "label": {
+                "en": "Muted"
+              }
+            }
+          ]
+        },
+        {
+          "id": "deviceSpecification",
+          "type": "label",
+          "label": {
+            "en": "Device Specification"
+          },
+          "hint": {
+            "en": "The Tuya specification of this device"
+          },
+          "value": "<not available>"
+        }
+      ]
+    },
     {
       "capabilities": [
         "onoff",

diff --git a/drivers/camera/device.ts b/drivers/camera/device.ts
@@ -1,6 +1,6 @@
 import TuyaOAuth2Device from '../../lib/TuyaOAuth2Device';
 import * as TuyaOAuth2Util from '../../lib/TuyaOAuth2Util';
-import { constIncludes } from '../../lib/TuyaOAuth2Util';
+import { constIncludes, getFromMap } from '../../lib/TuyaOAuth2Util';
 import { SettingsEvent, TuyaStatus } from '../../types/TuyaTypes';
 import {
   CAMERA_ALARM_EVENT_CAPABILITIES,
@@ -50,9 +50,8 @@ module.exports = class TuyaOAuth2DeviceCamera extends TuyaOAuth2Device {
 
     // Reset alarms in case a timeout was interrupted
     for (const tuyaCapability in CAMERA_ALARM_EVENT_CAPABILITIES) {
-      const capability =
-        CAMERA_ALARM_EVENT_CAPABILITIES[tuyaCapability as keyof typeof CAMERA_ALARM_EVENT_CAPABILITIES];
-      if (this.hasCapability(capability)) {
+      const capability = getFromMap(CAMERA_ALARM_EVENT_CAPABILITIES, tuyaCapability);
+      if (capability && this.hasCapability(capability)) {
         await this.setCapabilityValue(capability, false);
       }
     }
@@ -112,8 +111,11 @@ module.exports = class TuyaOAuth2DeviceCamera extends TuyaOAuth2Device {
 
         // Check if the event is for a known alarm
         if (notificationType in CAMERA_ALARM_EVENT_CAPABILITIES) {
-          const alarmCapability =
-            CAMERA_ALARM_EVENT_CAPABILITIES[notificationType as keyof typeof CAMERA_ALARM_EVENT_CAPABILITIES];
+          const alarmCapability = getFromMap(CAMERA_ALARM_EVENT_CAPABILITIES, notificationType);
+          if (!alarmCapability) {
+            continue;
+          }
+
           if (!this.hasCapability(alarmCapability)) {
             await this.addCapability(alarmCapability).catch(this.error);
           }
@@ -166,8 +168,7 @@ module.exports = class TuyaOAuth2DeviceCamera extends TuyaOAuth2Device {
     }
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  async onSettings(event: SettingsEvent<any>): Promise<string | void> {
+  async onSettings(event: SettingsEvent<Record<string, unknown>>): Promise<string | void> {
     return await TuyaOAuth2Util.onSettings(this, event, CAMERA_SETTING_LABELS);
   }
 };