homebridge-gpio-electic-rim-lock 1.0.4 → 2.0.2

package/.github/workflows/main.yml

@@ -0,0 +1,26 @@
+name: Publish to NPM
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm install --ignore-scripts
+
+      - name: Publish package
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -9,43 +9,45 @@ This plugin assumes that you are using a Raspberry Pi to directly control your e
 
 ## Installation
 
-Install this plugin using: 
+### Via Homebridge UI (Recommended)
+
+1. Open the Homebridge UI
+2. Navigate to Plugins
+3. Search for "homebridge-gpio-electic-rim-lock"
+4. Click Install
+
+### Via npm
 ```
 sudo npm install -g homebridge-gpio-electic-rim-lock --unsafe-perm
 ```
-
+Restart Homebridge after installing.
 
 ## Configuration
 
-You will need to add the following accessory configuration to the Homebridge [config.json](https://github.com/nfarina/homebridge/blob/master/config-sample.json).
+### Via Homebridge UI
+
+The plugin provides a full configuration UI. Navigate to Plugins → Settings for Homebridge Gpio Electic Rim Lock.
 
-Configuration sample:
+### Manual Configuration
 
+Add the following accessory configuration to the Homebridge [config.json](https://github.com/nfarina/homebridge/blob/master/config-sample.json):
 ```JSON
-{
-    "bridge": {
-        "name": "Raspberry Pi 2",
-        "username": "CC:22:3D:E3:CE:32",
-        "port": 51826,
-        "pin": "031-45-154"
-    },
 
+{
     "accessories": [
         {
-                "accessory": "Tiro",
-                "name": "Door",
-                "pin": 12,
-                "duration": 500
+            "accessory": "Tiro",
+            "name": "Door",
+            "pin": 12,
+            "duration": 500
         }
-    ],
-
-    "platforms": []
+    ]
 }
 
 ```
 
 Fields: 
 
-* name - Can be anything (required).
+* name - The door name visible in HomeKit, can be anything (required).
 * pin - The physical GPIO pin number that controls the relay (required).
-* duratin - Number of milliseconds to trigger the relay. Defaults to 1000 millseconds (1 second) if not specified.
+* duratin - Number of milliseconds to trigger the relay. Defaults to 500 millseconds (0,5 second) if not specified.

package/config.schema.json

@@ -0,0 +1,44 @@
+{
+  "pluginAlias": "Tiro",config.schema.json
+  "pluginType": "accessory",
+  "singular": false,
+
+  "headerDisplay": "Homebridge plugin to open electric rim locks via Raspberry Pi GPIO pins.",
+  "footerDisplay": "For documentation, see the [plugin homepage](https://github.com/roberto-montanari/homebridge-gpio-electic-rim-lock) on GitHub.",
+
+  "schema": {
+    "type": "object",
+    "required": [
+      "name",
+      "pin",
+      "duration"
+    ],
+    "properties": {
+
+      "name": {
+        "title": "Door name",
+        "type": "string",
+        "description": "Door name visible in HomeKit",
+        "minLength": 1
+      },
+
+      "pin": {
+        "title": "GPIO pin number",
+        "type": "integer",
+        "description": "The physical GPIO pin number that controls the relay",
+        "enum": [
+          11, 12, 13, 15
+        ]
+      },
+
+      "duration": {
+        "title": "Pulse duration (ms)",
+        "type": "integer",
+        "description": "Number of milliseconds to trigger the relay",
+        "default": 500,
+        "minimum": 500,
+        "maximum": 2000
+      }
+    }
+  }
+}

package/index.js

@@ -25,7 +25,7 @@ function ElecticRimLockAccessory(log, config) {
 	this.lastLockTargetState = 1;
 
 	if (!this.pin) throw new Error("You must provide a config value for pin.");
-	if (this.duration == null || this.duration % 1 != 0) this.duration = 1000;
+	if (this.duration == null || this.duration % 1 != 0) this.duration = 500;
 	this.log("Tiro GPIO version: " + this.version);
 	this.log("Switch pin: " + this.pin);
 	this.log("Active time: " + this.duration + " ms");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-gpio-electic-rim-lock",
-  "version": "1.0.4",
+  "version": "2.0.2",
   "description": "Homebridge plugin to open electric rim locks via Raspberry Pi GPIO pins",
   "main": "index.js",
   "scripts": {
@@ -23,7 +23,7 @@
   "homepage": "https://github.com/roberto-montanari/homebridge-gpio-electic-rim-lock#readme",
   "engines": {
     "node": ">=0.12.0",
-    "homebridge": ">=0.2.0"
+    "homebridge": ">=0.2.0 || ^2.0.0"
   },
   "dependencies": {
     "rpio": ">=0.9.12"