node-switchbot 1.1.3-beta.7 → 1.2.0

package/CHANGELOG.md

@@ -2,25 +2,32 @@
 
 All notable changes to this project will be documented in this file. This project uses [Semantic Versioning](https://semver.org/)
 
-## [Beta - Version 1.2.0](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v1.1.2) (2021-11-13)
+## [Version 1.2.0](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v1.2.0) (2022-03-04)
 
 ### Changes
 
 - Added support for SwitchBot "Contact" and "Motion"
+- Fix for Curtains on Firmware v3.3 and above
 - Housekeeping and update dependencies
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v1.1.2...v1.2.0
+
 ## [Version 1.1.2](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v1.1.2) (2021-11-13)
 
 ### Changes
 
 - Housekeeping and update dependencies
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v1.1.1...v1.1.2
+
 ## [Version 1.1.1](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v1.1.1) (2021-11-02)
 
 ### Changes
 
 - Change back from @node/noble to @abandonware/noble
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v1.1.0...v1.1.1
+
 ## [Version 1.1.0](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v1.1.0) (2021-10-26)
 
 ### Changes
@@ -29,24 +36,32 @@ All notable changes to this project will be documented in this file. This projec
 - Add Humidifier advertisement
 - Correct Model for advertisement
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v1.0.8...v1.1.0
+
 ## [Version 1.0.8](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v1.0.8) (2021-09-30)
 
 ### Changes
 
 - fix extra trace of old noble from @abandonware/noble
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v1.0.7...v1.0.8
+
 ## [Version 1.0.7](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v1.0.7) (2021-09-24)
 
 ### Changes
 
 - Change from @abandonware/noble to @homebridge/noble
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v1.0.6...v1.0.7
+
 ## [Version 1.0.6](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v1.0.6) (2021-08-29)
 
 ### Changes
 
 - Fixes FATAL ERROR: ad_id is not defined
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v1.0.5...v1.0.6
+
 ## [Version 1.0.5](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v1.0.5) (2021-08-04)
 
 ### Changes
@@ -54,42 +69,56 @@ All notable changes to this project will be documented in this file. This projec
 - Adding code for Contact and Motion Sensors
   - Not Ready to be used yet though
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v1.0.4...v1.0.5
+
 ## [Version 1.0.4](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v1.0.4) (2021-08-03)
 
 ### Changes
 
 - Support for the discover method with id on macOS
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v1.0.3...v1.0.4
+
 ## [Version 1.0.3](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v1.0.3) (2021-07-30)
 
 ### Changes
 
 - Fixed misspelling.
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v1.0.2...v1.0.3
+
 ## [Version 1.0.2](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v1.0.2) (2021-07-29)
 
 ### Changes
 
 - Housekeeping and update dependencies
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v1.0.1...v1.0.2
+
 ## [Version 1.0.1](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v1.0.1) (2021-07-29)
 
 ### Changes
 
 - Fixed issue where after switching Bluetooth off and on, would not work properly.
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v1.0.0...v1.0.1
+
 ## [Version 1.0.0](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v1.0.0) (2021-01-21)
 
 ### Changes
 
 -   * fix "No device was found" in MacOS
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v0.2.0...v1.0.0
+
 ## [Version 0.2.0](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v0.2.0) (2020-11-05)
 
 ### Changes
 
 - Modify Curtain's action command to support group and running mode. (Thanks to [@SwitchBot-Wonderlabs](https://github.com/OpenWonderLabs/node-switchbot/pull/7/))
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v0.1.0...v0.2.0
+
 ## [Version 0.1.0](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v0.1.0) (2020-10-28)
 
 ### Changes
@@ -97,18 +126,24 @@ All notable changes to this project will be documented in this file. This projec
 - Added support for SwitchBot Curtain. (Thanks to [@SwitchBot-Wonderlabs](https://github.com/OpenWonderLabs/node-switchbot/pull/6/))
 - Added support for running on the Raspberry Pi Zero W. (Thanks to [@zizi4n5](https://github.com/OpenWonderLabs/node-switchbot/pull/5))
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v0.0.5...v0.1.0
+
 ## [Version 0.0.5](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v0.0.5) (2020-02-19)
 
 ### Changes
 
 - Improved the stability of discovering the BLE characteristics. (Thanks to [@dnicolson](https://github.com/OpenWonderLabs/node-switchbot/issues/3))
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v0.0.4...v0.0.5
+
 ## [Version 0.0.4](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v0.0.4) (2020-02-11)
 
 ### Changes
 
 - Fixed the bug that temperature value lower than 0 degC could not be handled. (Thanks to [@musimasami](https://github.com/OpenWonderLabs/node-switchbot/issues/2))
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v0.0.3...v0.0.4
+
 ## [Version 0.0.3](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v0.0.3) (2020-02-10)
 
 ### Changes
@@ -116,6 +151,8 @@ All notable changes to this project will be documented in this file. This projec
 - Now the characteristic UUID `0x2a00` (Device Name) is not mandatory. Some models of Bot don't seem to support the characteristic. (Thanks to [@dnicolson](https://github.com/OpenWonderLabs/node-switchbot/issues/1))
 - Fixed the bug that the `turnOn()` method returns an error if the "Press mode" is selected on the Bot.
 
+**Full Changelog**: https://github.com/OpenWonderLabs/node-switchbot/compare/v0.0.2...v0.0.3
+
 ## [Version 0.0.2](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v0.0.2) (2019-11-20)
 
 ### Changes

package/lib/switchbot-advertising.js

@@ -60,7 +60,7 @@ class SwitchbotAdvertising {
   * If the specified `Peripheral` does not represent any switchbot
   * device, this method will return `null`.
   * ---------------------------------------------------------------- */
-  parse(peripheral) {
+  parse(peripheral, onlog) {
     let ad = peripheral.advertisement;
     if (!ad || !ad.serviceData) {
       return null;
@@ -75,22 +75,28 @@ class SwitchbotAdvertising {
     let sd = null;
 
     if (model === 'H') { // WoHand
-      sd = this._parseServiceDataForWoHand(buf);
+      sd = this._parseServiceDataForWoHand(buf, onlog);
     } else if (model === 'e') { // WoHumi
-      sd = this._parseServiceDataForWoHumi(buf);
+      sd = this._parseServiceDataForWoHumi(buf, onlog);
     } else if (model === 'T') { // WoSensorTH
-      sd = this._parseServiceDataForWoSensorTH(buf);
+      sd = this._parseServiceDataForWoSensorTH(buf, onlog);
     } else if (model === 'c') { // WoCurtain
-      sd = this._parseServiceDataForWoCurtain(buf);
+      sd = this._parseServiceDataForWoCurtain(buf, onlog);
     } else if (model === 's') { // WoMotion
-      sd = this._parseServiceDataForWoPresence(buf);
+      sd = this._parseServiceDataForWoPresence(buf, onlog);
     } else if (model === 'd') { // WoContact
-      sd = this._parseServiceDataForWoContact(buf);
+      sd = this._parseServiceDataForWoContact(buf, onlog);
     } else {
+      if (onlog && typeof onlog === 'function') {
+        onlog(`[parseAdvertising.${peripheral.id}] return null, model "${model}" not available!`);
+      }
       return null;
     }
 
     if (!sd) {
+      if (onlog && typeof onlog === 'function') {
+        onlog(`[parseAdvertising.${peripheral.id}.${model}] return null, parsed serviceData empty!`);
+      }
       return null;
     }
     let address = peripheral.address || '';
@@ -114,11 +120,18 @@ class SwitchbotAdvertising {
       rssi: peripheral.rssi,
       serviceData: sd
     };
+    
+    if (onlog && typeof onlog === 'function') {
+      onlog(`[parseAdvertising.${peripheral.id}.${model}] return ${JSON.stringify(data)}`);
+    }
     return data;
   }
 
-  _parseServiceDataForWoHand(buf) {
+  _parseServiceDataForWoHand(buf, onlog) {
     if (buf.length !== 3) {
+      if (onlog && typeof onlog === 'function') {
+        onlog(`[_parseServiceDataForWoHand] Buffer length ${buf.length} !== 3!`);
+      }
       return null;
     }
     let byte1 = buf.readUInt8(1);
@@ -139,8 +152,11 @@ class SwitchbotAdvertising {
     return data;
   }
 
-  _parseServiceDataForWoHumi(buf) {
+  _parseServiceDataForWoHumi(buf, onlog) {
     if (buf.length !== 8) {
+      if (onlog && typeof onlog === 'function') {
+        onlog(`[_parseServiceDataForWoHumi] Buffer length ${buf.length} !== 8!`);
+      }
       return null;
     }
     let byte1 = buf.readUInt8(1);
@@ -164,8 +180,11 @@ class SwitchbotAdvertising {
     return data;
   }
 
-  _parseServiceDataForWoSensorTH(buf) {
+  _parseServiceDataForWoSensorTH(buf, onlog) {
     if (buf.length !== 6) {
+      if (onlog && typeof onlog === 'function') {
+        onlog(`[_parseServiceDataForWoSensorTH] Buffer length ${buf.length} !== 6!`);
+      }
       return null;
     }
     let byte2 = buf.readUInt8(2);
@@ -193,8 +212,11 @@ class SwitchbotAdvertising {
     return data;
   }
 
-  _parseServiceDataForWoPresence(buf) {
+  _parseServiceDataForWoPresence(buf, onlog) {
     if (buf.length !== 6) {
+      if (onlog && typeof onlog === 'function') {
+        onlog(`[_parseServiceDataForWoPresence] Buffer length ${buf.length} !== 6!`);
+      }
       return null;
     }
     let byte1 = buf.readUInt8(1);
@@ -218,8 +240,11 @@ class SwitchbotAdvertising {
     return data;
   }
 
-  _parseServiceDataForWoContact(buf) {
+  _parseServiceDataForWoContact(buf, onlog) {
     if (buf.length !== 9) {
+      if (onlog && typeof onlog === 'function') {
+        onlog(`[_parseServiceDataForWoContact] Buffer length ${buf.length} !== 9!`);
+      }
       return null;
     }
 
@@ -249,14 +274,18 @@ class SwitchbotAdvertising {
     return data;
   }
 
-  _parseServiceDataForWoCurtain(buf) {
-    if (buf.length !== 5) {
+  _parseServiceDataForWoCurtain(buf, onlog) {
+    if (buf.length !== 5 && buf.length !== 6) {
+      if (onlog && typeof onlog === 'function') {
+        onlog(`[_parseServiceDataForWoCurtain] Buffer length ${buf.length} !== 5 or 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);
 
     let calibration = (byte1 & 0b01000000) ? true : false; // Whether the calibration is completed
     let battery = byte2 & 0b01111111; // %

package/lib/switchbot.js

@@ -34,6 +34,7 @@ class Switchbot {
     this.noble = noble;
     this.ondiscover = null;
     this.onadvertisement = null;
+    this.onlog = null;
 
     // Private properties
     this._scanning = false;
@@ -178,7 +179,7 @@ class Switchbot {
   }
 
   _getDeviceObject(peripheral, id, model) {
-    let ad = switchbotAdvertising.parse(peripheral);
+    let ad = switchbotAdvertising.parse(peripheral, this.onlog);
     if (this._filterAdvertising(ad, id, model)) {
       let device = null;
       switch (ad.serviceData.model) {
@@ -293,7 +294,7 @@ class Switchbot {
 
         // Set a handler for the 'discover' event
         this.noble.on('discover', (peripheral) => {
-          let ad = switchbotAdvertising.parse(peripheral);
+          let ad = switchbotAdvertising.parse(peripheral, this.onlog);
           if (this._filterAdvertising(ad, p.id, p.model)) {
             if (this.onadvertisement && typeof (this.onadvertisement) === 'function') {
               this.onadvertisement(ad);

package/package.json

@@ -1,42 +1,42 @@
 {
-    "name": "node-switchbot",
-    "version": "1.1.3-beta.7",
-    "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": {
-        "@abandonware/noble": "^1.9.2-15"
-    },
-    "devDependencies": {
-        "npm-check-updates": "^12.4.0"
-    }
+  "name": "node-switchbot",
+  "version": "1.2.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": {
+    "@abandonware/noble": "^1.9.2-15"
+  },
+  "devDependencies": {
+    "npm-check-updates": "^12.5.2"
+  }
 }