@joshjohanning/homebridge-fakeswitch 1.0.0

package/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Check npm version compatibility
+        uses: joshjohanning/npm-version-check-action@v2

package/.github/workflows/publish.yml

@@ -0,0 +1,110 @@
+name: Publish Package
+
+on:
+  release:
+    types: [created]
+  workflow_dispatch:
+    inputs:
+      npm:
+        description: 'Publish to NPM'
+        type: boolean
+        default: false
+      gh:
+        description: 'Publish to GitHub Packages'
+        type: boolean
+        default: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+      attestations: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: 20
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build package tarball
+        run: npm pack
+
+      - name: Attest build provenance
+        uses: actions/attest@v4
+        with:
+          subject-path: '*.tgz'
+
+      - name: Upload tarball
+        uses: actions/upload-artifact@v7
+        with:
+          name: package
+          path: '*.tgz'
+          retention-days: 1
+
+  publish_npm:
+    needs: build
+    if: ${{ github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && inputs.npm) }}
+
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Download tarball
+        uses: actions/download-artifact@v8
+        with:
+          name: package
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: 20
+          registry-url: 'https://registry.npmjs.org'
+
+      # Ensure npm 11.5.1 or later is installed
+      - name: Update npm
+        run: npm install -g npm@latest
+
+      - name: NPM publish
+        run: npm publish *.tgz --access public --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  publish_gh:
+    needs: build
+    if: ${{ github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && inputs.gh) }}
+
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Download tarball
+        uses: actions/download-artifact@v8
+        with:
+          name: package
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: 20
+          registry-url: 'https://npm.pkg.github.com'
+
+      - name: GitHub Packages publish
+        run: npm publish *.tgz --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/index.js

@@ -0,0 +1,62 @@
+"use strict";
+
+var Service, Characteristic, HomebridgeAPI;
+
+module.exports = function(homebridge) {
+
+  Service = homebridge.hap.Service;
+  Characteristic = homebridge.hap.Characteristic;
+  HomebridgeAPI = homebridge;
+  homebridge.registerAccessory("homebridge-fakeswitch", "FakeSwitch", FakeSwitch);
+}
+
+function FakeSwitch(log, config) {
+  this.log = log;
+  this.name = config.name;
+  this.stateful = config.stateful;
+  this.reverse = config.reverse;
+  this._service = new Service.Switch(this.name);
+  
+  this.cacheDirectory = HomebridgeAPI.user.persistPath();
+  this.storage = require('node-persist');
+  this.storage.initSync({dir:this.cacheDirectory, forgiveParseErrors: true});
+  
+  this._service.getCharacteristic(Characteristic.On)
+    .on('set', this._setOn.bind(this));
+
+  if (this.reverse) this._service.setCharacteristic(Characteristic.On, true);
+
+  if (this.stateful) {
+	var cachedState = this.storage.getItemSync(this.name);
+	if((cachedState === undefined) || (cachedState === false)) {
+		this._service.setCharacteristic(Characteristic.On, false);
+	} else {
+		this._service.setCharacteristic(Characteristic.On, true);
+	}
+  }
+}
+
+FakeSwitch.prototype.getServices = function() {
+  return [this._service];
+}
+
+FakeSwitch.prototype._setOn = function(on, callback) {
+
+  this.log("Setting switch to " + on);
+
+  if (on && !this.reverse && !this.stateful) {
+    setTimeout(function() {
+      this._service.setCharacteristic(Characteristic.On, false);
+    }.bind(this), 1000);
+  } else if (!on && this.reverse && !this.stateful) {
+    setTimeout(function() {
+      this._service.setCharacteristic(Characteristic.On, true);
+    }.bind(this), 1000);
+  }
+  
+  if (this.stateful) {
+	this.storage.setItemSync(this.name, on);
+  }
+  
+  callback();
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@joshjohanning/homebridge-fakeswitch",
+  "version": "1.0.0",
+  "description": "A simple fake/dummy switch plugin for Homebridge; forked from thncode/homebridge-fakeswitch",
+  "license": "MIT",
+  "keywords": [
+    "homebridge-plugin",
+    "homebridge",
+    "fakeswitch",
+    "dummy-switch"
+  ],
+  "engines": {
+    "node": "^22.12.0 || ^24.0.0",
+    "homebridge": "^1.6.0 || ^2.0.0"
+  },
+  "author": {
+    "name": "Josh Johanning"
+  },
+  "contributors": [
+    {
+      "name": "Thomas Nemec"
+    }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/joshjohanning/homebridge-fakeswitch.git"
+  },
+  "bugs": {
+    "url": "https://github.com/joshjohanning/homebridge-fakeswitch/issues"
+  },
+  "homepage": "https://github.com/joshjohanning/homebridge-fakeswitch#readme",
+  "main": "index.js",
+  "dependencies": {
+    "node-persist": "^4.0.4"
+  }
+}

package/readme.md

@@ -0,0 +1,49 @@
+# "Dummy Switches" Plugin
+
+Example config.json:
+
+```
+    "accessories": [
+        {
+          "accessory": "DummySwitch",
+          "name": "My Switch 1"
+        }   
+    ]
+
+```
+
+With this plugin, you can create any number of fake switches that will do nothing when turned on (and will automatically turn off right afterward, simulating a stateless switch). This can be very useful for advanced automation with HomeKit scenes.
+
+For instance, the Philips Hue app will automatically create HomeKit scenes for you based on Hue Scenes you create. But what if you want to create a scene that contains both Philips Hue actions and other actions (like turning on the coffee maker with a WeMo outlet)? You are forced to either modify the Hue-created scene (which can be a HUGE list of actions if you have lots of lights) or build your own HomeKit lighting scenes.
+
+Instead, you can link scenes using these dummy switches. Let's say you have a Hue Scene called "Rise and Shine" that you want to activate in the morning. And you have also setup the system HomeKit scene "Good Morning" to turn on your coffee maker and disarm you security system. You can add a single dummy switch to your Good Morning scene, then create a Trigger based on the switching-on of the dummy switch that also activates Rise And Shine.
+
+## Stateful Switches
+
+The default behavior of a dummy switch is to turn itself off one second after being turned on. However you may want to create a dummy switch that remains on and must be manually turned off. You can do this by passing an argument in your config.json:
+
+```
+    "accessories": [
+        {
+          "accessory": "DummySwitch",
+          "name": "My Stateful Switch 1",
+          "stateful": true
+        }   
+    ]
+
+```
+
+## Reverse Switches
+
+You may also want to create a dummy switch that turns itself on one second after being turned off. This can be done by passing the 'reverse' argument in your config.json:
+
+```
+    "accessories": [
+        {
+          "accessory": "DummySwitch",
+          "name": "My Stateful Switch 1",
+          "reverse": true
+        }   
+    ]
+
+```