homebridge-melcloud-control 4.1.0 → 4.1.1-beta.1

package/CHANGELOG.md

@@ -22,6 +22,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Do not use Homebridge UI > v5.5.0 because of break config.json
 
+## [4.1.1] - (xx.11.2025)
+
+## Changes
+
+- added shedule sensor for MELCLoud Home ATA devices
+- config schema updated
+- readme updated
+- cleanup
+
 ## [4.1.0] - (10.11.2025)
 
 ## Changes

package/README.md

@@ -79,6 +79,7 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
       * Frost protection.
       * Overheat protection.
       * Holiday mode.
+      * Shedule.
       * Error
 * Heat Pump:
   * Heater Cooler:
@@ -223,12 +224,13 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
 | `ataDevices[].heatDryFanMode` | Here select the operatiing mode for `Heat`, if this mode is not supported, it will be disabled. |
 | `ataDevices[].coolDryFanMode` | Here select the operatiing mode for `Cool`, if this mode is not supported, it will be disabled. |
 | `ataDevices[].autoDryFanMode` | Here select the operatiing mode for `Auto`, if this mode is not supported, it will be disabled.. |
-| `ataDevices[].temperatureSensor` | This enable extra `Room` temperature sensors to use with automations in HomeKit app. |
-| `ataDevices[].temperatureOutdoorSensor` | This enable extra `Outdoor` temperature sensors to use with automations in HomeKit app. |
-| `ataDevices[].frostProtectionSensor` | This enable extra `Frost Protectio` sensors to use with automations in HomeKit app. |
-| `ataDevices[].overHeatProtectionSensor` | This enable extra `Overheat Protection` sensors to use with automations in HomeKit app. |
-| `ataDevices[].holidayModeSensor` | This enable extra `Holiday Mode` sensors to use with automations in HomeKit app. |
-| `ataDevices[].errorSensor` | This enable `Error` sensors to use with automations in HomeKit app. |
+| `ataDevices[].temperatureSensor` | This enable extra `Room` temperature sensor to use with automations in HomeKit app. |
+| `ataDevices[].temperatureOutdoorSensor` | This enable extra `Outdoor` temperature sensor to use with automations in HomeKit app. |
+| `ataDevices[].frostProtectionSensor` | This enable extra `Frost Protectio` sensor to use with automations in HomeKit app. |
+| `ataDevices[].overHeatProtectionSensor` | This enable extra `Overheat Protection` sensor to use with automations in HomeKit app. |
+| `ataDevices[].holidayModeSensor` | This enable extra `Holiday Mode` sensor to use with automations in HomeKit app. |
+| `ataDevices[].sheduleSensor` | This enable extra `Shedule` sensor to use with automations in HomeKit app. |
+| `ataDevices[].errorSensor` | This enable `Error` sensor to use with automations in HomeKit app. |
 | `ataDevices[].refreshInterval` | Here set the background devices state refresh time in (sec), default `5s`. |
 | `ataDevices[].presets[]` | Array of ATA device Presets created automatically after login to MELCloud from plugin config UI. |
 | `ataDevices[].presets[].id` | Read only data, do not change it. |
@@ -246,15 +248,15 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
 | `atwDevices[].name` | Here You can schange the `Accessory Name` which is exposed to the `Homebridge/HomeKit`. |
 | `atwDevices[].displayType` | Here select main control mode `None/Disabled`, `Heater/Cooler`, `Thermostat`. |
 | `atwDevices[].hideZone` | Here select which zone need to be hidden `None/Disabled`, `Heat Pump`, `Heat Pump / Zone 1`, `Heat Pump / Zone 1 / Hot Water`, `Heat Pump / Zone 1 / Zone 2`, `Heat Pump / Hot Water`,`Heat Pump / Hot Water / Zone 2`, `Heat Pump / Zone 2`, `Zone 1`, `Zone 1 / Hot Water`, `Zone 1 / Hot Water / Zone 2`, `Zone 1 / Zone 2`, `Hot Water`, `Hot Water / Zone 2`, `Zone 2`, `All`. |
-| `atwDevices[].temperatureSensor` | This enable extra `Room` temperature sensors to use with automations in HomeKit app. |
-| `atwDevices[].temperatureFlowSensor` | This enable extra `Flow` temperature sensors to use with automations in HomeKit app. |
-| `atwDevices[].temperatureReturnSensor` | This enable extra `Return` temperature sensors to use with automations in HomeKit app. |
-| `atwDevices[].temperatureFlowZone1Sensor` | This enable extra `Flow Zone 1` temperature sensors to use with automations in HomeKit app. |
-| `atwDevices[].temperatureReturnZone1Sensor` | This enable extra `Return Zone 1` temperature sensors to use with automations in HomeKit app. |
-| `atwDevices[].temperatureFlowWaterTankSensor` | This enable extra `Flow Water Tank` temperature sensors to use with automations in HomeKit app. |
-| `atwDevices[].temperatureReturnWaterTankSensor` | This enable extra `Return Water Tank` temperature sensors to use with automations in HomeKit app. |
-| `atwDevices[].temperatureFlowZone2Sensor` | This enable extra `Flow Zone 2` temperature sensors to use with automations in HomeKit app. |
-| `atwDevices[].temperatureReturnZone2Sensor` | This enable extra `Return Zone 2` temperature sensors to use with automations in HomeKit app. |
+| `atwDevices[].temperatureSensor` | This enable extra `Room` temperature sensor to use with automations in HomeKit app. |
+| `atwDevices[].temperatureFlowSensor` | This enable extra `Flow` temperature sensor to use with automations in HomeKit app. |
+| `atwDevices[].temperatureReturnSensor` | This enable extra `Return` temperature sensor to use with automations in HomeKit app. |
+| `atwDevices[].temperatureFlowZone1Sensor` | This enable extra `Flow Zone 1` temperature sensor to use with automations in HomeKit app. |
+| `atwDevices[].temperatureReturnZone1Sensor` | This enable extra `Return Zone 1` temperature sensor to use with automations in HomeKit app. |
+| `atwDevices[].temperatureFlowWaterTankSensor` | This enable extra `Flow Water Tank` temperature sensor to use with automations in HomeKit app. |
+| `atwDevices[].temperatureReturnWaterTankSensor` | This enable extra `Return Water Tank` temperature sensor to use with automations in HomeKit app. |
+| `atwDevices[].temperatureFlowZone2Sensor` | This enable extra `Flow Zone 2` temperature sensor to use with automations in HomeKit app. |
+| `atwDevices[].temperatureReturnZone2Sensor` | This enable extra `Return Zone 2` temperature sensor to use with automations in HomeKit app. |
 | `atwDevices[].errorSensor` | This enable `Error` sensors to use with automations in HomeKit app. |
 | `atwDevices[].refreshInterval` | Here set the background devices state refresh time in (sec), default `5s`. |
 | `atwDevices[].presets[]` | Array of ATA device Presets created automatically after login to MELCloud from plugin config UI. |
@@ -272,9 +274,9 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
 | `ervDevices[].typeString` | Read only data, do not change it. |
 | `ervDevices[].name` | Here You can schange the `Accessory Name` which is exposed to the `Homebridge/HomeKit`. |
 | `ervDevices[].displayType` | Here select main control mode `None/Disabled`, `Heater/Cooler`, `Thermostat`. |
-| `ervDevices[].temperatureSensor` | This enable extra `Room` temperature sensors to use with automations in HomeKit app. |
-| `ervDevices[].temperatureOutdoorSensor` | This enable extra `Outdoor` temperature sensors to use with automations in HomeKit app. |
-| `ervDevices[].temperatureSupplySensor` | This enable extra `Supply` temperature sensors to use with automations in HomeKit app. |
+| `ervDevices[].temperatureSensor` | This enable extra `Room` temperature sensor to use with automations in HomeKit app. |
+| `ervDevices[].temperatureOutdoorSensor` | This enable extra `Outdoor` temperature sensor to use with automations in HomeKit app. |
+| `ervDevices[].temperatureSupplySensor` | This enable extra `Supply` temperature sensor to use with automations in HomeKit app. |
 | `ervDevices[].errorSensor` | This enable `Error` sensors to use with automations in HomeKit app. |
 | `ervDevices[].refreshInterval` | Here set the background devices state refresh time in (sec), default `5s`. |
 | `ervDevices[].presets[]` | Array of ATA device Presets created automatically after login to MELCloud from plugin config UI. |

package/config.schema.json

@@ -413,6 +413,12 @@
                     "default": false,
                     "description": "This enable extra holiday mode sensor to use with automations in HomeKit app."
                   },
+                  "sheduleSensor": {
+                    "title": "Shedule",
+                    "type": "boolean",
+                    "default": false,
+                    "description": "This enable extra shedule sensor to use with automations in HomeKit app."
+                  },
                   "errorSensor": {
                     "title": "Error",
                     "type": "boolean",
@@ -1958,6 +1964,7 @@
                                 "accounts[].ataDevices[].frostProtectionSensor",
                                 "accounts[].ataDevices[].overheatProtectionSensor",
                                 "accounts[].ataDevices[].holidayModeSensor",
+                                "accounts[].ataDevices[].sheduleSensor",
                                 "accounts[].ataDevices[].errorSensor"
                               ]
                             },

package/package.json

@@ -1,7 +1,7 @@
 {
   "displayName": "MELCloud Control",
   "name": "homebridge-melcloud-control",
-  "version": "4.1.0",
+  "version": "4.1.1-beta.1",
   "description": "Homebridge plugin to control Mitsubishi Air Conditioner, Heat Pump and Energy Recovery Ventilation.",
   "license": "MIT",
   "author": "grzegorz914",

package/src/deviceata.js

@@ -32,6 +32,7 @@ class DeviceAta extends EventEmitter {
         this.frostProtectionSensor = device.frostProtectionSensor || false;
         this.overheatProtectionSensor = device.overheatProtectionSensor || false;
         this.holidayModeSensor = device.holidayModeSensor || false;
+        this.sheduleSensor = device.sheduleSensor || false;
         this.errorSensor = device.errorSensor || false;
         this.heatDryFanMode = device.heatDryFanMode || 1; //NONE, HEAT, DRY, FAN
         this.coolDryFanMode = device.coolDryFanMode || 1; //NONE, COOL, DRY, FAN
@@ -650,6 +651,20 @@ class DeviceAta extends EventEmitter {
                 accessory.addService(this.holidayModeSensorService);
             }
 
+            //shedule sensor
+            if (this.sheduleSensor && this.accessory.sheduleEnabled !== null) {
+                if (this.logDebug) this.emit('debug', `Prepare shedule service`);
+                this.sheduleSensorService = new Service.ContactSensor(`${serviceName} Shedule`, `Shedule Sensor ${deviceId}`);
+                this.sheduleSensorService.addOptionalCharacteristic(Characteristic.ConfiguredName);
+                this.sheduleSensorService.setCharacteristic(Characteristic.ConfiguredName, `${accessoryName} Shedule`);
+                this.sheduleSensorService.getCharacteristic(Characteristic.ContactSensorState)
+                    .onGet(async () => {
+                        const state = this.accessory.sheduleEnabled;
+                        return state;
+                    })
+                accessory.addService(this.sheduleSensorService);
+            }
+
             //error sensor
             if (this.errorSensor && this.accessory.isInError !== null) {
                 if (this.logDebug) this.emit('debug', `Prepare error service`);
@@ -1021,6 +1036,7 @@ class DeviceAta extends EventEmitter {
                     const overheatProtectionActive = deviceData.OverheatProtection?.active;
                     const holidayModeEnabled = deviceData.HolidayMode?.enabled;
                     const holidayModeActive = deviceData.HolidayMode?.active;
+                    const sheduleEnabled = deviceData.ScheduleEnabled;
 
                     //device control
                     const hideVaneControls = deviceData.HideVaneControls ?? false;
@@ -1112,7 +1128,8 @@ class DeviceAta extends EventEmitter {
                         overheatProtectionEnabled: overheatProtectionEnabled,
                         overheatProtectionActive: overheatProtectionActive,
                         holidayModeEnabled: holidayModeEnabled,
-                        holidayModeActive: holidayModeActive
+                        holidayModeActive: holidayModeActive,
+                        sheduleEnabled: sheduleEnabled
                     };
 
                     //operating mode 0, HEAT, DRY, COOL, 4, 5, 6, FAN, AUTO, ISEE HEAT, ISEE DRY, ISEE COOL
@@ -1257,6 +1274,7 @@ class DeviceAta extends EventEmitter {
                     this.frostProtectionSensorService?.updateCharacteristic(Characteristic.ContactSensorState, frostProtectionActive);
                     this.overheatProtectionSensorService?.updateCharacteristic(Characteristic.ContactSensorState, overheatProtectionActive);
                     this.holidayModeSensorService?.updateCharacteristic(Characteristic.ContactSensorState, holidayModeActive);
+                    this.sheduleSensorService?.updateCharacteristic(Characteristic.ContactSensorState, sheduleEnabled);
                     this.errorService?.updateCharacteristic(Characteristic.ContactSensorState, isInError);
 
                     //update presets state

package/src/melcloudata.js

@@ -20,7 +20,7 @@ class MelCloudAta extends EventEmitter {
             .on('debug', debug => this.emit('debug', debug));
 
         //set default values
-        this.deviceState = {};
+        this.deviceData = {};
         this.headers = {};
 
         //lock flags
@@ -87,6 +87,7 @@ class MelCloudAta extends EventEmitter {
             const frostProtection = deviceData.FrostProtection;
             const overheatProtection = deviceData.OverheatProtection;
             const holidayMode = deviceData.HolidayMode;
+            const sheduleEnabled = deviceData.ScheduleEnabled;
 
             //device
             const device = deviceData.Device ?? {};
@@ -135,34 +136,6 @@ class MelCloudAta extends EventEmitter {
                 if (this.logDebug) this.emit('debug', `Units are not configured in MELCloud service`);
             };
 
-            const deviceState = {
-                HideVaneControls: hideVaneControls,
-                HideDryModeControl: hideDryModeControl,
-                FrostProtection: frostProtection,
-                OverheatProtection: overheatProtection,
-                HolidayMode: holidayMode,
-                Power: power,
-                InStandbyMode: inStandbyMode,
-                OperationMode: operationMode,
-                RoomTemperature: roomTemperature,
-                OutdoorTemperature: outdoorTemperature,
-                SetTemperature: setTemperature,
-                ActualFanSpeed: actualFanSpeed,
-                SetFanSpeed: setFanSpeed,
-                AutomaticFanSpeed: automaticFanSpeed,
-                VaneVerticalDirection: vaneVerticalDirection,
-                VaneVerticalSwing: vaneVerticalSwing,
-                VaneHorizontalDirection: vaneHorizontalDirection,
-                VaneHorizontalSwing: vaneHorizontalSwing,
-                TemperatureIncrement: temperatureIncrement,
-                DefaultCoolingSetTemperature: defaultCoolingSetTemperature,
-                DefaultHeatingSetTemperature: defaultHeatingSetTemperature,
-                ProhibitPower: prohibitPower,
-                ProhibitSetTemperature: prohibitSetTemperature,
-                ProhibitOperationMode: prohibitOperationMode,
-                IsInError: isInError
-            }
-
             //restFul
             this.emit('restFul', 'info', deviceData);
             this.emit('restFul', 'state', deviceData.Device);
@@ -172,12 +145,12 @@ class MelCloudAta extends EventEmitter {
             this.emit('mqtt', 'State', deviceData.Device);
 
             //check state changes
-            const deviceDataHasNotChanged = JSON.stringify(deviceState) === JSON.stringify(this.deviceState);
+            const deviceDataHasNotChanged = JSON.stringify(deviceData) === JSON.stringify(this.deviceData);
             if (deviceDataHasNotChanged) {
                 if (this.logDebug) this.emit('debug', `Device state not changed`);
                 return;
             }
-            this.deviceState = deviceState;
+            this.deviceData = deviceData;
 
             //emit info
             this.emit('deviceInfo', manufacturer, indoor.model, outdoor.model, serialNumber, firmwareAppVersion);