homebridge-tsvesync 1.0.96 → 1.0.97

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## 1.0.97 (2025-08-16)
+
+### Added
+- **Enhanced Authentication Reliability**: Updated to tsvesync v1.0.97 with improved authentication system
+  - Automatic support for new two-step VeSync authentication flow with legacy fallback
+  - Enhanced cross-region authentication support for international users
+  - Improved authentication error recovery and retry mechanisms
+- **Regional API Support**: Automatic detection and routing for global VeSync API endpoints
+  - Enhanced support for EU users with automatic endpoint switching
+  - Improved authentication reliability for users in different geographical regions
+  - Better handling of cross-region authentication errors and automatic fallback
+
+### Fixed
+- **Authentication Issues**: Resolved authentication problems affecting international users
+  - Fixed "app version is too low" errors with updated VeSync API compatibility
+  - Improved authentication success rates for users in EU and other regions
+  - Enhanced token refresh and session management reliability
+- **API Compatibility**: Updated VeSync API version support for improved stability
+  - Better handling of VeSync API changes and authentication protocol updates
+  - Improved compatibility with latest VeSync mobile app authentication methods
+
+### Dependencies
+- Updated tsvesync from 1.0.96 to 1.0.97 for enhanced authentication and regional support
+
+### Migration Notes
+- No configuration changes required - authentication improvements are automatic
+- Enhanced authentication reliability should improve connection stability for all users
+- International users should experience better authentication success rates
+- Existing device functionality remains unchanged with improved underlying reliability
+
 ## 1.0.96 (2025-08-09)
 
 ### Changed

package/README.md

@@ -2,6 +2,12 @@
 
 This is a Homebridge plugin that allows you to control your VeSync/Levoit/Etekcity devices through HomeKit. It provides native HomeKit integration for a wide range of VeSync-enabled devices.
 
+## 🆕 Recent Updates
+
+- **Enhanced Authentication Support**: Now supports the new VeSync authentication flow (pyvesync PR #340) with automatic fallback to legacy authentication
+- **Regional API Support**: Automatic detection and routing for US and EU regional endpoints
+- **Improved Compatibility**: Better error handling and automatic recovery for API changes
+
 ## Supported Devices
 
 ### Air Purifiers
@@ -223,10 +229,48 @@ Example configuration with all exclusion options:
 
 ## Troubleshooting
 
-1. Make sure your VeSync credentials are correct
-2. Check the Homebridge logs for any error messages
-3. Ensure your devices are properly set up in the VeSync app
-4. Verify your devices are running the latest firmware
+### Authentication Issues
+
+If you're experiencing authentication problems, you can test your credentials and determine your authentication type using the included test script:
+
+```bash
+# Test your VeSync authentication
+./scripts/vesync-auth-test.sh
+
+# Or provide credentials directly
+./scripts/vesync-auth-test.sh user@example.com password
+
+# For detailed output
+./scripts/vesync-auth-test.sh -v
+```
+
+The script will:
+- Test both NEW and LEGACY authentication methods
+- Detect your account's regional endpoint (US/EU)
+- Provide clear recommendations for configuration
+- Show any error codes with explanations
+
+### Common Issues
+
+1. **Authentication Failed**
+   - Verify your VeSync credentials are correct
+   - Try logging into the VeSync app to confirm they work
+   - Run the authentication test script to diagnose issues
+
+2. **Devices Not Appearing**
+   - Check the Homebridge logs for any error messages
+   - Ensure your devices are properly set up in the VeSync app
+   - Verify your devices are running the latest firmware
+
+3. **Regional Issues (EU Users)**
+   - The plugin automatically detects and uses the correct regional endpoint
+   - EU accounts will automatically use `smartapi.vesync.eu`
+   - US/CA/MX/JP accounts use `smartapi.vesync.com`
+
+4. **API Rate Limiting**
+   - The plugin includes automatic rate limiting
+   - If you see quota errors, increase the `updateInterval` in your config
+   - Premium accounts have higher quotas than free accounts
 5. Check that your devices are online in the VeSync app
 
 ## Development

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-tsvesync",
-  "version": "1.0.96",
+  "version": "1.0.97",
   "description": "Homebridge plugin for VeSync devices including Levoit air purifiers, humidifiers, and Etekcity smart outlets",
   "main": "dist/index.js",
   "scripts": {
@@ -98,7 +98,7 @@
     "axios": "^1.6.5",
     "dotenv": "^16.3.1",
     "js-yaml": "^4.1.0",
-    "tsvesync": "1.0.96"
+    "tsvesync": "1.0.97"
   },
   "devDependencies": {
     "@types/jest": "^29.5.11",

package/scripts/README.md

@@ -0,0 +1,65 @@
+# VeSync Authentication Testing Scripts
+
+This directory contains scripts for testing and validating VeSync authentication flows.
+
+## Files
+
+### test-auth-type.sh
+Comprehensive script to test both NEW (PR #340) and LEGACY VeSync authentication flows.
+
+**Features:**
+- Tests both NEW two-step authentication and LEGACY single-step authentication
+- Regional endpoint detection (US, EU, Global)
+- PII redaction for security
+- Comprehensive error code explanations
+- Network connectivity testing
+- Detailed recommendations based on results
+
+**Usage:**
+```bash
+# Using environment variables from .env
+scripts/run-auth-test.sh
+
+# Direct usage with credentials
+scripts/test-auth-type.sh user@example.com password
+
+# With verbose output
+scripts/test-auth-type.sh -v user@example.com password
+
+# With debug mode (saves API responses)
+scripts/test-auth-type.sh -d user@example.com password
+```
+
+### run-auth-test.sh
+Helper script that loads environment variables from .env file and runs the authentication test.
+
+**Usage:**
+```bash
+# Ensure .env file exists with VESYNC_USERNAME and VESYNC_PASSWORD
+scripts/run-auth-test.sh [options]
+```
+
+## Environment Variables
+
+Create a `.env` file in the project root with:
+```env
+VESYNC_USERNAME=your-email@example.com
+VESYNC_PASSWORD=your-password
+```
+
+## Recent Fixes
+
+- **Fixed JSON payload construction**: Replaced problematic here-doc syntax with printf-based JSON construction to prevent script hanging
+- **Improved environment variable loading**: Added proper .env file loading support
+- **Enhanced error handling**: Better error codes and explanations
+- **Added PII redaction**: Safely masks sensitive information in output
+
+## Authentication Flow Detection
+
+The script will determine:
+1. **NEW Authentication (PR #340)**: Two-step flow using authorize codes
+2. **LEGACY Authentication**: Traditional single-step login flow  
+3. **Regional Issues**: Cross-region authentication problems
+4. **API Changes**: Detection of new error codes or API changes
+
+Results include specific recommendations for which authentication method to use in your implementation.