@switchbot/homebridge-switchbot 5.0.0-beta.3 → 5.0.0-beta.31

package/dist/platform-hap.js

@@ -36,7 +36,7 @@ import { TV } from './irdevice/tv.js';
 import { VacuumCleaner } from './irdevice/vacuumcleaner.js';
 import { WaterHeater } from './irdevice/waterheater.js';
 import { PLATFORM_NAME, PLUGIN_NAME } from './settings.js';
-import { cleanDeviceConfig, formatDeviceIdAsMac, isBlindTiltDevice, isCurtainDevice, safeStringify, sleep } from './utils.js';
+import { ApiRequestTracker, cleanDeviceConfig, createPlatformLogger, formatDeviceIdAsMac, isBlindTiltDevice, isCurtainDevice, safeStringify, sleep } from './utils.js';
 /**
  * HomebridgePlatform
  * This class is the main constructor for your plugin, this is where you should
@@ -47,6 +47,17 @@ export class SwitchBotHAPPlatform {
     accessories = [];
     api;
     log;
+    // Logging helper functions (attached from utils.createPlatformLogger in constructor)
+    infoLog;
+    successLog;
+    debugSuccessLog;
+    warnLog;
+    debugWarnLog;
+    errorLog;
+    debugErrorLog;
+    debugLog;
+    loggingIsDebug;
+    enablingPlatformLogging;
     // Configuration properties
     platformConfig;
     platformLogging;
@@ -64,6 +75,8 @@ export class SwitchBotHAPPlatform {
     // SwitchBot APIs
     switchBotAPI;
     switchBotBLE;
+    // API request tracking
+    apiTracker;
     // External APIs
     eve;
     fakegatoAPI;
@@ -73,9 +86,21 @@ export class SwitchBotHAPPlatform {
     constructor(log, config, api) {
         this.api = api;
         this.log = log;
+        // Attach shared platform logging helpers (moved to utils for reuse)
+        const _pl = createPlatformLogger(async () => this.platformLogging, this.log);
+        this.infoLog = _pl.infoLog;
+        this.successLog = _pl.successLog;
+        this.debugSuccessLog = _pl.debugSuccessLog;
+        this.warnLog = _pl.warnLog;
+        this.debugWarnLog = _pl.debugWarnLog;
+        this.errorLog = _pl.errorLog;
+        this.debugErrorLog = _pl.debugErrorLog;
+        this.debugLog = _pl.debugLog;
+        this.loggingIsDebug = _pl.loggingIsDebug;
+        this.enablingPlatformLogging = _pl.enablingPlatformLogging;
         // only load if configured
         if (!config) {
-            this.log.error('No configuration found for the plugin, please check your config.');
+            this.errorLog('No configuration found for the plugin, please check your config.');
             return;
         }
         // Plugin options into our config variables.
@@ -86,6 +111,19 @@ export class SwitchBotHAPPlatform {
             options: config.options,
             devices: config.devices,
         };
+        // Determine platform logging preference (match HAP behaviour as closely as
+        // possible using config values. We default to 'standard' when unspecified.)
+        this.platformLogging = (this.config.options?.logging === 'debug' || this.config.options?.logging === 'standard' || this.config.options?.logging === 'none')
+            ? this.config.options.logging
+            : 'standard';
+        // Unconditional diagnostic using the raw Homebridge `log` so it always
+        // appears regardless of the platform logging helpers' gating logic.
+        try {
+            this.log.debug?.(`[SwitchBot HAP] effective platformLogging=${String(this.platformLogging)}`);
+        }
+        catch (e) {
+            // swallow any logging errors — diagnostics are best-effort
+        }
         // Normalize deviceConfig to remove UI-inserted defaults (lots of false/empty values)
         try {
             if (this.config.options) {
@@ -171,9 +209,29 @@ export class SwitchBotHAPPlatform {
         // to start discovery of new accessories.
         this.api.on('didFinishLaunching', async () => {
             this.debugLog('Executed didFinishLaunching callback');
+            // Initialize API request tracking
+            try {
+                this.apiTracker = new ApiRequestTracker(this.api, this.log, 'SwitchBot HAP');
+                this.apiTracker.startHourlyLogging();
+            }
+            catch (e) {
+                this.errorLog(`Failed to initialize API request tracking: ${e.message ?? e}`);
+            }
             // run the method to discover / register your devices as accessories
             try {
-                await this.discoverDevices();
+                // Does the user have a version of Homebridge that is compatible with matter?
+                if (!this.api.isMatterAvailable?.()) {
+                    this.debugLog(`Matter is not available in this version of Homebridge. Please update Homebridge to use this plugin, ${this.api.isMatterAvailable?.() ? '' : ' (Matter is not available in this version of Homebridge)'}`);
+                }
+                if (!this.api.isMatterEnabled?.()) {
+                    this.debugLog(`Matter is not enabled in Homebridge. Please enable Matter in the Homebridge settings to use this plugin, ${this.api.isMatterEnabled?.() ? '' : ' (Matter is not enabled in Homebridge)'}`);
+                }
+                if (!this.api.isMatterAvailable?.() && !this.api.isMatterEnabled?.()) {
+                    await this.discoverDevices();
+                }
+                else {
+                    this.infoLog('Matter is enabled in Homebridge. SwitchBot Matter devices will be handled by the Matter platform.');
+                }
             }
             catch (e) {
                 this.errorLog(`Failed to Discover, Error Message: ${e.message ?? e}, Submit Bugs Here: ` + 'https://tinyurl.com/SwitchBotBug');
@@ -406,6 +464,7 @@ export class SwitchBotHAPPlatform {
         this.debugWarnLog(`Delay Between Retries: ${this.platformDelayBetweenRetries}`);
         while (retryCount < maxRetries) {
             try {
+                this.apiTracker?.track();
                 const { response, statusCode } = await this.switchBotAPI.getDevices();
                 this.debugLog(`response: ${JSON.stringify(response)}`);
                 if (this.isSuccessfulResponse(statusCode)) {
@@ -2637,6 +2696,7 @@ export class SwitchBotHAPPlatform {
         const delayBetweenRetries = deviceDelayBetweenRetries;
         while (retryCount < maxRetries) {
             try {
+                this.apiTracker?.track();
                 const { response, statusCode } = await this.switchBotAPI.getDeviceStatus(device.deviceId, this.config.credentials?.token, this.config.credentials?.secret);
                 this.debugLog(`response: ${JSON.stringify(response)}`);
                 return { response, statusCode };
@@ -2662,6 +2722,7 @@ export class SwitchBotHAPPlatform {
         const delayBetweenRetries = deviceDelayBetweenRetries ?? 1000;
         while (retryCount < maxRetries) {
             try {
+                this.apiTracker?.track();
                 const { response, statusCode } = await this.switchBotAPI.controlDevice(device.deviceId, bodyChange.command, bodyChange.parameter, bodyChange.commandType, this.config.credentials?.token, this.config.credentials?.secret);
                 this.debugLog(`response: ${JSON.stringify(response)}`);
                 return { response, statusCode };
@@ -2784,66 +2845,5 @@ export class SwitchBotHAPPlatform {
             return value;
         }
     }
-    /**
-     * If device level logging is turned on, log to log.warn
-     * Otherwise send debug logs to log.debug
-     */
-    async infoLog(...log) {
-        if (await this.enablingPlatformLogging()) {
-            this.log.info(String(...log));
-        }
-    }
-    async successLog(...log) {
-        if (await this.enablingPlatformLogging()) {
-            this.log.success(String(...log));
-        }
-    }
-    async debugSuccessLog(...log) {
-        if (await this.enablingPlatformLogging()) {
-            if (await this.loggingIsDebug()) {
-                this.log.success('[DEBUG]', String(...log));
-            }
-        }
-    }
-    async warnLog(...log) {
-        if (await this.enablingPlatformLogging()) {
-            this.log.warn(String(...log));
-        }
-    }
-    async debugWarnLog(...log) {
-        if (await this.enablingPlatformLogging()) {
-            if (await this.loggingIsDebug()) {
-                this.log.warn('[DEBUG]', String(...log));
-            }
-        }
-    }
-    async errorLog(...log) {
-        if (await this.enablingPlatformLogging()) {
-            this.log.error(String(...log));
-        }
-    }
-    async debugErrorLog(...log) {
-        if (await this.enablingPlatformLogging()) {
-            if (await this.loggingIsDebug()) {
-                this.log.error('[DEBUG]', String(...log));
-            }
-        }
-    }
-    async debugLog(...log) {
-        if (await this.enablingPlatformLogging()) {
-            if (this.platformLogging === 'debug') {
-                this.log.info('[DEBUG]', String(...log));
-            }
-            else if (this.platformLogging === 'debugMode') {
-                this.log.debug(String(...log));
-            }
-        }
-    }
-    async loggingIsDebug() {
-        return this.platformLogging === 'debugMode' || this.platformLogging === 'debug';
-    }
-    async enablingPlatformLogging() {
-        return this.platformLogging === 'debugMode' || this.platformLogging === 'debug' || this.platformLogging === 'standard';
-    }
 }
 //# sourceMappingURL=platform-hap.js.map