homebridge-virtual-accessories 3.6.0

package/dist/accessories/virtualAccessoryDoorbell.js

@@ -0,0 +1,111 @@
+import { Accessory } from './virtualAccessory.js';
+import { AccessoryNotAllowedError } from '../errors.js';
+import { CompanionSwitch } from '../companions/companionSwitch.js';
+import { SwitchConfiguration } from '../configuration/accessories/configurationSwitch.js';
+import { TimerConfiguration } from '../configuration/configurationTimer.js';
+import { DurationConfiguration } from '../configuration/configurationDuration.js';
+/**
+ * Doorbell - Accessory implementation
+ */
+export class Doorbell extends Accessory {
+    static ACCESSORY_TYPE_NAME = 'Doorbell';
+    static SINGLE_PRESS = 0; // Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS
+    static DOUBLE_PRESS = 1; // Characteristic.ProgrammableSwitchEvent.DOUBLE_PRESS
+    static LONG_PRESS = 2; // Characteristic.ProgrammableSwitchEvent.LONG_PRESS;
+    static COMPANION_TIMER_RESET = 1;
+    companionSensorResetTimerId;
+    states = {
+        Volume: 100,
+    };
+    companionSwitch;
+    constructor(platform, accessory) {
+        super(platform, accessory);
+        // First configure the device based on the accessory details
+        this.states.Volume = this.accessoryConfiguration.doorbell.volume;
+        this.service = this.accessory.getService(this.platform.Service.Doorbell) || this.accessory.addService(this.platform.Service.Doorbell);
+        this.service.setCharacteristic(this.platform.Characteristic.Name, this.accessoryConfiguration.accessoryName);
+        this.service.getCharacteristic(this.platform.Characteristic.ProgrammableSwitchEvent)
+            .onGet(this.getProgrammableSwitchEvent.bind(this));
+        // TODO: Figure out how to change the volume
+        this.service.getCharacteristic(this.platform.Characteristic.Volume)
+            .onSet(this.setVolume.bind(this))
+            .onGet(this.getVolume.bind(this));
+        // Create switch service
+        this.companionSwitch = this.createCompanionSwitch();
+    }
+    // Handlers
+    async getProgrammableSwitchEvent() {
+        // implement your own code to check if the device is on
+        const pressEvent = Doorbell.SINGLE_PRESS;
+        this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Getting Programmable Switch Event: ${Doorbell.getEventName(pressEvent)}`);
+        return pressEvent;
+    }
+    async setVolume(value) {
+        this.states.Volume = value;
+        this.log.info(`[${this.accessoryConfiguration.accessoryName}] Setting Volume: ${this.states.Volume}`);
+    }
+    async getVolume() {
+        const volume = this.states.Volume;
+        this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Getting Volume: ${volume}`);
+        return volume;
+    }
+    /**
+     * This method is called by the comoanion switch to ring the doorbell
+     */
+    async triggerEvent(companionAccessory) {
+        if (!(companionAccessory.accessoryConfiguration.accessoryID === this.accessoryConfiguration.accessoryID)) {
+            throw new AccessoryNotAllowedError(`Switch ${companionAccessory.accessoryConfiguration.accessoryName} is not allowed to trigger this sensor`);
+        }
+        this.service.updateCharacteristic(this.platform.Characteristic.ProgrammableSwitchEvent, (Doorbell.SINGLE_PRESS));
+        this.log.info(`[${this.accessoryConfiguration.accessoryName}] Triggered Doorbell Event: ${Doorbell.getEventName(Doorbell.SINGLE_PRESS)}`);
+    }
+    getJsonState() {
+        return JSON.stringify({});
+    }
+    getAccessoryTypeName() {
+        return Doorbell.ACCESSORY_TYPE_NAME;
+    }
+    static getEventName(event) {
+        let eventName;
+        switch (event) {
+            case undefined: {
+                eventName = 'undefined';
+                break;
+            }
+            case Doorbell.SINGLE_PRESS: {
+                eventName = 'SINGLE PRESS';
+                break;
+            }
+            case Doorbell.DOUBLE_PRESS: {
+                eventName = 'DOUBLE PRESS';
+                break;
+            }
+            case Doorbell.LONG_PRESS: {
+                eventName = 'LONG PRESS';
+                break;
+            }
+            default: {
+                eventName = event.toString();
+            }
+        }
+        return eventName;
+    }
+    createCompanionSwitch() {
+        // Enrich configuration with "switch" settings
+        this.accessoryConfiguration.switch = new SwitchConfiguration();
+        this.accessoryConfiguration.switch.defaultState = 'off';
+        this.accessoryConfiguration.switch.hasCompanionSensor = false;
+        this.accessoryConfiguration.switch.hasResetTimer = true;
+        this.accessoryConfiguration.switch.muteLogging = false;
+        // Enrich configuration with "resetTimer" settings
+        this.accessoryConfiguration.resetTimer = new TimerConfiguration();
+        this.accessoryConfiguration.resetTimer.duration = new DurationConfiguration();
+        this.accessoryConfiguration.resetTimer.duration.days = 0;
+        this.accessoryConfiguration.resetTimer.duration.hours = 0;
+        this.accessoryConfiguration.resetTimer.duration.minutes = 0;
+        this.accessoryConfiguration.resetTimer.duration.seconds = Doorbell.COMPANION_TIMER_RESET;
+        const companionSwitch = new CompanionSwitch(this.platform, this.accessory, this.accessoryConfiguration.accessoryName + ' Switch', this);
+        return companionSwitch;
+    }
+}
+//# sourceMappingURL=virtualAccessoryDoorbell.js.map

package/dist/accessories/virtualAccessoryDoorbell.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"virtualAccessoryDoorbell.js","sourceRoot":"","sources":["../../src/accessories/virtualAccessoryDoorbell.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAGlD,OAAO,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qDAAqD,CAAC;AAC1F,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAElF;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,SAAS;IAErC,MAAM,CAAU,mBAAmB,GAAW,UAAU,CAAC;IAEzD,MAAM,CAAU,YAAY,GAAW,CAAC,CAAC,CAAE,sDAAsD;IACjG,MAAM,CAAU,YAAY,GAAW,CAAC,CAAC,CAAE,sDAAsD;IACjG,MAAM,CAAU,UAAU,GAAW,CAAC,CAAC,CAAI,qDAAqD;IAExF,MAAM,CAAU,qBAAqB,GAAW,CAAC,CAAC;IAElD,2BAA2B,CAA4C;IAEvE,MAAM,GAAG;QACf,MAAM,EAAE,GAAG;KACZ,CAAC;IAEM,eAAe,CAAmB;IAE1C,YACE,QAAoC,EACpC,SAA4B;QAE5B,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAE3B,4DAA4D;QAC5D,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,MAAM,CAAC;QAEjE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAEtI,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;QAE7G,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,uBAAuB,CAAC;aACjF,KAAK,CAAC,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAErD,4CAA4C;QAC5C,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC;aAChE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAChC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEpC,wBAAwB;QACxB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;IACtD,CAAC;IAED,WAAW;IAEX,KAAK,CAAC,0BAA0B;QAC9B,uDAAuD;QACvD,MAAM,UAAU,GAAG,QAAQ,CAAC,YAAY,CAAC;QAEzC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,wCAAwC,QAAQ,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAEzI,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,KAA0B;QACxC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,KAAe,CAAC;QAErC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,qBAAqB,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACxG,CAAC;IAED,KAAK,CAAC,SAAS;QACb,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;QAElC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,qBAAqB,MAAM,EAAE,CAAC,CAAC;QAE3F,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,kBAA6B;QAC9C,IAAI,CAAC,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,WAAW,KAAK,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;YACzG,MAAM,IAAI,wBAAwB,CAAC,UAAU,kBAAkB,CAAC,sBAAsB,CAAC,aAAa,wCAAwC,CAAC,CAAC;QAChJ,CAAC;QAED,IAAI,CAAC,OAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,uBAAuB,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC;QAElH,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,+BAA+B,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IAC5I,CAAC;IAES,YAAY;QACpB,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAC5B,CAAC;IAES,oBAAoB;QAC5B,OAAO,QAAQ,CAAC,mBAAmB,CAAC;IACtC,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,KAAa;QAC/B,IAAI,SAAiB,CAAC;QAEtB,QAAQ,KAAK,EAAE,CAAC;YAChB,KAAK,SAAS,CAAC,CAAC,CAAC;gBAAC,SAAS,GAAG,WAAW,CAAC;gBAAC,MAAM;YAAC,CAAC;YACnD,KAAK,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC;gBAAC,SAAS,GAAG,cAAc,CAAC;gBAAC,MAAM;YAAC,CAAC;YAClE,KAAK,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC;gBAAC,SAAS,GAAG,cAAc,CAAC;gBAAC,MAAM;YAAC,CAAC;YAClE,KAAK,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;gBAAC,SAAS,GAAG,YAAY,CAAC;gBAAC,MAAM;YAAC,CAAC;YAC9D,OAAO,CAAC,CAAC,CAAC;gBAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;YAAC,CAAC;QAC1C,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,qBAAqB;QAC3B,8CAA8C;QAC9C,IAAI,CAAC,sBAAsB,CAAC,MAAM,GAAG,IAAI,mBAAmB,EAAE,CAAC;QAC/D,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC;QACxD,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,kBAAkB,GAAG,KAAK,CAAC;QAC9D,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;QACxD,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC;QAEvD,kDAAkD;QAClD,IAAI,CAAC,sBAAsB,CAAC,UAAU,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAClE,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,QAAQ,GAAG,IAAI,qBAAqB,EAAE,CAAC;QAC9E,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;QACzD,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,CAAC;QAC1D,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,GAAG,CAAC,CAAC;QAC5D,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,qBAAqB,CAAC;QAEzF,MAAM,eAAe,GAAG,IAAI,eAAe,CACzC,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,sBAAsB,CAAC,aAAa,GAAG,SAAS,EACrD,IAAI,CACL,CAAC;QAEF,OAAO,eAAe,CAAC;IACzB,CAAC"}

package/dist/accessories/virtualAccessoryFan.d.ts

@@ -0,0 +1,27 @@
+import type { CharacteristicValue, PlatformAccessory } from 'homebridge';
+import { VirtualAccessoriesPlatform } from '../platform.js';
+import { Accessory } from './virtualAccessory.js';
+/**
+ * Fan - Accessory implementation
+ */
+export declare class Fan extends Accessory {
+    static readonly ACCESSORY_TYPE_NAME: string;
+    static readonly ON: boolean;
+    static readonly OFF: boolean;
+    static readonly CLOCKWISE: number;
+    static readonly COUNTER_CLOCKWISE: number;
+    private readonly stateStorageKey;
+    private readonly rotatioDirectionStorageKey;
+    private readonly rotatioSpeedStorageKey;
+    private states;
+    constructor(platform: VirtualAccessoriesPlatform, accessory: PlatformAccessory);
+    setOn(value: CharacteristicValue): Promise<void>;
+    getOn(): Promise<CharacteristicValue>;
+    setRotationDirection(value: CharacteristicValue): Promise<void>;
+    getRotationDirection(): Promise<CharacteristicValue>;
+    setRotationSpeed(value: CharacteristicValue): Promise<void>;
+    getRotationSpeed(): Promise<CharacteristicValue>;
+    protected getJsonState(): string;
+    protected getAccessoryTypeName(): string;
+    static getStateName(state: boolean): string;
+}

package/dist/accessories/virtualAccessoryFan.js

@@ -0,0 +1,122 @@
+import { Accessory } from './virtualAccessory.js';
+/**
+ * Fan - Accessory implementation
+ */
+export class Fan extends Accessory {
+    static ACCESSORY_TYPE_NAME = 'Fan';
+    static ON = true;
+    static OFF = false;
+    static CLOCKWISE = 0; // Characteristic.ProgrammableSwitchEvent.RotationDirection.CLOCKWISE;
+    static COUNTER_CLOCKWISE = 1; // Characteristic.ProgrammableSwitchEvent.RotationDirection.COUNTER_CLOCKWISE;
+    stateStorageKey = 'FanState';
+    rotatioDirectionStorageKey = 'FanRotationDirection';
+    rotatioSpeedStorageKey = 'FanRotationSpeed';
+    states = {
+        FanState: Fan.OFF,
+        FanRotationDirection: Fan.CLOCKWISE,
+        FanRotationSpeed: 100,
+    };
+    constructor(platform, accessory) {
+        super(platform, accessory);
+        // First configure the device based on the accessory details
+        this.defaultState = this.accessoryConfiguration.fan.defaultState === 'on' ? Fan.ON : Fan.OFF;
+        const rotationDirection = this.accessoryConfiguration.fan.rotationDirection === 'clockwise' ? Fan.CLOCKWISE : Fan.COUNTER_CLOCKWISE;
+        const rotationSpeed = this.accessoryConfiguration.fan.rotationSpeed;
+        this.states.FanState = this.defaultState;
+        this.states.FanRotationDirection = rotationDirection;
+        this.states.FanRotationSpeed = rotationSpeed;
+        // If the accessory is stateful retrieve stored state
+        if (this.accessoryConfiguration.accessoryIsStateful) {
+            const accessoryState = this.loadAccessoryState(this.storagePath);
+            const cachedState = accessoryState[this.stateStorageKey];
+            const cachedRotationDirection = accessoryState[this.rotatioDirectionStorageKey];
+            const cachedRotationSpeed = accessoryState[this.rotatioSpeedStorageKey];
+            if (cachedState !== undefined && cachedRotationDirection !== undefined && cachedRotationSpeed !== undefined) {
+                this.states.FanState = cachedState;
+                this.states.FanRotationDirection = cachedRotationDirection;
+                this.states.FanRotationSpeed = cachedRotationSpeed;
+            }
+        }
+        this.service = this.accessory.getService(this.platform.Service.Fan) || this.accessory.addService(this.platform.Service.Fan);
+        this.service.setCharacteristic(this.platform.Characteristic.Name, this.accessoryConfiguration.accessoryName);
+        // Update the initial state of the accessory     
+        this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Setting Fan Current State: ${Fan.getStateName(this.states.FanState)}`);
+        this.service.updateCharacteristic(this.platform.Characteristic.On, (this.states.FanState));
+        this.service.updateCharacteristic(this.platform.Characteristic.RotationDirection, (this.states.FanRotationDirection));
+        this.service.updateCharacteristic(this.platform.Characteristic.RotationSpeed, (this.states.FanRotationSpeed));
+        // register handlers
+        this.service.getCharacteristic(this.platform.Characteristic.On)
+            .onSet(this.setOn.bind(this))
+            .onGet(this.getOn.bind(this));
+        this.service.getCharacteristic(this.platform.Characteristic.RotationDirection)
+            .onSet(this.setRotationDirection.bind(this))
+            .onGet(this.getRotationDirection.bind(this));
+        this.service.getCharacteristic(this.platform.Characteristic.RotationSpeed)
+            .onSet(this.setRotationSpeed.bind(this))
+            .onGet(this.getRotationSpeed.bind(this));
+    }
+    // Handlers
+    async setOn(value) {
+        this.states.FanState = value;
+        this.storeState();
+        this.log.info(`[${this.accessoryConfiguration.accessoryName}] Setting State: ${Fan.getStateName(this.states.FanState)}`);
+    }
+    async getOn() {
+        const fanState = this.states.FanState;
+        this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Getting State: ${Fan.getStateName(fanState)}`);
+        return fanState;
+    }
+    async setRotationDirection(value) {
+        this.states.FanRotationDirection = value;
+        this.storeState();
+        this.log.info(`[${this.accessoryConfiguration.accessoryName}] Setting Rotation Direction: ${this.states.FanRotationDirection}`);
+    }
+    async getRotationDirection() {
+        const fanRotationDirection = this.states.FanRotationDirection;
+        this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Getting Rotation Direction: ${fanRotationDirection}`);
+        return fanRotationDirection;
+    }
+    async setRotationSpeed(value) {
+        this.states.FanRotationSpeed = value;
+        this.storeState();
+        this.log.info(`[${this.accessoryConfiguration.accessoryName}] Setting Rotation Speed: ${this.states.FanRotationSpeed}%`);
+    }
+    async getRotationSpeed() {
+        const fanRotationSpeed = this.states.FanRotationSpeed;
+        this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Getting Rotation Speed: ${fanRotationSpeed}%`);
+        return fanRotationSpeed;
+    }
+    getJsonState() {
+        const json = JSON.stringify({
+            [this.stateStorageKey]: this.states.FanState,
+            [this.rotatioDirectionStorageKey]: this.states.FanRotationDirection,
+            [this.rotatioSpeedStorageKey]: this.states.FanRotationSpeed,
+        });
+        return json;
+    }
+    getAccessoryTypeName() {
+        return Fan.ACCESSORY_TYPE_NAME;
+    }
+    static getStateName(state) {
+        let stateName;
+        switch (state) {
+            case undefined: {
+                stateName = 'undefined';
+                break;
+            }
+            case Fan.ON: {
+                stateName = 'ON';
+                break;
+            }
+            case Fan.OFF: {
+                stateName = 'OFF';
+                break;
+            }
+            default: {
+                stateName = state.toString();
+            }
+        }
+        return stateName;
+    }
+}
+//# sourceMappingURL=virtualAccessoryFan.js.map

package/dist/accessories/virtualAccessoryFan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"virtualAccessoryFan.js","sourceRoot":"","sources":["../../src/accessories/virtualAccessoryFan.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD;;GAEG;AACH,MAAM,OAAO,GAAI,SAAQ,SAAS;IAEhC,MAAM,CAAU,mBAAmB,GAAW,KAAK,CAAC;IAEpD,MAAM,CAAU,EAAE,GAAY,IAAI,CAAC;IACnC,MAAM,CAAU,GAAG,GAAY,KAAK,CAAC;IAErC,MAAM,CAAU,SAAS,GAAW,CAAC,CAAC,CAAU,sEAAsE;IACtH,MAAM,CAAU,iBAAiB,GAAW,CAAC,CAAC,CAAE,8EAA8E;IAE7G,eAAe,GAAW,UAAU,CAAC;IACrC,0BAA0B,GAAW,sBAAsB,CAAC;IAC5D,sBAAsB,GAAW,kBAAkB,CAAC;IAE7D,MAAM,GAAG;QACf,QAAQ,EAAE,GAAG,CAAC,GAAG;QACjB,oBAAoB,EAAE,GAAG,CAAC,SAAS;QACnC,gBAAgB,EAAE,GAAG;KACtB,CAAC;IAEF,YACE,QAAoC,EACpC,SAA4B;QAE5B,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAE3B,4DAA4D;QAC5D,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,YAAY,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;QAC7F,MAAM,iBAAiB,GAAW,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,iBAAiB,KAAK,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC;QAC5I,MAAM,aAAa,GAAW,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,aAAuB,CAAC;QAEtF,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,MAAM,CAAC,oBAAoB,GAAG,iBAAiB,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,gBAAgB,GAAG,aAAa,CAAC;QAE7C,qDAAqD;QACrD,IAAI,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,EAAE,CAAC;YACpD,MAAM,cAAc,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACjE,MAAM,WAAW,GAAY,cAAc,CAAC,IAAI,CAAC,eAAe,CAAY,CAAC;YAC7E,MAAM,uBAAuB,GAAW,cAAc,CAAC,IAAI,CAAC,0BAA0B,CAAW,CAAC;YAClG,MAAM,mBAAmB,GAAW,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAW,CAAC;YAE1F,IAAI,WAAW,KAAK,SAAS,IAAI,uBAAuB,KAAK,SAAS,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;gBAC5G,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,WAAW,CAAC;gBACnC,IAAI,CAAC,MAAM,CAAC,oBAAoB,GAAG,uBAAuB,CAAC;gBAC3D,IAAI,CAAC,MAAM,CAAC,gBAAgB,GAAG,mBAAmB,CAAC;YACrD,CAAC;QACH,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAE5H,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;QAE7G,iDAAiD;QACjD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,gCAAgC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACtI,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC3F,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACtH,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAE9G,oBAAoB;QAEpB,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;aAC5D,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC5B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEhC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,iBAAiB,CAAC;aAC3E,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC3C,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAE/C,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,aAAa,CAAC;aACvE,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACvC,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,WAAW;IAEX,KAAK,CAAC,KAAK,CAAC,KAA0B;QACpC,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,KAAgB,CAAC;QAExC,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,oBAAoB,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC3H,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAEtC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,oBAAoB,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAE9G,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,KAA0B;QACnD,IAAI,CAAC,MAAM,CAAC,oBAAoB,GAAG,KAAe,CAAC;QAEnD,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,iCAAiC,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAClI,CAAC;IAED,KAAK,CAAC,oBAAoB;QACxB,MAAM,oBAAoB,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;QAE9D,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,iCAAiC,oBAAoB,EAAE,CAAC,CAAC;QAErH,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,KAA0B;QAC/C,IAAI,CAAC,MAAM,CAAC,gBAAgB,GAAG,KAAe,CAAC;QAE/C,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,6BAA6B,IAAI,CAAC,MAAM,CAAC,gBAAgB,GAAG,CAAC,CAAC;IAC3H,CAAC;IAED,KAAK,CAAC,gBAAgB;QACpB,MAAM,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;QAEtD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,6BAA6B,gBAAgB,GAAG,CAAC,CAAC;QAE9G,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAES,YAAY;QACpB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;YAC1B,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;YAC5C,CAAC,IAAI,CAAC,0BAA0B,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,oBAAoB;YACnE,CAAC,IAAI,CAAC,sBAAsB,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,gBAAgB;SAC5D,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAES,oBAAoB;QAC5B,OAAO,GAAG,CAAC,mBAAmB,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,KAAc;QAChC,IAAI,SAAiB,CAAC;QAEtB,QAAQ,KAAK,EAAE,CAAC;YAChB,KAAK,SAAS,CAAC,CAAC,CAAC;gBAAC,SAAS,GAAG,WAAW,CAAC;gBAAC,MAAM;YAAC,CAAC;YACnD,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;gBAAC,SAAS,GAAG,IAAI,CAAC;gBAAC,MAAM;YAAC,CAAC;YACzC,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;gBAAC,SAAS,GAAG,KAAK,CAAC;gBAAC,MAAM;YAAC,CAAC;YAC3C,OAAO,CAAC,CAAC,CAAC;gBAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;YAAA,CAAC;QACzC,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC"}

package/dist/accessories/virtualAccessoryFilterMaintenance.d.ts

@@ -0,0 +1,26 @@
+import type { CharacteristicValue, PlatformAccessory } from 'homebridge';
+import { VirtualAccessoriesPlatform } from '../platform.js';
+import { Accessory } from './virtualAccessory.js';
+/**
+ * FilterMaintenance - Accessory implementation
+ */
+export declare class FilterMaintenance extends Accessory {
+    static readonly ACCESSORY_TYPE_NAME: string;
+    static readonly FILTER_OK: number;
+    static readonly CHANGE_FILTER: number;
+    private readonly timerStartTimeStorageKey;
+    private readonly timerDurationStorageKey;
+    private readonly timerIsRunningStorageKey;
+    private lifespan;
+    private lifespanTimer;
+    private filterChangeIndicator;
+    private states;
+    constructor(platform: VirtualAccessoriesPlatform, accessory: PlatformAccessory);
+    getFilterChangeIndication(): Promise<CharacteristicValue>;
+    getFilterLifeLevel(): Promise<CharacteristicValue>;
+    setResetFilterIndication(value: CharacteristicValue): Promise<void>;
+    protected getJsonState(): string;
+    protected getAccessoryTypeName(): string;
+    static getStateName(event: number): string;
+    private onTimerExpired;
+}

package/dist/accessories/virtualAccessoryFilterMaintenance.js

@@ -0,0 +1,122 @@
+/* eslint-disable brace-style */
+import { Accessory } from './virtualAccessory.js';
+import { Timer } from '../timer.js';
+import { Utils } from '../utils.js';
+/**
+ * FilterMaintenance - Accessory implementation
+ */
+export class FilterMaintenance extends Accessory {
+    static ACCESSORY_TYPE_NAME = 'Filter';
+    static FILTER_OK = 0; // Characteristic.FilterChangeIndication.FILTER_OK
+    static CHANGE_FILTER = 1; // Characteristic.FilterChangeIndication.CHANGE_FILTER
+    timerStartTimeStorageKey = 'TimerStartTime';
+    timerDurationStorageKey = 'TimerDuration';
+    timerIsRunningStorageKey = 'TimerIsRunning';
+    lifespan;
+    lifespanTimer;
+    filterChangeIndicator;
+    states = {};
+    constructor(platform, accessory) {
+        super(platform, accessory);
+        // First configure the device based on the accessory details
+        this.lifespan = Utils.daysHoursMinutesSecondsToSeconds(this.accessoryConfiguration.filterMaintenance.lifespan.days, this.accessoryConfiguration.filterMaintenance.lifespan.hours, this.accessoryConfiguration.filterMaintenance.lifespan.minutes, this.accessoryConfiguration.filterMaintenance.lifespan.seconds);
+        const timerIsResettable = true;
+        this.lifespanTimer = new Timer(this.accessoryConfiguration.accessoryName, this.log, timerIsResettable, this.lifespan);
+        const accessoryState = this.loadAccessoryState(this.storagePath);
+        if (this.isEmptyAccessoryState(accessoryState)) {
+            // No stored state -> First run
+            this.lifespanTimer.start(this.onTimerExpired);
+            this.storeState();
+        }
+        else {
+            const cachedTimerStartTime = accessoryState[this.timerStartTimeStorageKey];
+            const cachedTimerDuration = accessoryState[this.timerDurationStorageKey];
+            const cachedTimerIsRunning = accessoryState[this.timerIsRunningStorageKey];
+            this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Cached Timer Start Time: ${cachedTimerStartTime}`);
+            this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Cached Timer Duration: ${cachedTimerDuration}`);
+            this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Cached Timer Is Running: ${cachedTimerIsRunning}`);
+            // If the timer was running, calculate elapsed time and set timer for remaining duration
+            if (cachedTimerIsRunning) {
+                Utils.restoreRunningTimer(this.lifespanTimer, cachedTimerStartTime, cachedTimerDuration, this.onTimerExpired, this.accessoryConfiguration.accessoryName, this.log);
+                // Do not store state if the timer was restored!
+                // Store state only when the timer started or reset
+            }
+        }
+        this.filterChangeIndicator = this.lifespanTimer?.isTimerRunning() ? FilterMaintenance.FILTER_OK : FilterMaintenance.CHANGE_FILTER;
+        this.service = this.accessory.getService(this.platform.Service.FilterMaintenance) || this.accessory.addService(this.platform.Service.FilterMaintenance);
+        this.service.setCharacteristic(this.platform.Characteristic.Name, this.accessoryConfiguration.accessoryName);
+        this.service.getCharacteristic(this.platform.Characteristic.FilterChangeIndication)
+            .onGet(this.getFilterChangeIndication.bind(this));
+        this.service.getCharacteristic(this.platform.Characteristic.FilterLifeLevel)
+            .onGet(this.getFilterLifeLevel.bind(this));
+        this.service.getCharacteristic(this.platform.Characteristic.ResetFilterIndication)
+            .onSet(this.setResetFilterIndication.bind(this));
+    }
+    // Handlers
+    async getFilterChangeIndication() {
+        const filterChangeIndicator = this.filterChangeIndicator;
+        this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Getting Filter Change Indication: ${FilterMaintenance.getStateName(filterChangeIndicator)}`);
+        return filterChangeIndicator;
+    }
+    async getFilterLifeLevel() {
+        const lifeLevel = (this.lifespanTimer.getRuntime() === 0) ?
+            0 :
+            this.lifespanTimer.getRemainingDuration() / this.lifespanTimer.getRuntime() * 100;
+        this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Getting Filter Life Level: ${lifeLevel.toFixed(2)}`);
+        return lifeLevel;
+    }
+    async setResetFilterIndication(value) {
+        const reset = value;
+        if (reset === 1) {
+            this.lifespanTimer.stop();
+            this.lifespanTimer.start(this.onTimerExpired);
+            this.filterChangeIndicator = FilterMaintenance.FILTER_OK;
+            this.storeState();
+            this.log.info(`[${this.accessoryConfiguration.accessoryName}] Reset Filter Indication`);
+        }
+        else {
+            this.log.error(`[${this.accessoryConfiguration.accessoryName}] Reset Filter Indication called with invalid value ${reset}`);
+        }
+    }
+    getJsonState() {
+        const timerStartTime = this.lifespanTimer.getStartTime().toString();
+        const timerDuration = (this.lifespanTimer.getRuntime() > 0) ? this.lifespanTimer.getRuntime() : this.lifespanTimer.getDefaultDuration();
+        const timerIsRunning = this.lifespanTimer.isTimerRunning();
+        const jsonState = {
+            [this.timerStartTimeStorageKey]: timerStartTime,
+            [this.timerDurationStorageKey]: timerDuration,
+            [this.timerIsRunningStorageKey]: timerIsRunning,
+        };
+        const json = JSON.stringify(jsonState);
+        return json;
+    }
+    getAccessoryTypeName() {
+        return FilterMaintenance.ACCESSORY_TYPE_NAME;
+    }
+    static getStateName(event) {
+        let stateName;
+        switch (event) {
+            case undefined: {
+                stateName = 'undefined';
+                break;
+            }
+            case FilterMaintenance.FILTER_OK: {
+                stateName = 'FILTER OK';
+                break;
+            }
+            case FilterMaintenance.CHANGE_FILTER: {
+                stateName = 'CHANGE FILTER';
+                break;
+            }
+            default: {
+                stateName = event.toString();
+            }
+        }
+        return stateName;
+    }
+    onTimerExpired() {
+        this.filterChangeIndicator = FilterMaintenance.CHANGE_FILTER;
+        this.storeState();
+    }
+}
+//# sourceMappingURL=virtualAccessoryFilterMaintenance.js.map

package/dist/accessories/virtualAccessoryFilterMaintenance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"virtualAccessoryFilterMaintenance.js","sourceRoot":"","sources":["../../src/accessories/virtualAccessoryFilterMaintenance.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAKhC,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,SAAS;IAE9C,MAAM,CAAU,mBAAmB,GAAW,QAAQ,CAAC;IAEvD,MAAM,CAAU,SAAS,GAAW,CAAC,CAAC,CAAM,kDAAkD;IAC9F,MAAM,CAAU,aAAa,GAAW,CAAC,CAAC,CAAE,sDAAsD;IAEjF,wBAAwB,GAAW,gBAAgB,CAAC;IACpD,uBAAuB,GAAW,eAAe,CAAC;IAClD,wBAAwB,GAAW,gBAAgB,CAAC;IAE7D,QAAQ,CAAS;IACjB,aAAa,CAAQ;IAErB,qBAAqB,CAAS;IAE9B,MAAM,GAAG,EAChB,CAAC;IAEF,YACE,QAAoC,EACpC,SAA4B;QAE5B,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAE3B,4DAA4D;QAE5D,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,gCAAgC,CACpD,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,EAC3D,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,KAAK,EAC5D,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,OAAO,EAC9D,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAC/D,CAAC;QAEF,MAAM,iBAAiB,GAAY,IAAI,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,IAAI,KAAK,CAC5B,IAAI,CAAC,sBAAsB,CAAC,aAAa,EACzC,IAAI,CAAC,GAAG,EACR,iBAAiB,EACjB,IAAI,CAAC,QAAQ,CACd,CAAC;QAEF,MAAM,cAAc,GAAW,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzE,IAAI,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC,EAAE,CAAC;YAC/C,+BAA+B;YAC/B,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC9C,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,CAAC;aACI,CAAC;YACJ,MAAM,oBAAoB,GAAG,cAAc,CAAC,IAAI,CAAC,wBAAwB,CAAW,CAAC;YACrF,MAAM,mBAAmB,GAAG,cAAc,CAAC,IAAI,CAAC,uBAAuB,CAAW,CAAC;YACnF,MAAM,oBAAoB,GAAG,cAAc,CAAC,IAAI,CAAC,wBAAwB,CAAY,CAAC;YAEtF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,8BAA8B,oBAAoB,EAAE,CAAC,CAAC;YAClH,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,4BAA4B,mBAAmB,EAAE,CAAC,CAAC;YAC/G,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,8BAA8B,oBAAoB,EAAE,CAAC,CAAC;YAElH,wFAAwF;YACxF,IAAI,oBAAoB,EAAE,CAAC;gBACzB,KAAK,CAAC,mBAAmB,CACvB,IAAI,CAAC,aAAa,EAClB,oBAAoB,EACpB,mBAAmB,EACnB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,sBAAsB,CAAC,aAAa,EACzC,IAAI,CAAC,GAAG,CACT,CAAC;gBAEF,gDAAgD;gBAChD,mDAAmD;YACrD,CAAC;QACH,CAAC;QAED,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,aAAa,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,aAAa,CAAC;QAElI,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAExJ,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;QAE7G,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,sBAAsB,CAAC;aAChF,KAAK,CAAC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEpD,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC;aACzE,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAE7C,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,qBAAqB,CAAC;aAC/E,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC;IAED,WAAW;IAEX,KAAK,CAAC,yBAAyB;QAC7B,MAAM,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAEzD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,uCAAuC,iBAAiB,CAAC,YAAY,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC;QAE5J,OAAO,qBAAqB,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,kBAAkB;QACtB,MAAM,SAAS,GACb,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,GAAG,GAAG,CAAC;QAEtF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,gCAAgC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAEpH,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,wBAAwB,CAAC,KAA0B;QACvD,MAAM,KAAK,GAAG,KAAe,CAAC;QAE9B,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAChB,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;YAC1B,IAAI,CAAC,aAAa,CAAC,KAAK,CACtB,IAAI,CAAC,cAAc,CACpB,CAAC;YACF,IAAI,CAAC,qBAAqB,GAAG,iBAAiB,CAAC,SAAS,CAAC;YACzD,IAAI,CAAC,UAAU,EAAE,CAAC;YAElB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,2BAA2B,CAAC,CAAC;QAC1F,CAAC;aACI,CAAC;YACJ,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,aAAa,uDAAuD,KAAK,EAAE,CAAC,CAAC;QAC9H,CAAC;IACH,CAAC;IAES,YAAY;QACpB,MAAM,cAAc,GAAW,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC5E,MAAM,aAAa,GAAW,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE,CAAC;QAChJ,MAAM,cAAc,GAAY,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,CAAC;QAEpE,MAAM,SAAS,GAAG;YAChB,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE,cAAc;YAC/C,CAAC,IAAI,CAAC,uBAAuB,CAAC,EAAE,aAAa;YAC7C,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE,cAAc;SAChD,CAAC;QAEF,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAEvC,OAAO,IAAI,CAAC;IACd,CAAC;IAES,oBAAoB;QAC5B,OAAO,iBAAiB,CAAC,mBAAmB,CAAC;IAC/C,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,KAAa;QAC/B,IAAI,SAAiB,CAAC;QAEtB,QAAQ,KAAK,EAAE,CAAC;YAChB,KAAK,SAAS,CAAC,CAAC,CAAC;gBAAC,SAAS,GAAG,WAAW,CAAC;gBAAC,MAAM;YAAC,CAAC;YACnD,KAAK,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;gBAAC,SAAS,GAAG,WAAW,CAAC;gBAAC,MAAM;YAAC,CAAC;YACrE,KAAK,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC;gBAAC,SAAS,GAAG,eAAe,CAAC;gBAAC,MAAM;YAAC,CAAC;YAC7E,OAAO,CAAC,CAAC,CAAC;gBAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;YAAC,CAAC;QAC1C,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,cAAc;QACpB,IAAI,CAAC,qBAAqB,GAAG,iBAAiB,CAAC,aAAa,CAAC;QAC7D,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC"}

package/dist/accessories/virtualAccessoryGarageDoor.d.ts

@@ -0,0 +1,28 @@
+import type { CharacteristicValue, PlatformAccessory } from 'homebridge';
+import { VirtualAccessoriesPlatform } from '../platform.js';
+import { Accessory } from './virtualAccessory.js';
+import { UpdatableObstruction } from '../updatableObstruction.js';
+/**
+ * GarageDoor - Accessory implementation
+ */
+export declare class GarageDoor extends Accessory implements UpdatableObstruction {
+    static readonly ACCESSORY_TYPE_NAME: string;
+    static readonly OPEN: number;
+    static readonly CLOSED: number;
+    static readonly OPENING: number;
+    static readonly CLOSING: number;
+    static readonly STOPPED: number;
+    private static readonly DEFAULT_TIMEOUT_SECS;
+    private readonly stateStorageKey;
+    private transitionTimerId;
+    private states;
+    constructor(platform: VirtualAccessoriesPlatform, accessory: PlatformAccessory);
+    getCurrentDoorState(): Promise<CharacteristicValue>;
+    setTargetDoorState(value: CharacteristicValue): Promise<void>;
+    getTargetDoorState(): Promise<CharacteristicValue>;
+    getObstructionDetected(): Promise<CharacteristicValue>;
+    protected getJsonState(): string;
+    protected getAccessoryTypeName(): string;
+    static getStateName(state: number): string;
+    updateObstruction(value: boolean, accessoryId: string): void;
+}

package/dist/accessories/virtualAccessoryGarageDoor.js

@@ -0,0 +1,162 @@
+/* eslint-disable brace-style */
+/* eslint-disable max-len */
+import { Accessory } from './virtualAccessory.js';
+import { InvalidObstructionValueType, ObstructionValueUpdateNotAllowed } from '../errors.js';
+/**
+ * GarageDoor - Accessory implementation
+ */
+export class GarageDoor extends Accessory {
+    static ACCESSORY_TYPE_NAME = 'GarageDoor';
+    static OPEN = 0; // Characteristic.CurrentDoorState.OPEN   - Characteristic.TargetDoorState.OPEN
+    static CLOSED = 1; // Characteristic.CurrentDoorState.CLOSED - Characteristic.TargetDoorState.CLOSED
+    static OPENING = 2; // Characteristic.CurrentDoorState.OPENING;
+    static CLOSING = 3; // Characteristic.CurrentDoorState.CLOSING;
+    static STOPPED = 4; // Characteristic.CurrentDoorState.STOPPED;
+    static DEFAULT_TIMEOUT_SECS = 3;
+    stateStorageKey = 'GarageDoorState';
+    transitionTimerId;
+    states = {
+        GarageDoorCurrentState: GarageDoor.CLOSED,
+        GarageDoorTargetState: GarageDoor.CLOSED,
+        ObstructionDetected: false,
+    };
+    constructor(platform, accessory) {
+        super(platform, accessory);
+        // First configure the device based on the accessory details
+        this.defaultState = this.accessoryConfiguration.garageDoor.defaultState === 'open' ? GarageDoor.OPEN : GarageDoor.CLOSED;
+        this.states.GarageDoorCurrentState = this.defaultState;
+        // If the accessory is stateful retrieve stored state
+        if (this.accessoryConfiguration.accessoryIsStateful) {
+            const accessoryState = this.loadAccessoryState(this.storagePath);
+            const cachedState = accessoryState[this.stateStorageKey];
+            if (cachedState !== undefined) {
+                this.states.GarageDoorCurrentState = cachedState;
+            }
+        }
+        this.states.GarageDoorTargetState = this.states.GarageDoorCurrentState;
+        this.service = this.accessory.getService(this.platform.Service.GarageDoorOpener) || this.accessory.addService(this.platform.Service.GarageDoorOpener);
+        this.service.setCharacteristic(this.platform.Characteristic.Name, this.accessoryConfiguration.accessoryName);
+        // Update the initial state of the accessory
+        this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Setting Garage Door Current State: ${GarageDoor.getStateName(this.states.GarageDoorCurrentState)}`);
+        this.service.updateCharacteristic(this.platform.Characteristic.CurrentDoorState, (this.states.GarageDoorCurrentState));
+        this.service.updateCharacteristic(this.platform.Characteristic.TargetDoorState, (this.states.GarageDoorTargetState));
+        // register handlers
+        this.service.getCharacteristic(this.platform.Characteristic.CurrentDoorState)
+            .onGet(this.getCurrentDoorState.bind(this));
+        this.service.getCharacteristic(this.platform.Characteristic.TargetDoorState)
+            .onSet(this.setTargetDoorState.bind(this))
+            .onGet(this.getTargetDoorState.bind(this));
+        this.service.getCharacteristic(this.platform.Characteristic.ObstructionDetected)
+            .onGet(this.getObstructionDetected.bind(this));
+    }
+    // Handlers
+    async getCurrentDoorState() {
+        const garageDoorCurrentState = this.states.GarageDoorCurrentState;
+        this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Getting Current Door State: ${GarageDoor.getStateName(garageDoorCurrentState)}`);
+        return garageDoorCurrentState;
+    }
+    async setTargetDoorState(value) {
+        this.states.GarageDoorTargetState = value;
+        this.log.info(`[${this.accessoryConfiguration.accessoryName}] Setting Target Door State: ${GarageDoor.getStateName(this.states.GarageDoorTargetState)}`);
+        // Clear the obstruction flag
+        this.states.ObstructionDetected = false;
+        this.service.setCharacteristic(this.platform.Characteristic.ObstructionDetected, (this.states.ObstructionDetected));
+        this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Setting Obstruction Detected: ${this.states.ObstructionDetected}`);
+        // CurrentDoorState CLOSING/OPENING
+        this.states.GarageDoorCurrentState = (this.states.GarageDoorTargetState === GarageDoor.OPEN) ? GarageDoor.OPENING : GarageDoor.CLOSING;
+        this.service.setCharacteristic(this.platform.Characteristic.CurrentDoorState, (this.states.GarageDoorCurrentState));
+        this.log.info(`[${this.accessoryConfiguration.accessoryName}] Setting Current Door State: ${GarageDoor.getStateName(this.states.GarageDoorCurrentState)}`);
+        // CurrentDoorState CLOSED/OPEN with 3 second delay
+        const transitionDuration = this.accessoryConfiguration.garageDoor.transitionDuration;
+        const transitionDelayMillis = (transitionDuration ? transitionDuration : GarageDoor.DEFAULT_TIMEOUT_SECS) * 1000;
+        // Reset timer, if running
+        clearTimeout(this.transitionTimerId);
+        this.transitionTimerId = setTimeout(() => {
+            this.states.GarageDoorCurrentState = this.states.GarageDoorTargetState;
+            this.service.setCharacteristic(this.platform.Characteristic.CurrentDoorState, (this.states.GarageDoorCurrentState));
+            this.storeState();
+            this.log.info(`[${this.accessoryConfiguration.accessoryName}] Setting Current Door State: ${GarageDoor.getStateName(this.states.GarageDoorCurrentState)}`);
+        }, transitionDelayMillis);
+    }
+    async getTargetDoorState() {
+        const garageDoorTargetState = this.states.GarageDoorTargetState;
+        this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Getting Target Door State: ${GarageDoor.getStateName(garageDoorTargetState)}`);
+        return garageDoorTargetState;
+    }
+    async getObstructionDetected() {
+        const obstructionDetected = this.states.ObstructionDetected;
+        this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Getting Obstruction Detected: ${obstructionDetected}`);
+        return obstructionDetected;
+    }
+    getJsonState() {
+        const json = JSON.stringify({
+            [this.stateStorageKey]: this.states.GarageDoorCurrentState,
+        });
+        return json;
+    }
+    getAccessoryTypeName() {
+        return GarageDoor.ACCESSORY_TYPE_NAME;
+    }
+    static getStateName(state) {
+        let stateName;
+        switch (state) {
+            case undefined: {
+                stateName = 'undefined';
+                break;
+            }
+            case GarageDoor.OPEN: {
+                stateName = 'OPEN';
+                break;
+            }
+            case GarageDoor.CLOSED: {
+                stateName = 'CLOSED';
+                break;
+            }
+            case GarageDoor.OPENING: {
+                stateName = 'OPENING';
+                break;
+            }
+            case GarageDoor.CLOSING: {
+                stateName = 'CLOSING';
+                break;
+            }
+            case GarageDoor.STOPPED: {
+                stateName = 'STOPPED';
+                break;
+            }
+            default: {
+                stateName = state.toString();
+            }
+        }
+        return stateName;
+    }
+    // Updatable Obstruction interface
+    updateObstruction(value, accessoryId) {
+        this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Request update obstruction detected to ${value}`);
+        if (accessoryId !== this.accessoryConfiguration.accessoryID) {
+            this.log.error(`[${this.accessoryConfiguration.accessoryName}] Accessory Id  ${accessoryId} is not valid for this accessory`);
+            throw new ObstructionValueUpdateNotAllowed(`Invalid accessory id: ${accessoryId}`);
+        }
+        else if (typeof value !== 'boolean') {
+            this.log.error(`[${this.accessoryConfiguration.accessoryName}] Value ${value} is not valid for a Garage Door obstruction detected`);
+            throw new InvalidObstructionValueType(`Invalid sensor value: ${value}`);
+        }
+        else if (this.states.GarageDoorCurrentState === GarageDoor.OPENING || this.states.GarageDoorCurrentState === GarageDoor.CLOSING) {
+            this.states.ObstructionDetected = value;
+            this.service.setCharacteristic(this.platform.Characteristic.ObstructionDetected, (this.states.ObstructionDetected));
+            // Only log to 'info' if setting ObstructionDetected to true
+            this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Updating obstruction detected to ${value}`);
+            if (value === true) {
+                // Reset timer, if running
+                clearTimeout(this.transitionTimerId);
+                this.states.GarageDoorCurrentState = GarageDoor.STOPPED;
+                this.service.setCharacteristic(this.platform.Characteristic.CurrentDoorState, (this.states.GarageDoorCurrentState));
+                this.log.info(`[${this.accessoryConfiguration.accessoryName}] Setting Current Door State: ${GarageDoor.getStateName(this.states.GarageDoorCurrentState)}`);
+            }
+        }
+        else {
+            this.log.debug(`[${this.accessoryConfiguration.accessoryName}] Ignoring. Garage Door is ${GarageDoor.getStateName(this.states.GarageDoorCurrentState)}`);
+        }
+    }
+}
+//# sourceMappingURL=virtualAccessoryGarageDoor.js.map