homebridge-eggtimer-plugin 1.0.30

package/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: teh-hippo

package/.github/dependabot.yml

@@ -0,0 +1,19 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      
+  # Maintain dependencies for npm
+  - package-ecosystem: "pnpm"
+    directory: "/"
+    schedule:
+      interval: "weekly"

package/.github/workflows/audit.yml

@@ -0,0 +1,30 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Audit
+
+on:
+  
+  schedule:
+    - cron: '0 0 * * *'
+  workflow_dispatch:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/cache@v4
+      name: Cache node modules
+      with:
+        path: node_modules
+        key: ${{ runner.os }}-node-${{ hashFiles('**/pnpm-lock.yaml') }}
+    - name: Use Node.js 20.x
+      uses: actions/setup-node@v4.0.2
+      with:
+        node-version: 20.x
+    - uses: pnpm/action-setup@v3
+    - run: pnpm install --frozen-lockfile
+    - run: pnpm audit

package/.github/workflows/auto-merge-dependabot.yml

@@ -0,0 +1,16 @@
+name: Auto-merge Dependabot
+on: pull_request
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    if: github.actor == 'dependabot[bot]' || (startsWith(github.event.pull_request.title, 'Bump to version ') && (github.actor == 'github-actions' || github.actor == 'teh-hippo'))
+    steps:
+      - uses: peter-evans/enable-pull-request-automerge@v3
+        with:
+          pull-request-number: ${{ github.event.pull_request.number }}
+          merge-method: rebase

package/.github/workflows/build.yml

@@ -0,0 +1,32 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Build
+
+on:
+  pull_request:
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/cache@v4
+      name: Cache node modules
+      with:
+        path: node_modules
+        key: ${{ runner.os }}-node-${{ hashFiles('**/pnpm-lock.yaml') }}
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4.0.2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - uses: pnpm/action-setup@v3
+    - run: pnpm install --frozen-lockfile
+    - run: pnpm lint

package/.github/workflows/corepack.yml

@@ -0,0 +1,44 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Update PNPM
+
+on:
+  
+  schedule:
+    - cron: '0 0 * * *'
+  workflow_dispatch:
+    
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/cache@v4
+      name: Cache node modules
+      with:
+        path: node_modules
+        key: ${{ runner.os }}-node-${{ hashFiles('**/pnpm-lock.json') }}
+    - name: Use Node.js 20.x
+      uses: actions/setup-node@v4.0.2
+      with:
+        node-version: 20.x
+    - uses: pnpm/action-setup@v3
+    - run: corepack up
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@v6
+      with:
+        reviewers: teh-hippo
+        delete-branch: true
+        title: Update PNPM
+        commit-message: |
+          Update to the latest PNPM manager.
+        token: ${{ secrets.GITHUB_TOKEN }}
+        committer: AutoHippo <auto@hippo.org>
+        branch: autohippo/update-pnpm-${{ github.run_number }}

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,57 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4.0.2
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+      - uses: pnpm/action-setup@v3
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm build
+      - run: pnpm publish --no-git-checks
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  update-build-number:
+    needs: publish
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-tags: true
+      - uses: actions/setup-node@v4.0.2
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+      - uses: pnpm/action-setup@v3
+      - run: pnpm version patch --no-git-tag-version
+      - name: get-npm-version
+        id: version-after
+        uses: martinbeentjes/npm-get-version-action@v1.3.1
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          add-paths: |
+            package.json
+          delete-branch: true
+          title: Bump to version ${{ steps.version-after.outputs.current-version }}
+          commit-message: |
+            Bump to version ${{ steps.version-after.outputs.current-version }}
+          token: ${{ secrets.PAT }}
+          committer: AutoHippo <auto@hippo.org>
+          branch: bump-to-version-${{ steps.version-after.outputs.current-version }}

package/README.md

@@ -0,0 +1,44 @@
+![node](https://img.shields.io/node/v/homebridge-eggtimer-plugin)
+[![npm](https://img.shields.io/npm/dt/homebridge-eggtimer-plugin.svg)](https://www.npmjs.com/package/homebridge-eggtimer-plugin)
+[![npm version](https://badge.fury.io/js/homebridge-eggtimer-plugin.svg)](https://badge.fury.io/js/homebridge-eggtimer-plugin)
+![Node.js CI](https://github.com/teh-hippo/homebridge-eggtimer-plugin/workflows/Node.js%20CI/badge.svg)
+
+[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
+
+# Homebridge Egg Timer Plugin
+
+Example config.json:
+
+```json
+    "accessories": [
+        {
+            "name": "Timer Bulb 1",
+            "interval": 60000,
+            "stateful": false,
+            "occupancySensor": false,
+            "accessory": "EggTimerBulb",
+        },
+    ]
+```
+
+This plugin will create a fake bulb that provides an everyday egg-timer for automations.
+Brightness is used as an indicator of the time remaining and can be adjusted after the time has started.
+When turned, the brightness will be decremented at set intervals (per minute by default).
+HomeKit automations can be triggered based on the timer commencing (bulb on) and on completion (bulb off).
+
+Unlike [homebridge-delay-switch](https://github.com/nitaybz/homebridge-delay-switch), the timer length is provided each time - similar to a real-world egg timer.
+
+This was created originally created to help with kids' bedtime routines, where nightlights would be turned off automatically after an allowed amount of reading time (call me crazy, its 2023).
+
+Other example usages found since:
+
+* Automating a desk heater for bursts of heat in the winter.
+* Running our air-con for a while and having it turn off automatically.
+
+## Parameters
+
+| Parameter | Description | Default |
+| --------- | ----- | ------- |
+| `interval`| How often to decrement the brightness. | `60000` (1 minute) |
+| `stateful`| Persist the timer state between restarts. | `false` |
+| `occupancySensor`| Add an occupancy sensor that reflects the timer's current state. | `false` |

package/SECURITY.md

@@ -0,0 +1,11 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.0.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+Create an issue and it'll get sorted.

package/config.schema.json

@@ -0,0 +1,37 @@
+{
+    "pluginAlias": "EggTimerBulb",
+    "pluginType": "accessory",
+    "singular": false,
+    "headerDisplay": "Everyday egg timers for HomeBridge",
+    "footerDisplay": "Created by teh-hippo",
+    "schema": {
+        "type": "object",
+        "properties": {
+            "name": {
+                "title": "Accessory Name",
+                "description": "Name for the accessory",
+                "type": "string",
+                "required": true
+            },
+            "interval": {
+                "title": "Interval Time in Milliseconds",
+                "description": "Amount of time in milliseconds to wait in between each decrement of the brightness",
+                "type": "integer",
+                "default": 60000,
+                "required": true
+            },
+            "stateful": {
+                "title": "Stateful",
+                "description": "Persist the timer state between restarts.",
+                "type": "boolean",
+                "required": false
+            },
+            "occupancySensor": {
+                "title": "Occupancy Sensor",
+                "description": "Add an occupancy sensor that reflects the timer's current state",
+                "type": "boolean",
+                "required": false
+            }
+        }
+    }
+  }

package/dist/accessory.d.ts

@@ -0,0 +1,4 @@
+import { API } from "homebridge";
+declare const _default: (api: API) => void;
+export = _default;
+//# sourceMappingURL=accessory.d.ts.map

package/dist/accessory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessory.d.ts","sourceRoot":"","sources":["../src/accessory.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,GAAG,EAKJ,MAAM,YAAY,CAAC;8BA2KL,GAAG;AAAlB,kBAEE"}

package/dist/accessory.js

@@ -0,0 +1,134 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const node_persist_1 = require("node-persist");
+const async_lock_1 = __importDefault(require("async-lock"));
+class EggTimerBulb {
+    constructor(log, config, api) {
+        this.brightness = 0;
+        this.log = log;
+        this.hap = api.hap;
+        this.interval = Number(config.interval);
+        this.stateRestored = false;
+        this.lightbulbService = new this.hap.Service.Lightbulb(config.name);
+        this.lightbulbService.getCharacteristic(this.hap.Characteristic.On)
+            .onGet(this.getOn.bind(this))
+            .onSet(this.setOn.bind(this));
+        this.lightbulbService.getCharacteristic(this.hap.Characteristic.Brightness)
+            .onGet(this.getBrightness.bind(this))
+            .onSet(this.setBrightness.bind(this));
+        this.informationService = new this.hap.Service.AccessoryInformation()
+            .setCharacteristic(this.hap.Characteristic.Manufacturer, "Egg Timer Bulb")
+            .setCharacteristic(this.hap.Characteristic.Model, `${config.name} (${this.interval.toString()}ms)`);
+        this.stateful = config.stateful === true;
+        this.storageKey = `${config.name}-${this.interval.toString()}`;
+        this.storageDir = api.user.persistPath();
+        this.lock = new async_lock_1.default();
+        if (config.occupancySensor === true) {
+            this.occupancyService = new this.hap.Service.OccupancySensor(`${config.name} Active`);
+            this.occupancyService.getCharacteristic(this.hap.Characteristic.OccupancyDetected)
+                .onGet(this.getOccupancy.bind(this));
+        }
+        if (this.stateful) {
+            this.restoreState().catch((error) => {
+                this.log.error(String(error));
+            });
+        }
+    }
+    getServices() {
+        const services = [
+            this.informationService,
+            this.lightbulbService
+        ];
+        if (this.occupancyService) {
+            services.push(this.occupancyService);
+        }
+        return services;
+    }
+    async getOn() {
+        await this.restoreState();
+        return this.brightness > 0;
+    }
+    async setOn(value) {
+        if (!value) {
+            this.log.info("Manually stopping timer.");
+            await this.updateBrightness(0);
+        }
+    }
+    async getBrightness() {
+        await this.restoreState();
+        return this.brightness;
+    }
+    async setBrightness(value) {
+        const brightness = value;
+        await this.updateBrightness(brightness);
+    }
+    async getOccupancy() {
+        await this.restoreState();
+        return this.brightness > 0;
+    }
+    async updateBrightness(value) {
+        this.log.debug(`Brightness: ${this.brightness.toString()} -> ${value.toString()}`);
+        this.brightness = Math.max(0, Math.min(100, value));
+        // Persist state
+        if (this.stateful) {
+            if (this.brightness > 0) {
+                this.log.debug("Caching state");
+                await (0, node_persist_1.set)(this.storageKey, this.brightness);
+            }
+            else {
+                this.log.debug("Deleting state");
+                await (0, node_persist_1.del)(this.storageKey);
+            }
+        }
+        // Update HomeKit
+        const isActive = this.brightness > 0;
+        this.lightbulbService.updateCharacteristic(this.hap.Characteristic.Brightness, this.brightness);
+        this.lightbulbService.updateCharacteristic(this.hap.Characteristic.On, isActive);
+        if (this.occupancyService !== undefined) {
+            this.occupancyService.updateCharacteristic(this.hap.Characteristic.OccupancyDetected, isActive);
+        }
+        // Update Timer
+        if (isActive && this.timer === undefined) {
+            this.log.info("Starting timer");
+            this.timer = setInterval(() => {
+                this.updateBrightness(this.brightness - 1).catch((error) => {
+                    this.log.error(String(error));
+                });
+            }, this.interval);
+        }
+        else if (this.brightness === 0) {
+            this.log.info("Timer completed.");
+            clearInterval(this.timer);
+            this.timer = undefined;
+        }
+    }
+    async restoreState() {
+        if (!this.stateful || this.stateRestored) {
+            return;
+        }
+        await this.lock.acquire("restoreState", async () => {
+            // Double-lock
+            if (this.stateRestored) {
+                return;
+            }
+            this.log.debug("Checking for stored state.");
+            await (0, node_persist_1.init)({
+                expiredInterval: 1000 * 60 * 60 * 24 * 14, // Delete cached items after 14 days.
+                forgiveParseErrors: true,
+                dir: this.storageDir
+            });
+            const value = await (0, node_persist_1.get)(this.storageKey);
+            if (value !== undefined && value > 0) {
+                this.log.info(`Restoring state to: ${value.toString()}`);
+                await this.updateBrightness(value);
+            }
+            this.stateRestored = true;
+        });
+    }
+}
+module.exports = (api) => {
+    api.registerAccessory("EggTimerBulb", EggTimerBulb);
+};
+//# sourceMappingURL=accessory.js.map

package/dist/accessory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessory.js","sourceRoot":"","sources":["../src/accessory.ts"],"names":[],"mappings":";;;;AAUA,+CAKsB;AAEtB,4DAAmC;AAEnC,MAAM,YAAY;IAehB,YAAY,GAAY,EAAE,MAAuB,EAAE,GAAQ;QAJnD,eAAU,GAAG,CAAC,CAAC;QAKrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAE3B,IAAI,CAAC,gBAAgB,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEpE,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;aAChE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC5B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEhC,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC;aACxE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACpC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAExC,IAAI,CAAC,kBAAkB,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE;aAClE,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,gBAAgB,CAAC;aACzE,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,EAAE,GAAG,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAEtG,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,KAAK,IAAI,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,GAAG,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC;QAC/D,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,oBAAS,EAAE,CAAC;QAE5B,IAAI,MAAM,CAAC,eAAe,KAAK,IAAI,EAAE,CAAC;YACpC,IAAI,CAAC,gBAAgB,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,IAAI,SAAS,CAAC,CAAC;YACtF,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,iBAAiB,CAAC;iBAC/E,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACzC,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;gBAC3C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,WAAW;QACT,MAAM,QAAQ,GAAG;YACf,IAAI,CAAC,kBAAkB;YACvB,IAAI,CAAC,gBAAgB;SACtB,CAAC;QAEF,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACvC,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,KAAK;QACjB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;IAC7B,CAAC;IAEO,KAAK,CAAC,KAAK,CAAC,KAA0B;QAC5C,IAAI,CAAE,KAAiB,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;YAC1C,MAAM,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,aAAa;QACzB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,KAA0B;QACpD,MAAM,UAAU,GAAG,KAAe,CAAC;QACnC,MAAM,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAC1C,CAAC;IAEO,KAAK,CAAC,YAAY;QACxB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;IAC7B,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,KAAa;QAC1C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACnF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QAEpD,gBAAgB;QAChB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,IAAI,CAAC,UAAU,GAAG,CAAC,EAAE,CAAC;gBACxB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;gBAChC,MAAM,IAAA,kBAAG,EAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YAC9C,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;gBACjC,MAAM,IAAA,kBAAG,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QAED,iBAAiB;QACjB,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;QACrC,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAChG,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;QACjF,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACxC,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QAClG,CAAC;QAED,eAAe;QACf,IAAI,QAAQ,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAChC,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE;gBAC5B,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;oBAClE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;gBAChC,CAAC,CAAC,CAAC;YACL,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpB,CAAC;aAAM,IAAI,IAAI,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAClC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC1B,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACzB,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,YAAY;QACxB,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACzC,OAAO;QACT,CAAC;QAED,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE;YACjD,cAAc;YACd,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;gBACvB,OAAO;YACT,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;YAC7C,MAAM,IAAA,mBAAI,EAAC;gBACT,eAAe,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,qCAAqC;gBAChF,kBAAkB,EAAE,IAAI;gBACxB,GAAG,EAAE,IAAI,CAAC,UAAU;aACrB,CAAC,CAAC;YAEH,MAAM,KAAK,GAAG,MAAM,IAAA,kBAAG,EAAC,IAAI,CAAC,UAAU,CAAuB,CAAC;YAC/D,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACrC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,uBAAuB,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;gBACzD,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;YACrC,CAAC;YAED,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,iBAAS,CAAC,GAAQ,EAAE,EAAE;IACpB,GAAG,CAAC,iBAAiB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;AACtD,CAAC,CAAC"}

package/eslint.config.js

@@ -0,0 +1,36 @@
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
+// @ts-check
+
+//import eslint from "@eslint/js";
+const eslint = require('@eslint/js')
+//import tseslint from "typescript-eslint";
+const tseslint = require('typescript-eslint')
+//import stylistic from "@stylistic/eslint-plugin";
+const stylistic = require('@stylistic/eslint-plugin')
+
+module.exports = [
+  ...tseslint.config(
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+    eslint.configs.recommended,
+    ...tseslint.configs.stylisticTypeChecked,
+    ...tseslint.configs.strictTypeChecked,
+    {
+      languageOptions: {
+        parserOptions: {
+          project: true
+        }
+      }
+    }
+  ),
+  stylistic.configs.customize({
+    indent: 2,
+    quotes: "double",
+    commaDangle: "never",
+    quoteProps: "as-needed",
+    arrowParens: false,
+    blockSpacing: true,
+    braceStyle: "1tbs",
+    flat: true,
+    semi: true
+  })
+];

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "homebridge-eggtimer-plugin",
+  "displayName": "Homebridge Eggtimer Plugin",
+  "version": "1.0.30",
+  "description": "Egg Timers for Homebridge: https://github.com/nfarina/homebridge",
+  "license": "MIT",
+  "keywords": [
+    "homebridge-plugin",
+    "egg-timer",
+    "eggtimer",
+    "timer",
+    "countdown",
+    "delay",
+    "automation",
+    "homebridge",
+    "persistent"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/teh-hippo/homebridge-eggtimer-plugin.git"
+  },
+  "bugs": {
+    "url": "http://github.com/teh-hippo/homebridge-eggtimer-plugin/issues"
+  },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/teh-hippo"
+  },
+  "main": "dist/accessory.js",
+  "engines": {
+    "node": ">=16.0.0",
+    "homebridge": ">=1.3.5"
+  },
+  "devDependencies": {
+    "@stylistic/eslint-plugin": "^1.8.0",
+    "@types/async-lock": "^1.4.2",
+    "@types/node": "^20.12.8",
+    "@types/node-persist": "^3.1.8",
+    "eslint": "^8.57.0",
+    "homebridge": "^1.8.1",
+    "rimraf": "^5.0.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^7.8.0"
+  },
+  "dependencies": {
+    "async-lock": "^1.4.1",
+    "node-persist": "^4.0.1"
+  },
+  "packageManager": "pnpm@8.15.8+sha256.691fe176eea9a8a80df20e4976f3dfb44a04841ceb885638fe2a26174f81e65e",
+  "scripts": {
+    "lint": "eslint src",
+    "lintAndFix": "eslint --fix src",
+    "debug": "tsc && homebridge -I -D",
+    "build": "rimraf ./dist && tsc"
+  }
+}

package/src/accessory.ts

@@ -0,0 +1,182 @@
+import {
+  AccessoryConfig,
+  AccessoryPlugin,
+  API,
+  CharacteristicValue,
+  HAP,
+  Logging,
+  Service
+} from "homebridge";
+
+import {
+  init,
+  set,
+  get,
+  del
+} from "node-persist";
+
+import AsyncLock from "async-lock";
+
+class EggTimerBulb implements AccessoryPlugin {
+  private readonly log: Logging;
+  private readonly lightbulbService: Service;
+  private readonly informationService: Service;
+  private readonly occupancyService: Service | undefined;
+  private readonly interval: number;
+  private readonly hap: HAP;
+  private readonly storageKey: string;
+  private readonly storageDir: string;
+  private readonly stateful: boolean;
+  private readonly lock: AsyncLock;
+  private brightness = 0;
+  private timer: NodeJS.Timeout | undefined;
+  private stateRestored: boolean;
+
+  constructor(log: Logging, config: AccessoryConfig, api: API) {
+    this.log = log;
+    this.hap = api.hap;
+    this.interval = Number(config.interval);
+    this.stateRestored = false;
+
+    this.lightbulbService = new this.hap.Service.Lightbulb(config.name);
+
+    this.lightbulbService.getCharacteristic(this.hap.Characteristic.On)
+      .onGet(this.getOn.bind(this))
+      .onSet(this.setOn.bind(this));
+
+    this.lightbulbService.getCharacteristic(this.hap.Characteristic.Brightness)
+      .onGet(this.getBrightness.bind(this))
+      .onSet(this.setBrightness.bind(this));
+
+    this.informationService = new this.hap.Service.AccessoryInformation()
+      .setCharacteristic(this.hap.Characteristic.Manufacturer, "Egg Timer Bulb")
+      .setCharacteristic(this.hap.Characteristic.Model, `${config.name} (${this.interval.toString()}ms)`);
+
+    this.stateful = config.stateful === true;
+    this.storageKey = `${config.name}-${this.interval.toString()}`;
+    this.storageDir = api.user.persistPath();
+    this.lock = new AsyncLock();
+
+    if (config.occupancySensor === true) {
+      this.occupancyService = new this.hap.Service.OccupancySensor(`${config.name} Active`);
+      this.occupancyService.getCharacteristic(this.hap.Characteristic.OccupancyDetected)
+        .onGet(this.getOccupancy.bind(this));
+    }
+
+    if (this.stateful) {
+      this.restoreState().catch((error: unknown) => {
+        this.log.error(String(error));
+      });
+    }
+  }
+
+  getServices(): Service[] {
+    const services = [
+      this.informationService,
+      this.lightbulbService
+    ];
+
+    if (this.occupancyService) {
+      services.push(this.occupancyService);
+    }
+
+    return services;
+  }
+
+  private async getOn(): Promise<boolean> {
+    await this.restoreState();
+    return this.brightness > 0;
+  }
+
+  private async setOn(value: CharacteristicValue): Promise<void> {
+    if (!(value as boolean)) {
+      this.log.info("Manually stopping timer.");
+      await this.updateBrightness(0);
+    }
+  }
+
+  private async getBrightness(): Promise<number> {
+    await this.restoreState();
+    return this.brightness;
+  }
+
+  private async setBrightness(value: CharacteristicValue): Promise<void> {
+    const brightness = value as number;
+    await this.updateBrightness(brightness);
+  }
+
+  private async getOccupancy(): Promise<boolean> {
+    await this.restoreState();
+    return this.brightness > 0;
+  }
+
+  private async updateBrightness(value: number): Promise<void> {
+    this.log.debug(`Brightness: ${this.brightness.toString()} -> ${value.toString()}`);
+    this.brightness = Math.max(0, Math.min(100, value));
+
+    // Persist state
+    if (this.stateful) {
+      if (this.brightness > 0) {
+        this.log.debug("Caching state");
+        await set(this.storageKey, this.brightness);
+      } else {
+        this.log.debug("Deleting state");
+        await del(this.storageKey);
+      }
+    }
+
+    // Update HomeKit
+    const isActive = this.brightness > 0;
+    this.lightbulbService.updateCharacteristic(this.hap.Characteristic.Brightness, this.brightness);
+    this.lightbulbService.updateCharacteristic(this.hap.Characteristic.On, isActive);
+    if (this.occupancyService !== undefined) {
+      this.occupancyService.updateCharacteristic(this.hap.Characteristic.OccupancyDetected, isActive);
+    }
+
+    // Update Timer
+    if (isActive && this.timer === undefined) {
+      this.log.info("Starting timer");
+      this.timer = setInterval(() => {
+        this.updateBrightness(this.brightness - 1).catch((error: unknown) => {
+          this.log.error(String(error));
+        });
+      }, this.interval);
+    } else if (this.brightness === 0) {
+      this.log.info("Timer completed.");
+      clearInterval(this.timer);
+      this.timer = undefined;
+    }
+  }
+
+  private async restoreState(): Promise<void> {
+    if (!this.stateful || this.stateRestored) {
+      return;
+    }
+
+    await this.lock.acquire("restoreState", async () => {
+      // Double-lock
+      if (this.stateRestored) {
+        return;
+      }
+
+      this.log.debug("Checking for stored state.");
+      await init({
+        expiredInterval: 1000 * 60 * 60 * 24 * 14, // Delete cached items after 14 days.
+        forgiveParseErrors: true,
+        dir: this.storageDir
+      });
+
+      const value = await get(this.storageKey) as number | undefined;
+      if (value !== undefined && value > 0) {
+        this.log.info(`Restoring state to: ${value.toString()}`);
+        await this.updateBrightness(value);
+      }
+
+      this.stateRestored = true;
+    });
+  }
+}
+
+export = (api: API) => {
+  api.registerAccessory("EggTimerBulb", EggTimerBulb);
+};

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "target": "ES2018", // ~node10
+    "module": "commonjs",
+    "lib": [
+      "es2015",
+      "es2016",
+      "es2017",
+      "es2018"
+    ],
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "noImplicitAny": false
+  },
+  "include": [
+    "src/"
+  ]
+}