homebridge-melcloud-control 3.5.2 → 3.6.0

package/CHANGELOG.md

@@ -16,6 +16,17 @@ 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.6.0] - (29.01.2025)
+
+## Changes
+
+- added possibility to disable/enable log success, info, warn, error
+- refactor cnnect code
+- bump dependencies
+- config schema updated
+- redme updated
+- cleanup
+
 ## [3.5.0] - (06.12.2024)
 
 ## Changes

package/README.md

@@ -273,9 +273,12 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
 | `buttonsSensors.displayType` | Here select display type in HomeKit, `0 - None/Disabled`, `1 - Outlet`, `2 - Switch`, `3 - Motion Sensor`, `4 - Occupancy Sensor`, `5 - Contact Sensor`. |
 | `buttonsSensors.namePrefix` | Here enable/disable the accessory name as a prefix for button/sensor name. |
 | `refreshInterval` | Here set the background account data refresh time in (sec), default `120s`. |
-| `enableDebugMode` | This enable deep log in homebridge console. |
-| `disableLogInfo` | This disable display log values and states on every it change. |
-| `disableLogDeviceInfo` | This disable display log device info on plugin start. |
+| `disableLogDeviceInfo` | If enabled, add ability to disable log device info by every connections device to the network. |
+| `disableLogInfo` | If enabled, disable log info, all values and state will not be displayed in Homebridge log console. |
+| `disableLogSuccess` | If enabled, disable logging device success. |
+| `disableLogWarn` | If enabled, disable logging device warnings. |
+| `disableLogError` | If enabled, disable logging device error. |
+| `enableDebugMode` | If enabled, deep log will be present in homebridge console. |
 | `restFul` | This is RSTful server. |
 | `restFul.enable` | If enabled, RESTful server will start automatically and respond to any path request. |
 | `restFul.port` | Here set the listening `Port` for RESTful server. |

package/config.schema.json

@@ -1543,25 +1543,41 @@
               "description": "Set the background account data refresh time in seconds.",
               "required": false
             },
-            "enableDebugMode": {
-              "title": "Debug",
+            "disableLogDeviceInfo": {
+              "title": "Disable Log Device Info",
               "type": "boolean",
               "default": false,
-              "description": "Enable debug mode.",
+              "description": "This disable logging device info by every connections device to the network.",
               "required": false
             },
             "disableLogInfo": {
               "title": "Disable Log Info",
               "type": "boolean",
               "default": false,
-              "description": "Don't display values and states in log every time info changes.",
               "required": false
             },
-            "disableLogDeviceInfo": {
-              "title": "Disable Log Device Info",
+            "disableLogSuccess": {
+              "title": "Disable Log Success",
+              "type": "boolean",
+              "default": false,
+              "required": false
+            },
+            "disableLogWarn": {
+              "title": "Disable Log Warn",
+              "type": "boolean",
+              "default": false,
+              "required": false
+            },
+            "disableLogError": {
+              "title": "Disable Log Error",
+              "type": "boolean",
+              "default": false,
+              "required": false
+            },
+            "enableDebugMode": {
+              "title": "Enable Log Debug",
               "type": "boolean",
               "default": false,
-              "description": "Don't display device info in log on plugin start.",
               "required": false
             },
             "restFul": {
@@ -2011,9 +2027,12 @@
                   "key": "accounts[]",
                   "title": "Log",
                   "items": [
-                    "accounts[].enableDebugMode",
+                    "accounts[].disableLogDeviceInfo",
                     "accounts[].disableLogInfo",
-                    "accounts[].disableLogDeviceInfo"
+                    "accounts[].disableLogSuccess",
+                    "accounts[].disableLogWarn",
+                    "accounts[].disableLogError",
+                    "accounts[].enableDebugMode"
                   ]
                 },
                 {

package/index.js

@@ -47,9 +47,14 @@ class MelCloudPlatform {
 				}
 				accountsName.push(accountName);
 
-				//debug config
+				//log config
 				const enableDebugMode = account.enableDebugMode || false;
-				const debug = enableDebugMode ? log.info(`${accountName}, did finish launching.`) : false;
+				const disableLogDeviceInfo = account.disableLogDeviceInfo || false;
+				const disableLogInfo = account.disableLogInfo || false;
+				const disableLogSuccess = account.disableLogSuccess || false;
+				const disableLogWarn = account.disableLogWarn || false;
+				const disableLogError = account.disableLogError || false;
+				const debug = enableDebugMode ? log.info(`Device: ${host} ${deviceName}, debug: Did finish launching.`) : false;
 
 				//remove sensitive data
 				const debugData = {
@@ -60,7 +65,7 @@ class MelCloudPlatform {
 						passwd: 'removed'
 					}
 				};
-				const debug1 = enableDebugMode ? log.info(`${accountName}, Config: ${JSON.stringify(debugData, null, 2)}`) : false;
+				const debug1 = !enableDebugMode ? false : log.info(`${accountName}, Config: ${JSON.stringify(debugData, null, 2)}`);
 
 				//define directory and file paths
 				const accountFile = `${prefDir}/${accountName}_Account`;
@@ -73,34 +78,41 @@ class MelCloudPlatform {
 				try {
 					//melcloud account
 					const melCloud = new MelCloud(user, passwd, language, accountFile, buildingsFile, devicesFile, enableDebugMode, false);
-					melCloud.on('success', (message) => {
-						log.success(`${accountName}, ${message}`);
+					melCloud.on('success', (success) => {
+						const emitLog = disableLogSuccess ? false : log.success(`${accountName}, ${success}`);
 					})
-						.on('message', (message) => {
-							log.info(`${accountName}, ${message}`);
+						.on('info', (info) => {
+							const emitLog = disableLogInfo ? false : log.info(`${accountName}, ${info}`);
 						})
 						.on('debug', (debug) => {
-							log.info(`${accountName}, debug: ${debug}`);
+							const emitLog = !enableDebugMode ? false : log.info(`${accountName}, debug: ${debug}`);
 						})
 						.on('warn', (warn) => {
-							log.warn(`${accountName}, ${warn}`);
+							const emitLog = disableLogWarn ? false : log.warn(`${accountName}, ${warn}`);
 						})
 						.on('error', (error) => {
-							log.error(`${accountName}, ${error}.`);
+							const emitLog = disableLogError ? false : log.error(`${accountName}, ${error}.`);
 						});
 
 					//connect
 					const response = await melCloud.connect();
-					const accountInfo = response.accountInfo;
-					const contextKey = response.contextKey;
-					const useFahrenheit = response.useFahrenheit;
+					const accountInfo = response.accountInfo ?? false;
+					const contextKey = response.contextKey ?? false;
+					const useFahrenheit = response.useFahrenheit ?? false;
+
+					if (contextKey === false) {
+						return;
+					}
 
 					//check devices list
 					const devices = await melCloud.chackDevicesList(contextKey);
+					if (devices === false) {
+						return;
+					}
 
 					//start impulse generator
 					const timers = [{ name: 'checkDevicesList', sampling: refreshInterval }];
-					melCloud.impulseGenerator.start(timers);
+					await melCloud.impulseGenerator.start(timers);
 
 					//Air Conditioner 0
 					try {
@@ -121,31 +133,31 @@ class MelCloudPlatform {
 
 								//publish device
 								api.publishExternalAccessories(PluginName, [accessory]);
-								log.success(`${accountName}, ${deviceTypeText} ${deviceName}, published as external accessory.`);
+								const emitLog = disableLogSuccess ? false : log.success(`${accountName}, ${deviceTypeText} ${deviceName}, published as external accessory.`);
 							})
 								.on('devInfo', (devInfo) => {
-									log.info(devInfo);
+									const emitLog = disableLogDeviceInfo ? false : log.info(devInfo);
 								})
-								.on('success', (message) => {
-									log.success(`${accountName}, ${deviceTypeText}, ${deviceName}, ${message}`);
+								.on('success', (success) => {
+									const emitLog = disableLogSuccess ? false : log.success(`${accountName}, ${deviceTypeText}, ${deviceName}, ${success}`);
 								})
-								.on('message', (message) => {
-									log.info(`${accountName}, ${deviceTypeText}, ${deviceName}, ${message}`);
+								.on('info', (info) => {
+									const emitLog = disableLogInfo ? false : log.info(`${accountName}, ${deviceTypeText}, ${deviceName}, ${info}`);
 								})
 								.on('debug', (debug) => {
-									log.info(`${accountName}, ${deviceTypeText}, ${deviceName}, debug: ${debug}`);
+									const emitLog = !enableDebugMode ? false : log.info(`${accountName}, ${deviceTypeText}, ${deviceName}, debug: ${debug}`);
 								})
 								.on('warn', (warn) => {
-									log.warn(`${accountName}, ${deviceTypeText}, ${deviceName}, ${warn}`);
+									const emitLog = disableLogWarn ? false : log.warn(`${accountName}, ${deviceTypeText}, ${deviceName}, ${warn}`);
 								})
 								.on('error', (error) => {
-									log.error(`${accountName}, ${deviceTypeText}, ${deviceName}, ${error}`);
+									const emitLog = disableLogError ? false : log.error(`${accountName}, ${deviceTypeText}, ${deviceName}, ${error}`);
 								});
 
 							await airConditioner.start();
 						};
 					} catch (error) {
-						log.error(`${accountName}, ATA did finish launching error: ${error}`);
+						throw new Error(`${accountName}, ATA did finish launching error: ${error}.`);
 					}
 
 					//Heat Pump 1
@@ -167,31 +179,31 @@ class MelCloudPlatform {
 
 								//publish device
 								api.publishExternalAccessories(PluginName, [accessory]);
-								log.success(`${accountName}, ${deviceTypeText} ${deviceName}, published as external accessory.`);
+								const emitLog = disableLogSuccess ? false : log.success(`${accountName}, ${deviceTypeText} ${deviceName}, published as external accessory.`);
 							})
 								.on('devInfo', (devInfo) => {
-									log.info(devInfo);
+									const emitLog = disableLogDeviceInfo ? false : log.info(devInfo);
 								})
-								.on('success', (message) => {
-									log.success(`${accountName}, ${deviceTypeText}, ${deviceName}, ${message}`);
+								.on('success', (success) => {
+									const emitLog = disableLogSuccess ? false : log.success(`${accountName}, ${deviceTypeText}, ${deviceName}, ${success}`);
 								})
-								.on('message', (message) => {
-									log.info(`${accountName}, ${deviceTypeText}, ${deviceName}, ${message}`);
+								.on('info', (info) => {
+									const emitLog = disableLogInfo ? false : log.info(`${accountName}, ${deviceTypeText}, ${deviceName}, ${info}`);
 								})
 								.on('debug', (debug) => {
-									log.info(`${accountName}, ${deviceTypeText}, ${deviceName}, debug: ${debug}`);
+									const emitLog = !enableDebugMode ? false : log.info(`${accountName}, ${deviceTypeText}, ${deviceName}, debug: ${debug}`);
 								})
 								.on('warn', (warn) => {
-									log.warn(`${accountName}, ${deviceTypeText}, ${deviceName}, ${warn}`);
+									const emitLog = disableLogWarn ? false : log.warn(`${accountName}, ${deviceTypeText}, ${deviceName}, ${warn}`);
 								})
 								.on('error', (error) => {
-									log.error(`${accountName}, ${deviceTypeText}, ${deviceName}, ${error}`);
+									const emitLog = disableLogError ? false : log.error(`${accountName}, ${deviceTypeText}, ${deviceName}, ${error}`);
 								});
 
 							await heatPump.start();
 						};
 					} catch (error) {
-						log.error(`${accountName}, ATW did finish launching error: ${error}`);
+						throw new Error(`${accountName}, ATE did finish launching error: ${error}.`);
 					}
 
 					//Energy Recovery Ventilation 3
@@ -213,34 +225,34 @@ class MelCloudPlatform {
 
 								//publish device
 								api.publishExternalAccessories(PluginName, [accessory]);
-								log.success(`${accountName}, ${deviceTypeText} ${deviceName}, published as external accessory.`);
+								const emitLog = disableLogSuccess ? false : log.success(`${accountName}, ${deviceTypeText} ${deviceName}, published as external accessory.`);
 							})
 								.on('devInfo', (devInfo) => {
-									log.info(devInfo);
+									const emitLog = disableLogDeviceInfo ? false : log.info(devInfo);
 								})
-								.on('success', (message) => {
-									log.success(`${accountName}, ${deviceTypeText}, ${deviceName}, ${message}`);
+								.on('success', (success) => {
+									const emitLog = disableLogSuccess ? false : log.success(`${accountName}, ${deviceTypeText}, ${deviceName}, ${success}`);
 								})
-								.on('message', (message) => {
-									log.info(`${accountName}, ${deviceTypeText}, ${deviceName}, ${message}`);
+								.on('info', (info) => {
+									const emitLog = disableLogInfo ? false : log.info(`${accountName}, ${deviceTypeText}, ${deviceName}, ${info}`);
 								})
 								.on('debug', (debug) => {
-									log.info(`${accountName}, ${deviceTypeText}, ${deviceName}, debug: ${debug}`);
+									const emitLog = !enableDebugMode ? false : log.info(`${accountName}, ${deviceTypeText}, ${deviceName}, debug: ${debug}`);
 								})
 								.on('warn', (warn) => {
-									log.warn(`${accountName}, ${deviceTypeText}, ${deviceName}, ${warn}`);
+									const emitLog = disableLogWarn ? false : log.warn(`${accountName}, ${deviceTypeText}, ${deviceName}, ${warn}`);
 								})
 								.on('error', (error) => {
-									log.error(`${accountName}, ${deviceTypeText}, ${deviceName}, ${error}`);
+									const emitLog = disableLogError ? false : log.error(`${accountName}, ${deviceTypeText}, ${deviceName}, ${error}`);
 								});
 
 							await energyRecoveryVentilation.start();
 						};
 					} catch (error) {
-						log.error(`${accountName}, ERV did finish launching error: ${error}`);
+						throw new Error(`${accountName}, ERV did finish launching error: ${error}.`);
 					}
 				} catch (error) {
-					log.error(`${accountName}, did finish launching error: ${error}`);
+					throw new Error(`${accountName}, Account did finish launching error: ${error}.`);
 				}
 			};
 		});

package/package.json

@@ -1,7 +1,7 @@
 {
   "displayName": "MELCloud Control",
   "name": "homebridge-melcloud-control",
-  "version": "3.5.2",
+  "version": "3.6.0",
   "description": "Homebridge plugin to control Mitsubishi Air Conditioner, Heat Pump and Energy Recovery Ventilation.",
   "license": "MIT",
   "author": "grzegorz914",
@@ -31,7 +31,7 @@
     "LICENSE"
   ],
   "engines": {
-    "homebridge": "^1.6.0 || ^2.0.0-beta.0",
+    "homebridge": "^1.8.5 || ^2.0.0-beta.0",
     "node": "^18.20.4 || ^20.15.1 || ^22.7.0 || ^23.2.0"
   },
   "dependencies": {

package/src/deviceata.js

@@ -1370,19 +1370,19 @@ class DeviceAta extends EventEmitter {
                         this.emit('error', error);
                     };
                 })
-                .on('success', (message) => {
-                    this.emit('success', message);
+                .on('success', (success) => {
+                    this.emit('success', success);
                 })
-                .on('message', (message) => {
-                    this.emit('message', message);
+                .on('info', (info) => {
+                    this.emit('info', info);
                 })
                 .on('debug', (debug) => {
                     this.emit('debug', debug);
                 })
-                .on('warn', async (warn) => {
+                .on('warn', (warn) => {
                     this.emit('warn', warn);
                 })
-                .on('error', async (error) => {
+                .on('error', (error) => {
                     this.emit('error', error);
                 });
 

package/src/deviceatw.js

@@ -1914,19 +1914,19 @@ class DeviceAtw extends EventEmitter {
                         this.emit('error', error);
                     };
                 })
-                .on('success', (message) => {
-                    this.emit('success', message);
+                .on('success', (success) => {
+                    this.emit('success', success);
                 })
-                .on('message', (message) => {
-                    this.emit('message', message);
+                .on('info', (info) => {
+                    this.emit('info', info);
                 })
                 .on('debug', (debug) => {
                     this.emit('debug', debug);
                 })
-                .on('warn', async (warn) => {
+                .on('warn', (warn) => {
                     this.emit('warn', warn);
                 })
-                .on('error', async (error) => {
+                .on('error', (error) => {
                     this.emit('error', error);
                 });
 

package/src/deviceerv.js

@@ -1238,19 +1238,19 @@ class DeviceErv extends EventEmitter {
                         this.emit('error', error);
                     };
                 })
-                .on('success', (message) => {
-                    this.emit('success', message);
+                .on('success', (success) => {
+                    this.emit('success', success);
                 })
-                .on('message', (message) => {
-                    this.emit('message', message);
+                .on('info', (info) => {
+                    this.emit('info', info);
                 })
                 .on('debug', (debug) => {
                     this.emit('debug', debug);
                 })
-                .on('warn', async (warn) => {
+                .on('warn', (warn) => {
                     this.emit('warn', warn);
                 })
-                .on('error', async (error) => {
+                .on('error', (error) => {
                     this.emit('error', error);
                 });
 

package/src/melcloud.js

@@ -79,7 +79,7 @@ class MelCloud extends EventEmitter {
 
             if (contextKey === undefined || contextKey === null) {
                 this.emit('warn', `Context key: ${contextKey}, missing.`)
-                return;
+                return false;
             };
 
             //create axios instance post
@@ -144,7 +144,7 @@ class MelCloud extends EventEmitter {
 
             if (!buildingsList) {
                 this.emit('warn', `No building found.`);
-                return;
+                return false;
             }
 
             //save buildings to the file
@@ -170,7 +170,7 @@ class MelCloud extends EventEmitter {
             const devicesCount = devices.length;
             if (devicesCount === 0) {
                 this.emit('warn', `No devices found.`);
-                return;
+                return false;
             }
 
             //save buildings to the file

package/src/melcloudata.js

@@ -10,7 +10,7 @@ class MelCloudAta extends EventEmitter {
         super();
         this.devicesFile = config.devicesFile;
         this.deviceId = config.deviceId;
-        this.debugLog = config.debugLog;
+        this.enableDebugMode = config.enableDebugMode;
 
         //set default values
         this.deviceState = {};
@@ -52,7 +52,7 @@ class MelCloudAta extends EventEmitter {
                 return;
             }
             const deviceData = devicesData.find(device => device.DeviceID === this.deviceId);
-            const debug = this.debugLog ? this.emit('debug', `Device Data: ${JSON.stringify(deviceData, null, 2)}`) : false;
+            const debug = this.enableDebugMode ? this.emit('debug', `Device Data: ${JSON.stringify(deviceData, null, 2)}`) : false;
 
             //device info
             const deviceId = deviceData.DeviceID;

package/src/melcloudatw.js

@@ -10,7 +10,7 @@ class MelCloudAtw extends EventEmitter {
         super();
         this.devicesFile = config.devicesFile;
         this.deviceId = config.deviceId;
-        this.debugLog = config.debugLog;
+        this.enableDebugMode = config.enableDebugMode;
 
         //set default values
         this.deviceState = {};
@@ -52,7 +52,7 @@ class MelCloudAtw extends EventEmitter {
                 return;
             }
             const deviceData = devicesData.find(device => device.DeviceID === this.deviceId);
-            const debug = this.debugLog ? this.emit('debug', `Device Data: ${JSON.stringify(deviceData, null, 2)}`) : false;
+            const debug = this.enableDebugMode ? this.emit('debug', `Device Data: ${JSON.stringify(deviceData, null, 2)}`) : false;
 
             //device info
             const deviceId = deviceData.DeviceID;

package/src/melclouderv.js

@@ -10,7 +10,7 @@ class MelCloudErv extends EventEmitter {
         super();
         this.devicesFile = config.devicesFile;
         this.deviceId = config.deviceId;
-        this.debugLog = config.debugLog;
+        this.enableDebugMode = config.enableDebugMode;
 
         //set default values
         this.deviceState = {};
@@ -52,7 +52,7 @@ class MelCloudErv extends EventEmitter {
                 return;
             }
             const deviceData = devicesData.find(device => device.DeviceID === this.deviceId);
-            const debug = this.debugLog ? this.emit('debug', `Device Data: ${JSON.stringify(deviceData, null, 2)}`) : false;
+            const debug = this.enableDebugMode ? this.emit('debug', `Device Data: ${JSON.stringify(deviceData, null, 2)}`) : false;
 
             //deviceData
             const deviceId = deviceData.DeviceID;