node-switchbot 1.3.0 → 1.4.2-beta.0

package/README.md

@@ -16,7 +16,8 @@ and [SwitchBot Contact Sensor](https://www.switch-bot.com/products/contact-senso
 This module is unofficial. It was developed by reference to [the official python code](https://github.com/OpenWonderLabs/python-host).
 But some functionalities of this module were developed through trial and error. So some information obtained from this module might be wrong.
 
----------------------------------------
+---
+
 ## Table of Contents
 
 - [node-switchbot](#node-switchbot)
@@ -69,9 +70,8 @@ The node-switchbot supports only Linux-based OSes, such as Raspbian, Ubuntu, and
 
 ## Dependencies
 
-* [Node.js](https://nodejs.org/en/) 10 +
-* [@abandonware/noble](https://github.com/abandonware/noble)
-
+- [Node.js](https://nodejs.org/en/) 10 +
+- [@abandonware/noble](https://github.com/abandonware/noble)
 
 See the document of the [@abandonware/noble](https://github.com/abandonware/noble) for details on installing the [@abandonware/noble](https://github.com/abandonware/noble).
 
@@ -95,7 +95,8 @@ $ npm install @abandonware/noble
 $ npm install node-switchbot
 ```
 
----------------------------------------
+---
+
 ## Quick Start
 
 ### Monitoring Advertising packets
@@ -131,23 +132,26 @@ The [`startScan()`](#startscan-method) and [`wait()`](#Switchbot-wait-method) me
 
 ```javascript
 // Load the node-switchbot and get a `Switchbot` constructor object
-const Switchbot = require('node-switchbot');
+const Switchbot = require("node-switchbot");
 // Create an `Switchbot` object
 let switchbot = new Switchbot();
 
 // Start to monitor advertisement packets
-switchbot.startScan().then(() => {
-  // Set an event hander
-  switchbot.onadvertisement = (ad) => {
-    console.log(JSON.stringify(ad, null, '  '));
-  };
-  // Wait 10 seconds
-  return switchbot.wait(10000);
-}).then(() => {
-  // Stop to monitor
-  switchbot.stopScan();
-  process.exit();
-});
+switchbot
+  .startScan()
+  .then(() => {
+    // Set an event hander
+    switchbot.onadvertisement = (ad) => {
+      console.log(JSON.stringify(ad, null, "  "));
+    };
+    // Wait 10 seconds
+    return switchbot.wait(10000);
+  })
+  .then(() => {
+    // Stop to monitor
+    switchbot.stopScan();
+    process.exit();
+  });
 ```
 
 The sample codes above will output the result as follows:
@@ -204,15 +208,15 @@ This sample discovers a Bot (WoHand), then put the Bot's arm down, finally put i
 
 ```javascript
 // Load the node-switchbot and get a `Switchbot` constructor object
-const Switchbot = require('node-switchbot');
+const Switchbot = require("node-switchbot");
 // Create an `Switchbot` object
 const switchbot = new Switchbot();
 
 (async () => {
   // Find a Bot (WoHand)
-  const bot_list = await switchbot.discover({ model: 'H', quick: true });
+  const bot_list = await switchbot.discover({ model: "H", quick: true });
   if (bot_list.length === 0) {
-    throw new Error('No device was found.');
+    throw new Error("No device was found.");
   }
   // The `SwitchbotDeviceWoHand` object representing the found Bot.
   let device = bot_list[0];
@@ -230,7 +234,8 @@ In order to manipulate the arm of your Bot, you have to discover your Bot using
 
 In this code, you can get a [`SwitchbotDeviceWoHand`](#SwitchbotDeviceWoHand-object) object representing the found Bot. Using the [`down()`](#SwitchbotDeviceWoHand-down-method) and [`up()`](#SwitchbotDeviceWoHand-up-method) methods of the object, you can move the arm. In addition to these methods, you can use the [`press()`](#SwitchbotDeviceWoHand-press-method), [`turnOn()`](#SwitchbotDeviceWoHand-turnOn-method), and [`turnOff()`](#SwitchbotDeviceWoHand-turnOff-method) methods as well.
 
----------------------------------------
+---
+
 ## `Switchbot` object
 
 In order to use the node-switchbot, you have to load the node-switchbot module as follows:
@@ -247,9 +252,9 @@ const switchbot = new Switchbot();
 
 The `Switchbot` constructor takes an argument optionally. It must be a hash object containing the properties as follows:
 
-Property | Type   | Required | Description
-:--------|:-------|:---------|:-----------
-`noble`  | Noble  | option   | a Noble object of the [`@abandonware/noble`](https://github.com/abandonware/noble) module
+| Property | Type  | Required | Description                                                                               |
+| :------- | :---- | :------- | :---------------------------------------------------------------------------------------- |
+| `noble`  | Noble | option   | a Noble object of the [`@abandonware/noble`](https://github.com/abandonware/noble) module |
 
 The node-switchbot module uses the [`@abandonware/noble`](https://github.com/abandonware/noble) module in order to interact with BLE devices. If you want to interact other BLE devices using the `@abandonware/noble` module, you can create an `Noble` object by yourself, then pass it to this module. If you don't specify a `Noble` object to the `noble` property, this module automatically create a `Noble` object internally.
 
@@ -270,12 +275,12 @@ In the code snippet above, the variable `switchbot` is an `Switchbot` object. Th
 
 The `discover` method finds devices. This method returns a `Promise` object. This method takes an argument which is a hash object containing parameters as follows:
 
-Property     | Type    | Required | Description
-:------------|:--------|:---------|:------------
-`duration`   | Integer | Optional | Duration for discovery process (msec). The default value is 5000 (msec).
-`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.
-`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 parameter is case-insensitive, and colons are ignored.
-`quick`      | Boolean | Optional | If this value is `true`, this method finishes the discovery process when the first device is found, then calls the `resolve()` function without waiting the specified `duration`. The default value is `false`.
+| Property   | Type    | Required | Description                                                                                                                                                                                                      |
+| :--------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `duration` | Integer | Optional | Duration for discovery process (msec). The default value is 5000 (msec).                                                                                                                                         |
+| `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. |
+| `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 parameter is case-insensitive, and colons are ignored.             |
+| `quick`    | Boolean | Optional | If this value is `true`, this method finishes the discovery process when the first device is found, then calls the `resolve()` function without waiting the specified `duration`. The default value is `false`.  |
 
 In the code snippet below, no parameter is passed to the method:
 
@@ -287,7 +292,7 @@ switchbot.discover().then((device_list) => {
 });
 ```
 
-If no parameter is passed to the method as the code above,  an `Array` object will be passed to the `resolve()` function in 5 seconds. The `Array` object contains [`SwitchbotDevice`](#SwitchbotDevice-object) objects representing the found devices. See the section "[`SwitchbotDevice`](#SwitchbotDevice-object) objects" for more details.
+If no parameter is passed to the method as the code above, an `Array` object will be passed to the `resolve()` function in 5 seconds. The `Array` object contains [`SwitchbotDevice`](#SwitchbotDevice-object) objects representing the found devices. See the section "[`SwitchbotDevice`](#SwitchbotDevice-object) objects" for more details.
 
 If you want a quick response, you can set the `quick` property to `true`.
 
@@ -333,10 +338,10 @@ The discovery process was finished.
 
 The `startScan()` method starts to scan advertising packets coming from devices. This method takes an argument which is a hash object containing the parameters as follows:
 
-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.
-`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.
+| 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. |
+| `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.
 
@@ -384,7 +389,7 @@ The `serviceData` property depends on the model of the device. See the section "
 
 ### `stopScan()` method
 
-The `stopScan()` method stops to scan advertising packets coming from devices. This method returns nothing. Note that this method is *not* asynchronous but synchronous unlike the other methods. See the section "[`startScan()` method](#startscan-method)" for details.
+The `stopScan()` method stops to scan advertising packets coming from devices. This method returns nothing. Note that this method is _not_ asynchronous but synchronous unlike the other methods. See the section "[`startScan()` method](#startscan-method)" for details.
 
 ### `onadvertisement` event handler
 
@@ -398,7 +403,8 @@ The `wait()` method waits for the specified milliseconds. This method takes an i
 
 This method has nothing to do with Switchbot devices. It's just a utility method. See the section "[Quick Start](#Quick-Start)" for details of the usage of this method.
 
----------------------------------------
+---
+
 ## `SwitchbotDevice` object
 
 The `SwitchbotDevice` object represents a Switchbot device (Bot, Meter, Curtain, Contact or Motion), which is created through the discovery process triggered by the [`Switchbot.discover()`](#Switchbot-discover-method) method.
@@ -411,15 +417,15 @@ You can use the properties and methods described in this section on Bot, Meter,
 
 The `SwitchbotDevice` object supports the properties as follows:
 
-Property         | Type     | Description
-:----------------|:---------|:-----------
-`id`             | String   | ID of the device. (e.g., `"cb4eb903c96d"`)
-`address`        | String   | MAC address of the device. Basically it is as same as the value of the `id` except that this value includes `:` in the string. (e.g., `"cb:4e:b9:03:c9:6d"`)
-`model`           | String   | This value is `"H"` "Bot (WoHand)", `"T"` "Meter (WoSensorTH)", `"c"` "Curtain (WoCurtain)", `"d"` "Contact (WoContact)" or `"s"` "Motion (WoMotion)".
-`modelName`       | String   | This value is `"WoHand"`, `"WoSensorTH"`, `WoCurtain`, `WoContect` or `WoMotion`.
-`connectionState` | String   | This value indicates the BLE connection state. `"connecting"`, `"connected"`, `"disconnecting"`, or `"disconnected"`.
-`onconnect`       | Function | See the section "[`onconnect` event handler](#SwitchbotDevice-onconnect-event-handler)" for details.
-`ondisconnect`    | Function | See the section "[`ondisconnect` event handler](#SwitchbotDevice-ondisconnect-event-handler)" for details.
+| Property          | Type     | Description                                                                                                                                                  |
+| :---------------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id`              | String   | ID of the device. (e.g., `"cb4eb903c96d"`)                                                                                                                   |
+| `address`         | String   | MAC address of the device. Basically it is as same as the value of the `id` except that this value includes `:` in the string. (e.g., `"cb:4e:b9:03:c9:6d"`) |
+| `model`           | String   | This value is `"H"` "Bot (WoHand)", `"T"` "Meter (WoSensorTH)", `"c"` "Curtain (WoCurtain)", `"d"` "Contact (WoContact)" or `"s"` "Motion (WoMotion)".       |
+| `modelName`       | String   | This value is `"WoHand"`, `"WoSensorTH"`, `WoCurtain`, `WoContect` or `WoMotion`.                                                                            |
+| `connectionState` | String   | This value indicates the BLE connection state. `"connecting"`, `"connected"`, `"disconnecting"`, or `"disconnected"`.                                        |
+| `onconnect`       | Function | See the section "[`onconnect` event handler](#SwitchbotDevice-onconnect-event-handler)" for details.                                                         |
+| `ondisconnect`    | Function | See the section "[`ondisconnect` event handler](#SwitchbotDevice-ondisconnect-event-handler)" for details.                                                   |
 
 ### `getDeviceName()` method
 
@@ -430,21 +436,25 @@ If no connection is established with the device, this method automatically estab
 If the device name is fetched successfully, the device name will be passed to the `resolve()`.
 
 ```javascript
-switchbot.discover({ model: 'H', quick: true }).then((device_list) => {
-  return device_list[0].getDeviceName();
-}).then((name) => {
-  console.log(name);
-  process.exit();
-}).catch((error) => {
-  console.error(error);
-  process.exit();
-});
+switchbot
+  .discover({ model: "H", quick: true })
+  .then((device_list) => {
+    return device_list[0].getDeviceName();
+  })
+  .then((name) => {
+    console.log(name);
+    process.exit();
+  })
+  .catch((error) => {
+    console.error(error);
+    process.exit();
+  });
 ```
 
 The code above will output the result as follows:
 
 ```javascript
-WoHand
+WoHand;
 ```
 
 ### `setDeviceName()` method
@@ -456,15 +466,19 @@ If no connection is established with the device, this method automatically estab
 The character set of the device name saved in the device is UTF-8. The byte length of the name must be less than or equal to 20 bytes. If the name consists of only ASCII characters, up to 20 characters would be allowed. But if the name consists of multibyte characters, the upper limit of characters would be fewer than half. For example, Japanese characters could be saved at most 6 characters because most of Japanese characters consume 3 byte per each character.
 
 ```javascript
-switchbot.discover({ model: 'H', quick: true }).then((device_list) => {
-  return device_list[0].setDeviceName('Bot in kitchen');
-}).then(() => {
-  console.log('Done.');
-  process.exit();
-}).catch((error) => {
-  console.error(error);
-  process.exit();
-});
+switchbot
+  .discover({ model: "H", quick: true })
+  .then((device_list) => {
+    return device_list[0].setDeviceName("Bot in kitchen");
+  })
+  .then(() => {
+    console.log("Done.");
+    process.exit();
+  })
+  .catch((error) => {
+    console.error(error);
+    process.exit();
+  });
 ```
 
 ### `connect()` method
@@ -480,34 +494,42 @@ The code snippet below establishes a connection with the Bot using the `connect(
 ```javascript
 let device = null;
 
-switchbot.discover({ model: 'H', quick: true }).then((device_list) => {
-  device = device_list[0];
-  if (!device) {
-    console.log('No device was found.');
+switchbot
+  .discover({ model: "H", quick: true })
+  .then((device_list) => {
+    device = device_list[0];
+    if (!device) {
+      console.log("No device was found.");
+      process.exit();
+    }
+    console.log(device.modelName + " (" + device.address + ") was found.");
+    console.log("Connecting...");
+    return device.connect();
+  })
+  .then(() => {
+    console.log("Putting the arm down...");
+    return device.down();
+  })
+  .then(() => {
+    console.log("Waiting for 5 seconds...");
+    return switchbot.wait(5000);
+  })
+  .then(() => {
+    console.log("Putting the arm up...");
+    return device.up();
+  })
+  .then(() => {
+    console.log("Disconnecting...");
+    return device.disconnect();
+  })
+  .then(() => {
+    console.log("Done.");
     process.exit();
-  }
-  console.log(device.modelName + ' (' + device.address + ') was found.');
-  console.log('Connecting...');
-  return device.connect();
-}).then(() => {
-  console.log('Putting the arm down...');
-  return device.down();
-}).then(() => {
-  console.log('Waiting for 5 seconds...');
-  return switchbot.wait(5000);
-}).then(() => {
-  console.log('Putting the arm up...');
-  return device.up();
-}).then(() => {
-  console.log('Disconnecting...');
-  return device.disconnect();
-}).then(() => {
-  console.log('Done.');
-  process.exit();
-}).catch((error) => {
-  console.error(error);
-  process.exit();
-});
+  })
+  .catch((error) => {
+    console.error(error);
+    process.exit();
+  });
 ```
 
 The result will be as follows:
@@ -535,31 +557,35 @@ The `onconnect` event handler will be called when the connection with the device
 The code below calls the [`press()`](#SwitchbotDeviceWoHand-press-method) method, while callback functions are attached to the `onconnect` and `ondisconnect`.
 
 ```javascript
-switchbot.discover({ model: 'H', quick: true }).then((device_list) => {
-  let device = device_list[0];
-  if (!device) {
-    console.log('No device was found.');
+switchbot
+  .discover({ model: "H", quick: true })
+  .then((device_list) => {
+    let device = device_list[0];
+    if (!device) {
+      console.log("No device was found.");
+      process.exit();
+    }
+    console.log(device.modelName + " (" + device.address + ") was found.");
+
+    // Set event handers
+    device.onconnect = () => {
+      console.log("Connected.");
+    };
+    device.ondisconnect = () => {
+      console.log("Disconnected.");
+    };
+
+    console.log("Pressing the switch...");
+    return device.press();
+  })
+  .then(() => {
+    console.log("Done.");
     process.exit();
-  }
-  console.log(device.modelName + ' (' + device.address + ') was found.');
-
-  // Set event handers
-  device.onconnect = () => {
-    console.log('Connected.');
-  };
-  device.ondisconnect = () => {
-    console.log('Disconnected.');
-  };
-
-  console.log('Pressing the switch...');
-  return device.press();
-}).then(() => {
-  console.log('Done.');
-  process.exit();
-}).catch((error) => {
-  console.error(error);
-  process.exit();
-});
+  })
+  .catch((error) => {
+    console.error(error);
+    process.exit();
+  });
 ```
 
 The code above will output the result as follows:
@@ -578,7 +604,8 @@ Seeing the result, you would find the [`press()`](#SwitchbotDeviceWoHand-press-m
 
 The `ondisconnect` event handler will be called when the connection with the device is closed. Nothing will be passed to the handler. See the previous section "[`onconnect` event handler](#SwitchbotDevice-onconnect-event-handler)" for more details.
 
----------------------------------------
+---
+
 ## `SwitchbotDeviceWoHand` object
 
 The `SwitchbotDeviceWoHand` object represents a Bot, which is created through the discovery process triggered by the [`Switchbot.discover()`](#Switchbot-discover-method) method.
@@ -592,13 +619,17 @@ The `press()` method sends a press command to the Bot. This method returns a `Pr
 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.
 
 ```javascript
-switchbot.discover({ model: 'H', quick: true }).then((device_list) => {
-  return device_list[0].press();
-}).then(() => {
-  console.log('Done.');
-}).catch((error) => {
-  console.error(error);
-});
+switchbot
+  .discover({ model: "H", quick: true })
+  .then((device_list) => {
+    return device_list[0].press();
+  })
+  .then(() => {
+    console.log("Done.");
+  })
+  .catch((error) => {
+    console.error(error);
+  });
 ```
 
 When the Bot receives this command, the Bot's arm will be put down (stretched), then put up (retracted) in a few seconds.
@@ -611,20 +642,24 @@ If no connection is established with the device, this method automatically estab
 
 When the Bot receives this command, the Bot's arm will be put down (stretched) or put up (retracted) depending on the mode setting.
 
-Mode                | Inverse the on/off direction | Physical position of the arm
-:-------------------|:-----------------------------|:----------------------------
-Press mode          | N/A                          | Down (stretched), then Up (retracted)
-Switch mode         | Disabled                     | Down (stretched)
-               | Enabled                      | Up (retracted)
+| Mode        | Inverse the on/off direction | Physical position of the arm          |
+| :---------- | :--------------------------- | :------------------------------------ |
+| Press mode  | N/A                          | Down (stretched), then Up (retracted) |
+| Switch mode | Disabled                     | Down (stretched)                      |
+|        | Enabled                      | Up (retracted)                        |
 
 ```javascript
-switchbot.discover({ model: 'H', quick: true }).then((device_list) => {
-  return device_list[0].turnOn();
-}).then(() => {
-  console.log('Done.');
-}).catch((error) => {
-  console.error(error);
-});
+switchbot
+  .discover({ model: "H", quick: true })
+  .then((device_list) => {
+    return device_list[0].turnOn();
+  })
+  .then(() => {
+    console.log("Done.");
+  })
+  .catch((error) => {
+    console.error(error);
+  });
 ```
 
 ### `turnOff()` method
@@ -635,20 +670,24 @@ If no connection is established with the device, this method automatically estab
 
 When the Bot receives this command, the Bot's arm will be put down (stretched) or put up (retracted) depending on the mode setting.
 
-Mode                | Inverse the on/off direction | Physical position of the arm
-:-------------------|:-----------------------------|:----------------------------
-Press mode          | N/A                          | Down (stretched), then Up (retracted)
-Switch mode         | Disabled                     | Up (retracted)
-               | Enabled                      | Down (stretched)
+| Mode        | Inverse the on/off direction | Physical position of the arm          |
+| :---------- | :--------------------------- | :------------------------------------ |
+| Press mode  | N/A                          | Down (stretched), then Up (retracted) |
+| Switch mode | Disabled                     | Up (retracted)                        |
+|        | Enabled                      | Down (stretched)                      |
 
 ```javascript
-switchbot.discover({ model: 'H', quick: true }).then((device_list) => {
-  return device_list[0].turnOff();
-}).then(() => {
-  console.log('Done.');
-}).catch((error) => {
-  console.error(error);
-});
+switchbot
+  .discover({ model: "H", quick: true })
+  .then((device_list) => {
+    return device_list[0].turnOff();
+  })
+  .then(() => {
+    console.log("Done.");
+  })
+  .catch((error) => {
+    console.error(error);
+  });
 ```
 
 ### `down()` method
@@ -660,13 +699,17 @@ If no connection is established with the device, this method automatically estab
 When the Bot receives this command, the Bot's arm will be put down (stretched) regardless of the mode setting.
 
 ```javascript
-switchbot.discover({ model: 'H', quick: true }).then((device_list) => {
-  return device_list[0].down();
-}).then(() => {
-  console.log('Done.');
-}).catch((error) => {
-  console.error(error);
-});
+switchbot
+  .discover({ model: "H", quick: true })
+  .then((device_list) => {
+    return device_list[0].down();
+  })
+  .then(() => {
+    console.log("Done.");
+  })
+  .catch((error) => {
+    console.error(error);
+  });
 ```
 
 ### `up()` method
@@ -678,16 +721,21 @@ If no connection is established with the device, this method automatically estab
 When the Bot receives this command, the Bot's arm will be put up (retracted) regardless of the mode setting.
 
 ```javascript
-switchbot.discover({ model: 'H', quick: true }).then((device_list) => {
-  return device_list[0].up();
-}).then(() => {
-  console.log('Done.');
-}).catch((error) => {
-  console.error(error);
-});
+switchbot
+  .discover({ model: "H", quick: true })
+  .then((device_list) => {
+    return device_list[0].up();
+  })
+  .then(() => {
+    console.log("Done.");
+  })
+  .catch((error) => {
+    console.error(error);
+  });
 ```
 
----------------------------------------
+---
+
 ## `SwitchbotDeviceWoCurtain` object
 
 The `SwitchbotDeviceWoCurtain` object represents a Curtain, which is created through the discovery process triggered by the [`Switchbot.discover()`](#Switchbot-discover-method) method.
@@ -697,13 +745,17 @@ Actually, the `SwitchbotDeviceWoCurtain` is an object inherited from the [`Switc
 ### `open()` method
 
 ```javascript
-switchbot.discover({ model: 'c', quick: true }).then((device_list) => {
-  return device_list[0].open();
-}).then(() => {
-  console.log('Done.');
-}).catch((error) => {
-  console.error(error);
-});
+switchbot
+  .discover({ model: "c", quick: true })
+  .then((device_list) => {
+    return device_list[0].open();
+  })
+  .then(() => {
+    console.log("Done.");
+  })
+  .catch((error) => {
+    console.error(error);
+  });
 ```
 
 ### `close()` method
@@ -715,13 +767,17 @@ If no connection is established with the device, this method automatically estab
 When the Curtain receives this command, the Curtain will close the curtain (100% position). If not calibrated, the Curtain does not move.
 
 ```javascript
-switchbot.discover({ model: 'c', quick: true }).then((device_list) => {
-  return device_list[0].close();
-}).then(() => {
-  console.log('Done.');
-}).catch((error) => {
-  console.error(error);
-});
+switchbot
+  .discover({ model: "c", quick: true })
+  .then((device_list) => {
+    return device_list[0].close();
+  })
+  .then(() => {
+    console.log("Done.");
+  })
+  .catch((error) => {
+    console.error(error);
+  });
 ```
 
 ### `pause()` method
@@ -733,13 +789,17 @@ If no connection is established with the device, this method automatically estab
 When the Curtain receives this command, the Curtain will pause.
 
 ```javascript
-switchbot.discover({ model: 'c', quick: true }).then((device_list) => {
-  return device_list[0].pause();
-}).then(() => {
-  console.log('Done.');
-}).catch((error) => {
-  console.error(error);
-});
+switchbot
+  .discover({ model: "c", quick: true })
+  .then((device_list) => {
+    return device_list[0].pause();
+  })
+  .then(() => {
+    console.log("Done.");
+  })
+  .catch((error) => {
+    console.error(error);
+  });
 ```
 
 ### `runToPos()` method
@@ -750,39 +810,43 @@ If no connection is established with the device, this method automatically estab
 
 When the Curtain receives this command, the Curtain will run to the percentage position. If not calibrated, the Curtain does not move.
 
-
 The `open()` method sends an open command to the Curtain. This method returns a `Promise` object. Nothing will be passed to the `resove()`.
 
 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.
 
 When the Curtain receives this command, the Curtain will open the curtain (0% position). If not calibrated, the Curtain does not move.
 
-Property     | Type    | Required | Description
-:------------|:--------|:---------|:------------
-`percent`    | Integer | Required | The percentage of target position (`0-100`). (e.g., `50`)
-`mode`       | Integer | Optional | The running mode of Curtain. <br/>`0x00` - Performance mode.<br/> `0x01` - Silent mode. <br/>`0xff` - Default. Unspecified, from Curtain's settings.
+| Property  | Type    | Required | Description                                                                                                                                          |
+| :-------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `percent` | Integer | Required | The percentage of target position (`0-100`). (e.g., `50`)                                                                                            |
+| `mode`    | Integer | Optional | The running mode of Curtain. <br/>`0x00` - Performance mode.<br/> `0x01` - Silent mode. <br/>`0xff` - Default. Unspecified, from Curtain's settings. |
 
 ```javascript
-switchbot.discover({ model: 'c', quick: true }).then((device_list) => {
-  return device_list[0].runToPos(50);
-}).then(() => {
-  console.log('Done.');
-}).catch((error) => {
-  console.error(error);
-});
+switchbot
+  .discover({ model: "c", quick: true })
+  .then((device_list) => {
+    return device_list[0].runToPos(50);
+  })
+  .then(() => {
+    console.log("Done.");
+  })
+  .catch((error) => {
+    console.error(error);
+  });
 ```
 
----------------------------------------
+---
+
 ## Advertisement data
 
 After the [`startScan()`](#startscan-method) method is invoked, the [`onadvertisement`](#Switchbot-onadvertisement-event-handler) event handler will be called whenever an advertising packet comes from the switchbot devices. An object containing the properties as follows will be passed to the event handler:
 
-Property      | Type    | Description
-:-------------|:--------|:-----------
-`id`          | String  | ID of the device. (e.g., `"cb4eb903c96d"`)
-`address`     | String  | MAC address of the device. Basically it is as same as the value of the `id` except that this value includes `:` in the string. (e.g., `"cb:4e:b9:03:c9:6d"`)
-`rssi`        | Integer | RSSI. (e.g., `-62`)
-`serviceData` | Object  | An object including the device-specific data.
+| Property      | Type    | Description                                                                                                                                                  |
+| :------------ | :------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id`          | String  | ID of the device. (e.g., `"cb4eb903c96d"`)                                                                                                                   |
+| `address`     | String  | MAC address of the device. Basically it is as same as the value of the `id` except that this value includes `:` in the string. (e.g., `"cb:4e:b9:03:c9:6d"`) |
+| `rssi`        | Integer | RSSI. (e.g., `-62`)                                                                                                                                          |
+| `serviceData` | Object  | An object including the device-specific data.                                                                                                                |
 
 The structures of the `serviceData` are described in the following sections.
 
@@ -807,27 +871,26 @@ Example of the advertisement data:
 
 Structure of the `serviceData`:
 
-Property    | Type    | Description
-:-----------|:--------|:-----------
-`model`     | String  | This value is always `"H"`, which means "Bot (WoHand)".
-`modelName` | String  | This value is always `"WoHand"`, which means "Bot".
-`mode`      | Boolean | This indicates the mode setting. When the mode is "Switch mode", this value is `true`. When the mode is "Press mode", this value is `false`.
-`state`     | Boolean | This value indicates whether the switch status is ON or OFF.
-`battery`   | Integer | (**experimental**) This value indicates the battery level (`%`).
+| Property    | Type    | Description                                                                                                                                  |
+| :---------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------- |
+| `model`     | String  | This value is always `"H"`, which means "Bot (WoHand)".                                                                                      |
+| `modelName` | String  | This value is always `"WoHand"`, which means "Bot".                                                                                          |
+| `mode`      | Boolean | This indicates the mode setting. When the mode is "Switch mode", this value is `true`. When the mode is "Press mode", this value is `false`. |
+| `state`     | Boolean | This value indicates whether the switch status is ON or OFF.                                                                                 |
+| `battery`   | Integer | (**experimental**) This value indicates the battery level (`%`).                                                                             |
 
 The `mode` can be changed only using the official smartphone app. The node-switchbot does not support changing the mode because the BLE protocol is non-public.
 
-If the `mode` is `false`, which means the "Press mode" is selected, the `state` is always `false`. If the `mode` is `true`, which means the "Switch mode" is selected, the `state` represents the logical state (ON or OFF). Note that it does *not* mean the physical arm position. The physical arm position depends on the setting "Inverse the on/off direction" on the official smartphone app.
-
-"Inverse the on/off direction" | Value of the `state` | Logical state | Physical arm position
-:------------------------------|:---------------------|:--------------|:------------
-disabled                       | `true`               | OFF           | Up (retracted)
-&nbsp;                         | `false`              | ON            | Down (stretched)
-enabled                        | `true`               | OFF           | Down (stretched)
-&nbsp;                         | `false`              | ON            | Up (retracted)
+If the `mode` is `false`, which means the "Press mode" is selected, the `state` is always `false`. If the `mode` is `true`, which means the "Switch mode" is selected, the `state` represents the logical state (ON or OFF). Note that it does _not_ mean the physical arm position. The physical arm position depends on the setting "Inverse the on/off direction" on the official smartphone app.
 
-The `battery` is *experimental* for now. I'm not sure whether the value is correct or not. Never trust this value for now.
+| "Inverse the on/off direction" | Value of the `state` | Logical state | Physical arm position |
+| :----------------------------- | :------------------- | :------------ | :-------------------- |
+| disabled                       | `true`               | OFF           | Up (retracted)        |
+| &nbsp;                         | `false`              | ON            | Down (stretched)      |
+| enabled                        | `true`               | OFF           | Down (stretched)      |
+| &nbsp;                         | `false`              | ON            | Up (retracted)        |
 
+The `battery` is _experimental_ for now. I'm not sure whether the value is correct or not. Never trust this value for now.
 
 ### Meter (WoSensorTH)
 
@@ -854,20 +917,20 @@ Example of the advertisement data:
 
 Structure of the `data`:
 
-Property      | Type    | Description
-:-------------|:--------|:-----------
-`model`       | String  | This value is always `"T"`, which means "Meter (WoSensorTH)".
-`modelName`   | String  | This value is always `"WoSensorTH"`, which means "Meter".
-`temperature` | Object  |
-&nbsp;&nbsp; `c`         | Float   | Temperature (degree Celsius/°C)
-&nbsp;&nbsp; `f`         | Float   | Temperature (degree Fahrenheit/℉)
-`fahrenheit`  | Boolean | The flag whether the Meter shows Fahrenheit (`true`) or Celsius (`false`) for the temperature on the display
-`humidity`    | Integer | Humidity (`%`)
-`battery`     | Integer | (**experimental**) This value indicates the battery level (`%`).
+| Property         | Type    | Description                                                                                                  |
+| :--------------- | :------ | :----------------------------------------------------------------------------------------------------------- |
+| `model`          | String  | This value is always `"T"`, which means "Meter (WoSensorTH)".                                                |
+| `modelName`      | String  | This value is always `"WoSensorTH"`, which means "Meter".                                                    |
+| `temperature`    | Object  |
+| &nbsp;&nbsp; `c` | Float   | Temperature (degree Celsius/°C)                                                                              |
+| &nbsp;&nbsp; `f` | Float   | Temperature (degree Fahrenheit/℉)                                                                            |
+| `fahrenheit`     | Boolean | The flag whether the Meter shows Fahrenheit (`true`) or Celsius (`false`) for the temperature on the display |
+| `humidity`       | Integer | Humidity (`%`)                                                                                               |
+| `battery`        | Integer | (**experimental**) This value indicates the battery level (`%`).                                             |
 
-The `fahrenheit` indicates the setting on the device. Note that it does *not* indicate the setting on the official smartphone app. The setting of the temperature unit on the device and the setting on the app are independent.
+The `fahrenheit` indicates the setting on the device. Note that it does _not_ indicate the setting on the official smartphone app. The setting of the temperature unit on the device and the setting on the app are independent.
 
-The `battery` is *experimental* for now. I'm not sure whether the value is correct or not. Never trust this value for now.
+The `battery` is _experimental_ for now. I'm not sure whether the value is correct or not. Never trust this value for now.
 
 ### Curtain (WoCurtain)
 
@@ -891,14 +954,14 @@ Example of the advertisement data:
 
 Structure of the `serviceData`:
 
-Property      | Type    | Description
-:-------------|:--------|:-----------
-`model`       | String  | This value is always `"c"`, which means "Curtain (WoCurtain)".
-`modelName`   | String  | This value is always `"WoCurtain"`, which means "Curtain".
-`calibration` | Boolean | This value indicates the calibration status (`true` or `false`).
-`battery`     | Integer | This value indicates the battery level (`1-100`, `%`).
-`position`    | Integer | This value indicates the percentage of current position (`0-100`, 0 is open, `%`).
-`lightLevel`  | Integer | This value indicates the light level of the light source currently set (`1-10`).
+| Property      | Type    | Description                                                                        |
+| :------------ | :------ | :--------------------------------------------------------------------------------- |
+| `model`       | String  | This value is always `"c"`, which means "Curtain (WoCurtain)".                     |
+| `modelName`   | String  | This value is always `"WoCurtain"`, which means "Curtain".                         |
+| `calibration` | Boolean | This value indicates the calibration status (`true` or `false`).                   |
+| `battery`     | Integer | This value indicates the battery level (`1-100`, `%`).                             |
+| `position`    | Integer | This value indicates the percentage of current position (`0-100`, 0 is open, `%`). |
+| `lightLevel`  | Integer | This value indicates the light level of the light source currently set (`1-10`).   |
 
 ### Contact (WoContact)
 
@@ -922,14 +985,14 @@ Example of the advertisement data:
 
 Structure of the `serviceData`:
 
-Property      | Type    | Description
-:-------------|:--------|:-----------
-`model`       | String  | This value is always `"c"`, which means "Contact (WoContact)".
-`modelName`   | String  | This value is always `"WoContact"`, which means "Contact".
-`movement`    | Boolean | This value indicates the motion status (`true` or `false`).
-`battery`     | Integer | This value indicates the battery level (`1-100`, `%`).
-`doorState`   | String  | This value indicates the door Status (`close`, `open`, `timeout no closed`).
-`lightLevel`  | String  | This value indicates the light level (`dark`, `bright`).
+| Property     | Type    | Description                                                                  |
+| :----------- | :------ | :--------------------------------------------------------------------------- |
+| `model`      | String  | This value is always `"c"`, which means "Contact (WoContact)".               |
+| `modelName`  | String  | This value is always `"WoContact"`, which means "Contact".                   |
+| `movement`   | Boolean | This value indicates the motion status (`true` or `false`).                  |
+| `battery`    | Integer | This value indicates the battery level (`1-100`, `%`).                       |
+| `doorState`  | String  | This value indicates the door Status (`close`, `open`, `timeout no closed`). |
+| `lightLevel` | String  | This value indicates the light level (`dark`, `bright`).                     |
 
 ### Motion (WoMotion)
 
@@ -952,16 +1015,17 @@ Example of the advertisement data:
 
 Structure of the `serviceData`:
 
-Property      | Type    | Description
-:-------------|:--------|:-----------
-`model`       | String  | This value is always `"s"`, which means "Motion (WoMotion)".
-`modelName`   | String  | This value is always `"WoMotion"`, which means "Motion".
-`movement`    | Boolean | This value indicates the motion status (`true` or `false`).
-`battery`     | Integer | This value indicates the battery level (`1-100`, `%`).
-`lightLevel`  | String  | This value indicates the light level (`dark`, `bright`).
+| Property     | Type    | Description                                                  |
+| :----------- | :------ | :----------------------------------------------------------- |
+| `model`      | String  | This value is always `"s"`, which means "Motion (WoMotion)". |
+| `modelName`  | String  | This value is always `"WoMotion"`, which means "Motion".     |
+| `movement`   | Boolean | This value indicates the motion status (`true` or `false`).  |
+| `battery`    | Integer | This value indicates the battery level (`1-100`, `%`).       |
+| `lightLevel` | String  | This value indicates the light level (`dark`, `bright`).     |
+
+---
 
----------------------------------------
 ## References
 
-* [Switchbot official global site](https://www.switch-bot.com/)
-* [GitHub - OpenWonderLabs/SwitchBotAPI-BLE](https://github.com/OpenWonderLabs/SwitchBotAPI-BLE)
+- [Switchbot official global site](https://www.switch-bot.com/)
+- [GitHub - OpenWonderLabs/SwitchBotAPI-BLE](https://github.com/OpenWonderLabs/SwitchBotAPI-BLE)