@switchbot/homebridge-switchbot 3.7.1-beta.9 → 3.8.0

package/src/irdevice/light.ts

@@ -2,12 +2,13 @@
  *
  * light.ts: @switchbot/homebridge-switchbot.
  */
-import { irdeviceBase } from './irdevice.js';
+import type { CharacteristicValue, PlatformAccessory, Service } from 'homebridge'
 
-import type { SwitchBotPlatform } from '../platform.js';
-import type { irDevicesConfig } from '../settings.js';
-import type { irdevice } from '../types/irdevicelist.js';
-import type { CharacteristicValue, PlatformAccessory, Service } from 'homebridge';
+import type { SwitchBotPlatform } from '../platform.js'
+import type { irDevicesConfig } from '../settings.js'
+import type { irdevice } from '../types/irdevicelist.js'
+
+import { irdeviceBase } from './irdevice.js'
 
 /**
  * Platform Accessory
@@ -17,127 +18,108 @@ import type { CharacteristicValue, PlatformAccessory, Service } from 'homebridge
 export class Light extends irdeviceBase {
   // Services
   private LightBulb?: {
-    Name: CharacteristicValue;
-    Service: Service;
-    On: CharacteristicValue;
-  };
+    Name: CharacteristicValue
+    Service: Service
+    On: CharacteristicValue
+  }
 
   private ProgrammableSwitchOn?: {
-    Name: CharacteristicValue;
-    Service: Service;
-    ProgrammableSwitchEvent: CharacteristicValue;
-    ProgrammableSwitchOutputState: CharacteristicValue;
-  };
+    Name: CharacteristicValue
+    Service: Service
+    ProgrammableSwitchEvent: CharacteristicValue
+    ProgrammableSwitchOutputState: CharacteristicValue
+  }
 
   private ProgrammableSwitchOff?: {
-    Name: CharacteristicValue;
-    Service: Service;
-    ProgrammableSwitchEvent: CharacteristicValue;
-    ProgrammableSwitchOutputState: CharacteristicValue;
-  };
+    Name: CharacteristicValue
+    Service: Service
+    ProgrammableSwitchEvent: CharacteristicValue
+    ProgrammableSwitchOutputState: CharacteristicValue
+  }
 
   constructor(
     readonly platform: SwitchBotPlatform,
     accessory: PlatformAccessory,
     device: irdevice & irDevicesConfig,
   ) {
-    super(platform, accessory, device);
+    super(platform, accessory, device)
     // Set category
-    accessory.category = this.hap.Categories.LIGHTBULB;
+    accessory.category = this.hap.Categories.LIGHTBULB
 
     if (!device.irlight?.stateless) {
       // Initialize LightBulb Service
-      accessory.context.LightBulb = accessory.context.LightBulb ?? {};
+      accessory.context.LightBulb = accessory.context.LightBulb ?? {}
       this.LightBulb = {
         Name: accessory.displayName,
         Service: accessory.getService(this.hap.Service.Lightbulb) ?? accessory.addService(this.hap.Service.Lightbulb) as Service,
         On: accessory.context.On || false,
-      };
-      accessory.context.LightBulb = this.LightBulb as object;
+      }
+      accessory.context.LightBulb = this.LightBulb as object
 
-      this.LightBulb.Service
-        .setCharacteristic(this.hap.Characteristic.Name, this.LightBulb.Name)
-        .getCharacteristic(this.hap.Characteristic.On)
-        .onGet(() => {
-          return this.LightBulb!.On;
-        })
-        .onSet(this.OnSet.bind(this));
+      this.LightBulb.Service.setCharacteristic(this.hap.Characteristic.Name, this.LightBulb.Name).getCharacteristic(this.hap.Characteristic.On).onGet(() => {
+        return this.LightBulb!.On
+      }).onSet(this.OnSet.bind(this))
     } else {
       // Initialize ProgrammableSwitchOn Service
-      accessory.context.ProgrammableSwitchOn = accessory.context.ProgrammableSwitchOn ?? {};
+      accessory.context.ProgrammableSwitchOn = accessory.context.ProgrammableSwitchOn ?? {}
       this.ProgrammableSwitchOn = {
         Name: `${accessory.displayName} On`,
-        Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch)
-        ?? accessory.addService(this.hap.Service.StatefulProgrammableSwitch) as Service,
+        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,
         ProgrammableSwitchOutputState: accessory.context.ProgrammableSwitchOutputState ?? 0,
-      };
-      accessory.context.ProgrammableSwitchOn = this.ProgrammableSwitchOn as object;
+      }
+      accessory.context.ProgrammableSwitchOn = this.ProgrammableSwitchOn as object
 
       // Initialize ProgrammableSwitchOn Characteristics
-      this.ProgrammableSwitchOn?.Service
-        .setCharacteristic(this.hap.Characteristic.Name, this.ProgrammableSwitchOn.Name)
-        .getCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent).setProps({
-          validValueRanges: [0, 0],
-          minValue: 0,
-          maxValue: 0,
-          validValues: [0],
-        })
-        .onGet(() => {
-          return this.ProgrammableSwitchOn!.ProgrammableSwitchEvent;
-        });
-
-      this.ProgrammableSwitchOn?.Service
-        .getCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState)
-        .onGet(() => {
-          return this.ProgrammableSwitchOn!.ProgrammableSwitchOutputState;
-        })
-        .onSet(this.ProgrammableSwitchOutputStateSetOn.bind(this));
+      this.ProgrammableSwitchOn?.Service.setCharacteristic(this.hap.Characteristic.Name, this.ProgrammableSwitchOn.Name).getCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent).setProps({
+        validValueRanges: [0, 0],
+        minValue: 0,
+        maxValue: 0,
+        validValues: [0],
+      }).onGet(() => {
+        return this.ProgrammableSwitchOn!.ProgrammableSwitchEvent
+      })
+
+      this.ProgrammableSwitchOn?.Service.getCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState).onGet(() => {
+        return this.ProgrammableSwitchOn!.ProgrammableSwitchOutputState
+      }).onSet(this.ProgrammableSwitchOutputStateSetOn.bind(this))
 
       // Initialize ProgrammableSwitchOff Service
-      accessory.context.ProgrammableSwitchOff = accessory.context.ProgrammableSwitchOff ?? {};
+      accessory.context.ProgrammableSwitchOff = accessory.context.ProgrammableSwitchOff ?? {}
       this.ProgrammableSwitchOff = {
         Name: `${accessory.displayName} Off`,
-        Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch)
-        ?? accessory.addService(this.hap.Service.StatefulProgrammableSwitch) as Service,
+        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,
         ProgrammableSwitchOutputState: accessory.context.ProgrammableSwitchOutputState ?? 0,
-      };
-      accessory.context.ProgrammableSwitchOff = this.ProgrammableSwitchOff as object;
+      }
+      accessory.context.ProgrammableSwitchOff = this.ProgrammableSwitchOff as object
 
       // Initialize ProgrammableSwitchOff Characteristics
-      this.ProgrammableSwitchOff?.Service
-        .setCharacteristic(this.hap.Characteristic.Name, this.ProgrammableSwitchOff.Name)
-        .getCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent).setProps({
-          validValueRanges: [0, 0],
-          minValue: 0,
-          maxValue: 0,
-          validValues: [0],
-        })
-        .onGet(() => {
-          return this.ProgrammableSwitchOff!.ProgrammableSwitchEvent;
-        });
-
-      this.ProgrammableSwitchOff?.Service
-        .getCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState)
-        .onGet(() => {
-          return this.ProgrammableSwitchOff!.ProgrammableSwitchOutputState;
-        })
-        .onSet(this.ProgrammableSwitchOutputStateSetOff.bind(this));
+      this.ProgrammableSwitchOff?.Service.setCharacteristic(this.hap.Characteristic.Name, this.ProgrammableSwitchOff.Name).getCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent).setProps({
+        validValueRanges: [0, 0],
+        minValue: 0,
+        maxValue: 0,
+        validValues: [0],
+      }).onGet(() => {
+        return this.ProgrammableSwitchOff!.ProgrammableSwitchEvent
+      })
+
+      this.ProgrammableSwitchOff?.Service.getCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState).onGet(() => {
+        return this.ProgrammableSwitchOff!.ProgrammableSwitchOutputState
+      }).onSet(this.ProgrammableSwitchOutputStateSetOff.bind(this))
     }
-
   }
 
   async OnSet(value: CharacteristicValue): Promise<void> {
-    await this.debugLog(`On: ${value}`);
+    await this.debugLog(`On: ${value}`)
 
-    this.LightBulb!.On = value;
+    this.LightBulb!.On = value
     if (this.LightBulb?.On) {
-      const On = true;
-      await this.pushLightOnChanges(On);
+      const On = true
+      await this.pushLightOnChanges(On)
     } else {
-      const On = false;
-      await this.pushLightOffChanges(On);
+      const On = false
+      await this.pushLightOffChanges(On)
     }
     /**
      * pushLightOnChanges and pushLightOffChanges above assume they are measuring the state of the accessory BEFORE
@@ -146,12 +128,12 @@ export class Light extends irdeviceBase {
   }
 
   async ProgrammableSwitchOutputStateSetOn(value: CharacteristicValue): Promise<void> {
-    await this.debugLog(`On: ${value}`);
+    await this.debugLog(`On: ${value}`)
 
-    this.ProgrammableSwitchOn!.ProgrammableSwitchOutputState = value;
+    this.ProgrammableSwitchOn!.ProgrammableSwitchOutputState = value
     if (this.ProgrammableSwitchOn?.ProgrammableSwitchOutputState === 1) {
-      const On = true;
-      await this.pushLightOnChanges(On);
+      const On = true
+      await this.pushLightOnChanges(On)
     }
     /**
      * pushLightOnChanges and pushLightOffChanges above assume they are measuring the state of the accessory BEFORE
@@ -160,12 +142,12 @@ export class Light extends irdeviceBase {
   }
 
   async ProgrammableSwitchOutputStateSetOff(value: CharacteristicValue): Promise<void> {
-    await this.debugLog(`On: ${value}`);
+    await this.debugLog(`On: ${value}`)
 
-    this.ProgrammableSwitchOff!.ProgrammableSwitchOutputState = value;
+    this.ProgrammableSwitchOff!.ProgrammableSwitchOutputState = value
     if (this.ProgrammableSwitchOff?.ProgrammableSwitchOutputState === 1) {
-      const On = false;
-      await this.pushLightOffChanges(On);
+      const On = false
+      await this.pushLightOffChanges(On)
     }
     /**
      * pushLightOnChanges and pushLightOffChanges above assume they are measuring the state of the accessory BEFORE
@@ -173,100 +155,94 @@ export class Light extends irdeviceBase {
      */
   }
 
-
-
   /**
    * Pushes the requested changes to the SwitchBot API
-   * deviceType	commandType     Command	          command parameter	         Description
-   * Light -        "command"       "turnOff"         "default"	        =        set to OFF state
-   * Light -       "command"       "turnOn"          "default"	        =        set to ON state
-   * Light -       "command"       "volumeAdd"       "default"	        =        volume up
-   * Light -       "command"       "volumeSub"       "default"	        =        volume down
-   * Light -       "command"       "channelAdd"      "default"	        =        next channel
-   * Light -       "command"       "channelSub"      "default"	        =        previous channel
+   * deviceType    commandType     Command          command parameter           Description
+   * Light -       "command"       "turnOff"         "default"          =        set to OFF state
+   * Light -       "command"       "turnOn"          "default"          =        set to ON state
+   * Light -       "command"       "volumeAdd"       "default"          =        volume up
+   * Light -       "command"       "volumeSub"       "default"          =        volume down
+   * Light -       "command"       "channelAdd"      "default"          =        next channel
+   * Light -       "command"       "channelSub"      "default"          =        previous channel
    */
   async pushLightOnChanges(On: boolean): Promise<void> {
-    await this.debugLog(`pushLightOnChanges On: ${On}, disablePushOn: ${this.disablePushOn}`);
+    await this.debugLog(`pushLightOnChanges On: ${On}, disablePushOn: ${this.disablePushOn}`)
     if (On === true && this.disablePushOn === false) {
-      const commandType: string = await this.commandType();
-      const command: string = await this.commandOn();
+      const commandType: string = await this.commandType()
+      const command: string = await this.commandOn()
       const bodyChange = JSON.stringify({
-        command: command,
+        command,
         parameter: 'default',
-        commandType: commandType,
-      });
-      await this.pushChanges(bodyChange, On);
+        commandType,
+      })
+      await this.pushChanges(bodyChange, On)
     }
   }
 
   async pushLightOffChanges(On: boolean): Promise<void> {
-    await this.debugLog(`pushLightOffChanges On: ${On}, disablePushOff: ${this.disablePushOff}`);
+    await this.debugLog(`pushLightOffChanges On: ${On}, disablePushOff: ${this.disablePushOff}`)
     if (On === false && this.disablePushOff === false) {
-      const commandType: string = await this.commandType();
-      const command: string = await this.commandOff();
+      const commandType: string = await this.commandType()
+      const command: string = await this.commandOff()
       const bodyChange = JSON.stringify({
-        command: command,
+        command,
         parameter: 'default',
-        commandType: commandType,
-      });
-      await this.pushChanges(bodyChange, On);
+        commandType,
+      })
+      await this.pushChanges(bodyChange, On)
     }
   }
 
   async pushChanges(bodyChange: any, On: boolean): Promise<void> {
-    this.debugLog('pushChanges');
+    this.debugLog('pushChanges')
     if (this.device.connectionType === 'OpenAPI') {
-      this.infoLog(`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);
+        const { body, statusCode } = await this.pushChangeRequest(bodyChange)
+        const deviceStatus: any = await body.json()
+        await this.pushStatusCodes(statusCode, deviceStatus)
         if (await this.successfulStatusCodes(statusCode, deviceStatus)) {
-          await this.successfulPushChange(statusCode, deviceStatus, bodyChange);
-          this.accessory.context.On = On;
-          await this.updateHomeKitCharacteristics();
+          await this.successfulPushChange(statusCode, deviceStatus, bodyChange)
+          this.accessory.context.On = On
+          await this.updateHomeKitCharacteristics()
         } else {
-          await this.statusCode(statusCode);
-          await this.statusCode(deviceStatus.statusCode);
+          await this.statusCode(statusCode)
+          await this.statusCode(deviceStatus.statusCode)
         }
       } catch (e: any) {
-        await this.apiError(e);
-        await this.pushChangeError(e);
+        await this.apiError(e)
+        await this.pushChangeError(e)
       }
     } else {
-      this.warnLog('Connection Type: '
-      + `${this.device.connectionType}, commands will not be sent to OpenAPI`);
+      this.warnLog(`Connection Type: ${this.device.connectionType}, commands will not be sent to OpenAPI`)
     }
   }
 
   async updateHomeKitCharacteristics(): Promise<void> {
-    await this.debugLog('updateHomeKitCharacteristics');
+    await this.debugLog('updateHomeKitCharacteristics')
     if (!this.device.irlight?.stateless && this.LightBulb?.Service) {
       // On
-      await this.updateCharacteristic(this.LightBulb.Service, this.hap.Characteristic.On,
-        this.LightBulb.On, 'On');
+      await this.updateCharacteristic(this.LightBulb.Service, this.hap.Characteristic.On, this.LightBulb.On, 'On')
     } else {
       if (this.ProgrammableSwitchOn?.Service) {
-      // On Stateful Programmable Switch
-        await this.updateCharacteristic(this.ProgrammableSwitchOn.Service, this.hap.Characteristic.ProgrammableSwitchOutputState,
-          this.ProgrammableSwitchOn.ProgrammableSwitchOutputState, 'ProgrammableSwitchOutputState');
+        // On Stateful Programmable Switch
+        await this.updateCharacteristic(this.ProgrammableSwitchOn.Service, this.hap.Characteristic.ProgrammableSwitchOutputState, this.ProgrammableSwitchOn.ProgrammableSwitchOutputState, 'ProgrammableSwitchOutputState')
       }
       if (this.ProgrammableSwitchOff?.Service) {
-      // Off Stateful Programmable Switch
-        await this.updateCharacteristic(this.ProgrammableSwitchOff.Service, this.hap.Characteristic.ProgrammableSwitchOutputState,
-          this.ProgrammableSwitchOff.ProgrammableSwitchOutputState, 'ProgrammableSwitchOutputState');
+        // Off Stateful Programmable Switch
+        await this.updateCharacteristic(this.ProgrammableSwitchOff.Service, this.hap.Characteristic.ProgrammableSwitchOutputState, this.ProgrammableSwitchOff.ProgrammableSwitchOutputState, 'ProgrammableSwitchOutputState')
       }
     }
   }
 
   async apiError(e: any): Promise<void> {
     if (!this.device.irlight?.stateless) {
-      this.LightBulb?.Service.updateCharacteristic(this.hap.Characteristic.On, e);
+      this.LightBulb?.Service.updateCharacteristic(this.hap.Characteristic.On, e)
     } else {
-      this.ProgrammableSwitchOn?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent, e);
-      this.ProgrammableSwitchOn?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState, e);
-      this.ProgrammableSwitchOff?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent, e);
-      this.ProgrammableSwitchOff?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState, e);
+      this.ProgrammableSwitchOn?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent, e)
+      this.ProgrammableSwitchOn?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState, e)
+      this.ProgrammableSwitchOff?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent, e)
+      this.ProgrammableSwitchOff?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState, e)
     }
   }
 }