homebridge-dummy 1.1.0-beta.0 → 1.1.0-beta.2

package/CHANGELOG.md

@@ -1,25 +1,27 @@
-## ‼️ WARNING - READ BEFORE CONTINUING ‼️
-
-If upgrading from v0.9.2 or earlier, automations and scenes using Homebridge Dummy accessories will need to be reconfigured.
-
-## ⚠️ IMPORTANT ⚠️
-
-After installing v1.0, you must **RESTART HOMEBRIDGE SERVICE & UI** (not just *RESTART HOMEBRIDGE*) before continuing or you will experience issues with Homebridge Dummy configuration.
+# Change Log
 
-Once you have restarted both Homebridge and the UI, you will need to open the Homebridge Dummy plugin settings to run the accessory migration helper.
+All notable changes to homebridge-dummy will be documented in this file.
 
-Full details [here](https://github.com/mpatfield/homebridge-dummy?tab=readme-ov-file#v10-migration).
+## 1.1.0-beta.2 (2025-07-31)
 
-# Change Log
+### ‼️ WARNING — Read this if upgrading from v0.9.2 or earlier…
 
-All notable changes to homebridge-dummy will be documented in this file.
+Automations and scenes using Homebridge Dummy accessories will need to be reconfigured. After upgrading, you must **RESTART HOMEBRIDGE SERVICE & UI** (not just *RESTART HOMEBRIDGE*). After restarting, open the Homebridge Dummy plugin settings to run the accessory migration helper. Full details [here](https://github.com/mpatfield/homebridge-dummy?tab=readme-ov-file#v10-migration).
 
-## 1.1.0-beta.X (XXXX-XX-XX)
+---
 
 ### Added
-
 - Groups (Beta) - Items sharing the same group name will be collected together in the Home app UI
-    - ⚠️ Adding/removing/changing the group name will require you to reconfigure any HomeKit scenes or automations
+    - ⚠️ Adding/removing/changing the group name for an accessory will require you to reconfigure any HomeKit scenes or automations
+- Auto-Trigger feature to invoke accessory at a specified interval or times
+- Support for Thermostats
+    - Manual control only, no auto-trigger or auto-reset functionality
+
+### Changed
+- Reorganized plugin config UI and renamed "Timer" to "Auto-Reset"
+
+### Fixed
+- Timers over 1 hour were logging incorrectly ([#143](https://github.com/mpatfield/homebridge-dummy/issues/143))
 
 ## 1.0.0 (2025-07-23)
 

package/README.md

@@ -85,22 +85,35 @@ Using the Homebridge Config UI is the easiest way to set up this plugin. However
         {
             "id": "string",
             "name": "string",
+            "type": "Door | Lightbulb | LockMechanism | Outlet | Switch | Thermostat | Window | WindoCovering",
             "groupName": "string",
-            "type": "Door | Lightbulb | LockMechanism | Outlet | Switch | Window | WindoCovering",
             "timer": {
                 "delay": number,
                 "units": "SECONDS | MINUTES | HOURS",
                 "random": true | false
             },
+            "trigger": {
+                "type": "INTERVAL" | "CRON",
+                "interval": number,
+                "units": "SECONDS | MINUTES | HOURS",
+                "random": true | false,
+                "cron": "string"
+            },
             "sensor": "CarbonDioxideSensor | CarbonMonoxideSensor | ContactSensor | LeakSensor | MotionSensor | OccupancySensor | SmokeSensor",
+            "temperatureUnits": "C" | "F",
             "defaultOn": true | false,
             "defaultBrightness": 0-100,
             "defaultLockState": "locked" | "unlocked",
             "defaultPosition": "open" | "closed",
-            "onCommand": "string",
-            "offCommand": "string",
-            "lockCommand": "string",
-            "unlockCommand": "string",
+            "defaultThermostatState": "auto" | "heat" | "cool" | "off",
+            "defaultTemperature": number,
+            "commandOn": "string",
+            "commandOff": "string",
+            "commandLock": "string",
+            "commandUnlock": "string",
+            "commandOpen": "string",
+            "commandClose": "string",
+            "commandTemperature": "string",
             "resetOnRestart": true | false,
             "disableLogging": true | false
         }
@@ -115,7 +128,7 @@ All fields are optional unless noted with an asterisk (*)
 - `id`* - A unique identifier for the accessory. Changing this value will create a new accessory.
 
 - `name`* - The display name for the accessory in HomeKit
-- `type`* - The type of accessory: `Door`, `Lightbulb`, `LockMechanism`, `Outlet`, `Switch`, `Window`, or `WindowCovering`
+- `type`* - The type of accessory: `Door`, `Lightbulb`, `LockMechanism`, `Outlet`, `Switch`, `Thermostat`, `Window`, or `WindowCovering`
 
 - `groupName` - (Beta) Items sharing the same group name will be collected together in the Home app UI
     - ⚠️ Adding/removing/changing the group name will require you to reconfigure any HomeKit scenes or automations
@@ -124,10 +137,19 @@ All fields are optional unless noted with an asterisk (*)
 - `timer.units` — The units to use for delay above (`SECONDS`, `MINUTES`, or `HOURS`). *Required if delay is set.
 - `timer.random` — If true, the delay will be randomized with a maximum value of `timer.delay`
 
+- `trigger.type` — Automatically set the accessory to it's non-default value
+- `trigger.interval` — Trigger the accessory after this many seconds/minutes/hours. *Required if `trigger.type` = `INTERVAL`
+- `trigger.units` — The units to use for the interval (`SECONDS`, `MINUTES`, or `HOURS`) *Required if `trigger.type` = `INTERVAL`
+- `trigger.random` — If true, the interval will be randomized with a maximum value of `trigger.interval`
+- `trigger.cron` — The cron string for triggering the accessory.  *Required if `trigger.type` = `CRON`
+    - See [crontab.guru](http://crontab.guru) for help
+
 - `sensor` - Optionally attach a sensor that mirrors the state of the parent accessory
     - Only works with `Lightbulb`, `Outlet`, and `Switch`
     - Valid values are `CarbonDioxideSensor`, `CarbonMonoxideSensor`, `ContactSensor`, `LeakSensor`, `MotionSensor`, `OccupancySensor`, or `SmokeSensor`
 
+- `temperatureUnits` - Units to use for thermostats, either 'C' or 'F'
+
 - `defaultOn` — Initial value. Default _ON_ = true, default _OFF_ = false
 
 - `defaultBrightness` — If set, lightbulb will have additional dimmer settings with this default brightness percentage
@@ -136,13 +158,19 @@ All fields are optional unless noted with an asterisk (*)
 
 - `defaultPosition` — Initial position for the door/window/blinds, "open" or "closed"
 
-- `onCommand` - Arbitraty command to execute when lightbulb/outlet/switch turns on
-- `offCommand` - Arbitraty command to execute when lightbulb/outlet/switch turns off
+- `defaultThermostatState` - The initial state for the thermostat, "auto", "heat", "cool", or "off"
+
+- `defaultTemperature` - The default temperature for the thermostat in `temperatureUnits` defined above
+
+- `onCommand` - Arbitraty command to execute when lightbulb/outlet/switch/thermostat turns on
+- `offCommand` - Arbitraty command to execute when lightbulb/outlet/switch/thermostat turns off
 
 - `lockCommand` - Arbitraty command to execute when lock mechanism is locked
 - `unlockCommand` - Arbitraty command to execute when lock mechanism is unlocked
 
-- `resetOnRestart` _ If true, all values return to defaults when Homebridge restarts. Ignored when timer is defined.
+- `commandTemperature` - Arbitrary command to execute when temperature changes
+
+- `resetOnRestart` _ If true, accessory will return to default state when Homebridge restarts
 
 - `disableLogging` — If true, state changes will not be logged
 
@@ -273,10 +301,40 @@ All fields are optional unless noted with an asterisk (*)
 }
 ```
 
+### Hourly Trigger Switch
+```json
+{
+    "name": "Hourly",
+    "type": "Switch",
+    "timer": {
+        "delay": 1,
+        "units": "SECONDS"
+    },
+    "trigger": {
+        "type": "INTERVAL",
+        "interval": 1,
+        "units": "HOURS"
+    }
+}
+```
+
+### Thermostat
+```json
+{
+    "name": "Thermostat",
+    "type": "Thermostat",
+    "temperatureUnits": "F",
+    "defaultThermostatState": "heat",
+    "defaultTemperature": 78
+}
+```
+
 ## Credits
 
-Special thanks to [@nfarina](https://github.com/nfarina) for creating the original version of this plugin and maintaining it for almost 10 (!!!) years
+Special thanks to [@nfarina](https://github.com/sponsors/nfarina) for creating the original version of this plugin and maintaining it for almost 10 (!!!) years
 
 [Keryan Belahcene](https://www.instagram.com/keryan.me) for creating the [Flume](https://github.com/homebridge-plugins/homebridge-flume) banner image which was adapted for use with this plugin
 
+Auto-Trigger feature inspired by [Homebridge Schedule](https://github.com/kbrashears5/typescript-homebridge-schedule) by [@kbrashears5](https://github.com/sponsors/kbrashears5)
+
 And to the amazing creators/contributors of [Homebridge](https://homebridge.io) who made this plugin possible!

package/config.schema.json

@@ -27,6 +27,40 @@
             "description": "${config.description.random}"
           }
         }
+      },
+      "trigger": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "title": "${config.title.type}", 
+            "enum": [ "INTERVAL", "CRON"],
+            "enumNames": ["${config.enumNames.interval}", "${config.enumNames.cron}"]
+          },
+          "interval": {
+            "type": "integer",
+            "title": "${config.title.interval}", 
+            "minimum": 1
+          },
+          "units": {
+            "type": "string",
+            "title": "${config.title.units}", 
+            "enum": [ "SECONDS", "MINUTES", "HOURS"],
+            "enumNames": ["${config.enumNames.seconds}", "${config.enumNames.minutes}", "${config.enumNames.hours}"]
+          },
+          "random": {
+            "type": "boolean",
+            "title": "${config.title.random}",
+            "description": "${config.description.random}"
+          },
+          "cron": {
+            "type": "string",
+            "title": "${config.title.cron}", 
+            "description": "${config.description.cron}", 
+            "placeholder": "* * * * * *",
+            "minimum": 1
+          }
+        }        
       }
     },
     "properties": {
@@ -50,20 +84,27 @@
             "type": {
               "type": "string",
               "title": "${config.title.type}", 
-              "enum": ["Door", "Lightbulb", "LockMechanism", "Outlet", "Switch", "Window", "WindowCovering"],
-              "enumNames": ["${config.enumNames.door}", "${config.enumNames.lightbulb}", "${config.enumNames.lockMechanism}", "${config.enumNames.outlet}", "${config.enumNames.switch}", "${config.enumNames.window}", "${config.enumNames.windowCovering}"]
+              "enum": ["Door", "Lightbulb", "LockMechanism", "Outlet", "Switch", "Thermostat", "Window", "WindowCovering"],
+              "enumNames": ["${config.enumNames.door}", "${config.enumNames.lightbulb}", "${config.enumNames.lockMechanism}", "${config.enumNames.outlet}", "${config.enumNames.switch}", "${config.enumNames.thermostat}", "${config.enumNames.window}", "${config.enumNames.windowCovering}"]
             },
             "groupName": {
               "type": "string",
               "title": "${config.title.groupName}"
             },
             "timer": { "$ref": "#/definitions/timer" },
+            "trigger": { "$ref": "#/definitions/trigger" },
             "sensor": {
               "type": "string",
               "title": "${config.title.sensor}",
               "enum": ["CarbonDioxideSensor", "CarbonMonoxideSensor", "ContactSensor", "LeakSensor", "MotionSensor", "OccupancySensor", "SmokeSensor"],
               "enumNames": ["${config.enumNames.carbonDioxideSensor}", "${config.enumNames.carbonMonoxideSensor}", "${config.enumNames.contactSensor}", "${config.enumNames.leakSensor}", "${config.enumNames.motionSensor}", "${config.enumNames.occupancySensor}", "${config.enumNames.smokeSensor}"]
             },
+            "temperatureUnits": {
+              "type": "string",
+              "title": "${config.title.units}",
+              "enum": ["C", "F"],
+              "enumNames": ["${config.enumNames.celsius}", "${config.enumNames.fahrenheit}"]
+            },
             "defaultBrightness": {
               "type": "number",
               "title": "${config.title.defaultBrightness}",
@@ -88,6 +129,16 @@
               "enum": ["open", "closed"],
               "enumNames": ["${config.enumNames.open}", "${config.enumNames.closed}"]
             },
+            "defaultThermostatState": {
+              "type": "string",
+              "title": "${config.title.defaultState}",
+              "enum": ["auto", "heat", "cool", "off"],
+              "enumNames": ["${config.enumNames.auto}", "${config.enumNames.heat}", "${config.enumNames.cool}", "${config.enumNames.off}"]
+            },
+            "defaultTemperature": {
+              "type": "number",
+              "title": "${config.title.defaultTemperature}"
+            },
             "commandOn": {
               "type": "string",
               "title": "${config.title.commandOn}"
@@ -112,6 +163,10 @@
               "type": "string",
               "title": "${config.title.commandClose}"
             },
+            "commandTemperature": {
+              "type": "string",
+              "title": "${config.title.commandTemperature}"
+            },
             "resetOnRestart": {
               "type": "boolean",
               "title": "${config.title.resetOnRestart}"
@@ -143,88 +198,21 @@
               "items": [
                 {
                   "key": "accessories[].name",
-                  "flex": "1 1 0"
+                  "flex": "1 1 33%"
                 },
                 {
                   "key": "accessories[].type",
-                  "flex": "1 1 0"
+                  "flex": "1 1 33%"
                 },
                 {
                   "key": "accessories[].groupName",
-                  "flex": "1 1 0"
-                }
-              ]
-            },
-            {
-              "type": "fieldset",
-              "title": "${config.title.timer}",
-              "description": "${config.description.timer}",
-              "condition": {
-                "functionBody": "return model.accessories?.[arguments[1]]?.type !== undefined;"
-              },
-              "items": [
-                {
-                  "type": "div",
-                  "displayFlex": true,
-                  "flex-direction": "row",
-                  "items": [
-                    {
-                      "key": "accessories[].timer.delay",
-                      "flex": "1 1 0"
-                    },
-                    {
-                      "key": "accessories[].timer.units",
-                      "flex": "1 1 0"
-                    }
-                  ]
-                },
-                {
-                  "key": "accessories[].timer.random",
-                  "condition": {
-                    "functionBody": "return model.accessories?.[arguments[1]]?.timer?.delay !== undefined;"
-                  }
+                  "flex": "1 1 33%"
                 }
               ]
             },
             {
               "type": "fieldset",
-              "title": "${config.title.commands}",
-              "description": "${config.description.commands}",
-              "condition": {
-                "functionBody": "return ['Lightbulb','Outlet','Switch'].includes(model.accessories?.[arguments[1]]?.type);"
-              },
-              "items": [
-                "accessories[].commandOn",
-                "accessories[].commandOff"
-              ]
-            },
-            {
-              "type": "fieldset",
-              "title": "${config.title.commands}",
-              "description": "${config.description.commands}",
-              "condition": {
-                "functionBody": "return ['LockMechanism'].includes(model.accessories?.[arguments[1]]?.type);"
-              },
-              "items": [
-                "accessories[].commandLock",
-                "accessories[].commandUnlock"
-              ]
-            },            
-            {
-              "type": "fieldset",
-              "title": "${config.title.commands}",
-              "description": "${config.description.commands}",
-              "condition": {
-                "functionBody": "return ['Door', 'Window', 'WindowCovering'].includes(model.accessories?.[arguments[1]]?.type);"
-              },
-              "items": [
-                "accessories[].commandOpen",
-                "accessories[].commandClose"
-              ]
-            },
-            {
-              "type": "fieldset",
-              "title": "${config.title.options}",
+              "notitle": true,
               "condition": {
                 "functionBody": "return model.accessories?.[arguments[1]]?.type !== undefined;"
               },
@@ -239,15 +227,15 @@
                   "items": [
                     {
                       "key": "accessories[].defaultOn",
-                      "flex": "0 0 25%"
+                      "flex": "0 0 33%"
                     },
                     {
                       "key": "accessories[].sensor",
-                      "flex": "0 0 25%"
+                      "flex": "0 0 33%"
                     },
                     {
                       "key": "accessories[].defaultBrightness",
-                      "flex": "0 0 25%",
+                      "flex": "0 0 33%",
                       "condition": {
                         "functionBody": "return ['Lightbulb'].includes(model.accessories?.[arguments[1]]?.type);"
                       }
@@ -264,7 +252,7 @@
                   "items": [
                     {
                       "key": "accessories[].defaultLockState",
-                      "flex": "0 0 25%"
+                      "flex": "0 0 33%"
                     }
                   ]
                 },
@@ -278,10 +266,32 @@
                   "items": [
                     {
                       "key": "accessories[].defaultPosition",
-                      "flex": "0 0 25%"
+                      "flex": "0 0 33%"
+                    }
+                  ]
+                },  
+                {
+                  "type": "div",
+                  "displayFlex": true,
+                  "flex-direction": "row",
+                  "condition": {
+                    "functionBody": "return ['Thermostat'].includes(model.accessories?.[arguments[1]]?.type);"
+                  },
+                  "items": [
+                    {
+                      "key": "accessories[].temperatureUnits",
+                      "flex": "0 0 33%"
+                    },
+                    {
+                      "key": "accessories[].defaultThermostatState",
+                      "flex": "0 0 33%"
+                    },
+                    {
+                      "key": "accessories[].defaultTemperature",
+                      "flex": "0 0 33%"
                     }
                   ]
-                },                
+                },              
                 {
                   "type": "div",
                   "displayFlex": true,
@@ -289,19 +299,144 @@
                   "items": [
                     {
                       "key": "accessories[].disableLogging",
-                      "flex": "0 1 25%"
+                      "flex": "0 1 33%"
                     },
                     {
                       "key": "accessories[].resetOnRestart",
-                      "flex": "0 1 25%",
+                      "flex": "0 1 33%",
                       "condition": {
                         "functionBody": "return model.accessories?.[arguments[1]]?.timer?.delay === undefined;"
                       }
-                    }                  
+                    }
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "fieldset",
+              "title": "${config.title.trigger}",
+              "description": "${config.description.trigger}",
+              "condition": {
+                "functionBody": "const type = model.accessories?.[arguments[1]]?.type; return type !== undefined && type !== 'Thermostat';"
+              },
+              "items": [
+                {
+                  "type": "div",
+                  "displayFlex": true,
+                  "flex-direction": "row",
+                  "items": [
+                    {
+                      "key": "accessories[].trigger.type",
+                      "flex": "1 1 33%"
+                    },
+                    {
+                      "key": "accessories[].trigger.interval",
+                      "flex": "1 1 33%",
+                      "condition": {
+                          "functionBody": "return model.accessories?.[arguments[1]]?.trigger?.type === 'INTERVAL';"
+                      }
+                    },
+                    {
+                      "key": "accessories[].trigger.units",
+                      "flex": "1 1 33%",
+                      "condition": {
+                          "functionBody": "return model.accessories?.[arguments[1]]?.trigger?.type === 'INTERVAL';"
+                      }
+                    }
+                  ]
+                },
+                {
+                  "key": "accessories[].trigger.cron",
+                  "condition": {
+                      "functionBody": "return model.accessories?.[arguments[1]]?.trigger?.type === 'CRON';"
+                  }
+                },
+                {
+                  "key": "accessories[].trigger.random",
+                  "condition": {
+                      "functionBody": "return model.accessories?.[arguments[1]]?.trigger?.type === 'INTERVAL';"
+                  }
+                }
+              ]
+            },
+            {
+              "type": "fieldset",
+              "title": "${config.title.timer}",
+              "description": "${config.description.timer}",
+              "condition": {
+                "functionBody": "const type = model.accessories?.[arguments[1]]?.type; return type !== undefined && type !== 'Thermostat';"
+              },
+              "items": [
+                {
+                  "type": "div",
+                  "displayFlex": true,
+                  "flex-direction": "row",
+                  "items": [
+                    {
+                      "key": "accessories[].timer.delay",
+                      "flex": "1 1 33%"
+                    },
+                    {
+                      "key": "accessories[].timer.units",
+                      "flex": "1 1 33%"
+                    },
+                    {
+                      "flex": "1 1 33%"
+                    }
                   ]
+                },
+                "accessories[].timer.random"
+              ]
+            },
+            {
+              "type": "fieldset",
+              "title": "${config.title.commands}",
+              "description": "${config.description.commands}",
+              "items": [
+                {
+                  "key": "accessories[].commandOn",
+                  "condition": {
+                    "functionBody": "return ['Lightbulb','Outlet','Switch','Thermostat'].includes(model.accessories?.[arguments[1]]?.type);"
+                  }
+                },
+                {
+                  "key": "accessories[].commandOff",
+                  "condition": {
+                    "functionBody": "return ['Lightbulb','Outlet','Switch','Thermostat'].includes(model.accessories?.[arguments[1]]?.type);"
+                  }
+                },
+                {
+                  "key": "accessories[].commandLock",
+                  "condition": {
+                    "functionBody": "return ['LockMechanism'].includes(model.accessories?.[arguments[1]]?.type);"
+                  }
+                },
+                {
+                  "key": "accessories[].commandUnlock",
+                  "condition": {
+                    "functionBody": "return ['LockMechanism'].includes(model.accessories?.[arguments[1]]?.type);"
+                  }
+                },
+                {
+                  "key": "accessories[].commandOpen",
+                  "condition": {
+                    "functionBody": "return ['Door', 'Window', 'WindowCovering'].includes(model.accessories?.[arguments[1]]?.type);"
+                  }
+                },
+                {
+                  "key": "accessories[].commandClose",
+                  "condition": {
+                    "functionBody": "return ['Door', 'Window', 'WindowCovering'].includes(model.accessories?.[arguments[1]]?.type);"
+                  }
+                },
+                {
+                  "key": "accessories[].commandTemperature",
+                  "condition": {
+                    "functionBody": "return ['Thermostat'].includes(model.accessories?.[arguments[1]]?.type);"
+                  }
                 }
               ]
-            }           
+            }
           ]
         }
       ]

package/dist/accessory/base.d.ts

@@ -10,17 +10,19 @@ export declare abstract class DummyAccessory<C extends DummyConfig> {
     protected readonly persistPath: string;
     static identifier(config: DummyConfig): string;
     protected readonly accessoryService: Service;
-    private readonly timer;
+    private readonly _timer?;
+    private readonly _trigger?;
     constructor(Service: ServiceType, Characteristic: CharacteristicType, accessory: PlatformAccessory, config: C, log: Log, persistPath: string, isGrouped: boolean);
     protected abstract getAccessoryType(): AccessoryType;
+    protected abstract trigger(): Promise<void>;
+    protected abstract reset(): Promise<void>;
     get subtype(): string | undefined;
     teardown(): void;
     protected get identifier(): string;
     protected get isStateful(): boolean;
     protected get defaultStateStorageKey(): string;
-    protected startTimer(callback: () => Promise<void>): void;
+    protected startTimer(): void;
     protected cancelTimer(): void;
     protected executeCommand(command: string): void;
-    protected assert(...keys: (keyof C)[]): boolean;
-    protected logIfDesired(message: string, ...parameters: string[]): void;
+    protected logIfDesired(message: string, ...parameters: (string | number)[]): void;
 }