node-switchbot 1.3.0 → 1.4.2-beta.0

package/lib/switchbot-device-wocolorbulb.js

@@ -0,0 +1,81 @@
+"use strict";
+const SwitchbotDevice = require("./switchbot-device.js");
+
+/**
+ * @see https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/plugmini.md
+ */
+class SwitchbotDeviceWoPlugMini extends SwitchbotDevice {
+  /**
+   * @returns {Promise<boolean>} resolves with a boolean that tells whether the plug in ON(true) or OFF(false)
+   */
+  readState() {
+    return this._operateBot([0x57, 0x0f, 0x51, 0x01]);
+  }
+
+  /**
+   * @private
+   */
+  _setState(reqByteArray) {
+    const base = [0x57, 0x0f, 0x50, 0x01];
+    return this._operateBot([].concat(base, reqByteArray));
+  }
+
+  /**
+   * @returns {Promise<boolean>} resolves with a boolean that tells whether the plug in ON(true) or OFF(false)
+   */
+  turnOn() {
+    return this._setState([0x01, 0x01]);
+  }
+
+  /**
+   * @returns {Promise<boolean>} resolves with a boolean that tells whether the plug in ON(true) or OFF(false)
+   */
+  turnOff() {
+    return this._setState([0x01, 0x02]);
+  }
+
+  /**
+   * @returns {Promise<boolean>} resolves with a boolean that tells whether the plug in ON(true) or OFF(false)
+   */
+  toggle() {
+    return this._setState([0x02, 0x03]);
+  }
+
+  /**
+   * @private
+   */
+  _operateBot(bytes) {
+    const req_buf = Buffer.from(bytes);
+    return new Promise((resolve, reject) => {
+      this._command(req_buf)
+        .then((res_bytes) => {
+          const res_buf = Buffer.from(res_bytes);
+          if (res_buf.length === 2) {
+            let code = res_buf.readUInt8(1);
+            if (code === 0x00 || code === 0x80) {
+              const is_on = code === 0x80;
+              resolve(is_on);
+            } else {
+              reject(
+                new Error(
+                  "The device returned an error: 0x" + res_buf.toString("hex")
+                )
+              );
+            }
+          } else {
+            reject(
+              new Error(
+                "Expecting a 2-byte response, got instead: 0x" +
+                  res_buf.toString("hex")
+              )
+            );
+          }
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  }
+}
+
+module.exports = SwitchbotDeviceWoPlugMini;

package/lib/switchbot-device-wocontact.js

@@ -1,9 +1,6 @@
-'use strict';
-const SwitchbotDevice = require('./switchbot-device.js');
+"use strict";
+const SwitchbotDevice = require("./switchbot-device.js");
 
-class SwitchbotDeviceWoContact extends SwitchbotDevice {
+class SwitchbotDeviceWoContact extends SwitchbotDevice {}
 
-
-}
-
-module.exports = SwitchbotDeviceWoContact;
+module.exports = SwitchbotDeviceWoContact;

package/lib/switchbot-device-wocurtain.js

@@ -1,102 +1,117 @@
-'use strict';
-const SwitchbotDevice = require('./switchbot-device.js');
+"use strict";
+const SwitchbotDevice = require("./switchbot-device.js");
 
 class SwitchbotDeviceWoCurtain extends SwitchbotDevice {
+  /* ------------------------------------------------------------------
+   * open()
+   * - Open the curtain
+   *
+   * [Arguments]
+   * - none
+   *
+   * [Return value]
+   * - Promise object
+   *   Nothing will be passed to the `resolve()`.
+   * ---------------------------------------------------------------- */
+  open() {
+    return this._operateCurtain([0x57, 0x0f, 0x45, 0x01, 0x05, 0xff, 0x00]);
+  }
 
-    /* ------------------------------------------------------------------
-    * open()
-    * - Open the curtain
-    *
-    * [Arguments]
-    * - none
-    *
-    * [Return value]
-    * - Promise object
-    *   Nothing will be passed to the `resolve()`.
-    * ---------------------------------------------------------------- */
-    open() {
-        return this._operateCurtain([0x57, 0x0f, 0x45, 0x01, 0x05, 0xff, 0x00]);
-    }
-
-    /* ------------------------------------------------------------------
-    * close()
-    * - close the curtain
-    *
-    * [Arguments]
-    * - none
-    *
-    * [Return value]
-    * - Promise object
-    *   Nothing will be passed to the `resolve()`.
-    * ---------------------------------------------------------------- */
-    close() {
-        return this._operateCurtain([0x57, 0x0f, 0x45, 0x01, 0x05, 0xff, 0x64]);
-    }
-
-    /* ------------------------------------------------------------------
-    * pause()
-    * - pause the curtain
-    *
-    * [Arguments]
-    * - none
-    *
-    * [Return value]
-    * - Promise object
-    *   Nothing will be passed to the `resolve()`.
-    * ---------------------------------------------------------------- */
-    pause() {
-        return this._operateCurtain([0x57, 0x0f, 0x45, 0x01, 0x00, 0xff]);
-    }
+  /* ------------------------------------------------------------------
+   * close()
+   * - close the curtain
+   *
+   * [Arguments]
+   * - none
+   *
+   * [Return value]
+   * - Promise object
+   *   Nothing will be passed to the `resolve()`.
+   * ---------------------------------------------------------------- */
+  close() {
+    return this._operateCurtain([0x57, 0x0f, 0x45, 0x01, 0x05, 0xff, 0x64]);
+  }
 
-    /* ------------------------------------------------------------------
-    * runToPos()
-    * - run to the targe position
-    *
-    * [Arguments]
-    * - percent | number | Required | the percentage of target position
-    *
-    * [Return value]
-    * - Promise object
-    *   Nothing will be passed to the `resolve()`.
-    * ---------------------------------------------------------------- */
-    runToPos(percent, mode) {
+  /* ------------------------------------------------------------------
+   * pause()
+   * - pause the curtain
+   *
+   * [Arguments]
+   * - none
+   *
+   * [Return value]
+   * - Promise object
+   *   Nothing will be passed to the `resolve()`.
+   * ---------------------------------------------------------------- */
+  pause() {
+    return this._operateCurtain([0x57, 0x0f, 0x45, 0x01, 0x00, 0xff]);
+  }
 
-        if (typeof percent != 'number') {
-            return new Promise((resolve, reject) => {
-                reject(new Error('The type of target position percentage is incorrent: ' + typeof percent));
-            });
-        }
-        if (mode == null) {
-            mode = 0xff;
-        }
-        else {
-            if (typeof mode != 'number') {
-                return new Promise((resolve, reject) => {
-                    reject(new Error('The type of running mode is incorrent: ' + typeof mode));
-                });
-            }
-            if (mode > 1) { mode = 0xff; }
-        }
-        if (percent > 100) { percent = 100; }
-        else if (percent < 0) { percent = 0; }
-        return this._operateCurtain([0x57, 0x0f, 0x45, 0x01, 0x05, mode, percent]);
+  /* ------------------------------------------------------------------
+   * runToPos()
+   * - run to the targe position
+   *
+   * [Arguments]
+   * - percent | number | Required | the percentage of target position
+   *
+   * [Return value]
+   * - Promise object
+   *   Nothing will be passed to the `resolve()`.
+   * ---------------------------------------------------------------- */
+  runToPos(percent, mode) {
+    if (typeof percent != "number") {
+      return new Promise((resolve, reject) => {
+        reject(
+          new Error(
+            "The type of target position percentage is incorrent: " +
+              typeof percent
+          )
+        );
+      });
     }
-
-    _operateCurtain(bytes) {
+    if (mode == null) {
+      mode = 0xff;
+    } else {
+      if (typeof mode != "number") {
         return new Promise((resolve, reject) => {
-            let req_buf = Buffer.from(bytes);
-            this._command(req_buf).then((res_buf) => {
-                let code = res_buf.readUInt8(0);
-                if (res_buf.length === 3 && code === 0x01) {
-                    resolve();
-                } else {
-                    reject(new Error('The device returned an error: 0x' + res_buf.toString('hex')));
-                }
-            }).catch((error) => {
-                reject(error);
-            });
+          reject(
+            new Error("The type of running mode is incorrent: " + typeof mode)
+          );
         });
+      }
+      if (mode > 1) {
+        mode = 0xff;
+      }
+    }
+    if (percent > 100) {
+      percent = 100;
+    } else if (percent < 0) {
+      percent = 0;
     }
+    return this._operateCurtain([0x57, 0x0f, 0x45, 0x01, 0x05, mode, percent]);
+  }
+
+  _operateCurtain(bytes) {
+    return new Promise((resolve, reject) => {
+      let req_buf = Buffer.from(bytes);
+      this._command(req_buf)
+        .then((res_buf) => {
+          let code = res_buf.readUInt8(0);
+          if (res_buf.length === 3 && code === 0x01) {
+            resolve();
+          } else {
+            reject(
+              new Error(
+                "The device returned an error: 0x" + res_buf.toString("hex")
+              )
+            );
+          }
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  }
 }
 
-module.exports = SwitchbotDeviceWoCurtain;
+module.exports = SwitchbotDeviceWoCurtain;

package/lib/switchbot-device-wohand.js

@@ -1,79 +1,78 @@
-'use strict';
-const SwitchbotDevice = require('./switchbot-device.js');
+"use strict";
+const SwitchbotDevice = require("./switchbot-device.js");
 
 class SwitchbotDeviceWoHand extends SwitchbotDevice {
-
   /* ------------------------------------------------------------------
-  * press()
-  * - Press
-  *
-  * [Arguments]
-  * - none
-  *
-  * [Return value]
-  * - Promise object
-  *   Nothing will be passed to the `resolve()`.
-  * ---------------------------------------------------------------- */
+   * press()
+   * - Press
+   *
+   * [Arguments]
+   * - none
+   *
+   * [Return value]
+   * - Promise object
+   *   Nothing will be passed to the `resolve()`.
+   * ---------------------------------------------------------------- */
   press() {
     return this._operateBot([0x57, 0x01, 0x00]);
   }
 
   /* ------------------------------------------------------------------
-  * turnOn()
-  * - Turn on
-  *
-  * [Arguments]
-  * - none
-  *
-  * [Return value]
-  * - Promise object
-  *   Nothing will be passed to the `resolve()`.
-  * ---------------------------------------------------------------- */
+   * turnOn()
+   * - Turn on
+   *
+   * [Arguments]
+   * - none
+   *
+   * [Return value]
+   * - Promise object
+   *   Nothing will be passed to the `resolve()`.
+   * ---------------------------------------------------------------- */
   turnOn() {
     return this._operateBot([0x57, 0x01, 0x01]);
   }
 
   /* ------------------------------------------------------------------
-  * turnOff()
-  * - Turn off
-  *
-  * [Arguments]
-  * - none
-  *
-  * [Return value]
-  * - Promise object
-  *   Nothing will be passed to the `resolve()`.
-  * ---------------------------------------------------------------- */
+   * turnOff()
+   * - Turn off
+   *
+   * [Arguments]
+   * - none
+   *
+   * [Return value]
+   * - Promise object
+   *   Nothing will be passed to the `resolve()`.
+   * ---------------------------------------------------------------- */
   turnOff() {
     return this._operateBot([0x57, 0x01, 0x02]);
   }
 
   /* ------------------------------------------------------------------
-  * down()
-  * - Down
-  *
-  * [Arguments]
-  * - none
-  *
-  * [Return value]
-  * - Promise object
-  *   Nothing will be passed to the `resolve()`.
-  * ---------------------------------------------------------------- */
+   * down()
+   * - Down
+   *
+   * [Arguments]
+   * - none
+   *
+   * [Return value]
+   * - Promise object
+   *   Nothing will be passed to the `resolve()`.
+   * ---------------------------------------------------------------- */
   down() {
     return this._operateBot([0x57, 0x01, 0x03]);
   }
 
   /* ------------------------------------------------------------------
-  * up()
-  * - Up
-  *
-  * [Arguments]
-  * - none
-  *
-  * [Return value]
-  * - Promise object
-  *   Nothing will be passed to the `resolve()`.
-  * ---------------------------------------------------------------- */
+   * up()
+   * - Up
+   *
+   * [Arguments]
+   * - none
+   *
+   * [Return value]
+   * - Promise object
+   *   Nothing will be passed to the `resolve()`.
+   * ---------------------------------------------------------------- */
   up() {
     return this._operateBot([0x57, 0x01, 0x04]);
   }
@@ -81,19 +80,24 @@ class SwitchbotDeviceWoHand extends SwitchbotDevice {
   _operateBot(bytes) {
     return new Promise((resolve, reject) => {
       let req_buf = Buffer.from(bytes);
-      this._command(req_buf).then((res_buf) => {
-        let code = res_buf.readUInt8(0);
-        if (res_buf.length === 3 && (code === 0x01 || code === 0x05)) {
-          resolve();
-        } else {
-          reject(new Error('The device returned an error: 0x' + res_buf.toString('hex')));
-        }
-      }).catch((error) => {
-        reject(error);
-      });
+      this._command(req_buf)
+        .then((res_buf) => {
+          let code = res_buf.readUInt8(0);
+          if (res_buf.length === 3 && (code === 0x01 || code === 0x05)) {
+            resolve();
+          } else {
+            reject(
+              new Error(
+                "The device returned an error: 0x" + res_buf.toString("hex")
+              )
+            );
+          }
+        })
+        .catch((error) => {
+          reject(error);
+        });
     });
   }
-
 }
 
-module.exports = SwitchbotDeviceWoHand;
+module.exports = SwitchbotDeviceWoHand;

package/lib/switchbot-device-wohumi.js

@@ -1,79 +1,78 @@
-'use strict';
-const SwitchbotDevice = require('./switchbot-device.js');
+"use strict";
+const SwitchbotDevice = require("./switchbot-device.js");
 
 class SwitchbotDeviceWoHumi extends SwitchbotDevice {
-
   /* ------------------------------------------------------------------
-  * press()
-  * - Press
-  *
-  * [Arguments]
-  * - none
-  *
-  * [Return value]
-  * - Promise object
-  *   Nothing will be passed to the `resolve()`.
-  * ---------------------------------------------------------------- */
+   * press()
+   * - Press
+   *
+   * [Arguments]
+   * - none
+   *
+   * [Return value]
+   * - Promise object
+   *   Nothing will be passed to the `resolve()`.
+   * ---------------------------------------------------------------- */
   press() {
     return this._operateBot([0x57, 0x01, 0x00]);
   }
 
   /* ------------------------------------------------------------------
-  * turnOn()
-  * - Turn on
-  *
-  * [Arguments]
-  * - none
-  *
-  * [Return value]
-  * - Promise object
-  *   Nothing will be passed to the `resolve()`.
-  * ---------------------------------------------------------------- */
+   * turnOn()
+   * - Turn on
+   *
+   * [Arguments]
+   * - none
+   *
+   * [Return value]
+   * - Promise object
+   *   Nothing will be passed to the `resolve()`.
+   * ---------------------------------------------------------------- */
   turnOn() {
     return this._operateBot([0x57, 0x01, 0x01]);
   }
 
   /* ------------------------------------------------------------------
-  * turnOff()
-  * - Turn off
-  *
-  * [Arguments]
-  * - none
-  *
-  * [Return value]
-  * - Promise object
-  *   Nothing will be passed to the `resolve()`.
-  * ---------------------------------------------------------------- */
+   * turnOff()
+   * - Turn off
+   *
+   * [Arguments]
+   * - none
+   *
+   * [Return value]
+   * - Promise object
+   *   Nothing will be passed to the `resolve()`.
+   * ---------------------------------------------------------------- */
   turnOff() {
     return this._operateBot([0x57, 0x01, 0x02]);
   }
 
   /* ------------------------------------------------------------------
-  * down()
-  * - Down
-  *
-  * [Arguments]
-  * - none
-  *
-  * [Return value]
-  * - Promise object
-  *   Nothing will be passed to the `resolve()`.
-  * ---------------------------------------------------------------- */
+   * down()
+   * - Down
+   *
+   * [Arguments]
+   * - none
+   *
+   * [Return value]
+   * - Promise object
+   *   Nothing will be passed to the `resolve()`.
+   * ---------------------------------------------------------------- */
   down() {
     return this._operateBot([0x57, 0x01, 0x03]);
   }
 
   /* ------------------------------------------------------------------
-  * up()
-  * - Up
-  *
-  * [Arguments]
-  * - none
-  *
-  * [Return value]
-  * - Promise object
-  *   Nothing will be passed to the `resolve()`.
-  * ---------------------------------------------------------------- */
+   * up()
+   * - Up
+   *
+   * [Arguments]
+   * - none
+   *
+   * [Return value]
+   * - Promise object
+   *   Nothing will be passed to the `resolve()`.
+   * ---------------------------------------------------------------- */
   up() {
     return this._operateBot([0x57, 0x01, 0x04]);
   }
@@ -81,19 +80,24 @@ class SwitchbotDeviceWoHumi extends SwitchbotDevice {
   _operateBot(bytes) {
     return new Promise((resolve, reject) => {
       let req_buf = Buffer.from(bytes);
-      this._command(req_buf).then((res_buf) => {
-        let code = res_buf.readUInt8(0);
-        if (res_buf.length === 3 && (code === 0x01 || code === 0x05)) {
-          resolve();
-        } else {
-          reject(new Error('The device returned an error: 0x' + res_buf.toString('hex')));
-        }
-      }).catch((error) => {
-        reject(error);
-      });
+      this._command(req_buf)
+        .then((res_buf) => {
+          let code = res_buf.readUInt8(0);
+          if (res_buf.length === 3 && (code === 0x01 || code === 0x05)) {
+            resolve();
+          } else {
+            reject(
+              new Error(
+                "The device returned an error: 0x" + res_buf.toString("hex")
+              )
+            );
+          }
+        })
+        .catch((error) => {
+          reject(error);
+        });
     });
   }
-
 }
 
-module.exports = SwitchbotDeviceWoHumi;
+module.exports = SwitchbotDeviceWoHumi;