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

package/README.md

@@ -54,12 +54,17 @@ But some functionalities of this module were developed through trial and error.
     - [`close()` method](#close-method)
     - [`pause()` method](#pause-method)
     - [`runToPos()` method](#runtopos-method)
+  - [`SwitchbotDeviceWoPlugMini` object](#switchbotdevicewoplugmini-object)
+    - [`turnOn()` method](#turnon-method)
+    - [`turnOff()` method](#turnoff-method)
+    - [`toggle()` method](#toggle-method)
   - [Advertisement data](#advertisement-data)
     - [Bot (WoHand)](#bot-wohand)
     - [Meter (WoSensorTH)](#meter-wosensorth)
     - [Curtain (WoCurtain)](#curtain-wocurtain)
     - [Contact (WoContact)](#contact-wocontact)
     - [Motion (WoMotion)](#motion-womotion)
+    - [PlugMini (WoPlugMini)](#plugmini-woplugmini)
   - [Release Note](#release-note)
   - [References](#references)
   - [License](#license)
@@ -340,7 +345,7 @@ The `startScan()` method starts to scan advertising packets coming from devices.
 
 | Property | Type   | Required | Description                                                                                                                                                                                                      |
 | :------- | :----- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `model`  | String | Optional | `"H"`, `"T"` or `"c"`. If `"H"` is specified, this method will discover only Bots. If `"T"` is specified, this method will discover only Meters. If `"c"` is specified, this method will discover only Curtains. |
+| `model`  | String | Optional | `"H"`, `"T"`, `"c"`, `"g"` or `"j"`. If `"H"` is specified, this method will discover only Bots. If `"T"` is specified, this method will discover only Meters. If `"c"` is specified, this method will discover only Curtains. If `"g"` or `"j"` is specified, this method will discover only (US/JP) Plug Minis. |
 | `id`     | String | Optional | If this value is set, this method will discover only a device whose ID is as same as this value. The ID is identical to the MAC address. This value is case-insensitive, and colons are ignored.                 |
 
 Whenever a packet is received, the callback function set to the [`onadvertisement`](#Switchbot-onadvertisement-event-handler) property of the [`Switchbot`](#Switchbot-object) object will be called. When a packet is received, a hash object representing the packet will be passed to the callback function.
@@ -835,6 +840,31 @@ switchbot
   });
 ```
 
+---
+## `SwitchbotDeviceWoPlugMini` object
+
+The `SwitchbotDeviceWoPlugMini ` object represents a PlugMini, which is created through the discovery process triggered by the [`Switchbot.discover()`](#Switchbot-discover-method) method.
+
+Actually, the `SwitchbotDeviceWoPlugMini ` is an object inherited from the [`SwitchbotDevice`](#SwitchbotDevice-object). You can use not only the method described in this section but also the properties and methods implemented in the [`SwitchbotDevice`](#SwitchbotDevice-object) object.
+
+### `turnOn()` method
+
+The `turnOn()` method sends a turn-on command to the PlugMini. This method returns a `Promise` object. A `boolean` value indicating whether the PlugMini is on (`true`), is passed to the `resolve()` method of the Promise.
+
+If no connection is established with the device, this method automatically establishes a connection with the device, then finally closes the connection. You don't have to call the [`connect()`](#SwitchbotDevice-connect-method) method in advance.
+
+### `turnOff()` method
+
+The `turnOff()` method sends a turn-off command to the PlugMini. This method returns a `Promise` object. A `boolean` value indicating whether the PlugMini is off (`false`), is passed to the `resolve()` method of the Promise.
+
+If no connection is established with the device, this method automatically establishes a connection with the device, then finally closes the connection. You don't have to call the [`connect()`](#SwitchbotDevice-connect-method) method in advance.
+
+### `toggle()` method
+
+The `toggle()` method sends a toggle command to the PlugMini, toggling between the on and off state. This method returns a `Promise` object. A `boolean` value indicating whether the PlugMini is on (`true`) or off (`false`), is passed to the `resolve()` method of the Promise.
+
+If no connection is established with the device, this method automatically establishes a connection with the device, then finally closes the connection. You don't have to call the [`connect()`](#SwitchbotDevice-connect-method) method in advance.
+
 ---
 
 ## Advertisement data
@@ -1023,6 +1053,42 @@ Structure of the `serviceData`:
 | `battery`    | Integer | This value indicates the battery level (`1-100`, `%`).       |
 | `lightLevel` | String  | This value indicates the light level (`dark`, `bright`).     |
 
+### PlugMini (WoPlugMini)
+
+Example of the advertisement data:
+
+```json
+{
+  "id": "cd2409ea3e9441f87d4580e0380a62bf",
+  "address": "60:55:f9:35:f6:a6",
+  "rssi": -50,
+  "serviceData": {
+    "model": "j",
+    "modelName": "WoPlugMini",
+    "state": "off",
+    "delay": false,
+    "timer": false,
+    "syncUtcTime": true,
+    "wifiRssi": 48,
+    "overload": false,
+    "currentPower": 0
+  }
+}
+```
+
+Structure of the `serviceData`:
+
+| Property      | Type    | Description                                                                         |
+| :------------ | :------ | :---------------------------------------------------------------------------------- |
+| `model`       | String  | This value is always `"j"` or `"g"`, which means "PlugMini" (JP or US).             |
+| `modelName`   | String  | This value is always `"WoPlugMini"`, which means "PlugMini".                        |
+| `state   `    | Boolean | This value indicates whether the plug mini is turned on (`true`) or not (`false`).  |
+| `delay`       | Boolean | Indicates whether a delay is present.                                               |
+| `timer`       | Boolean | Indicates whether a timer is present.                                               |
+| `syncUtcTime` | boolean | Indicates whether the UTC time has been synchronized.                               |
+| `overload`    | boolean | Indicates whether the Plug Mini is overloaded, more than 15A current overload.      |                            
+| `currentPower`| Float   | Current power consumption in Watts.                                                 |
+
 ---
 
 ## References

package/lib/switchbot-advertising.js

@@ -75,7 +75,7 @@ class SwitchbotAdvertising {
       !Buffer.isBuffer(manufacturerData) ||
       manufacturerData.length < 3;
 
-    if (bufIsInvalid && manufacturerDataIsInvalid) {
+    if (bufIsInvalid || manufacturerDataIsInvalid) {
       return null;
     }
 
@@ -83,41 +83,29 @@ class SwitchbotAdvertising {
     let sd = null;
 
     if (model === "H") {
-      // WoHand
-      sd = this._parseServiceDataForWoHand(buf, onlog);
+      sd = this._parseServiceDataForWoHand(buf, onlog);//WoHand
     } else if (model === "T") {
-      // WoSensorTH
-      sd = this._parseServiceDataForWoSensorTH(buf, onlog);
+      sd = this._parseServiceDataForWoSensorTH(buf, onlog);//WoSensorTH
     } else if (model === "e") {
-      // WoHumi
-      sd = this._parseServiceDataForWoHumi(buf, onlog);
+      sd = this._parseServiceDataForWoHumi(buf, onlog);//WoHumi
     } else if (model === "s") {
-      // WoMotion
-      sd = this._parseServiceDataForWoPresence(buf, onlog);
+      sd = this._parseServiceDataForWoPresence(buf, onlog);//WoPresence
     } else if (model === "d") {
-      // WoContact
-      sd = this._parseServiceDataForWoContact(buf, onlog);
+      sd = this._parseServiceDataForWoContact(buf, onlog);//WoContact
     } else if (model === "c") {
-      // WoCurtain
-      sd = this._parseServiceDataForWoCurtain(buf, onlog);
+      sd = this._parseServiceDataForWoCurtain(buf, onlog);// WoCurtain
     } else if (model === "u") {
-      // WoColorBulb
-      sd = this._parseServiceDataForWoColorBulb(buf, onlog);
+      sd = this._parseServiceDataForWoBulb(manufacturerData, onlog);// WoBulb
     } else if (model === "g") {
-      // WoPlugMini (US)
-      sd = this._parseServiceDataForWoPlugMiniUS(manufacturerData, onlog);
+      sd = this._parseServiceDataForWoPlugMiniUS(manufacturerData, onlog);      // WoPlugMini (US)
     } else if (model === "j") {
-      // WoPlugMini (JP)
-      sd = this._parseServiceDataForWoPlugMiniJP(manufacturerData, onlog);
+      sd = this._parseServiceDataForWoPlugMiniJP(manufacturerData, onlog);// WoPlugMini (JP)
     } else if (model === "o") {
-      // WoSmartLock
-      sd = this._parseServiceDataForWoSmartLock(buf, onlog);
+      sd = this._parseServiceDataForWoSmartLock(buf, onlog);// WoSmartLock
     } else if (model === "i") {
-      // WoMeterPlus
-      sd = this._parseServiceDataForWoSensorTHPlus(buf, onlog);
+      sd = this._parseServiceDataForWoSensorTHPlus(buf, onlog);// WoMeterPlus
     } else if (model === "r") {
-      // WoLEDStripLight
-      sd = this._parseServiceDataForWoLEDStripLight(buf, onlog);
+      sd = this._parseServiceDataForWoStrip(buf, onlog);// WoStrip
     } else {
       if (onlog && typeof onlog === "function") {
         onlog(
@@ -363,11 +351,11 @@ class SwitchbotAdvertising {
     return data;
   }
 
-  _parseServiceDataForWoColorBulb(buf, onlog) {
-    if (buf.length !== 6) {
+  _parseServiceDataForWoBulb(buf, onlog) {
+    if (buf.length !== 13) {
       if (onlog && typeof onlog === "function") {
         onlog(
-          `[_parseServiceDataForWoColorBulb] Buffer length ${buf.length} !== 6!`
+          `[_parseServiceDataForWoBulb] Buffer length ${buf.length} !== 13!`
         );
       }
       return null;
@@ -378,8 +366,8 @@ class SwitchbotAdvertising {
     const byte12 = buf.readUInt8(12); // byte12: bit7: overload?
     const byte13 = buf.readUInt8(13); // byte12[bit0~6] + byte13: current power value
 
-    const state = byte9 === 0x00 ? "off" : byte9 === 0x80 ? "on" : null;
-    const lightLevel = byte9 & 0b01111111;
+    const state = byte9 === 0x01 ? "off" : byte9 === 0x80 ? "on" : null;
+    const lightLevel = byte9 & 0b00000011;
     const delay = !!(byte10 & 0b00000001);
     const networkStatus = !!(byte10 & 0b00000001);
     const statePreset = !!(byte10 & 0b00000010);
@@ -387,11 +375,15 @@ class SwitchbotAdvertising {
     const wifiRssi = byte11;
     const dynamicRate = !!(byte12 & 0b10000000);
     const loopIndex = (((byte12 & 0b01111111) << 8) + byte13) / 10; // in watt
-    // TODO: voltage ???
 
     const data = {
       model: "u",
-      modelName: "WoColorBulb",
+      modelName: "WoBulb",
+      state: state,
+    };
+    /* const data = {
+      model: "u",
+      modelName: "WoBulb",
       state: state,
       lightLevel: lightLevel,
       delay: delay,
@@ -401,7 +393,7 @@ class SwitchbotAdvertising {
       wifiRssi: wifiRssi,
       dynamicRate: dynamicRate,
       loopIndex: loopIndex,
-    };
+    };*/
 
     return data;
   }

package/lib/{switchbot-device-wocolorbulb.js → switchbot-device-wobulb.js}

@@ -2,21 +2,21 @@
 const SwitchbotDevice = require("./switchbot-device.js");
 
 /**
- * @see https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/plugmini.md
+ * @see https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/colorbulb.md
  */
-class SwitchbotDeviceWoPlugMini extends SwitchbotDevice {
+class SwitchbotDeviceWoBulb 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]);
+    return this._operateBot([0x57, 0x0f, 0x48, 0x01]);
   }
 
   /**
    * @private
    */
   _setState(reqByteArray) {
-    const base = [0x57, 0x0f, 0x50, 0x01];
+    const base = [0x57, 0x0f, 0x47, 0x01];
     return this._operateBot([].concat(base, reqByteArray));
   }
 
@@ -78,4 +78,4 @@ class SwitchbotDeviceWoPlugMini extends SwitchbotDevice {
   }
 }
 
-module.exports = SwitchbotDeviceWoPlugMini;
+module.exports = SwitchbotDeviceWoBulb;

package/lib/switchbot-device-wostrip.js

@@ -0,0 +1,81 @@
+"use strict";
+const SwitchbotDevice = require("./switchbot-device.js");
+
+/**
+ * @see https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/colorbulb.md
+ */
+class SwitchbotDeviceWoStrip 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, 0x4A, 0x01]);
+  }
+
+  /**
+   * @private
+   */
+  _setState(reqByteArray) {
+    const base = [0x57, 0x0f, 0x49, 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 = SwitchbotDeviceWoStrip;

package/lib/switchbot.js

@@ -10,6 +10,8 @@ const SwitchbotDeviceWoContact = require("./switchbot-device-wocontact.js");
 const SwitchbotDeviceWoSensorTH = require("./switchbot-device-wosensorth.js");
 const SwitchbotDeviceWoHumi = require("./switchbot-device-wohumi.js");
 const SwitchbotDeviceWoPlugMini = require("./switchbot-device-woplugmini.js");
+const SwitchbotDeviceWoBulb = require("./switchbot-device-wobulb.js");
+const SwitchbotDeviceWoStrip = require("./switchbot-device-wostrip.js");
 
 class Switchbot {
   /* ------------------------------------------------------------------
@@ -226,7 +228,7 @@ class Switchbot {
           device = new SwitchbotDeviceWoCurtain(peripheral, this.noble);
           break;
         case "u":
-          device = new SwitchbotDeviceWoColorBulb(peripheral, this.noble);
+          device = new SwitchbotDeviceWoBulb(peripheral, this.noble);
           break;
         case "g":
         case "j":
@@ -239,7 +241,7 @@ class Switchbot {
           device = new SwitchbotDeviceWoSensorTHPlus(peripheral, this.noble);
           break;
         case "r":
-          device = new SwitchbotDeviceWoLEDStripLight(peripheral, this.noble);
+          device = new SwitchbotDeviceWoStrip(peripheral, this.noble);
           break;
         default: // 'resetting', 'unknown'
           device = new SwitchbotDevice(peripheral, this.noble);

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "node-switchbot",
-    "version": "1.4.2-beta.0",
-    "description": "The node-switchbot is a Node.js module which allows you to move your Switchbot (Bot)'s arm and Switchbot Curtain(Curtain), also monitor the temperature/humidity from SwitchBot Thermometer & Hygrometer (Meter).",
+    "version": "1.4.2-beta.10",
+    "description": "The node-switchbot is a Node.js module which allows you to control your Switchbot Devices through Bluetooth (BLE).",
     "main": "./lib/switchbot.js",
     "files": [
         "lib"
@@ -25,7 +25,7 @@
         "Bluetooth smart",
         "Bluetooth"
     ],
-    "homepage": "https://github.com/OpenWonderLabs",
+    "homepage": "https://github.com/OpenWonderLabs/node-switchbot",
     "author": "OpenWonderLabs (https://github.com/OpenWonderLabs)",
     "license": "MIT",
     "repository": {
@@ -37,6 +37,6 @@
         "@abandonware/noble": "^1.9.2-15"
     },
     "devDependencies": {
-        "npm-check-updates": "^16.0.6"
+        "npm-check-updates": "^16.2.1"
     }
 }