homebridge-myplace 2.2.3 → 2.3.1

package/CHANGELOG.md

@@ -1,5 +1,5 @@
 ### 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.2.3 (2025-09-11)
+##### v2.3.1 (2025-10-22)
 
-###### (1) Increased maxBuffer to 5MB to resolve JOSN truncation issue               
-###### (2) Added debugging switch for the plugin
+###### (1) Allow up to 5 retries of inaccessible device before proceeding to auto-discovery.
+###### (2) Minor bug fixes.

package/Cmd5Platform.js

@@ -4,6 +4,8 @@
 const { getAccessoryName,
         getAccessoryDisplayName } = require( "./utils/getAccessoryNameFunctions" );
 const { parseAddQueueTypes } = require( "./Cmd5PriorityPollingQueue" );
+const { removeTempDir } = require( "./utils/removeTempDir" );
+const { updateConfig } = require( "./utils/updateConfig" );
 
 let Logger = require( "./utils/Logger" );
 let getAccessoryUUID = require( "./utils/getAccessoryUUID" );
@@ -15,7 +17,6 @@ let trueTypeOf = require( "./utils/trueTypeOf" );
 let HV = require( "./utils/HV" );
 
 // Essential variables
-const { spawnSync } = require('child_process');
 let createAccessorysInformationService = require( "./utils/createAccessorysInformationService" );
 
 // Pretty Colors
@@ -36,8 +37,6 @@ const Cmd5Accessory = require( "./Cmd5Accessory" ).Cmd5Accessory;
 // Settings, Globals and Constants
 let settings = require( "./cmd5Settings" );
 const constants = require( "./cmd5Constants" );
-const path = require('path');
-const fs = require('fs');
 
 // Platform definition
 class Cmd5Platform
@@ -105,83 +104,22 @@ class Cmd5Platform
 
       // didFinishLaunching is only called after the
       // registerPlatform completes.
-      api.on( "didFinishLaunching", ( ) =>
+      api.on( "didFinishLaunching", async () =>
       {
          this.log.info( chalk.green( "MyPlace Platform didFinishLaunching" ) );
 
-         // Remove MyPlace shell script temporary working directories on Homebridge RESTART
-         this.log.info( chalk.yellow( "Removing temporary working directories" ) );
-         try {
-            const directoryPath = process.env.TMPDIR || "/tmp";
-            const files = fs.readdirSync(directoryPath);
-            const filteredFiles = files.filter(file => file.match(/^(AA|BB)-\d{3}$/));
-
-            filteredFiles.forEach(file => {
-               const sdir = `${directoryPath}/${file}`;
-
-               try {
-                  fs.rmSync(sdir, { recursive: true, force: true });
-                  this.log.info(`Temporary working directory ${sdir} removed`);
-               } catch (err) {
-                  this.log.error(` Unable to remove temporary working directory ${sdir}: [${err}]`);
-               }
-            });
-         } catch (err) {
-            this.log.error(`Unable to scan and remove temporary working directory: [${err}]`);
-         }
-
-         // Run ConfigCreator to update/refresh the MyPlace config
-         this.log.info( chalk.yellow( "Running createMyPlacConfig..." ) );
-         try {
-            // Build args for up to 3 devices
-            let args = [];
-            for (let i = 0; i < 3; i++) {
-               const device = this.config.devices[i];
-               if (device) {
-                  const ipPort = `${device.ipAddress || ''}:${device.port || ''}`;
-                  const name = device.name || '';
-                  const extraTimers = device.extraTimers ?? false;
-                  const debug = device.debug ?? false;
-                  args.push(ipPort, name, extraTimers, debug);
-               } else {
-                  // If device is missing, push empty args
-                  args.push('', '', '', '');
-               }
-            }
-
-            // Add __dirname and "homebridge" as last two arguments
-            args.push(`${__dirname}/MyPlace.sh`);
-
-            // Run the createMyPlaceconfig.js script
-            const scriptPath = path.resolve(__dirname, 'utils', 'createMyPlaceConfig.js');
-            this.log.debug('Running script:', scriptPath, args);
-
-            const result = spawnSync('node', [scriptPath, ...args], { encoding: 'utf8', maxBuffer: 5 * 1024 * 1024 });
+         // Update the config
+         // The original config has no config for accessories and that needs to be generated by createMyplaceConfig.js
+         this.config = await updateConfig( this.config, this.log, __dirname );
 
-            const status = result.stderr.trim();
-            const jsonText = result.stdout.trim();
-
-            if (status.includes('DONE')) {
-               this.config = JSON.parse(jsonText);
-               this.log.info(status);
-               this.log.debug('Updated config:\n' + JSON.stringify(this.config));
-            } else {
-               this.log.error(status);
-               this.log.warn('Proceeding with original config — no accessories will be created.');
-            }
-         } catch (err) {
-            this.log.warn('ERROR: createMyPlaceConfig failed:', err);
-            this.log.warn('Proceeding with original config — no accessories will be created.');
-         }
-
-         // Now process these using the updated config
+         // Now process this updated config
          this.parseConfigForCmd5Directives( this.config );
          this.hV.update( this );
          this.processNewCharacteristicDefinitions( );
 
-         this.log.info( chalk.yellow( "Scanning the config and the cache for devices to be removed or restored from cache" ) );
-         // scan the platform devices to identify which ones to be restored from cache
-         this.scanToBeRestoredDevices( this.log );
+         // 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.scanToBeRemovedOrRestored( this.log );
 
          // Any accessory NOT to be restored should be removed, find them
          this.toBeRestoredPlatforms.forEach( ( accessory ) =>
@@ -194,6 +132,9 @@ class Cmd5Platform
          // if it is not already in cache
          this.discoverDevices( this.log );
 
+         // Remove MyPlace shell script temporary working directories on Homebridge RESTART
+         removeTempDir( this.log );
+
          // Let the Polling Begin
          this.startPolling();
 
@@ -409,7 +350,7 @@ class Cmd5Platform
    }
 
    // Scan the platform accessories and identify devices to be restored from cache
-   scanToBeRestoredDevices( )
+   scanToBeRemovedOrRestored( )
    {
       // Homebridge can only handle a max of 150 accessories per bridge, as such, it is prudent to identify and remove those accessories 
       // which are not to be restored before creating new ones
@@ -475,7 +416,7 @@ class Cmd5Platform
             let duplicatePlatformAccessory = this.createdCmd5Platforms.find(accessory => accessory.UUID === existingAccessory.UUID);
             if ( duplicatePlatformAccessory )
             {
-               this.log( chalk.red( `Error duplicate platform accessory: ${ duplicatePlatformAccessory.name } uuid:${ duplicatePlatformAccessory.UUID }` ) );
+               this.log.error( chalk.red( `Error duplicate platform accessory: ${ duplicatePlatformAccessory.displayName } uuid:${ duplicatePlatformAccessory.UUID }` ) );
                // Next in for.Each object iteration
                return;
             }
@@ -581,6 +522,8 @@ class Cmd5Platform
 
             platform.Service = this.Service;
 
+            platform.context.device = device; // ⬅️ Store device config for restoration
+
             this.log.info( chalk.magenta( `Configuring platformAccessory: ` ) + `${ device.displayName }` );
             let that = this;
             accessory = new Cmd5Accessory( that.log, device, this.api, [ ], this );

package/Cmd5PriorityPollingQueue.js

@@ -120,10 +120,10 @@ class Cmd5PriorityPollingQueue
          if ( this.state_cmd.match( /MyPlace.sh'$/ ) )
          {
             // Reject Set requests to change Fanv2 rotationSpeed or to turn off myZone for zones with temperature sensors
-            if ( this.typeIndex == 20 && this.displayName.match ( / Zone$/ ) && 
-                  ( characteristicString == 'RotationSpeed' || 
-                    ( characteristicString == 'RotationDirection' && value == 1 ) 
-                  ) 
+            if ( this.typeIndex == 20 && this.displayName.match ( / Zone$/ ) &&
+                  ( characteristicString == 'RotationSpeed' ||
+                    ( characteristicString == 'RotationDirection' && value == 1 )
+                  )
                )
             {
                let storedValue = this.cmd5Storage.getStoredValueForIndex( accTypeEnumIndex );
@@ -132,8 +132,8 @@ class Cmd5PriorityPollingQueue
                return;
             }
             // Reject Set requests to change Thermostat targetHeatingCoolingState for Zone Thermostat
-            if ( this.typeIndex == 57 && this.displayName.match ( / Thermostat$/ ) && 
-                  characteristicString == 'TargetHeatingCoolingState' 
+            if ( this.typeIndex == 57 && this.displayName.match ( / Thermostat$/ ) &&
+                  characteristicString == 'TargetHeatingCoolingState'
                )
             {
                let storedValue = this.cmd5Storage.getStoredValueForIndex( accTypeEnumIndex );
@@ -143,13 +143,13 @@ class Cmd5PriorityPollingQueue
             }
             // Turn on the Zone when this Zone is set as myZone
             else if ( this.typeIndex == 20 && this.displayName.match ( / Zone$/ ) &&
-                      characteristicString == 'RotationDirection' && value == 0 
+                      characteristicString == 'RotationDirection' && value == 0
                  )
             {
                this.service.getCharacteristic( 'Active' ).updateValue( 1 );
             }
             else if ( this.displayName.match( / FanSpeed$/ ) )
-            {  
+            {
                // Abort if 'on' or 'rotationSpeed' value = 0, this accessory is always on
                if ( value == 0 )
                {