@switchbot/homebridge-switchbot 2.0.0-beta.12 → 2.0.0-beta.14

package/src/irdevice/other.ts

@@ -1,6 +1,7 @@
 import https from 'https';
 import crypto from 'crypto';
 import { IncomingMessage } from 'http';
+import superStringify from 'super-stringify';
 import { SwitchBotPlatform } from '../platform';
 import { irDevicesConfig, irdevice, HostDomain, DevicePath } from '../settings';
 import { CharacteristicValue, PlatformAccessory, Service } from 'homebridge';
@@ -99,7 +100,7 @@ export class Others {
       if (this.device.other) {
         if (this.device.other.commandOn) {
           if (!this.Active) {
-            const body = JSON.stringify({
+            const body = superStringify({
               'command': `${this.device.other.commandOn}`,
               'parameter': 'default',
               'commandType': 'customize',
@@ -122,7 +123,7 @@ export class Others {
       if (this.device.other) {
         if (this.device.other.commandOff) {
           if (this.Active) {
-            const body = JSON.stringify({
+            const body = superStringify({
               'command': `${this.device.other.commandOff}`,
               'parameter': 'default',
               'commandType': 'customize',
@@ -178,13 +179,13 @@ export class Others {
       });
       req.write(body);
       req.end();
-      this.debugLog(`Other: ${this.accessory.displayName} pushchanges: ${JSON.stringify(req)}`);
+      this.debugLog(`Other: ${this.accessory.displayName} pushchanges: ${superStringify(req)}`);
       this.updateHomeKitCharacteristics();
     } catch (e: any) {
       this.errorLog(`Other: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection`);
       if (this.deviceLogging.includes('debug')) {
         this.errorLog(
-          `Other: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,` + ` Error Message: ${JSON.stringify(e.message)}`,
+          `Other: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,` + ` Error Message: ${superStringify(e.message)}`,
         );
       }
       this.apiError(e);
@@ -211,7 +212,7 @@ export class Others {
       case 190:
         this.errorLog(
           `Other: ${this.accessory.displayName} Device internal error due to device states not synchronized` +
-            ` with server, Or command: ${JSON.stringify(res)} format is invalid`,
+            ` with server, Or command: ${superStringify(res)} format is invalid`,
         );
         break;
       case 100:
@@ -247,7 +248,7 @@ export class Others {
       config['logging'] = device.logging;
     }
     if (Object.entries(config).length !== 0) {
-      this.infoLog(`Other: ${this.accessory.displayName} Config: ${JSON.stringify(config)}`);
+      this.infoLog(`Other: ${this.accessory.displayName} Config: ${superStringify(config)}`);
     }
   }
 

package/src/irdevice/tv.ts

@@ -1,6 +1,7 @@
 import https from 'https';
 import crypto from 'crypto';
 import { IncomingMessage } from 'http';
+import superStringify from 'super-stringify';
 import { SwitchBotPlatform } from '../platform';
 import { CharacteristicValue, PlatformAccessory, Service } from 'homebridge';
 import { irdevice, irDevicesConfig, HostDomain, DevicePath } from '../settings';
@@ -237,7 +238,7 @@ export class TV {
    */
   async pushTvOnChanges(): Promise<void> {
     if (this.Active !== 1) {
-      const body = JSON.stringify({
+      const body = superStringify({
         'command': 'turnOn',
         'parameter': 'default',
         'commandType': 'command',
@@ -247,7 +248,7 @@ export class TV {
   }
 
   async pushTvOffChanges(): Promise<void> {
-    const body = JSON.stringify({
+    const body = superStringify({
       'command': 'turnOff',
       'parameter': 'default',
       'commandType': 'command',
@@ -256,7 +257,7 @@ export class TV {
   }
 
   async pushOkChanges(): Promise<void> {
-    const body = JSON.stringify({
+    const body = superStringify({
       'command': 'Ok',
       'parameter': 'default',
       'commandType': 'command',
@@ -265,7 +266,7 @@ export class TV {
   }
 
   async pushBackChanges(): Promise<void> {
-    const body = JSON.stringify({
+    const body = superStringify({
       'command': 'Back',
       'parameter': 'default',
       'commandType': 'command',
@@ -274,7 +275,7 @@ export class TV {
   }
 
   async pushMenuChanges(): Promise<void> {
-    const body = JSON.stringify({
+    const body = superStringify({
       'command': 'Menu',
       'parameter': 'default',
       'commandType': 'command',
@@ -283,7 +284,7 @@ export class TV {
   }
 
   async pushUpChanges(): Promise<void> {
-    const body = JSON.stringify({
+    const body = superStringify({
       'command': 'Up',
       'parameter': 'default',
       'commandType': 'command',
@@ -292,7 +293,7 @@ export class TV {
   }
 
   async pushDownChanges(): Promise<void> {
-    const body = JSON.stringify({
+    const body = superStringify({
       'command': 'Down',
       'parameter': 'default',
       'commandType': 'command',
@@ -301,7 +302,7 @@ export class TV {
   }
 
   async pushRightChanges(): Promise<void> {
-    const body = JSON.stringify({
+    const body = superStringify({
       'command': 'Right',
       'parameter': 'default',
       'commandType': 'command',
@@ -310,7 +311,7 @@ export class TV {
   }
 
   async pushLeftChanges(): Promise<void> {
-    const body = JSON.stringify({
+    const body = superStringify({
       'command': 'Left',
       'parameter': 'default',
       'commandType': 'command',
@@ -319,7 +320,7 @@ export class TV {
   }
 
   async pushVolumeUpChanges(): Promise<void> {
-    const body = JSON.stringify({
+    const body = superStringify({
       'command': 'volumeAdd',
       'parameter': 'default',
       'commandType': 'command',
@@ -328,7 +329,7 @@ export class TV {
   }
 
   async pushVolumeDownChanges(): Promise<void> {
-    const body = JSON.stringify({
+    const body = superStringify({
       'command': 'volumeSub',
       'parameter': 'default',
       'commandType': 'command',
@@ -374,14 +375,14 @@ export class TV {
       });
       req.write(body);
       req.end();
-      this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushchanges: ${JSON.stringify(req)}`);
+      this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushchanges: ${superStringify(req)}`);
       this.updateHomeKitCharacteristics();
     } catch (e: any) {
       this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection`);
       if (this.deviceLogging.includes('debug')) {
         this.errorLog(
           `${this.device.remoteType}: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,` +
-            ` Error Message: ${JSON.stringify(e.message)}`,
+            ` Error Message: ${superStringify(e.message)}`,
         );
       }
       this.apiError(e);
@@ -409,7 +410,7 @@ export class TV {
         this.errorLog(
           `${this.device.remoteType}: ` +
             `${this.accessory.displayName} Device internal error due to device states not synchronized with server,` +
-            ` Or command: ${JSON.stringify(res)} format is invalid`,
+            ` Or command: ${superStringify(res)} format is invalid`,
         );
         break;
       case 100:
@@ -435,7 +436,7 @@ export class TV {
       config['logging'] = device.logging;
     }
     if (Object.entries(config).length !== 0) {
-      this.infoLog(`${this.device.remoteType}: ${this.accessory.displayName} Config: ${JSON.stringify(config)}`);
+      this.infoLog(`${this.device.remoteType}: ${this.accessory.displayName} Config: ${superStringify(config)}`);
     }
   }
 

package/src/irdevice/vacuumcleaner.ts

@@ -1,6 +1,7 @@
 import https from 'https';
 import crypto from 'crypto';
 import { IncomingMessage } from 'http';
+import superStringify from 'super-stringify';
 import { SwitchBotPlatform } from '../platform';
 import { irDevicesConfig, irdevice, HostDomain, DevicePath } from '../settings';
 import { CharacteristicValue, PlatformAccessory, Service } from 'homebridge';
@@ -86,7 +87,7 @@ export class VacuumCleaner {
    */
   async pushOnChanges(): Promise<void> {
     if (this.On) {
-      const body = JSON.stringify({
+      const body = superStringify({
         'command': 'turnOn',
         'parameter': 'default',
         'commandType': 'command',
@@ -97,7 +98,7 @@ export class VacuumCleaner {
 
   async pushOffChanges(): Promise<void> {
     if (!this.On) {
-      const body = JSON.stringify({
+      const body = superStringify({
         'command': 'turnOff',
         'parameter': 'default',
         'commandType': 'command',
@@ -144,7 +145,7 @@ export class VacuumCleaner {
       });
       req.write(body);
       req.end();
-      this.debugLog(`Vacuum Cleaner: ${this.accessory.displayName} pushchanges: ${JSON.stringify(req)}`);
+      this.debugLog(`Vacuum Cleaner: ${this.accessory.displayName} pushchanges: ${superStringify(req)}`);
       this.OnCached = this.On;
       this.accessory.context.On = this.OnCached;
       this.updateHomeKitCharacteristics();
@@ -153,7 +154,7 @@ export class VacuumCleaner {
       if (this.deviceLogging.includes('debug')) {
         this.errorLog(
           `Vacuum Cleaner: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,` +
-            ` Error Message: ${JSON.stringify(e.message)}`,
+            ` Error Message: ${superStringify(e.message)}`,
         );
       }
       this.apiError(e);
@@ -180,7 +181,7 @@ export class VacuumCleaner {
       case 190:
         this.errorLog(
           `Vacuum Cleaner: ${this.accessory.displayName} Device internal error due to device states not synchronized` +
-            ` with server, Or command: ${JSON.stringify(res)} format is invalid`,
+            ` with server, Or command: ${superStringify(res)} format is invalid`,
         );
         break;
       case 100:
@@ -205,7 +206,7 @@ export class VacuumCleaner {
       config['logging'] = device.logging;
     }
     if (Object.entries(config).length !== 0) {
-      this.infoLog(`Vacuum Cleaner: ${this.accessory.displayName} Config: ${JSON.stringify(config)}`);
+      this.infoLog(`Vacuum Cleaner: ${this.accessory.displayName} Config: ${superStringify(config)}`);
     }
   }
 

package/src/irdevice/waterheater.ts

@@ -1,6 +1,7 @@
 import https from 'https';
 import crypto from 'crypto';
 import { IncomingMessage } from 'http';
+import superStringify from 'super-stringify';
 import { SwitchBotPlatform } from '../platform';
 import { irDevicesConfig, irdevice, HostDomain, DevicePath } from '../settings';
 import { CharacteristicValue, PlatformAccessory, Service } from 'homebridge';
@@ -93,7 +94,7 @@ export class WaterHeater {
    */
   async pushWaterHeaterOnChanges(): Promise<void> {
     if (this.Active !== 1) {
-      const body = JSON.stringify({
+      const body = superStringify({
         'command': 'turnOn',
         'parameter': 'default',
         'commandType': 'command',
@@ -104,7 +105,7 @@ export class WaterHeater {
 
   async pushWaterHeaterOffChanges(): Promise<void> {
     if (this.Active !== 0) {
-      const body = JSON.stringify({
+      const body = superStringify({
         'command': 'turnOff',
         'parameter': 'default',
         'commandType': 'command',
@@ -151,13 +152,13 @@ export class WaterHeater {
       });
       req.write(body);
       req.end();
-      this.debugLog(`Water Heater: ${this.accessory.displayName} pushchanges: ${JSON.stringify(req)}`);
+      this.debugLog(`Water Heater: ${this.accessory.displayName} pushchanges: ${superStringify(req)}`);
       this.updateHomeKitCharacteristics();
     } catch (e: any) {
       this.errorLog(`Water Heater: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection`);
       if (this.deviceLogging.includes('debug')) {
         this.errorLog(
-          `Water Heater: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,` + ` Error Message: ${JSON.stringify(e.message)}`,
+          `Water Heater: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,` + ` Error Message: ${superStringify(e.message)}`,
         );
       }
       this.apiError(e);
@@ -184,7 +185,7 @@ export class WaterHeater {
       case 190:
         this.errorLog(
           `Water Heater: ${this.accessory.displayName} Device internal error due to device states not synchronized` +
-            ` with server, Or command: ${JSON.stringify(res)} format is invalid`,
+            ` with server, Or command: ${superStringify(res)} format is invalid`,
         );
         break;
       case 100:
@@ -209,7 +210,7 @@ export class WaterHeater {
       config['logging'] = device.logging;
     }
     if (Object.entries(config).length !== 0) {
-      this.infoLog(`Water Heater: ${this.accessory.displayName} Config: ${JSON.stringify(config)}`);
+      this.infoLog(`Water Heater: ${this.accessory.displayName} Config: ${superStringify(config)}`);
     }
   }
 

package/src/platform.ts

@@ -22,6 +22,7 @@ import https from 'https';
 import crypto from 'crypto';
 import { Buffer } from 'buffer';
 import fakegato from 'fakegato-history';
+import superStringify from 'super-stringify';
 import { readFileSync, writeFileSync } from 'fs';
 import { API, DynamicPlatformPlugin, Logger, PlatformAccessory, Service, Characteristic } from 'homebridge';
 import { PLATFORM_NAME, PLUGIN_NAME, irdevice, device, SwitchBotPlatformConfig, devicesConfig, DevicePath, HostDomain } from './settings';
@@ -65,9 +66,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       this.verifyConfig();
       this.debugLog('Config OK');
     } catch (e: any) {
-      this.errorLog(JSON.stringify(e.message));
+      this.errorLog(superStringify(e.message));
       if (this.platformLogging?.includes('debug')) {
-        this.errorLog(JSON.stringify(e));
+        this.errorLog(superStringify(e));
       }
       return;
     }
@@ -89,9 +90,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
           this.discoverDevices();
         }
       } catch (e: any) {
-        this.errorLog('Failed to Discover Devices.', JSON.stringify(e.message));
+        this.errorLog('Failed to Discover Devices.', superStringify(e.message));
         if (this.platformLogging?.includes('debug')) {
-          this.errorLog(JSON.stringify(e));
+          this.errorLog(superStringify(e));
         }
       }
     });
@@ -145,7 +146,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       platformConfig['pushRate'] = this.config.options.pushRate;
     }
     if (Object.entries(platformConfig).length !== 0) {
-      this.infoLog(`Platform Config: ${JSON.stringify(platformConfig)}`);
+      this.infoLog(`Platform Config: ${superStringify(platformConfig)}`);
     }
 
     if (this.config.options) {
@@ -263,7 +264,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         this.warnLog(`Token: ${pluginConfig.credentials.token}`);
       }
       // save the config, ensuring we maintain pretty json
-      writeFileSync(this.api.user.configPath(), JSON.stringify(currentConfig, null, 4));
+      writeFileSync(this.api.user.configPath(), superStringify(currentConfig, null, 4));
       this.verifyConfig();
     } catch (e: any) {
       this.errorLog(e);
@@ -297,7 +298,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         };
         const req = https.request(options, (res) => {
           this.debugLog(`statusCode: ${res.statusCode}`);
-          this.debugLog(`headers: ${JSON.stringify(res.headers)}`);
+          this.debugLog(`headers: ${superStringify(res.headers)}`);
           let rawData = '';
           res.on('data', (d) => {
             rawData += d;
@@ -306,7 +307,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
           res.on('end', () => {
             try {
               const devicesAPI = JSON.parse(rawData);
-              this.debugLog(`devicesAPI: ${JSON.stringify(devicesAPI.body)}`);
+              this.debugLog(`devicesAPI: ${superStringify(devicesAPI.body)}`);
 
               // SwitchBot Devices
               if (devicesAPI.body.deviceList.length !== 0) {
@@ -316,7 +317,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
               }
               const deviceLists = devicesAPI.body.deviceList;
               if (!this.config.options?.devices) {
-                this.debugLog(`SwitchBot Device Config Not Set: ${JSON.stringify(this.config.options?.devices)}`);
+                this.debugLog(`SwitchBot Device Config Not Set: ${superStringify(this.config.options?.devices)}`);
                 const devices = deviceLists.map((v: any) => v);
                 for (const device of devices) {
                   if (device.deviceType) {
@@ -327,7 +328,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
                   }
                 }
               } else if (this.config.credentials?.token && this.config.options.devices) {
-                this.debugLog(`SwitchBot Device Config Set: ${JSON.stringify(this.config.options?.devices)}`);
+                this.debugLog(`SwitchBot Device Config Set: ${superStringify(this.config.options?.devices)}`);
                 const deviceConfigs = this.config.options?.devices;
 
                 const mergeBydeviceId = (a1: { deviceId: string }[], a2: any[]) =>
@@ -340,7 +341,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
                   }));
 
                 const devices = mergeBydeviceId(deviceLists, deviceConfigs);
-                this.debugLog(`SwitchBot Devices: ${JSON.stringify(devices)}`);
+                this.debugLog(`SwitchBot Devices: ${superStringify(devices)}`);
                 for (const device of devices) {
                   if (device.deviceType) {
                     if (device.configDeviceName) {
@@ -361,7 +362,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
               }
               const irDeviceLists = devicesAPI.body.infraredRemoteList;
               if (!this.config.options?.irdevices) {
-                this.debugLog(`IR Device Config Not Set: ${JSON.stringify(this.config.options?.irdevices)}`);
+                this.debugLog(`IR Device Config Not Set: ${superStringify(this.config.options?.irdevices)}`);
                 const devices = irDeviceLists.map((v: any) => v);
                 for (const device of devices) {
                   if (device.remoteType) {
@@ -369,7 +370,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
                   }
                 }
               } else {
-                this.debugLog(`IR Device Config Set: ${JSON.stringify(this.config.options?.irdevices)}`);
+                this.debugLog(`IR Device Config Set: ${superStringify(this.config.options?.irdevices)}`);
                 const irDeviceConfig = this.config.options?.irdevices;
 
                 const mergeIRBydeviceId = (a1: { deviceId: string }[], a2: any[]) =>
@@ -382,7 +383,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
                   }));
 
                 const devices = mergeIRBydeviceId(irDeviceLists, irDeviceConfig);
-                this.debugLog(`IR Devices: ${JSON.stringify(devices)}`);
+                this.debugLog(`IR Devices: ${superStringify(devices)}`);
                 for (const device of devices) {
                   if (device.remoteType) {
                     this.createIRDevice(device);
@@ -399,7 +400,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         });
         req.end();
       } else if (!this.config.credentials?.token && this.config.options?.devices) {
-        this.debugLog(`SwitchBot Device Manual Config Set: ${JSON.stringify(this.config.options?.devices)}`);
+        this.debugLog(`SwitchBot Device Manual Config Set: ${superStringify(this.config.options?.devices)}`);
         const deviceConfigs = this.config.options?.devices;
         const devices = deviceConfigs.map((v: any) => v);
         for (const device of devices) {
@@ -452,10 +453,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       this.errorLog('Failed to Discover Devices');
     }
     if (this.platformLogging === 'debug') {
-      this.errorLog(`Failed to Discover Devices, Error Message: ${JSON.stringify(e.message)}`);
+      this.errorLog(`Failed to Discover Devices, Error Message: ${superStringify(e.message)}`);
     }
     if (this.platformLogging === 'debugMode') {
-      this.errorLog(`Failed to Discover Devices, Error: ${JSON.stringify(e)}`);
+      this.errorLog(`Failed to Discover Devices, Error: ${superStringify(e)}`);
     }
   }
 
@@ -659,7 +660,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       if (this.registerDevice(device)) {
         this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} DeviceID: ${device.deviceId}`);
 
-        this.debugLog(JSON.stringify(device.bot?.mode));
+        this.debugLog(superStringify(device.bot?.mode));
 
         // if you need to update the accessory.context then you should run `api.updatePlatformAccessories`. eg.:
         existingAccessory.context.model = device.deviceType;
@@ -680,7 +681,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       // the accessory does not yet exist, so we need to create it
       this.infoLog(`Adding new accessory: ${device.deviceName} ${device.deviceType} DeviceID: ${device.deviceId}`);
 
-      this.debugLog(JSON.stringify(device.bot?.mode));
+      this.debugLog(superStringify(device.bot?.mode));
 
       // create a new accessory
       const accessory = new this.api.platformAccessory(device.deviceName, uuid);
@@ -1787,13 +1788,13 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
 
   public deviceListInfo(devices) {
     if (this.platformLogging?.includes('debug')) {
-      this.warnLog(`deviceListInfoStatus: ${JSON.stringify(devices)}`);
+      this.warnLog(`deviceListInfoStatus: ${superStringify(devices)}`);
     }
   }
 
   public async deviceInfo(device: (irdevice & devicesConfig) | (device & devicesConfig)) {
     if (this.platformLogging?.includes('debug')) {
-      this.warnLog(JSON.stringify(device));
+      this.warnLog(superStringify(device));
 
       const t = Date.now();
       const nonce = 'requestID';
@@ -1827,9 +1828,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
 
       this.deviceStatus = req;
       if (this.deviceStatus.message === 'success') {
-        this.warnLog(`${device.deviceName} deviceInfoStatus: ${JSON.stringify(this.deviceStatus)}`);
+        this.warnLog(`${device.deviceName} deviceInfoStatus: ${superStringify(this.deviceStatus)}`);
       } else {
-        this.warnLog(`${device.deviceName} deviceInfoStatus: ${JSON.stringify(this.deviceStatus.message)}`);
+        this.warnLog(`${device.deviceName} deviceInfoStatus: ${superStringify(this.deviceStatus.message)}`);
         this.warnLog('Unable to retreive deviceInfoStatus.');
       }
     }