@switchbot/homebridge-switchbot 3.5.1-beta.8 → 3.5.1

package/src/irdevice/tv.ts

@@ -59,20 +59,20 @@ export class TV extends irdeviceBase {
     switch (device.remoteType) {
       case 'Speaker':
       case 'DIY Speaker':
-        accessory.category = this.platform.api.hap.Categories.SPEAKER;
+        accessory.category = this.hap.Categories.SPEAKER;
         break;
       case 'IPTV':
       case 'DIY IPTV':
-        accessory.category = this.platform.api.hap.Categories.TV_STREAMING_STICK;
+        accessory.category = this.hap.Categories.TV_STREAMING_STICK;
         break;
       case 'DVD':
       case 'DIY DVD':
       case 'Set Top Box':
       case 'DIY Set Top Box':
-        accessory.category = this.platform.api.hap.Categories.TV_SET_TOP_BOX;
+        accessory.category = this.hap.Categories.TV_SET_TOP_BOX;
         break;
       default:
-        accessory.category = this.platform.api.hap.Categories.TELEVISION;
+        accessory.category = this.hap.Categories.TELEVISION;
     }
 
     this.Television.Service
@@ -125,7 +125,7 @@ export class TV extends irdeviceBase {
   }
 
   async VolumeSelectorSet(value: CharacteristicValue): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} VolumeSelector: ${value}`);
+    await this.debugLog(`VolumeSelector: ${value}`);
     if (value === this.hap.Characteristic.VolumeSelector.INCREMENT) {
       this.pushVolumeUpChanges();
     } else {
@@ -136,61 +136,61 @@ export class TV extends irdeviceBase {
   async RemoteKeySet(value: CharacteristicValue): Promise<void> {
     switch (value) {
       case this.hap.Characteristic.RemoteKey.REWIND: {
-        this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Set Remote Key Pressed: REWIND`);
+        await this.debugLog('Set Remote Key Pressed: REWIND');
         break;
       }
       case this.hap.Characteristic.RemoteKey.FAST_FORWARD: {
-        this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Set Remote Key Pressed: FAST_FORWARD`);
+        await this.debugLog('Set Remote Key Pressed: FAST_FORWARD');
         break;
       }
       case this.hap.Characteristic.RemoteKey.NEXT_TRACK: {
-        this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Set Remote Key Pressed: NEXT_TRACK`);
+        await this.debugLog('Set Remote Key Pressed: NEXT_TRACK');
         break;
       }
       case this.hap.Characteristic.RemoteKey.PREVIOUS_TRACK: {
-        this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Set Remote Key Pressed: PREVIOUS_TRACK`);
+        await this.debugLog('Set Remote Key Pressed: PREVIOUS_TRACK');
         break;
       }
       case this.hap.Characteristic.RemoteKey.ARROW_UP: {
-        this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Set Remote Key Pressed: ARROW_UP`);
+        await this.debugLog('Set Remote Key Pressed: ARROW_UP');
         //this.pushUpChanges();
         break;
       }
       case this.hap.Characteristic.RemoteKey.ARROW_DOWN: {
-        this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Set Remote Key Pressed: ARROW_DOWN`);
+        await this.debugLog('Set Remote Key Pressed: ARROW_DOWN');
         //this.pushDownChanges();
         break;
       }
       case this.hap.Characteristic.RemoteKey.ARROW_LEFT: {
-        this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Set Remote Key Pressed: ARROW_LEFT`);
+        await this.debugLog('Set Remote Key Pressed: ARROW_LEFT');
         //this.pushLeftChanges();
         break;
       }
       case this.hap.Characteristic.RemoteKey.ARROW_RIGHT: {
-        this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Set Remote Key Pressed: ARROW_RIGHT`);
+        await this.debugLog('Set Remote Key Pressed: ARROW_RIGHT');
         //this.pushRightChanges();
         break;
       }
       case this.hap.Characteristic.RemoteKey.SELECT: {
-        this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Set Remote Key Pressed: SELECT`);
+        await this.debugLog('Set Remote Key Pressed: SELECT');
         //this.pushOkChanges();
         break;
       }
       case this.hap.Characteristic.RemoteKey.BACK: {
-        this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Set Remote Key Pressed: BACK`);
+        await this.debugLog('Set Remote Key Pressed: BACK');
         //this.pushBackChanges();
         break;
       }
       case this.hap.Characteristic.RemoteKey.EXIT: {
-        this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Set Remote Key Pressed: EXIT`);
+        await this.debugLog('Set Remote Key Pressed: EXIT');
         break;
       }
       case this.hap.Characteristic.RemoteKey.PLAY_PAUSE: {
-        this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Set Remote Key Pressed: PLAY_PAUSE`);
+        await this.debugLog('Set Remote Key Pressed: PLAY_PAUSE');
         break;
       }
       case this.hap.Characteristic.RemoteKey.INFORMATION: {
-        this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Set Remote Key Pressed: INFORMATION`);
+        await this.debugLog('Set Remote Key Pressed: INFORMATION');
         //this.pushMenuChanges();
         break;
       }
@@ -198,12 +198,12 @@ export class TV extends irdeviceBase {
   }
 
   async ActiveIdentifierSet(value: CharacteristicValue): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} ActiveIdentifier: ${value}`);
+    await this.debugLog(`ActiveIdentifier: ${value}`);
     this.Television.ActiveIdentifier = value;
   }
 
   async ActiveSet(value: CharacteristicValue): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Active (value): ${value}`);
+    await this.debugLog(`Active (value): ${value}`);
 
     this.Television.Active = value;
     if (this.Television.Active === this.hap.Characteristic.Active.ACTIVE) {
@@ -224,7 +224,7 @@ export class TV extends irdeviceBase {
    * TV           "command"       "channelSub"      "default"	        previous channel
    */
   async pushTvOnChanges(): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushTvOnChanges`
+    await this.debugLog('pushTvOnChanges'
       + ` Active: ${this.Television.Active}, disablePushOn: ${this.disablePushOn}`);
     if (this.Television.Active === this.hap.Characteristic.Active.ACTIVE && !this.disablePushOn) {
       const commandType: string = await this.commandType();
@@ -239,7 +239,7 @@ export class TV extends irdeviceBase {
   }
 
   async pushTvOffChanges(): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushTvOffChanges`
+    await this.debugLog('pushTvOffChanges'
       + ` Active: ${this.Television.Active}, disablePushOff: ${this.disablePushOff}`);
     if (this.Television.Active === this.hap.Characteristic.Active.INACTIVE && !this.disablePushOff) {
       const commandType: string = await this.commandType();
@@ -254,7 +254,7 @@ export class TV extends irdeviceBase {
   }
 
   async pushOkChanges(): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushOkChanges disablePushDetail: ${this.disablePushDetail}`);
+    await this.debugLog(`pushOkChanges disablePushDetail: ${this.disablePushDetail}`);
     if (!this.disablePushDetail) {
       const bodyChange = JSON.stringify({
         command: 'Ok',
@@ -266,7 +266,7 @@ export class TV extends irdeviceBase {
   }
 
   async pushBackChanges(): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushBackChanges disablePushDetail: ${this.disablePushDetail}`);
+    await this.debugLog(`pushBackChanges disablePushDetail: ${this.disablePushDetail}`);
     if (!this.disablePushDetail) {
       const bodyChange = JSON.stringify({
         command: 'Back',
@@ -278,7 +278,7 @@ export class TV extends irdeviceBase {
   }
 
   async pushMenuChanges(): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushMenuChanges disablePushDetail: ${this.disablePushDetail}`);
+    await this.debugLog(`pushMenuChanges disablePushDetail: ${this.disablePushDetail}`);
     if (!this.disablePushDetail) {
       const bodyChange = JSON.stringify({
         command: 'Menu',
@@ -290,7 +290,7 @@ export class TV extends irdeviceBase {
   }
 
   async pushUpChanges(): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushUpChanges disablePushDetail: ${this.disablePushDetail}`);
+    await this.debugLog(`pushUpChanges disablePushDetail: ${this.disablePushDetail}`);
     if (!this.disablePushDetail) {
       const bodyChange = JSON.stringify({
         command: 'Up',
@@ -302,7 +302,7 @@ export class TV extends irdeviceBase {
   }
 
   async pushDownChanges(): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushDownChanges disablePushDetail: ${this.disablePushDetail}`);
+    await this.debugLog(`pushDownChanges disablePushDetail: ${this.disablePushDetail}`);
     if (!this.disablePushDetail) {
       const bodyChange = JSON.stringify({
         command: 'Down',
@@ -314,7 +314,7 @@ export class TV extends irdeviceBase {
   }
 
   async pushRightChanges(): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushRightChanges disablePushDetail: ${this.disablePushDetail}`);
+    await this.debugLog(`pushRightChanges disablePushDetail: ${this.disablePushDetail}`);
     if (!this.disablePushDetail) {
       const bodyChange = JSON.stringify({
         command: 'Right',
@@ -326,7 +326,7 @@ export class TV extends irdeviceBase {
   }
 
   async pushLeftChanges(): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushLeftChanges disablePushDetail: ${this.disablePushDetail}`);
+    await this.debugLog(`pushLeftChanges disablePushDetail: ${this.disablePushDetail}`);
     if (!this.disablePushDetail) {
       const bodyChange = JSON.stringify({
         command: 'Left',
@@ -338,7 +338,7 @@ export class TV extends irdeviceBase {
   }
 
   async pushVolumeUpChanges(): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushVolumeUpChanges disablePushDetail: ${this.disablePushDetail}`);
+    await this.debugLog(`pushVolumeUpChanges disablePushDetail: ${this.disablePushDetail}`);
     if (!this.disablePushDetail) {
       const bodyChange = JSON.stringify({
         command: 'volumeAdd',
@@ -350,7 +350,7 @@ export class TV extends irdeviceBase {
   }
 
   async pushVolumeDownChanges(): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushVolumeDownChanges disablePushDetail: ${this.disablePushDetail}`);
+    await this.debugLog(`pushVolumeDownChanges disablePushDetail: ${this.disablePushDetail}`);
     if (!this.disablePushDetail) {
       const bodyChange = JSON.stringify({
         command: 'volumeSub',
@@ -362,14 +362,14 @@ export class TV extends irdeviceBase {
   }
 
   async pushTVChanges(bodyChange: any): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushTVChanges`);
+    await this.debugLog('pushTVChanges');
     if (this.device.connectionType === 'OpenAPI') {
-      this.infoLog(`${this.device.remoteType}: ${this.accessory.displayName} Sending request to SwitchBot API, body: ${bodyChange},`);
+      await this.infoLog(`Sending request to SwitchBot API, body: ${bodyChange},`);
       try {
         const { body, statusCode } = await this.pushChangeRequest(bodyChange);
         const deviceStatus: any = await body.json();
         await this.pushStatusCodes(statusCode, deviceStatus);
-        if ((statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)) {
+        if (await this.successfulStatusCodes(statusCode, deviceStatus)) {
           await this.successfulPushChange(statusCode, deviceStatus, bodyChange);
           await this.updateHomeKitCharacteristics();
         } else {
@@ -381,29 +381,18 @@ export class TV extends irdeviceBase {
         await this.pushChangeError(e);
       }
     } else {
-      this.warnLog(`${this.device.remoteType}: ${this.accessory.displayName}`
-      + ` Connection Type: ${this.device.connectionType}, commands will not be sent to OpenAPI`);
+      await this.warnLog(`Connection Type: ${this.device.connectionType}, commands will not be sent to OpenAPI`);
     }
   }
 
   async updateHomeKitCharacteristics(): Promise<void> {
+    await this.debugLog('updateHomeKitCharacteristics');
     // Active
-    if (this.Television.Active === undefined) {
-      this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Active: ${this.Television.Active}`);
-    } else {
-      this.accessory.context.Active = this.Television.Active;
-      this.Television.Service.updateCharacteristic(this.hap.Characteristic.Active, this.Television.Active);
-      this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} updateCharacteristic Active: ${this.Television.Active}`);
-    }
+    await this.updateCharacteristic(this.Television.Service, this.hap.Characteristic.Active,
+      this.Television.Active, 'Active');
     // ActiveIdentifier
-    if (this.Television.ActiveIdentifier === undefined) {
-      this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} ActiveIdentifier: ${this.Television.ActiveIdentifier}`);
-    } else {
-      this.accessory.context.ActiveIdentifier = this.Television.ActiveIdentifier;
-      this.Television.Service.updateCharacteristic(this.hap.Characteristic.ActiveIdentifier, this.Television.ActiveIdentifier);
-      this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} updateCharacteristic`
-        + ` ActiveIdentifier: ${this.Television.ActiveIdentifier}`);
-    }
+    await this.updateCharacteristic(this.Television.Service, this.hap.Characteristic.ActiveIdentifier,
+      this.Television.ActiveIdentifier, 'ActiveIdentifier');
   }
 
   async apiError(e: any): Promise<void> {

package/src/irdevice/vacuumcleaner.ts

@@ -28,6 +28,8 @@ export class VacuumCleaner extends irdeviceBase {
     device: irdevice & irDevicesConfig,
   ) {
     super(platform, accessory, device);
+    // Set category
+    accessory.category = this.hap.Categories.OTHER;
 
     // Initialize Switch Service
     accessory.context.Switch = accessory.context.Switch ?? {};
@@ -48,7 +50,7 @@ export class VacuumCleaner extends irdeviceBase {
   }
 
   async OnSet(value: CharacteristicValue): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} On: ${value}`);
+    await this.debugLog(`On: ${value}`);
 
     // Set the requested state
     this.Switch.On = value;
@@ -66,7 +68,7 @@ export class VacuumCleaner extends irdeviceBase {
    * Vacuum Cleaner    "command"       "turnOn"       "default"	      set to ON state
    */
   async pushOnChanges(): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushOnChanges`
+    await this.debugLog('pushOnChanges'
       + ` On: ${this.Switch.On}, disablePushOn: ${this.disablePushOn}`);
     if (this.Switch.On && !this.disablePushOn) {
       const commandType: string = await this.commandType();
@@ -81,7 +83,7 @@ export class VacuumCleaner extends irdeviceBase {
   }
 
   async pushOffChanges(): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushOffChanges`
+    await this.debugLog('pushOffChanges'
       + ` On: ${this.Switch.On}, disablePushOff: ${this.disablePushOff}`);
     if (!this.Switch.On && !this.disablePushOff) {
       const commandType: string = await this.commandType();
@@ -96,14 +98,14 @@ export class VacuumCleaner extends irdeviceBase {
   }
 
   async pushChanges(bodyChange: any): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushChanges`);
+    await this.debugLog('pushChanges');
     if (this.device.connectionType === 'OpenAPI') {
-      this.infoLog(`${this.device.remoteType}: ${this.accessory.displayName} Sending request to SwitchBot API, body: ${bodyChange},`);
+      await this.infoLog(`Sending request to SwitchBot API, body: ${bodyChange},`);
       try {
         const { body, statusCode } = await this.pushChangeRequest(bodyChange);
         const deviceStatus: any = await body.json();
         await this.pushStatusCodes(statusCode, deviceStatus);
-        if ((statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)) {
+        if (await this.successfulStatusCodes(statusCode, deviceStatus)) {
           await this.successfulPushChange(statusCode, deviceStatus, bodyChange);
           await this.updateHomeKitCharacteristics();
         } else {
@@ -115,20 +117,15 @@ export class VacuumCleaner extends irdeviceBase {
         await this.pushChangeError(e);
       }
     } else {
-      this.warnLog(`${this.device.remoteType}: ${this.accessory.displayName}`
-        + ` Connection Type: ${this.device.connectionType}, commands will not be sent to OpenAPI`);
+      await this.warnLog(`Connection Type: ${this.device.connectionType}, commands will not be sent to OpenAPI`);
     }
   }
 
   async updateHomeKitCharacteristics(): Promise<void> {
+    await this.debugLog('updateHomeKitCharacteristics');
     // On
-    if (this.Switch.On === undefined) {
-      this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} On: ${this.Switch.On}`);
-    } else {
-      this.accessory.context.On = this.Switch.On;
-      this.Switch.Service.updateCharacteristic(this.hap.Characteristic.On, this.Switch.On);
-      this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} updateCharacteristic On: ${this.Switch.On}`);
-    }
+    await this.updateCharacteristic(this.Switch.Service, this.hap.Characteristic.On,
+      this.Switch.On, 'On');
   }
 
   async apiError(e: any): Promise<void> {

package/src/irdevice/waterheater.ts

@@ -28,6 +28,8 @@ export class WaterHeater extends irdeviceBase {
     device: irdevice & irDevicesConfig,
   ) {
     super(platform, accessory, device);
+    // Set category
+    accessory.category = this.hap.Categories.FAUCET;
 
     // Initialize Switch Service
     accessory.context.Valve = accessory.context.Valve ?? {};
@@ -49,7 +51,7 @@ export class WaterHeater extends irdeviceBase {
   }
 
   async ActiveSet(value: CharacteristicValue): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Active: ${value}`);
+    await this.debugLog(`Active: ${value}`);
 
     this.Valve.Active = value;
     if (this.Valve.Active === this.hap.Characteristic.Active.ACTIVE) {
@@ -68,7 +70,7 @@ export class WaterHeater extends irdeviceBase {
    * WaterHeater     "command"       "turnOn"          "default"	       set to ON state
    */
   async pushWaterHeaterOnChanges(): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushWaterHeaterOnChanges Active: ${this.Valve.Active},`
+    await this.debugLog(`pushWaterHeaterOnChanges Active: ${this.Valve.Active},`
       + ` disablePushOn: ${this.disablePushOn}`);
     if (this.Valve.Active === this.hap.Characteristic.Active.ACTIVE && !this.disablePushOn) {
       const commandType: string = await this.commandType();
@@ -83,7 +85,7 @@ export class WaterHeater extends irdeviceBase {
   }
 
   async pushWaterHeaterOffChanges(): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushWaterHeaterOffChanges Active: ${this.Valve.Active},`
+    await this.debugLog(`pushWaterHeaterOffChanges Active: ${this.Valve.Active},`
       + ` disablePushOff: ${this.disablePushOff}`);
     if (this.Valve.Active === this.hap.Characteristic.Active.INACTIVE && !this.disablePushOff) {
       const commandType: string = await this.commandType();
@@ -98,14 +100,14 @@ export class WaterHeater extends irdeviceBase {
   }
 
   async pushChanges(bodyChange: any): Promise<void> {
-    this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushChanges`);
+    await this.debugLog('pushChanges');
     if (this.device.connectionType === 'OpenAPI') {
-      this.infoLog(`${this.device.remoteType}: ${this.accessory.displayName} Sending request to SwitchBot API, body: ${bodyChange},`);
+      this.infoLog(`Sending request to SwitchBot API, body: ${bodyChange},`);
       try {
         const { body, statusCode } = await this.pushChangeRequest(bodyChange);
         const deviceStatus: any = await body.json();
         await this.pushStatusCodes(statusCode, deviceStatus);
-        if ((statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)) {
+        if (await this.successfulStatusCodes(statusCode, deviceStatus)) {
           await this.successfulPushChange(statusCode, deviceStatus, bodyChange);
           await this.updateHomeKitCharacteristics();
         } else {
@@ -117,20 +119,15 @@ export class WaterHeater extends irdeviceBase {
         await this.pushChangeError(e);
       }
     } else {
-      this.warnLog(`${this.device.remoteType}: ${this.accessory.displayName}`
-        + ` Connection Type: ${this.device.connectionType}, commands will not be sent to OpenAPI`);
+      await this.warnLog(`Connection Type: ${this.device.connectionType}, commands will not be sent to OpenAPI`);
     }
   }
 
   async updateHomeKitCharacteristics(): Promise<void> {
+    await this.debugLog('updateHomeKitCharacteristics');
     // Active
-    if (this.Valve.Active === undefined) {
-      this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Active: ${this.Valve.Active}`);
-    } else {
-      this.accessory.context.Active = this.Valve.Active;
-      this.Valve.Service.updateCharacteristic(this.hap.Characteristic.Active, this.Valve.Active);
-      this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} updateCharacteristic Active: ${this.Valve.Active}`);
-    }
+    await this.updateCharacteristic(this.Valve.Service, this.hap.Characteristic.Active,
+      this.Valve.Active, 'Active');
   }
 
   async apiError({ e }: { e: any }): Promise<void> {