Update package version to v0.5.0

.eslintrc

@@ -1,38 +0,0 @@
-{
-  "parser": "@typescript-eslint/parser",
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/eslint-recommended",
-    "plugin:@typescript-eslint/recommended" // uses the recommended rules from the @typescript-eslint/eslint-plugin
-  ],
-  "parserOptions": {
-    "ecmaVersion": 2018,
-    "sourceType": "module"
-  },
-  "ignorePatterns": [
-    "dist"
-  ],
-  "rules": {
-    "quotes": ["warn", "single"],
-    "indent": ["warn", 2, { "SwitchCase": 1 }],
-    "semi": ["off"],
-    "comma-dangle": ["warn", "always-multiline"],
-    "dot-notation": "off",
-    "eqeqeq": "warn",
-    "curly": ["warn", "all"],
-    "brace-style": ["warn"],
-    "prefer-arrow-callback": ["warn"],
-    "max-len": ["warn", 140],
-    "no-console": ["warn"], // use the provided Homebridge log method instead
-    "no-non-null-assertion": ["off"],
-    "comma-spacing": ["error"],
-    "no-multi-spaces": ["warn", { "ignoreEOLComments": true }],
-    "no-trailing-spaces": ["warn"],
-    "lines-between-class-members": ["warn", "always", {"exceptAfterSingleLine": true}],
-    "@typescript-eslint/explicit-function-return-type": "off",
-    "@typescript-eslint/no-non-null-assertion": "off",
-    "@typescript-eslint/explicit-module-boundary-types": "off",
-    "@typescript-eslint/semi": ["warn"],
-    "@typescript-eslint/member-delimiter-style": ["warn"]
-  }
-}

.github/ISSUE_TEMPLATE/bug-report.md

@@ -41,4 +41,4 @@ Show your Homebridge config.json here, remove any sensitive information.
 * **NPM Version**: <!-- npm -v -->
 * **Operating System**: <!-- Raspbian / Ubuntu / Debian / Windows / macOS / Docker / hb-service -->
 
-<!-- Click the "Preview" tab before you submit to ensure the formatting is correct. -->
+<!-- Click the "Preview" tab before you submit to ensure the formatting is correct. -->

.github/ISSUE_TEMPLATE/feature-request.md

@@ -19,5 +19,4 @@ assignees: ''
 **Additional context:**
 <!-- Add any other context or screenshots about the feature request here. -->
 
-
+<!-- Click the "Preview" tab before you submit to ensure the formatting is correct. -->
-<!-- Click the "Preview" tab before you submit to ensure the formatting is correct. -->

.github/ISSUE_TEMPLATE/support-request.md

@@ -35,4 +35,4 @@ Show your Homebridge config.json here, remove any sensitive information.
 * **NPM Version**: <!-- npm -v -->
 * **Operating System**: <!-- Raspbian / Ubuntu / Debian / Windows / macOS / Docker / hb-service -->
 
-<!-- Click the "Preview" tab before you submit to ensure the formatting is correct. -->
+<!-- Click the "Preview" tab before you submit to ensure the formatting is correct. -->

.github/workflows/build.yml

@@ -7,15 +7,15 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
+      fail-fast: false
       matrix:
-        # the Node.js versions to build on
+        node-version: [20.x, 22.x, 24.x]
-        node-version: [12.x, 13.x, 14.x, 15.x, 16.x]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v5
 
-      - name: Use Node.js ${{ matrix.node-version }} 
+      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v6
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -27,5 +27,11 @@ jobs:
 
       - name: Build the project
         run: npm run build
-        env:
+
-          CI: true
+      - name: List, audit, fix outdated dependencies and build again
+        run: |
+          npm list --outdated
+          npm audit || true  # ignore failures
+          npm audit fix || true
+          npm list --outdated
+          npm run build

.github/workflows/publish.yml

@@ -1,18 +1,24 @@
-name: Publish Package to npmjs
+name: Publish Package
+
 on:
-  release:
+  push:
-    types: [created]
+    tags:
+      - 'v*'
+
+permissions:
+  id-token: write  # Required for OIDC
+  contents: read
+
 jobs:
-  build:
+  publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
-      # Setup .npmrc file to publish to npm
+
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: '16.x'
+          node-version: '24'
           registry-url: 'https://registry.npmjs.org'
       - run: npm ci
-      - run: npm publish
+      - run: npm run build --if-present
-        env:
+      - run: npm publish
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.idea/inspectionProfiles/Project_Default.xml

@@ -1,6 +1,11 @@
 <component name="InspectionProjectProfileManager">
   <profile version="1.0">
     <option name="myName" value="Project Default" />
+    <inspection_tool class="DuplicatedCode" enabled="true" level="WEAK WARNING" enabled_by_default="true">
+      <Languages>
+        <language minSize="50" name="TypeScript" />
+      </Languages>
+    </inspection_tool>
     <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
   </profile>
 </component>

.npmignore

@@ -10,7 +10,7 @@ src
 .github
 
 # eslint
-.eslintrc
+eslint.config.js
 
 # typescript
 tsconfig.json
@@ -135,3 +135,5 @@ web_modules/
 .yarn/unplugged
 .yarn/build-state.yml
 .pnp.*
+
+test/

.vscode/settings.json

@@ -1,8 +1,10 @@
 {
   "files.eol": "\n",
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
+    "source.fixAll.eslint": "explicit"
   },
-  "editor.rulers": [ 140 ],
+  "editor.rulers": [
+    140
+  ],
   "eslint.enable": true
 }

README.md

@@ -1,5 +1,5 @@
-<p align="center">
+<p>
-<img src="https://github.com/homebridge/branding/raw/master/logos/homebridge-wordmark-logo-vertical.png" width="150" alt="Homebridge">
+<img src="https://github.com/homebridge/branding/blob/latest/logos/homebridge-color-round-stylized.png" width="150" alt="Homebridge">
 </p>
 
 # Homebridge Multi-Tap-Switch
@@ -31,23 +31,22 @@ or manually by following these instructions:
 
 The configuration allows the user to add multiple **Multi-Tap-Switches**. The following parameters are available:
 
-| Option                             | Default Value  | Characteristic (runtime configuration) | Description                                                                               |
+| Option                              | Default Value  | Characteristic (runtime configuration) | Description                                                                               |
-|------------------------------------|----------------|----------------------------------------|-------------------------------------------------------------------------------------------|
+|-------------------------------------|----------------|----------------------------------------|-------------------------------------------------------------------------------------------|
-| `name`                             | MultiTapSwitch |                                        | Name of the Platform Accessory (primarily shown in logs)                                  |
+| `name`                              | MultiTapSwitch |                                        | Name of the Platform Accessory (primarily shown in logs)                                  |
-| `devices[]`                        |                |                                        | Array of configured devices                                                               |
+| `devices[]`                         |                |                                        | Array of configured devices                                                               |
-| `devices[].name`                   |                |                                        | Name of the switch                                                                        |
+| `devices[].name`                    |                |                                        | Name of the switch                                                                        |
-| `devices[].numberConfiguredScenes` | 5              | `Configured Scenes`                    | Number of **stateless** switches (cannot be changed during runtime)                       |
+| `devices[] .numberConfiguredScenes` | 5              | `Configured Scenes`                    | Number of **stateless** switches (cannot be changed during runtime)                       |
-| `devices[].triggerTimeout`         | 10             | `Trigger Timeout`                      | Seconds, after which the switch is reset (starting from the first **programmable** switch |
+| `devices[] .triggerTimeout`         | 10             | `Trigger Timeout`                      | Seconds, after which the switch is reset (starting from the first **programmable** switch |
-| `devices[].resetAfterSwitchOff`    | false          |                                        | Reset the switch (like after timeout), when it is turned ```OFF```.                       |
+| `devices[] .resetAfterSwitchOff`    | false          |                                        | Reset the switch (like after timeout), when it is turned ```OFF```.                       |
-| `devices[].logging`                | false          |                                        | Logging of switch/trigger actions.                                                        |
+| `devices[] .logging`                | false          |                                        | Logging of switch/trigger actions.                                                        |
 
 The parameter ```triggerTimeout``` can be changed in the configuration during runtime. So, this is just the initial value.
 
-The parameter ```numberConfiguredScenes``` just defines how many **programmable** switches are available. The number of
+The parameter ```numberConfiguredScenes``` just defines how many **programmable** switches are available (currently, there is no limit). The number of
 really **used** switches can configured during runtime, between 0 and the configured number.
 
-> **NOTE:** Additional parameters (also called **Characteristics**) can only be configured via 3rd-party HomeKit apps (i.e.
+> **NOTE:** Additional parameters (also called **Characteristics**) can only be configured via 3rd-party HomeKit apps, but not in the basic Home App!
-> Home+, Controller for HomeKit, etc.), but in the basic Home App!
 
 So, an example **platform** plugin config will look as follows:
 
@@ -66,3 +65,9 @@ So, an example **platform** plugin config will look as follows:
       ]
     }
 ````
+
+## Contribution
+
+Contributions are always welcome. You can also use the code for own projects and adapt it to your specific needs.
+
+If you find any bugs or have ideas for optimizations or new features, feel free.

config.schema.json

@@ -43,12 +43,19 @@
               "required": true,
               "default": 10,
               "minimum": 0,
-              "maximum": 30
+              "maximum": 60
             },
             "resetAfterSwitchOff": {
-              "title": "Reset when switch turned `Off`",
+              "title": "Reset when switch is turned `Off`",
               "type": "boolean",
-              "description": "Reset the switch and trigger index, when the trigger switch is turned <code>Off</code> (independent from timeout)",
+              "description": "Reset the switch and trigger index, when the stateless switch is turned <code>Off</code>",
+              "required": true,
+              "default": false
+            },
+            "triggerSceneAfterSwitchOff": {
+              "title": "Trigger scene, when switch is turned `Off`",
+              "type": "boolean",
+              "description": "Trigger scene <code>0</code> (so called <code>Off</code>-scene), when the stateless switch is turned <code>Off</code> (independent from timeout).<br><b>Note:</b> If this is enabled, rotation starts from switch <code>1</code>, otherwise <code>0</code>.",
               "required": true,
               "default": false
             },
@@ -57,6 +64,15 @@
               "type": "boolean",
               "required": true,
               "default": false
+            },
+            "debounceTimerMs": {
+              "title": "Debounce Timer (in milliseconds)",
+              "type": "number",
+              "description": "Time to wait before the next switch trigger is accepted.<br>Only change this value, if you encounter problems using the HomeKit slider in the Home App",
+              "required": true,
+              "minimum": 10,
+              "maximum": 1000,
+              "default": 150
             }
           }
         }

eslint.config.js

@@ -0,0 +1,35 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    ignores: ['dist/**'],
+  },
+  {
+    rules: {
+      'quotes': ['error', 'single'],
+      'indent': ['error', 2, { 'SwitchCase': 0 }],
+      'linebreak-style': ['error', 'unix'],
+      'semi': ['error', 'always'],
+      'comma-dangle': ['error', 'always-multiline'],
+      'dot-notation': 'error',
+      'eqeqeq': ['error', 'smart'],
+      'curly': ['error', 'all'],
+      'brace-style': ['error'],
+      'prefer-arrow-callback': 'warn',
+      'max-len': ['warn', 160],
+      'object-curly-spacing': ['error', 'always'],
+      'no-use-before-define': 'off',
+      '@typescript-eslint/no-use-before-define': ['error', { 'classes': false, 'enums': false }],
+      '@typescript-eslint/no-unused-vars': ['error', { 'caughtErrors': 'none' }],
+    },
+  },
+  {
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: 'module',
+    },
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+);

package.json

@@ -2,7 +2,7 @@
   "private": false,
   "displayName": "Homebridge Multi-Tap-Switch",
   "name": "homebridge-multi-tap-switch",
-  "version": "0.2.0",
+  "version": "0.5.0",
   "description": "A configurable multi-tap switch for i.e. switching scenes",
   "license": "MIT",
   "repository": {
@@ -13,8 +13,8 @@
     "url": "https://github.com/dtwardow/homebridge-multi-tap-switch/issues"
   },
   "engines": {
-    "node": ">=14.18.1",
+    "node": "^20.18.0 || ^22.10.0 || ^24.0.0",
-    "homebridge": ">=1.3.5"
+    "homebridge": "^1.8.0 || ^2.0.0-beta.0"
   },
   "main": "dist/index.js",
   "scripts": {
@@ -26,16 +26,19 @@
   "keywords": [
     "homebridge-plugin"
   ],
+  "dependencies": {
+    "homebridge-lib": "^7.1.12"
+  },
   "devDependencies": {
-    "@types/node": "^16.10.9",
+    "@eslint/js": "^9.39.1",
-    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@types/node": "^24.10.1",
-    "@typescript-eslint/parser": "^5.0.0",
+    "eslint": "^9.39.1",
-    "eslint": "^8.0.1",
+    "homebridge": "^2.0.0-beta.55",
-    "homebridge": "^1.3.5",
+    "nodemon": "^3.1.11",
-    "nodemon": "^2.0.13",
+    "rimraf": "^6.1.0",
-    "rimraf": "^3.0.2",
+    "ts-node": "^10.9.2",
-    "ts-node": "^10.3.0",
+    "typescript": "^5.9.3",
-    "typescript": "^4.4.4"
+    "typescript-eslint": "^8.46.4"
   },
   "homepage": "https://github.com/dtwardow/homebridge-multi-tap-switch#readme",
   "author": "Dennis Twardowsky <twardowsky@gmail.com>"

src/config.ts

@@ -1,16 +1,21 @@
-import {PlatformConfig} from 'homebridge';
+import { PlatformConfig } from 'homebridge';
 
 const DEFAULT_NUM_OF_CONFIGURED_SCENES = 5;
 const DEFAULT_TRIGGER_TIMEOUT = 10;
 const DEFAULT_RESET_AFTER_SWITCH_OFF = false;
+const DEFAULT_TRIGGER_SCENE_AFTER_SWITCH_OFF = false;
+const DEFAULT_TRIGGER_SCENE_OFF = 0;
 const DEFAULT_LOGGING = false;
+const DEFAULT_DEBOUNCE_TIMEOUT_MS = 150;
 
 export interface PluginDeviceConfig {
   readonly name: string;
   readonly numberConfiguredScenes?: number;
   readonly triggerTimeout?: number;
   readonly resetAfterSwitchOff?: boolean;
+  readonly triggerSceneAfterSwitchOff?: boolean;
   readonly logging?: boolean;
+  readonly debounceTimerMs?: number;
 }
 
 export class PluginConfig {
@@ -50,22 +55,41 @@ export class DeviceConfig {
       || DEFAULT_RESET_AFTER_SWITCH_OFF;
   }
 
+  isTriggerSceneWhenOff(): boolean {
+    return this.device.triggerSceneAfterSwitchOff
+      || DEFAULT_TRIGGER_SCENE_AFTER_SWITCH_OFF;
+  }
+
+  // When triggerSceneAfterSwitchOff is 'true', start at 1, otherwise 0 (normal behavior)
+  FirstTriggerScene(): number {
+    return this.isTriggerSceneWhenOff() ? 1 : 0;
+  }
+
+  TriggerOffSceneIndex(): number {
+    return DEFAULT_TRIGGER_SCENE_OFF;
+  }
+
   isLogging(): boolean {
     return this.device.logging
       || DEFAULT_LOGGING;
   }
+
+  DebounceTimeoutMs(): number {
+    return this.device.debounceTimerMs
+      || DEFAULT_DEBOUNCE_TIMEOUT_MS;
+  }
 }
 
 export interface AccessoryState {
   numberConfiguredScenes: number;
   triggerTimeout: number;
-  //nextSceneToTrigger: number;
+  triggerTimeoutManuallyChanged: boolean;
 }
 
 export function initializeAccessoryState(initConfig: PluginDeviceConfig | AccessoryState): AccessoryState {
   return {
     numberConfiguredScenes: initConfig.numberConfiguredScenes || DEFAULT_NUM_OF_CONFIGURED_SCENES,
     triggerTimeout: initConfig.triggerTimeout || DEFAULT_TRIGGER_TIMEOUT,
-    //nextSceneToTrigger: 0,
+    triggerTimeoutManuallyChanged: false,
   };
 }

src/helper/timeoutHandler.ts

@@ -0,0 +1,45 @@
+import { Logging } from './logger';
+import { clearTimeout } from 'node:timers';
+
+export default class TimeoutHandler {
+  private timeoutObject: NodeJS.Timeout | undefined;
+  public timeoutMs: number = 0;
+  private log: Logging | undefined;
+
+  private isRunning: boolean = false;
+
+  constructor(timeoutMs: number, logger: Logging) {
+    this.log = logger;
+    this.timeoutMs = timeoutMs;
+  }
+
+  public trigger(): void {
+    if (!this.isRunning) {
+      this.timeoutStarted();
+      this.timeoutObject = setTimeout(this.timeoutTriggered.bind(this), this.timeoutMs);
+    }
+  }
+
+  public cancel(): void {
+    if (!this.isRunning) {
+      clearTimeout(this.timeoutObject);
+      this.isRunning = false;
+    }
+  }
+
+  public elapsedAndTrigger(): boolean {
+    if (!this.isRunning) {
+      this.trigger();
+      return true;
+    }
+    return false;
+  }
+
+  private timeoutStarted(): void {
+    this.isRunning = true;
+  }
+
+  async timeoutTriggered(): Promise<void> {
+    this.isRunning = false;
+  }
+}

src/index.ts

@@ -1,7 +1,7 @@
 import { API } from 'homebridge';
 
 import { PLATFORM_NAME } from './settings';
-import { MultiTapSwitchPlatform } from './platform';
+import MultiTapSwitchPlatform from './platform';
 
 /**
  * This method registers the platform with Homebridge

src/platform.ts

@@ -4,24 +4,14 @@ import { PLATFORM_NAME, PLUGIN_NAME } from './settings';
 import { DeviceAccessory } from './platformAccessory';
 
 // Necessary definitions for custom characteristics!
-import ConfiguredScenes from './types/characteristicConfiguredScenes';
+import { initializeAccessoryState, PluginConfig } from './config';
-let IConfiguredScenes;
-import {initializeAccessoryState, PluginConfig} from './config';
-let ITriggerTimeout;
-import TriggerTimeout from './types/characteristicTimeout';
 
 /**
  * HomebridgePlatform
  */
-export class MultiTapSwitchPlatform implements DynamicPlatformPlugin {
+class MultiTapSwitchPlatform implements DynamicPlatformPlugin {
-  public readonly Service: typeof Service = this.api.hap.Service;
+  public readonly Service: typeof Service;
-  public readonly Characteristic:
+  public readonly Characteristic: typeof Characteristic;
-    typeof Characteristic &
-    typeof IConfiguredScenes &
-    typeof ITriggerTimeout;
-
-  private readonly CharacteristicConfiguredScenes;
-  private readonly CharacteristicTriggerTimeout;
 
   // Track restored cached accessories
   public readonly accessories: PlatformAccessory[] = [];
@@ -40,25 +30,15 @@ export class MultiTapSwitchPlatform implements DynamicPlatformPlugin {
     public readonly api: API,
   ) {
     this.Config = new PluginConfig(this.config);
+    this.Service = api.hap.Service;
+    this.Characteristic = api.hap.Characteristic;
 
     this.log.debug('Finished initializing platform:', this.Config.Name);
 
-    this.CharacteristicConfiguredScenes = ConfiguredScenes(this.api);
-    IConfiguredScenes = this.CharacteristicConfiguredScenes;
-    this.CharacteristicTriggerTimeout = TriggerTimeout(this.api);
-    ITriggerTimeout = this.CharacteristicTriggerTimeout;
-
     this.api.on('didFinishLaunching', () => {
       log.debug('Discover/Register Devices ...');
       this.discoverDevices();
     });
-
-    this.Characteristic = Object.defineProperty(this.api.hap.Characteristic,
-      'ConfiguredScenes',
-      {value: this.CharacteristicConfiguredScenes});
-    this.Characteristic = Object.defineProperty(this.api.hap.Characteristic,
-      'TriggerTimeout',
-      {value: this.CharacteristicTriggerTimeout});
   }
 
   /**
@@ -78,13 +58,15 @@ export class MultiTapSwitchPlatform implements DynamicPlatformPlugin {
    * @param serial (optional) Provide an additional number (might be obsolete in future releases)
    */
   defineUuid(name: string | undefined, serial = 'UNDEF'): string {
-    return this.api.hap.uuid.generate(name + '_' + serial);
+    return this.api.hap.uuid.generate(PLATFORM_NAME + '_' + name + '_' + serial);
   }
 
   /**
    * Discover new and existing accessories
    */
   discoverDevices() {
+    const knownUuids: string[] = [];
+
     const parsedConfig = new PluginConfig(this.config);
     for (const device of parsedConfig.Devices) {
       const uuid = this.defineUuid(device.name, '0');
@@ -100,7 +82,7 @@ export class MultiTapSwitchPlatform implements DynamicPlatformPlugin {
         // if you need to update the accessory.context then you should run `api.updatePlatformAccessories`. eg.:
         // existingAccessory.context.device = device;
         // this.api.updatePlatformAccessories([existingAccessory]);
-        if (existingAccessory.context.config !== device) {
+        if (JSON.stringify(existingAccessory.context.config) !== JSON.stringify(device)) {
           this.log.debug('Update Accessory ->', device.name);
           existingAccessory.context.config = device;
           this.api.updatePlatformAccessories([existingAccessory]);
@@ -108,7 +90,9 @@ export class MultiTapSwitchPlatform implements DynamicPlatformPlugin {
 
         // Create the accessory handler for the restored accessory
         // This is imported from `platformAccessory.ts`
-        new DeviceAccessory(this, existingAccessory);
+        new DeviceAccessory(this, this.api, existingAccessory);
+
+        knownUuids.push(uuid);
       } else {
         // Accessory does not yet exist, so we need to create it
         this.log.info('Add Device ->', device.name, '/',
@@ -124,11 +108,21 @@ export class MultiTapSwitchPlatform implements DynamicPlatformPlugin {
 
         // Create the accessory handler for the new  accessory
         // This is imported from `platformAccessory.ts`
-        new DeviceAccessory(this, accessory);
+        new DeviceAccessory(this, this.api, accessory);
 
         // link the accessory to your platform
         this.api.registerPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [accessory]);
       }
     }
+
+    // Unregister unused accessories
+    for (const device of this.accessories) {
+      if (!knownUuids.find(id => id === device.UUID)) {
+        this.log.info('Remove unused device ->', device.displayName, '/', device.UUID);
+        this.api.unregisterPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [device]);
+      }
+    }
   }
 }
+
+export default MultiTapSwitchPlatform;

src/platformAccessory.ts

@@ -1,8 +1,12 @@
-import {CharacteristicValue, PlatformAccessory, Service} from 'homebridge';
+import { CharacteristicValue, PlatformAccessory, Service, API } from 'homebridge';
-import {MultiTapSwitchPlatform} from './platform';
+import MultiTapSwitchPlatform from './platform';
-import {AccessoryState, DeviceConfig} from './config';
+import { AccessoryState, DeviceConfig } from './config';
-import {Logging} from './helper/logger';
+import { Logging } from './helper/logger';
-import {VERSION} from './settings';
+import { VERSION } from './settings';
+import { attachCharacteristic_ConfiguredScenes } from './types/characteristicConfiguredScenes';
+import { attachCharacteristic_TriggerTimeout } from './types/characteristicTimeout';
+import { attachCharacteristic_CurrentScene } from './types/characteristicCurrentScene';
+import TimeoutHandler from './helper/timeoutHandler';
 
 /**
  * Platform Accessory
@@ -11,47 +15,54 @@ export class DeviceAccessory {
   private serviceIn: Service;
   private serviceOut: Service;
 
-  private readonly singleButtonEvents = {
+  private readonly singleButtonEvents;
-    minValue: this.platform.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS,
-    maxValue: this.platform.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS,
-    validValues: [
-      this.platform.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS,
-    ],
-  };
 
   private readonly State: AccessoryState;
   private readonly Config: DeviceConfig;
 
   private readonly TriggerButtons: Service[] = [];
   private SwitchResetTimer: NodeJS.Timeout | undefined;
-  private SwitchOn = false;
+  private SwitchOn: boolean = false;
-  private NextItemToTrigger = 0;
+  private NextItemToTrigger: number = 0;
+  private LastTriggerReceived: TimeoutHandler;
 
   private Log: Logging;
 
   /**
    * Construct the accessory services
    * @param platform Parent Homebridge platform
+   * @param api Parent platform API
    * @param accessory Accessory to which these services will be attached
    */
   constructor(
     private readonly platform: MultiTapSwitchPlatform,
+    private readonly api: API,
     private readonly accessory: PlatformAccessory,
   ) {
+    this.singleButtonEvents = {
+      minValue: this.platform.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS,
+      maxValue: this.platform.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS,
+      validValues: [
+        this.platform.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS,
+      ],
+    };
+
     this.Config = new DeviceConfig(accessory.context.config);
     this.State = this.accessory.context.persistent;
 
     this.Log = new Logging(platform.log, this.Config.Name(), this.Config.isLogging());
     this.Log.log('Initialize Accessory ->', this.Config.Name());
 
+    this.LastTriggerReceived = new TimeoutHandler(this.Config.DebounceTimeoutMs(), this.Log);
+
     /**
      * Accessory information
      */
     this.accessory.getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'HB/dtw')
-      .setCharacteristic(this.platform.Characteristic.Model, 'SceneSwitch')
+      .setCharacteristic(this.platform.Characteristic.Model, 'Multi-Tap-Switch')
       .setCharacteristic(this.platform.Characteristic.Version, VERSION)
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, accessory.UUID);
+      .setCharacteristic(this.platform.Characteristic.SerialNumber, this.Config.Name());
 
     /**
      * Input Service / Switch
@@ -69,8 +80,7 @@ export class DeviceAccessory {
     if (this.State.numberConfiguredScenes > this.Config.NumOfScenes()) {
       this.State.numberConfiguredScenes = this.Config.NumOfScenes();
     }
-    (this.serviceIn.getCharacteristic(this.platform.Characteristic.ConfiguredScenes)
+    attachCharacteristic_ConfiguredScenes(this.serviceIn, this.api)
-      || this.serviceIn.addOptionalCharacteristic(this.platform.Characteristic.ConfiguredScenes))
       .setProps({
         'minValue': 1,
         'maxValue': this.Config.NumOfScenes(),
@@ -81,8 +91,13 @@ export class DeviceAccessory {
       .updateValue(this.State.numberConfiguredScenes);
 
     // Register handlers for the TriggerTimeout characteristic & restore previous value
-    (this.serviceIn.getCharacteristic(this.platform.Characteristic.TriggerTimeout)
+    if (!this.State.triggerTimeoutManuallyChanged) {
-       || this.serviceIn.addOptionalCharacteristic(this.platform.Characteristic.TriggerTimeout))
+      this.State.triggerTimeout = this.Config.TriggerTimeout();
+    } else {
+      this.Log.debug('Current Trigger Timeout [' + this.State.triggerTimeout + '] differs from configured value [' +
+        this.Config.TriggerTimeout() + ']. It won\'t be updated until it\'s equal again.');
+    }
+    attachCharacteristic_TriggerTimeout(this.serviceIn, this.api)
       .setProps({
         'minValue': 0,
         'maxValue': 30,
@@ -92,6 +107,17 @@ export class DeviceAccessory {
       .onGet(this.getTriggerTimeout.bind(this))
       .updateValue(this.State.triggerTimeout);
 
+    // Register handlers for the CurrentScene characteristic & restore previous value
+    attachCharacteristic_CurrentScene(this.serviceIn, this.api)
+      .setProps({
+        'minValue': 0,
+        'maxValue': this.Config.NumOfScenes(),
+        'minStep': 1,
+      })
+      .onSet(this.setCurrentScene.bind(this))
+      .onGet(this.getCurrentScene.bind(this))
+      .updateValue(this.NextItemToTrigger = this.Config.FirstTriggerScene());
+
     // Set the service name, this is what is displayed as the default name on the Home app
     this.serviceIn.setCharacteristic(this.platform.Characteristic.Name, this.Config.Name());
 
@@ -115,7 +141,9 @@ export class DeviceAccessory {
         this.serviceOut.addLinkedService(newButton);
         newButton.getCharacteristic(this.platform.Characteristic.ProgrammableSwitchEvent)
           .setProps(this.singleButtonEvents);
-        newButton.setCharacteristic(this.platform.Characteristic.ServiceLabelIndex, i);
+        newButton
+          .setCharacteristic(this.platform.Characteristic.ServiceLabelIndex, i)
+          .setCharacteristic(this.platform.Characteristic.Name, 'Scene ' + i);
       }
 
       // Push switches to an internal list for later use
@@ -141,14 +169,13 @@ export class DeviceAccessory {
   /**
    * Trigger/Fire the next programmable switch event
    */
-  triggerNext() {
+  trigger(index: number) {
-    if (this.NextItemToTrigger >= this.State.numberConfiguredScenes) {
+    if ((index >= 0) && (index < this.State.numberConfiguredScenes)) {
-      this.NextItemToTrigger = 0;
+      this.Log.log('Trigger Event -> ', index);
+      this.TriggerButtons[index].updateCharacteristic(this.platform.Characteristic.ProgrammableSwitchEvent, 0);
+    } else {
+      this.Log.error('Trigger Event -> Index ', index, ' out of bounds (min = 0, max = ', this.State.numberConfiguredScenes - 1, ')');
     }
-
-    // Trigger Scene Button
-    this.Log.log('Trigger Event -> ', this.NextItemToTrigger);
-    this.TriggerButtons[this.NextItemToTrigger++].updateCharacteristic(this.platform.Characteristic.ProgrammableSwitchEvent, 0);
   }
 
   /**
@@ -157,39 +184,59 @@ export class DeviceAccessory {
   resetTrigger() {
     this.Log.log('Reset Scene Trigger');
     this.serviceIn.updateCharacteristic(this.platform.Characteristic.On, this.SwitchOn = false);
-    this.NextItemToTrigger = 0;
+    this.NextItemToTrigger = this.Config.FirstTriggerScene();
   }
 
+  // =====================
+  // = Handler Functions =
+  // =====================
+
   /**
    * Handle state changes of the input switch
    * This function does all the necessary work.
    * @param value Target switch state from Automation or manual state change
    */
   async setOn(value: CharacteristicValue) {
-    // implement your own code to turn your device on/off
+    // Check if debounce timer has elapsed. If not, ignore the command.
-    this.SwitchOn = value as boolean;
+    if (this.LastTriggerReceived.elapsedAndTrigger()) {
+      this.SwitchOn = value as boolean;
 
-    if (this.SwitchOn) {
+      if (this.SwitchOn) { // Switch is set to 'ON'
-      if (this.SwitchResetTimer) {
+        // Disable an active reset timer, before starting a new one.
-        clearTimeout(this.SwitchResetTimer);
+        if (this.SwitchResetTimer) {
+          clearTimeout(this.SwitchResetTimer);
+        }
+
+        // Start the reset timer, if parameter is greater than 0.
+        // Otherwise, do nothing.
+        if (this.State.triggerTimeout > 0) {
+          this.SwitchResetTimer = setTimeout(this.resetTrigger.bind(this), this.State.triggerTimeout * 1000);
+        }
+
+        // Determine next item to trigger
+        if (this.NextItemToTrigger >= this.State.numberConfiguredScenes) {
+          this.NextItemToTrigger = this.Config.FirstTriggerScene();
+        }
+        // Trigger Switch
+        this.trigger(this.NextItemToTrigger++);
+      } else { // Switch is set to 'OFF'
+        // If configured: Disable any active reset timer, when the switch is manually turned off
+        if (this.Config.isResetWhenOff()) {
+          if (this.SwitchResetTimer) {
+            clearTimeout(this.SwitchResetTimer);
+          }
+          this.resetTrigger();
+        }
+
+        // If configured: Trigger stateless switch / scene when manually switched off
+        if (this.Config.isTriggerSceneWhenOff()) {
+          // Trigger scene 0
+          this.trigger(this.Config.TriggerOffSceneIndex());
+        }
       }
 
-      // Start the reset timer, if parameter is greater than 0.
+      this.Log.debug('Set Switch State ->', value);
-      // Otherwise, do nothing.
-      if (this.State.triggerTimeout > 0) {
-        this.SwitchResetTimer = setTimeout(this.resetTrigger.bind(this), this.State.triggerTimeout * 1000);
-      }
-
-      // Trigger Scene
-      this.triggerNext();
-    } else if (this.Config.isResetWhenOff() && !this.SwitchOn) {
-      if (this.SwitchResetTimer) {
-        clearTimeout(this.SwitchResetTimer);
-      }
-      this.resetTrigger();
     }
-
-    this.Log.debug('Set Switch State ->', value);
   }
 
   /**
@@ -249,6 +296,15 @@ export class DeviceAccessory {
         'Set Trigger Timeout ->', triggerTimeout, '-> Out-of-Range / Value must be greater or equal to 0');
       triggerTimeout = 0;
     }
+
+    this.State.triggerTimeoutManuallyChanged = (this.Config.TriggerTimeout() !== triggerTimeout);
+    if (!this.State.triggerTimeoutManuallyChanged) {
+      this.Log.debug('Trigger Timeout in sync with config.');
+    } else {
+      this.Log.warn('Trigger Timeout not in sync with config value [' + this.Config.TriggerTimeout() + '].');
+      this.Log.warn('It will not be updated by config changes, until it is in sync again!');
+    }
+
     this.State.triggerTimeout = triggerTimeout;
   }
 
@@ -260,4 +316,37 @@ export class DeviceAccessory {
     this.Log.debug('Get Trigger Timeout ->', triggerTimeout);
     return triggerTimeout;
   }
+
+  /**
+   * Set the number of active switches.
+   * The final value is limited to the maximum configured number of programmable switches.
+   * @param value Number of active switches
+   */
+  async setCurrentScene(value: CharacteristicValue) {
+    let currentScene = value as number;
+
+    if ((currentScene > 0) && (currentScene <= this.Config.NumOfScenes())) {
+      this.Log.log('Set current active scene ->', currentScene);
+    } else {
+      this.Log.warn(
+        'Set current scene ->', currentScene, '-> Out-of-Range / Value must be between 1 and', this.Config.NumOfScenes());
+      if (currentScene > this.Config.NumOfScenes()) {
+        currentScene = this.Config.NumOfScenes();
+      } else {
+        currentScene = 1;
+      }
+    }
+
+    // value must be corrected by one, because it's used as array index
+    this.NextItemToTrigger = currentScene - 1;
+  }
+
+  /**
+   * Report number of active switches back to HomeKit (for visualization)
+   */
+  async getCurrentScene(): Promise<CharacteristicValue> {
+    const currentScene = this.NextItemToTrigger + 1;
+    this.Log.debug('Get Number of current scene ->', currentScene);
+    return currentScene;
+  }
 }

src/settings.ts

@@ -1,5 +1,4 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
+import package_config from '../package.json';
-const package_config = require('../package.json');
 
 /**
  * This is the name of the platform that users will use to register the plugin in the Homebridge config.json

src/types/characteristicConfiguredScenes.ts

@@ -1,22 +1,23 @@
-import { Formats, Perms } from 'homebridge';
+import { API, Characteristic, Formats, Perms, Service } from 'homebridge';
 
-export = (homebridge) => {
+const DISPLAY_NAME = 'Configured Scenes';
-  const CustomCharacteristic = homebridge.hap.Characteristic;
+const UUID = 'A8E3F4DF-5E5D-6A7F-8FA7-A22FA5AE9F53';
-  const characteristicUUID = 'A8E3F4DF-5E5D-6A7F-8FA7-A22FA5AE9F53';
 
-  return class ConfiguredScenes extends CustomCharacteristic {
+export function attachCharacteristic_ConfiguredScenes(target: Service, api: API): Characteristic {
-    public static readonly UUID: string = characteristicUUID;
+  let result: Characteristic;
 
-    constructor() {
+  if (target.testCharacteristic(DISPLAY_NAME)) {
-      super('Configured Scenes', ConfiguredScenes.UUID, {
+    result = target.getCharacteristic(DISPLAY_NAME)!; // Already tested it exists
-        format: Formats.UINT8,
+  } else {
-        //unit: '',
+    result = target.addCharacteristic(new api.hap.Characteristic(DISPLAY_NAME, UUID, {
-        minValue: 0,
+      format: Formats.UINT8,
-        maxValue: 0,
+      //unit: '',
-        minStep: 1,
+      minValue: 0,
-        perms: [Perms.PAIRED_WRITE, Perms.PAIRED_READ, Perms.NOTIFY],
+      maxValue: 0,
-      });
+      minStep: 1,
-      this.value = this.getDefaultValue();
+      perms: [Perms.PAIRED_WRITE, Perms.PAIRED_READ, Perms.NOTIFY],
-    }
+    }));
-  };
+  }
-};
+
+  return result;
+}

src/types/characteristicCurrentScene.ts

@@ -0,0 +1,23 @@
+import { API, Characteristic, Formats, Perms, Service } from 'homebridge';
+
+const DISPLAY_NAME = 'Current Scene';
+const UUID = '290E9D33-0EFC-4640-891E-CC25AAD740EA';
+
+export function attachCharacteristic_CurrentScene(target: Service, api: API): Characteristic {
+  let result: Characteristic;
+
+  if (target.testCharacteristic(DISPLAY_NAME)) {
+    result = target.getCharacteristic(DISPLAY_NAME)!; // Already tested it exists
+  } else {
+    result = target.addCharacteristic(new api.hap.Characteristic(DISPLAY_NAME, UUID, {
+      format: Formats.UINT8,
+      //unit: '',
+      minValue: 0,
+      maxValue: 0,
+      minStep: 1,
+      perms: [Perms.PAIRED_WRITE, Perms.PAIRED_READ, Perms.NOTIFY],
+    }));
+  }
+
+  return result;
+}

src/types/characteristicTimeout.ts

@@ -1,22 +1,23 @@
-import { Formats, Perms } from 'homebridge';
+import { API, Characteristic, Formats, Perms, Service } from 'homebridge';
 
-export = (homebridge) => {
+const DISPLAY_NAME = 'Trigger Timeout';
-  const CustomCharacteristic = homebridge.hap.Characteristic;
+const UUID = 'E2C19A02-1D2F-F592-A2BF-BF920014FB18';
-  const characteristicUUID = 'E2C19A02-1D2F-F592-A2BF-BF920014FB18';
 
-  return class TriggerTimeout extends CustomCharacteristic {
+export function attachCharacteristic_TriggerTimeout(target: Service, api: API): Characteristic {
-    public static readonly UUID: string = characteristicUUID;
+  let result: Characteristic;
 
-    constructor() {
+  if (target.testCharacteristic(DISPLAY_NAME)) {
-      super('Trigger Timeout', TriggerTimeout.UUID, {
+    result = target.getCharacteristic(DISPLAY_NAME)!; // Already tested it exists
-        format: Formats.UINT16,
+  } else {
-        //unit: '',
+    result = target.addCharacteristic(new api.hap.Characteristic(DISPLAY_NAME, UUID, {
-        minValue: 0,
+      format: Formats.UINT16,
-        maxValue: 60,
+      //unit: '',
-        minStep: 1,
+      minValue: 0,
-        perms: [Perms.PAIRED_WRITE, Perms.PAIRED_READ, Perms.NOTIFY],
+      maxValue: 60,
-      });
+      minStep: 1,
-      this.value = this.getDefaultValue();
+      perms: [Perms.PAIRED_WRITE, Perms.PAIRED_READ, Perms.NOTIFY],
-    }
+    }));
-  };
+  }
-};
+
+  return result;
+}

test/hbConfig/auth.json

@@ -0,0 +1,10 @@
+[
+  {
+    "id": 1,
+    "username": "test",
+    "name": "test",
+    "hashedPassword": "df121e72b850a058bd68f3d05b1f94dc985821a3885b5da38e263654f29843f98bb6d8e594f6042ff871a424602a9bff50dffa97f258bdc1dca4c79e87bac20c",
+    "salt": "64085e70da64670349f042d4c3d3cac75b20233ffeb71db68399973f60da077d",
+    "admin": true
+  }
+]

test/hbConfig/config.json

@@ -0,0 +1,43 @@
+{
+  "bridge": {
+    "name": "HomebridgeTest",
+    "username": "CC:22:3D:E3:CE:30",
+    "manufacturer": "homebridge.io",
+    "model": "homebridge",
+    "port": 51826,
+    "pin": "031-45-154"
+  },
+
+  "description": "This is an example configuration file with one fake accessory and one fake platform. You can use this as a template for creating your own configuration file containing devices you actually own.",
+  "ports": {
+    "start": 52100,
+    "end": 52150,
+    "comment": "This section is used to control the range of ports that separate accessory (like camera or television) should be bind to."
+  },
+  "accessories": [
+  ],
+
+  "platforms": [
+    {
+      "platform" : "MultiTapSwitch",
+      "name" : "MTS",
+      "devices": [
+        {
+          "name": "MTS1",
+          "numberConfiguredScenes": 5,
+          "triggerTimeout": 10,
+          "resetAfterSwitchOff": false,
+          "logging": true
+        },
+        {
+          "name": "MTS2",
+          "numberConfiguredScenes": 5,
+          "triggerTimeout": 10,
+          "resetAfterSwitchOff": false,
+          "triggerSceneAfterSwitchOff": true,
+          "logging": true
+        }
+      ]
+    }
+  ]
+}

tsconfig.json

@@ -1,23 +1,24 @@
 {
   "compilerOptions": {
-    "target": "ES2018", // ~node10
+    "target": "ES2022",
-    "module": "commonjs",
     "lib": [
-      "es2015",
+      "DOM",
-      "es2016",
+      "ES2022"
-      "es2017",
-      "es2018"
     ],
-    "declaration": true,
+    "rootDir": "src",
-    "declarationMap": true,
+    "module": "nodenext",
-    "sourceMap": true,
+    "moduleResolution": "nodenext",
-    "outDir": "./dist",
-    "rootDir": "./src",
     "strict": true,
+    "declaration": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "allowSyntheticDefaultImports": true,
     "esModuleInterop": true,
-    "noImplicitAny": false
+    "forceConsistentCasingInFileNames": true
   },
   "include": [
+    "eslint.config.js",
+    "homebridge-ui",
     "src/"
   ],
   "exclude": [