@switchbot/homebridge-switchbot 3.6.1-beta.8 → 3.7.0

package/src/irdevice/irdevice.ts

@@ -43,11 +43,11 @@ export abstract class irdeviceBase {
       .getService(this.hap.Service.AccessoryInformation)!
       .setCharacteristic(this.hap.Characteristic.Manufacturer, 'SwitchBot')
       .setCharacteristic(this.hap.Characteristic.AppMatchingIdentifier, 'id1087374760')
-      .setCharacteristic(this.hap.Characteristic.Name, device.configDeviceName ?? device.deviceName ?? accessory.displayName)
-      .setCharacteristic(this.hap.Characteristic.ConfiguredName, device.configDeviceName ?? device.deviceName ?? accessory.displayName)
+      .setCharacteristic(this.hap.Characteristic.Name, accessory.displayName)
+      .setCharacteristic(this.hap.Characteristic.ConfiguredName, accessory.displayName)
       .setCharacteristic(this.hap.Characteristic.Model, accessory.context.model ?? 'Unknown')
-      .setCharacteristic(this.hap.Characteristic.ProductData, accessory.context.deviceId)
-      .setCharacteristic(this.hap.Characteristic.SerialNumber, accessory.context.deviceId);
+      .setCharacteristic(this.hap.Characteristic.ProductData, device.deviceId)
+      .setCharacteristic(this.hap.Characteristic.SerialNumber, device.deviceId);
   }
 
   async getDeviceLogSettings(device: irdevice & irDevicesConfig): Promise<void> {
@@ -199,9 +199,9 @@ export abstract class irdeviceBase {
     } else {
       Service.updateCharacteristic(Characteristic, CharacteristicValue);
       await this.debugLog(`updateCharacteristic ${CharacteristicName}: ${CharacteristicValue}`);
-      await this.debugWarnLog(`context before: ${this.accessory.context[CharacteristicName]}`);
+      await this.debugWarnLog(`${CharacteristicName} context before: ${this.accessory.context[CharacteristicName]}`);
       this.accessory.context[CharacteristicName] = CharacteristicValue;
-      await this.debugWarnLog(`context after: ${this.accessory.context[CharacteristicName]}`);
+      await this.debugWarnLog(`${CharacteristicName} context after: ${this.accessory.context[CharacteristicName]}`);
     }
   }
 
@@ -363,7 +363,7 @@ export abstract class irdeviceBase {
 
   async debugSuccessLog(...log: any[]): Promise<void> {
     if (await this.enablingDeviceLogging()) {
-      if (this.deviceLogging?.includes('debug')) {
+      if (await this.loggingIsDebug()) {
         this.log.success(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log));
       }
     }
@@ -377,7 +377,7 @@ export abstract class irdeviceBase {
 
   async debugWarnLog(...log: any[]): Promise<void> {
     if (await this.enablingDeviceLogging()) {
-      if (this.deviceLogging?.includes('debug')) {
+      if (await this.loggingIsDebug()) {
         this.log.warn(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log));
       }
     }
@@ -391,7 +391,7 @@ export abstract class irdeviceBase {
 
   async debugErrorLog(...log: any[]): Promise<void> {
     if (await this.enablingDeviceLogging()) {
-      if (this.deviceLogging?.includes('debug')) {
+      if (await this.loggingIsDebug()) {
         this.log.error(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log));
       }
     }
@@ -401,13 +401,17 @@ export abstract class irdeviceBase {
     if (await this.enablingDeviceLogging()) {
       if (this.deviceLogging === 'debug') {
         this.log.info(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log));
-      } else {
+      } else if (this.deviceLogging === 'debugMode') {
         this.log.debug(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log));
       }
     }
   }
 
+  async loggingIsDebug(): Promise<boolean> {
+    return this.deviceLogging === 'debugMode' || this.deviceLogging === 'debug';
+  }
+
   async enablingDeviceLogging(): Promise<boolean> {
-    return this.deviceLogging.includes('debug') || this.deviceLogging === 'standard';
+    return this.deviceLogging === 'debugMode' || this.deviceLogging === 'debug' || this.deviceLogging === 'standard';
   }
 }

package/src/irdevice/light.ts

@@ -49,7 +49,7 @@ export class Light extends irdeviceBase {
       // Initialize LightBulb Service
       accessory.context.LightBulb = accessory.context.LightBulb ?? {};
       this.LightBulb = {
-        Name: accessory.context.LightBulb.Name ?? `${accessory.displayName} ${device.remoteType}`,
+        Name: accessory.displayName,
         Service: accessory.getService(this.hap.Service.Lightbulb) ?? accessory.addService(this.hap.Service.Lightbulb) as Service,
         On: accessory.context.On || false,
       };
@@ -66,7 +66,7 @@ export class Light extends irdeviceBase {
       // Initialize ProgrammableSwitchOn Service
       accessory.context.ProgrammableSwitchOn = accessory.context.ProgrammableSwitchOn ?? {};
       this.ProgrammableSwitchOn = {
-        Name: accessory.context.ProgrammableSwitchOn.Name ?? `${accessory.displayName} ${device.remoteType} On`,
+        Name: `${accessory.displayName} On`,
         Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch)
         ?? accessory.addService(this.hap.Service.StatefulProgrammableSwitch) as Service,
         ProgrammableSwitchEvent: accessory.context.ProgrammableSwitchEvent ?? this.hap.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS,
@@ -97,7 +97,7 @@ export class Light extends irdeviceBase {
       // Initialize ProgrammableSwitchOff Service
       accessory.context.ProgrammableSwitchOff = accessory.context.ProgrammableSwitchOff ?? {};
       this.ProgrammableSwitchOff = {
-        Name: accessory.context.ProgrammableSwitchOff.Name ?? `${accessory.displayName} ${device.remoteType} Off`,
+        Name: `${accessory.displayName} Off`,
         Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch)
         ?? accessory.addService(this.hap.Service.StatefulProgrammableSwitch) as Service,
         ProgrammableSwitchEvent: accessory.context.ProgrammableSwitchEvent ?? this.hap.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS,

package/src/irdevice/other.ts

@@ -79,7 +79,7 @@ export class Others extends irdeviceBase {
     super(platform, accessory, device);
 
     // default placeholders
-    this.getOtherConfigSettings(device);
+    this.getOtherConfigSettings(accessory, device);
 
     // deviceType
     if (this.otherDeviceType === 'switch') {
@@ -88,7 +88,7 @@ export class Others extends irdeviceBase {
       // Initialize Switch Service
       accessory.context.Switch = accessory.context.Switch ?? {};
       this.Switch = {
-        Name: accessory.context.Switch.Name ?? accessory.displayName,
+        Name: accessory.displayName,
         Service: accessory.getService(this.hap.Service.Switch) ?? accessory.addService(this.hap.Service.Switch) as Service,
       };
       accessory.context.Switch = this.Switch as object;
@@ -114,7 +114,7 @@ export class Others extends irdeviceBase {
       // Initialize GarageDoor Service
       accessory.context.GarageDoor = accessory.context.GarageDoor ?? {};
       this.GarageDoor = {
-        Name: accessory.context.GarageDoor.Name ?? accessory.displayName,
+        Name: accessory.displayName,
         Service: accessory.getService(this.hap.Service.GarageDoorOpener) ?? accessory.addService(this.hap.Service.GarageDoorOpener) as Service,
       };
       accessory.context.GarageDoor = this.GarageDoor as object;
@@ -147,7 +147,7 @@ export class Others extends irdeviceBase {
       // Initialize Door Service
       accessory.context.Door = accessory.context.Door ?? {};
       this.Door = {
-        Name: accessory.context.Door.Name ?? accessory.displayName,
+        Name: accessory.displayName,
         Service: accessory.getService(this.hap.Service.Door) ?? accessory.addService(this.hap.Service.Door) as Service,
       };
       accessory.context.Door = this.Door as object;
@@ -179,7 +179,7 @@ export class Others extends irdeviceBase {
       // Initialize Window Service
       accessory.context.Window = accessory.context.Window ?? {};
       this.Window = {
-        Name: accessory.context.Window.Name ?? accessory.displayName,
+        Name: accessory.displayName,
         Service: accessory.getService(this.hap.Service.Window) ?? accessory.addService(this.hap.Service.Window) as Service,
       };
       accessory.context.Window = this.Window as object;
@@ -211,7 +211,7 @@ export class Others extends irdeviceBase {
       // Initialize WindowCovering Service
       accessory.context.WindowCovering = accessory.context.WindowCovering ?? {};
       this.WindowCovering = {
-        Name: accessory.context.WindowCovering.Name ?? accessory.displayName,
+        Name: accessory.displayName,
         Service: accessory.getService(this.hap.Service.WindowCovering) ?? accessory.addService(this.hap.Service.WindowCovering) as Service,
       };
       accessory.context.WindowCovering = this.WindowCovering as object;
@@ -244,7 +244,7 @@ export class Others extends irdeviceBase {
       // Initialize Lock Service
       accessory.context.LockMechanism = accessory.context.LockMechanism ?? {};
       this.LockMechanism = {
-        Name: accessory.context.LockMechanism.Name ?? accessory.displayName,
+        Name: accessory.displayName,
         Service: accessory.getService(this.hap.Service.LockMechanism) ?? accessory.addService(this.hap.Service.LockMechanism) as Service,
       };
       accessory.context.LockMechanism = this.LockMechanism as object;
@@ -271,7 +271,7 @@ export class Others extends irdeviceBase {
       // Initialize Faucet Service
       accessory.context.Faucet = accessory.context.Faucet ?? {};
       this.Faucet = {
-        Name: accessory.context.Faucet.Name ?? accessory.displayName,
+        Name: accessory.displayName,
         Service: accessory.getService(this.hap.Service.Faucet) ?? accessory.addService(this.hap.Service.Faucet) as Service,
       };
       accessory.context.Faucet = this.Faucet as object;
@@ -297,7 +297,7 @@ export class Others extends irdeviceBase {
       // Initialize Fan Service
       accessory.context.Fan = accessory.context.Fan ?? {};
       this.Fan = {
-        Name: accessory.context.Fan.Name ?? accessory.displayName,
+        Name: accessory.displayName,
         Service: accessory.getService(this.hap.Service.Fanv2) ?? accessory.addService(this.hap.Service.Fanv2) as Service,
       };
       accessory.context.Fan = this.Fan as object;
@@ -323,7 +323,7 @@ export class Others extends irdeviceBase {
       // Initialize StatefulProgrammableSwitch Service
       accessory.context.StatefulProgrammableSwitch = accessory.context.StatefulProgrammableSwitch ?? {};
       this.StatefulProgrammableSwitch = {
-        Name: accessory.context.StatefulProgrammableSwitch.Name ?? accessory.displayName,
+        Name: accessory.displayName,
         Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch)
           ?? accessory.addService(this.hap.Service.StatefulProgrammableSwitch) as Service,
       };
@@ -350,7 +350,7 @@ export class Others extends irdeviceBase {
       // Initialize Switch property
       accessory.context.Outlet = accessory.context.Outlet ?? {};
       this.Outlet = {
-        Name: accessory.context.Outlet.Name ?? accessory.displayName,
+        Name: accessory.displayName,
         Service: accessory.getService(this.hap.Service.Outlet) ?? accessory.addService(this.hap.Service.Outlet) as Service,
       };
       accessory.context.Outlet = this.Outlet as object;
@@ -713,7 +713,7 @@ export class Others extends irdeviceBase {
     // If Outlet.Service still present, then remove first
     accessory.context.Outlet = accessory.context.Outlet ?? {};
     this.Outlet = {
-      Name: accessory.context.Outlet.Name ?? `${accessory.displayName} Outlet`,
+      Name: accessory.displayName,
       Service: accessory.getService(this.hap.Service.Outlet) as Service,
     };
     accessory.context.Outlet = this.Outlet as object;
@@ -725,7 +725,7 @@ export class Others extends irdeviceBase {
     // If GarageDoor.Service still present, then remove first
     accessory.context.GarageDoor = accessory.context.GarageDoor ?? {};
     this.GarageDoor = {
-      Name: accessory.context.GarageDoor.Name ?? `${accessory.displayName} Garage Door`,
+      Name: accessory.displayName,
       Service: accessory.getService(this.hap.Service.GarageDoorOpener) as Service,
     };
     accessory.context.GarageDoor = this.GarageDoor as object;
@@ -737,7 +737,7 @@ export class Others extends irdeviceBase {
     // If Door.Service still present, then remove first
     accessory.context.Door = accessory.context.Door ?? {};
     this.Door = {
-      Name: accessory.context.Door.Name ?? `${accessory.displayName} Door`,
+      Name: accessory.displayName,
       Service: accessory.getService(this.hap.Service.Door) as Service,
     };
     accessory.context.Door = this.Door as object;
@@ -749,7 +749,7 @@ export class Others extends irdeviceBase {
     // If Lock.Service still present, then remove first
     accessory.context.LockMechanism = accessory.context.LockMechanism ?? {};
     this.LockMechanism = {
-      Name: accessory.context.LockMechanism.Name ?? `${accessory.displayName} Lock`,
+      Name: accessory.displayName,
       Service: accessory.getService(this.hap.Service.LockMechanism) as Service,
     };
     accessory.context.LockMechanism = this.LockMechanism as object;
@@ -761,7 +761,7 @@ export class Others extends irdeviceBase {
     // If Faucet.Service still present, then remove first
     accessory.context.Faucet = accessory.context.Faucet ?? {};
     this.Faucet = {
-      Name: accessory.context.Faucet.Name ?? `${accessory.displayName} Faucet`,
+      Name: accessory.displayName,
       Service: accessory.getService(this.hap.Service.Faucet) as Service,
     };
     accessory.context.Faucet = this.Faucet as object;
@@ -773,7 +773,7 @@ export class Others extends irdeviceBase {
     // If Fan Service still present, then remove first
     accessory.context.Fan = accessory.context.Fan ?? {};
     this.Fan = {
-      Name: accessory.context.Fan.Name ?? `${accessory.displayName} Fan`,
+      Name: accessory.displayName,
       Service: accessory.getService(this.hap.Service.Fanv2) as Service,
     };
     accessory.context.Fan = this.Fan as object;
@@ -785,7 +785,7 @@ export class Others extends irdeviceBase {
     // If Window.Service still present, then remove first
     accessory.context.Window = accessory.context.Window ?? {};
     this.Window = {
-      Name: accessory.context.Window.Name ?? `${accessory.displayName} Window`,
+      Name: accessory.displayName,
       Service: accessory.getService(this.hap.Service.Window) as Service,
     };
     accessory.context.Window = this.Window as object;
@@ -797,7 +797,7 @@ export class Others extends irdeviceBase {
     // If WindowCovering.Service still present, then remove first
     accessory.context.WindowCovering = accessory.context.WindowCovering ?? {};
     this.WindowCovering = {
-      Name: accessory.context.WindowCovering.Name ?? `${accessory.displayName} Window Covering`,
+      Name: accessory.displayName,
       Service: accessory.getService(this.hap.Service.WindowCovering) as Service,
     };
     accessory.context.WindowCovering = this.WindowCovering as object;
@@ -809,7 +809,7 @@ export class Others extends irdeviceBase {
     // If StatefulProgrammableSwitch.Service still present, then remove first
     accessory.context.StatefulProgrammableSwitch = accessory.context.StatefulProgrammableSwitch ?? {};
     this.StatefulProgrammableSwitch = {
-      Name: accessory.context.StatefulProgrammableSwitch.Name ?? `${accessory.displayName} Stateful Programmable Switch`,
+      Name: accessory.displayName,
       Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch) as Service,
     };
     accessory.context.StatefulProgrammableSwitch = this.StatefulProgrammableSwitch as object;
@@ -821,7 +821,7 @@ export class Others extends irdeviceBase {
     // If Switch.Service still present, then remove first
     accessory.context.Switch = accessory.context.Switch ?? {};
     this.Switch = {
-      Name: accessory.context.Switch.Name ?? `${accessory.displayName} Switch`,
+      Name: accessory.displayName,
       Service: accessory.getService(this.hap.Service.Switch) as Service,
     };
     accessory.context.Switch = this.Switch as object;
@@ -829,18 +829,10 @@ export class Others extends irdeviceBase {
     accessory.removeService(this.Switch.Service);
   }
 
-  async getOtherConfigSettings(device: irdevice & irDevicesConfig): Promise<void> {
-    if (!device.other?.deviceType && this.accessory.context.deviceType) {
-      this.otherDeviceType = this.accessory.context.deviceType;
-      await this.debugWarnLog(`Using Device Type: ${this.otherDeviceType}, from Accessory Cache.`);
-    } else if (device.other?.deviceType) {
-      this.accessory.context.deviceType = device.other.deviceType;
-      await this.debugWarnLog(`Accessory Cache: ${this.accessory.context.deviceType}`);
-      this.otherDeviceType = this.accessory.context.deviceType;
-      await this.debugWarnLog(`Using Device Type: ${this.otherDeviceType}`);
-    } else {
-      this.otherDeviceType = 'outlet';
-      this.warnLog(`no deviceType set, using default deviceType: ${this.otherDeviceType}`);
-    }
+  async getOtherConfigSettings(accessory: PlatformAccessory, device: irdevice & irDevicesConfig): Promise<void> {
+    this.otherDeviceType = accessory.context.otherDeviceType ? accessory.context.otherDeviceType
+      : device.other?.deviceType ? device.other.deviceType : 'outlet';
+    const deviceType = accessory.context.otherDeviceType ? 'Accessory Cache': device.other?.deviceType ? 'Device Config' : 'Default';
+    await this.debugLog(`Use ${deviceType} Type: ${this.otherDeviceType}`);
   }
 }

package/src/irdevice/tv.ts

@@ -46,8 +46,8 @@ export class TV extends irdeviceBase {
     // Initialize Television Service
     accessory.context.Television = accessory.context.Television ?? {};
     this.Television = {
-      Name: accessory.context.Television.Name ?? `${accessory.displayName} ${device.remoteType}`,
-      ConfiguredName: accessory.context.Television.ConfiguredName ?? `${accessory.displayName} ${device.remoteType}`,
+      Name: accessory.displayName,
+      ConfiguredName: accessory.displayName,
       Service: accessory.getService(this.hap.Service.Television) ?? accessory.addService(this.hap.Service.Television) as Service,
       Active: accessory.context.Active ?? this.hap.Characteristic.Active.INACTIVE,
       ActiveIdentifier: accessory.context.ActiveIdentifier ?? 1,
@@ -105,7 +105,7 @@ export class TV extends irdeviceBase {
     // Initialize TelevisionSpeaker Service
     accessory.context.TelevisionSpeaker = accessory.context.TelevisionSpeaker ?? {};
     this.TelevisionSpeaker = {
-      Name: accessory.context.TelevisionSpeaker.Name ?? `${accessory.displayName} ${device.remoteType} Speaker`,
+      Name: `${accessory.displayName} Speaker`,
       Service: accessory.getService(this.hap.Service.TelevisionSpeaker) ?? accessory.addService(this.hap.Service.TelevisionSpeaker) as Service,
       Active: accessory.context.Active ?? false,
       VolumeControlType: accessory.context.VolumeControlType ?? this.hap.Characteristic.VolumeControlType.ABSOLUTE,

package/src/irdevice/vacuumcleaner.ts

@@ -34,7 +34,7 @@ export class VacuumCleaner extends irdeviceBase {
     // Initialize Switch Service
     accessory.context.Switch = accessory.context.Switch ?? {};
     this.Switch = {
-      Name: accessory.context.Switch.Name ?? `${accessory.displayName} ${device.remoteType}`,
+      Name: accessory.displayName,
       Service: accessory.getService(this.hap.Service.Switch) ?? accessory.addService(this.hap.Service.Switch) as Service,
       On: accessory.context.On ?? false,
     };

package/src/irdevice/waterheater.ts

@@ -34,14 +34,14 @@ export class WaterHeater extends irdeviceBase {
     // Initialize Switch Service
     accessory.context.Valve = accessory.context.Valve ?? {};
     this.Valve = {
-      Name: accessory.context.Valve.Name ?? `${accessory.displayName} ${device.remoteType}`,
+      Name: accessory.displayName,
       Service: accessory.getService(this.hap.Service.Valve) ?? accessory.addService(this.hap.Service.Valve) as Service,
       Active: accessory.context.Active ?? this.hap.Characteristic.Active.INACTIVE,
     };
     accessory.context.Valve = this.Valve as object;
 
     this.Valve.Service
-      .setCharacteristic(this.hap.Characteristic.Name, accessory.displayName)
+      .setCharacteristic(this.hap.Characteristic.Name, this.Valve.Name)
       .setCharacteristic(this.hap.Characteristic.ValveType, this.hap.Characteristic.ValveType.GENERIC_VALVE)
       .getCharacteristic(this.hap.Characteristic.Active)
       .onGet(() => {