homebridge-smarthq-client 1.3.0 → 1.3.1

package/.github/workflows/release.yml

@@ -21,9 +21,9 @@ jobs:
           persist-credentials: false
 
       - name: Setup Node.js
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v7
         with:
-          node-version: 24
+          node-version: '24.10'
           cache: 'npm'
 
       - name: Install Dependencies
@@ -33,7 +33,9 @@ jobs:
         run: npm run build --if-present
 
       - name: Run Tests
-        run: npm test --if-present 
+        run: npm test --if-present
+        env:
+          NODE_OPTIONS: --experimental-vm-modules
 
       - name: Semantic Release
         env:

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [1.3.1](https://github.com/ceb400/homebridge-smarthq-client/compare/v1.3.0...v1.3.1) (2026-09-18)
+
+
+### Bug Fixes
+
+* :bug: dishwasher options initialized wrong ([ee59785](https://github.com/ceb400/homebridge-smarthq-client/commit/ee59785bbdc33a7373a8d0dfe0b766f0101ac1e2))
+* :bug: Fix Dishwasher Cleaning mode error.  Replace Cycle Pct Done with new Time remaining ([a1738bb](https://github.com/ceb400/homebridge-smarthq-client/commit/a1738bbe3e36217c0476d89ffcbe1f5682909776))
+
 # Changelog
 
 All notable changes to this project will be documented in this file.

package/dist/dishwasher/dishwasher.d.ts

@@ -2,9 +2,13 @@ import { CharacteristicValue, PlatformAccessory, Service, Characteristic } from
 import { DeviceService } from "ge-smarthq";
 import { SmartHqPlatform } from "../platform.js";
 /**
+
  * Platform Accessory
+
  * An instance of this class is created for each accessory your platform registers
+
  * Each accessory may expose multiple services of different service types
+
  */
 export declare class Dishwasher {
     private readonly platform;
@@ -50,36 +54,48 @@ export declare class Dishwasher {
     private readonly SANI_AND_BOOST_TEMP;
     constructor(platform: SmartHqPlatform, accessory: PlatformAccessory, deviceServices: DeviceService[], deviceId: string, groupAccessory: PlatformAccessory[]);
     /**
+  
      * Handle requests to get the current value of the "Active" characteristic
+  
      */
     handleSetDurationGet(): Promise<CharacteristicValue>;
     /**
+  
      * Handle requests to get the current value of the "Active" characteristic
+  
      */
     handleActiveGet(): Promise<CharacteristicValue>;
     /**
+  
      * Handle requests to set the "Active" characteristic
+  
      */
     handleActiveSet(value: CharacteristicValue): Promise<void>;
     /**
+  
      * Handle requests to get the current value of the "In Use" characteristic
+  
      */
     handleInUseGet(): Promise<CharacteristicValue>;
     /**
+  
      * Handle requests to get the current value of the "Name" characteristic
+  
      */
     handleNameGet(): Promise<string | false>;
     /**
+  
      * Handle requests to get the current value of the "mode" value
+  
      */
     handleModeGet(v1mode: string): Promise<CharacteristicValue>;
     /**
+  
      * Handle requests to get the current value of the "Valve Type" characteristic
+  
      */
     handleValveTypeGet(): Promise<number>;
     handleRemainingTimeGet(): Promise<CharacteristicValue>;
-    getCyclePct(): Promise<CharacteristicValue>;
-    setCyclePct(value: CharacteristicValue): Promise<CharacteristicValue>;
     setMode(): Promise<boolean>;
     private formatError;
     startCycle(): Promise<boolean>;
@@ -96,6 +112,7 @@ export declare class Dishwasher {
     getLastElementAndCapitalize(str: string, delimiter: string): [string, string];
     setupWebSocket(): Promise<void>;
     logCurrentOptions(): void;
+    updateDurationTimerDisplay(remainingSeconds: number): void;
     testCases(): Promise<false | undefined>;
     testSetMode({ mode, temp, dry, zone, bottle, steam, silverware }: {
         mode?: string;

package/dist/dishwasher/dishwasher.js

@@ -1,9 +1,13 @@
 import { SmartHQClient } from "ge-smarthq";
 import chalk from "chalk";
 /**
+
  * Platform Accessory
+
  * An instance of this class is created for each accessory your platform registers
+
  * Each accessory may expose multiple services of different service types
+
  */
 export class Dishwasher {
     platform;
@@ -37,7 +41,7 @@ export class Dishwasher {
     ONE_HOUR_MODE = "cloud.smarthq.domain.dishwasher.timed.hours.1";
     PLATPLUS_MODE = "cloud.smarthq.domain.dishwasher.brand.cascade.platinumplus";
     RINSE_MODE = "cloud.smarthq.domain.dishwasher.rinse";
-    CLEAN_MODE = "cloud.smarthq.domain.dishwasher.clean";
+    CLEAN_MODE = "cloud.smarthq.domain.dishwasher.dishwasher.cleaning";
     LIGHT_MODE = "cloud.smarthq.domain.dishwasher.light";
     //========  wash zone constants  ========
     BOTH_ZONE = "cloud.smarthq.type.dishwasher.washzone.both";
@@ -81,26 +85,25 @@ export class Dishwasher {
         }
         this.setupWebSocket();
         /*
+    
          *  Listen for WebSocket messages for this device and update HomeKit characteristics accordingly
+    
          */
         this.client.on("service_update", (message) => {
-            //this.client.debug(chalk.red('Wash Modes - Service Update:'+ JSON.stringify(message, null, 2)));
             if (message.domainType === "cloud.smarthq.domain.energy"
                 && message.deviceType === "cloud.smarthq.device.dishwasher") {
                 this.energyMeterValuePerHour += message.state?.meterValueDelta || 0; // sum for the hour until reset
+                this.client.debug(chalk.white('Energy Meter Value: ' + this.energyMeterValuePerHour));
             }
+            // Update the time remaining from the WebSocket message if it is a cycle timer update
+            // Update the ConfiguredName of the durationTimer service to show the time remaining in the cycle or the current time if no cycle is active
             if (message.serviceType === "cloud.smarthq.service.cycletimer" &&
                 message.domainType === "cloud.smarthq.domain.cycle") {
-                // when secondsRemaining is 0 then reset totalSeconds to prevent stale values from previous cycles
-                if (message.state?.secondsRemaining === 0) {
-                    this.totalSeconds = 0;
-                }
+                this.timeRemainingFromWebSocket =
+                    message.state?.secondsRemaining || 0;
                 if (this.totalSeconds === 0) {
                     this.totalSeconds = message.state?.secondsRemaining || 0;
                 }
-                this.timeRemainingFromWebSocket =
-                    message.state?.secondsRemaining || 0;
-                this.getCyclePct();
             }
             if (message.state?.mode != null) {
                 switch (message.state.mode) {
@@ -138,6 +141,10 @@ export class Dishwasher {
             this.client.debug(chalk.red("Watts/hour value: " + this.energyMeterValuePerHour));
             this.energyMeterValuePerHour = 0;
         }, 60 * 60 * 1000);
+        // Interval to update configured name of durationTimer service every minute to show time remaining in cycle or current time if no cycle is active
+        setInterval(() => {
+            this.updateDurationTimerDisplay(this.timeRemainingFromWebSocket);
+        }, 60 * 1000);
         const washTemps = this.getAvailableItemsByType("washTempAvailable");
         const washZones = this.getAvailableItemsByType("washZoneAvailable");
         const heatedDrys = this.getAvailableItemsByType("heatedDryAvailable");
@@ -199,21 +206,23 @@ export class Dishwasher {
         dishwasher
             .getCharacteristic(this.Characteristic.Name)
             .onGet(this.handleNameGet.bind(this));
-        //=====================================================================================
-        // create a new Lightbulb service for the Cycle Pct Done
-        //=====================================================================================
-        displayName = "Cycle Pct Done";
-        const cyclePct = this.accessory.getService(displayName) ||
-            this.accessory.addService(this.Service.Lightbulb, displayName, `${this.deviceId}-cycle-done`);
-        cyclePct.setCharacteristic(this.Characteristic.Name, displayName);
-        cyclePct.addOptionalCharacteristic(this.Characteristic.ConfiguredName);
-        cyclePct.setCharacteristic(this.Characteristic.ConfiguredName, displayName);
-        cyclePct
-            .getCharacteristic(this.Characteristic.Brightness)
-            .onGet(this.getCyclePct.bind(this))
-            .onSet(this.setCyclePct.bind(this));
+        // Test dynamically changing configured name to use as a text field
+        const customName = "Time Display";
+        const durationTimer = this.setupService("Outlet", customName, `${this.deviceId}-optionstimer`);
+        durationTimer
+            .getCharacteristic(this.Characteristic.On)
+            .onGet(() => {
+            const currentState = durationTimer.getCharacteristic(this.Characteristic.On)
+                .value;
+            return currentState; // Return true or false
+        })
+            .onSet((value) => {
+            this.client.debug(chalk.yellow(`Time Display On/Off set to: ${value}`));
+        });
         /**
+    
          * create a new steam Outlet service Dummy (used as 'available' option)  ------
+    
          */
         displayName = "Steam option";
         const optionSteam = this.setupService("Outlet", displayName, `${this.deviceId}-optionsteam`);
@@ -229,7 +238,9 @@ export class Dishwasher {
             this.testSetMode({ steam: value });
         });
         /**
+    
          * create a new bottlewash Outlet service Dummy (used as 'available' option) for extending presets ------
+    
          */
         displayName = "Bottlewash option";
         const optionBottlewash = this.setupService("Outlet", displayName, `${this.deviceId}-optionbottlewash`);
@@ -245,7 +256,9 @@ export class Dishwasher {
             this.testSetMode({ bottle: value });
         });
         /**
+    
          * create a new silverware Outlet service Dummy (used as 'available' option) for extending presets ------
+    
          */
         displayName = "Silverware option";
         const optionSilverware = this.setupService("Outlet", displayName, `${this.deviceId}-option-silverware`);
@@ -261,7 +274,9 @@ export class Dishwasher {
             this.testSetMode({ silverware: this.currentSilverwareWash });
         });
         /**
+    
          * Grouped services for Wash Temp, Dry Level, Wash Zone, and Preset Modes - only one can be on at a time within each group
+    
          */
         this.client.debug(chalk.green("Wash Temperature options"));
         const temps = washTemps.map(([item]) => this.setupGroupService("Outlet", item, "modegroup-" + item.replace(/\s+/g, "-").toLowerCase(), this.groupAccessory[0]));
@@ -495,6 +510,7 @@ export class Dishwasher {
         // NOTE:  only for developing a method for testing command combinations.
         // this.testCases();
         /*
+        
             for (const service of this.deviceServices) {
               if (
                 service.serviceDeviceType === "cloud.smarthq.device.dishwasher" &&
@@ -516,18 +532,24 @@ export class Dishwasher {
                 }
         
                 //const originalPresetMode = response?.state.
+        
               }
             }
+        
               */
     }
     /**
+  
      * Handle requests to get the current value of the "Active" characteristic
+  
      */
     async handleSetDurationGet() {
         return this.totalSeconds;
     }
     /**
+  
      * Handle requests to get the current value of the "Active" characteristic
+  
      */
     async handleActiveGet() {
         let isActive = false;
@@ -541,25 +563,11 @@ export class Dishwasher {
                         this.client.debug("No response from dishwasher run status request");
                         return false;
                     }
-                    if (response.state.runStatus === "cloud.smarthq.type.runstatus.off") {
+                    if (response.state.runStatus === "cloud.smarthq.type.runstatus.endofcycle"
+                        || response.state.runStatus === "cloud.smarthq.type.runstatus.off") {
                         // change back to 0 seconds remaining when cycle is not active to prevent stale remaining time value in HomeKit
                         this.totalSeconds = 0; // reset total seconds when cycle is complete
-                        this.accessory
-                            .getService("Dishwasher")
-                            ?.getCharacteristic(this.Characteristic.Active)
-                            .updateValue(false);
-                        this.accessory
-                            .getService("Dishwasher")
-                            ?.getCharacteristic(this.Characteristic.SetDuration)
-                            .updateValue(0);
-                        this.accessory
-                            .getService("Dishwasher")
-                            ?.getCharacteristic(this.Characteristic.RemainingDuration)
-                            .updateValue(0);
-                        this.accessory
-                            .getService("Dishwasher")
-                            ?.getCharacteristic(this.Characteristic.InUse)
-                            .updateValue(false);
+                        this.updateDurationTimerDisplay(this.totalSeconds);
                     }
                     else {
                         isActive = true;
@@ -570,7 +578,7 @@ export class Dishwasher {
                         this.accessory
                             .getService("Dishwasher")
                             ?.getCharacteristic(this.Characteristic.InUse)
-                            .updateValue(isActive);
+                            .updateValue(this.Characteristic.InUse.IN_USE);
                     }
                     break;
                 }
@@ -583,7 +591,9 @@ export class Dishwasher {
         return isActive;
     }
     /**
+  
      * Handle requests to set the "Active" characteristic
+  
      */
     async handleActiveSet(value) {
         this.client.debug(`Starting dishwasher active state: ${value}`);
@@ -611,7 +621,9 @@ export class Dishwasher {
         }
     }
     /**
+  
      * Handle requests to get the current value of the "In Use" characteristic
+  
      */
     async handleInUseGet() {
         //this.client.debug('Triggered GET InUse');
@@ -620,7 +632,9 @@ export class Dishwasher {
         return this.handleActiveGet();
     }
     /**
+  
      * Handle requests to get the current value of the "Name" characteristic
+  
      */
     async handleNameGet() {
         //this.client.debug('Triggered GET Name');
@@ -646,7 +660,9 @@ export class Dishwasher {
         return this.accessory.displayName;
     }
     /**
+  
      * Handle requests to get the current value of the "mode" value
+  
      */
     async handleModeGet(v1mode) {
         let isOn = false;
@@ -657,10 +673,12 @@ export class Dishwasher {
                 try {
                     const response = await this.client.getServiceDetails(this.deviceId, service.serviceId);
                     /*
+          
                     this.client.debug(
                       "================ Response from getServiceDetails for mode get: " +
                         JSON.stringify(response, null, 2),
                     );
+          
                     */
                     if (response?.state?.mode == null) {
                         this.client.debug("No response from dishwasher mode request");
@@ -678,7 +696,9 @@ export class Dishwasher {
         return isOn;
     }
     /**
+  
      * Handle requests to get the current value of the "Valve Type" characteristic
+  
      */
     async handleValveTypeGet() {
         //this.client.debug('Triggered GET ValveType');
@@ -698,34 +718,6 @@ export class Dishwasher {
         }
         return this.totalSeconds;
     }
-    async getCyclePct() {
-        // remaining time appears able to change after a cycle has started???
-        if (this.timeRemainingFromWebSocket > this.totalSeconds) {
-            this.totalSeconds = this.timeRemainingFromWebSocket;
-        }
-        const pctDone = 100 - Math.round((this.timeRemainingFromWebSocket / this.totalSeconds) * 100) || 0;
-        this.setCyclePct(pctDone);
-        if (this.timeRemainingFromWebSocket === 0) {
-            this.accessory
-                .getService("Cycle Pct Done")
-                ?.getCharacteristic(this.Characteristic.On)
-                .updateValue(false);
-        }
-        else {
-            this.accessory
-                .getService("Cycle Pct Done")
-                ?.getCharacteristic(this.Characteristic.On)
-                .updateValue(true);
-            this.accessory.getService("Cycle Pct Done")?.updateCharacteristic(this.Characteristic.Brightness, pctDone);
-        }
-        return pctDone;
-    }
-    async setCyclePct(value) {
-        this.accessory
-            .getService("Cycle Pct Done")
-            ?.updateCharacteristic(this.Characteristic.Brightness, value);
-        return value;
-    }
     async setMode() {
         const baseCommand = {
             deviceId: this.deviceId,
@@ -776,6 +768,16 @@ export class Dishwasher {
                     },
                 };
                 break;
+            case this.CLEAN_MODE:
+                cmdBody = {
+                    ...baseCommand,
+                    domainType: this.currentPreset,
+                    command: {
+                        washTemp: this.currentWashTemp,
+                        commandType: "cloud.smarthq.command.dishwasher.mode.v1.set",
+                    },
+                };
+                break;
             case this.ONE_HOUR_MODE:
                 cmdBody = {
                     ...baseCommand,
@@ -862,7 +864,7 @@ export class Dishwasher {
                 this.accessory
                     .getService("Dishwasher")
                     ?.getCharacteristic(this.Characteristic.InUse)
-                    .updateValue(true);
+                    .updateValue(this.Characteristic.InUse.IN_USE);
                 this.accessory
                     .getService("Dishwasher")
                     ?.getCharacteristic(this.Characteristic.SetDuration)
@@ -870,7 +872,7 @@ export class Dishwasher {
                 this.accessory
                     .getService("Dishwasher")
                     ?.getCharacteristic(this.Characteristic.RemainingDuration)
-                    .updateValue(this.totalSeconds);
+                    .updateValue(this.timeRemainingFromWebSocket);
                 return response.success;
             }
         }
@@ -900,7 +902,7 @@ export class Dishwasher {
                 this.accessory
                     .getService("Dishwasher")
                     ?.getCharacteristic(this.Characteristic.InUse)
-                    .updateValue(false);
+                    .updateValue(this.Characteristic.InUse.NOT_IN_USE);
                 this.totalSeconds = 0; // reset total seconds when cycle is stopped
                 this.accessory
                     .getService("Dishwasher")
@@ -909,7 +911,7 @@ export class Dishwasher {
                 this.accessory
                     .getService("Dishwasher")
                     ?.getCharacteristic(this.Characteristic.RemainingDuration)
-                    .updateValue(this.totalSeconds);
+                    .updateValue(this.timeRemainingFromWebSocket);
                 return response.success;
             }
         }
@@ -988,6 +990,7 @@ export class Dishwasher {
             accessory.removeService(service);
         });
     }
+    // Build a list of available dishwasher option names in a display-friendly format.
     getAvailableItemsByType(availableType) {
         let itemsAvailable = [];
         for (const service of this.deviceServices) {
@@ -1077,6 +1080,52 @@ export class Dishwasher {
         this.client.debug(chalk.red("Steam:           " + this.currentSteam));
         this.client.debug(chalk.red("Silverware Wash: " + this.currentSilverwareWash));
     }
+    updateDurationTimerDisplay(remainingSeconds) {
+        const now = new Date();
+        const hours = now.getHours();
+        const minutes = now.getMinutes();
+        if (remainingSeconds > 0) {
+            const remainingHours = Math.floor(remainingSeconds / 3600);
+            const remainingMinutes = Math.floor((remainingSeconds % 3600) / 60);
+            const displayString = `Ends in: ${remainingHours.toString().padStart(2, "0")}:${remainingMinutes.toString().padStart(2, "0")}`;
+            this.accessory
+                .getService("Time Display")
+                ?.getCharacteristic(this.Characteristic.ConfiguredName)
+                .updateValue(displayString);
+            this.accessory
+                .getService("Time Display")
+                ?.getCharacteristic(this.Characteristic.On)
+                .updateValue(false);
+            return;
+        }
+        const displayString = `Time: ${hours.toString().padStart(2, "0")}:${minutes.toString().padStart(2, "0")}`;
+        // when secondsRemaining is 0 then reset totalSeconds to prevent stale values from previous cycles
+        this.totalSeconds = 0;
+        this.accessory
+            .getService("Dishwasher")
+            ?.getCharacteristic(this.Characteristic.SetDuration)
+            .updateValue(0);
+        this.accessory
+            .getService("Dishwasher")
+            ?.getCharacteristic(this.Characteristic.RemainingDuration)
+            .updateValue(0);
+        this.accessory
+            .getService("Dishwasher")
+            ?.getCharacteristic(this.Characteristic.Active)
+            .updateValue(this.Characteristic.Active.INACTIVE);
+        this.accessory
+            .getService("Dishwasher")
+            ?.getCharacteristic(this.Characteristic.InUse)
+            .updateValue(this.Characteristic.InUse.NOT_IN_USE);
+        this.accessory
+            .getService("Time Display")
+            ?.getCharacteristic(this.Characteristic.ConfiguredName)
+            .updateValue(displayString);
+        this.accessory
+            .getService("Time Display")
+            ?.getCharacteristic(this.Characteristic.On)
+            .updateValue(false);
+    }
     async testCases() {
         //======================================================
         // Develop test plan for dishwasher