homebridge-myplace 2.3.3 → 2.3.5

package/CHANGELOG.md

@@ -1,3 +1,4 @@
 ### Homebridge-myplace - An independent plugin for Homebridge bringing Advantage Air MyPlace system, its smaller siblings (E-zone, MyAir, MyAir4, etc) and its cousins (e.g. Fujitsu AnywAir) to Homekit
-##### v2.3.3 (18-11-2025)
-##### (1) Bug fix - to fix an error of an undefined variable.
+
+##### v2.3.5 (14-01-2026)
+##### (1) Determine device accessibility by validating the port's availability rather than initiating a direct access request. This approach prevents multiple access attempts occuring in rapid succession during the stup porcess.

package/Cmd5Platform.js

@@ -123,7 +123,7 @@ class Cmd5Platform
          this.processNewCharacteristicDefinitions( );
 
          // scan the platform accessories (devices) to identify which ones to be restored from cache
-         this.log.info( chalk.yellow( "***Scanning the config and the cache for accessories to be removed or restored from cache..." ) );
+         this.log.info( chalk.yellow( "*** Scanning the config and the cache for accessories to be removed or restored from cache..." ) );
          this.scanToBeRemovedOrRestored( this.log );
 
          // Any accessory NOT to be restored should be removed, find them

package/RUNNING_CHANGELOG.md

@@ -1,4 +1,12 @@
 ### Homebridge-myplace - An independent plugin for Homebridge bringing Advantage Air MyPlace system, its smaller siblings (E-zone, MyAir, MyAir4, etc) and its cousins (e.g. Fujitsu AnywAir) to Homekit
+
+##### v2.3.5 (14-01-2026)
+##### (1) Determine device accessibility by validating the port's availability rather than initiating a direct access request. This approach prevents multiple access attempts occuring in rapid succession during the stup porces>
+
+##### v2.3.4 (05-12-2025)
+##### (1) Ensure that all valid devices defined in the configuration are processed, even when one or more configured devices are invalid or inaccessible.
+##### (2) Improved the clarity and consistency of log messages.
+
 ##### v2.3.3 (18-11-2025)
 ##### (1) Bug fix - to fix an error of an undefined variable.
 

package/package.json

@@ -1,7 +1,7 @@
 {
    "name": "homebridge-myplace",
    "description": "Exec Plugin bringing Advanatge Air MyPlace system to Homekit",
-   "version": "2.3.3",
+   "version": "2.3.5",
    "license": "MIT",
    "author": {
       "name": "Ung Sing"

package/utils/createMyPlaceConfig.js

@@ -1,7 +1,7 @@
 // This async function is to generate a complete configuration file needed for the myPlace plugin
 // It can handle up to 3 independent myPlace (BB) systems
 
-async function createMyPlaceConfig(config, pluginPath) {
+async function createMyPlaceConfig(config, IPs, pluginPath, log) {
   const path = require("path");
 
   const MYPLACE_SH_PATH = path.join(pluginPath, "MyPlace.sh");
@@ -415,18 +415,6 @@ async function createMyPlaceConfig(config, pluginPath) {
     };
   }
 
-  // Helper regex to validate IP and IP:port
-  const ipRegex = /^(\d{1,3}\.){3}\d{1,3}$/;
-  const ipPortRegex = /^(\d{1,3}\.){3}\d{1,3}:\d+$/;
-
-  // Validate and normalize IPs
-  function normalizeIP( ip, port = 2025 ) {
-    if (!ip || ip === "undefined" ) return "";
-    if (ipRegex.test(ip)) return `${ip}:${port}`;
-    if (ipPortRegex.test(ip)) return ip;
-    throw new Error(`ERROR: Device ${n + 1} - the specified IP address ${ip} is in wrong format`);
-  }
-
   // Determine number of tablets/devices
   let noOfTablets = config.devices.length;
 
@@ -440,31 +428,40 @@ async function createMyPlaceConfig(config, pluginPath) {
     } else {
       AAname = config.devices[n]?.name || `Aircon${n + 1}`;
     }
-    const AAIP = config.devices[n]?.ipAddress;
-    const AAport = config.devices[n]?.port || 2025;
+
+    const ip = IPs[n];
+    if (ip === "undefined") continue;
+
     const extraTimers = config.devices[n]?.extraTimers || false;
     const debug = config.devices[n]?.debug || false;
     const queue=["AAA", "AAB", "AAC"][n]
 
-    const ip = normalizeIP(AAIP, AAport);
     const IPA = `\${AAIP${n + 1}}`
 
-    // if (!ip || ip === "undefined" || !ipRegex.test(ip)) continue;
-
     // Fetch system data
     let myAirData;
     try {
-      const response = await fetch(`http://${ip}/getSystemData`, {timeout: 45000});
+      const response = await fetch(`http://${ip}/getSystemData`);
       if (!response.ok) throw new Error(`HTTP error ${response.status}`);
       myAirData = await response.json();
     } catch {
-      throw new Error(`ERROR: Device ${n + 1} is inaccessible - not power ON or wrong IP ${AAIP} or wrong port ${AAport}`);
+      if (n === noOfTablets - 1) {
+        throw new Error(`Device ${n + 1} with IP ${ip} is inaccessible (power OFF or wrong IP or wrong port).`);
+      } else {
+        log.warn(`⚠️  Device ${n + 1} with IP ${ip} is inaccessible (power OFF or wrong IP or wrong port).`);
+        continue;
+      }
     }
 
     // Extract system info (use safe chaining or checks as needed)
     const sysName = (myAirData.system?.name ?? "").replace(/ /g, "_").replace(/['"]/g, "");
     if (!sysName) {
-      throw new Error("ERROR: failed to get system info from your AdvantageAir system!");
+      if (n === noOfTablets - 1) {
+        throw new Error("Failed to get system info from your device ${n + 1}!");
+      } else {
+        log.error("⚠️  Failed to get system info from your device ${n + 1}!");
+        continue;
+      }
     }
     const sysType = (myAirData.system?.sysType ?? "").replace(/ /g, "_").replace(/"/g, "");
     const tspModel = (myAirData.system?.tspModel ?? "").replace(/ /g, "_").replace(/"/g, "");

package/utils/devicesAutoDiscovery.js

@@ -47,7 +47,7 @@ async function devicesAutoDiscovery(config, log, portsToTry) {
     }
   }
 
-  return { foundDevices, portsToTry };
+  return foundDevices;
 }
 
 module.exports = { devicesAutoDiscovery };

package/utils/isIpAccessible.js

@@ -0,0 +1,63 @@
+const net = require("net");
+
+// Simple port check (returns true/false)
+function isPortReachable( ip ) {
+  return new Promise((resolve) => {
+    const socket = new net.Socket();
+
+    socket.setTimeout(1000);
+
+    socket.on("connect", () => {
+      socket.destroy();
+      resolve(true);
+    });
+
+    socket.on("timeout", () => {
+      socket.destroy();
+      resolve(false);
+    });
+
+    socket.on("error", () => {
+      resolve(false);
+    });
+
+    const [ipStr, portStr] = ip.split(":");
+    const port = Number(portStr);
+
+    socket.connect(port, ipStr);
+  });
+}
+
+// If port is not reachable, retry up to 5 times...
+async function isIpAccessible( ip, i, noOfDevices, log ) {
+
+  for (let attempt = 0; attempt < 6; attempt++) {
+
+    try {
+      const reachable = await isPortReachable( ip );
+
+      if (reachable) {
+        return true;  // success
+      } else {
+        throw new Error("Port unreachable");
+      }
+
+    } catch (err) {
+
+      if (attempt === 5) {
+        log.warn(`⚠️  All 5 retry attempts on Device ${i + 1} failed!`);
+        return false;
+      }
+
+      log.warn(
+        `⚠️  Device ${i + 1}/${noOfDevices} with IP ${ip} is inaccessible. ` +
+        `Retrying (${attempt + 1}/5) in 5s...`
+      );
+
+      // wait 5 seconds before retry
+      await new Promise(resolve => setTimeout(resolve, 5000));
+    }
+  }
+}
+
+module.exports = { isIpAccessible };

package/utils/updateConfig.js

@@ -1,4 +1,5 @@
 // Update myplaceConfig
+const { isIpAccessible } = require("./isIpAccessible");
 const { devicesAutoDiscovery } = require("./devicesAutoDiscovery");
 const { createMyPlaceConfig } = require("./createMyPlaceConfig");
 const { readConfig } = require("./readConfig");
@@ -9,6 +10,8 @@ function delay(ms) {
   return new Promise(resolve => setTimeout(resolve, ms));
 }
 
+const isValidIp = (value) => /^(?:\d{1,3}\.){3}\d{1,3}$/.test(value);
+
 async function updateConfig(config, log, storagePath, pluginPath) {
   // Enforce maxAccessories: default 149 (Homebridge hard limit)
   const maxAccessories = (typeof config.maxAccessories === "number"
@@ -35,145 +38,113 @@ async function updateConfig(config, log, storagePath, pluginPath) {
     });
   }
 
+  let IPs = [];
   if (!Array.isArray(config.devices) || devicesMissingIPs) {
-    log.warn(chalk.yellow("⚠️  No devices found in the original config — triggering auto-discovery..."));
+    log.warn(`⚠️  No devices found in the original config!`);
+    log.warn(`🔍 *** Triggering device auto-discovery...`);
     doDevicesAutoDiscovery = true;
+  } else {
+    // check if the device(s) in config is accessbile or not with retry up to 5 times, if not, set it to "undefined".
+    log.warn(`🕵️  *** Validating device IP address(es)...`);
+    const noOfDevices = config.devices.length;
+    for ( let i = 0; i < noOfDevices; i++ ) {
+      const ip = config.devices[i].ipAddress;
+      const port = config.devices[i].port || 2025;
+      if (ip) {
+        IPs.push(`${ip}:${port}`);
+        if ( !isValidIp(ip) ) {
+          log.warn(`⚠️  Device ${i + 1}/${noOfDevices} with IP ${ip}:${port} has its IP in wrong format!`);
+          log.warn(`⚠️  Device ${i + 1}/${noOfDevices} will NOT be processed!`);
+          IPs[i] = "undefined";
+        } else {
+          const isIpAccessibleTest = await isIpAccessible( `${ip}:${port}`, i, noOfDevices, log );
+          if ( !isIpAccessibleTest ) {
+            log.warn(`⚠️  Device ${i + 1}/${noOfDevices} with IP ${ip}:${port} is inaccessible! May be power OFF, wrong IP or wrong port.`);
+            log.warn(`⚠️  Device ${i + 1}/${noOfDevices} will NOT be processed!`);
+            IPs[i] = "undefined";
+          } else {
+            log.info(`✅ Device ${i + 1}/${noOfDevices} is reachable!`);
+          }
+        }
+      } else {
+        IPs.push("undefined");
+      }
+    }
+    // check that not all IPs are "undefined", if so, do devucesAutoDiscovery...
+    if (IPs.every((el) => el === "undefined")) {
+      // final attempt to auto discover a Bond device
+      log.warn(`⚠️  No specified device is accessible on the LAN network!`);
+      log.warn(`🔍 *** Triggering device auto-discovery...`);
+      doDevicesAutoDiscovery = true;
+    }
   }
 
-  while (portsToTry.length > 0) {
-    // Auto-discovery stage
-    if (doDevicesAutoDiscovery) {
-      log.info("🔍 Ports to scan for devices:", portsToTry);
-      const { foundDevices, portsToTry: remainingPorts } =
-        await devicesAutoDiscovery(config, log, portsToTry);
+  // Auto-discovery stage
+  if ( doDevicesAutoDiscovery ) {
+    log.info("🔍 Ports to scan for devices:", portsToTry);
+    const foundDevices = await devicesAutoDiscovery(config, log, portsToTry);
 
-      portsToTry = remainingPorts;
-      devicesAutoDiscoveryCounter++;
+    const noOfDevices = foundDevices.length;
+    if (noOfDevices > 0) {
+      config.devices = foundDevices;
+      log.info("Devices config:\n" + JSON.stringify(config.devices, null, 2));
 
-      if (foundDevices.length > 0) {
-        config.devices = foundDevices;
-        log.info("Devices config:\n" + JSON.stringify(config.devices, null, 2));
+      // Store found devices IPs
+      for ( let i = 0; i < noOfDevices; i++ ) {
+        IPs[i] = foundDevices[i].ipAddress + ':' + foundDevices[i].port;
+      }
+    } else {
+      log.warn("⚠️  No devices found on any ports.");
+      // check if an existing config.json is present in this.storagePath/.myplace, if so use it
+      existingConfig = readConfig( storagePath, log );
+      if (existingConfig) {
+        log.warn("⚠️  Proceeding with existing config — all cached accessories will be restored.");
+        return existingConfig;
       } else {
-        log.warn("⚠️  No devices found on any ports.");
-        // check if an existing config.json is present in this.storagePath/.myplace, if so use it
-        existingConfig = readConfig( storagePath, log );
-        if (existingConfig) {
-          log.warn("⚠️  Proceeding with existing config — all cached accessories will be restored.");
-          return existingConfig;
-        } else {
-          log.warn("⚠️  Proceeding with original config — no accessories will be created and cached accessories will be removed!");
-          return config;
-        }
+        log.warn("⚠️  Proceeding with original config — no accessories will be created and cached accessories will be removed!");
+        return config;
       }
     }
+  }
 
-    // Run ConfigCreator
-    log.info(chalk.yellow(
-      devicesAutoDiscoveryCounter > 1
-        ? "Running createMyPlaceConfig again..."
-        : "Running createMyPlaceConfig..."
-    ));
-
-    try {
-      const myplaceConfig = await createMyPlaceConfig(config, pluginPath);
-      log.info(chalk.green("✅ DONE! createMyPlaceConfig completed successfully!"));
-      log.debug("Updated MyPlace config:\n" + JSON.stringify(myplaceConfig, null, 2));
-
-      // Enforce accessories limit
-      if (Array.isArray(myplaceConfig.accessories) &&
-          myplaceConfig.accessories.length > maxAccessories) {
-        log.warn(`⚠️ Configured accessories exceed limit of ${maxAccessories}. ` +
-                 `Only the first ${maxAccessories} will be bridged, ` +
-                 `${myplaceConfig.accessories.length - maxAccessories} ignored.`);
-        log.info("Note: Homebridge only allows a maximum of 149 bridged accessories per bridge.");
-
-        myplaceConfig.accessories = myplaceConfig.accessories.slice(0, maxAccessories);
-      }
+  // Run CreateMyPlaceConfig
+  log.warn(`*** Running createMyPlaceConfig...`);
+  try {
+    const noOfDevices = IPs.length;
+    const noOfDevicesProcessed = IPs.filter(ip => ip !== "undefined").length;
 
-      return myplaceConfig;
-    } catch (err) {
-      const autoDiscoveryErrors = ["wrong format", "inaccessible"];
-      const isInaccessibleError = err.message.toLowerCase().includes("inaccessible");
-
-      doDevicesAutoDiscovery = autoDiscoveryErrors.some(e =>
-        err.message.toLowerCase().includes(e)
-      );
-
-      if (doDevicesAutoDiscovery && portsToTry.length > 0) {
-        log.warn(`⚠️ ${err.message}`);
-
-        // Special handling for "inaccessible" errors - wait 5 seconds and retry up to 5 times
-        if (isInaccessibleError) {
-          const maxRetries = 5;
-          let retryCount = 0;
-          let retrySuccess = false;
-          let lastRetryError = err;
-
-          let deviceNumber = 1;
-          let ipAddress;
-          const match = err.message.match(/Device (\d+).*?IP ([\d.]+)/);
-          if (match) {
-            deviceNumber = parseInt(match[1], 10);
-            ipAddress = match[2];
-          }
+    const myplaceConfig = await createMyPlaceConfig(config, IPs, pluginPath, log);
+    if (doDevicesAutoDiscovery) {
+      log.info(`✅ DONE! createMyPlaceConfig completed successfully for ${noOfDevicesProcessed}/${noOfDevices} "auto-discovered" device(s)!`);
+    } else {
+      log.info(`✅ DONE! createMyPlaceConfig completed successfully for ${noOfDevicesProcessed}/${noOfDevices} device(s)!`);
+    }
 
-          while (retryCount < maxRetries && !retrySuccess) {
-            retryCount++;
-            log.info(chalk.yellow(`⏳ Device ${deviceNumber} with IP ${ipAddress} is inaccessible, waiting 5 seconds before retry (${retryCount}/${maxRetries})...`));
-            await delay(5000);
-
-            // Retry createMyPlaceConfig immediately without auto-discovery
-            try {
-              log.info(chalk.yellow(`🔄 Retrying createMyPlaceConfig (attempt ${retryCount}/${maxRetries})...`));
-              const myplaceConfig = await createMyPlaceConfig(config, pluginPath);
-              log.info(chalk.green(`✅ SUCCESS! createMyPlaceConfig completed after ${retryCount} retry attempt(s)!`));
-
-              // Enforce accessories limit on retry success
-              if (Array.isArray(myplaceConfig.accessories) &&
-                  myplaceConfig.accessories.length > maxAccessories) {
-                log.warn(`⚠️ Configured accessories exceed limit of ${maxAccessories}. ` +
-                         `Only the first ${maxAccessories} will be bridged, ` +
-                         `${myplaceConfig.accessories.length - maxAccessories} ignored.`);
-                myplaceConfig.accessories = myplaceConfig.accessories.slice(0, maxAccessories);
-              }
-
-              return myplaceConfig;
-            } catch (retryErr) {
-              lastRetryError = retryErr;
-              log.warn(`⚠️ Retry attempt ${retryCount}/${maxRetries} failed: ${retryErr.message}`);
-
-              // Check if it's still an "inaccessible" error for the next retry
-              if (!retryErr.message.toLowerCase().includes("inaccessible")) {
-                log.warn("⚠️ Error type changed, stopping retries and proceeding to auto-discovery...");
-                break;
-              }
-            }
-          }
+    log.debug("Updated MyPlace config:\n" + JSON.stringify(myplaceConfig));
 
-          // If we exhausted all retries and still failed, log the final error
-          if (!retrySuccess) {
-            log.error(`❌ All ${maxRetries} retry attempts failed. Last error: ${lastRetryError.message}`);
-          }
-        }
+    // Enforce accessories limit
+    if (Array.isArray(myplaceConfig.accessories) &&
+        myplaceConfig.accessories.length > maxAccessories) {
+      log.warn(`⚠️  Configured accessories exceed limit of ${maxAccessories}. ` +
+               `Only the first ${maxAccessories} will be bridged, ` +
+               `${myplaceConfig.accessories.length - maxAccessories} ignored.`);
+      log.info("Note: Homebridge only allows a maximum of 149 bridged accessories per bridge.");
 
-        if (devicesAutoDiscoveryCounter === 0) {
-          log.info(chalk.yellow("🔍 Starting devices auto-discovery..."));
-        } else {
-          log.info(chalk.yellow(`🔄 Retrying devices auto-discovery (attempt #${devicesAutoDiscoveryCounter + 1})...`));
-        }
-      } else {
-        log.error(`❌ ${err.message}`);
-        log.warn("⚠️  No devices found in your network!");
-        // check if an existing config.json is present in this.storagePath/.myplace, if so use it
-        existingConfig = readConfig( storagePath, log );
-        if (existingConfig) {
-          log.warn("⚠️  Proceeding with existing config — all cached accessories will be restored.");
-          return existingConfig;
-        }
-        log.warn("⚠️  Proceeding with original config — no accessories will be created and cached accessories will be removed!");
-        return config;
-      }
+      myplaceConfig.accessories = myplaceConfig.accessories.slice(0, maxAccessories);
+    }
+
+    return myplaceConfig;
+  } catch (err) {
+    log.warn(`⚠️  ${err.message}`);
+    log.warn(`⚠️  Config not updated!`);
+    // check if an existing config.json is present in this.storagePath/.myplace, if so use it
+    existingConfig = readConfig( storagePath, log );
+    if (existingConfig) {
+      log.warn(`⚠️  Proceeding with existing config — all cached accessories will be restored.`);
+      return existingConfig;
     }
+    log.warn(`⚠️  Proceeding with original config — no accessories will be created and cached accessories will be removed!`);
+    return config;
   }
 
   return config; // fallback