homebridge-http-door-lock 0.1.0

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,78 @@
+# homebridge-http-lock
+
+This is a Homebridge plugin for connected locks that expose their controls over HTTP.
+
+Locks enabled through this plugin appear as locks in HomeKit.
+
+### Installation
+
+1. Install [Homebridge](https://homebridge.io/).
+1. Install the plugin: `npm install -g homebridge-http-door-lock`.
+1. Configure the sensors in `config.json`.
+
+### Configuration
+
+```json
+{
+    "platforms": [
+        {
+            "platform": "HTTPDoorLock",
+            "locks": [
+                {
+                    "name": "Simple Lock",
+                    "openEndpoint": {
+                        "url": "https://api.example.com/locks/simple/unlock",
+                        "method": "POST"
+                    },
+                    "closeEndpoint": {
+                        "url": "https://api.example.com/locks/simple/lock",
+                        "method": "POST"
+                    }
+                },
+                {
+                    "name": "Buzzer Lock",
+                    "openEndpoint": {
+                        "url": "https://api.example.com/locks/buzzer/unlock",
+                        "method": "POST",
+                        "headers": {
+                            "Authorization": "Bearer bearer-token"
+                        }
+                    },
+                    "resetLock": {
+                        "enabled": true,
+                        "delay": 5
+                    }
+                },
+                {
+                    "name": "Complex Lock",
+                    "manufacturer": "Lock Manufacturer",
+                    "model": "HTTP-Lock",
+                    "serial": "000000000000",
+                    "openEndpoint": {
+                        "url": "https://api.example.com/locks/complex/unlock",
+                        "method": "POST",
+                        "headers": {
+                            "Authorization": "Bearer bearer-token"
+                        }
+                    },
+                    "closeEndpoint": {
+                        "url": "https://api.example.com/locks/complex/unlock",
+                        "method": "POST",
+                        "headers": {
+                            "Authorization": "Bearer bearer-token"
+                        }
+                    },
+                    "autoLock": {
+                        "enabled": true,
+                        "delay": 5
+                    }
+                }
+            ]
+        }
+    ]
+}
+```
+
+### Supported Sensors
+
+This plugin has been tested with Zigbee locks exposed through the SmartThings API. It should also work with other locks that exposed their controls through HTTP.

package/config.schema.json

@@ -0,0 +1,130 @@
+{
+  "pluginAlias": "HttpLock",
+  "pluginType": "platform",
+  "singular": false,
+  "schema": {
+    "type": "object",
+    "properties": {
+      "locks": {
+        "title": "Locks",
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string"
+            },
+            "manufacturer": {
+              "type": "string"
+            },
+            "model": {
+              "type": "string"
+            },
+            "serial": {
+              "type": "string"
+            },
+            "firmware": {
+              "type": "string"
+            },
+            "openEndpoint": {
+              "type": "string",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "url": {
+                    "type": "string"
+                  },
+                  "method": {
+                    "type": "string"
+                  },
+                  "headers": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "name": {
+                          "type": "string"
+                        },
+                        "value": {
+                          "type": "string"
+                        }
+                      },
+                      "required": []
+                    }
+                  }
+                },
+                "required": [
+                  "url"
+                ]
+              }
+            },
+            "closeEndpoint": {
+              "type": "string",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "url": {
+                    "type": "string"
+                  },
+                  "method": {
+                    "type": "string"
+                  },
+                  "headers": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "name": {
+                          "type": "string"
+                        },
+                        "value": {
+                          "type": "string"
+                        }
+                      },
+                      "required": []
+                    }
+                  }
+                },
+                "required": [
+                  "url"
+                ]
+              }
+            },
+            "autoLock": {
+              "type": "object",
+              "properties": {
+                "enabled": {
+                  "type": "boolean",
+                  "default": false
+                },
+                "delay": {
+                  "type": "number",
+                  "default": 5,
+                  "minimum": 1
+                }
+              }
+            },
+            "resetLock": {
+              "type": "object",
+              "properties": {
+                "enabled": {
+                  "type": "boolean",
+                  "default": false
+                },
+                "delay": {
+                  "type": "number",
+                  "default": 5,
+                  "minimum": 1
+                }
+              }
+            },
+            "required": [
+              "name",
+              "openEndpoint"
+            ]
+          }
+        }
+      }
+    }
+  }
+}

package/dist/index.js

@@ -0,0 +1,8 @@
+import { HttpDoorLockPlatform } from './platform.js';
+import { PLATFORM_NAME } from './settings.js';
+/**
+ * This method registers the platform with Homebridge
+ */
+export default (api) => {
+    api.registerPlatform(PLATFORM_NAME, HttpDoorLockPlatform);
+};

package/dist/platform.js

@@ -0,0 +1,91 @@
+import { HttpDoorLockPlatformAccessory } from './platformAccessory.js';
+import { PLATFORM_NAME, PLUGIN_NAME } from './settings.js';
+/**
+ * HomebridgePlatform
+ * This class is the main constructor for thermometer plugin, this is where it
+ * parses the user config and discover/register accessories with Homebridge.
+ */
+export class HttpDoorLockPlatform {
+    log;
+    config;
+    api;
+    Service;
+    Characteristic;
+    // this is used to track restored cached accessories
+    accessories = [];
+    constructor(log, config, api) {
+        this.log = log;
+        this.config = config;
+        this.api = api;
+        this.Service = api.hap.Service;
+        this.Characteristic = api.hap.Characteristic;
+        this.log.debug('Finished initializing platform:', this.config.name);
+        // When this event is fired it means Homebridge has restored all cached accessories from disk.
+        // Dynamic Platform plugins should only register new accessories after this event was fired,
+        // in order to ensure they weren't added to homebridge already. This event can also be used
+        // to start discovery of new accessories.
+        this.api.on('didFinishLaunching', () => {
+            log.debug('Executed didFinishLaunching callback');
+            // run the method to discover / register your devices as accessories
+            this.discoverDevices();
+        });
+    }
+    /**
+     * This function is invoked when homebridge restores cached accessories from disk at startup.
+     * It should be used to set up event handlers for characteristics and update respective values.
+     */
+    configureAccessory(accessory) {
+        this.log.info('Loading accessory from cache:', accessory.displayName);
+        // add the restored accessory to the accessories cache, so we can track if it has already been registered
+        this.accessories.push(accessory);
+    }
+    /**
+     * This is an example method showing how to register discovered accessories.
+     * Accessories must only be registered once, previously created accessories
+     * must not be registered again to prevent "duplicate UUID" errors.
+     */
+    discoverDevices() {
+        // loop over the discovered devices and register each one if it has not already been registered
+        for (const device of this.config.locks) {
+            // generate a unique id for the accessory this should be generated from
+            // something globally unique, but constant, for example, the device serial
+            // number or MAC address
+            const uuid = this.api.hap.uuid.generate(device.name);
+            // see if an accessory with the same uuid has already been registered and restored from
+            // the cached devices we stored in the `configureAccessory` method above
+            const existingAccessory = this.accessories.find(accessory => accessory.UUID === uuid);
+            if (existingAccessory) {
+                // the accessory already exists
+                this.log.info('Restoring existing accessory from cache:', existingAccessory.displayName);
+                // if you need to update the accessory.context then you should run `api.updatePlatformAccessories`. e.g.:
+                existingAccessory.context.device = device;
+                this.api.updatePlatformAccessories([existingAccessory]);
+                // create the accessory handler for the restored accessory
+                // this is imported from `platformAccessory.ts`
+                new HttpDoorLockPlatformAccessory(this, existingAccessory);
+                const accessoriesToRemove = this.accessories.filter(accessory => {
+                    return !this.config.locks.some((device) => this.api.hap.uuid.generate(device.name) === accessory.UUID);
+                });
+                // remove platform accessories when no longer present
+                if (accessoriesToRemove.length > 0) {
+                    this.api.unregisterPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, accessoriesToRemove);
+                    this.log.info('Removing accessories no longer present from cache:', accessoriesToRemove.map(accessory => accessory.displayName));
+                }
+            }
+            else {
+                // the accessory does not yet exist, so we need to create it
+                this.log.info('Adding new accessory:', device.name);
+                // create a new accessory
+                const accessory = new this.api.platformAccessory(device.name, uuid);
+                // store a copy of the device object in the `accessory.context`
+                // the `context` property can be used to store any data about the accessory you may need
+                accessory.context.device = device;
+                // create the accessory handler for the newly create accessory
+                // this is imported from `platformAccessory.ts`
+                new HttpDoorLockPlatformAccessory(this, accessory);
+                // link the accessory to your platform
+                this.api.registerPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [accessory]);
+            }
+        }
+    }
+}

package/dist/platformAccessory.js

@@ -0,0 +1,78 @@
+/**
+ * Platform Accessory
+ * An instance of this class is created for each accessory the platform registers.
+ */
+export class HttpDoorLockPlatformAccessory {
+    platform;
+    accessory;
+    constructor(platform, accessory) {
+        this.platform = platform;
+        this.accessory = accessory;
+        // set accessory information
+        this.accessory.getService(this.platform.Service.AccessoryInformation)
+            .setCharacteristic(this.platform.Characteristic.Manufacturer, accessory.context.device.manufacturer || 'Device-Manufacturer')
+            .setCharacteristic(this.platform.Characteristic.Model, accessory.context.device.model || 'Default-Model')
+            .setCharacteristic(this.platform.Characteristic.SerialNumber, accessory.context.device.serial || 'Default-Serial');
+        const lockService = this.accessory.getService('Lock Mechanism') || this.accessory.addService(this.platform.Service.LockMechanism, 'Lock Mechanism', 'Lock-Mechanism');
+        lockService.setCharacteristic(this.platform.Characteristic.LockCurrentState, this.platform.Characteristic.LockCurrentState.SECURED);
+        lockService.setCharacteristic(this.platform.Characteristic.LockTargetState, this.platform.Characteristic.LockTargetState.SECURED);
+        lockService
+            .getCharacteristic(this.platform.Characteristic.LockTargetState)
+            .onSet(async (value) => {
+            await this.HandleLockRequest(accessory.context.device, lockService, value);
+        });
+    }
+    /* eslint-disable @typescript-eslint/no-explicit-any */
+    async HandleLockRequest(device, lockService, targetState) {
+        const name = device.name || 'HTTP Lock';
+        const timeout = 10;
+        if (targetState === this.platform.Characteristic.LockTargetState.SECURED) {
+            const response = await fetch(device.closeEndpoint.url, { method: device.closeEndpoint.method || 'GET', headers: device.closeEndpoint.headers || {}, signal: AbortSignal.timeout(timeout * 1000) }).catch(() => null);
+            const success = response?.ok ?? false;
+            if (success) {
+                lockService.updateCharacteristic(this.platform.Characteristic.LockCurrentState, this.platform.Characteristic.LockCurrentState.SECURED);
+                this.platform.log.info(`${name} is locked.`);
+            }
+            else {
+                setTimeout(() => {
+                    lockService.updateCharacteristic(this.platform.Characteristic.LockCurrentState, this.platform.Characteristic.LockCurrentState.UNSECURED);
+                    lockService.updateCharacteristic(this.platform.Characteristic.LockTargetState, this.platform.Characteristic.LockTargetState.UNSECURED);
+                    this.platform.log.error(`Failed to lock ${name}.`);
+                }, 1000);
+            }
+            return;
+        }
+        else if (targetState === this.platform.Characteristic.LockTargetState.UNSECURED) {
+            const response = await fetch(device.openEndpoint.url, { method: device.openEndpoint.method || 'GET', headers: device.openEndpoint.headers || {}, signal: AbortSignal.timeout(timeout * 1000) }).catch(() => null);
+            const success = response?.ok ?? false;
+            if (success) {
+                lockService.updateCharacteristic(this.platform.Characteristic.LockCurrentState, this.platform.Characteristic.LockCurrentState.UNSECURED);
+                this.platform.log.info(`${name} is unlocked.`);
+                if (device.autoLock?.enabled) {
+                    const delay = device.autoLock.delay ?? 5;
+                    setTimeout(() => {
+                        lockService.setCharacteristic(this.platform.Characteristic.LockTargetState, this.platform.Characteristic.LockTargetState.SECURED);
+                        this.platform.log.info(`${name} is auto locked.`);
+                    }, delay * 1000);
+                    return;
+                }
+                else if (device.resetLock?.enabled) {
+                    const delay = device.resetLock.delay ?? 5;
+                    setTimeout(() => {
+                        lockService.updateCharacteristic(this.platform.Characteristic.LockCurrentState, this.platform.Characteristic.LockCurrentState.SECURED);
+                        lockService.updateCharacteristic(this.platform.Characteristic.LockTargetState, this.platform.Characteristic.LockTargetState.SECURED);
+                        this.platform.log.info(`${name} reset to locked.`);
+                    }, delay * 1000);
+                }
+            }
+            else {
+                setTimeout(() => {
+                    lockService.updateCharacteristic(this.platform.Characteristic.LockCurrentState, this.platform.Characteristic.LockCurrentState.SECURED);
+                    lockService.updateCharacteristic(this.platform.Characteristic.LockTargetState, this.platform.Characteristic.LockTargetState.SECURED);
+                    this.platform.log.error(`Failed to unlock ${name}.`);
+                }, 1000);
+            }
+        }
+        return;
+    }
+}

package/dist/settings.js

@@ -0,0 +1,8 @@
+/**
+ * This is the name of the platform that users will use to register the plugin in the Homebridge config.json
+ */
+export const PLATFORM_NAME = 'HttpDoorLock';
+/**
+ * This must match the name of your plugin as defined the package.json
+ */
+export const PLUGIN_NAME = 'homebridge-http-door-lock';

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "homebridge-http-door-lock",
+  "displayName": "HTTP Lock",
+  "type": "module",
+  "version": "0.1.0",
+  "description": "A Homebridge plugin for connected locks that expose their controls over HTTP.",
+  "author": "Jim Liu",
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/homebits/homebridge-http-door-lock#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/homebits/homebridge-http-door-lock.git"
+  },
+  "bugs": {
+    "url": "https://github.com/homebits/homebridge-http-door-lock/issues"
+  },
+  "keywords": [
+    "homebridge-plugin"
+  ],
+  "main": "dist/index.js",
+  "engines": {
+    "node": "^20.18.0 || ^22.10.0 || ^24.0.0",
+    "homebridge": "^1.8.0 || ^2.0.0-beta.0"
+  },
+  "scripts": {
+    "build": "rimraf ./dist && tsc --build",
+    "lint": "eslint . --max-warnings=0",
+    "prepublishOnly": "npm run lint && npm run build",
+    "watch": "npm run build && npm link && nodemon"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.2.0",
+    "eslint": "^9.39.0",
+    "homebridge": "^2.0.0-beta.0",
+    "nodemon": "^3.1.4",
+    "rimraf": "^6.1.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.15.0"
+  }
+}