homebridge-melcloud-control 3.1.2-beta.9 → 3.1.3-beta.0

package/CHANGELOG.md

@@ -12,15 +12,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - v1 After update to v1 and above from v0 the devices need to be added to the Home app again and the old unresponsive remove!!! This devices will be removed from all automations and scenes!!!
 - v2 After update to v2 from v1 only RESTFull and MQTT config settings need to be updated in config.
   - v2.4 and above require upcomming homebridge v2
-- v3 After update to v3 from previous versions the plugin need to be configured using Config UI X.
+- v3 After update to v3 the plugin need to be configured using Config UI X.
   - do not configure it manually, always using Config UI X
+  - required Homebridge v2.0.0 and above
+
+## [3.1.2] - (31.08.2024)
+
+## Changes
+
+- fix presets configured array
 
 ## [3.1.0] - (31.08.2024)
 
 ## Changes
 
 - improvements in plugin config UI
-- added possibility indyvidual presets control
+- added presets config indyvidually
 - config schema update
 - bump dependencies
 - cleanup  
@@ -39,7 +46,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - added homebridge UI server
 - whole new concept get all devices from melcloud usin config UI X
-- added individual configuration of every device
+- added device config indyvidually
 - config schema updated
 - cleanup
 

package/README.md

@@ -21,8 +21,8 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
 
 | Package | Installation | Role | Required |
 | --- | --- | --- | --- |
-| [Homebridge](https://github.com/homebridge/homebridge) | [Homebridge Wiki](https://github.com/homebridge/homebridge/wiki) | HomeKit Bridge | Required |
-| [Config UI X](https://github.com/homebridge/homebridge-config-ui-x) | [Config UI X Wiki](https://github.com/homebridge/homebridge-config-ui-x/wiki) | Homebridge Web User Interface | Recommended |
+| [Homebridge v2.0](https://github.com/homebridge/homebridge) | [Homebridge Wiki](https://github.com/homebridge/homebridge/wiki) | HomeKit Bridge | Required ab v3.0.0 |
+| [Config UI X](https://github.com/homebridge/homebridge-config-ui-x) | [Config UI X Wiki](https://github.com/homebridge/homebridge-config-ui-x/wiki) | Homebridge Web User Interface | Required ab v3.0.0|
 | [MELCloud](https://github.com/grzegorz914/homebridge-melcloud-control) | [Plug-In Wiki](https://github.com/grzegorz914/homebridge-melcloud-control/wiki) | Homebridge Plug-In | Required |
 
 ### About The Plugin
@@ -161,7 +161,7 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
 ### Configuration
 
 * Run this plugin as a [Child Bridge](https://github.com/homebridge/homebridge/wiki/Child-Bridges) (Highly Recommended), this prevent crash Homebridge if plugin crashes.
-* Install and use [Homebridge Config UI X](https://github.com/homebridge/homebridge-config-ui-x/wiki) to configure this plugin (Highly Recommended).
+* Install and use [Homebridge Config UI X](https://github.com/homebridge/homebridge-config-ui-x/wiki) to configure this plugin, required for version v3 and above.
 * The `sample-config.json` can be edited and used as an alternative.
 
 <p align="center">

package/config.schema.json

@@ -1719,7 +1719,7 @@
                         {
                           "key": "accounts[].ataDevices[].presets",
                           "type": "tabarray",
-                          "title": "{{ value.name  || ''}}",
+                          "title": "{{ value.name }}",
                           "items": [
                             {
                               "key": "accounts[].ataDevices[].presets[].id",

package/homebridge-ui/public/index.html

@@ -187,7 +187,7 @@
             };
 
             //get device info fom devices ata
-            devicesByType.ata.forEach((device, index) => {
+            devicesByType.ata.forEach(async (device, index) => {
               const deviceId = device.DeviceID;
               const deviceType = device.Type;
               const deviceTypeText = "Air Conditioner";
@@ -212,6 +212,7 @@
 
               const ataDevicesExist = pluginConfig[0].accounts[this.deviceIndex].ataDevices ?? false;
               const ataDevices = ataDevicesExist ? pluginConfig[0].accounts[this.deviceIndex].ataDevices : pluginConfig[0].accounts[this.deviceIndex].ataDevices = [];
+
               const ataDeviceIdExist = ataDevices.some(device => device.id === deviceId);
               const pushTypeAta = ataDeviceIdExist ? false : ataDevices.push(deviceAta);
               const pushNewDevice = ataDeviceIdExist ? false : newDevices.ata.push(device);
@@ -236,10 +237,15 @@
                 const presetsCount = newDevices.ataPresets.length;
                 textAtaPresets = `ATA Presets: ${presetsCount}`
               };
+
+              //compare presets
+              const presetsOnMelCloud = devicePresets;
+              const presetsAtaInConfig = pluginConfig[0].accounts[this.deviceIndex].ataDevices[index].presets;
+              presetsAtaInConfig = syncArrays(presetsOnMelCloud, presetsAtaInConfig);
             });
 
             //get device info fom devices atw
-            devicesByType.atw.forEach((device, index) => {
+            devicesByType.atw.forEach(async (device, index) => {
               const deviceId = device.DeviceID;
               const deviceType = device.Type;
               const deviceTypeText = "Heat Pump";
@@ -293,10 +299,14 @@
                 const presetsCount = newDevices.atwPresets.length;
                 textAtwPresets = `ATW Presets: ${presetsCount}`
               };
+
+              const presetsOnMelCloud = devicePresets;
+              const presetsAtwInConfig = pluginConfig[0].accounts[this.deviceIndex].atwDevices[index].presets;
+              presetsAtwInConfig = syncArrays(presetsOnMelCloud, presetsAtwInConfig);
             });
 
             //get device info fom devices erv
-            devicesByType.erv.forEach((device, index) => {
+            devicesByType.erv.forEach(async (device, index) => {
               const deviceId = device.DeviceID;
               const deviceType = device.Type;
               const deviceTypeText = "Energy Recovery Ventilation";
@@ -344,8 +354,23 @@
                 const presetsCount = newDevices.ervPresets.length;
                 textErvPresets = `ERV Presets: ${presetsCount}`
               };
+
+              const presetsOnMelCloud = devicePresets;
+              const presetsErvInConfig = pluginConfig[0].accounts[this.deviceIndex].ervDevices[index].presets;
+              presetsErvInConfig = await syncArrays(presetsOnMelCloud, presetsErvInConfig);
             });
 
+            //compare arrays and update array in config
+            const devicesOnMelCloud = devices;
+            const devicesAtaInConfig = pluginConfig[0].accounts[this.deviceIndex].ataDevices;
+            devicesAtaInConfig = await syncArrays(devicesOnMelCloud, devicesAtaInConfig);
+
+            const devicesAtwInConfig = pluginConfig[0].accounts[this.deviceIndex].atwDevices;
+            devicesAtwInConfig = await syncArrays(devicesOnMelCloud, devicesAtwInConfig);
+
+            const devicesErvInConfig = pluginConfig[0].accounts[this.deviceIndex].ervDevices;
+            devicesErvInConfig = await syncArrays(devicesOnMelCloud, devicesErvInConfig);
+
             const newDevicesCount = newDevices.ata.length + newDevices.atw.length + newDevices.erv.length ?? 0;
             const newPresetsCount = newDevices.ataPresets.length + newDevices.atwPresets.length + newDevices.ervPresets.length ?? 0;
             if (newDevicesCount === 0 && newPresetsCount === 0) {
@@ -389,6 +414,23 @@
             break;
         };
 
+        async function syncArrays(devicesOnMelCloud, devicesInConfig) {
+          // Create a Set of IDs from devicesOnMelCloud for quick lookup
+          const devicesOnMelCloudId = new Set(devicesOnMelCloud.map(device => device.DeviceID));
+
+          // Filter devicesInConfig to keep only objects that exist in devicesOnMelCloud
+          devicesInConfig = devicesInConfig.filter(device => devicesOnMelCloudId.has(device.DeviceID));
+
+          // Add objects from devicesOnMelCloud to devicesInConfig that do not exist in devicesInConfig
+          devicesOnMelCloud.forEach(device => {
+            if (!devicesInConfig.some(item => item.id === device.id)) {
+              devicesInConfig.push(device);
+            }
+          });
+
+          return devicesInConfig;
+        }
+
         homebridge.hideSpinner();
       } catch (e) {
         document.getElementById('info').innerHTML = 'Please try again.';

package/index.js

@@ -105,7 +105,9 @@ class MelCloudPlatform {
 
 					//Air Conditioner
 					for (const device of account.ataDevices) {
-						if (!device.id || device.displayMode === 0) {
+						//chack device from config exist on melcloud
+						const deviceExistInMelCloud = devices.some(dev => dev.DeviceID === device.id);
+						if (!deviceExistInMelCloud || device.displayMode === 0) {
 							continue;
 						};
 
@@ -142,7 +144,9 @@ class MelCloudPlatform {
 
 					//Heat Pump
 					for (const device of account.atwDevices) {
-						if (!device.id || device.displayMode === 0) {
+						//chack device from config exist on melcloud
+						const deviceExistInMelCloud = devices.some(dev => dev.DeviceID === device.id);
+						if (!deviceExistInMelCloud || device.displayMode === 0) {
 							continue;
 						};
 
@@ -180,7 +184,9 @@ class MelCloudPlatform {
 
 					//Energy Recovery Ventilation
 					for (const device of account.ervDevices) {
-						if (!device.id || device.displayMode === 0) {
+						//chack device from config exist on melcloud
+						const deviceExistInMelCloud = devices.some(dev => dev.DeviceID === device.id);
+						if (!deviceExistInMelCloud || device.displayMode === 0) {
 							continue;
 						};
 

package/package.json

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

package/src/deviceata.js

@@ -20,7 +20,6 @@ class DeviceAta extends EventEmitter {
         this.displayMode = device.displayMode;
         this.temperatureSensor = device.temperatureSensor || false;
         this.temperatureSensorOutdoor = device.temperatureSensorOutdoor || false;
-        this.presetsEnabled = device.presets || false;
         this.heatDryFanMode = device.heatDryFanMode || 1; //NONE, HEAT, DRY, FAN
         this.coolDryFanMode = device.coolDryFanMode || 1; //NONE, COOL, DRY, FAN
         this.autoDryFanMode = device.autoDryFanMode || 1; //NONE, AUTO, DRY, FAN
@@ -46,13 +45,13 @@ class DeviceAta extends EventEmitter {
             const presetDisplayType = preset.displayType ?? 0;
             const presetNamePrefix = preset.namePrefix ?? false;
             if (presetName && presetDisplayType > 0) {
-                const buttonServiceType = ['', Service.Outlet, Service.Switch, Service.MotionSensor, Service.OccupancySensor, Service.ContactSensor][presetDisplayType];
-                const buttonCharacteristicType = ['', Characteristic.On, Characteristic.On, Characteristic.MotionDetected, Characteristic.OccupancyDetected, Characteristic.ContactSensorState][presetDisplayType];
+                const presetyServiceType = ['', Service.Outlet, Service.Switch, Service.MotionSensor, Service.OccupancySensor, Service.ContactSensor][presetDisplayType];
+                const presetCharacteristicType = ['', Characteristic.On, Characteristic.On, Characteristic.MotionDetected, Characteristic.OccupancyDetected, Characteristic.ContactSensorState][presetDisplayType];
                 preset.namePrefix = presetNamePrefix;
-                preset.serviceType = buttonServiceType;
-                preset.characteristicType = buttonCharacteristicType;
+                preset.serviceType = presetyServiceType;
+                preset.characteristicType = presetCharacteristicType;
                 preset.state = false;
-                this.buttonsConfigured.push(preset);
+                this.presetsConfigured.push(preset);
             } else {
                 const log = presetDisplayType === 0 ? false : this.emit('message', `Preset Name: ${preset ? preset : 'Missing'}.`);
             };

package/src/deviceatw.js

@@ -42,25 +42,25 @@ class DeviceAtw extends EventEmitter {
         //function
         this.melCloud = melCloud; //function
 
-        //presets configured
-        this.presetsConfigured = [];
-        for (const preset of this.presets) {
-            const presetName = preset.name ?? false;
-            const presetDisplayType = preset.displayType ?? 0;
-            const presetNamePrefix = preset.namePrefix ?? false;
-            if (presetName && presetDisplayType > 0) {
-                const buttonServiceType = ['', Service.Outlet, Service.Switch, Service.MotionSensor, Service.OccupancySensor, Service.ContactSensor][presetDisplayType];
-                const buttonCharacteristicType = ['', Characteristic.On, Characteristic.On, Characteristic.MotionDetected, Characteristic.OccupancyDetected, Characteristic.ContactSensorState][presetDisplayType];
-                preset.namePrefix = presetNamePrefix;
-                preset.serviceType = buttonServiceType;
-                preset.characteristicType = buttonCharacteristicType;
-                preset.state = false;
-                this.buttonsConfigured.push(preset);
-            } else {
-                const log = presetDisplayType === 0 ? false : this.emit('message', `Preset Name: ${preset ? preset : 'Missing'}.`);
-            };
-        }
-        this.presetsConfiguredCount = this.presetsConfigured.length || 0;
+         //presets configured
+         this.presetsConfigured = [];
+         for (const preset of this.presets) {
+             const presetName = preset.name ?? false;
+             const presetDisplayType = preset.displayType ?? 0;
+             const presetNamePrefix = preset.namePrefix ?? false;
+             if (presetName && presetDisplayType > 0) {
+                 const presetyServiceType = ['', Service.Outlet, Service.Switch, Service.MotionSensor, Service.OccupancySensor, Service.ContactSensor][presetDisplayType];
+                 const presetCharacteristicType = ['', Characteristic.On, Characteristic.On, Characteristic.MotionDetected, Characteristic.OccupancyDetected, Characteristic.ContactSensorState][presetDisplayType];
+                 preset.namePrefix = presetNamePrefix;
+                 preset.serviceType = presetyServiceType;
+                 preset.characteristicType = presetCharacteristicType;
+                 preset.state = false;
+                 this.presetsConfigured.push(preset);
+             } else {
+                 const log = presetDisplayType === 0 ? false : this.emit('message', `Preset Name: ${preset ? preset : 'Missing'}.`);
+             };
+         }
+         this.presetsConfiguredCount = this.presetsConfigured.length || 0;
 
         //buttons configured
         this.buttonsConfigured = [];

package/src/deviceerv.js

@@ -43,13 +43,13 @@ class DeviceErv extends EventEmitter {
             const presetDisplayType = preset.displayType ?? 0;
             const presetNamePrefix = preset.namePrefix ?? false;
             if (presetName && presetDisplayType > 0) {
-                const buttonServiceType = ['', Service.Outlet, Service.Switch, Service.MotionSensor, Service.OccupancySensor, Service.ContactSensor][presetDisplayType];
-                const buttonCharacteristicType = ['', Characteristic.On, Characteristic.On, Characteristic.MotionDetected, Characteristic.OccupancyDetected, Characteristic.ContactSensorState][presetDisplayType];
+                const presetyServiceType = ['', Service.Outlet, Service.Switch, Service.MotionSensor, Service.OccupancySensor, Service.ContactSensor][presetDisplayType];
+                const presetCharacteristicType = ['', Characteristic.On, Characteristic.On, Characteristic.MotionDetected, Characteristic.OccupancyDetected, Characteristic.ContactSensorState][presetDisplayType];
                 preset.namePrefix = presetNamePrefix;
-                preset.serviceType = buttonServiceType;
-                preset.characteristicType = buttonCharacteristicType;
+                preset.serviceType = presetyServiceType;
+                preset.characteristicType = presetCharacteristicType;
                 preset.state = false;
-                this.buttonsConfigured.push(preset);
+                this.presetsConfigured.push(preset);
             } else {
                 const log = presetDisplayType === 0 ? false : this.emit('message', `Preset Name: ${preset ? preset : 'Missing'}.`);
             };