@switchbot/homebridge-switchbot 5.0.0-beta.15 → 5.0.0-beta.150

package/dist/utils.d.ts

@@ -1,138 +1,115 @@
-import type { API, Logging } from 'homebridge';
-import type { blindTilt, curtain, curtain3, device } from 'node-switchbot';
-import type { devicesConfig } from './settings.js';
-export declare enum BlindTiltMappingMode {
-    OnlyUp = "only_up",
-    OnlyDown = "only_down",
-    DownAndUp = "down_and_up",
-    UpAndDown = "up_and_down",
-    UseTiltForDirection = "use_tilt_for_direction"
-}
-export declare function isCurtainDevice(device: device & devicesConfig): device is (curtain | curtain3) & devicesConfig;
-export declare function isBlindTiltDevice(device: device & devicesConfig): device is blindTilt & devicesConfig;
-export declare function sleep(ms: number): Promise<void>;
+import type { SwitchBotPluginConfig } from './settings.js';
+import type { Logger, PlatformConfig } from 'homebridge';
 /**
- * Check if the humidity is within the min and max range
- * @param humidity - The humidity value
- * @param min - The minimum humidity value
- * @param max - The maximum humidity value
- * @returns The humidity value
- */
-export declare function validHumidity(humidity: number, min?: number, max?: number): number;
-/**
- * Converts the value to celsius if the temperature units are in Fahrenheit
- */
-export declare function convertUnits(value: number, unit: string, convert?: string): number;
-/**
- * Safely serializes an object to a JSON string, handling circular references.
+ * Indicates which device types should prefer Matter if available.
+ * Based on HAP service mappings: device implementations use specific HomeKit services
+ * that map to corresponding Matter clusters when Matter is enabled.
  *
- * @param obj - The object to be serialized.
- * @returns The JSON string representation of the object.
+ * @property {boolean} [deviceType] - True if the device type supports Matter, false otherwise.
+ * @example
+ * DEVICE_MATTER_SUPPORTED['bot'] // true
  */
-export declare function safeStringify(obj: any): string;
 /**
- * Formats a device ID as a MAC address.
- * Ensures the device ID does not already contain colons.
+ * Factory function to create Matter handlers with Homebridge logger integration.
+ * Returns handler objects for supported device types, mapping Matter cluster actions to SwitchBot API calls.
  *
- * @param deviceId - The device ID to format.
- * @param cassSensative - If the MAC address should be case sensitive. Default is false, which will return the MAC address in lowercase.
- * @returns The formatted MAC address.
- * @throws Will throw an error if the device ID is not a valid MAC address or a 12-character hexadecimal string.
+ * @param log - Homebridge logger instance
+ * @param deviceId - SwitchBot device ID
+ * @param type - Device type string
+ * @param client - SwitchBot client instance
+ * @returns Handler object for Matter clusters
  */
-export declare function formatDeviceIdAsMac(deviceId: string, cassSensative?: boolean): string;
-export declare function rgb2hs(r: any, g: any, b: any): number[];
-export declare function hs2rgb(h: any, s: any): number[];
-export declare function k2rgb(k: number): any;
-export declare function m2hs(m: any): number[];
+export declare const DEVICE_MATTER_SUPPORTED: Record<string, boolean>;
 /**
- * Remove deviceConfig entries that contain only default/empty values.
- * Returns undefined if nothing meaningful remains.
- */
-export declare function cleanDeviceConfig(deviceConfig?: Record<string, Record<string, any>>): Record<string, Record<string, any>> | undefined;
-/**
- * Factory that returns a function to send OpenAPI commands using a retry wrapper.
+ * Default Matter cluster configurations by device type.
+ * Maps device types to their Matter cluster states (used when device doesn't provide clusters).
+ * Note: wosweeper/curtain/plug variants are normalized before cluster lookup (see loadDevices).
  *
- * @param retryCommandFunc - bound function that calls platform.retryCommand(device, bodyChange, maxRetries, delay)
- * @param deviceObj - the device object to operate on
- * @param opts - optional overrides for maxRetries and delayBetweenRetries
- * @param opts.maxRetries - override for maxRetries
- * @param opts.delayBetweenRetries - override for delayBetweenRetries
+ * @property {object} [deviceType] - The default cluster state for the device type.
+ * @example
+ * DEVICE_MATTER_CLUSTERS['bot'] // { onOff: { onOff: false } }
  */
-export declare function makeOpenAPISender(retryCommandFunc: any, deviceObj: any, opts?: {
-    maxRetries?: number;
-    delayBetweenRetries?: number;
-}): (command: string, parameter?: string) => Promise<any>;
+export declare const DEVICE_MATTER_CLUSTERS: Record<string, any>;
+export declare function createMatterHandlers(log: Logger, deviceId: string, type: string, client: any): any;
+export declare function resolveMatterDeviceType(matterApi: any, type: string, createdDeviceType?: any, clusters?: any): any;
 /**
- * Factory that returns a function to perform BLE actions using a SwitchBotBLE client.
- * Handles discovery retries and method invocation on the discovered device instance.
+ * Canonical Matter cluster ID mapping (from matter.js clusters).
+ * Maps cluster names to their numeric cluster IDs.
  *
- * @param switchBotBLE - instance of SwitchBotBLE (may be undefined)
- * @param deviceObj - the device object (used to obtain bleModel/deviceId)
- * @param opts - optional retry settings
- * @param opts.bleRetries - number of BLE discovery retries
- * @param opts.bleRetryDelay - delay between BLE retries in ms
- */
-export declare function makeBLESender(switchBotBLE: any, deviceObj: any, opts?: {
-    bleRetries?: number;
-    bleRetryDelay?: number;
-}): (methodName: string, ...args: any[]) => Promise<any>;
-/**
- * Decide effective connection type for a device given platform options.
- * Mirrors the logic previously in platform-matter.
- */
-export declare function chooseConnectionType(platformOptions: any, deviceObj: any): 'BLE' | 'OpenAPI';
-/**
- * Detect whether Matter is enabled/available on the provided Homebridge API object.
- * This encapsulates the multi-fallback detection used across the project.
+ * @example
+ * MATTER_CLUSTER_IDS.OnOff // 0x0006
  */
+export declare const MATTER_CLUSTER_IDS: {
+    readonly OnOff: 6;
+    readonly LevelControl: 8;
+    readonly ColorControl: 768;
+    readonly WindowCovering: 258;
+    readonly DoorLock: 257;
+    readonly FanControl: 514;
+    readonly RelativeHumidityMeasurement: 1029;
+};
 /**
- * Detect whether Matter is enabled on the provided Homebridge API object.
- * Returns an object with an `enabled` boolean and an optional `reason` string
- * describing which check matched (useful for diagnostics).
+ * Common Matter attribute IDs grouped by cluster.
+ * Maps cluster names to objects mapping attribute names to their numeric attribute IDs.
+ *
+ * @example
+ * MATTER_ATTRIBUTE_IDS.OnOff.OnOff // 0x0000
  */
-export declare function detectMatter(apiObj: API): {
-    enabled: boolean;
-    reason?: string;
+export declare const MATTER_ATTRIBUTE_IDS: {
+    readonly OnOff: {
+        readonly OnOff: 0;
+    };
+    readonly LevelControl: {
+        readonly CurrentLevel: 0;
+    };
+    readonly ColorControl: {
+        readonly CurrentHue: 0;
+        readonly CurrentSaturation: 1;
+        readonly ColorTemperatureMireds: 2;
+    };
+    readonly WindowCovering: {
+        readonly CurrentPosition: 0;
+        readonly TargetPosition: 1;
+    };
+    readonly FanControl: {
+        readonly SpeedCurrent: 0;
+    };
+    readonly DoorLock: {
+        readonly LockState: 0;
+    };
+    readonly RelativeHumidityMeasurement: {
+        readonly MeasuredValue: 0;
+    };
 };
 /**
- * Backwards-compatible boolean wrapper for detectMatter.
+ * Normalizes a device type string for Matter integration.
+ * Maps various device type aliases and variants to canonical Matter device types.
+ *
+ * @param {string | undefined | null} typeValue - The device type string to normalize.
+ * @returns {string} The normalized device type string for Matter.
+ *
+ * @example
+ * normalizeTypeForMatter('wosweeper') // 'vacuum'
+ * normalizeTypeForMatter('curtain3') // 'curtain'
+ * normalizeTypeForMatter('plug mini (us)') // 'plug'
  */
-export declare function detectMatterEnabled(apiObj: API): boolean;
+export declare function normalizeTypeForMatter(typeValue: string | undefined | null): string;
 /**
- * Create platform logging helpers used by both HAP and Matter platforms.
+ * Normalizes a Homebridge PlatformConfig object to a SwitchBotPluginConfig.
  *
- * getPlatformLogging may be either a synchronous string-returning function or an
- * async function that resolves to the current platform logging setting. The
- * returned helpers mirror the instance methods previously implemented on the
- * HAP platform (infoLog, warnLog, errorLog, debugLog, etc.).
+ * @param raw The raw Homebridge platform config object.
+ * @returns The normalized plugin config object.
  */
-export declare function createPlatformLogger(getPlatformLogging: () => string | Promise<string | undefined>, log: Logging): {
-    infoLog: (...args: any[]) => Promise<void>;
-    successLog: (...args: any[]) => Promise<void>;
-    debugSuccessLog: (...args: any[]) => Promise<void>;
-    warnLog: (...args: any[]) => Promise<void>;
-    debugWarnLog: (...args: any[]) => Promise<void>;
-    errorLog: (...args: any[]) => Promise<void>;
-    debugErrorLog: (...args: any[]) => Promise<void>;
-    debugLog: (...args: any[]) => Promise<void>;
-    loggingIsDebug: () => Promise<boolean>;
-    enablingPlatformLogging: () => Promise<boolean>;
-};
+export declare function normalizeConfig(raw?: PlatformConfig): SwitchBotPluginConfig;
 /**
- * Create a Platform proxy class that selects between two platform constructors
- * (HAP vs Matter) at runtime using `detectMatter`. Returns a class suitable
- * for passing to `api.registerPlatform`.
+ * Creates a proxy class that instantiates the correct platform implementation (HAP or Matter) at runtime.
+ *
+ * @param HAPPlatform The HAP platform class constructor.
+ * @param MatterPlatform The Matter platform class constructor.
+ * @returns A proxy class that delegates to the correct platform implementation.
+ *
+ * @class SwitchBotPlatformProxy
+ * @property impl The instantiated platform implementation (HAP or Matter).
  */
-export declare function createPlatformProxy(HAPCtor: any, MatterCtor: any): {
-    new (log: any, config: any, api: API): {
-        delegate: any;
-        readonly log: any;
-        readonly config: any;
-        readonly api: API;
-        configureAccessory(accessory: any): void;
-        configureMatterAccessory?(accessory: any): void;
-        get accessories(): any;
-        get matterAccessories(): any;
-    };
-};
+export declare function createPlatformProxy(HAPPlatform: any, MatterPlatform: any): any;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAE1E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAElD,oBAAY,oBAAoB;IAC9B,MAAM,YAAY;IAClB,QAAQ,cAAc;IACtB,SAAS,gBAAgB;IACzB,SAAS,gBAAgB;IACzB,mBAAmB,2BAA2B;CAC/C;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,MAAM,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,GAAG,aAAa,CAE9G;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,MAAM,IAAI,SAAS,GAAG,aAAa,CAErG;AAED,wBAAgB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/C;AACD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAOlF;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAQlF;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,UAWrC;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,MAAM,CA6BrF;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,YAiC5C;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,YAyCpC;AAED,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,OA8D9B;AAED,wBAAgB,IAAI,CAAC,CAAC,KAAA,YA2ZrB;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,CA2CrI;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,gBAAgB,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAAE,IACrH,SAAS,MAAM,EAAE,kBAAqB,kBAIrD;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,CAAA;CAAE,IACvG,YAAY,MAAM,EAAE,GAAG,MAAM,GAAG,EAAE,kBA6BjD;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,eAAe,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,GAAG,KAAK,GAAG,SAAS,CAQ5F;AAED;;;GAGG;AACH;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,GAAG,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAsB/E;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAExD;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,kBAAkB,EAAE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO;uBAoBpF,GAAG,EAAE;0BAKF,GAAG,EAAE;+BAMA,GAAG,EAAE;uBAOb,GAAG,EAAE;4BAKA,GAAG,EAAE;wBAOT,GAAG,EAAE;6BAKA,GAAG,EAAE;wBAOV,GAAG,EAAE;;;EAalC;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG;cAI5B,GAAG,UAA0B,GAAG,OAAuB,GAAG;kBAFjF,GAAG;sBAEoB,GAAG;yBAA0B,GAAG;sBAAuB,GAAG;sCAS7D,GAAG,GAAG,IAAI;6CAUH,GAAG,GAAG,IAAI;2BAU5B,GAAG;iCAQG,GAAG;;EAQ/B"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAA;AAC1D,OAAO,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AACxD;;;;;;;;GAQG;AACH;;;;;;;;;GASG;AAEH,eAAO,MAAM,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAoD3D,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CA2KtD,CAAA;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,GAAG,CA2rBlG;AA+BD,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,GAAG,GAAG,GAAG,CAelH;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;CAQrB,CAAA;AAEV;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;CAQvB,CAAA;AAEV;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,MAAM,CAyEnF;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,CAAC,EAAE,cAAc,GAAG,qBAAqB,CAK3E;AAGD;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,GAAG,EAAE,cAAc,EAAE,GAAG,GAAG,GAAG,CA2B9E"}