node-switchbot 2.5.0-beta.3 → 2.5.0-beta.30

package/dist/device/wostrip.js

@@ -1,174 +1,128 @@
 import { Buffer } from 'node:buffer';
-/* Copyright(C) 2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
- *
- * wostrip.ts: Switchbot BLE API registration.
- */
 import { SwitchbotDevice } from '../device.js';
 import { SwitchBotBLEModel, SwitchBotBLEModelFriendlyName, SwitchBotBLEModelName } from '../types/types.js';
 /**
- * @see https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/colorbulb.md
+ * Class representing a WoStrip device.
+ * @see https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/ledstriplight.md
  */
 export class WoStrip extends SwitchbotDevice {
+    /**
+     * Parses the service data from the SwitchBot Strip Light.
+     * @param {Buffer} serviceData - The service data buffer.
+     * @param {(message: string) => void} [onlog] - Optional logging function.
+     * @returns {Promise<stripLightServiceData | null>} - Parsed service data or null if invalid.
+     */
     static async parseServiceData(serviceData, onlog) {
         if (serviceData.length !== 18) {
-            if (onlog && typeof onlog === 'function') {
-                onlog(`[parseServiceDataForWoStrip] Buffer length ${serviceData.length} !== 18!`);
-            }
+            onlog?.(`[parseServiceDataForWoStrip] Buffer length ${serviceData.length} !== 18!`);
             return null;
         }
-        // const byte1 = serviceData.readUInt8(1)// power and light status
-        // const byte2 = serviceData.readUInt8(2)// bulb brightness
-        const byte3 = serviceData.readUInt8(3); // bulb R
-        const byte4 = serviceData.readUInt8(4); // bulb G
-        const byte5 = serviceData.readUInt8(5); // bulb B
-        const byte7 = serviceData.readUInt8(7);
-        const byte8 = serviceData.readUInt8(8);
-        const byte9 = serviceData.readUInt8(9);
-        const byte10 = serviceData.readUInt8(10);
-        const power = !!(byte7 & 0b10000000);
-        const state = !!(byte7 & 0b10000000);
-        const brightness = byte7 & 0b01111111;
-        const red = byte3;
-        const green = byte4;
-        const blue = byte5;
-        const delay = byte8 & 0b10000000;
-        const preset = byte8 & 0b00001000;
-        const color_mode = byte8 & 0b00000111;
-        const speed = byte9 & 0b01111111;
-        const loop_index = byte10 & 0b11111110;
+        const [byte3, byte4, byte5, byte7, byte8, byte9, byte10] = [
+            serviceData.readUInt8(3),
+            serviceData.readUInt8(4),
+            serviceData.readUInt8(5),
+            serviceData.readUInt8(7),
+            serviceData.readUInt8(8),
+            serviceData.readUInt8(9),
+            serviceData.readUInt8(10),
+        ];
         const data = {
             model: SwitchBotBLEModel.StripLight,
             modelName: SwitchBotBLEModelName.StripLight,
             modelFriendlyName: SwitchBotBLEModelFriendlyName.StripLight,
-            power,
-            state,
-            brightness,
-            red,
-            green,
-            blue,
-            delay,
-            preset,
-            color_mode,
-            speed,
-            loop_index,
+            power: !!(byte7 & 0b10000000),
+            state: !!(byte7 & 0b10000000),
+            brightness: byte7 & 0b01111111,
+            red: byte3,
+            green: byte4,
+            blue: byte5,
+            delay: byte8 & 0b10000000,
+            preset: byte8 & 0b00001000,
+            color_mode: byte8 & 0b00000111,
+            speed: byte9 & 0b01111111,
+            loop_index: byte10 & 0b11111110,
         };
         return data;
     }
     /**
-     * @returns resolves with a boolean that tells whether the plug in ON(true) or OFF(false)
+     * Reads the state of the strip light.
+     * @returns {Promise<boolean>} - Resolves with true if the strip light is ON, false otherwise.
      */
     async readState() {
-        return await this.operateStripLight([0x57, 0x0F, 0x4A, 0x01]);
+        return this.operateStripLight([0x57, 0x0F, 0x4A, 0x01]);
     }
     /**
-     * @private
+     * Sets the state of the strip light.
+     * @public
+     * @param {number[]} reqByteArray - The request byte array.
+     * @returns {Promise<boolean>} - Resolves with true if the operation was successful.
      */
     async setState(reqByteArray) {
         const base = [0x57, 0x0F, 0x49, 0x01];
-        return await this.operateStripLight([...base, ...reqByteArray]);
+        return this.operateStripLight([...base, ...reqByteArray]);
     }
     /**
-     * @returns resolves with a boolean that tells whether the plug in ON(true) or OFF(false)
+     * Turns the strip light on.
+     * @returns {Promise<boolean>} - Resolves with true if the strip light is ON.
      */
     async turnOn() {
-        return await this.setState([0x01, 0x01]);
+        return this.setState([0x01, 0x01]);
     }
     /**
-     * @returns resolves with a boolean that tells whether the plug in ON(true) or OFF(false)
+     * Turns the strip light off.
+     * @returns {Promise<boolean>} - Resolves with true if the strip light is OFF.
      */
     async turnOff() {
-        return await this.setState([0x01, 0x02]);
+        return this.setState([0x01, 0x02]);
     }
     /**
-     * @returns resolves with brightness percent
+     * Sets the brightness of the strip light.
+     * @param {number} brightness - The brightness percentage (0-100).
+     * @returns {Promise<boolean>} - Resolves with true if the operation was successful.
      */
     async setBrightness(brightness) {
-        if (typeof brightness !== 'number') {
-            throw new TypeError(`The type of target brightness percentage is incorrect: ${typeof brightness}`);
-        }
-        if (brightness > 100) {
-            brightness = 100;
-        }
-        else if (brightness < 0) {
-            brightness = 0;
-        }
-        return await this.setState([0x02, 0x14]);
-    }
-    /**
-     * @returns resolves with color temperature
-     */
-    async setColorTemperature(color_temperature) {
-        if (color_temperature) {
-            throw new Error(`Strip Light Doesn't Support Color temperature: ${typeof color_temperature}`);
+        if (typeof brightness !== 'number' || brightness < 0 || brightness > 100) {
+            throw new TypeError(`Invalid brightness value: ${brightness}`);
         }
+        return this.setState([0x02, 0x14, brightness]);
     }
     /**
-     * @returns resolves with brightness + rgb
+     * Sets the RGB values of the strip light.
+     * @param {number} brightness - The brightness percentage (0-100).
+     * @param {number} red - The red value (0-255).
+     * @param {number} green - The green value (0-255).
+     * @param {number} blue - The blue value (0-255).
+     * @returns {Promise<boolean>} - Resolves with true if the operation was successful.
      */
     async setRGB(brightness, red, green, blue) {
-        if (typeof brightness !== 'number') {
-            throw new TypeError(`The type of target brightness percentage is incorrect: ${typeof brightness}`);
-        }
-        if (typeof red !== 'number') {
-            throw new TypeError(`The type of target red is incorrect: ${typeof red}`);
-        }
-        if (typeof green !== 'number') {
-            throw new TypeError(`The type of target green is incorrect: ${typeof green}`);
-        }
-        if (typeof blue !== 'number') {
-            throw new TypeError(`The type of target blue is incorrect: ${typeof blue}`);
-        }
-        if (brightness > 100) {
-            brightness = 100;
-        }
-        else if (brightness < 0) {
-            brightness = 0;
-        }
-        if (red > 255) {
-            red = 255;
-        }
-        else if (red < 0) {
-            red = 0;
-        }
-        if (green > 255) {
-            green = 255;
-        }
-        else if (green < 0) {
-            green = 0;
-        }
-        if (blue > 255) {
-            blue = 255;
-        }
-        else if (blue < 0) {
-            blue = 0;
-        }
-        return await this.setState([0x02, 0x12, brightness, red, green, blue]);
+        if (![brightness, red, green, blue].every(val => typeof val === 'number')) {
+            throw new TypeError('Invalid RGB or brightness value');
+        }
+        brightness = Math.max(0, Math.min(100, brightness));
+        red = Math.max(0, Math.min(255, red));
+        green = Math.max(0, Math.min(255, green));
+        blue = Math.max(0, Math.min(255, blue));
+        return this.setState([0x02, 0x12, brightness, red, green, blue]);
     }
     /**
-     * @private
+     * Operates the strip light with the given byte array.
+     * @public
+     * @param {number[]} bytes - The byte array to send.
+     * @returns {Promise<boolean>} - Resolves with true if the operation was successful.
      */
     async operateStripLight(bytes) {
         const req_buf = Buffer.from(bytes);
-        await this.command(req_buf)
-            .then((res_bytes) => {
-            const res_buf = Buffer.from(res_bytes);
-            if (res_buf.length === 2) {
-                const code = res_buf.readUInt8(1);
-                if (code === 0x00 || code === 0x80) {
-                    const is_on = code === 0x80;
-                    return is_on;
-                }
-                else {
-                    throw new Error(`The device returned an error: 0x${res_buf.toString('hex')}`);
-                }
-            }
-            else {
-                throw new Error(`Expecting a 2-byte response, got instead: 0x${res_buf.toString('hex')}`);
-            }
-        })
-            .catch((error) => {
-            throw error;
-        });
+        const res_buf = await this.command(req_buf);
+        if (res_buf.length !== 2) {
+            throw new Error(`Expecting a 2-byte response, got instead: 0x${res_buf.toString('hex')}`);
+        }
+        const code = res_buf.readUInt8(1);
+        if (code === 0x00 || code === 0x80) {
+            return code === 0x80;
+        }
+        else {
+            throw new Error(`The device returned an error: 0x${res_buf.toString('hex')}`);
+        }
     }
 }
 //# sourceMappingURL=wostrip.js.map

package/dist/device/wostrip.js.map

@@ -1 +1 @@
-{"version":3,"file":"wostrip.js","sourceRoot":"","sources":["../../src/device/wostrip.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC;;;GAGG;AACH,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,EAAE,iBAAiB,EAAE,6BAA6B,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AAE3G;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,eAAe;IAC1C,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAC3B,WAAmB,EACnB,KAA8C;QAE9C,IAAI,WAAW,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAC9B,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;gBACzC,KAAK,CAAC,8CAA8C,WAAW,CAAC,MAAM,UAAU,CAAC,CAAA;YACnF,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC;QAED,kEAAkE;QAClE,2DAA2D;QAC3D,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA,CAAA,SAAS;QAC/C,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA,CAAA,SAAS;QAC/C,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA,CAAA,SAAS;QAC/C,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QACtC,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QACtC,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QACtC,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;QAExC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,UAAU,CAAC,CAAA;QACpC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,UAAU,CAAC,CAAA;QACpC,MAAM,UAAU,GAAG,KAAK,GAAG,UAAU,CAAA;QACrC,MAAM,GAAG,GAAG,KAAK,CAAA;QACjB,MAAM,KAAK,GAAG,KAAK,CAAA;QACnB,MAAM,IAAI,GAAG,KAAK,CAAA;QAClB,MAAM,KAAK,GAAG,KAAK,GAAG,UAAU,CAAA;QAChC,MAAM,MAAM,GAAG,KAAK,GAAG,UAAU,CAAA;QACjC,MAAM,UAAU,GAAG,KAAK,GAAG,UAAU,CAAA;QACrC,MAAM,KAAK,GAAG,KAAK,GAAG,UAAU,CAAA;QAChC,MAAM,UAAU,GAAG,MAAM,GAAG,UAAU,CAAA;QAEtC,MAAM,IAAI,GAA0B;YAClC,KAAK,EAAE,iBAAiB,CAAC,UAAU;YACnC,SAAS,EAAE,qBAAqB,CAAC,UAAU;YAC3C,iBAAiB,EAAE,6BAA6B,CAAC,UAAU;YAC3D,KAAK;YACL,KAAK;YACL,UAAU;YACV,GAAG;YACH,KAAK;YACL,IAAI;YACJ,KAAK;YACL,MAAM;YACN,UAAU;YACV,KAAK;YACL,UAAU;SACX,CAAA;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS;QACb,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;IAC/D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,YAAsB;QACnC,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QACrC,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,YAAY,CAAC,CAAC,CAAA;IACjE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACV,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;IAC1C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;IAC1C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,UAAkB;QACpC,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YACnC,MAAM,IAAI,SAAS,CAAC,0DAA0D,OAAO,UAAU,EAAE,CAAC,CAAA;QACpG,CAAC;QACD,IAAI,UAAU,GAAG,GAAG,EAAE,CAAC;YACrB,UAAU,GAAG,GAAG,CAAA;QAClB,CAAC;aAAM,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YAC1B,UAAU,GAAG,CAAC,CAAA;QAChB,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;IAC1C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB,CAAC,iBAA0B;QAClD,IAAI,iBAAiB,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,kDAAkD,OAAO,iBAAiB,EAAE,CAAC,CAAA;QAC/F,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,UAAkB,EAAE,GAAW,EAAE,KAAa,EAAE,IAAY;QACvE,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YACnC,MAAM,IAAI,SAAS,CAAC,0DAA0D,OAAO,UAAU,EAAE,CAAC,CAAA;QACpG,CAAC;QACD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,MAAM,IAAI,SAAS,CAAC,wCAAwC,OAAO,GAAG,EAAE,CAAC,CAAA;QAC3E,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,IAAI,SAAS,CAAC,0CAA0C,OAAO,KAAK,EAAE,CAAC,CAAA;QAC/E,CAAC;QACD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,MAAM,IAAI,SAAS,CAAC,yCAAyC,OAAO,IAAI,EAAE,CAAC,CAAA;QAC7E,CAAC;QACD,IAAI,UAAU,GAAG,GAAG,EAAE,CAAC;YACrB,UAAU,GAAG,GAAG,CAAA;QAClB,CAAC;aAAM,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YAC1B,UAAU,GAAG,CAAC,CAAA;QAChB,CAAC;QACD,IAAI,GAAG,GAAG,GAAG,EAAE,CAAC;YACd,GAAG,GAAG,GAAG,CAAA;QACX,CAAC;aAAM,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACnB,GAAG,GAAG,CAAC,CAAA;QACT,CAAC;QACD,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;YAChB,KAAK,GAAG,GAAG,CAAA;QACb,CAAC;aAAM,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACrB,KAAK,GAAG,CAAC,CAAA;QACX,CAAC;QACD,IAAI,IAAI,GAAG,GAAG,EAAE,CAAC;YACf,IAAI,GAAG,GAAG,CAAA;QACZ,CAAC;aAAM,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;YACpB,IAAI,GAAG,CAAC,CAAA;QACV,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;IACxE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB,CAAC,KAAe;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAClC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;aACxB,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;YAClB,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YACtC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACzB,MAAM,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;gBACjC,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBACnC,MAAM,KAAK,GAAG,IAAI,KAAK,IAAI,CAAA;oBAC3B,OAAO,KAAK,CAAA;gBACd,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CAAC,mCAAmC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;gBAC/E,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,+CAA+C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;YAC3F,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,KAAK,CAAA;QACb,CAAC,CAAC,CAAA;IACN,CAAC;CACF"}
+{"version":3,"file":"wostrip.js","sourceRoot":"","sources":["../../src/device/wostrip.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,EAAE,iBAAiB,EAAE,6BAA6B,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AAE3G;;;GAGG;AACH,MAAM,OAAO,OAAQ,SAAQ,eAAe;IAC1C;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAC3B,WAAmB,EACnB,KAAiC;QAEjC,IAAI,WAAW,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAC9B,KAAK,EAAE,CAAC,8CAA8C,WAAW,CAAC,MAAM,UAAU,CAAC,CAAA;YACnF,OAAO,IAAI,CAAA;QACb,CAAC;QAED,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG;YACzD,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YACxB,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YACxB,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YACxB,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YACxB,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YACxB,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YACxB,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;SAC1B,CAAA;QAED,MAAM,IAAI,GAA0B;YAClC,KAAK,EAAE,iBAAiB,CAAC,UAAU;YACnC,SAAS,EAAE,qBAAqB,CAAC,UAAU;YAC3C,iBAAiB,EAAE,6BAA6B,CAAC,UAAU;YAC3D,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,UAAU,CAAC;YAC7B,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,UAAU,CAAC;YAC7B,UAAU,EAAE,KAAK,GAAG,UAAU;YAC9B,GAAG,EAAE,KAAK;YACV,KAAK,EAAE,KAAK;YACZ,IAAI,EAAE,KAAK;YACX,KAAK,EAAE,KAAK,GAAG,UAAU;YACzB,MAAM,EAAE,KAAK,GAAG,UAAU;YAC1B,UAAU,EAAE,KAAK,GAAG,UAAU;YAC9B,KAAK,EAAE,KAAK,GAAG,UAAU;YACzB,UAAU,EAAE,MAAM,GAAG,UAAU;SAChC,CAAA;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS;QACb,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;IACzD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAC,YAAsB;QAC1C,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QACrC,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,YAAY,CAAC,CAAC,CAAA;IAC3D,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;IACpC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;IACpC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,UAAkB;QACpC,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,UAAU,GAAG,CAAC,IAAI,UAAU,GAAG,GAAG,EAAE,CAAC;YACzE,MAAM,IAAI,SAAS,CAAC,6BAA6B,UAAU,EAAE,CAAC,CAAA;QAChE,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAA;IAChD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAC,UAAkB,EAAE,GAAW,EAAE,KAAa,EAAE,IAAY;QACvE,IAAI,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,EAAE,CAAC;YAC1E,MAAM,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAA;QACxD,CAAC;QAED,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAA;QACnD,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;QACrC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAA;QACzC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAA;QAEvC,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;IAClE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,iBAAiB,CAAC,KAAe;QAC5C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAClC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAE3C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,+CAA+C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QAC3F,CAAC;QAED,MAAM,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QACjC,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACnC,OAAO,IAAI,KAAK,IAAI,CAAA;QACtB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,mCAAmC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QAC/E,CAAC;IACH,CAAC;CACF"}

package/dist/device.d.ts

@@ -1,254 +1,117 @@
-import { Buffer } from 'node:buffer';
 import type * as Noble from '@stoprocent/noble';
-import type { SwitchBotBLEModel, SwitchBotBLEModelName } from './types/types.js';
-type Chars = {
-    write: Noble.Characteristic | null;
-    notify: Noble.Characteristic | null;
-    device: Noble.Characteristic | null;
-} | null;
+import type { Chars, SwitchBotBLEModel, SwitchBotBLEModelName } from './types/types.js';
+import { Buffer } from 'node:buffer';
+/**
+ * Represents a Switchbot Device.
+ */
 export declare class SwitchbotDevice {
-    _noble: typeof Noble;
-    _peripheral: Noble.Peripheral;
-    _characteristics: Chars | null;
-    _id: string;
-    _address: any;
-    _model: SwitchBotBLEModel;
-    _modelName: SwitchBotBLEModelName;
-    _explicitly: boolean;
-    _connected: boolean;
-    onnotify_internal: any;
-    ondisconnect_internal: () => void;
-    onconnect_internal: () => Promise<void>;
-    /**
-     * Constructor for the Device class.
-     *
-     * @param {object} peripheral - The `peripheral` object from noble, representing this device.
-     * @param {Noble} noble - The Noble object created by the noble module.
-     *
-     * This constructor initializes a new instance of the Device class with the specified peripheral and noble objects.
+    private _noble;
+    private _peripheral;
+    private _characteristics;
+    private _id;
+    private _address;
+    private _model;
+    private _modelName;
+    private _explicitly;
+    private _connected;
+    private onnotify_internal;
+    private ondisconnect_internal;
+    private onconnect_internal;
+    /**
+     * Initializes a new instance of the SwitchbotDevice class.
+     * @param peripheral The peripheral object from noble.
+     * @param noble The Noble object.
      */
     constructor(peripheral: Noble.Peripheral, noble: typeof Noble);
     get id(): string;
     get address(): string;
-    get model(): string;
-    get modelName(): string;
+    get model(): SwitchBotBLEModel;
+    get modelName(): SwitchBotBLEModelName;
     get connectionState(): string;
-    get onconnect(): () => Promise<void> | void;
-    /**
-     * Sets the asynchronous connection handler.
-     *
-     * This setter assigns a function to be used as the asynchronous connection handler. The handler
-     * is expected to be a function that returns a Promise, which resolves once the connection process
-     * is complete. The resolution of the Promise does not carry any value.
-     *
-     * @param func A function that returns a Promise, representing the asynchronous operation of connecting.
-     * This function is expected to be called without any arguments.
-     * @throws Error if the provided argument is not a function, ensuring type safety.
-     */
-    set onconnect(func: () => Promise<void> | void);
-    get ondisconnect(): () => Promise<void> | void;
-    /**
-     * Sets the asynchronous disconnection handler.
-     *
-     * This setter configures a function to act as the asynchronous disconnection handler. The handler
-     * should be a function that returns a Promise, which resolves when the disconnection process
-     * is complete. The resolution of the Promise does not carry any value.
-     *
-     * @param func A function that returns a Promise, representing the asynchronous operation of disconnecting.
-     * This function is expected to be called without any arguments.
-     * @throws Error if the provided argument is not a function, to ensure that the handler is correctly typed.
-     */
-    set ondisconnect(func: () => Promise<void> | void);
-    /**
-     * Initiates an asynchronous connection process.
-     *
-     * This method marks the device as being connected explicitly by setting a flag, then proceeds
-     * to initiate the actual connection process by calling an internal asynchronous method `connect_internalAsync`.
-     * The `connect_internalAsync` method is responsible for handling the low-level connection logic.
-     *
-     * @returns A Promise that resolves when the connection process initiated by `connect_internalAsync` completes.
-     * The resolution of this Promise does not carry any value, indicating that the focus is on
-     * the completion of the connection process rather than the result of the connection itself.
+    get onconnect(): () => Promise<void>;
+    set onconnect(func: () => Promise<void>);
+    get ondisconnect(): () => Promise<void>;
+    set ondisconnect(func: () => Promise<void>);
+    /**
+     * Connects to the device.
+     * @returns A Promise that resolves when the connection is complete.
      */
     connect(): Promise<void>;
     /**
-     * Initiates the device connection process.
-     *
-     * This method is marked as deprecated and is scheduled for removal in a future version. It is recommended
-     * to use `disconnectAsync()` instead. The method returns a Promise that resolves when the device is successfully
-     * connected or rejects if the connection cannot be established.
-     *
-     * The connection process involves several steps:
-     * 1. Checks the Bluetooth adapter's state. If it's not powered on, the promise is rejected.
-     * 2. Checks the current connection state of the device. If already connected, the promise resolves immediately.
-     *    If in the process of connecting or disconnecting, the promise is rejected advising to wait.
-     * 3. Sets up event handlers for 'connect' and 'disconnect' events on the peripheral device to manage connection state.
-     * 4. Initiates the connection. If an error occurs during this step, the promise is rejected.
-     * 5. Once connected, retrieves the device's characteristics and subscribes to them. If this process fails, the device
-     *    is disconnected, and the promise is rejected.
-     *
-     * @returns A Promise<void> that resolves when the device is connected or rejects with an error.
-     */
-    connect_internal(): Promise<void>;
+     * Internal method to handle the connection process.
+     * @returns A Promise that resolves when the connection is complete.
+     */
+    private connect_internal;
+    /**
+     * Retrieves the device characteristics.
+     * @returns A Promise that resolves with the device characteristics.
+     */
     getCharacteristics(): Promise<Chars>;
+    /**
+     * Discovers the device services.
+     * @returns A Promise that resolves with the list of services.
+     */
     discoverServices(): Promise<Noble.Service[]>;
     /**
-     * Asynchronously discovers the characteristics of the specified service.
-     * This method is an asynchronous version of the deprecated `discoverCharacteristics` method.
-     * It attempts to discover the characteristics of the specified service and returns a Promise that resolves with the list of characteristics.
-     * If the discovery process fails, the Promise is rejected with an error.
-     * @param service The service object for which characteristics will be discovered.
-     * @returns A Promise that resolves with the list of characteristics or rejects with an error.
-     */
-    discoverCharacteristics(service: Noble.Service): Promise<Noble.Characteristic[]>;
-    subscribe(): Promise<void>;
-    /**
-     * Asynchronously unsubscribes from the device's notification characteristic.
-     *
-     * This method checks if the notification characteristic object exists within the cached characteristics
-     * (`this.chars`). If the characteristic is found, it proceeds to remove all event listeners attached to it
-     * to prevent any further handling of incoming data notifications. Then, it asynchronously unsubscribes from
-     * the notification characteristic using `unsubscribeAsync()`, effectively stopping the device from sending
-     * notifications to the client.
-     *
-     * If the notification characteristic is not found, the method simply returns without performing any action.
-     *
-     * @return A Promise that resolves to `void` upon successful unsubscription or if the characteristic is not found.
+     * Discovers the characteristics of a service.
+     * @param service The service to discover characteristics for.
+     * @returns A Promise that resolves with the list of characteristics.
+     */
+    private discoverCharacteristics;
+    /**
+     * Subscribes to the notify characteristic.
+     * @returns A Promise that resolves when the subscription is complete.
+     */
+    private subscribe;
+    /**
+     * Unsubscribes from the notify characteristic.
+     * @returns A Promise that resolves when the unsubscription is complete.
      */
     unsubscribe(): Promise<void>;
     /**
-     * Asynchronously disconnects from the device.
-     *
-     * This method handles the disconnection process by first checking the current
-     * connection state of the device. If the device is already disconnected, the
-     * method resolves immediately. If the device is in the process of connecting or
-     * disconnecting, it throws an error indicating that the operation should be retried
-     * after a brief wait. Otherwise, it proceeds to unsubscribe from any subscriptions
-     * and then initiates the disconnection process.
-     *
-     * Note: This method sets a flag to indicate that the disconnection was not initiated
-     * by the user explicitly.
-     *
-     * @returns A Promise that resolves when the disconnection process has completed.
-     * The Promise does not pass any value upon resolution.
+     * Disconnects from the device.
+     * @returns A Promise that resolves when the disconnection is complete.
      */
     disconnect(): Promise<void>;
     /**
-     * Disconnects from the device asynchronously if the connection was not initiated by the user.
-     *
-     * This method checks the `explicitly` flag to determine if the connection was initiated by the user.
-     * If not, it proceeds to disconnect from the device by calling `this.disconnectAsync()`. After the disconnection,
-     * it sets `explicitly` to true to prevent future disconnections when the connection is user-initiated.
-     *
-     * This approach ensures that automatic disconnections only occur when the user has not explicitly initiated the connection,
-     * avoiding unnecessary disconnections in user-initiated sessions.
-     *
-     * @returns A Promise that resolves once the device has been successfully disconnected, applicable only when the
-     * connection was not user-initiated.
-     */
-    disconnect_internal(): Promise<void>;
-    /**
-     * Asynchronously retrieves the device name.
-     * This method is designed to fetch the name of the device asynchronously and return it as a promise.
-     * It is marked as deprecated and will be removed in a future version. Use `getDeviceNameAsync` instead.
-     *
-     * @deprecated since version 2.4.0. Will be removed in version 3.0.0. Use `getDeviceNameAsync()` instead.
-     * @returns A Promise that resolves with the device name.
+     * Internal method to handle disconnection if not explicitly initiated.
+     * @returns A Promise that resolves when the disconnection is complete.
      */
-    getDeviceName(): Promise<void>;
+    private disconnect_internal;
     /**
-     * Asynchronously retrieves the device name.
-     * This method initiates a connection to the device, checks for the presence of a specific characteristic UUID,
-     * reads the characteristic to obtain the device name, and then disconnects from the device.
-     * It ensures that the device supports the required characteristic for fetching the name. If the characteristic
-     * is not supported, it throws an error. The method encapsulates the entire process of connecting, reading,
-     * and disconnecting, making it convenient to get the device name with a single call.
-     *
-     * @returns A Promise that resolves with the device name as a string.
+     * Retrieves the device name.
+     * @returns A Promise that resolves with the device name.
      */
-    getDeviceNameAsnyc(): Promise<string>;
+    getDeviceName(): Promise<string>;
     /**
-     * Asynchronously sets the device name to the specified value.
-     * Validates the new name to ensure it meets the criteria of being a string with a byte length between 1 and 100 bytes.
-     * If the validation fails, the promise is rejected with an error detailing the validation issue.
-     * Upon successful validation, the device name is updated, and the promise resolves without passing any value.
-     *
-     * @param name The new device name as a string. Must be 1 to 100 bytes in length.
-     * @returns A Promise that resolves to `void` upon successful update of the device name.
-     * @deprecated since version 2.4.0. Will be removed in version 3.0.0. Use `setDeviceNameAsync()` instead.
+     * Sets the device name.
+     * @param name The new device name.
+     * @returns A Promise that resolves when the name is set.
      */
     setDeviceName(name: string): Promise<void>;
     /**
-     * Asynchronously sets the device name to the specified value.
-     * This method begins by validating the provided name to ensure it meets the criteria of being a string with a byte length between 1 and 100 bytes.
-     * If the name does not pass validation, the method throws an error with a message detailing the validation issue.
-     * After passing validation, the method converts the name into a UTF-8 encoded buffer.
-     * It then initiates a connection to the device. If the device does not support the required characteristic UUID for setting the device name,
-     * an error is thrown indicating the lack of support.
-     * Upon successfully connecting and verifying support, the method writes the new name to the device using the appropriate characteristic.
-     * Finally, it disconnects from the device, completing the name update process.
-     *
-     * @param name The new device name as a string. Must be 1 to 100 bytes in length.
-     * @returns A Promise that resolves to `void` upon successful update of the device name.
-     */
-    setDeviceNameAsync(name: string): Promise<void>;
-    /**
-     * Asynchronously sends a command to the device and awaits a response.
-     * This method encapsulates the process of sending a command encapsulated in a Buffer to the device,
-     * and then waiting for the device to respond. The method ensures that the device is connected before sending the command,
-     * writes the command to the device's write characteristic, waits for a response on the notify characteristic,
-     * and finally disconnects from the device. The response from the device is returned as a Buffer.
-     *
-     * @param req_buf A Buffer containing the command to be sent to the device.
-     * @returns A Promise that resolves with a Buffer containing the device's response to the command.
+     * Sends a command to the device and awaits a response.
+     * @param req_buf The command buffer.
+     * @returns A Promise that resolves with the response buffer.
      */
     command(req_buf: Buffer): Promise<Buffer>;
     /**
      * Waits for a response from the device after sending a command.
-     * This method sets up a promise that resolves when a response is received from the device or rejects if a timeout occurs.
-     * A timer is started to enforce a command timeout. If the response is received before the timeout, the timer is cleared.
-     * The method sets an internal handler (`onnotify_internal`) to process the incoming response.
-     * If the response is not received within the specified timeout period, the promise is rejected with a 'COMMAND_TIMEOUT' error.
-     * Once a response is received or a timeout occurs, the internal handler is reset to an empty function to prevent memory leaks.
-     * @deprecated since version 2.4.0. Will be removed in version 3.0.0. Use `_waitCommandResponseAsync()` instead.
-     *
-     * @returns A Promise that resolves with the received Buffer or rejects with an error if a timeout occurs.
-     */
-    _waitCommandResponse(): Promise<Buffer>;
-    /**
-     * Asynchronously waits for a response from the device after sending a command.
-     * This method sets up a promise that resolves when a response is received from the device or rejects if a timeout occurs.
-     * A timer is started to enforce a command timeout. If the response is received before the timeout, the timer is cleared.
-     * The method sets an internal handler (`onnotify_internalAsync`) to process the incoming response.
-     * If the response is not received within the specified timeout period, the promise is rejected with a 'COMMAND_TIMEOUT' error.
-     * Once a response is received or a timeout occurs, the internal handler is reset to an empty function to prevent memory leaks.
-     *
-     * @returns A Promise that resolves with the received Buffer or rejects with an error if a timeout occurs.
-     */
-    _waitCommandResponseAsync(): Promise<Buffer>;
-    /**
-     * Asynchronously reads data from the specified characteristic of the device with a timeout.
-     * This method attempts to read data from the device's characteristic and sets a timeout to handle cases where the read operation takes too long.
-     * If the read operation does not complete within the specified timeout period, an error is thrown.
-     * Once the read operation completes successfully, the timeout is cleared to prevent it from triggering.
-     *
-     * @param char The characteristic of the device from which data will be read.
-     * @returns A Promise that resolves with the data read from the characteristic or rejects with an error if a timeout occurs.
-     *
-     * @throws Error if the read operation fails or if a timeout occurs.
-     */
-    read(char: Noble.Characteristic): Promise<Buffer>;
-    /**
-     * Asynchronously writes data to a specified characteristic of the device.
-     * This method sends a buffer of data to the device's characteristic and sets a timeout to handle cases where the write operation takes too long.
-     * If the write operation does not complete within the specified timeout period, an error is thrown.
-     * Once the write operation completes successfully, the timeout is cleared to prevent it from triggering.
-     *
-     * @param char The characteristic of the device to which the data will be written.
-     * @param buf A Buffer containing the data to be written to the device.
-     * @returns A Promise that resolves when the write operation completes successfully or rejects with an error if a timeout occurs.
-     */
-    write(char: Noble.Characteristic, buf: Buffer): Promise<void | string>;
+     * @returns A Promise that resolves with the response buffer.
+     */
+    private _waitCommandResponseAsync;
+    /**
+     * Reads data from a characteristic with a timeout.
+     * @param char The characteristic to read from.
+     * @returns A Promise that resolves with the data buffer.
+     */
+    private read;
+    /**
+     * Writes data to a characteristic with a timeout.
+     * @param char The characteristic to write to.
+     * @param buf The data buffer.
+     * @returns A Promise that resolves when the write is complete.
+     */
+    private write;
 }
-export {};
 //# sourceMappingURL=device.d.ts.map