homebridge-midea-platform 0.4.13 → 1.0.0

package/docs/a1.md

@@ -0,0 +1,20 @@
+# Dehumidifier
+
+Providing dehumidifier settings is optional and the whole section or individual options may be ommitted and default values (noted below) will be used. Within the *devices.config* object the following dehumidifier specific options.
+
+```json
+"A1_options": {
+    "minHumidity": 35,
+    "maxHumidity": 85,
+    "humidityStep": 5,
+    "temperatureSensor": false,
+    "pumpSwitch": false
+}
+```
+
+## Options
+- **minHumidity** *(optional)*: The minimum relative humidity that the unit can be set for. Default is 35%
+- **maxHumidity** *(optional)*: The maximum relative humidity that the unit can be set for. Default is 85%
+- **humidityStep** *(optional)*: Increment in which the relative himidity setting can be changed, may be set to either 5% or 10%. The default is 5%.
+- **temperatureSensor** *(optional)*: Toggles if the temperature sensor is created with the accessory. Default is false.
+- **pumpSwitch** *(optional)*: Toggles if the pump switch is created with the accessory. Default is false.

package/docs/ac.md

@@ -0,0 +1,41 @@
+# Air Conditioner
+
+Providing air conditioner settings is optional and the whole section or individual options may be ommitted and default values (noted below) will be used. Within the *devices.config* object the following air conditioner specific options.
+
+```json
+"AC_options": {
+    "swingMode": "Both",
+    "heatingCapable": false,
+    "ecoSwitch": false,
+    "displaySwitch": {
+        "flag": true,
+        "command": false
+    },
+    "minTemp": 16,
+    "maxTemp": 30,
+    "tempStep": 1,
+    "fahrenheit": false,
+    "fanOnlyMode": false,
+    "breezeAwaySwitch": false,
+    "dryModeSwitch": false,
+    "auxHeatingSwitches": false,
+    "outDoorTemp": false,
+    "audioFeedback": false
+}
+```
+## Options
+- **swingMode** *(optional)*: The swing mode of the unit.  Options are "Both", "Vertical", "Horizontal", or "None".  Default is "None".
+- **heatingCapable** *(optional)*: Toggles if the unit is capable of heating. Default is false.
+- **displaySwitch** *(optional)*: Object with following two options...
+- * **flag** *(optional)*: Toggles if a switch, which can turn the display on or off will be created or not. Default is true.
+- * **command** *(optional)*: Use this if the switch display command does not work. If it doesn't work either way then you unit does not support this feature. Default is false. 
+- **minTemp** *(optional)*: The minimum temperature that the unit can be set for.  Default is 16 celsius
+- **maxTemp** *(optional)*: The maximum temperature that the unit can be set for.  Default is 30 celsius
+- **tempStep** *(optional)*: Increment in which the temperature setting can be changed, may be set to either 0.5 or 1 degree celsius.  The default is one degree.
+- **fahrenheit** *(optional)*: Toggles if the temperature on the unit is displayed in Fahrenheit or Celsius.  Default is false (displays in Celsius).
+- **fanOnlyMode** *(optional)*: Toggles if the fan only mode is created with the accessory. Default is false.
+- **breezeAwaySwitch** *(optional)*: Toggles if the breeze away switch is created with the accessory. Default is false.
+- **dryModeSwitch** *(optional)*: Toggles if the dry mode switch is created with the accessory. Default is false.
+- **auxHeatingSwitches** *(optional)*: Toggles if the aux heating switches are created with the accessory. Default is false.
+- **outDoorTemp** *(optional)*: Toggles if the outdoor temperature sensor is created with the accessory. Default is false.
+- **audioFeedback** *(optional)*: Toggles if the unit beeps when a command is sent, default is false.

package/docs/e2.md

@@ -0,0 +1,21 @@
+# Electric Water Heater
+
+Providing electric water heater settings is optional and the whole section or individual options may be ommitted and default values (noted below) will be used. Within the *devices.config* object the following electric water heater specific options.
+
+```json
+"E2_options": {
+    "protocol": "auto",
+    "minTemp": 30,
+    "maxTemp": 75,
+    "tempStep": 1,
+    "variableHeatingSwitch": false,
+    "wholeTankHeatingSwitch": false,
+}
+```
+## Options
+- **protocol** *(optional)*: The protocol used to control the water heater. Only change this if the device is not responding to the commands. Default is "auto". Other options are "auto", "old", "new".
+- **minTemp** *(optional)*: The minimum temperature that the unit can be set for. Default is 30 celsius
+- **maxTemp** *(optional)*: The maximum temperature that the unit can be set for. Default is 75 celsius
+- **tempStep** *(optional)*: Increment in which the temperature setting can be changed, may be set to either 0.5 or 1 degree celsius. The default is one degree.
+- **variableHeatingSwitch** *(optional)*: Toggles if the variable heating switch is created with the accessory. Default is false.
+- **wholeTankHeatingSwitch** *(optional)*: Toggles if the whole tank heating switch is created with the accessory. Default is false.

package/docs/e3.md

@@ -0,0 +1,27 @@
+# Gas Water Heater
+
+Providing gas water heater settings is optional and the whole section or individual options may be ommitted and default values (noted below) will be used. Within the *devices.config* object the following gas water heater specific options.
+
+```json
+"E3_options": {
+    "precisionHalves": false,
+    "minTemp": 35,
+    "maxTemp": 65,
+    "tempStep": 1,
+    "burningStateSensor": false,
+    "protectionSensor": false,
+    "zeroColdWaterSwitch": false,
+    "zeroColdPulseSwitch": false,
+    "smartVolumeSwitch": false
+}
+```
+## Options
+- **precisionHalves** *(optional)*: This option must be enabled if the temperature on your unit is displayed in half degree increments. Default is false.
+- **minTemp** *(optional)*: The minimum temperature that the unit can be set for. Default is 35 celsius
+- **maxTemp** *(optional)*: The maximum temperature that the unit can be set for. Default is 65 celsius
+- **tempStep** *(optional)*: Increment in which the temperature setting can be changed, may be set to either 0.5 or 1 degree celsius. The default is one degree.
+- **burningStateSensor** *(optional)*: Toggles if the burning state sensor is created with the accessory. Default is false.
+- **protectionSensor** *(optional)*: Toggles if the protection sensor is created with the accessory. Default is false.
+- **zeroColdWaterSwitch** *(optional)*: Toggles if the zero cold water switch is created with the accessory. Default is false.
+- **zeroColdPulseSwitch** *(optional)*: Toggles if the zero cold pulse switch is created with the accessory. Default is false.
+- **smartVolumeSwitch** *(optional)*: Toggles if the smart volume switch is created with the accessory. Default is false.

package/homebridge-ui/public/index.html

@@ -26,25 +26,41 @@
       <div class="card-body">
         <form>
           <div class="mb-3 bg-info-subtle border-info-subtle p-3 rounded-2">
-            You can discover your devices without providing credentials. However, if you see <i>No Credentials</i> in the
-            Add/Update column then you must provide login credentials so that a <i>token/key</i> pair can be retrieved
-            from Midea cloud servers, these are protocol version 3 devices.
+            You can discover your devices without providing credentials. However, if you see <i>No Credentials</i> in
+            the
+            Add/Update column then you must provide login credentials or use the default profile option so the
+            <i>token/key</i> pair can be retrieved
+            from Midea cloud servers.<br/>
+            <i>Note: you don't have to have your devices connected to the account you are using to fetch the token/key pair.</i>
           </div>
-          <div class="mb-3">
-            <label for="registeredApp" class="form-label">Registered app</label>
-            <select id="registeredApp" class="form-select">
-              <option selected value="Midea SmartHome (MSmartHome)">Midea SmartHome (MSmartHome)</option>
-              <option value="NetHome Plus">NetHome Plus</option>
-              <option value="Meiju">Meiju</option>
-            </select>
+          <div class="mb-3 form-check form-switch">
+            <input id="useDefaultProfile" type="checkbox" class="form-check-input" role="switch">
+            <label for="useDefaultProfile" class="form-check-label">Use default Midea SmartHome profile</label>
           </div>
-          <div class="mb-3">
-            <label for="username" class="form-label">Username</label>
-            <input type="text" class="form-control" id="username">
-          </div>
-          <div class="mb-3">
-            <label for="password" class="form-label">Password</label>
-            <input type="password" class="form-control" id="password">
+          <div class="mb-3" id="login">
+            <div class="mb-3">
+              <label for="registeredApp" class="form-label">Registered app</label>
+              <select id="registeredApp" class="form-select">
+                <option selected value="Midea SmartHome (MSmartHome)">Midea SmartHome (MSmartHome)</option>
+                <option value="NetHome Plus">NetHome Plus</option>
+                <option value="Meiju">Meiju</option>
+                <option value="Artison Clima">Artison Clima</option>
+              </select>
+            </div>
+            <div class="mb-3 hide bg-warning-subtle border-warning-subtle p-3 rounded-2" id="meijuWarning">
+              The Meiju app disabled the process of obtaining the required token/key pair for protocol version 3 devices. 
+              When choosing Meiju, it will utilize the default Midea SmartHome profile to retrieve the token/key pair.
+            </div>
+            <div id="userPass">
+              <div class="mb-3">
+                <label for="username" class="form-label">Username</label>
+                <input type="text" class="form-control" id="username">
+              </div>
+              <div class="mb-3">
+                <label for="password" class="form-label">Password</label>
+                <input type="password" class="form-control" id="password">
+              </div>
+            </div>
           </div>
           <div class="mb-3">
             <label for="ip" class="form-label">IP Addresses (comma or space separated list for when devices are on
@@ -82,6 +98,19 @@
 
 </div>
 
+<style>
+
+  .hide {
+    display: none;
+  }
+
+  .disabled {
+    pointer-events: none;
+    opacity: 0.5;
+  }
+</style>
+
+
 <script>
 
   (async () => {
@@ -174,6 +203,30 @@
     createForm(configSchema, configuration);
     homebridge.hideSpinner();
 
+    const loginSection = document.getElementById('login')
+    const userPass = document.getElementById('userPass');
+    const meijuWarning = document.getElementById('meijuWarning');
+
+    document.getElementById('useDefaultProfile').addEventListener('change', function (e) {
+      if (e.target.checked === true) {
+        loginSection.classList.add('disabled');
+      } else {
+        loginSection.classList.remove('disabled');
+      }
+    });
+
+    document.getElementById('registeredApp').addEventListener('change', function (e) {
+      if (e.target.value === 'Meiju') {
+        meijuWarning.classList.remove('hide');
+        userPass.classList.add('disabled');
+      } else {
+        meijuWarning.classList.add('hide');
+        userPass.classList.remove('disabled');
+      }
+    });
+
+
+
     /*********************************************************************
      * Discover button clicked....
      */
@@ -183,6 +236,9 @@
       const username = document.getElementById('username').value;
       const password = document.getElementById('password').value;
       const registeredApp = document.getElementById('registeredApp').value;
+      const isMeiju = registeredApp === 'Meiju';
+      const useDefaultProfile = document.getElementById('useDefaultProfile').checked === true || isMeiju;
+      
       let ipAddrs = document.getElementById('ip').value ? document.getElementById('ip').value.split(/[\s,]+/) : [];
 
       homebridge.showSpinner();
@@ -190,7 +246,7 @@
 
       console.info(`Request login...`);
       try {
-        await homebridge.request('/login', { username, password, registeredApp });
+        await homebridge.request('/login', { username, password, registeredApp, useDefaultProfile });
       } catch (e) {
         homebridge.toast.error(e.message);
         homebridge.hideSpinner();
@@ -201,6 +257,7 @@
       const table = document.getElementById('discoverTable').getElementsByTagName('tbody')[0];
       table.innerHTML = '';
 
+
       // Merge current config over to the server so discover has latest device config...
       let currentConfig = await homebridge.getPluginConfig();
       currentConfig = currentConfig.length > 0 ? currentConfig[0] : {};
@@ -218,7 +275,7 @@
         return (regexIPv4.test(ip));
       });
       if (!validIPs) {
-        homebride.toast.error(`Invalid IP address provided`);
+        homebridge.toast.error(`Invalid IP address provided`);
         homebridge.hideSpinner();
         // Abort if we have invalid IP address
         return;
@@ -246,12 +303,8 @@
           tr.insertCell().appendChild(document.createTextNode(device.version));
           if (device.version === 3) {
             tr.insertCell().appendChild(document.createTextNode(
-              device.token ?
-                device.token.slice(0, 6) + '...' + device.token.slice(-4) :
-                'token missing' + '\n' +
-                  device.key ?
-                  device.key.slice(0, 6) + '...' + device.key.slice(-4) :
-                  'key missing'
+              (device.token ? (device.token.slice(0, 6) + '...' + device.token.slice(-4)) : 'token missing') + '\n' +
+              (device.key ? (device.key.slice(0, 6) + '...' + device.key.slice(-4)) : 'key missing')
             ));
           } else {
             tr.insertCell().appendChild(document.createTextNode('not needed'));

package/homebridge-ui/server.js

@@ -10,11 +10,17 @@
 const { HomebridgePluginUiServer, RequestError } = require('@homebridge/plugin-ui-utils');
 const Discover = require('../dist/core/MideaDiscover.js').default;
 const CloudFactory = require('../dist/core/MideaCloud.js').default;
-const { DeviceType, TCPMessageType, ProtocolVersion } = require("../dist/core/MideaConstants.js");
+const { DeviceType, TCPMessageType, ProtocolVersion, Endianness } = require("../dist/core/MideaConstants.js");
 const { LocalSecurity } = require("../dist/core/MideaSecurity.js");
 const { PromiseSocket } = require("../dist/core/MideaUtils.js");
 const { defaultConfig, defaultDeviceConfig } = require('../dist/platformUtils.js');
 
+const DEFAULT_ACCOUNT = [
+  BigInt("39182118275972017797890111985649342047468653967530949796945843010512"),
+  BigInt("29406100301096535908214728322278519471982973450672552249652548883645"),
+  BigInt("39182118275972017797890111985649342050088014265865102175083010656997")
+]
+
 var _ = require('lodash');
 
 /*********************************************************************
@@ -81,8 +87,14 @@ class UiServer extends HomebridgePluginUiServer {
     this.security = new LocalSecurity();
     this.promiseSocket = new PromiseSocket(this.logger, config?.logRecoverableErrors ? config.logRecoverableErrors : false);
 
-    this.onRequest('/login', async ({ username, password, registeredApp }) => {
+    this.onRequest('/login', async ({ username, password, registeredApp, useDefaultProfile }) => {
       try {
+        if (useDefaultProfile) {
+          this.logger.debug(`Using default profile.`);
+          registeredApp = 'Midea SmartHome (MSmartHome)';
+          username = Buffer.from((DEFAULT_ACCOUNT[0] ^ DEFAULT_ACCOUNT[1]).toString(16), 'hex').toString('ascii')
+          password = Buffer.from((DEFAULT_ACCOUNT[0] ^ DEFAULT_ACCOUNT[2]).toString(16), 'hex').toString('ascii')
+        }
         this.cloud = CloudFactory.createCloud(username, password, registeredApp);
         if (username && password && registeredApp) {
           await this.cloud.login();
@@ -90,6 +102,7 @@ class UiServer extends HomebridgePluginUiServer {
       } catch (e) {
         const msg = e instanceof Error ? e.stack : e;
         this.logger.warn(`Login failed:\n${msg}`);
+        throw new RequestError(`Login failed! Check the logs for more information.`);
       }
     });
 
@@ -149,9 +162,9 @@ class UiServer extends HomebridgePluginUiServer {
     // works or having tried both.
     while (i <= 1 && !connected) {
       // Start with big-endianess as it is more likely to succeed.
-      const endianess = i === 0 ? 'big' : 'little';
+      const endianess = i === 0 ? Endianness.Little : Endianness.Big;
       try {
-        const [token, key] = await this.cloud.getToken(device.id, endianess);
+        const [token, key] = await this.cloud.getTokenKey(device.id, endianess);
         device.token = token ? token.toString('hex') : undefined;
         device.key = key ? key.toString('hex') : undefined;
         await this.authenticate(device);
@@ -226,6 +239,12 @@ class UiServer extends HomebridgePluginUiServer {
           case DeviceType.DEHUMIDIFIER:
             device['displayName'] = 'Dehumidifier';
             break;
+          case DeviceType.ELECTRIC_WATER_HEATER:
+            device['displayName'] = 'Electric Water Heater';
+            break;
+          case DeviceType.GAS_WATER_HEATER:
+            device['displayName'] = 'Gas Water Heater';
+            break;
           default:
             device['displayName'] = 'Unknown';
             break;

package/package.json

@@ -1,7 +1,7 @@
 {
   "displayName": "Homebridge Midea Platform",
   "name": "homebridge-midea-platform",
-  "version": "0.4.13",
+  "version": "1.0.0",
   "description": "Homebridge plugin for Midea devices",
   "license": "Apache-2.0",
   "repository": {
@@ -24,6 +24,12 @@
     "format": "prettier --log-level warn --write \"**/*.ts\" && npm run lint -- --fix",
     "prepare": "husky install"
   },
+  "lint-staged": {
+    "*.ts": [
+      "prettier --write",
+      "eslint --fix"
+    ]
+  },
   "keywords": [
     "homebridge-plugin"
   ],
@@ -46,6 +52,7 @@
     "eslint-plugin-prettier": "^5.0.1",
     "homebridge": "^1.6.0",
     "husky": "^8.0.0",
+    "lint-staged": "^15.2.2",
     "nodemon": "^3.0.1",
     "prettier": "^3.0.3",
     "rimraf": "^3.0.2",