tsvesync 1.0.11

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mick Giles
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,227 @@
+# TSVeSync
+
+A TypeScript library for interacting with VeSync smart home devices. This library provides a modern, type-safe interface for controlling VeSync devices including air purifiers, outlets, and switches.
+
+## Features
+
+- Full TypeScript support with type definitions
+- Support for multiple device types:
+  - Air Purifiers (Core200S, Core300S, Core400S, Core600S, LV-PUR131S, Vital100S, Vital200S, EverestAir)
+  - Humidifiers (Classic300S, Classic200S, Dual200S, LV600S, OasisMist series, Superior6000S)
+  - Smart Bulbs (ESL100, ESL100CW, ESL100MC, XYD0001)
+  - Outlets (15A, 10A, 7A models)
+  - Smart Tower Fans (LTF-F422S series)
+- Real-time device status and control
+- Energy monitoring for supported devices
+- Air quality monitoring for supported purifiers
+- Humidity control for supported humidifiers
+- RGB and color temperature control for smart bulbs
+- Fan speed and mode control
+- Comprehensive error handling
+- Modern async/await API
+
+## Supported Devices
+
+### Air Purifiers
+- Core200S
+  - Features: Sleep mode, Manual mode, Filter life monitoring
+  - Fan speeds: 1-3
+- Core300S
+  - Features: Auto mode, Sleep mode, Manual mode, Air quality monitoring
+  - Fan speeds: 1-4
+- Core400S
+  - Features: Auto mode, Sleep mode, Manual mode, Air quality monitoring
+  - Fan speeds: 1-4
+- Core600S
+  - Features: Auto mode, Sleep mode, Manual mode, Air quality monitoring
+  - Fan speeds: 1-4
+- LV-PUR131S
+  - Features: Air quality monitoring
+- Vital100S
+  - Features: Air quality monitoring, Pet mode
+  - Modes: Manual, Auto, Sleep, Pet
+  - Fan speeds: 1-4
+- Vital200S
+  - Features: Air quality monitoring, Pet mode
+  - Modes: Manual, Auto, Sleep, Pet
+  - Fan speeds: 1-4
+- EverestAir
+  - Features: Air quality monitoring, Fan rotation, Turbo mode
+  - Modes: Manual, Auto, Sleep, Turbo
+  - Fan speeds: 1-3
+
+### Humidifiers
+- Classic300S
+  - Features: Nightlight
+  - Modes: Auto, Sleep, Manual
+  - Mist levels: 1-9
+- Classic200S
+  - Modes: Auto, Manual
+  - Mist levels: 1-9
+- Dual200S
+  - Modes: Auto, Manual
+  - Mist levels: 1-2
+- LV600S
+  - Features: Warm mist, Nightlight
+  - Modes: Humidity, Sleep, Manual
+  - Mist levels: 1-9
+  - Warm mist levels: 0-3
+- OasisMist (EU)
+  - Features: Warm mist, Nightlight
+  - Modes: Auto, Manual
+  - Mist levels: 1-9
+  - Warm mist levels: 0-3
+- OasisMist (US)
+  - Features: Warm mist
+  - Modes: Auto, Humidity, Sleep, Manual
+  - Mist levels: 1-9
+  - Warm mist levels: 0-3
+- OasisMist1000S
+  - Modes: Auto, Sleep, Manual
+  - Mist levels: 1-9
+- Superior6000S
+  - Modes: Auto, Humidity, Sleep, Manual
+  - Mist levels: 1-9
+
+### Smart Bulbs
+- ESL100
+  - Features: Basic white light
+  - Brightness control
+- ESL100CW
+  - Features: Tunable white light
+  - Brightness control
+  - Color temperature control (warm to cool white)
+- ESL100MC
+  - Features: Full RGB color
+  - White and color modes
+  - Brightness control
+  - RGB color control
+- XYD0001
+  - Features: Full RGB color with HSV control
+  - White and color modes
+  - Brightness control
+  - Color temperature control
+  - HSV (Hue, Saturation, Value) color control
+
+### Outlets
+- 15A Outlet (ESO15-TB)
+  - Power monitoring
+  - Energy usage tracking (daily/weekly/monthly/yearly)
+  - Voltage monitoring
+  - Outdoor rated
+- 15A Outlet (ESW15-USA)
+  - Power monitoring
+  - Energy usage tracking (daily/weekly/monthly/yearly)
+  - Voltage monitoring
+- 10A Outlet (ESW03-USA)
+  - Power monitoring
+  - Energy usage tracking (daily/weekly/monthly/yearly)
+  - Voltage monitoring
+- 10A Outlet (ESW01-EU)
+  - Power monitoring
+  - Energy usage tracking (daily/weekly/monthly/yearly)
+  - Voltage monitoring
+- 7A Outlet (wifi-switch-1.3)
+  - Energy usage tracking (daily/weekly/monthly/yearly)
+
+### Smart Tower Fan
+- LTF-F422S Series
+  - Features: Fan speed control
+  - Modes: Normal, Auto, Advanced Sleep, Turbo
+  - Fan speeds: 1-12
+
+## Installation
+
+```bash
+npm install tsvesync
+```
+
+## Usage
+
+### Basic Setup
+
+```typescript
+import { VeSync } from 'tsvesync';
+
+// Create a VeSync manager instance
+const manager = new VeSync(username, password);
+
+// Login
+await manager.login();
+
+// Get all devices
+await manager.getDevices();
+```
+
+### Working with Devices
+
+```typescript
+// Get device status
+for (const device of manager.devices) {
+    await device.update();
+    console.log(`${device.deviceName}: ${device.deviceStatus}`);
+}
+
+// Control an air purifier
+const fan = manager.devices.find(d => d.deviceType === 'Core300S');
+if (fan) {
+    await fan.setMode('auto');  // Available modes: auto, sleep, manual
+    await fan.setSpeed(2);      // Speed range depends on model
+}
+
+// Control an outlet
+const outlet = manager.devices.find(d => d.deviceType === 'ESO15-TB');
+if (outlet) {
+    await outlet.turnOn();
+    const energy = await outlet.getEnergyUsage();
+    console.log('Current power usage:', energy.power, 'W');
+}
+```
+
+## Environment Variables
+
+The library supports configuration through environment variables:
+
+```env
+VESYNC_USERNAME=your_email@example.com
+VESYNC_PASSWORD=your_password
+VESYNC_API_URL=https://smartapi.vesync.com  # Optional, defaults to standard API URL
+```
+
+## Testing
+
+The project includes a comprehensive test suite:
+
+```bash
+# Run the standard test suite
+npm test
+
+# Run the special device test (requires .env configuration)
+npx ts-node test/testSpecial.ts
+```
+
+## Development
+
+### Building
+
+```bash
+npm run build
+```
+
+### Linting
+
+```bash
+npm run lint
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT
+
+## Acknowledgments
+
+This project is inspired by the PyVeSync Python library and aims to provide similar functionality for TypeScript/JavaScript developers.

package/api/vesync/VeSync.yaml

@@ -0,0 +1,33 @@
+get_devices:
+  headers:
+    Content-Type: application/json; charset=UTF-8
+    User-Agent: okhttp/3.12.1
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    appVersion: 2.8.6
+    method: devices
+    pageNo: '1'
+    pageSize: '100'
+    phoneBrand: SM N9005
+    phoneOS: Android
+    timeZone: America/New_York
+    token: sample_tk
+    traceId: TRACE_ID
+  method: post
+  url: /cloud/v1/deviceManaged/devices
+login:
+  json_object:
+    acceptLanguage: en
+    appVersion: 2.8.6
+    devToken: ''
+    email: EMAIL
+    method: login
+    password: PASSWORD
+    phoneBrand: SM N9005
+    phoneOS: Android
+    timeZone: America/New_York
+    traceId: TRACE_ID
+    userType: '1'
+  method: post
+  url: /cloud/v1/user/login

package/api/vesyncbulb/ESL100.yaml

@@ -0,0 +1,74 @@
+set_brightness:
+  headers:
+    accept-language: en
+    accountId: sample_id
+    appVersion: 2.8.6
+    content-type: application/json
+    tk: sample_tk
+    tz: America/New_York
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    brightNess: '50'
+    status: 'on'
+    timeZone: America/New_York
+    token: sample_tk
+    uuid: ESL100-UUID
+  method: put
+  url: /SmartBulb/v1/device/updateBrightness
+turn_off:
+  headers:
+    accept-language: en
+    accountId: sample_id
+    appVersion: 2.8.6
+    content-type: application/json
+    tk: sample_tk
+    tz: America/New_York
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    status: 'off'
+    timeZone: America/New_York
+    token: sample_tk
+    uuid: ESL100-UUID
+  method: put
+  url: /SmartBulb/v1/device/devicestatus
+turn_on:
+  headers:
+    accept-language: en
+    accountId: sample_id
+    appVersion: 2.8.6
+    content-type: application/json
+    tk: sample_tk
+    tz: America/New_York
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    status: 'on'
+    timeZone: America/New_York
+    token: sample_tk
+    uuid: ESL100-UUID
+  method: put
+  url: /SmartBulb/v1/device/devicestatus
+update:
+  headers:
+    accept-language: en
+    accountId: sample_id
+    appVersion: 2.8.6
+    content-type: application/json
+    tk: sample_tk
+    tz: America/New_York
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    appVersion: 2.8.6
+    method: devicedetail
+    mobileId: '1234567890123456'
+    phoneBrand: SM N9005
+    phoneOS: Android
+    timeZone: America/New_York
+    token: sample_tk
+    traceId: TRACE_ID
+    uuid: ESL100-UUID
+  method: post
+  url: /SmartBulb/v1/device/devicedetail

package/api/vesyncbulb/ESL100CW.yaml

@@ -0,0 +1,123 @@
+set_brightness:
+  headers:
+    accept-language: en
+    accountId: sample_id
+    appVersion: 2.8.6
+    content-type: application/json
+    tk: sample_tk
+    tz: America/New_York
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    appVersion: 2.8.6
+    cid: ESL100CW-CID
+    configModule: ConfigModule
+    jsonCmd:
+      light:
+        brightness: 50
+    method: bypass
+    phoneBrand: SM N9005
+    phoneOS: Android
+    timeZone: America/New_York
+    token: sample_tk
+    traceId: TRACE_ID
+  method: post
+  url: /cloud/v1/deviceManaged/bypass
+set_color_temp:
+  headers:
+    accept-language: en
+    accountId: sample_id
+    appVersion: 2.8.6
+    content-type: application/json
+    tk: sample_tk
+    tz: America/New_York
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    appVersion: 2.8.6
+    cid: ESL100CW-CID
+    jsonCmd:
+      light:
+        colorTempe: 50
+    method: bypass
+    phoneBrand: SM N9005
+    phoneOS: Android
+    timeZone: America/New_York
+    token: sample_tk
+    traceId: TRACE_ID
+  method: post
+  url: /cloud/v1/deviceManaged/bypass
+turn_off:
+  headers:
+    accept-language: en
+    accountId: sample_id
+    appVersion: 2.8.6
+    content-type: application/json
+    tk: sample_tk
+    tz: America/New_York
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    appVersion: 2.8.6
+    cid: ESL100CW-CID
+    configModule: ConfigModule
+    jsonCmd:
+      light:
+        action: 'off'
+    method: bypass
+    phoneBrand: SM N9005
+    phoneOS: Android
+    timeZone: America/New_York
+    token: sample_tk
+    traceId: TRACE_ID
+  method: post
+  url: /cloud/v1/deviceManaged/bypass
+turn_on:
+  headers:
+    accept-language: en
+    accountId: sample_id
+    appVersion: 2.8.6
+    content-type: application/json
+    tk: sample_tk
+    tz: America/New_York
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    appVersion: 2.8.6
+    cid: ESL100CW-CID
+    configModule: ConfigModule
+    jsonCmd:
+      light:
+        action: 'on'
+    method: bypass
+    phoneBrand: SM N9005
+    phoneOS: Android
+    timeZone: America/New_York
+    token: sample_tk
+    traceId: TRACE_ID
+  method: post
+  url: /cloud/v1/deviceManaged/bypass
+update:
+  headers:
+    accept-language: en
+    accountId: sample_id
+    appVersion: 2.8.6
+    content-type: application/json
+    tk: sample_tk
+    tz: America/New_York
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    appVersion: 2.8.6
+    cid: ESL100CW-CID
+    configModule: ConfigModule
+    jsonCmd:
+      getLightStatus: get
+    method: bypass
+    phoneBrand: SM N9005
+    phoneOS: Android
+    timeZone: America/New_York
+    token: sample_tk
+    traceId: TRACE_ID
+  method: post
+  url: /cloud/v1/deviceManaged/bypass

package/api/vesyncbulb/ESL100MC.yaml

@@ -0,0 +1,169 @@
+enable_white_mode:
+  headers:
+    Content-Type: application/json; charset=UTF-8
+    User-Agent: okhttp/3.12.1
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    appVersion: 2.8.6
+    cid: ESL100MC-CID
+    configModule: ConfigModule
+    debugMode: false
+    deviceRegion: US
+    method: bypassV2
+    payload:
+      data:
+        action: 'on'
+        blue: 0
+        brightness: 100
+        colorMode: white
+        green: 0
+        red: 0
+        speed: 0
+      method: setLightStatus
+      source: APP
+    phoneBrand: SM N9005
+    phoneOS: Android
+    timeZone: America/New_York
+    token: sample_tk
+    traceId: TRACE_ID
+  method: post
+  url: /cloud/v2/deviceManaged/bypassV2
+set_brightness:
+  headers:
+    Content-Type: application/json; charset=UTF-8
+    User-Agent: okhttp/3.12.1
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    appVersion: 2.8.6
+    cid: ESL100MC-CID
+    configModule: ConfigModule
+    debugMode: false
+    deviceRegion: US
+    method: bypassV2
+    payload:
+      data:
+        action: 'on'
+        blue: 0
+        brightness: 50
+        colorMode: white
+        green: 0
+        red: 0
+        speed: 0
+      method: setLightStatus
+      source: APP
+    phoneBrand: SM N9005
+    phoneOS: Android
+    timeZone: America/New_York
+    token: sample_tk
+    traceId: TRACE_ID
+  method: post
+  url: /cloud/v2/deviceManaged/bypassV2
+set_rgb:
+  headers:
+    Content-Type: application/json; charset=UTF-8
+    User-Agent: okhttp/3.12.1
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    appVersion: 2.8.6
+    cid: ESL100MC-CID
+    configModule: ConfigModule
+    debugMode: false
+    deviceRegion: US
+    method: bypassV2
+    payload:
+      data:
+        action: 'on'
+        blue: 255
+        brightness: 100
+        colorMode: color
+        green: 200
+        red: 50
+        speed: 0
+      method: setLightStatus
+      source: APP
+    phoneBrand: SM N9005
+    phoneOS: Android
+    timeZone: America/New_York
+    token: sample_tk
+    traceId: TRACE_ID
+  method: post
+  url: /cloud/v2/deviceManaged/bypassV2
+turn_off:
+  headers:
+    Content-Type: application/json; charset=UTF-8
+    User-Agent: okhttp/3.12.1
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    appVersion: 2.8.6
+    cid: ESL100MC-CID
+    configModule: ConfigModule
+    debugMode: false
+    deviceRegion: US
+    method: bypassV2
+    payload:
+      data:
+        enabled: false
+        id: 0
+      method: setSwitch
+      source: APP
+    phoneBrand: SM N9005
+    phoneOS: Android
+    timeZone: America/New_York
+    token: sample_tk
+    traceId: TRACE_ID
+  method: post
+  url: /cloud/v2/deviceManaged/bypassV2
+turn_on:
+  headers:
+    Content-Type: application/json; charset=UTF-8
+    User-Agent: okhttp/3.12.1
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    appVersion: 2.8.6
+    cid: ESL100MC-CID
+    configModule: ConfigModule
+    debugMode: false
+    deviceRegion: US
+    method: bypassV2
+    payload:
+      data:
+        enabled: true
+        id: 0
+      method: setSwitch
+      source: APP
+    phoneBrand: SM N9005
+    phoneOS: Android
+    timeZone: America/New_York
+    token: sample_tk
+    traceId: TRACE_ID
+  method: post
+  url: /cloud/v2/deviceManaged/bypassV2
+update:
+  headers:
+    Content-Type: application/json; charset=UTF-8
+    User-Agent: okhttp/3.12.1
+  json_object:
+    acceptLanguage: en
+    accountID: sample_id
+    appVersion: 2.8.6
+    cid: ESL100MC-CID
+    configModule: ConfigModule
+    debugMode: false
+    deviceRegion: US
+    method: bypassV2
+    payload:
+      data: {}
+      method: getLightStatus
+      source: APP
+    phoneBrand: SM N9005
+    phoneOS: Android
+    timeZone: America/New_York
+    token: sample_tk
+    traceId: TRACE_ID
+  method: post
+  url: /cloud/v2/deviceManaged/bypassV2