tsvesync 1.6.0 → 1.7.0

package/dist/lib/fans/towerFan.js

@@ -3,254 +3,190 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VeSyncTowerFan = void 0;
 const airBaseV2_1 = require("./airBaseV2");
 const logger_1 = require("../logger");
-/**
- * VeSync Tower Fan Implementation
- */
+/** LTF-F422S tower fans use different commands from bypassV2 purifiers. */
 class VeSyncTowerFan extends airBaseV2_1.VeSyncAirBaseV2 {
     constructor(details, manager) {
         super(details, manager);
-        this.towerModes = ['normal', 'advancedSleep', 'off'];
-        logger_1.logger.debug(`Initialized VeSyncTowerFan device: ${this.deviceName}`);
+        this.towerModes = ['normal', 'auto', 'advancedSleep', 'turbo', 'off'];
     }
-    /**
-     * Get device details
-     */
-    async getDetails() {
-        logger_1.logger.debug(`Getting details for device: ${this.deviceName}`);
-        const [head, body] = this.buildApiDict('getTowerFanStatus');
-        const [response, status] = await this.callApi('/cloud/v2/deviceManaged/bypassV2', 'post', body, head);
-        if (!this.checkResponse([response, status], 'getDetails') || !(response === null || response === void 0 ? void 0 : response.result)) {
-            logger_1.logger.debug('Error getting tower fan details');
-            this.connectionStatus = 'offline';
+    /** A successful cloud envelope can still contain a rejected device command. */
+    checkResponse(response, method) {
+        var _a, _b, _c;
+        if (!super.checkResponse(response, method))
+            return false;
+        const result = (_a = response[0]) === null || _a === void 0 ? void 0 : _a.result;
+        if (!result || result.code !== 0) {
+            this.logError(method, `Device error code ${(_b = result === null || result === void 0 ? void 0 : result.code) !== null && _b !== void 0 ? _b : 'missing'}: ${(_c = result === null || result === void 0 ? void 0 : result.msg) !== null && _c !== void 0 ? _c : 'Invalid device response'}`);
             return false;
         }
-        const innerResponse = response.result;
-        if (innerResponse.code !== 0 || !innerResponse.result) {
-            logger_1.logger.debug('Error in inner response from tower fan');
+        return true;
+    }
+    async request(method, data = {}) {
+        var _a;
+        const [head, body] = this.buildApiDict(method);
+        body.payload.data = data;
+        const response = await this.callApi('/cloud/v2/deviceManaged/bypassV2', 'post', body, head);
+        if (!this.checkResponse(response, method))
+            return null;
+        this.connectionStatus = 'online';
+        return (_a = response[0].result.result) !== null && _a !== void 0 ? _a : {};
+    }
+    async getDetails() {
+        var _a, _b;
+        const data = await this.request('getTowerFanStatus');
+        if (!data || (data.powerSwitch !== 0 && data.powerSwitch !== 1)) {
             this.connectionStatus = 'offline';
             return false;
         }
-        const deviceData = innerResponse.result;
-        this.deviceStatus = deviceData.powerSwitch === 1 ? 'on' : 'off';
-        this.details = {
-            powerSwitch: deviceData.powerSwitch,
-            workMode: deviceData.workMode,
-            manualSpeedLevel: deviceData.manualSpeedLevel,
-            fanSpeedLevel: deviceData.fanSpeedLevel,
-            screenState: deviceData.screenState,
-            screenSwitch: deviceData.screenSwitch,
-            oscillationState: deviceData.oscillationState,
-            oscillationSwitch: deviceData.oscillationSwitch,
-            timerRemain: deviceData.timerRemain,
-            temperature: deviceData.temperature || 0,
-            humidity: deviceData.humidity || 0,
-            thermalComfort: deviceData.thermalComfort,
-            sleepPreference: deviceData.sleepPreference || {},
-            scheduleCount: deviceData.scheduleCount,
-            displayingType: deviceData.displayingType,
-            errorCode: deviceData.errorCode
-        };
-        logger_1.logger.debug(`Successfully got details for device: ${this.deviceName}`);
+        this.deviceStatus = data.powerSwitch === 1 ? 'on' : 'off';
+        this.details = { ...data };
+        this.mode = (_a = data.workMode) !== null && _a !== void 0 ? _a : 'normal';
+        // A status poll cannot identify the timer. It may have been replaced in
+        // the app, so never carry an older command's id into cancellation.
+        this.timerId = undefined;
+        this.updateTimerState((_b = data.timerRemain) !== null && _b !== void 0 ? _b : 0, this.deviceStatus === 'on' ? 'off' : 'on');
         return true;
     }
-    /**
-     * Toggle device power
-     */
     async toggleSwitch(toggle) {
-        if (typeof toggle !== 'boolean') {
-            logger_1.logger.debug('Invalid toggle value for tower fan switch');
+        if (typeof toggle !== 'boolean')
             return false;
-        }
-        const [head, body] = this.buildApiDict('setSwitch');
-        body.payload.data = {
-            powerSwitch: toggle ? 1 : 0,
-            switchIdx: 0
-        };
-        const [response, status] = await this.callApi('/cloud/v2/deviceManaged/bypassV2', 'post', body, head);
-        const success = this.checkResponse([response, status], 'toggleSwitch');
-        if (success) {
-            this.deviceStatus = toggle ? 'on' : 'off';
-        }
-        else {
-            logger_1.logger.debug('Error toggling tower fan power');
-        }
-        return success;
-    }
-    /**
-     * Turn device on
-     */
-    async turnOn() {
-        logger_1.logger.debug(`Turning on device: ${this.deviceName}`);
-        return this.toggleSwitch(true);
-    }
-    /**
-     * Turn device off
-     */
-    async turnOff() {
-        logger_1.logger.debug(`Turning off device: ${this.deviceName}`);
-        return this.toggleSwitch(false);
+        if (!await this.request('setSwitch', { powerSwitch: Number(toggle), switchIdx: 0 }))
+            return false;
+        this.deviceStatus = toggle ? 'on' : 'off';
+        this.details.powerSwitch = Number(toggle);
+        return true;
     }
-    /**
-     * Set tower fan mode
-     */
+    async turnOn() { return this.toggleSwitch(true); }
+    async turnOff() { return this.toggleSwitch(false); }
     async mode_toggle(mode) {
-        if (!this.towerModes.includes(mode)) {
-            logger_1.logger.debug(`Invalid mode: ${mode}. Must be one of: ${this.towerModes.join(', ')}`);
+        const apiMode = mode === 'sleep' ? 'advancedSleep' : mode === 'manual' ? 'normal' : mode;
+        if (!this.towerModes.includes(apiMode))
             return false;
-        }
-        if (mode === 'off') {
+        if (apiMode === 'off')
             return this.turnOff();
-        }
-        const [head, body] = this.buildApiDict('setTowerFanMode');
-        body.deviceId = this.cid;
-        body.payload.data = {
-            workMode: mode
-        };
-        const [response, status] = await this.callApi('/cloud/v2/deviceManaged/bypassV2', 'post', body, head);
-        const success = this.checkResponse([response, status], 'mode_toggle');
-        if (success) {
-            this.details.workMode = mode;
-        }
-        else {
-            logger_1.logger.error(`Failed to set ${mode} mode for device: ${this.deviceName}`);
-        }
-        return success;
+        if (!await this.request('setTowerFanMode', { workMode: apiMode }))
+            return false;
+        this.mode = apiMode;
+        return true;
     }
-    /**
-     * Change fan speed
-     */
+    async setMode(mode) { return this.mode_toggle(mode); }
+    async normal_mode() { return this.setMode('normal'); }
+    async manual_mode() { return this.normal_mode(); }
+    async advanced_sleep_mode() { return this.setMode('sleep'); }
+    async sleep_mode() { return this.advanced_sleep_mode(); }
     async changeFanSpeed(speed) {
-        // const speeds = this.config.levels ?? [];
-        // if (!speeds.includes(speed)) {
-        //     logger.debug(`Invalid speed: ${speed}. Must be one of: ${speeds.join(', ')}`);
-        //     return false;
-        // }
-        const [head, body] = this.buildApiDict('setLevel');
-        body.payload.data = {
-            levelIdx: 0,
-            levelType: 'wind',
-            manualSpeedLevel: speed
-        };
-        const [response, status] = await this.callApi('/cloud/v2/deviceManaged/bypassV2', 'post', body, head);
-        const success = this.checkResponse([response, status], 'changeFanSpeed');
-        if (success) {
-            this.details.manualSpeedLevel = speed;
-        }
-        else {
-            logger_1.logger.debug('Error setting fan speed');
-        }
-        return success;
-    }
-    /**
-     * Set normal mode
-     */
-    async normal_mode() {
-        logger_1.logger.debug(`Setting normal mode for device: ${this.deviceName}`);
-        return this.mode_toggle('normal');
-    }
-    /**
-     * Set manual mode - adapter to set mode to normal
-     */
-    async manual_mode() {
-        logger_1.logger.debug(`Setting manual mode for device: ${this.deviceName}`);
-        return this.normal_mode();
-    }
-    /**
-     * Set advanced sleep mode
-     */
-    async advanced_sleep_mode() {
-        logger_1.logger.debug(`Setting advanced sleep mode for device: ${this.deviceName}`);
-        return this.mode_toggle('advancedSleep');
-    }
-    /**
-     * Set sleep mode - adapter for advanced sleep mode
-     */
-    async sleep_mode() {
-        logger_1.logger.debug(`Setting sleep mode for device: ${this.deviceName}`);
-        return this.advanced_sleep_mode();
-    }
-    /**
-     * Override setMode to handle tower fan specific modes
-     */
-    async setMode(mode) {
-        return this.mode_toggle(mode);
-    }
-    /**
-     * Get current speed
-     */
-    get speed() {
-        return this.details.manualSpeedLevel || 0;
-    }
-    /**
-     * Get display status
-     */
-    get displayState() {
-        return Boolean(this.details.screenState);
-    }
-    /**
-     * Get oscillation status
-     */
-    get oscillationState() {
-        return Boolean(this.details.oscillationState);
-    }
-    /**
-     * Get mute status
-     */
-    get muteState() {
-        return Boolean(this.details.muteState);
-    }
-    /**
-     * Get temperature (in tenths of a degree)
-     */
-    get temperature() {
-        return this.details.temperature || 0;
-    }
-    /**
-     * Get humidity percentage
-     */
-    get humidity() {
-        return this.details.humidity || 0;
+        var _a;
+        if (!Number.isInteger(speed) || !((_a = this.config.levels) !== null && _a !== void 0 ? _a : []).includes(speed))
+            return false;
+        if (!await this.request('setLevel', { levelIdx: 0, levelType: 'wind', manualSpeedLevel: speed }))
+            return false;
+        this.details.manualSpeedLevel = speed;
+        return true;
     }
-    /**
-     * Get thermal comfort level
-     */
-    get thermalComfort() {
-        return this.details.thermalComfort || 0;
+    async setOscillation(toggle) {
+        if (typeof toggle !== 'boolean')
+            return false;
+        if (!await this.request('setOscillationSwitch', { oscillationSwitch: Number(toggle) }))
+            return false;
+        this.details.oscillationSwitch = Number(toggle);
+        this.details.oscillationState = Number(toggle);
+        return true;
     }
-    /**
-     * Get sleep preferences
-     */
-    get sleepPreference() {
-        return this.details.sleepPreference || {};
+    async setOscillationOn() { return this.setOscillation(true); }
+    async setOscillationOff() { return this.setOscillation(false); }
+    async setDisplay(enabled) {
+        if (typeof enabled !== 'boolean')
+            return false;
+        if (!await this.request('setDisplay', { screenSwitch: Number(enabled) }))
+            return false;
+        this.details.screenSwitch = Number(enabled);
+        this.details.screenState = Number(enabled);
+        return true;
     }
-    /**
-     * Get schedule count
-     */
-    get scheduleCount() {
-        return this.details.scheduleCount || 0;
+    async setMute(enabled) {
+        if (typeof enabled !== 'boolean')
+            return false;
+        if (!await this.request('setMuteSwitch', { muteSwitch: Number(enabled) }))
+            return false;
+        this.details.muteSwitch = Number(enabled);
+        this.details.muteState = Number(enabled);
+        return true;
     }
-    /**
-     * Get error code
-     */
-    get errorCode() {
-        return this.details.errorCode || 0;
+    /** Public timer duration remains hours, like the other tsvesync devices. */
+    async setTimer(hours, action = this.deviceStatus === 'on' ? 'off' : 'on') {
+        const seconds = Math.round(hours * 3600);
+        if (!Number.isFinite(hours) || hours <= 0 || hours > 12 || seconds < 1 || !['on', 'off'].includes(action))
+            return false;
+        const result = await this.request('setTimer', { action, total: seconds });
+        if (!result || !Number.isInteger(result.id))
+            return false;
+        this.timerId = result.id;
+        this.updateTimerState(seconds, action);
+        return true;
     }
-    /**
-     * Turn oscillation on
-     */
-    async setOscillationOn() {
-        return this.setOscillation(true);
+    async getTimer() {
+        const result = await this.request('getTimer');
+        if (!result || !('timers' in result) || (result.timers !== null && !Array.isArray(result.timers)))
+            return false;
+        if (result.timers === null || result.timers.length === 0) {
+            this.updateTimerState(0, 'off');
+            return true;
+        }
+        const timer = result.timers[0];
+        if (!Number.isInteger(timer.id) || !Number.isFinite(timer.remain) || timer.remain < 0 || !['on', 'off'].includes(timer.action))
+            return false;
+        this.timerId = timer.id;
+        this.updateTimerState(timer.remain, timer.action);
+        return true;
     }
-    /**
-     * Turn oscillation off
-     */
-    async setOscillationOff() {
-        return this.setOscillation(false);
+    async clearTimer() {
+        // Status responses include the remaining duration but not the timer id.
+        if (this.timerRemaining > 0 && this.timerId === undefined && !await this.getTimer())
+            return false;
+        if (this.timerId === undefined)
+            return this.timerRemaining === 0;
+        if (!await this.request('clearTimer', { id: this.timerId }))
+            return false;
+        this.updateTimerState(0, 'off');
+        return true;
     }
-    /**
-     * Display device info
-     */
+    updateTimerState(seconds, action) {
+        const remaining = Number.isFinite(seconds) ? Math.max(0, seconds) : 0;
+        this.details.timerRemain = remaining;
+        this._timer = remaining > 0 ? { duration: remaining, action } : null;
+        this.timerDeadline = remaining > 0 ? Date.now() + remaining * 1000 : undefined;
+        if (remaining === 0)
+            this.timerId = undefined;
+    }
+    get timerRemaining() {
+        return this.timerDeadline === undefined ? 0 : Math.max(0, Math.ceil((this.timerDeadline - Date.now()) / 1000));
+    }
+    get mode() { var _a; return this.details.workMode === 'advancedSleep' ? 'sleep' : (_a = this.details.workMode) !== null && _a !== void 0 ? _a : 'normal'; }
+    set mode(value) {
+        this.details.workMode = value === 'sleep' ? 'advancedSleep' : value === 'manual' ? 'normal' : value;
+        this.details.mode = this.mode;
+    }
+    get speed() { var _a, _b; return (_b = (_a = this.details.manualSpeedLevel) !== null && _a !== void 0 ? _a : this.details.fanSpeedLevel) !== null && _b !== void 0 ? _b : 0; }
+    set speed(value) { this.details.manualSpeedLevel = value; }
+    get displayState() { return this.details.screenState === 1; }
+    get displayEnabled() { return this.details.screenSwitch === 1; }
+    get screenStatus() { return this.displayEnabled ? 'on' : 'off'; }
+    get oscillationState() { return this.details.oscillationState === 1; }
+    get oscillationEnabled() { return this.details.oscillationSwitch === 1; }
+    get muteState() { return this.details.muteState === 1; }
+    /** Raw API temperature is Fahrenheit times ten, retained for compatibility. */
+    get temperature() { var _a; return (_a = this.details.temperature) !== null && _a !== void 0 ? _a : 0; }
+    get temperatureCelsius() {
+        const raw = this.details.temperature;
+        return typeof raw === 'number' && Number.isFinite(raw) ? (raw / 10 - 32) * 5 / 9 : undefined;
+    }
+    get humidity() { var _a; return (_a = this.details.humidity) !== null && _a !== void 0 ? _a : 0; }
+    get thermalComfort() { var _a; return (_a = this.details.thermalComfort) !== null && _a !== void 0 ? _a : 0; }
+    get sleepPreference() { var _a; return (_a = this.details.sleepPreference) !== null && _a !== void 0 ? _a : {}; }
+    get scheduleCount() { var _a; return (_a = this.details.scheduleCount) !== null && _a !== void 0 ? _a : 0; }
+    get errorCode() { var _a; return (_a = this.details.errorCode) !== null && _a !== void 0 ? _a : 0; }
     display() {
+        var _a;
         super.display();
         const info = [
             ['Mode: ', this.details.workMode || ''],
@@ -263,7 +199,7 @@ class VeSyncTowerFan extends airBaseV2_1.VeSyncAirBaseV2 {
             ['Mute: ', this.muteState],
             ['Mute Switch: ', this.details.muteSwitch],
             ['Timer: ', this.timer],
-            ['Temperature: ', this.temperature / 10, '°C'],
+            ['Temperature: ', (_a = this.temperatureCelsius) !== null && _a !== void 0 ? _a : 'unknown', '°C'],
             ['Humidity: ', this.humidity, '%'],
             ['Thermal Comfort: ', this.thermalComfort],
             ['Sleep Preference: ', JSON.stringify(this.sleepPreference)],

package/dist/lib/vesyncFan.js

@@ -229,25 +229,35 @@ exports.fanConfig = {
     'LTF-F422S-KEU': {
         module: 'VeSyncTowerFan',
         // No child_lock: the LTF-F422S API neither reports nor accepts it (pyvesync parity)
-        features: ['display', 'night_light', 'timer', 'fan_speeds', 'tower_modes'],
+        features: ['display', 'timer', 'fan_speeds', 'tower_modes', 'oscillation', 'temperature', 'mute'],
+        modes: ['normal', 'auto', 'sleep', 'turbo'],
         levels: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
     },
     'LTF-F422S-WUSR': {
         module: 'VeSyncTowerFan',
         // No child_lock: the LTF-F422S API neither reports nor accepts it (pyvesync parity)
-        features: ['display', 'night_light', 'timer', 'fan_speeds', 'tower_modes'],
+        features: ['display', 'timer', 'fan_speeds', 'tower_modes', 'oscillation', 'temperature', 'mute'],
+        modes: ['normal', 'auto', 'sleep', 'turbo'],
+        levels: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
+    },
+    'LTF-F422S-WJP': {
+        module: 'VeSyncTowerFan',
+        features: ['display', 'timer', 'fan_speeds', 'tower_modes', 'oscillation', 'temperature', 'mute'],
+        modes: ['normal', 'auto', 'sleep', 'turbo'],
         levels: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
     },
     'LTF-F422_WJP': {
         module: 'VeSyncTowerFan',
         // No child_lock: the LTF-F422S API neither reports nor accepts it (pyvesync parity)
-        features: ['display', 'night_light', 'timer', 'fan_speeds', 'tower_modes'],
+        features: ['display', 'timer', 'fan_speeds', 'tower_modes', 'oscillation', 'temperature', 'mute'],
+        modes: ['normal', 'auto', 'sleep', 'turbo'],
         levels: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
     },
     'LTF-F422S-WUS': {
         module: 'VeSyncTowerFan',
         // No child_lock: the LTF-F422S API neither reports nor accepts it (pyvesync parity)
-        features: ['display', 'night_light', 'timer', 'fan_speeds', 'tower_modes'],
+        features: ['display', 'timer', 'fan_speeds', 'tower_modes', 'oscillation', 'temperature', 'mute'],
+        modes: ['normal', 'auto', 'sleep', 'turbo'],
         levels: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
     },
     // Classic Series

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tsvesync",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "A TypeScript library for interacting with VeSync smart home devices",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,7 +12,8 @@
     "prepare": "npm run build",
     "version": "git add -A src",
     "postversion": "git push && git push --tags",
-    "test:token-refresh": "ts-node test/token-refresh-retry.test.ts"
+    "test:token-refresh": "ts-node test/token-refresh-retry.test.ts",
+    "test:tower-fan": "ts-node test/tower-fan-parity.test.ts"
   },
   "keywords": [
     "vesync",

package/src/index.ts

@@ -7,6 +7,9 @@ export { VeSyncOutlet7A, VeSyncOutlet10A, VeSyncOutlet15A, VeSyncOutdoorPlug } f
 export { VeSyncBulb } from './lib/vesyncBulb';
 export { VeSyncWallSwitch, VeSyncDimmerSwitch } from './lib/vesyncSwitchImpl';
 
+// Tower fan API
+export { VeSyncTowerFan } from './lib/fans/towerFan';
+
 // Export base device class
 export { VeSyncBaseDevice } from './lib/vesyncBaseDevice';
 

package/src/lib/fans/index.ts

@@ -69,6 +69,7 @@ export const fanModules: Record<string, new (details: Record<string, any>, manag
     // LTF Series
     'LTF-F422S-KEU': VeSyncTowerFan,
     'LTF-F422S-WUSR': VeSyncTowerFan,
+    'LTF-F422S-WJP': VeSyncTowerFan,
     'LTF-F422_WJP': VeSyncTowerFan,
     'LTF-F422S-WUS': VeSyncTowerFan,