homebridge-gpio-electic-rim-lock 1.0.3 → 2.0.1

package/.github/workflows/publish.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

@@ -1,51 +1,53 @@
 # homebridge-gpio-electic-rim-lock
-Homebridge plugin to open electric rim locks via Raspberry Pi GPIO pins
+Homebridge plugin to open electric rim locks via Raspberry Pi GPIO pins.
 
-# Circuit
+## Circuit
 
 This plugin assumes that you are using a Raspberry Pi to directly control your electric rim locks. Electric rim locks usually have a switch on the wall that you can push to open the door. On my model, this is just a very simple switch that completes a 12vac circuit. The button must be pressed for about a second before the door will open. In order for this to be an effective electric rim locks opener, you need a relay that will perform the duty of the button.
 
-![Schematic](https://github.com/roberto-montanari/homebridge-gpio-electic-rim-lock/blob/master/images/circuit.png?raw=true)
+![Schematic](https://github.com/roberto-montanari/homebridge-gpio-electic-rim-lock/blob/master/images/schematic.png?raw=true)
 
-# Installation
+## 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 --unsafe-perm homebridge-gpio-electic-rim-lock
+sudo npm install -g homebridge-gpio-electic-rim-lock --unsafe-perm
 ```
+Restart Homebridge after installing.
 
+## Configuration
 
-# Configuration
+### Via Homebridge UI
 
-You will need to add the following accessory configuration to the Homebridge [config.json](https://github.com/nfarina/homebridge/blob/master/config-sample.json)
+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": 4000
+            "accessory": "Tiro",
+            "name": "Door",
+            "pin": 12,
+            "duration": 500
         }
-    ],
-
-    "platforms": []
+    ]
 }
 
 ```
 
 Fields: 
 
-* name - 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
+* 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 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

@@ -5,42 +5,54 @@ var rpio = require('rpio');
 module.exports = function(homebridge) {
 	Service = homebridge.hap.Service;
 	Characteristic = homebridge.hap.Characteristic;
-	
-    homebridge.registerAccessory('homebridge-gpio-electic-rim-lock', 'Tiro', ElecticRimLockAccessory);	
+
+	homebridge.registerAccessory('homebridge-gpio-electic-rim-lock', 'Tiro', ElecticRimLockAccessory);	
+}
+
+function getSerial(){
+	var fs = require('fs');
+	var content = fs.readFileSync('/proc/cpuinfo', 'utf8').split("\n");	
+	var serial = content[content.length-2].split(":");
+	return serial[1].slice(9);
 }
 
 function ElecticRimLockAccessory(log, config) {
-    this.log = log;
-    this.name = config['name'];
-    this.pin = config['pin'];
-    this.duration = config['duration'];
+	this.log = log;
+	this.name = config['name'];
+	this.pin = config['pin'];
+	this.duration = config['duration'];
+	this.version = require('./package.json').version;
 	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.pin) throw new Error("You must provide a config value for pin.");
+	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");
 }
 
 ElecticRimLockAccessory.prototype = {
   
 	getServices: function() {	
 		let informationService = new Service.AccessoryInformation();
-    	informationService
-    		.setCharacteristic(Characteristic.Manufacturer, "Muntaner's Technology")
+		informationService
+    			.setCharacteristic(Characteristic.Manufacturer, "Roberto Montanari")
 			.setCharacteristic(Characteristic.Model, "Tiro GPIO")
-			.setCharacteristic(Characteristic.SerialNumber, "000-000-0"+this.pin);
+			.setCharacteristic(Characteristic.SerialNumber, getSerial() + this.pin)
+			.setCharacteristic(Characteristic.FirmwareRevision, this.version);
 
 		let lockMechanismService = new Service.LockMechanism(this.name);
 		lockMechanismService
-    		.getCharacteristic(Characteristic.LockCurrentState)
-    			.on('get', this.getLockCurrentState.bind(this));		
+    			.getCharacteristic(Characteristic.LockCurrentState)
+    				.on('get', this.getLockCurrentState.bind(this));		
 		lockMechanismService
-    		.getCharacteristic(Characteristic.LockTargetState)
-    			.on('get', this.getLockTargetState.bind(this))
-    			.on('set', this.setLockTargetState.bind(this));
+    			.getCharacteristic(Characteristic.LockTargetState)
+    				.on('get', this.getLockTargetState.bind(this))
+    				.on('set', this.setLockTargetState.bind(this));
 
 		this.informationService = informationService;
-    	this.lockMechanismService = lockMechanismService;
-    			
+		this.lockMechanismService = lockMechanismService;
+
 		return [informationService, lockMechanismService];
 	},
 
@@ -61,7 +73,7 @@ ElecticRimLockAccessory.prototype = {
 	setLockTargetState: function(state, callback) {
 		if (state == 0) {
 			this.writePin(1);
-			this.log("Wait " + this.duration + " ms");
+			this.log("Wait for " + this.duration + " ms");
 			var self = this;
 			setTimeout(function(){self.writePin(0)}, this.duration);
 			this.log("Set state to open");
@@ -69,15 +81,15 @@ ElecticRimLockAccessory.prototype = {
 			callback(null);
 		} else {
 			this.writePin(0);
-			this.log("Set state to close");
+			this.log("Set state to closed");
 			this.lastLockTargetState = 1;
 			callback(null);
 		}						
 	},
 
-	writePin: function(val) {
-        this.log("Turning " + (val == 0 ? "off" : "on") + " pin #" + this.pin);
-        rpio.open(this.pin, rpio.OUTPUT);
-        rpio.write(this.pin, val == 0 ? rpio.LOW : rpio.HIGH);
+	writePin: function(val) {	
+		this.log("Turning " + (val == 0 ? "off" : "on") + " pin " + this.pin);
+		rpio.open(this.pin, rpio.OUTPUT);
+		rpio.write(this.pin, val);
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-gpio-electic-rim-lock",
-  "version": "1.0.3",
+  "version": "2.0.1",
   "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"