@switchbot/openapi-cli 3.6.2 → 3.6.3
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 +23 -3
- package/dist/index.js +49777 -37930
- package/package.json +14 -14
package/README.md
CHANGED
|
@@ -45,7 +45,7 @@ Under the hood every surface shares the same catalog, cache, and HMAC client —
|
|
|
45
45
|
|
|
46
46
|
## Table of contents
|
|
47
47
|
|
|
48
|
-
- [Features](#features) · [Requirements](#requirements) · [Installation](#installation)
|
|
48
|
+
- [Features](#features) · [Supported devices](#supported-devices) · [Requirements](#requirements) · [Installation](#installation)
|
|
49
49
|
- [Quick start](#quick-start)
|
|
50
50
|
- [Credentials](#credentials)
|
|
51
51
|
- [Policy](#policy) · [Rules engine](#rules-engine)
|
|
@@ -63,9 +63,29 @@ Under the hood every surface shares the same catalog, cache, and HMAC client —
|
|
|
63
63
|
- 🎨 **Dual output modes** — colorized tables by default; `--json` passthrough for `jq` and scripting
|
|
64
64
|
- 🔐 **Secure credentials** — HMAC-SHA256 signed requests; config file written with `0600`; env-var override for CI
|
|
65
65
|
- 🔍 **Dry-run mode** — preview every mutating request before it hits the API
|
|
66
|
-
- 🧪 **Fully tested** —
|
|
66
|
+
- 🧪 **Fully tested** — 2500+ Vitest tests, mocked axios, zero network in CI
|
|
67
67
|
- ⚡ **Shell completion** — Bash / Zsh / Fish / PowerShell
|
|
68
68
|
|
|
69
|
+
## Supported devices
|
|
70
|
+
|
|
71
|
+
The built-in catalog covers every device type in the [SwitchBot Cloud API v1.1](https://github.com/OpenWonderLabs/SwitchBotAPI).
|
|
72
|
+
Run `switchbot catalog list` to see the full list including aliases and per-command details.
|
|
73
|
+
|
|
74
|
+
| Category | Devices |
|
|
75
|
+
|---|---|
|
|
76
|
+
| **Lighting** | Color Bulb · Strip Light · Strip Light 3 · RGBICWW Strip Light · Floor Lamp · RGBICWW Floor Lamp · Ceiling Light · Ceiling Light Pro · RGBIC Neon Rope Light · RGBIC Neon Wire Rope Light · Candle Warmer Lamp |
|
|
77
|
+
| **Climate** | Humidifier · Humidifier2 · Air Purifier VOC · Air Purifier Table VOC · Air Purifier PM2.5 · Air Purifier Table PM2.5 · Smart Radiator Thermostat |
|
|
78
|
+
| **Security** | Smart Lock · Smart Lock Pro · Smart Lock Pro Wifi · Smart Lock Ultra · Lock Lite · Lock Vision · Lock Vision Pro · Keypad · Keypad Touch · Keypad Vision · Keypad Vision Pro · Garage Door Opener · Video Doorbell |
|
|
79
|
+
| **Curtains & blinds** | Curtain · Curtain3 · Blind Tilt · Roller Shade |
|
|
80
|
+
| **Power** | Plug · Plug Mini (US) · Plug Mini (JP) · Plug Mini (EU) · Relay Switch 1 · Relay Switch 1PM · Relay Switch 2PM |
|
|
81
|
+
| **Fans** | Battery Circulator Fan · Circulator Fan · Standing Circulator Fan |
|
|
82
|
+
| **Cleaning** | Robot Vacuum Cleaner S1 · Robot Vacuum Cleaner S1 Plus · K10+ · K10+ Pro · Robot Vacuum Cleaner K10+ Pro Combo · Robot Vacuum Cleaner S10 · Robot Vacuum Cleaner S20 · Robot Vacuum Cleaner K11+ · Robot Vacuum Cleaner K20 Plus Pro |
|
|
83
|
+
| **Sensors** _(read-only)_ | Meter · MeterPlus · WoIOSensor · MeterPro · MeterPro(CO2) · WeatherStation · Motion Sensor · Presence Sensor · Contact Sensor · Water Detector · Wallet Finder Card |
|
|
84
|
+
| **Hubs** _(read-only)_ | Hub · Hub Plus · Hub Mini · Hub 2 · Hub 3 · AI Hub |
|
|
85
|
+
| **Cameras** _(status only)_ | Indoor Cam · Pan/Tilt Cam · Pan/Tilt Cam 2K · Pan/Tilt Cam Plus 2K · Pan/Tilt Cam Plus 3K · Outdoor Spotlight Cam |
|
|
86
|
+
| **Other** | Bot · AI Art Frame · Home Climate Panel · Remote |
|
|
87
|
+
| **IR virtual remotes** _(via Hub)_ | Air Conditioner · TV · Streamer · Set Top Box · DVD · Speaker · Fan · Light · Others |
|
|
88
|
+
|
|
69
89
|
## Requirements
|
|
70
90
|
|
|
71
91
|
- **Node.js ≥ 18**
|
|
@@ -816,7 +836,7 @@ npm install
|
|
|
816
836
|
|
|
817
837
|
npm run dev -- <args> # Run from TypeScript sources via tsx
|
|
818
838
|
npm run build # Compile to dist/
|
|
819
|
-
npm test # Run the Vitest suite
|
|
839
|
+
npm test # Run the Vitest suite
|
|
820
840
|
npm run test:watch # Watch mode
|
|
821
841
|
npm run test:coverage # Coverage report (v8, HTML + text)
|
|
822
842
|
```
|