node-switchbot 1.0.9-beta.4 → 1.1.0

package/CHANGELOG.md

@@ -2,7 +2,15 @@
 
 All notable changes to this project will be documented in this file. This project uses [Semantic Versioning](https://semver.org/)
 
-## [Version 1.0.8](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v1.0.48) (2021-09-30)
+## [Version 1.1.0](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v1.1.0) (2021-10-26)
+
+### Changes
+
+- Add Contact/Motion Sensor advertisement
+- Add Humidifier advertisement
+- Correct Model for advertisement
+
+## [Version 1.0.8](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v1.0.8) (2021-09-30)
 
 ### Changes
 
@@ -93,4 +101,4 @@ All notable changes to this project will be documented in this file. This projec
 
 ### Changes
 
-- First public release
+- First public release

package/README.md

@@ -899,4 +899,4 @@ Property      | Type    | Description
 ## References
 
 * [Switchbot official global site](https://www.switch-bot.com/)
-* [Github - OpenWonderLabs/python-host](https://github.com/OpenWonderLabs/python-host)
+* [Github - OpenWonderLabs/python-host](https://github.com/OpenWonderLabs/python-host)

package/lib/switchbot-advertising.js

@@ -78,13 +78,15 @@ class SwitchbotAdvertising {
 
     if (model === 'H') { // WoHand
       sd = this._parseServiceDataForWoHand(buf);
+    } else if (model === 'e') { // WoHumi
+      sd = this._parseServiceDataForWoHumi(buf);
     } else if (model === 'T') { // WoSensorTH
       sd = this._parseServiceDataForWoSensorTH(buf);
     } else if (model === 'c') { // WoCurtain
       sd = this._parseServiceDataForWoCurtain(buf);
-    } else if (model === 'P') { // WoPresence
+    } else if (model === 's') { // WoMotion
       sd = this._parseServiceDataForWoPresence(buf);
-    } else if (model === 'C') { // WoContact
+    } else if (model === 'd') { // WoContact
       sd = this._parseServiceDataForWoContact(buf);
     } else {
       return null;
@@ -139,6 +141,31 @@ class SwitchbotAdvertising {
     return data;
   }
 
+  _parseServiceDataForWoHumi(buf) {
+    if (buf.length !== 8) {
+      return null;
+    }
+    let byte1 = buf.readUInt8(1);
+    // let byte2 = buf.readUInt8(2);
+    let byte3 = buf.readUInt8(3);
+    let byte4 = buf.readUInt8(4);
+    let byte5 = buf.readUInt8(5);
+
+    let onState = (byte1 & 0b10000000) ? true : false; // 1 - on
+    let autoMode = (byte4 & 0b10000000) ? true : false; // 1 - auto
+    let percentage = byte4 & 0b01111111; // 0-100%, 101/102/103 - Quick gear 1/2/3
+
+    let data = {
+      model: 'e',
+      modelName: 'WoHumi',
+      onState: onState,
+      autoMode: autoMode,
+      percentage: autoMode ? 0 : percentage,
+    };
+
+    return data;
+  }
+
   _parseServiceDataForWoSensorTH(buf) {
     if (buf.length !== 6) {
       return null;
@@ -172,66 +199,53 @@ class SwitchbotAdvertising {
     if (buf.length !== 6) {
       return null;
     }
+    let byte1 = buf.readUInt8(1);
+    let byte2 = buf.readUInt8(2);
+    // let byte3 = buf.readUInt8(3);
+    // let byte4 = buf.readUInt8(4);
+    let byte5 = buf.readUInt8(5);
 
-    const byte1 = buf.readUInt8(1);
-    const byte2 = buf.readUInt8(2);
-    const byte3 = buf.readUInt8(3);
-    const byte4 = buf.readUInt8(4);
-    const byte5 = buf.readUInt8(5);
-
-    const motion = byte1 & 0b01000000; // Whether the calibration is completed
-    const battery = byte2 & 0b01111111; // %
-    const pir_trigger3 = byte3 & 0b00001111; //
-    const pir_trigger4 = byte4 & 0b01000000; //
-    const state = byte5 & 0b01111111; // %
+    let pirState = (byte1 & 0b01000000) ? true : false; // 1 - Movement detected
+    let battery = byte2 & 0b01111111; // %
+    let lightLevel = byte5 & 0b00000011;
 
-    const data = {
+    let data = {
       model: 's',
-      modelName: 'WoPresence',
-      motion: motion ? true : false,
+      modelName: 'WoMotion',
+      movement: pirState,
       battery: battery,
-      pir_trigger3: pir_trigger3,
-      pir_trigger4: pir_trigger4,
-      state: state ? true : false,
+      lightLevel: (lightLevel == 1) ? 'dark' : ((lightLevel == 2) ? 'bright' : 'unknown'),
     };
 
     return data;
   }
 
   _parseServiceDataForWoContact(buf) {
-    if (buf.length !== 6) {
+    if (buf.length !== 9) {
       return null;
     }
 
-    const byte1 = buf.readUInt8(1);
-    const byte2 = buf.readUInt8(2);
-    const byte3 = buf.readUInt8(3);
-    const byte4 = buf.readUInt8(4);
-    const byte5 = buf.readUInt8(5);
-    const byte6 = buf.readUInt8(6);
-    const byte7 = buf.readUInt8(7);
-    const byte8 = buf.readUInt8(8);
+    let byte1 = buf.readUInt8(1);
+    let byte2 = buf.readUInt8(2);
+    let byte3 = buf.readUInt8(3);
+    // let byte4 = buf.readUInt8(4);
+    // let byte5 = buf.readUInt8(5);
+    // let byte6 = buf.readUInt8(6);
+    // let byte7 = buf.readUInt8(7);
+    // let byte8 = buf.readUInt8(8);
 
-    const motion = byte1 & 0b01000000; // Whether there is motion
-    const battery = byte2 & 0b01111111; // %
-    const state = byte3 & 0b01111111; // current state
-    const pir_trigger4 = byte4 & 0b00001111; //
-    const pir_trigger5 = byte5 & 0b01000000; //
-    const hal_trigger6 = byte6 & 0b01111111; //
-    const hal_trigger7 = byte7 & 0b01111111; //
-    const act_counter = byte8 & 0b00001111; //
+    let pirState = (byte1 & 0b01000000) ? true : false; // 1 - Movement detected
+    let battery = byte2 & 0b01111111; // %
+    let hallState = (byte3 >> 1) & 0b00000011;
+    let lightLevel = byte3 & 0b00000001;
 
-    const data = {
+    let data = {
       model: 'd',
       modelName: 'WoContact',
-      motion: motion ? true : false,
+      movement: pirState,
       battery: battery,
-      state: state ? true : false,
-      pir_trigger4: pir_trigger4,
-      pir_trigger5: pir_trigger5,
-      hal_trigger6: hal_trigger6,
-      hal_trigger7: hal_trigger7,
-      act_counter: act_counter,
+      doorState: (hallState == 0) ? 'close' : ((hallState == 1) ? 'open' : 'timeout no closed'),
+      lightLevel: (lightLevel == 0) ? 'dark' : 'bright',
     };
 
     return data;
@@ -246,7 +260,7 @@ class SwitchbotAdvertising {
     let byte3 = buf.readUInt8(3);
     let byte4 = buf.readUInt8(4);
 
-    let calibration = byte1 & 0b01000000; // Whether the calibration is completed
+    let calibration = (byte1 & 0b01000000) ? true : false; // Whether the calibration is completed
     let battery = byte2 & 0b01111111; // %
     let currPosition = byte3 & 0b01111111; // current positon %
     let lightLevel = (byte4 >> 4) & 0b00001111; // light sensor level (1-10)
@@ -254,7 +268,7 @@ class SwitchbotAdvertising {
     let data = {
       model: 'c',
       modelName: 'WoCurtain',
-      calibration: calibration ? true : false,
+      calibration: calibration,
       battery: battery,
       position: currPosition,
       lightLevel: lightLevel
@@ -264,4 +278,4 @@ class SwitchbotAdvertising {
   }
 }
 
-module.exports = new SwitchbotAdvertising();
+module.exports = new SwitchbotAdvertising();

package/lib/switchbot-device-wohumi.js

@@ -0,0 +1,99 @@
+'use strict';
+const SwitchbotDevice = require('./switchbot-device.js');
+
+class SwitchbotDeviceWoHumi extends SwitchbotDevice {
+
+  /* ------------------------------------------------------------------
+  * press()
+  * - Press
+  *
+  * [Arguments]
+  * - none
+  *
+  * [Returen value]
+  * - Promise object
+  *   Nothing will be passed to the `resolve()`.
+  * ---------------------------------------------------------------- */
+  press() {
+    return this._operateBot([0x57, 0x01, 0x00]);
+  }
+
+  /* ------------------------------------------------------------------
+  * turnOn()
+  * - Turn on
+  *
+  * [Arguments]
+  * - none
+  *
+  * [Returen value]
+  * - Promise object
+  *   Nothing will be passed to the `resolve()`.
+  * ---------------------------------------------------------------- */
+  turnOn() {
+    return this._operateBot([0x57, 0x01, 0x01]);
+  }
+
+  /* ------------------------------------------------------------------
+  * turnOff()
+  * - Turn off
+  *
+  * [Arguments]
+  * - none
+  *
+  * [Returen value]
+  * - Promise object
+  *   Nothing will be passed to the `resolve()`.
+  * ---------------------------------------------------------------- */
+  turnOff() {
+    return this._operateBot([0x57, 0x01, 0x02]);
+  }
+
+  /* ------------------------------------------------------------------
+  * down()
+  * - Down
+  *
+  * [Arguments]
+  * - none
+  *
+  * [Returen value]
+  * - Promise object
+  *   Nothing will be passed to the `resolve()`.
+  * ---------------------------------------------------------------- */
+  down() {
+    return this._operateBot([0x57, 0x01, 0x03]);
+  }
+
+  /* ------------------------------------------------------------------
+  * up()
+  * - Up
+  *
+  * [Arguments]
+  * - none
+  *
+  * [Returen value]
+  * - Promise object
+  *   Nothing will be passed to the `resolve()`.
+  * ---------------------------------------------------------------- */
+  up() {
+    return this._operateBot([0x57, 0x01, 0x04]);
+  }
+
+  _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);
+      });
+    });
+  }
+
+}
+
+module.exports = SwitchbotDeviceWoHumi;

package/lib/switchbot.js

@@ -8,6 +8,7 @@ const SwitchbotDeviceWoCurtain = require('./switchbot-device-wocurtain.js');
 const SwitchbotDeviceWoPresence = require('./switchbot-device-wopresence.js');
 const SwitchbotDeviceWoContact = require('./switchbot-device-wocontact.js');
 const SwitchbotDeviceWoSensorTH = require('./switchbot-device-wosensorth.js');
+const SwitchbotDeviceWoHumi = require('./switchbot-device-wohumi.js');
 
 class Switchbot {
   /* ------------------------------------------------------------------
@@ -49,12 +50,13 @@ class Switchbot {
   *   - duration | Integer | Optional | Duration for discovery process (msec).
   *              |         |          | The value must be in the range of 1 to 60000.
   *              |         |          | The default value is 5000 (msec).
-  *   - model    | String  | Optional | "H", "T", "M", "D", or "S".
+  *   - model    | String  | Optional | "H", "T", "e", "s", "d", or "c".
   *              |         |          | If "H" is specified, this method will discover only Bots.
   *              |         |          | If "T" is specified, this method will discover only Meters.
-  *              |         |          | If "S" is specified, this method will discover only Motion Sensors.
-  *              |         |          | If "D" is specified, this method will discover only Contact Sensors.
-  *              |         |          | If "C" is specified, this method will discover only Curtains.
+  *              |         |          | If "e" is specified, this method will discover only Humidifiers.
+  *              |         |          | If "s" is specified, this method will discover only Motion Sensors.
+  *              |         |          | If "d" is specified, this method will discover only Contact Sensors.
+  *              |         |          | If "c" is specified, this method will discover only Curtains.
   *   - id       | String  | Optional | If this value is set, this method willl discover
   *              |         |          | only a device whose ID is as same as this value.
   *              |         |          | The ID is identical to the MAC address.
@@ -76,7 +78,7 @@ class Switchbot {
       // Check the parameters
       let valid = parameterChecker.check(params, {
         duration: { required: false, type: 'integer', min: 1, max: 60000 },
-        model: { required: false, type: 'string', enum: ['H', 'h','T', 'P', 'S', 'D', 'C', 'c'] },
+        model: { required: false, type: 'string', enum: ['H', 'T', 'e', 's', 'd', 'c'] },
         id: { required: false, type: 'string', min: 12, max: 17 },
         quick: { required: false, type: 'boolean' }
       }, false);
@@ -183,13 +185,16 @@ class Switchbot {
         case 'H':
           device = new SwitchbotDeviceWoHand(peripheral, this.noble);
           break;
+        case 'e':
+          device = new SwitchbotDeviceWoHumi(peripheral, this.noble);
+          break;
         case 'T':
           device = new SwitchbotDeviceWoSensorTH(peripheral, this.noble);
           break;
-        case 'S':
+        case 's':
           device = new SwitchbotDeviceWoPresence(peripheral, this.noble);
           break;
-        case 'D':
+        case 'd':
           device = new SwitchbotDeviceWoContact(peripheral, this.noble);
           break;
         case 'c':
@@ -229,20 +234,23 @@ class Switchbot {
   *
   * [Arguments]
   *   - params   | Object  | Optional |
-  *   - model    | String  | Optional | "H", "T", "M", "CS", or "C".
+  *   - model    | String  | Optional | "H", "T", "e", "s", "d", or "c".
   *              |         |          | If "H" is specified, the `onadvertisement`
   *              |         |          | event hander will be called only when advertising
   *              |         |          | packets comes from Bots.
   *              |         |          | If "T" is specified, the `onadvertisement`
   *              |         |          | event hander will be called only when advertising
   *              |         |          | packets comes from Meters.
-  *              |         |          | If "S" is specified, the `onadvertisement`
+  *              |         |          | If "e" is specified, the `onadvertisement`
+  *              |         |          | event hander will be called only when advertising
+  *              |         |          | packets comes from Humidifiers.
+  *              |         |          | If "s" is specified, the `onadvertisement`
   *              |         |          | event hander will be called only when advertising
   *              |         |          | packets comes from Motion Sensor.
-  *              |         |          | If "D" is specified, the `onadvertisement`
+  *              |         |          | If "d" is specified, the `onadvertisement`
   *              |         |          | event hander will be called only when advertising
   *              |         |          | packets comes from Contact Sensor.
-  *              |         |          | If "C" is specified, the `onadvertisement`
+  *              |         |          | If "c" is specified, the `onadvertisement`
   *              |         |          | event hander will be called only when advertising
   *              |         |          | packets comes from Curtains.
   *   - id       | String  | Optional | If this value is set, the `onadvertisement`
@@ -261,7 +269,7 @@ class Switchbot {
     let promise = new Promise((resolve, reject) => {
       // Check the parameters
       let valid = parameterChecker.check(params, {
-        model: { required: false, type: 'string', enum: ['H', 'h','T', 'P', 'S', 'D', 'C', 'c'] },
+        model: { required: false, type: 'string', enum: ['H', 'T', 'e', 's', 'd', 'c'] },
         id: { required: false, type: 'string', min: 12, max: 17 },
       }, false);
 

package/package.json

@@ -1,42 +1,42 @@
 {
-    "name": "node-switchbot",
-    "version": "1.0.9-beta.4",
-    "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).",
-    "main": "./lib/switchbot.js",
-    "files": [
-        "lib"
-    ],
-    "directories": {
-        "lib": "./lib"
-    },
-    "scripts": {
-        "check": "npm install && npm outdated",
-        "update": "ncu -u && npm update && npm install"
-    },
-    "keywords": [
-        "switchbot",
-        "bot",
-        "meter",
-        "temperature",
-        "humidity",
-        "curtain",
-        "BLE",
-        "Bluetooth Low Energy",
-        "Bluetooth smart",
-        "Bluetooth"
-    ],
-    "homepage": "https://github.com/OpenWonderLabs",
-    "author": "OpenWonderLabs (https://github.com/OpenWonderLabs)",
-    "license": "MIT",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/futomi/node-switchbot.git"
-    },
-    "readmeFilename": "README.md",
-    "dependencies": {
-        "@homebridge/noble": "^1.9.3"
-    },
-    "devDependencies": {
-        "npm-check-updates": "^11.8.5"
-    }
+  "name": "node-switchbot",
+  "version": "1.1.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).",
+  "main": "./lib/switchbot.js",
+  "files": [
+    "lib"
+  ],
+  "directories": {
+    "lib": "./lib"
+  },
+  "scripts": {
+    "check": "npm install && npm outdated",
+    "update": "ncu -u && npm update && npm install"
+  },
+  "keywords": [
+    "switchbot",
+    "bot",
+    "meter",
+    "temperature",
+    "humidity",
+    "curtain",
+    "BLE",
+    "Bluetooth Low Energy",
+    "Bluetooth smart",
+    "Bluetooth"
+  ],
+  "homepage": "https://github.com/OpenWonderLabs",
+  "author": "OpenWonderLabs (https://github.com/OpenWonderLabs)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/OpenWonderLabs/node-switchbot.git"
+  },
+  "readmeFilename": "README.md",
+  "dependencies": {
+    "@homebridge/noble": "^1.9.3"
+  },
+  "devDependencies": {
+    "npm-check-updates": "^11.8.5"
+  }
 }