homebridge-melcloud-control 3.8.0-beta.8 → 3.8.0

package/CHANGELOG.md

@@ -16,15 +16,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - do not configure it manually, always using Config UI X
   - required Homebridge v2.0.0 and above
 
-## [3.8.0] - (01.05.2025)
+## [3.8.0] - (05.05.2025)
 
 ## Changes
 
-- add possibility to hide individual zone/hot water tank accessory in Home app, solved[#194](https://github.com/grzegorz914/homebridge-melcloud-control/issues/194)
+- add possibility to hide individual zone accessory in Home app for ATW device, solved[#194](https://github.com/grzegorz914/homebridge-melcloud-control/issues/194)
+- publish sensors independent from hiden zones for ATW devices
+- stability and performance improvements
 - bump dependencies
 - config schema updated
 - redme updated
-- other small fixes
 - cleanup
 
 ## [3.7.5] - (25.03.2025)
@@ -33,12 +34,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - fix[#192](https://github.com/grzegorz914/homebridge-melcloud-control/issues/192), thanks @helloabunai
 
-
 ## [3.7.3] - (15.03.2025)
 
 ## Changes
 
-- updated Homebridge UI interface 
+- updated Homebridge UI interface
 
 ## [3.7.1] - (14.03.2025)
 
@@ -54,7 +54,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - bump dependencies
 - config schema updated
 - redme updated
-- cleanup 
+- cleanup
 
 ## [3.6.9] - (28.02.2025)
 

package/README.md

@@ -234,7 +234,7 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
 | `atwDevices.typeString` | Read only data, do not change it. |
 | `atwDevices.name` | Here You can schange the `Accessory Name` which is exposed to the `Homebridge/HomeKit`. |
 | `atwDevices.displayMode` | Here select main control mode `None/Disabled`, `Heater/Cooler`, `Thermostat`. |
-| `atwDevices.hideZone` | Here select which zone need to be hidden `None/Disabled`, `Zone 1`, `Zone 2`, `Zone 1/2`, `Hot Water`, `Zone 1/Hot Water`, `Zone 2/Hot Water`, `Zone 1/2/Hot Water`. |
+| `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.temperatureSensorFlow` | This enable extra `Flow` temperature sensors to use with automations in HomeKit app. |
 | `atwDevices.temperatureSensorReturn` | This enable extra `Return` temperature sensors to use with automations in HomeKit app. |

package/config.schema.json

@@ -264,7 +264,7 @@
                         ]
                       }
                     ],
-                    "description": "Select device control mode displayed in HomeKit app.",
+                    "description": "Select accessory control type displayed in HomeKit app.",
                     "required": true
                   },
                   "heatDryFanMode": {
@@ -826,14 +826,14 @@
                         ]
                       }
                     ],
-                    "description": "Select device control mode displayed in HomeKit app.",
+                    "description": "Select accessory control type displayed in HomeKit app.",
                     "required": true
                   },
                   "hideZone": {
                     "title": "Hide zone",
                     "type": "integer",
                     "minimum": 0,
-                    "maximum": 7,
+                    "maximum": 15,
                     "default": 0,
                     "oneOf": [
                       {
@@ -843,49 +843,97 @@
                         ]
                       },
                       {
-                        "title": "Zone 1",
+                        "title": "Heat Pump",
                         "enum": [
                           1
                         ]
                       },
                       {
-                        "title": "Zone 2",
+                        "title": "Heat Pump / Zone 1",
                         "enum": [
                           2
                         ]
                       },
                       {
-                        "title": "Zone 1/2",
+                        "title": "Heat Pump / Zone 1 / Hot Water",
                         "enum": [
                           3
                         ]
                       },
                       {
-                        "title": "Hot Water",
+                        "title": "Heat Pump / Zone 1 / Zone 2",
                         "enum": [
                           4
                         ]
                       },
                       {
-                        "title": "Zone 1/Hot Water",
+                        "title": "Heat Pump / Hot Water",
                         "enum": [
                           5
                         ]
                       },
                       {
-                        "title": "Zone 2/Hot Water",
+                        "title": "Heat Pump / Hot Water / Zone 2",
                         "enum": [
                           6
                         ]
                       },
                       {
-                        "title": "Zone 1/2/Hot Water",
+                        "title": "Heat Pump / Zone 2",
                         "enum": [
                           7
                         ]
+                      },
+                      {
+                        "title": "Zone 1",
+                        "enum": [
+                          8
+                        ]
+                      },
+                      {
+                        "title": "Zone 1 / Hot Water",
+                        "enum": [
+                          9
+                        ]
+                      },
+                      {
+                        "title": "Zone 1 / Hot Water / Zone 2",
+                        "enum": [
+                          10
+                        ]
+                      },
+                      {
+                        "title": "Zone 1 / Zone 2",
+                        "enum": [
+                          11
+                        ]
+                      },
+                      {
+                        "title": "Hot Water",
+                        "enum": [
+                          12
+                        ]
+                      },
+                      {
+                        "title": "Hot Water / Zone 2",
+                        "enum": [
+                          13
+                        ]
+                      },
+                      {
+                        "title": "Zone 2",
+                        "enum": [
+                          14
+                        ]
+                      },
+                      {
+                        "title": "All",
+                        "enum": [
+                          15
+                        ]
                       }
                     ],
-                    "description": "Select which zone need to be hidden in HomeKit app, if present.",
+                    "description": "Select zone to hidde in HomeKit app, if present.",
                     "required": true
                   },
                   "temperatureSensor": {
@@ -1313,7 +1361,7 @@
                         ]
                       }
                     ],
-                    "description": "Select device control mode displayed in HomeKit app.",
+                    "description": "Select accessory control type displayed in HomeKit app.",
                     "required": true
                   },
                   "temperatureSensor": {
@@ -1867,7 +1915,7 @@
                     }
                   ],
                   "condition": {
-                    "functionBody": "return model.accounts[arrayIndices].ataDevices.length >= 1;"
+                    "functionBody": "return model.accounts[arrayIndices].ataDevices.length > 0;"
                   }
                 },
                 {
@@ -1876,7 +1924,7 @@
                   "title": "{{ value.title }}",
                   "items": [],
                   "condition": {
-                    "functionBody": "return model.accounts[arrayIndices].ataDevices.length < 1;"
+                    "functionBody": "return model.accounts[arrayIndices].ataDevices.length === 0;"
                   }
                 }
               ]
@@ -1899,6 +1947,7 @@
                       "readonly": true
                     },
                     "accounts[].atwDevices[].displayMode",
+                    "accounts[].atwDevices[].hideZone",
                     {
                       "key": "accounts[].atwDevices[]",
                       "type": "section",
@@ -1907,7 +1956,6 @@
                       "expanded": false,
                       "items": [
                         "accounts[].atwDevices[].name",
-                        "accounts[].atwDevices[].hideZone",
                         "accounts[].atwDevices[].refreshInterval"
                       ]
                     },
@@ -1974,7 +2022,7 @@
                     }
                   ],
                   "condition": {
-                    "functionBody": "return model.accounts[arrayIndices].atwDevices.length >= 1;"
+                    "functionBody": "return model.accounts[arrayIndices].atwDevices.length > 0;"
                   }
                 },
                 {
@@ -1983,7 +2031,7 @@
                   "title": "{{ value.title }}",
                   "items": [],
                   "condition": {
-                    "functionBody": "return model.accounts[arrayIndices].atwDevices.length < 1;"
+                    "functionBody": "return model.accounts[arrayIndices].atwDevices.length === 0;"
                   }
                 }
               ]
@@ -2074,7 +2122,7 @@
                     }
                   ],
                   "condition": {
-                    "functionBody": "return model.accounts[arrayIndices].ervDevices.length >= 1;"
+                    "functionBody": "return model.accounts[arrayIndices].ervDevices.length > 0;"
                   }
                 },
                 {
@@ -2083,7 +2131,7 @@
                   "title": "{{ value.title }}",
                   "items": [],
                   "condition": {
-                    "functionBody": "return model.accounts[arrayIndices].ervDevices.length < 1;"
+                    "functionBody": "return model.accounts[arrayIndices].ervDevices.length === 0;"
                   }
                 }
               ]

package/index.js

@@ -247,7 +247,7 @@ class MelCloudPlatform {
 							await impulseGenerator.start([{ name: 'start', sampling: 45000 }]);
 						};
 					} catch (error) {
-						const emitLog = disableLogError ? false : log.error(`${accountName}, ATE did finish launching error: ${error}.`);
+						const emitLog = disableLogError ? false : log.error(`${accountName}, ATW did finish launching error: ${error}.`);
 					}
 
 					//Energy Recovery Ventilation 3

package/package.json

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

package/src/deviceata.js

@@ -77,7 +77,6 @@ class DeviceAta extends EventEmitter {
             const buttonServiceType = ['', Service.Outlet, Service.Switch, Service.MotionSensor, Service.OccupancySensor, Service.ContactSensor][displayType];
             const buttonCharacteristicType = ['', Characteristic.On, Characteristic.On, Characteristic.MotionDetected, Characteristic.OccupancyDetected, Characteristic.ContactSensorState][displayType];
             button.name = button.name || 'Button'
-            button.namePrefix = buttonNamePrefix;
             button.serviceType = buttonServiceType;
             button.characteristicType = buttonCharacteristicType;
             button.state = false;
@@ -249,6 +248,7 @@ class DeviceAta extends EventEmitter {
     async startImpulseGenerator() {
         try {
             //start impule generator
+            await new Promise(resolve => setTimeout(resolve, 1000));
             await this.melCloudAta.impulseGenerator.start([{ name: 'checkState', sampling: this.refreshInterval }]);
             return true;
         } catch (error) {
@@ -628,18 +628,16 @@ class DeviceAta extends EventEmitter {
             if (this.presetsConfiguredCount > 0) {
                 const debug = this.enableDebugMode ? this.emit('debug', `Prepare presets services`) : false;
                 this.presetsServices = [];
-
-                for (let i = 0; i < this.presetsConfiguredCount; i++) {
-                    const preset = this.presetsConfigured[i];
+                this.presetsConfigured.forEach((preset, i) => {
                     const presetData = presetsOnServer.find(p => p.ID === preset.Id);
 
                     //get preset name
-                    const presetName = preset.name;
+                    const name = preset.name;
 
                     //get preset name prefix
-                    const presetNamePrefix = preset.namePrefix;
+                    const namePrefix = preset.namePrefix;
 
-                    const serviceName = presetNamePrefix ? `${accessoryName} ${presetName}` : presetName;
+                    const serviceName = namePrefix ? `${accessoryName} ${name}` : name;
                     const serviceType = preset.serviceType;
                     const characteristicType = preset.characteristicType;
                     const presetService = new serviceType(serviceName, `Preset ${deviceId} ${i}`);
@@ -675,34 +673,31 @@ class DeviceAta extends EventEmitter {
                                 };
 
                                 await this.melCloudAta.send(deviceData, this.displayMode);
-                                const info = this.disableLogInfo ? false : this.emit('message', `${state ? 'Set:' : 'Unset:'} ${presetName}`);
+                                const info = this.disableLogInfo ? false : this.emit('message', `${state ? 'Set:' : 'Unset:'} ${name}`);
                             } catch (error) {
                                 this.emit('warn', `Set preset error: ${error}`);
                             };
                         });
                     this.presetsServices.push(presetService);
                     accessory.addService(presetService);
-                };
+                });
             };
 
             //buttons services
             if (this.buttonsConfiguredCount > 0) {
                 const debug = this.enableDebugMode ? this.emit('debug', `Prepare buttons/sensors services`) : false;
                 this.buttonsServices = [];
-
-                for (let i = 0; i < this.buttonsConfiguredCount; i++) {
-                    const button = this.buttonsConfigured[i];
-
+                this.buttonsConfigured.forEach((button, i) => {
                     //get button mode
                     const mode = button.mode;
 
                     //get button name
-                    const buttonName = button.name;
+                    const name = button.name;
 
                     //get button name prefix
-                    const buttonNamePrefix = button.namePrefix;
+                    const namePrefix = button.namePrefix;
 
-                    const serviceName = buttonNamePrefix ? `${accessoryName} ${buttonName}` : buttonName;
+                    const serviceName = namePrefix ? `${accessoryName} ${name}` : name;
                     const serviceType = button.serviceType;
                     const characteristicType = button.characteristicType;
                     const buttonService = new serviceType(serviceName, `Button ${deviceId} ${i}`);
@@ -918,14 +913,14 @@ class DeviceAta extends EventEmitter {
                                 };
 
                                 await this.melCloudAta.send(deviceData, this.displayMode);
-                                const info = this.disableLogInfo ? false : this.emit('message', `${state ? `Set: ${buttonName}` : `Unset: ${buttonName}, Set: ${button.previousValue}`}`);
+                                const info = this.disableLogInfo ? false : this.emit('message', `${state ? `Set: ${name}` : `Unset: ${name}, Set: ${button.previousValue}`}`);
                             } catch (error) {
                                 this.emit('warn', `Set button error: ${error}`);
                             };
                         });
                     this.buttonsServices.push(buttonService);
                     accessory.addService(buttonService);
-                };
+                });
             };
 
             return accessory;
@@ -971,7 +966,7 @@ class DeviceAta extends EventEmitter {
                     this.firmwareRevision = firmwareAppVersion;
                     this.displayDeviceInfo = false;
                 })
-                .on('deviceState', (deviceData) => {
+                .on('deviceState', async (deviceData) => {
                     this.deviceData = deviceData;
 
                     //presets
@@ -1209,8 +1204,7 @@ class DeviceAta extends EventEmitter {
 
                     //update presets state
                     if (this.presetsConfigured.length > 0) {
-                        for (let i = 0; i < this.presetsConfigured.length; i++) {
-                            const preset = this.presetsConfigured[i];
+                        this.presetsConfigured.forEach((preset, i) => {
                             const presetData = presetsOnServer.find(p => p.ID === preset.Id);
 
                             preset.state = presetData ? (presetData.Power === power
@@ -1225,13 +1219,12 @@ class DeviceAta extends EventEmitter {
                                 this.presetsServices[i]
                                     .updateCharacteristic(characteristicType, preset.state)
                             };
-                        };
+                        });
                     };
 
                     //update buttons state
                     if (this.buttonsConfiguredCount > 0) {
-                        for (let i = 0; i < this.buttonsConfiguredCount; i++) {
-                            const button = this.buttonsConfigured[i];
+                        this.buttonsConfigured.forEach((button, i) => {
                             const mode = button.mode;
                             switch (mode) {
                                 case 0: //POWER ON,OFF
@@ -1350,7 +1343,7 @@ class DeviceAta extends EventEmitter {
                                 this.buttonsServices[i]
                                     .updateCharacteristic(characteristicType, button.state)
                             };
-                        };
+                        });
                     };
 
                     //log current state
@@ -1369,6 +1362,13 @@ class DeviceAta extends EventEmitter {
                         this.emit('message', `Temperature display unit: ${this.accessory.temperatureUnit}`);
                         this.emit('message', `Lock physical controls: ${this.accessory.lockPhysicalControl ? 'LOCKED' : 'UNLOCKED'}`);
                     };
+
+                    //prepare accessory
+                    if (this.startPrepareAccessory) {
+                        const accessory = await this.prepareAccessory(this.accountInfo, deviceData, this.deviceId, this.deviceTypeText, this.deviceName, this.accountName);
+                        this.emit('publishAccessory', accessory);
+                        this.startPrepareAccessory = false;
+                    }
                 })
                 .on('success', (success) => {
                     this.emit('success', success);
@@ -1396,18 +1396,7 @@ class DeviceAta extends EventEmitter {
             const startExternalIntegrations = this.restFul.enable || this.mqtt.enable ? await this.externalIntegrations() : false;
 
             //check state
-            const deviceData = await this.melCloudAta.checkState();
-
-            if (deviceData === false) {
-                return null;
-            }
-
-            //prepare accessory
-            if (this.startPrepareAccessory) {
-                const accessory = await this.prepareAccessory(this.accountInfo, deviceData, this.deviceId, this.deviceTypeText, this.deviceName, this.accountName);
-                this.emit('publishAccessory', accessory);
-                this.startPrepareAccessory = false;
-            }
+            await this.melCloudAta.checkState();
 
             return true;
         } catch (error) {