homebridge-melcloud-control 2.5.0-beta.3 → 2.5.0-beta.31

package/config.schema.json

@@ -205,6 +205,62 @@
               "description": "Here select the language used in MELCloud account.",
               "required": true
             },
+            "devices": {
+              "title": "Devices",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "title": "Name",
+                    "type": "string",
+                    "required": true
+                  },
+                  "id": {
+                    "title": "Mode",
+                    "type": "integer",
+                    "description": "Device ID.",
+                    "required": true
+                  },
+                  "type": {
+                    "title": "Type",
+                    "type": "integer",
+                    "description": "Device Type.",
+                    "required": true
+                  },
+                  "displayMode": {
+                    "title": "Control",
+                    "type": "integer",
+                    "minimum": 0,
+                    "maximum": 2,
+                    "default": 0,
+                    "oneOf": [
+                      {
+                        "title": "None/Disabled",
+                        "enum": [
+                          0
+                        ]
+                      },
+                      {
+                        "title": "Heater/Cooler",
+                        "enum": [
+                          0
+                        ]
+                      },
+                      {
+                        "title": "Thermostat",
+                        "enum": [
+                          1
+                        ]
+                      }
+                    ],
+                    "description": "Select device control mode displayed in HomeKit app.",
+                    "required": true
+                  }
+                }
+              },
+              "required": false
+            },
             "ataDisplayMode": {
               "title": "Control",
               "type": "integer",

package/homebridge-ui/public/index.html

@@ -6,21 +6,48 @@
 <div id="melCloudAccount" style="display: none;" class="card card-body">
   <form id="configForm">
     <div class="text-center">
-      <label id="accountName" style="font-size: 23px">Account Name</label><br>
+      <label id="accountName" style="font-size: 23px">Account</label><br>
       <label id="info" style="text-align: center; font-size: 17px;">MELCloud</label><br><br>
     </div>
     <div class="form-group">
       <label for="name">Name</label>
       <input id="name" type="text" class="form-control"><br>
-      <label for="user">MELCloud User</label>
+      <label for="user">User Name</label>
       <input id="user" type="text" class="form-control"><br>
-      <label for="passwd">MELCloud Password</label>
-      <input id="passwd" type="text" class="form-control"><br>
+      <label for="passwd">Password</label>
+      <input id="passwd" type="password" class="form-control"><br>
       <label for="language">Language</label>
-      <input id="language" type="text" class="form-control"><br>
+      <select id="language" name="language" class="form-control"><br>
+        <option value="0">English</option>
+        <option value="1">Български</option>
+        <option value="2">Čeština</option>
+        <option value="3">Dansk</option>
+        <option value="4">Deutsch</option>
+        <option value="5">Eesti</option>
+        <option value="6">Español</option>
+        <option value="7">Français</option>
+        <option value="8">Հայերեն</option>
+        <option value="9">Latviešu</option>
+        <option value="10">Lietuvių</option>
+        <option value="11">Magyar</option>
+        <option value="12">Nederlands</option>
+        <option value="13">Norwegian</option>
+        <option value="14">Polski</option>
+        <option value="15">Português</option>
+        <option value="16">Русский</option>
+        <option value="17">Suomi</option>
+        <option value="18">Svenska</option>
+        <option value="19">Svenska</option>
+        <option value="20">Українська</option>
+        <option value="21">Türkçe</option>
+        <option value="22">Ελληνικά</option>
+        <option value="23">Hrvatski</option>
+        <option value="24">Română</option>
+        <option value="25">Slovenščina</option>
+      </select>
     </div>
     <div class="text-center">
-      <button id="logIn" type="button" class="btn btn-primary">Log In</button>
+      <button id="logIn" type="button" class="btn btn-primary">Connect to MELCloud</button>
       <button id="configButton" type="button" class="btn btn-primary"><i class="fas fa-gear"></i></button>
     </div>
   </form>
@@ -56,6 +83,8 @@
           const setRemoveAtribute = j === i ? document.getElementById(`button${j}`).setAttribute("class", "btn btn-secondary") : document.getElementById(`button${j}`).setAttribute("class", "btn btn-primary");
         }
 
+        const devicesCount = pluginConfig[0].accounts[this.deviceIndex].devices.length ?? 0;
+        document.getElementById('info').innerHTML = `MELCloud configured ${devicesCount} ${devicesCount} ${devicesCount !== 1 ? 'devices' : 'device'}.`;
         document.getElementById('accountName').innerHTML = pluginConfig[0].accounts[i].name || '';
         document.getElementById('name').value = pluginConfig[0].accounts[i].name || '';
         document.getElementById('user').value = pluginConfig[0].accounts[i].user || '';
@@ -63,7 +92,8 @@
         document.getElementById('language').value = pluginConfig[0].accounts[i].language || '';
 
         const accountConfigured = pluginConfig[0].accounts[i].name && pluginConfig[0].accounts[i].user && pluginConfig[0].accounts[i].passwd && pluginConfig[0].accounts[i].language;
-        const setButtonName = accountConfigured ? document.getElementById('logIn').removeAttribute('disabled') : document.getElementById('logIn').setAttribute('disabled');
+        const setButtonState = accountConfigured ? document.getElementById('logIn').removeAttribute('disabled') : document.getElementById('logIn').setAttribute('disabled');
+        document.getElementById('configButton').setAttribute('disabled');
         await homebridge.updatePluginConfig(pluginConfig);
         this.deviceIndex = i;
       });
@@ -82,7 +112,7 @@
       pluginConfig[0].accounts[this.deviceIndex].language = document.querySelector('#language').value;
 
       const accountConfigured = pluginConfig[0].accounts[i].name && pluginConfig[0].accounts[i].user && pluginConfig[0].accounts[i].passwd && pluginConfig[0].accounts[i].language;
-      const setButtonMode = accountConfigured ? document.getElementById('logIn').removeAttribute('disabled') : document.getElementById('logIn').setAttribute('disabled');
+      const setButtonState = accountConfigured ? document.getElementById('logIn').removeAttribute('disabled') : document.getElementById('logIn').setAttribute('disabled');
 
       await homebridge.updatePluginConfig(pluginConfig);
       await homebridge.savePluginConfig(pluginConfig);
@@ -100,73 +130,57 @@
 
       try {
         await homebridge.updatePluginConfig(pluginConfig)
-        document.getElementById('info').innerHTML = '';
+        document.getElementById('info').innerHTML = 'Connecting...';
 
         const accountName = pluginConfig[0].accounts[this.deviceIndex].name;
         const user = pluginConfig[0].accounts[this.deviceIndex].user;
         const passwd = pluginConfig[0].accounts[this.deviceIndex].passwd;
         const language = pluginConfig[0].accounts[this.deviceIndex].language;
-        const enableDebugMode = pluginConfig[0].accounts[this.deviceIndex].enableDebugMode;
-        const refreshInterval = pluginConfig[0].accounts[this.deviceIndex].refreshInterval;
 
         const payload = {
           accountName: accountName,
           user: user,
           passwd: passwd,
-          language: language,
-          enableDebugMode: enableDebugMode,
-          refreshInterval: refreshInterval
+          language: language
         };
         const response = await homebridge.request('/connect', payload);
-        const info = response.info;
+        const info = response.info ?? '';
         const status = response.status;
-        const data = response.data;
-        const error = response.error;
+        const devices = response.data ?? [];
 
         switch (status) {
           case 0:
-            const devicesId = [];
+            const devicesCount = devices.length;
+            document.getElementById('info').innerHTML = `Success, found ${devicesCount} ${devicesCount !== 1 ? 'devices' : 'device'}. Now You can start to configure it.`;
+            document.getElementById('info').style.color = 'green';
 
             //get device info fom devices
-            for (const deviceInfo of devices) {
+            devices.forEach((deviceInfo, index) => {
+              const deviceType = deviceInfo.Type;
               const deviceId = deviceInfo.DeviceID;
               const deviceName = deviceInfo.DeviceName;
 
-              //prepare device if not in devices array
-              if (!devicesId.includes(deviceId)) {
-                devicesId.push(deviceId);
-              }
-            };
+              const displayMode = pluginConfig[0].accounts[this.deviceIndex].devices[index].displayMode ?? 0;
+              const device = { name: deviceName, id: deviceId, type: deviceType, displayMode: displayMode };
+              const language = pluginConfig[0].accounts[this.deviceIndex].devices.push(device);
+            });
 
-            document.getElementById('info').innerHTML = `${info} Found: ${devicesId.length} devices. Now You can start configure it.`;
-            document.getElementById('info').style.color = 'green';
             await homebridge.updatePluginConfig(pluginConfig);
             await homebridge.savePluginConfig(pluginConfig);
             break;
           case 1:
             document.getElementById('info').innerHTML = info;
-            document.getElementById('info').style.color = 'green';
-            break;
-          case 2:
-            document.getElementById('info').innerHTML = info;
-            document.getElementById('info').style.color = 'white';
-            break;
-          case 3:
-            document.getElementById('info').innerHTML = info;
-            document.getElementById('info').style.color = 'gray';
+            document.getElementById('info').style.color = 'red';
             break;
-          case 4:
-            document.getElementById('info').innerHTML = info;
+          default:
+            document.getElementById('info').innerHTML = `Received unknown status: ${status}, please try again.`;
             document.getElementById('info').style.color = 'yellow';
             break;
-          case 5:
-            document.getElementById('info').innerHTML = `MELCloud error: ${JSON.stringify(error, null, 2)}`;
-            document.getElementById('info').style.color = 'red';
-            break;
         };
 
         homebridge.hideSpinner();
       } catch (e) {
+        document.getElementById('info').innerHTML = 'Please try again.';
         homebridge.toast.error(`Data error: ${e.message}`);
       } finally {
         homebridge.hideSpinner();

package/homebridge-ui/server.js

@@ -19,58 +19,24 @@ class PluginUiServer extends HomebridgePluginUiServer {
     const user = payload.user;
     const passwd = payload.passwd;
     const language = payload.language;
-    const enableDebugMode = payload.enableDebugMode;
-    const refreshInterval = payload.refreshInterval;
     const accountInfoFile = `${this.homebridgeStoragePath}/melcloud/${accountName}_Account`;
     const deviceInfoFile = `${this.homebridgeStoragePath}/melcloud/${accountName}_Device_`;
     const buildingsFile = `${this.homebridgeStoragePath}/melcloud/${accountName}_Buildings`;
-    let data = {};
 
     try {
-      const melCloud = new MelCloud(user, passwd, language, accountInfoFile, deviceInfoFile, buildingsFile, enableDebugMode, refreshInterval, false);
-      melCloud.on('connect', (devices) => {
-        return data = {
-          info: 'Connect to MELCloud success, now pres the button Get Devices.',
-          status: 0,
-          data: devices
-        };
-      })
-        .on('success', (message) => {
-          return data = {
-            info: message,
-            status: 1
-          };
-        })
-        .on('message', (message) => {
-          return data = {
-            info: message,
-            status: 2
-          };
-        })
-        .on('debug', (debug) => {
-          return data = {
-            info: debug,
-            status: 3
-          };
-        })
-        .on('warn', (warn) => {
-          return data = {
-            info: warn,
-            status: 4
-          };
-        })
-        .on('error', async (error) => {
-          return data = {
-            info: 'Connect error:',
-            status: 5,
-            data: error
-          };
-        });
+      let data = {};
+      const melCloud = new MelCloud(user, passwd, language, accountInfoFile, deviceInfoFile, buildingsFile, false, 0, true);
+      const contextKey = await melCloud.connect();
+      const devices = await melCloud.chackDevicesList(contextKey);
+      return data = {
+        info: '',
+        status: 0,
+        data: devices
+      };
     } catch (error) {
       return data = {
-        info: 'MELCloud error.',
-        status: 5,
-        error: error
+        info: error,
+        status: 1
       };
     };
   };

package/index.js

@@ -78,7 +78,7 @@ class MelCloudPlatform {
 				const deviceRefreshInterval = account.deviceRefreshInterval * 1000 || 5000;
 
 				//melcloud account
-				const melCloud = new MelCloud(user, passwd, language, accountInfoFile, buildingsFile, deviceInfoFile, enableDebugMode, refreshInterval, true);
+				const melCloud = new MelCloud(user, passwd, language, accountInfoFile, buildingsFile, deviceInfoFile, enableDebugMode, refreshInterval, false);
 				melCloud.on('checkDevicesListComplete', (accountInfo, contextKey, deviceInfo) => {
 					const deviceId = deviceInfo.DeviceID.toString();
 					const deviceType = deviceInfo.Type;

package/package.json

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

package/src/melcloud.js

@@ -8,14 +8,15 @@ const ImpulseGenerator = require('./impulsegenerator.js');
 const CONSTANTS = require('./constants.json');
 
 class MelCloud extends EventEmitter {
-    constructor(user, passwd, language, accountInfoFile, deviceInfoFile, buildingsFile, enableDebugMode, refreshInterval, startImpulseGenerator) {
+    constructor(user, passwd, language, accountInfoFile, deviceInfoFile, buildingsFile, enableDebugMode, refreshInterval, connectForConfig) {
         super();
-        this.enableDebugMode = enableDebugMode;
         this.accountInfoFile = accountInfoFile;
         this.buildingsFile = buildingsFile;
         this.deviceInfoFile = deviceInfoFile;
+        this.enableDebugMode = enableDebugMode;
         this.refreshInterval = refreshInterval;
-        this.startImpulseGenerator = startImpulseGenerator;
+        this.connectForConfig = connectForConfig;
+        this.contextKey = '';
         this.devicesId = [];
 
         this.options = {
@@ -30,16 +31,18 @@ class MelCloud extends EventEmitter {
             }
         };
 
-        this.impulseGenerator = new ImpulseGenerator();
-        this.impulseGenerator.on('checkDevicesList', async () => {
-            try {
-                await this.chackDevicesList();
-            } catch (error) {
-                this.emit('error', `Check devices list: ${error}.`);
-            };
-        }).on('state', (state) => { });
-
-        this.connect();
+        if (!connectForConfig) {
+            this.impulseGenerator = new ImpulseGenerator();
+            this.impulseGenerator.on('checkDevicesList', async () => {
+                try {
+                    await this.chackDevicesList(this.contextKey);
+                } catch (error) {
+                    this.emit('error', `Check devices list: ${error}.`);
+                };
+            }).on('state', (state) => { });
+
+            this.connect();
+        };
     };
 
     async connect() {
@@ -79,57 +82,26 @@ class MelCloud extends EventEmitter {
                 this.emit('warn', `Context key: ${contextKey}, missing.`)
                 return;
             };
-
-            //create axios instance get
-            this.axiosInstanceGet = axios.create({
-                method: 'GET',
-                baseURL: CONSTANTS.ApiUrls.BaseURL,
-                timeout: 5000,
-                headers: {
-                    'X-MitsContextKey': contextKey
-                },
-                maxContentLength: 100000000,
-                maxBodyLength: 1000000000,
-                withCredentials: true,
-                httpsAgent: new https.Agent({
-                    keepAlive: false,
-                    rejectUnauthorized: false
-                })
-            });
-
-            //create axios instance post
-            this.axiosInstancePost = axios.create({
-                method: 'POST',
-                baseURL: CONSTANTS.ApiUrls.BaseURL,
-                timeout: 5000,
-                headers: {
-                    'X-MitsContextKey': contextKey,
-                    'content-type': 'application/json'
-                },
-                maxContentLength: 100000000,
-                maxBodyLength: 1000000000,
-                withCredentials: true,
-                httpsAgent: new https.Agent({
-                    keepAlive: false,
-                    rejectUnauthorized: false
-                })
-            });
-
             this.accountInfo = accountInfo;
             this.contextKey = contextKey;
 
+            //return if connect for config
+            if (this.connectForConfig) {
+                return contextKey;
+            };
+
             //save melcloud info to the file
             await this.saveData(this.accountInfoFile, accountInfo);
 
             //check devices list
-            await this.chackDevicesList();
+            await this.chackDevicesList(contextKey);
 
             //emit connect success
             this.emit('success', `Connect to MELCloud Success.`)
 
             //start impulse generator
             const timers = [{ name: 'checkDevicesList', sampling: this.refreshInterval }];
-            const startImpulseGenerator = this.startImpulseGenerator ? this.impulseGenerator.start(timers) : false;
+            this.impulseGenerator.start(timers);
 
             return true;
         } catch (error) {
@@ -137,10 +109,27 @@ class MelCloud extends EventEmitter {
         };
     }
 
-    async chackDevicesList() {
+    async chackDevicesList(contextKey) {
         try {
+            //create axios instance get
+            const axiosInstanceGet = axios.create({
+                method: 'GET',
+                baseURL: CONSTANTS.ApiUrls.BaseURL,
+                timeout: 5000,
+                headers: {
+                    'X-MitsContextKey': contextKey
+                },
+                maxContentLength: 100000000,
+                maxBodyLength: 1000000000,
+                withCredentials: true,
+                httpsAgent: new https.Agent({
+                    keepAlive: false,
+                    rejectUnauthorized: false
+                })
+            });
+
             const debug = this.enableDebugMode ? this.emit('debug', `Scanning for devices.`) : false;
-            const listDevicesData = await this.axiosInstanceGet(CONSTANTS.ApiUrls.ListDevices);
+            const listDevicesData = await axiosInstanceGet(CONSTANTS.ApiUrls.ListDevices);
             const buildingsList = listDevicesData.data;
             const debug1 = this.enableDebugMode ? this.emit('debug', `Buildings: ${JSON.stringify(buildingsList, null, 2)}`) : false;
 
@@ -176,6 +165,11 @@ class MelCloud extends EventEmitter {
             }
             const debug3 = this.enableDebugMode ? this.emit('debug', `Found: ${devicesCount} devices.`) : false;
 
+            //return devices list for config
+            if (this.connectForConfig) {
+                return devices;
+            };
+
             //get device info fom devices
             for (const deviceInfo of devices) {
                 const deviceId = deviceInfo.DeviceID
@@ -189,16 +183,13 @@ class MelCloud extends EventEmitter {
                 //prepare device if not in devices array
                 if (!this.devicesId.includes(deviceId)) {
                     this.devicesId.push(deviceId);
-                    this.emit('checkDevicesListComplete', this.accountInfo, this.contextKey, deviceInfo);
+                    this.emit('checkDevicesListComplete', this.accountInfo, contextKey, deviceInfo);
                 }
             };
 
-            //emit devices list
-            this.emit('devicesList', devices);
-
             return true;
         } catch (error) {
-            this.impulseGenerator.stop();
+            const stop = connectForConfig ? false : this.impulseGenerator.stop();
             throw new Error(`Scanning for devices error: ${error.message ?? error}.`);
         };
     }
@@ -215,11 +206,29 @@ class MelCloud extends EventEmitter {
 
     async send(accountInfo) {
         try {
+            //create axios instance post
+            const axiosInstancePost = axios.create({
+                method: 'POST',
+                baseURL: CONSTANTS.ApiUrls.BaseURL,
+                timeout: 5000,
+                headers: {
+                    'X-MitsContextKey': this.contextKey,
+                    'content-type': 'application/json'
+                },
+                maxContentLength: 100000000,
+                maxBodyLength: 1000000000,
+                withCredentials: true,
+                httpsAgent: new https.Agent({
+                    keepAlive: false,
+                    rejectUnauthorized: false
+                })
+            });
+
             const options = {
                 data: accountInfo
             };
 
-            await this.axiosInstancePost(CONSTANTS.ApiUrls.UpdateApplicationOptions, options);
+            await axiosInstancePost(CONSTANTS.ApiUrls.UpdateApplicationOptions, options);
             await this.saveData(this.accountInfoFile, accountInfo);
             return true;
         } catch (error) {