node-switchbot 1.0.7

package/lib/switchbot-advertising.js

@@ -0,0 +1,255 @@
+/* ------------------------------------------------------------------
+* node-linking - switchbot-advertising.js
+*
+* Copyright (c) 2019, Futomi Hatano, All rights reserved.
+* Released under the MIT license
+* Date: 2020-02-11
+* ---------------------------------------------------------------- */
+'use strict';
+
+class SwitchbotAdvertising {
+  constructor() { }
+
+  /* ------------------------------------------------------------------
+  * parse(peripheral)
+  * - Parse advertising packets coming from switchbot devices
+  *
+  * [Arguments]
+  * - peripheral | Object  | Required | A `Peripheral` object of noble
+  *
+  * [Returen value]
+  * - An object as follows:
+  *
+  * WoHand	
+  * {
+  *   id: 'c12e453e2008',
+  *   address: 'c1:2e:45:3e:20:08',
+  *   rssi: -43,
+  *   serviceData: {
+  *     model: 'H',
+  *     modelName: 'WoHand',
+  *     mode: false,
+  *     state: false,
+  *     battery: 95
+  *   }
+  * }
+  *
+  * WoSensorTH
+  * {
+  *   id: 'cb4eb903c96d',
+  *   address: 'cb:4e:b9:03:c9:6d',
+  *   rssi: -54,
+  *   serviceData: {
+  *     model: 'T',
+  *     modelName: 'WoSensorTH',
+  *     temperature: { c: 26.2, f: 79.2 },
+  *     fahrenheit: false,
+  *     humidity: 45,
+  *     battery: 100
+  *   }
+  * }
+  *
+  * WoCurtain
+  * {
+  *   id: 'ec58c5d00111',
+  *   address: 'ec:58:c5:d0:01:11',
+  *   rssi: -39,
+  *   serviceData: {
+  *     model: 'c',
+  *     modelName: 'WoCurtain',
+  *     calibration: true,
+  *     battery: 91,
+  *     position: 1,
+  *     lightLevel: 1
+  *   }
+  * }
+  * 
+  * If the specified `Peripheral` does not represent any switchbot
+  * device, this method will return `null`.
+  * ---------------------------------------------------------------- */
+  parse(peripheral) {
+    let ad = peripheral.advertisement;
+    if (!ad || !ad.serviceData) {
+      return null;
+    }
+    if (ad.serviceData[0].uuid !== '0d00') {
+      return null;
+    }
+    let buf = ad.serviceData[0].data;
+    if (!buf || !Buffer.isBuffer(buf) || buf.length < 3) {
+      return null;
+    }
+
+    let model = buf.slice(0, 1).toString('utf8');
+    let sd = null;
+
+    if (model === 'H') { // WoHand
+      sd = this._parseServiceDataForWoHand(buf);
+    } else if (model === 'h') { // 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
+      sd = this._parseServiceDataForWoPresence(buf);
+    } else if (model === 'C') { // WoContact
+      sd = this._parseServiceDataForWoContact(buf);
+    } else {
+      return null;
+    }
+
+    if (!sd) {
+      return null;
+    }
+    let address = peripheral.address || '';
+    if (address === '') {
+      address = peripheral.advertisement.manufacturerData || '';
+      if (address !== '') {
+        const str = peripheral.advertisement.manufacturerData.toString('hex').slice(4);
+        address = str.substr(0, 2);
+        for (var i = 2; i < str.length; i += 2) {
+          address = address + ":" + str.substr(i, 2);
+        }
+        // console.log("address", typeof(address), address);
+      }
+    }
+    else {
+      address = address.replace(/-/g, ':');
+    }
+    let data = {
+      id: peripheral.id,
+      address: address,
+      rssi: peripheral.rssi,
+      serviceData: sd
+    };
+    return data;
+  }
+
+  _parseServiceDataForWoHand(buf) {
+    if (buf.length !== 3) {
+      return null;
+    }
+    let byte1 = buf.readUInt8(1);
+    let byte2 = buf.readUInt8(2);
+
+    let mode = (byte1 & 0b10000000) ? true : false; // Whether the light switch Add-on is used or not
+    let state = (byte1 & 0b01000000) ? true : false; // Whether the switch status is ON or OFF
+    let battery = byte2 & 0b01111111; // %
+
+    let data = {
+      model: 'H',
+      modelName: 'WoHand',
+      mode: mode,
+      state: state,
+      battery: battery
+    };
+
+    return data;
+  }
+
+  _parseServiceDataForWoHumi(buf) {
+    if (buf.length !== 3) {
+      return null;
+    }
+    let byte1 = buf.readUInt8(1);
+    let byte2 = buf.readUInt8(2);
+
+    let mode = (byte1 & 0b10000000) ? true : false; // Whether the light switch Add-on is used or not
+    let state = (byte1 & 0b01000000) ? true : false; // Whether the switch status is ON or OFF
+
+    let data = {
+      model: 'h',
+      modelName: 'WoHumi',
+      mode: mode,
+      state: state
+    };
+
+    return data;
+  }
+
+  _parseServiceDataForWoSensorTH(buf) {
+    if (buf.length !== 6) {
+      return null;
+    }
+    let byte2 = buf.readUInt8(2);
+    let byte3 = buf.readUInt8(3);
+    let byte4 = buf.readUInt8(4);
+    let byte5 = buf.readUInt8(5);
+
+    let temp_sign = (byte4 & 0b10000000) ? 1 : -1;
+    let temp_c = temp_sign * ((byte4 & 0b01111111) + (byte3 / 10));
+    let temp_f = (temp_c * 9 / 5) + 32;
+    temp_f = Math.round(temp_f * 10) / 10;
+
+    let data = {
+      model: 'T',
+      modelName: 'WoSensorTH',
+      temperature: {
+        c: temp_c,
+        f: temp_f
+      },
+      fahrenheit: (byte5 & 0b10000000) ? true : false,
+      humidity: byte5 & 0b01111111,
+      battery: (byte2 & 0b01111111)
+    };
+
+    return data;
+  }
+
+  _parseServiceDataForWoPresence(buf) {
+    if (buf.length !== 6) {
+      return null;
+    }
+
+    let data = {
+      model: 'P',
+      modelName: 'WoPresence',
+      battery: (byte2 & 0b01111111)
+    };
+
+    return data;
+  }
+
+  _parseServiceDataForWoContact(buf) {
+    if (buf.length !== 6) {
+      return null;
+    }
+
+    let data = {
+      model: 'C',
+      modelName: 'WoContact',
+      battery: (byte2 & 0b01111111)
+    };
+
+    return data;
+  }
+
+  _parseServiceDataForWoCurtain(buf) {
+    if (buf.length !== 5) {
+      return null;
+    }
+    let byte1 = buf.readUInt8(1);
+    let byte2 = buf.readUInt8(2);
+    let byte3 = buf.readUInt8(3);
+    let byte4 = buf.readUInt8(4);
+
+    let calibration = byte1 & 0b01000000; // 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)
+
+    let data = {
+      model: 'c',
+      modelName: 'WoCurtain',
+      calibration: calibration ? true : false,
+      battery: battery,
+      position: currPosition,
+      lightLevel: lightLevel
+    };
+
+    return data;
+  }
+}
+
+module.exports = new SwitchbotAdvertising();

package/lib/switchbot-device-wocontact.js

@@ -0,0 +1,16 @@
+/* ------------------------------------------------------------------
+* node-linking - switchbot-device-wocontact.js
+*
+* Copyright (c) 2019, Futomi Hatano, All rights reserved.
+* Released under the MIT license
+* Date: 2019-11-16
+* ---------------------------------------------------------------- */
+'use strict';
+const SwitchbotDevice = require('./switchbot-device.js');
+
+class SwitchbotDeviceWoContact extends SwitchbotDevice {
+
+
+}
+
+module.exports = SwitchbotDeviceWoContact;

package/lib/switchbot-device-wocurtain.js

@@ -0,0 +1,109 @@
+/* ------------------------------------------------------------------
+* node-linking - switchbot-device-wocurtain.js
+*
+* Copyright (c) 2020, SwitchBot, All rights reserved.
+* Released under the MIT license
+* Date: 2020-10-26
+* ---------------------------------------------------------------- */
+'use strict';
+const SwitchbotDevice = require('./switchbot-device.js');
+
+class SwitchbotDeviceWoCurtain extends SwitchbotDevice {
+
+    /* ------------------------------------------------------------------
+    * open()
+    * - Open the curtain
+    *
+    * [Arguments]
+    * - none
+    *
+    * [Returen 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
+    *
+    * [Returen 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
+    *
+    * [Returen value]
+    * - Promise object
+    *   Nothing will be passed to the `resolve()`.
+    * ---------------------------------------------------------------- */
+    pause() {
+        return this._operateCurtain([0x57, 0x0f, 0x45, 0x01, 0x00, 0xff]);
+    }
+
+    /* ------------------------------------------------------------------
+    * runToPos()
+    * - run to the targe position
+    *
+    * [Arguments]
+    * - percent | number | Required | the percentage of target position
+    *
+    * [Returen 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));
+            });
+        }
+        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]);
+    }
+
+    _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;

package/lib/switchbot-device-wohand.js

@@ -0,0 +1,106 @@
+/* ------------------------------------------------------------------
+* node-linking - switchbot-device-wohand.js
+*
+* Copyright (c) 2019-2020, Futomi Hatano, All rights reserved.
+* Released under the MIT license
+* Date: 2020-02-10
+* ---------------------------------------------------------------- */
+'use strict';
+const SwitchbotDevice = require('./switchbot-device.js');
+
+class SwitchbotDeviceWoHand 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 = SwitchbotDeviceWoHand;

package/lib/switchbot-device-wohumi.js

@@ -0,0 +1,106 @@
+/* ------------------------------------------------------------------
+* node-linking - switchbot-device-wohumi.js
+*
+* Copyright (c) 2019-2020, Futomi Hatano, All rights reserved.
+* Released under the MIT license
+* Date: 2020-02-10
+* ---------------------------------------------------------------- */
+'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-device-wopresence.js

@@ -0,0 +1,16 @@
+/* ------------------------------------------------------------------
+* node-linking - switchbot-device-wopresence.js
+*
+* Copyright (c) 2019, Futomi Hatano, All rights reserved.
+* Released under the MIT license
+* Date: 2019-11-16
+* ---------------------------------------------------------------- */
+'use strict';
+const SwitchbotDevice = require('./switchbot-device.js');
+
+class SwitchbotDeviceWoPresence extends SwitchbotDevice {
+
+
+}
+
+module.exports = SwitchbotDeviceWoPresence;

package/lib/switchbot-device-wosensorth.js

@@ -0,0 +1,16 @@
+/* ------------------------------------------------------------------
+* node-linking - switchbot-device-wosensorth.js
+*
+* Copyright (c) 2019, Futomi Hatano, All rights reserved.
+* Released under the MIT license
+* Date: 2019-11-16
+* ---------------------------------------------------------------- */
+'use strict';
+const SwitchbotDevice = require('./switchbot-device.js');
+
+class SwitchbotDeviceWoSensorTH extends SwitchbotDevice {
+
+
+}
+
+module.exports = SwitchbotDeviceWoSensorTH;