homebridge-midea-platform 1.2.1 → 1.2.3-beta.0

package/dist/platformUtils.d.ts

@@ -26,6 +26,7 @@ export type DeviceConfig = {
     E2_options: E2Options;
     E3_options: E3Options;
     FA_options: FAOptions;
+    FD_options: FDOptions;
 };
 export declare enum SwingMode {
     NONE = "None",
@@ -112,5 +113,6 @@ type E3Options = {
     smartVolumeSwitch: boolean;
 };
 type FAOptions = unknown;
+type FDOptions = unknown;
 export declare const defaultDeviceConfig: DeviceConfig;
 export {};

package/dist/platformUtils.js

@@ -104,5 +104,6 @@ export const defaultDeviceConfig = {
         smartVolumeSwitch: false,
     },
     FA_options: {},
+    FD_options: {},
 };
 //# sourceMappingURL=platformUtils.js.map

package/dist/platformUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"platformUtils.js","sourceRoot":"","sources":["../src/platformUtils.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,MAAM,aAAa,GAAW;IACnC,eAAe,EAAE,EAAE;IACnB,iBAAiB,EAAE,EAAE;IACrB,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,EAAE;CACZ,CAAC;AAyBF,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,0BAAa,CAAA;IACb,kCAAqB,CAAA;IACrB,sCAAyB,CAAA;IACzB,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAED,MAAM,CAAN,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,uCAAyB,CAAA;AAC3B,CAAC,EAHW,UAAU,KAAV,UAAU,QAGrB;AAED,MAAM,CAAN,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,gCAAa,CAAA;IACb,8CAA2B,CAAA;IAC3B,oDAAiC,CAAA;AACnC,CAAC,EAJW,eAAe,KAAf,eAAe,QAI1B;AAgFD,MAAM,CAAC,MAAM,mBAAmB,GAAiB;IAC/C,EAAE,EAAE,CAAC;IACL,IAAI,EAAE,EAAE;IACR,gBAAgB,EAAE;QAChB,EAAE,EAAE,EAAE;QACN,KAAK,EAAE,EAAE;QACT,GAAG,EAAE,EAAE;QACP,OAAO,EAAE,KAAK;QACd,oBAAoB,EAAE,IAAI;QAC1B,sBAAsB,EAAE,IAAI;QAC5B,iBAAiB,EAAE,KAAK;KACzB;IACD,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,SAAS,CAAC,IAAI;YACpB,cAAc,EAAE,KAAK;YACrB,gBAAgB,EAAE,UAAU,CAAC,QAAQ;SACtC;QACD,cAAc,EAAE,IAAI;QACpB,WAAW,EAAE,KAAK;QAClB,aAAa,EAAE,KAAK;QACpB,SAAS,EAAE,KAAK;QAChB,SAAS,EAAE,KAAK;QAChB,aAAa,EAAE,KAAK;QACpB,eAAe,EAAE,KAAK;QACtB,gBAAgB,EAAE,KAAK;QACvB,aAAa,EAAE;YACb,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,KAAK;SACf;QACD,kBAAkB,EAAE,KAAK;QACzB,eAAe,EAAE,KAAK;QACtB,SAAS,EAAE,KAAK;QAChB,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,CAAC;QACX,UAAU,EAAE,KAAK;QACjB,iBAAiB,EAAE,KAAK;QACxB,YAAY,EAAE,KAAK;KACpB;IACD,UAAU,EAAE;QACV,iBAAiB,EAAE,KAAK;QACxB,YAAY,EAAE,KAAK;QACnB,cAAc,EAAE,KAAK;QACrB,UAAU,EAAE,KAAK;QACjB,eAAe,EAAE,eAAe,CAAC,IAAI;QACrC,WAAW,EAAE,EAAE;QACf,WAAW,EAAE,EAAE;QACf,YAAY,EAAE,CAAC;QACf,cAAc,EAAE,CAAC;KAClB;IACD,UAAU,EAAE;QACV,KAAK,EAAE,KAAK;QACZ,KAAK,EAAE,KAAK;QACZ,WAAW,EAAE,KAAK;QAClB,SAAS,EAAE,KAAK;QAChB,YAAY,EAAE,KAAK;QACnB,SAAS,EAAE,KAAK;KACjB;IACD,UAAU,EAAE,EAAE;IACd,UAAU,EAAE,EAAE;IACd,UAAU,EAAE;QACV,QAAQ,EAAE,MAAM;QAChB,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,CAAC;QACX,qBAAqB,EAAE,KAAK;QAC5B,sBAAsB,EAAE,KAAK;KAC9B;IACD,UAAU,EAAE;QACV,eAAe,EAAE,KAAK;QACtB,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,CAAC;QACX,kBAAkB,EAAE,KAAK;QACzB,gBAAgB,EAAE,KAAK;QACvB,mBAAmB,EAAE,KAAK;QAC1B,mBAAmB,EAAE,KAAK;QAC1B,iBAAiB,EAAE,KAAK;KACzB;IACD,UAAU,EAAE,EAAE;CACf,CAAC"}
+{"version":3,"file":"platformUtils.js","sourceRoot":"","sources":["../src/platformUtils.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,MAAM,aAAa,GAAW;IACnC,eAAe,EAAE,EAAE;IACnB,iBAAiB,EAAE,EAAE;IACrB,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,EAAE;CACZ,CAAC;AA0BF,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,0BAAa,CAAA;IACb,kCAAqB,CAAA;IACrB,sCAAyB,CAAA;IACzB,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAED,MAAM,CAAN,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,uCAAyB,CAAA;AAC3B,CAAC,EAHW,UAAU,KAAV,UAAU,QAGrB;AAED,MAAM,CAAN,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,gCAAa,CAAA;IACb,8CAA2B,CAAA;IAC3B,oDAAiC,CAAA;AACnC,CAAC,EAJW,eAAe,KAAf,eAAe,QAI1B;AAkFD,MAAM,CAAC,MAAM,mBAAmB,GAAiB;IAC/C,EAAE,EAAE,CAAC;IACL,IAAI,EAAE,EAAE;IACR,gBAAgB,EAAE;QAChB,EAAE,EAAE,EAAE;QACN,KAAK,EAAE,EAAE;QACT,GAAG,EAAE,EAAE;QACP,OAAO,EAAE,KAAK;QACd,oBAAoB,EAAE,IAAI;QAC1B,sBAAsB,EAAE,IAAI;QAC5B,iBAAiB,EAAE,KAAK;KACzB;IACD,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,SAAS,CAAC,IAAI;YACpB,cAAc,EAAE,KAAK;YACrB,gBAAgB,EAAE,UAAU,CAAC,QAAQ;SACtC;QACD,cAAc,EAAE,IAAI;QACpB,WAAW,EAAE,KAAK;QAClB,aAAa,EAAE,KAAK;QACpB,SAAS,EAAE,KAAK;QAChB,SAAS,EAAE,KAAK;QAChB,aAAa,EAAE,KAAK;QACpB,eAAe,EAAE,KAAK;QACtB,gBAAgB,EAAE,KAAK;QACvB,aAAa,EAAE;YACb,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,KAAK;SACf;QACD,kBAAkB,EAAE,KAAK;QACzB,eAAe,EAAE,KAAK;QACtB,SAAS,EAAE,KAAK;QAChB,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,CAAC;QACX,UAAU,EAAE,KAAK;QACjB,iBAAiB,EAAE,KAAK;QACxB,YAAY,EAAE,KAAK;KACpB;IACD,UAAU,EAAE;QACV,iBAAiB,EAAE,KAAK;QACxB,YAAY,EAAE,KAAK;QACnB,cAAc,EAAE,KAAK;QACrB,UAAU,EAAE,KAAK;QACjB,eAAe,EAAE,eAAe,CAAC,IAAI;QACrC,WAAW,EAAE,EAAE;QACf,WAAW,EAAE,EAAE;QACf,YAAY,EAAE,CAAC;QACf,cAAc,EAAE,CAAC;KAClB;IACD,UAAU,EAAE;QACV,KAAK,EAAE,KAAK;QACZ,KAAK,EAAE,KAAK;QACZ,WAAW,EAAE,KAAK;QAClB,SAAS,EAAE,KAAK;QAChB,YAAY,EAAE,KAAK;QACnB,SAAS,EAAE,KAAK;KACjB;IACD,UAAU,EAAE,EAAE;IACd,UAAU,EAAE,EAAE;IACd,UAAU,EAAE;QACV,QAAQ,EAAE,MAAM;QAChB,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,CAAC;QACX,qBAAqB,EAAE,KAAK;QAC5B,sBAAsB,EAAE,KAAK;KAC9B;IACD,UAAU,EAAE;QACV,eAAe,EAAE,KAAK;QACtB,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,CAAC;QACX,kBAAkB,EAAE,KAAK;QACzB,gBAAgB,EAAE,KAAK;QACvB,mBAAmB,EAAE,KAAK;QAC1B,mBAAmB,EAAE,KAAK;QAC1B,iBAAiB,EAAE,KAAK;KACzB;IACD,UAAU,EAAE,EAAE;IACd,UAAU,EAAE,EAAE;CACf,CAAC"}

package/docs/fd.md

@@ -0,0 +1,3 @@
+# Humidifier
+
+Humidifier currently does not have any available options.

package/homebridge-ui/server.js

@@ -0,0 +1,381 @@
+/***********************************************************************
+ * Midea Homebridge platform Custom UI server-side script
+ *
+ * Copyright (c) 2023 Kovalovszky Patrik, https://github.com/kovapatrik
+ * Copyright (c) 2023 David Kerr, https://github.com/dkerr64
+ *
+ * Based on https://github.com/homebridge/plugin-ui-utils
+ *
+ */
+import {
+  HomebridgePluginUiServer,
+  RequestError,
+} from "@homebridge/plugin-ui-utils";
+import Discover from "../dist/core/MideaDiscover.js";
+import CloudFactory from "../dist/core/MideaCloud.js";
+import {
+  DeviceType,
+  TCPMessageType,
+  ProtocolVersion,
+  Endianness,
+} from "../dist/core/MideaConstants.js";
+import { LocalSecurity, ProxiedSecurity } from "../dist/core/MideaSecurity.js";
+import { PromiseSocket } from "../dist/core/MideaUtils.js";
+import { defaultConfig, defaultDeviceConfig } from "../dist/platformUtils.js";
+import { createRequire } from "node:module";
+const require = createRequire(import.meta.url);
+
+import _ from "lodash";
+
+const DEFAULT_ACCOUNT = [
+  BigInt(
+    "39182118275972017797890111985649342047468653967530949796945843010512",
+  ),
+  BigInt(
+    "29406100301096535908214728322278519471982973450672552249652548883645",
+  ),
+  BigInt(
+    "39182118275972017797890111985649342050088014265865102175083010656997",
+  ),
+];
+
+/*********************************************************************
+ * Logger
+ * Lightweight log class to mimic the homebridge log capability
+ */
+class Logger {
+  _debug;
+  _Reset = "\x1b[0m";
+  _Bright = "\x1b[1m";
+  _Dim = "\x1b[2m";
+
+  _FgBlack = "\x1b[30m";
+  _FgRed = "\x1b[31m";
+  _FgGreen = "\x1b[32m";
+  _FgYellow = "\x1b[33m";
+  _FgBlue = "\x1b[34m";
+  _FgMagenta = "\x1b[35m";
+  _FgCyan = "\x1b[36m";
+  _FgWhite = "\x1b[37m";
+  _FgGray = "\x1b[90m";
+
+  constructor(uiDebug = false) {
+    this._debug = uiDebug;
+  }
+  info(str) {
+    console.info(this._FgWhite + str + this._Reset);
+  }
+  warn(str) {
+    console.warn(this._FgYellow + str + this._Reset);
+  }
+  error(str) {
+    console.error(this._FgRed + str + this._Reset);
+  }
+  debug(str) {
+    if (this._debug) {
+      console.debug(this._FgGray + str + this._Reset);
+    }
+  }
+  setDebugEnabled(enabled = true) {
+    this._debug = enabled;
+  }
+}
+
+/*********************************************************************
+ * UIServer
+ * Main server-side script called when Custom UI client sends requests
+ */
+class UiServer extends HomebridgePluginUiServer {
+  cloud;
+  promiseSocket;
+  security;
+  logger;
+  config;
+
+  constructor() {
+    super();
+    // Obtain the plugin configuration from homebridge config JSON file.
+    const config = require(this.homebridgeConfigPath).platforms.find(
+      (obj) => obj.platform === "midea-platform",
+    );
+    this.logger = new Logger(config?.uiDebug ?? false);
+    this.logger.info("Custom UI created.");
+    this.logger.debug(`ENV:\n${JSON.stringify(process.env, null, 2)}`);
+    this.security = new LocalSecurity();
+    this.promiseSocket = new PromiseSocket(
+      this.logger,
+      config?.uiDebug ?? false,
+    );
+
+    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();
+          }
+        } 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.",
+          );
+        }
+      },
+    );
+
+    this.onRequest("/mergeToDefault", async ({ config }) => {
+      _.defaultsDeep(config, defaultConfig);
+      config.devices.forEach((device) => {
+        _.defaultsDeep(device, defaultDeviceConfig);
+      });
+      this.config = config;
+      this.logger.setDebugEnabled(config.uiDebug ? config.uiDebug : false);
+      this.logger.debug(`Merged config:\n${JSON.stringify(config, null, 2)}`);
+      return config;
+    });
+
+    this.onRequest("/getDefaults", async () => {
+      return {
+        defaultConfig,
+        defaultDeviceConfig,
+      };
+    });
+
+    this.onRequest("/discover", async ({ ip }) => {
+      try {
+        const devices = await this.blockingDiscover(ip);
+        for (const device of devices) {
+          if (device.version === ProtocolVersion.V3 && this.cloud.loggedIn) {
+            await this.getNewCredentials(device);
+          } else {
+            device.token = "";
+            device.key = "";
+          }
+        }
+        this.logger.debug(`All devices:\n${JSON.stringify(devices, null, 2)}`);
+        return devices
+          .filter((a) => Object.keys(a).length > 0)
+          .sort((a, b) => a.ip.localeCompare(b.ip));
+      } catch (e) {
+        const msg = e instanceof Error ? e.stack : e;
+        throw new RequestError(`Device discovery failed:\n${msg}`);
+      }
+    });
+
+    this.onRequest("/downloadLua", async ({ deviceType, deviceSn }) => {
+      try {
+        if (!this.cloud || !(this.cloud instanceof ProxiedSecurity)) {
+          this.pushEvent("showToast", {
+            success: true,
+            msg: "Currently used cloud provider doesn't support Lua downloading, using the default profile now...",
+          });
+          const registeredApp = "Midea SmartHome (MSmartHome)";
+          const username = Buffer.from(
+            (DEFAULT_ACCOUNT[0] ^ DEFAULT_ACCOUNT[1]).toString(16),
+            "hex",
+          ).toString("ascii");
+          const password = Buffer.from(
+            (DEFAULT_ACCOUNT[0] ^ DEFAULT_ACCOUNT[2]).toString(16),
+            "hex",
+          ).toString("ascii");
+          this.cloud = CloudFactory.createCloud(
+            username,
+            password,
+            registeredApp,
+          );
+          await this.cloud.login();
+        }
+        const lua = await this.cloud.getProtocolLua(deviceType, deviceSn);
+        return lua;
+      } catch (e) {
+        const msg = e instanceof Error ? e.stack : e;
+        throw new RequestError(`Download Lua failed:\n${msg}`);
+      }
+    });
+
+    // inform client-side script that we are ready to receive requests.
+    this.ready();
+  }
+
+  /*********************************************************************
+   * getNewCredentials
+   * Obtains token/key credentials and saves them in device object.
+   */
+  async getNewCredentials(device) {
+    let connected = false;
+    let i = 0;
+    this.logger.info(`[${device.name}] Retrieve credentials.`);
+    // Need to make two passes to obtain token/key credentials as they may work or not
+    // depending on byte order (little or big-endian).  Exit the loop as soon as one
+    // works or having tried both.
+    while (i <= 1 && !connected) {
+      // Start with big-endianess as it is more likely to succeed.
+      const endianess = i === 0 ? Endianness.Little : Endianness.Big;
+      try {
+        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);
+        connected = true;
+      } catch (e) {
+        //const msg = e instanceof Error ? e.stack : e;
+        this.logger.debug(
+          `[${device.name}] Getting token and key with ${endianess}-endian is not successful.\n${e}`,
+        );
+        // if failed then reset token/key
+        device.token = undefined;
+        device.key = undefined;
+      }
+      i++;
+    }
+    this.logger.debug(
+      `[${device.name}] Token: ${device.token}, Key: ${device.key}`,
+    );
+    return;
+  }
+
+  /*********************************************************************
+   * authenticate
+   * authenticate the token/key pair with the device to check that it works.
+   */
+  async authenticate(device) {
+    if (!(device.token && device.key)) {
+      throw new Error(`[${device.name}] Token or key is missing!`);
+    }
+    await this.promiseSocket.connect(device.port, device.ip);
+    // Wrap next block in try/finally so we can destroy the socket if error occurs
+    // let thrown errors cascade up.
+    try {
+      const request = this.security.encode_8370(
+        Buffer.from(device.token, "hex"),
+        TCPMessageType.HANDSHAKE_REQUEST,
+      );
+      await this.promiseSocket.write(request);
+      const response = await this.promiseSocket.read();
+      if (response) {
+        if (response.length < 20) {
+          this.logger.debug(
+            `[${device.name}] Authenticate error when receiving data from ${device.ip}:${device.port}. (Data length: ${
+              response.length
+            })\n${JSON.stringify(response)}`,
+          );
+          throw Error(
+            `[${device.name}] Authenticate error when receiving data from ${device.ip}:${device.port}. (Data length mismatch)`,
+          );
+        }
+        const resp = response.subarray(8, 72);
+        this.security.tcp_key_from_resp(resp, Buffer.from(device.key, "hex"));
+      } else {
+        throw Error(
+          `[${device.name}] Authenticate error when receiving data from ${device.ip}:${device.port}.`,
+        );
+      }
+    } finally {
+      this.promiseSocket.destroy();
+    }
+  }
+
+  /*********************************************************************
+   * blockingDiscover
+   * broadcast to network(s) to discover new devices, obtain credentials
+   * for each as discovered.
+   */
+  async blockingDiscover(ipAddrs = undefined) {
+    let devices = [];
+    this.logger.debug(
+      `[blockingDiscover] IP addresses: ${JSON.stringify(ipAddrs)}`,
+    );
+    const discover = new Discover(this.logger);
+    return new Promise((resolve, reject) => {
+      this.logger.info("Start device discovery...");
+      this.pushEvent("showToast", {
+        success: true,
+        msg: "Start device discovery",
+      });
+      // If IP addresses provided then probe them directly
+      ipAddrs?.forEach((ip) => {
+        discover.discoverDeviceByIP(ip);
+      });
+      // And then send broadcast to network(s)
+      discover.startDiscover();
+
+      discover.on("device", async (device) => {
+        switch (device.type) {
+          case DeviceType.AIR_CONDITIONER:
+            device.displayName = "Air Conditioner";
+            break;
+          case DeviceType.DEHUMIDIFIER:
+            device.displayName = "Dehumidifier";
+            break;
+          case DeviceType.HEAT_PUMP_WIFI_CONTROLLER:
+            device.displayName = "Heat Pump WiFi Controller";
+          case DeviceType.FRONT_LOAD_WASHER:
+            device.displayName = "Front Load Washer";
+            break;
+          case DeviceType.DISHWASHER:
+            device.displayName = "Dishwasher";
+            break;
+          case DeviceType.ELECTRIC_WATER_HEATER:
+            device.displayName = "Electric Water Heater";
+            break;
+          case DeviceType.GAS_WATER_HEATER:
+            device.displayName = "Gas Water Heater";
+            break;
+          case DeviceType.FAN:
+            device.displayName = "Fan";
+            break;
+          case DeviceType.HUMIDIFIER:
+            device.displayName = "Humidifier";
+            break;
+          case DeviceType.UNKNOWN:
+          default:
+            device.displayName = "Unknown";
+            break;
+        }
+        devices.push(device);
+        // too verbose to post every device as found...
+        // this.pushEvent('showToast', { success: true, msg: `Discovered ${device.name} at ${device.ip}`, device: device });
+      });
+
+      discover.on("retry", (nTry, nDevices) => {
+        this.logger.info("Device discovery complete.");
+        this.pushEvent("showToast", {
+          success: true,
+          msg: `Continuing to search for devices (${nDevices} found)`,
+        });
+      });
+
+      discover.on("complete", () => {
+        this.logger.info("Device discovery complete.");
+        this.pushEvent("showToast", {
+          success: true,
+          msg: "Discovery complete",
+        });
+        resolve(devices);
+      });
+    });
+  }
+}
+
+// start the instance of the class
+(() => {
+  return new UiServer();
+})();

package/package.json

@@ -2,7 +2,7 @@
   "displayName": "Homebridge Midea Platform",
   "name": "homebridge-midea-platform",
   "type": "module",
-  "version": "1.2.1",
+  "version": "1.2.3-beta.0",
   "description": "Homebridge plugin for Midea devices",
   "license": "Apache-2.0",
   "repository": {