node-switchbot 2.5.0-beta.0 → 2.5.0-beta.10

package/dist/settings.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Switchbot BLE API registration settings.
+ *
+ * © 2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
+ */
 export declare const SERV_UUID_PRIMARY = "cba20d00224d11e69fb80002a5d5c51b";
 export declare const CHAR_UUID_WRITE = "cba20002224d11e69fb80002a5d5c51b";
 export declare const CHAR_UUID_NOTIFY = "cba20003224d11e69fb80002a5d5c51b";
@@ -5,4 +10,22 @@ export declare const CHAR_UUID_DEVICE = "2a00";
 export declare const READ_TIMEOUT_MSEC = 3000;
 export declare const WRITE_TIMEOUT_MSEC = 3000;
 export declare const COMMAND_TIMEOUT_MSEC = 3000;
+export declare enum WoSmartLockProCommands {
+    GET_CKIV = "570f2103",
+    LOCK_INFO = "570f4f8102",
+    UNLOCK = "570f4e0101000080",
+    UNLOCK_NO_UNLATCH = "570f4e01010000a0",
+    LOCK = "570f4e0101000000",
+    ENABLE_NOTIFICATIONS = "570e01001e00008101",
+    DISABLE_NOTIFICATIONS = "570e00"
+}
+export declare enum WoSmartLockCommands {
+    GET_CKIV = "570f2103",
+    LOCK_INFO = "570f4f8101",
+    UNLOCK = "570f4e01011080",
+    UNLOCK_NO_UNLATCH = "570f4e010110a0",
+    LOCK = "570f4e01011000",
+    ENABLE_NOTIFICATIONS = "570e01001e00008101",
+    DISABLE_NOTIFICATIONS = "570e00"
+}
 //# sourceMappingURL=settings.d.ts.map

package/dist/settings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,iBAAiB,qCAAqC,CAAA;AACnE,eAAO,MAAM,eAAe,qCAAqC,CAAA;AACjE,eAAO,MAAM,gBAAgB,qCAAqC,CAAA;AAClE,eAAO,MAAM,gBAAgB,SAAS,CAAA;AACtC,eAAO,MAAM,iBAAiB,OAAO,CAAA;AACrC,eAAO,MAAM,kBAAkB,OAAO,CAAA;AACtC,eAAO,MAAM,oBAAoB,OAAO,CAAA"}
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,eAAO,MAAM,iBAAiB,qCAAqC,CAAA;AACnE,eAAO,MAAM,eAAe,qCAAqC,CAAA;AACjE,eAAO,MAAM,gBAAgB,qCAAqC,CAAA;AAClE,eAAO,MAAM,gBAAgB,SAAS,CAAA;AAEtC,eAAO,MAAM,iBAAiB,OAAO,CAAA;AACrC,eAAO,MAAM,kBAAkB,OAAO,CAAA;AACtC,eAAO,MAAM,oBAAoB,OAAO,CAAA;AAExC,oBAAY,sBAAsB;IAChC,QAAQ,aAAa;IACrB,SAAS,eAAe;IACxB,MAAM,qBAAqB;IAC3B,iBAAiB,qBAAqB;IACtC,IAAI,qBAAqB;IACzB,oBAAoB,uBAAuB;IAC3C,qBAAqB,WAAW;CACjC;AAED,oBAAY,mBAAmB;IAC7B,QAAQ,aAAa;IACrB,SAAS,eAAe;IACxB,MAAM,mBAAmB;IACzB,iBAAiB,mBAAmB;IACpC,IAAI,mBAAmB;IACvB,oBAAoB,uBAAuB;IAC3C,qBAAqB,WAAW;CACjC"}

package/dist/settings.js

@@ -1,6 +1,7 @@
-/* Copyright(C) 2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
+/**
+ * Switchbot BLE API registration settings.
  *
- * settings.ts: Switchbot BLE API registration.
+ * © 2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
  */
 export const SERV_UUID_PRIMARY = 'cba20d00224d11e69fb80002a5d5c51b';
 export const CHAR_UUID_WRITE = 'cba20002224d11e69fb80002a5d5c51b';
@@ -9,4 +10,24 @@ export const CHAR_UUID_DEVICE = '2a00';
 export const READ_TIMEOUT_MSEC = 3000;
 export const WRITE_TIMEOUT_MSEC = 3000;
 export const COMMAND_TIMEOUT_MSEC = 3000;
+export var WoSmartLockProCommands;
+(function (WoSmartLockProCommands) {
+    WoSmartLockProCommands["GET_CKIV"] = "570f2103";
+    WoSmartLockProCommands["LOCK_INFO"] = "570f4f8102";
+    WoSmartLockProCommands["UNLOCK"] = "570f4e0101000080";
+    WoSmartLockProCommands["UNLOCK_NO_UNLATCH"] = "570f4e01010000a0";
+    WoSmartLockProCommands["LOCK"] = "570f4e0101000000";
+    WoSmartLockProCommands["ENABLE_NOTIFICATIONS"] = "570e01001e00008101";
+    WoSmartLockProCommands["DISABLE_NOTIFICATIONS"] = "570e00";
+})(WoSmartLockProCommands || (WoSmartLockProCommands = {}));
+export var WoSmartLockCommands;
+(function (WoSmartLockCommands) {
+    WoSmartLockCommands["GET_CKIV"] = "570f2103";
+    WoSmartLockCommands["LOCK_INFO"] = "570f4f8101";
+    WoSmartLockCommands["UNLOCK"] = "570f4e01011080";
+    WoSmartLockCommands["UNLOCK_NO_UNLATCH"] = "570f4e010110a0";
+    WoSmartLockCommands["LOCK"] = "570f4e01011000";
+    WoSmartLockCommands["ENABLE_NOTIFICATIONS"] = "570e01001e00008101";
+    WoSmartLockCommands["DISABLE_NOTIFICATIONS"] = "570e00";
+})(WoSmartLockCommands || (WoSmartLockCommands = {}));
 //# sourceMappingURL=settings.js.map

package/dist/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,kCAAkC,CAAA;AACnE,MAAM,CAAC,MAAM,eAAe,GAAG,kCAAkC,CAAA;AACjE,MAAM,CAAC,MAAM,gBAAgB,GAAG,kCAAkC,CAAA;AAClE,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAA;AACtC,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,CAAA;AACrC,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAA;AACtC,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,CAAA"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,CAAC,MAAM,iBAAiB,GAAG,kCAAkC,CAAA;AACnE,MAAM,CAAC,MAAM,eAAe,GAAG,kCAAkC,CAAA;AACjE,MAAM,CAAC,MAAM,gBAAgB,GAAG,kCAAkC,CAAA;AAClE,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAA;AAEtC,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,CAAA;AACrC,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAA;AACtC,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,CAAA;AAExC,MAAM,CAAN,IAAY,sBAQX;AARD,WAAY,sBAAsB;IAChC,+CAAqB,CAAA;IACrB,kDAAwB,CAAA;IACxB,qDAA2B,CAAA;IAC3B,gEAAsC,CAAA;IACtC,mDAAyB,CAAA;IACzB,qEAA2C,CAAA;IAC3C,0DAAgC,CAAA;AAClC,CAAC,EARW,sBAAsB,KAAtB,sBAAsB,QAQjC;AAED,MAAM,CAAN,IAAY,mBAQX;AARD,WAAY,mBAAmB;IAC7B,4CAAqB,CAAA;IACrB,+CAAwB,CAAA;IACxB,gDAAyB,CAAA;IACzB,2DAAoC,CAAA;IACpC,8CAAuB,CAAA;IACvB,kEAA2C,CAAA;IAC3C,uDAAgC,CAAA;AAClC,CAAC,EARW,mBAAmB,KAAnB,mBAAmB,QAQ9B"}

package/dist/switchbot.d.ts

@@ -1,50 +1,83 @@
-import type * as Noble from '@stoprocent/noble';
-import type { Ad } from './advertising.js';
-import type { Params } from './types/types.js';
+import type { Ad, Params } from './types/types.js';
+import * as Noble from '@stoprocent/noble';
 import { SwitchbotDevice } from './device.js';
+/**
+ * SwitchBot class to interact with SwitchBot devices.
+ */
 export declare class SwitchBot {
     private ready;
     noble: typeof Noble;
     ondiscover?: (device: SwitchbotDevice) => void;
     onadvertisement?: (ad: Ad) => void;
-    onlog: ((message: string) => void) | undefined;
+    onlog?: (message: string) => void;
     DEFAULT_DISCOVERY_DURATION: number;
-    PRIMARY_SERVICE_UUID_LIST: never[];
+    PRIMARY_SERVICE_UUID_LIST: string[];
+    /**
+     * Constructor
+     *
+     * @param {Params} [params] - Optional parameters
+     * @param {typeof Noble} [params.noble] - Optional noble instance
+     */
     constructor(params?: Params);
+    /**
+     * Initializes the noble object.
+     *
+     * @param {Params} [params] - Optional parameters
+     * @param {typeof Noble} [params.noble] - Optional noble instance
+     * @returns {Promise<void>} - Resolves when initialization is complete
+     */
     init(params?: Params): Promise<void>;
     /**
-     * Initiates BLE discovery for SwitchBot devices, scanning for those matching specified criteria.
-     * This async operation looks for devices by model or ID within a set duration.
-     *
-     * @param params An optional object with properties:
-     * - duration: Discovery time in milliseconds (1 to 60000, default 5000).
-     * - model: String specifying device type to discover, with each character representing a model:
-     * - "H": Bots
-     * - "T": Meters
-     * - "e": Humidifiers
-     * - "s": Motion Sensors
-     * - "d": Contact Sensors
-     * - "c": Curtains
-     * - "{": Curtain 3
-     * - "u": Color Bulbs
-     * - "g": Plugs
-     * - "o": Locks
-     * - "$": Lock Pros
-     * - "i": Meter Pluses
-     * - "r": Locks (Duplicate, possibly an error)
-     * - id: Optional device ID (MAC address) to discover, case-insensitive, ignores colons.
-     * - quick: If true, stops discovery upon first match, not waiting full duration. Defaults to false.
-     *
-     * @returns Promise resolving to an array of `SwitchbotDevice` objects for discovered devices.
-     *
-     * @deprecated since version 2.4.0. Will be removed in version 3.0.0. Use getDeviceObjectAsync() instead.
-     */
-    discover(params?: Params): Promise<unknown>;
+     * Discover SwitchBot devices based on the provided parameters.
+     *
+     * @param {Params} params - The parameters for discovery.
+     * @returns {Promise<SwitchbotDevice[]>} - A promise that resolves with a list of discovered devices.
+     */
+    discover(params?: Params): Promise<SwitchbotDevice[]>;
+    /**
+     * Initializes the noble object and waits for it to be powered on.
+     *
+     * @returns {Promise<void>} - Resolves when the noble object is powered on.
+     */
     _init(): Promise<void>;
-    getDeviceObject(peripheral: Noble.Peripheral, id: string, model: string): Promise<SwitchbotDevice | null | undefined>;
+    /**
+     * Gets the device object based on the peripheral, id, and model.
+     *
+     * @param {Noble.Peripheral} peripheral - The peripheral object.
+     * @param {string} id - The device id.
+     * @param {string} model - The device model.
+     * @returns {Promise<SwitchbotDevice | null>} - The device object or null.
+     */
+    getDeviceObject(peripheral: Noble.Peripheral, id: string, model: string): Promise<SwitchbotDevice | null>;
+    /**
+     * Filters advertising data based on id and model.
+     *
+     * @param {Ad} ad - The advertising data.
+     * @param {string} id - The device id.
+     * @param {string} model - The device model.
+     * @returns {boolean} - True if the advertising data matches the id and model, false otherwise.
+     */
     filterAdvertising(ad: Ad, id: string, model: string): boolean;
+    /**
+     * Starts scanning for SwitchBot devices.
+     *
+     * @param {Params} [params] - Optional parameters.
+     * @returns {Promise<void>} - Resolves when scanning starts successfully.
+     */
     startScan(params?: Params): Promise<void>;
-    wait(msec: number): Promise<unknown>;
+    /**
+     * Stops scanning for SwitchBot devices.
+     *
+     * @returns {Promise<void>} - Resolves when scanning stops successfully.
+     */
+    stopScan(): Promise<void>;
+    /**
+     * Waits for the specified time.
+     *
+     * @param {number} msec - The time to wait in milliseconds.
+     * @returns {Promise<void>} - Resolves after the specified time.
+     */
+    wait(msec: number): Promise<void>;
 }
 export { SwitchbotDevice };
 //# sourceMappingURL=switchbot.d.ts.map

package/dist/switchbot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"switchbot.d.ts","sourceRoot":"","sources":["../src/switchbot.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,KAAK,MAAM,mBAAmB,CAAA;AAE/C,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAA;AAC1C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAG9C,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAmB7C,qBAAa,SAAS;IACpB,OAAO,CAAC,KAAK,CAAe;IAC5B,KAAK,EAAG,OAAO,KAAK,CAAA;IACpB,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,CAAA;IAC9C,eAAe,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,IAAI,CAAA;IAClC,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC,GAAG,SAAS,CAAA;IAC9C,0BAA0B,SAAO;IACjC,yBAAyB,UAAK;gBAYlB,MAAM,CAAC,EAAE,MAAM;IAKrB,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM;IAY1B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CAAC,MAAM,GAAE,MAAW;IAoGtB,KAAK;IAuCL,eAAe,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAqE7E,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAgFnD,SAAS,CAAC,MAAM,GAAE,MAAW;IAgG7B,IAAI,CAAC,IAAI,EAAE,MAAM;CAmBlB;AAED,OAAO,EAAE,eAAe,EAAE,CAAA"}
+{"version":3,"file":"switchbot.d.ts","sourceRoot":"","sources":["../src/switchbot.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAElD,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAA;AAG1C,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAmB7C;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,KAAK,CAAe;IAC5B,KAAK,EAAG,OAAO,KAAK,CAAA;IACpB,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,CAAA;IAC9C,eAAe,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,IAAI,CAAA;IAClC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;IACjC,0BAA0B,SAAO;IACjC,yBAAyB,EAAE,MAAM,EAAE,CAAK;IAExC;;;;;OAKG;gBACS,MAAM,CAAC,EAAE,MAAM;IAI3B;;;;;;OAMG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1C;;;;;OAKG;IACG,QAAQ,CAAC,MAAM,GAAE,MAAW,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IA2D/D;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAsB5B;;;;;;;OAOG;IACG,eAAe,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAgC/G;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IAoB7D;;;;;OAKG;IACG,SAAS,CAAC,MAAM,GAAE,MAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAiCnD;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAS/B;;;;;OAKG;IACG,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAexC;AAED,OAAO,EAAE,eAAe,EAAE,CAAA"}