node-switchbot 2.0.2-beta.11 → 2.0.2-beta.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -111,7 +111,7 @@ Monitoring the advertising packets, you can find your devices and know the lates
|
|
|
111
111
|
```Typescript
|
|
112
112
|
// Load the node-switchbot and get a `Switchbot` constructor object
|
|
113
113
|
import { SwitchBot } from 'node-switchbot';
|
|
114
|
-
// Create
|
|
114
|
+
// Create a `Switchbot` object
|
|
115
115
|
const switchbot = new SwitchBot();
|
|
116
116
|
|
|
117
117
|
(async () => {
|
|
@@ -138,7 +138,7 @@ The [`startScan()`](#startscan-method) and [`wait()`](#Switchbot-wait-method) me
|
|
|
138
138
|
```Typescript
|
|
139
139
|
// Load the node-switchbot and get a `Switchbot` constructor object
|
|
140
140
|
const Switchbot = require("node-switchbot");
|
|
141
|
-
// Create
|
|
141
|
+
// Create a `Switchbot` object
|
|
142
142
|
const switchbot = new Switchbot();
|
|
143
143
|
|
|
144
144
|
// Start to monitor advertisement packets
|
|
@@ -214,7 +214,7 @@ This sample discovers a Bot (WoHand), then put the Bot's arm down, finally put i
|
|
|
214
214
|
```Typescript
|
|
215
215
|
// Load the node-switchbot and get a `Switchbot` constructor object
|
|
216
216
|
import { SwitchBot } from 'node-switchbot';
|
|
217
|
-
// Create
|
|
217
|
+
// Create a `Switchbot` object
|
|
218
218
|
const switchbot = new SwitchBot();
|
|
219
219
|
|
|
220
220
|
(async () => {
|
|
@@ -249,7 +249,7 @@ In order to use the node-switchbot, you have to load the node-switchbot module a
|
|
|
249
249
|
import { SwitchBot } from 'node-switchbot';
|
|
250
250
|
```
|
|
251
251
|
|
|
252
|
-
You can get an `SwitchBot` constructor from the code above. Then you have to create
|
|
252
|
+
You can get an `SwitchBot` constructor from the code above. Then you have to create a `SwitchBot` object from the `SwitchBot` constructor as follows:
|
|
253
253
|
|
|
254
254
|
```typescript
|
|
255
255
|
const switchbot = new SwitchBot();
|
|
@@ -303,9 +303,8 @@ If you want a quick response, you can set the `quick` property to `true`.
|
|
|
303
303
|
|
|
304
304
|
```Typescript
|
|
305
305
|
switchbot.discover({
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
});
|
|
306
|
+
duration: 5000,
|
|
307
|
+
quick: true
|
|
309
308
|
}).then((device_list) => {
|
|
310
309
|
// Do something...
|
|
311
310
|
}).catch((error) => {
|
|
@@ -749,7 +748,7 @@ Actually, the `WoCurtain` is an object inherited from the [`SwitchbotDevice`](#S
|
|
|
749
748
|
|
|
750
749
|
### `open()` method
|
|
751
750
|
|
|
752
|
-
The `open()` method sends
|
|
751
|
+
The `open()` method sends an open command to the Curtain. This method returns a `Promise` object. Nothing will be passed to the `resove()`.
|
|
753
752
|
|
|
754
753
|
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.
|
|
755
754
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "node-switchbot",
|
|
3
|
-
"version": "2.0.2-beta.
|
|
3
|
+
"version": "2.0.2-beta.12",
|
|
4
4
|
"description": "The node-switchbot is a Node.js module which allows you to control your Switchbot Devices through Bluetooth (BLE).",
|
|
5
5
|
"homepage": "https://github.com/OpenWonderLabs/node-switchbot",
|
|
6
6
|
"author": "OpenWonderLabs (https://github.com/OpenWonderLabs)",
|