@joshjohanning/homebridge-fakeswitch 1.0.0 → 1.0.1

package/.github/workflows/ci.yml

@@ -9,6 +9,9 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [22, 24]
     permissions:
       contents: read
       pull-requests: read
@@ -17,10 +20,10 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v6
 
-      - name: Setup Node.js
+      - name: Setup Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v6
         with:
-          node-version: '20'
+          node-version: ${{ matrix.node-version }}
           cache: 'npm'
 
       - name: Install dependencies

package/.github/workflows/publish.yml

@@ -30,7 +30,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v6
         with:
-          node-version: 20
+          node-version: 22
           cache: 'npm'
 
       - name: Install dependencies
@@ -78,9 +78,7 @@ jobs:
         run: npm install -g npm@latest
 
       - name: NPM publish
-        run: npm publish *.tgz --access public --provenance
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm publish *.tgz --provenance
 
   publish_gh:
     needs: build

package/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.1] - 2026-05-26
+
+### Docs
+
+- Added migration guide and example configurations to README
+
+### Housekeeping
+
+- Switched publish workflow to npm trusted publishing
+- Fixed Node.js version in CI workflows to match engine requirements
+- Added funding metadata
+- Cleaned up whitespace in `index.js`
+- Renamed `readme.md` to `README.md`
+- Added `LICENSE` file
+
+## [1.0.0] - 2025-05-26
+
+### Initial Release
+
+Fork of [thncode/homebridge-fakeswitch](https://github.com/thncode/homebridge-fakeswitch) with the following changes:
+
+- Renamed package to `@joshjohanning/homebridge-fakeswitch`
+- Updated Node.js engine requirement to `^22.12.0 || ^24.0.0`
+- Updated Homebridge engine requirement to `^1.6.0 || ^2.0.0`
+- Added CI and publish workflows for automated testing and package publishing

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Josh Johanning
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,114 @@
+# "Dummy Switches" Plugin
+
+> [!TIP]
+> This is a drop-in replacement for the original [`homebridge-fakeswitch`](https://github.com/thncode/homebridge-fakeswitch) plugin with explicit Homebridge 2 support. See [Migrating from `homebridge-fakeswitch`](#migrating-from-homebridge-fakeswitch) for setup steps.
+
+Example config.json:
+
+```json
+    "accessories": [
+        {
+          "accessory": "FakeSwitch",
+          "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:
+
+```json
+    "accessories": [
+        {
+          "accessory": "FakeSwitch",
+          "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:
+
+```json
+    "accessories": [
+        {
+          "accessory": "FakeSwitch",
+          "name": "My Stateful Switch 1",
+          "reverse": true
+        }
+    ]
+
+```
+
+## Migrating from `homebridge-fakeswitch`
+
+This package can be used as a drop-in replacement for the original [`homebridge-fakeswitch`](https://www.npmjs.com/package/homebridge-fakeswitch) plugin.
+
+This fork still registers the Homebridge accessory as:
+
+```json
+"accessory": "FakeSwitch"
+```
+
+Existing Homebridge config entries can stay the same. Your existing HomeKit accessories should keep their identity as long as you do not delete cached accessories, rename existing switches, or remove/re-pair the Homebridge bridge.
+
+### Safe migration steps
+
+1. Back up Homebridge from the Homebridge UI.
+2. Stop Homebridge:
+
+   ```bash
+   sudo hb-service stop
+   ```
+
+3. Remove the original plugin:
+
+   ```bash
+   sudo hb-service remove homebridge-magichome-dynamic-platform
+   ```
+
+4. Install this fork:
+
+   ```bash
+   sudo hb-service add @joshjohanning/homebridge-magichome-dynamic-platform
+   ```
+
+5. Start Homebridge:
+
+   ```bash
+   sudo hb-service start
+   ```
+
+6. Check the Homebridge logs:
+
+   ```bash
+   sudo hb-service logs
+   ```
+
+7. Verify your existing MagicHome lights still work in Apple Home.
+
+### Important notes
+
+Do not change existing plugin config from `FakeSwitch` during migration.
+
+Do not remove cached FakeSwitch accessories from Homebridge unless you intentionally want HomeKit to recreate them. Removing cached accessories may break room assignments, scenes, and automations that reference those switches.
+
+### Updating this fork
+
+When a new version is published to npm, update it from the Homebridge UI, or run:
+
+```bash
+sudo hb-service add @joshjohanning/homebridge-fakeswitch
+sudo hb-service restart
+```

package/index.js

@@ -16,11 +16,11 @@ function FakeSwitch(log, config) {
   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));
 
@@ -53,10 +53,10 @@ FakeSwitch.prototype._setOn = function(on, callback) {
       this._service.setCharacteristic(Characteristic.On, true);
     }.bind(this), 1000);
   }
-  
+
   if (this.stateful) {
 	this.storage.setItemSync(this.name, on);
   }
-  
+
   callback();
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@joshjohanning/homebridge-fakeswitch",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A simple fake/dummy switch plugin for Homebridge; forked from thncode/homebridge-fakeswitch",
   "license": "MIT",
   "keywords": [
@@ -29,6 +29,12 @@
     "url": "https://github.com/joshjohanning/homebridge-fakeswitch/issues"
   },
   "homepage": "https://github.com/joshjohanning/homebridge-fakeswitch#readme",
+  "funding": [
+    {
+      "type": "paypal",
+      "url": "https://www.paypal.com/paypalme/joshuajohanning"
+    }
+  ],
   "main": "index.js",
   "dependencies": {
     "node-persist": "^4.0.4"

package/readme.md

@@ -1,49 +0,0 @@
-# "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
-        }   
-    ]
-
-```