node-switchbot 1.1.3-beta.3 → 1.1.3-beta.4

package/lib/switchbot.js

@@ -1,17 +1,16 @@
-'use strict';
-const parameterChecker = require('./parameter-checker.js');
-const switchbotAdvertising = require('./switchbot-advertising.js');
+import * as parameterCheckerJs from "./parameter-checker.js";
+import * as switchbotAdvertisingJs from "./switchbot-advertising.js";
 
-const SwitchbotDevice = require('./switchbot-device.js');
-const SwitchbotDeviceWoHand = require('./switchbot-device-wohand.js');
-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');
+import SwitchbotDevice from "./switchbot-device.js";
+import SwitchbotDeviceWoHand from "./switchbot-device-wohand.js";
+import SwitchbotDeviceWoCurtain from "./switchbot-device-wocurtain.js";
+import SwitchbotDeviceWoPresence from "./switchbot-device-wopresence.js";
+import SwitchbotDeviceWoContact from "./switchbot-device-wocontact.js";
+import SwitchbotDeviceWoSensorTH from "./switchbot-device-wosensorth.js";
+import SwitchbotDeviceWoHumi from "./switchbot-device-wohumi.js";
 
 class Switchbot {
-  /* ------------------------------------------------------------------
+	/* ------------------------------------------------------------------
   * Constructor
   *	
   * [Arguments]
@@ -21,27 +20,27 @@ class Switchbot {
   *           |         |          | If you don't specify this parameter, this
   *           |         |          | module automatically creates it.
   * ---------------------------------------------------------------- */
-  constructor(params) {
-    // Check parameters
-    let noble = null;
-    if (params && params.noble) {
-      noble = params.noble;
-    } else {
-      noble = require('@abandonware/noble');
-    }
+	constructor(params) {
+		// Check parameters
+		let noble = null;
+		if (params && params.noble) {
+			noble = params.noble;
+		} else {
+			noble = require("@abandonware/noble");
+		}
 
-    // Plublic properties
-    this.noble = noble;
-    this.ondiscover = null;
-    this.onadvertisement = null;
+		// Plublic properties
+		this.noble = noble;
+		this.ondiscover = null;
+		this.onadvertisement = null;
 
-    // Private properties
-    this._scanning = false;
-    this._DEFAULT_DISCOVERY_DURATION = 5000
-    this._PRIMARY_SERVICE_UUID_LIST = ['cba20d00224d11e69fb80002a5d5c51b'];
-  };
+		// Private properties
+		this._scanning = false;
+		this._DEFAULT_DISCOVERY_DURATION = 5000;
+		this._PRIMARY_SERVICE_UUID_LIST = ["cba20d00224d11e69fb80002a5d5c51b"];
+	}
 
-  /* ------------------------------------------------------------------
+	/* ------------------------------------------------------------------
   * discover([params])
   * - Discover switchbot devices
   *
@@ -73,162 +72,162 @@ class Switchbot {
   *   An array will be passed to the `resolve()`, which includes
   *   `SwitchbotDevice` objects representing the found devices.
   * ---------------------------------------------------------------- */
-  discover(params = {}) {
-    let promise = new Promise((resolve, reject) => {
-      // Check the parameters
-      let valid = parameterChecker.check(params, {
-        duration: { required: false, type: 'integer', min: 1, max: 60000 },
-        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);
+	discover(params = {}) {
+		let promise = new Promise((resolve, reject) => {
+			// Check the parameters
+			let valid = parameterCheckerJs.check(params, {
+				duration: { required: false, type: "integer", min: 1, max: 60000 },
+				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);
 
-      if (!valid) {
-        reject(new Error(parameterChecker.error.message));
-        return;
-      }
+			if (!valid) {
+				reject(new Error(parameterCheckerJs.error.message));
+				return;
+			}
 
-      if (!params) {
-        params = {};
-      }
+			if (!params) {
+				params = {};
+			}
 
-      // Determine the values of the parameters
-      let p = {
-        duration: params.duration || this._DEFAULT_DISCOVERY_DURATION,
-        model: params.model || '',
-        id: params.id || '',
-        quick: params.quick ? true : false
-      };
+			// Determine the values of the parameters
+			let p = {
+				duration: params.duration || this._DEFAULT_DISCOVERY_DURATION,
+				model: params.model || "",
+				id: params.id || "",
+				quick: params.quick ? true : false
+			};
 
-      // Initialize the noble object
-      this._init().then(() => {
-        let peripherals = {};
-        let timer = null;
-        let finishDiscovery = () => {
-          if (timer) {
-            clearTimeout(timer);
-          }
-          this.noble.removeAllListeners('discover');
-          this.noble.stopScanning();
-          let device_list = [];
-          for (let addr in peripherals) {
-            device_list.push(peripherals[addr]);
-          }
-          resolve(device_list);
-        };
+			// Initialize the noble object
+			this._init().then(() => {
+				let peripherals = {};
+				let timer = null;
+				let finishDiscovery = () => {
+					if (timer) {
+						clearTimeout(timer);
+					}
+					this.noble.removeAllListeners("discover");
+					this.noble.stopScanning();
+					let device_list = [];
+					for (let addr in peripherals) {
+						device_list.push(peripherals[addr]);
+					}
+					resolve(device_list);
+				};
 
-        // Set an handler for the 'discover' event
-        this.noble.on('discover', (peripheral) => {
-          let device = this._getDeviceObject(peripheral, p.id, p.model);
-          if (!device) {
-            return;
-          }
-          let id = device.id;
-          peripherals[id] = device;
+				// Set an handler for the 'discover' event
+				this.noble.on("discover", (peripheral) => {
+					let device = this._getDeviceObject(peripheral, p.id, p.model);
+					if (!device) {
+						return;
+					}
+					let id = device.id;
+					peripherals[id] = device;
 
-          if (this.ondiscover && typeof (this.ondiscover) === 'function') {
-            this.ondiscover(device);
-          }
+					if (this.ondiscover && typeof (this.ondiscover) === "function") {
+						this.ondiscover(device);
+					}
 
-          if (p.quick) {
-            finishDiscovery();
-            return;
-          }
-        });
+					if (p.quick) {
+						finishDiscovery();
+						return;
+					}
+				});
 
-        // Start scaning
-        this.noble.startScanning(this._PRIMARY_SERVICE_UUID_LIST, false, (error) => {
-          if (error) {
-            reject(error);
-            return;
-          }
-          timer = setTimeout(() => {
-            finishDiscovery();
-          }, p.duration);
-        });
-      }).catch((error) => {
-        reject(error);
-      });
-    });
-    return promise;
-  }
+				// Start scaning
+				this.noble.startScanning(this._PRIMARY_SERVICE_UUID_LIST, false, (error) => {
+					if (error) {
+						reject(error);
+						return;
+					}
+					timer = setTimeout(() => {
+						finishDiscovery();
+					}, p.duration);
+				});
+			}).catch((error) => {
+				reject(error);
+			});
+		});
+		return promise;
+	}
 
-  _init() {
-    let promise = new Promise((resolve, reject) => {
-      switch (this.noble.state) {
-        case 'poweredOn':
-          resolve();
-          return;
-        case 'unsupported', 'unauthorized', 'poweredOff':
-          let err = new Error('Failed to initialize the Noble object: ' + this.noble.state);
-          reject(err);
-          return;
-        default: // 'resetting', 'unknown'
-          this.noble.once('stateChange', (state) => {
-            if (state === 'poweredOn') {
-              resolve();
-            } else {
-              let err = new Error('Failed to initialize the Noble object: ' + state);
-              reject(err);
-            }
-          });
-      }
-    });
-    return promise;
-  }
+	_init() {
+		let promise = new Promise((resolve, reject) => {
+			switch (this.noble.state) {
+			case "poweredOn":
+				resolve();
+				return;
+			case "unsupported", "unauthorized", "poweredOff":
+				let err = new Error("Failed to initialize the Noble object: " + this.noble.state);
+				reject(err);
+				return;
+			default: // 'resetting', 'unknown'
+				this.noble.once("stateChange", (state) => {
+					if (state === "poweredOn") {
+						resolve();
+					} else {
+						let err = new Error("Failed to initialize the Noble object: " + state);
+						reject(err);
+					}
+				});
+			}
+		});
+		return promise;
+	}
 
-  _getDeviceObject(peripheral, id, model) {
-    let ad = switchbotAdvertising.parse(peripheral);
-    if (this._filterAdvertising(ad, id, model)) {
-      let device = null;
-      switch (ad.serviceData.model) {
-        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':
-          device = new SwitchbotDeviceWoPresence(peripheral, this.noble);
-          break;
-        case 'd':
-          device = new SwitchbotDeviceWoContact(peripheral, this.noble);
-          break;
-        case 'c':
-          device = new SwitchbotDeviceWoCurtain(peripheral, this.noble);
-          break;
-        default: // 'resetting', 'unknown'
-          device = new SwitchbotDevice(peripheral, this.noble);
-      }
-      return device;
-    } else {
-      return null;
-    }
-  }
+	_getDeviceObject(peripheral, id, model) {
+		let ad = switchbotAdvertisingJs.parse(peripheral);
+		if (this._filterAdvertising(ad, id, model)) {
+			let device = null;
+			switch (ad.serviceData.model) {
+			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":
+				device = new SwitchbotDeviceWoPresence(peripheral, this.noble);
+				break;
+			case "d":
+				device = new SwitchbotDeviceWoContact(peripheral, this.noble);
+				break;
+			case "c":
+				device = new SwitchbotDeviceWoCurtain(peripheral, this.noble);
+				break;
+			default: // 'resetting', 'unknown'
+				device = new SwitchbotDevice(peripheral, this.noble);
+			}
+			return device;
+		} else {
+			return null;
+		}
+	}
 
-  _filterAdvertising(ad, id, model) {
-    if (!ad) {
-      return false;
-    }
-    if (id) {
-      id = id.toLowerCase().replace(/\:/g, '');
-      let ad_id = ad.address.toLowerCase().replace(/[^a-z0-9]/g, '');
-      if (ad_id !== id) {
-        return false;
-      }
-    }
-    if (model) {
-      if (ad.serviceData.model !== model) {
-        return false;
-      }
-    }
-    return true;
-  }
+	_filterAdvertising(ad, id, model) {
+		if (!ad) {
+			return false;
+		}
+		if (id) {
+			id = id.toLowerCase().replace(/\:/g, "");
+			let ad_id = ad.address.toLowerCase().replace(/[^a-z0-9]/g, "");
+			if (ad_id !== id) {
+				return false;
+			}
+		}
+		if (model) {
+			if (ad.serviceData.model !== model) {
+				return false;
+			}
+		}
+		return true;
+	}
 
-  /* ------------------------------------------------------------------
+	/* ------------------------------------------------------------------
   * startScan([params])
   * - Start to monitor advertising packets coming from switchbot devices
   *
@@ -265,58 +264,58 @@ class Switchbot {
   * - Promise object
   *   Nothing will be passed to the `resolve()`.
   * ---------------------------------------------------------------- */
-  startScan(params) {
-    let promise = new Promise((resolve, reject) => {
-      // Check the parameters
-      let valid = parameterChecker.check(params, {
-        model: { required: false, type: 'string', enum: ['H', 'T', 'e', 's', 'd', 'c'] },
-        id: { required: false, type: 'string', min: 12, max: 17 },
-      }, false);
+	startScan(params) {
+		let promise = new Promise((resolve, reject) => {
+			// Check the parameters
+			let valid = parameterCheckerJs.check(params, {
+				model: { required: false, type: "string", enum: ["H", "T", "e", "s", "d", "c"] },
+				id: { required: false, type: "string", min: 12, max: 17 },
+			}, false);
 
-      if (!valid) {
-        reject(new Error(parameterChecker.error.message));
-        return;
-      }
+			if (!valid) {
+				reject(new Error(parameterCheckerJs.error.message));
+				return;
+			}
 
-      if (!params) {
-        params = {};
-      }
+			if (!params) {
+				params = {};
+			}
 
-      // Initialize the noble object
-      this._init().then(() => {
+			// Initialize the noble object
+			this._init().then(() => {
 
-        // Determine the values of the parameters
-        let p = {
-          model: params.model || '',
-          id: params.id || ''
-        };
+				// Determine the values of the parameters
+				let p = {
+					model: params.model || "",
+					id: params.id || ""
+				};
 
-        // Set an handler for the 'discover' event
-        this.noble.on('discover', (peripheral) => {
-          let ad = switchbotAdvertising.parse(peripheral);
-          if (this._filterAdvertising(ad, p.id, p.model)) {
-            if (this.onadvertisement && typeof (this.onadvertisement) === 'function') {
-              this.onadvertisement(ad);
-            }
-          }
-        });
+				// Set an handler for the 'discover' event
+				this.noble.on("discover", (peripheral) => {
+					let ad = switchbotAdvertisingJs.parse(peripheral);
+					if (this._filterAdvertising(ad, p.id, p.model)) {
+						if (this.onadvertisement && typeof (this.onadvertisement) === "function") {
+							this.onadvertisement(ad);
+						}
+					}
+				});
 
-        // Start scaning
-        this.noble.startScanning(this._PRIMARY_SERVICE_UUID_LIST, true, (error) => {
-          if (error) {
-            reject(error);
-          } else {
-            resolve();
-          }
-        });
-      }).catch((error) => {
-        reject(error);
-      });
-    });
-    return promise;
-  }
+				// Start scaning
+				this.noble.startScanning(this._PRIMARY_SERVICE_UUID_LIST, true, (error) => {
+					if (error) {
+						reject(error);
+					} else {
+						resolve();
+					}
+				});
+			}).catch((error) => {
+				reject(error);
+			});
+		});
+		return promise;
+	}
 
-  /* ------------------------------------------------------------------
+	/* ------------------------------------------------------------------
   * stopScan()
   * - Stop to monitor advertising packets coming from switchbot devices
   *
@@ -326,12 +325,12 @@ class Switchbot {
   * [Returen value]
   * - none
   * ---------------------------------------------------------------- */
-  stopScan() {
-    this.noble.removeAllListeners('discover');
-    this.noble.stopScanning();
-  }
+	stopScan() {
+		this.noble.removeAllListeners("discover");
+		this.noble.stopScanning();
+	}
 
-  /* ------------------------------------------------------------------
+	/* ------------------------------------------------------------------
   * wait(msec) {
   * - Wait for the specified time (msec)
   *
@@ -342,22 +341,22 @@ class Switchbot {
   * - Promise object
   *   Nothing will be passed to the `resolve()`.
   * ---------------------------------------------------------------- */
-  wait(msec) {
-    return new Promise((resolve, reject) => {
-      // Check the parameters
-      let valid = parameterChecker.check({ msec: msec }, {
-        msec: { required: true, type: 'integer', min: 0 }
-      });
+	wait(msec) {
+		return new Promise((resolve, reject) => {
+			// Check the parameters
+			let valid = parameterCheckerJs.check({ msec: msec }, {
+				msec: { required: true, type: "integer", min: 0 }
+			});
 
-      if (!valid) {
-        reject(new Error(parameterChecker.error.message));
-        return;
-      }
-      // Set a timer
-      setTimeout(resolve, msec);
-    });
-  }
+			if (!valid) {
+				reject(new Error(parameterCheckerJs.error.message));
+				return;
+			}
+			// Set a timer
+			setTimeout(resolve, msec);
+		});
+	}
 
 }
 
-module.exports = Switchbot;
+export default Switchbot;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-switchbot",
-    "version": "1.1.3-beta.3",
+    "version": "1.1.3-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": [
@@ -11,7 +11,9 @@
     },
     "scripts": {
         "check": "npm install && npm outdated",
-        "update": "ncu -u && npm update && npm install"
+        "update": "ncu -u && npm update && npm install",
+        "lint": "eslint lib/**.js",
+        "prepublishOnly": "npm run lint && npm install"
     },
     "keywords": [
         "switchbot",
@@ -37,6 +39,11 @@
         "@abandonware/noble": "^1.9.2-15"
     },
     "devDependencies": {
+        "eslint": "^7.32.0",
+        "eslint-config-standard": "^16.0.3",
+        "eslint-plugin-import": "^2.25.4",
+        "eslint-plugin-node": "^11.1.0",
+        "eslint-plugin-promise": "^5.2.0",
         "npm-check-updates": "^12.0.5"
     }
 }