@switchbot/homebridge-switchbot 2.0.0 → 2.1.0-beta.0

package/src/irdevice/airpurifier.ts

@@ -127,21 +127,25 @@ export class AirPurifier {
    */
   async pushAirPurifierOnChanges(): Promise<void> {
     if (this.Active !== 1) {
+      const commandType: string = await this.commandType();
+      const command: string = await this.commandOn();
       const body = superStringify({
-        'command': 'turnOn',
+        'command': command,
         'parameter': 'default',
-        'commandType': 'command',
+        'commandType': commandType,
       });
       await this.pushChanges(body);
     }
   }
 
   async pushAirPurifierOffChanges(): Promise<void> {
+    const commandType: string = await this.commandType();
+    const command: string = await this.commandOff();
     if (this.Active !== 0) {
       const body = superStringify({
-        'command': 'turnOff',
+        'command': command,
         'parameter': 'default',
-        'commandType': 'command',
+        'commandType': commandType,
       });
       await this.pushChanges(body);
     }
@@ -263,6 +267,36 @@ export class AirPurifier {
     }
   }
 
+  async commandType() {
+    let commandType: string;
+    if (this.device.customize) {
+      commandType = 'customize';
+    } else {
+      commandType = 'command';
+    }
+    return commandType;
+  }
+
+  async commandOn() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOn';
+    }
+    return command;
+  }
+
+  async commandOff() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOff';
+    }
+    return command;
+  }
+
   async statusCode({ res }: { res: IncomingMessage }): Promise<void> {
     switch (res.statusCode) {
       case 151:

package/src/irdevice/camera.ts

@@ -77,21 +77,25 @@ export class Camera {
    */
   async pushOnChanges(): Promise<void> {
     if (this.On) {
+      const commandType: string = await this.commandType();
+      const command: string = await this.commandOn();
       const body = superStringify({
-        'command': 'turnOn',
+        'command': command,
         'parameter': 'default',
-        'commandType': 'command',
+        'commandType': commandType,
       });
       await this.pushChanges(body);
     }
   }
 
   async pushOffChanges(): Promise<void> {
+    const commandType: string = await this.commandType();
+    const command: string = await this.commandOff();
     if (!this.On) {
       const body = superStringify({
-        'command': 'turnOff',
+        'command': command,
         'parameter': 'default',
-        'commandType': 'command',
+        'commandType': commandType,
       });
       await this.pushChanges(body);
     }
@@ -160,6 +164,36 @@ export class Camera {
     }
   }
 
+  async commandType() {
+    let commandType: string;
+    if (this.device.customize) {
+      commandType = 'customize';
+    } else {
+      commandType = 'command';
+    }
+    return commandType;
+  }
+
+  async commandOn() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOn';
+    }
+    return command;
+  }
+
+  async commandOff() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOff';
+    }
+    return command;
+  }
+
   async statusCode({ res }: { res: IncomingMessage }): Promise<void> {
     switch (res.statusCode) {
       case 151:

package/src/irdevice/fan.ts

@@ -167,20 +167,24 @@ export class Fan {
    */
   async pushFanOnChanges(): Promise<void> {
     if (this.Active !== 1) {
+      const commandType: string = await this.commandType();
+      const command: string = await this.commandOn();
       const body = superStringify({
-        'command': 'turnOn',
+        'command': command,
         'parameter': 'default',
-        'commandType': 'command',
+        'commandType': commandType,
       });
       await this.pushTVChanges(body);
     }
   }
 
   async pushFanOffChanges(): Promise<void> {
+    const commandType: string = await this.commandType();
+    const command: string = await this.commandOff();
     const body = superStringify({
-      'command': 'turnOff',
+      'command': command,
       'parameter': 'default',
-      'commandType': 'command',
+      'commandType': commandType,
     });
     await this.pushTVChanges(body);
   }
@@ -289,6 +293,36 @@ export class Fan {
     }
   }
 
+  async commandType() {
+    let commandType: string;
+    if (this.device.customize) {
+      commandType = 'customize';
+    } else {
+      commandType = 'command';
+    }
+    return commandType;
+  }
+
+  async commandOn() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOn';
+    }
+    return command;
+  }
+
+  async commandOff() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOff';
+    }
+    return command;
+  }
+
   async statusCode({ res }: { res: IncomingMessage }): Promise<void> {
     switch (res.statusCode) {
       case 151:

package/src/irdevice/light.ts

@@ -77,10 +77,12 @@ export class Light {
    */
   async pushLightOnChanges(): Promise<void> {
     if (this.On) {
+      const commandType: string = await this.commandType();
+      const command: string = await this.commandOn();
       const body = superStringify({
-        'command': 'turnOn',
+        'command': command,
         'parameter': 'default',
-        'commandType': 'command',
+        'commandType': commandType,
       });
       await this.pushChanges(body);
     }
@@ -88,10 +90,12 @@ export class Light {
 
   async pushLightOffChanges(): Promise<void> {
     if (!this.On) {
+      const commandType: string = await this.commandType();
+      const command: string = await this.commandOff();
       const body = superStringify({
-        'command': 'turnOff',
+        'command': command,
         'parameter': 'default',
-        'commandType': 'command',
+        'commandType': commandType,
       });
       await this.pushChanges(body);
     }
@@ -179,6 +183,36 @@ export class Light {
     }
   }
 
+  async commandType() {
+    let commandType: string;
+    if (this.device.customize) {
+      commandType = 'customize';
+    } else {
+      commandType = 'command';
+    }
+    return commandType;
+  }
+
+  async commandOn() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOn';
+    }
+    return command;
+  }
+
+  async commandOff() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOff';
+    }
+    return command;
+  }
+
   async statusCode({ res }: { res: IncomingMessage }): Promise<void> {
     switch (res.statusCode) {
       case 151:

package/src/irdevice/other.ts

@@ -84,22 +84,16 @@ export class Others {
    * Other -       "command"       "channelSub"      "default"	        =        previous channel
    */
   async pushOnChanges(): Promise<void> {
-    if (this.platform.config.options) {
-      if (this.device.other) {
-        if (this.device.other.commandOn) {
-          if (!this.Active) {
-            const body = superStringify({
-              'command': `${this.device.other.commandOn}`,
-              'parameter': 'default',
-              'commandType': 'customize',
-            });
-            await this.pushChanges(body);
-          }
-        } else {
-          this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} On Command not set, commandOn: ${this.device.other.commandOn}`);
-        }
-      } else {
-        this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} On Command not set, other: ${this.device.other}`);
+    if (this.device.customize) {
+      if (!this.Active) {
+        const commandType: string = await this.commandType();
+        const command: string = await this.commandOn();
+        const body = superStringify({
+          'command': command,
+          'parameter': 'default',
+          'commandType': commandType,
+        });
+        await this.pushChanges(body);
       }
     } else {
       this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} On Command not set`);
@@ -107,22 +101,16 @@ export class Others {
   }
 
   async pushOffChanges(): Promise<void> {
-    if (this.platform.config.options) {
-      if (this.device.other) {
-        if (this.device.other.commandOff) {
-          if (this.Active) {
-            const body = superStringify({
-              'command': `${this.device.other.commandOff}`,
-              'parameter': 'default',
-              'commandType': 'customize',
-            });
-            await this.pushChanges(body);
-          }
-        } else {
-          this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Off Command not set, commandOff: ${this.device.other.commandOff}`);
-        }
-      } else {
-        this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Off Command not set, other: ${this.device.other}`);
+    if (this.device.customize) {
+      if (this.Active) {
+        const commandType: string = await this.commandType();
+        const command: string = await this.commandOff();
+        const body = superStringify({
+          'command': command,
+          'parameter': 'default',
+          'commandType': commandType,
+        });
+        await this.pushChanges(body);
       }
     } else {
       this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Off Command not set.`);
@@ -191,6 +179,36 @@ export class Others {
     }
   }
 
+  async commandType() {
+    let commandType: string;
+    if (this.device.customize) {
+      commandType = 'customize';
+    } else {
+      commandType = 'command';
+    }
+    return commandType;
+  }
+
+  async commandOn() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOn';
+    }
+    return command;
+  }
+
+  async commandOff() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOff';
+    }
+    return command;
+  }
+
   async statusCode({ res }: { res: IncomingMessage }): Promise<void> {
     switch (res.statusCode) {
       case 151:

package/src/irdevice/tv.ts

@@ -221,20 +221,24 @@ export class TV {
    */
   async pushTvOnChanges(): Promise<void> {
     if (this.Active !== 1) {
+      const commandType: string = await this.commandType();
+      const command: string = await this.commandOn();
       const body = superStringify({
-        'command': 'turnOn',
+        'command': command,
         'parameter': 'default',
-        'commandType': 'command',
+        'commandType': commandType,
       });
       await this.pushTVChanges(body);
     }
   }
 
   async pushTvOffChanges(): Promise<void> {
+    const commandType: string = await this.commandType();
+    const command: string = await this.commandOff();
     const body = superStringify({
-      'command': 'turnOff',
+      'command': command,
       'parameter': 'default',
-      'commandType': 'command',
+      'commandType': commandType,
     });
     await this.pushTVChanges(body);
   }
@@ -392,6 +396,36 @@ export class TV {
     }
   }
 
+  async commandType() {
+    let commandType: string;
+    if (this.device.customize) {
+      commandType = 'customize';
+    } else {
+      commandType = 'command';
+    }
+    return commandType;
+  }
+
+  async commandOn() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOn';
+    }
+    return command;
+  }
+
+  async commandOff() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOff';
+    }
+    return command;
+  }
+
   async statusCode({ res }: { res: IncomingMessage }): Promise<void> {
     switch (res.statusCode) {
       case 151:

package/src/irdevice/vacuumcleaner.ts

@@ -73,10 +73,12 @@ export class VacuumCleaner {
    */
   async pushOnChanges(): Promise<void> {
     if (this.On) {
+      const commandType: string = await this.commandType();
+      const command: string = await this.commandOn();
       const body = superStringify({
-        'command': 'turnOn',
+        'command': command,
         'parameter': 'default',
-        'commandType': 'command',
+        'commandType': commandType,
       });
       await this.pushChanges(body);
     }
@@ -84,10 +86,12 @@ export class VacuumCleaner {
 
   async pushOffChanges(): Promise<void> {
     if (!this.On) {
+      const commandType: string = await this.commandType();
+      const command: string = await this.commandOff();
       const body = superStringify({
-        'command': 'turnOff',
+        'command': command,
         'parameter': 'default',
-        'commandType': 'command',
+        'commandType': commandType,
       });
       await this.pushChanges(body);
     }
@@ -157,6 +161,36 @@ export class VacuumCleaner {
     }
   }
 
+  async commandType() {
+    let commandType: string;
+    if (this.device.customize) {
+      commandType = 'customize';
+    } else {
+      commandType = 'command';
+    }
+    return commandType;
+  }
+
+  async commandOn() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOn';
+    }
+    return command;
+  }
+
+  async commandOff() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOff';
+    }
+    return command;
+  }
+
   async statusCode({ res }: { res: IncomingMessage }): Promise<void> {
     switch (res.statusCode) {
       case 151:

package/src/irdevice/waterheater.ts

@@ -78,10 +78,12 @@ export class WaterHeater {
    */
   async pushWaterHeaterOnChanges(): Promise<void> {
     if (this.Active !== 1) {
+      const commandType: string = await this.commandType();
+      const command: string = await this.commandOn();
       const body = superStringify({
-        'command': 'turnOn',
+        'command': command,
         'parameter': 'default',
-        'commandType': 'command',
+        'commandType': commandType,
       });
       await this.pushChanges(body);
     }
@@ -89,10 +91,12 @@ export class WaterHeater {
 
   async pushWaterHeaterOffChanges(): Promise<void> {
     if (this.Active !== 0) {
+      const commandType: string = await this.commandType();
+      const command: string = await this.commandOff();
       const body = superStringify({
-        'command': 'turnOff',
+        'command': command,
         'parameter': 'default',
-        'commandType': 'command',
+        'commandType': commandType,
       });
       await this.pushChanges(body);
     }
@@ -160,6 +164,36 @@ export class WaterHeater {
     }
   }
 
+  async commandType() {
+    let commandType: string;
+    if (this.device.customize) {
+      commandType = 'customize';
+    } else {
+      commandType = 'command';
+    }
+    return commandType;
+  }
+
+  async commandOn() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOn';
+    }
+    return command;
+  }
+
+  async commandOff() {
+    let command: string;
+    if (this.device.customize && this.device.customOn) {
+      command = this.device.customOn;
+    } else {
+      command = 'turnOff';
+    }
+    return command;
+  }
+
   async statusCode({ res }: { res: IncomingMessage }): Promise<void> {
     switch (res.statusCode) {
       case 151:

package/src/platform.ts

@@ -58,7 +58,8 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
 
     // HOOBS notice
     if (__dirname.includes('hoobs')) {
-      this.log.warn('This plugin has not been tested under HOOBS, it is highly recommended that you switch to Homebridge: https://git.io/Jtxb0');
+      this.warnLog('This plugin has not been tested under HOOBS, it is highly recommended that you switch to Homebridge: '
+      + 'https://tinyurl.com/HOOBS2Homebridge');
     }
 
     // verify the config
@@ -66,7 +67,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       this.verifyConfig();
       this.debugLog('Config OK');
     } catch (e: any) {
-      this.errorLog(`Verify Config, Error Message: ${e.message}`);
+      this.errorLog(`Verify Config, Error Message: ${e.message}, Submit Bugs Here: ` + 'https://tinyurl.com/SwitchBotBug');
       this.debugErrorLog(`Verify Config, Error: ${e}`);
       return;
     }
@@ -91,7 +92,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
           this.discoverDevices();
         }
       } catch (e: any) {
-        this.errorLog(`Failed to Discover, Error Message: ${e.message}`);
+        this.errorLog(`Failed to Discover, Error Message: ${e.message}, Submit Bugs Here: ` + 'https://tinyurl.com/SwitchBotBug');
         this.debugErrorLog(`Failed to Discover, Error: ${e}`);
       }
     });
@@ -340,7 +341,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
                   this.errorLog('SwitchBot Token Supplied, Issue with Auth.');
                 }
               } else {
-                this.errorLog(`SwitchBot Device Request Issue: ${this.deviceStatus}`);
+                this.errorLog(`SwitchBot Device Request Issue: ${this.deviceStatus}, Submit Bugs Here: ` + 'https://tinyurl.com/SwitchBotBug');
               }
               // IR Devices
               /*if (devicesAPI.body.infraredRemoteList.length !== 0) {
@@ -388,15 +389,15 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
                   }
                 }
               } else {
-                this.errorLog(`SwitchBot IR Device Request Issue: ${this.deviceStatus}`);
+                this.errorLog(`SwitchBot IR Device Request Issue: ${this.deviceStatus}, Submit Bugs Here: ` + 'https://tinyurl.com/SwitchBotBug');
               }
             } catch (e:any) {
-              this.errorLog(`API Request: ${e}`);
+              this.errorLog(`API Request: ${e}, Submit Bugs Here: ` + 'https://tinyurl.com/SwitchBotBug');
             }
           });
         });
         req.on('error', (e: any) => {
-          this.errorLog(`req: ${e}`);
+          this.errorLog(`req: ${e}, Submit Bugs Here: ` + 'https://tinyurl.com/SwitchBotBug');
         });
         req.end();
       } else if (!this.config.credentials?.token && this.config.options?.devices) {
@@ -414,7 +415,8 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         this.errorLog('Neither SwitchBot Token or Device Config are not set.');
       }
     } catch (e: any) {
-      this.debugErrorLog(`Failed to Discover Devices, Error Message: ${superStringify(e.message)}`);
+      this.debugErrorLog(`Failed to Discover Devices, Error Message: ${superStringify(e.message)}, Submit Bugs Here: `
+      + 'https://tinyurl.com/SwitchBotBug');
       this.debugErrorLog(`Failed to Discover Devices, Error: ${e}`);
     }
   }
@@ -486,7 +488,8 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         break;
       default:
         this.warnLog(`Device: ${device.deviceName} with Device Type: ${device.deviceType}, is currently not supported.`);
-        this.warnLog('Submit Feature Requests Here: https://git.io/JL14Z');
+        // eslint-disable-next-line max-len
+        this.warnLog('Submit Feature Requests Here: ' + 'https://tinyurl.com/SwitchBotFeatureRequest');
     }
   }
 
@@ -549,7 +552,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       default:
         this.debugLog(`Unsupported Device: ${superStringify(device)}`);
         this.warnLog(`Device: ${device.deviceName} with Device Type: ${device.remoteType}, is currently not supported.`);
-        this.warnLog('Submit Feature Requests Here: https://git.io/JL14Z');
+        this.warnLog('Submit Feature Requests Here: ' + 'https://tinyurl.com/SwitchBotFeatureRequest');
     }
   }
 
@@ -1852,13 +1855,13 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
   async statusCode({ res }: { res: IncomingMessage }): Promise<void> {
     switch (res.statusCode) {
       case 151:
-        this.errorLog('Command not supported by this device type.');
+        this.errorLog('Command not supported by this device type, Submit Feature Request Here: ' + 'https://tinyurl.com/SwitchBotFeatureRequest');
         break;
       case 152:
         this.errorLog('Device not found.');
         break;
       case 160:
-        this.errorLog('Command is not supported.');
+        this.errorLog('Command is not supported, Submit Bugs Here: ' + 'https://tinyurl.com/SwitchBotBug');
         break;
       case 161:
         this.errorLog('Device is offline.');
@@ -1876,7 +1879,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         break;
       default:
         if (this.debugMode) {
-          this.debugLog('Unknown statusCode.');
+          this.debugLog('Unknown statusCode, Submit Bugs Here: ' + 'https://tinyurl.com/SwitchBotBug');
         }
     }
   }