@lucadiba/switchbot-client
v0.3.0TypeScript
A Node.js client for SwitchBot 1.1 APIs
0/weekUpdated 1 years agoMITUnpacked: 180.5 KB
Published by Luca Dibattista
npm install @lucadiba/switchbot-clientSwitchBot client
⚠️ This package is in beta ⚠️
> A JavaScript client for SwitchBot 1.1 APIs with built-in TypeScript types.
> This package supports both ESM and CommonJS.
Installation
Install the package using your preferred package manager:
``sh`
npm install @lucadiba/switchbot-client
Usage
$3
Import the package in your application.
`typescript`
import SwitchBot from "@lucadiba/switchbot-client";
Initialize the client with your open token and secret key. You can find these values in the SwitchBot app.
`typescript`
const switchbot = new SwitchBot({
openToken: "openToken",
secretKey: "secretKey",
});
$3
To interact with a device, you need to know its ID. You can find it in the SwitchBot app or by calling the devices method.
`typescript`
const devices = await switchbot.devices();
// [{
// deviceId: "deviceId",
// ...
// }]
Then, you can interact with the device.
`typescript`
// Press SwitchBot Bot
switchbot.bot("deviceId").press();
$3
`typescript`
// Execute SwitchBot Scene
switchbot.scene("sceneId").execute();
Support
The following devices are supported:
- Blind Tilt
- Bot
- Ceiling Light
- Ceiling Light Pro
- Color Bulb
- Contact Sensor
- Curtain
- Curtain 3
- Hub
- Hub 2
- Hub Plus
- Hub Mini
- Humidifier
- Indoor Cam
- Keypad
- Keypad Touch
- Lock
- Meter
- Meter Plus
- Outdoor meter
- Motion Sensor
- Pan/Tilt Cam
- Pan/Tilt Cam 2K
- Plug
- Plug Mini (US)
- Plug Mini (JP)
- Remote
- Robot Vacuum Cleaner S1
- Robot Vacuum Cleaner S1 Plus
- Strip Light
- 📘 Full documentation
The following devices are currently not supported:
- Battery Circulator Fan
- Virtual infrared remote devices
Author
👤 Luca Dibattista
- Website: https://lucadibattista.it
- Github: @LucaDiba
🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check issues page.
Please run npx changeset` and follow the instructions to create a new changeset before opening a pull request.
Show your support
Give a ⭐️ if this project helped you!
📝 License
Copyright © 2022 Luca Dibattista.
This project is MIT licensed.
---
_This README was generated with ❤️ by readme-md-generator_