@switchbot/homebridge-switchbot 4.1.1-beta.9 → 4.1.1

package/dist/platform.js

@@ -1,5 +1,5 @@
 import { readFileSync } from 'node:fs';
-import process from 'node:process';
+import { argv } from 'node:process';
 import asyncmqtt from 'async-mqtt';
 import fakegato from 'fakegato-history';
 import { EveHomeKitTypes } from 'homebridge-lib/EveHomeKitTypes';
@@ -46,14 +46,16 @@ export class SwitchBotPlatform {
     api;
     log;
     // Configuration properties
-    version;
-    Logging;
-    debugMode;
-    maxRetries;
-    delayBetweenRetries;
     platformConfig;
     platformLogging;
+    platformRefreshRate;
+    platformPushRate;
+    platformUpdateRate;
+    platformMaxRetries;
+    platformDelayBetweenRetries;
     config;
+    debugMode;
+    version;
     // MQTT and Webhook properties
     mqttClient = null;
     webhookEventListener = null;
@@ -81,10 +83,10 @@ export class SwitchBotPlatform {
             credentials: config.credentials,
             options: config.options,
             devices: config.devices,
-            deviceConfig: config.deviceConfig,
         };
         // Plugin Configuration
         this.getPlatformLogSettings();
+        this.getPlatformRateSettings();
         this.getPlatformConfigSettings();
         this.getVersion();
         // Finish initializing the platform
@@ -329,19 +331,6 @@ export class SwitchBotPlatform {
         this.debugLog('Verifying Config');
         this.config = this.config || {};
         this.config.options = this.config.options || {};
-        const platformConfig = {};
-        if (this.config.options.logging) {
-            platformConfig.logging = this.config.options.logging;
-        }
-        if (this.config.options.logging && this.config.options.refreshRate) {
-            platformConfig.refreshRate = this.config.options.refreshRate;
-        }
-        if (this.config.options.logging && this.config.options.pushRate) {
-            platformConfig.pushRate = this.config.options.pushRate;
-        }
-        if (Object.entries(platformConfig).length !== 0) {
-            this.debugWarnLog(`Platform Config: ${JSON.stringify(platformConfig)}`);
-        }
         if (this.config.options) {
             // Device Config
             if (this.config.options.devices) {
@@ -370,34 +359,6 @@ export class SwitchBotPlatform {
                 }
             }
         }
-        if (this.config.options.refreshRate < 5) {
-            throw new Error('Refresh Rate must be above 5 (5 seconds).');
-        }
-        if (!this.config.options.refreshRate) {
-            // default 120 seconds (2 minutes)
-            this.config.options.refreshRate = 120;
-            this.debugWarnLog('Using Default Refresh Rate (2 minutes).');
-        }
-        if (!this.config.options.pushRate) {
-            // default 100 milliseconds
-            this.config.options.pushRate = 0.1;
-            this.debugWarnLog('Using Default Push Rate.');
-        }
-        if (!this.config.options.maxRetries) {
-            this.config.options.maxRetries = 5;
-            this.debugWarnLog('Using Default Max Retries.');
-        }
-        else {
-            this.maxRetries = this.config.options.maxRetries;
-        }
-        if (!this.config.options.delayBetweenRetries) {
-            // default 3 seconds
-            this.config.options.delayBetweenRetries = 3000;
-            this.debugWarnLog('Using Default Delay Between Retries.');
-        }
-        else {
-            this.delayBetweenRetries = this.config.options.delayBetweenRetries * 1000;
-        }
         if (!this.config.credentials && !this.config.options) {
             this.debugWarnLog('Missing Credentials');
         }
@@ -419,11 +380,11 @@ export class SwitchBotPlatform {
             return this.handleManualConfig();
         }
         let retryCount = 0;
-        const maxRetries = this.maxRetries;
-        const delayBetweenRetries = this.delayBetweenRetries;
+        const maxRetries = this.platformMaxRetries ?? 5;
+        const delayBetweenRetries = this.platformDelayBetweenRetries || 5000;
         this.debugWarnLog(`Retry Count: ${retryCount}`);
-        this.debugWarnLog(`Max Retries: ${maxRetries}`);
-        this.debugWarnLog(`Delay Between Retries: ${delayBetweenRetries}`);
+        this.debugWarnLog(`Max Retries: ${this.platformMaxRetries}`);
+        this.debugWarnLog(`Delay Between Retries: ${this.platformDelayBetweenRetries}`);
         while (retryCount < maxRetries) {
             try {
                 const { response, statusCode } = await this.switchBotAPI.getDevices();
@@ -2563,50 +2524,65 @@ export class SwitchBotPlatform {
             return false;
         }
     }
-    async getVersion() {
-        const json = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf-8'));
-        this.debugLog(`Plugin Version: ${json.version}`);
-        this.version = json.version;
-        return json.version;
-    }
     async getPlatformConfigSettings() {
-        const { options } = this.config;
-        const platformConfig = {};
-        if (options) {
-            platformConfig.logging = options.logging;
-            platformConfig.refreshRate = options.refreshRate;
-            platformConfig.updateRate = options.updateRate;
-            platformConfig.pushRate = options.pushRate;
-            this.maxRetries = options.maxRetries || 3;
-            platformConfig.maxRetries = this.maxRetries;
-            if (!options.maxRetries) {
-                this.debugWarnLog('Using Default Max Retries');
-            }
-            this.delayBetweenRetries = (options.delayBetweenRetries || 3) * 1000;
-            platformConfig.delayBetweenRetries = this.delayBetweenRetries / 1000;
-            if (!options.delayBetweenRetries) {
-                this.debugWarnLog('Using Default Delay Between Retries');
-            }
-            if (Object.keys(platformConfig).length) {
-                this.debugLog(`Platform Config: ${JSON.stringify(platformConfig)}`);
+        if (this.config.options) {
+            const platformConfig = {
+                platform: 'Resideo',
+            };
+            platformConfig.logging = this.config.options.logging ? this.config.options.logging : undefined;
+            platformConfig.refreshRate = this.config.options.refreshRate ? this.config.options.refreshRate : undefined;
+            platformConfig.updateRate = this.config.options.updateRate ? this.config.options.updateRate : undefined;
+            platformConfig.pushRate = this.config.options.pushRate ? this.config.options.pushRate : undefined;
+            platformConfig.maxRetries = this.config.options.maxRetries ? this.config.options.maxRetries : undefined;
+            platformConfig.delayBetweenRetries = this.config.options.delayBetweenRetries ? this.config.options.delayBetweenRetries : undefined;
+            if (Object.entries(platformConfig).length !== 0) {
+                await this.debugLog(`Platform Config: ${JSON.stringify(platformConfig)}`);
             }
             this.platformConfig = platformConfig;
         }
     }
+    async getPlatformRateSettings() {
+        this.platformRefreshRate = this.config.options?.refreshRate ?? 120;
+        if (this.platformRefreshRate < 5) {
+            this.platformRefreshRate = 5;
+        }
+        const refreshRate = this.config.options?.refreshRate ? 'Using Platform Config refreshRate' : 'refreshRate Disabled by Default';
+        await this.debugLog(`${refreshRate}: ${this.platformRefreshRate}`);
+        this.platformUpdateRate = this.config.options?.updateRate ? this.config.options.updateRate : 1;
+        const updateRate = this.config.options?.updateRate ? 'Using Platform Config updateRate' : 'Using Default updateRate';
+        await this.debugLog(`${updateRate}: ${this.platformUpdateRate}`);
+        this.platformPushRate = this.config.options?.pushRate ? this.config.options.pushRate : 0.1;
+        const pushRate = this.config.options?.pushRate ? 'Using Platform Config pushRate' : 'Using Default pushRate';
+        await this.debugLog(`${pushRate}: ${this.platformPushRate}`);
+        this.platformMaxRetries = this.config.options?.maxRetries ? this.config.options.maxRetries : 3;
+        const maxRetries = this.config.options?.maxRetries ? 'Using Platform Config maxRetries' : 'Using Default maxRetries';
+        await this.debugLog(`${maxRetries}: ${this.platformMaxRetries}`);
+        this.platformDelayBetweenRetries = this.config.options?.delayBetweenRetries ? this.config.options.delayBetweenRetries * 1000 : 3000;
+        const delayBetweenRetries = this.config.options?.delayBetweenRetries ? 'Using Platform Config delayBetweenRetries' : 'Using Default delayBetweenRetries';
+        await this.debugLog(`${delayBetweenRetries}: ${this.platformDelayBetweenRetries / 1000}`);
+    }
     async getPlatformLogSettings() {
-        this.debugMode = process.argv.includes('-D') ?? process.argv.includes('--debug');
-        if (this.config.options?.logging === 'debug' || this.config.options?.logging === 'standard' || this.config.options?.logging === 'none') {
-            this.platformLogging = this.config.options.logging;
-            this.debugWarnLog(`Using Config Logging: ${this.platformLogging}`);
-        }
-        else if (this.debugMode) {
-            this.platformLogging = 'debugMode';
-            this.debugWarnLog(`Using ${this.platformLogging} Logging`);
-        }
-        else {
-            this.platformLogging = 'standard';
-            this.debugWarnLog(`Using ${this.platformLogging} Logging`);
-        }
+        this.debugMode = argv.includes('-D') ?? argv.includes('--debug');
+        this.platformLogging = (this.config.options?.logging === 'debug' || this.config.options?.logging === 'standard'
+            || this.config.options?.logging === 'none')
+            ? this.config.options.logging
+            : this.debugMode ? 'debugMode' : 'standard';
+        const logging = this.config.options?.logging ? 'Platform Config' : this.debugMode ? 'debugMode' : 'Default';
+        await this.debugLog(`Using ${logging} Logging: ${this.platformLogging}`);
+    }
+    /**
+     * Asynchronously retrieves the version of the plugin from the package.json file.
+     *
+     * This method reads the package.json file located in the parent directory,
+     * parses its content to extract the version, and logs the version using the debug logger.
+     * The extracted version is then assigned to the `version` property of the class.
+     *
+     * @returns {Promise<void>} A promise that resolves when the version has been retrieved and logged.
+     */
+    async getVersion() {
+        const { version } = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf-8'));
+        this.debugLog(`Plugin Version: ${version}`);
+        this.version = version;
     }
     /**
      * Validate and clean a string value for a Name Characteristic.