Package Exports
- homebridge-aldesvmc
- homebridge-aldesvmc/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (homebridge-aldesvmc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Homebridge Aldes VMC Plugin
This is a Homebridge plugin for controlling Aldes Ventilation Units (VMC) compatible with the AldesConnect™ mobile application. It uses the same underlying API as the mobile app to control the ventilation modes.
Disclaimer: This plugin uses an unofficial API based on reverse-engineering the AldesConnect™ app. It may break without notice if Aldes changes their API. Use at your own risk.
Features
- Exposes the Aldes VMC as a Fan accessory in HomeKit.
- Allows setting ventilation modes by adjusting the fan speed in the Home app:
- 0% (Off): Sets mode 'V' (Minimum/Daily)
- 50%: Sets mode 'Y' (Boost)
- 100%: Sets mode 'X' (Guests)
- Reports the current VMC mode as the fan speed (0%, 50%, or 100%).
- Handles Aldes API token acquisition and refresh automatically.
- Exposes environmental sensors for models that support these metrics:
- Air Quality
- CO₂ level
- Multiple temperature sensors (up to 5)
- Multiple humidity sensors (up to 5)
- Configurable polling intervals for sensors and external changes detection.
- Force Mode Indicator: Shows as a read-only switch in HomeKit. ON = VMC is in forced/self-controlled mode (cannot be controlled from HomeKit), OFF = normal operation.
Requirements
- Node.js >= 16.0.0
- Homebridge >= 1.3.0
Installation
- Install Homebridge using the official instructions.
- Install this plugin globally using npm:
sudo npm install -g homebridge-aldesVMC
- Update your Homebridge
config.jsonfile with the platform configuration (see below).
Configuration
Add the following platform block to your config.json within the platforms array:
{
"platform": "AldesVMC",
"name": "AldesVMC",
"username": "YOUR_ALDES_USERNAME",
"password": "YOUR_ALDES_PASSWORD",
"vmcName": "Aldes VMC",
"enableSensors": true,
"sensorPollingInterval": 60,
"externalChangesPollingInterval": 60,
"sensorConfig": {
"temperature": {
"main": true,
"ba1": true,
"ba2": true,
"ba3": false,
"ba4": false
},
"humidity": {
"main": true,
"ba1": true,
"ba2": true,
"ba3": false,
"ba4": false
}
}
}Fields:
platform(required): Must be"AldesVMC".name(required): The name to identify this platform instance (e.g.,"AldesVMC").username(required): Your username (email address) for the AldesConnect™ account.password(required): Your password for the AldesConnect™ account.vmcName(optional): The name for the VMC accessory as it will appear in the Home app (Default:"Aldes VMC").enableSensors(optional): Set tofalseto disable all sensors if your model doesn't support them (Default:true).sensorPollingInterval(optional): Interval in seconds between sensor data updates (Default:60).externalChangesPollingInterval(optional): Interval in seconds to check for VMC mode changes made from the Aldes app (Default:60).sensorConfig(optional): Configure which temperature and humidity sensors to enable (see below).
Sensor Configuration
The plugin supports up to 5 temperature and 5 humidity sensors, which can be individually enabled or disabled:
main: Main sensor (diameter 125mm)ba1: Room 1 sensor (diameter 80mm)ba2: Room 2 sensor (diameter 80mm)ba3: Room 3 sensor (diameter 80mm)ba4: Room 4 sensor (diameter 80mm)
By default, the main sensor and the first two room sensors are enabled for both temperature and humidity.
Sensors & Accessories
This plugin adds several HomeKit accessories:
- Air Quality Sensor - Shows the air quality level from your VMC unit:
- Reports quality levels: Excellent, Good, Fair, Inferior, Poor
- CO₂ Sensor - Shows the carbon dioxide level from your VMC unit:
- Reports CO₂ concentration in ppm
- Triggers abnormal status when CO₂ levels exceed 1000 ppm
- Multiple Temperature Sensors - Show temperature readings from different locations:
- Main Temperature Sensor ⌀125 - Main unit temperature reading
- Room 1-4 Temperature Sensors ⌀80 - Additional room temperature readings
- All report temperature in Celsius
- Multiple Humidity Sensors - Show humidity readings from different locations:
- Main Humidity Sensor ⌀125 - Main unit humidity reading
- Room 1-4 Humidity Sensors ⌀80 - Additional room humidity readings
- All report humidity percentage (0-100%)
- Force Mode Indicator - Indicates when the VMC is in forced mode (self-controlled):
- Shows as a read-only switch in HomeKit
- Switch OFF when in normal operation
- Switch ON when in forced mode (when control is not possible)
All sensors update their values by polling the Aldes API at the interval specified in the configuration (default: 60 seconds).
Force Mode Explained
When the VMC is in "Force Mode" (self-controlled), it cannot be controlled from HomeKit. The plugin exposes a read-only switch in HomeKit to indicate this state:
- ON: VMC is in forced/self-controlled mode (external override, e.g., boost from the wall control or app)
- OFF: VMC is in normal operation and can be controlled from HomeKit
Logging & Troubleshooting
- The plugin logs detailed debug and info messages. You can control the log level in Homebridge UI or by setting the
-Dflag when starting Homebridge. - If you see repeated warnings about API health or token errors, check your credentials and network connection.
- If you experience rate limiting, increase the polling intervals in your config.
- For troubleshooting, enable debug logging and review the Homebridge logs for details.
Changelog
- 1.1.2: Improved stability, cleanup and optimization
- 1.1.1: Improved accessory cleanup, added Force Mode indicator, enhanced error handling, and optimized polling.
- 1.1.0: Added support for multiple sensors and improved HomeKit state synchronization.
- 1.0.0: Initial release.
License
This plugin is licensed under the MIT License. See the LICENSE file for details.