homebridge-myplace 2.1.3 → 2.2.0

package/CHANGELOG.md

@@ -1,6 +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.1.3 (2024-12-30)
+##### v2.2.0 (2025-06-27)
 
-###### (1) Updated complatibility of the package json file to node 22 
-###### (2) Minor under the hood code changes to improve the running of this plugin
-###### (3) And some minor bug fixes
+###### (1) Simplified the setup process

package/Cmd5Accessory.js

@@ -21,9 +21,9 @@ let lcFirst = require( "./utils/lcFirst" );
 let trueTypeOf = require( "./utils/trueTypeOf" );
 
 // The sObject.defineProperty is to resolve a lint issue.
-// See utils/indexOfEnumLintTest.js for further information.
-let indexOfEnum = require( "./utils/indexOfEnum" );
-Object.defineProperty( exports, "indexOfEnum", { enumerable: true, get: function ( ){ return indexOfEnum.indexOfEnum; } });
+// See utils/Cmd5indexOfEnumLintTest.js for further information.
+let Cmd5indexOfEnum = require( "./utils/Cmd5indexOfEnum" );
+Object.defineProperty( exports, "Cmd5indexOfEnum", { enumerable: true, get: function ( ){ return Cmd5indexOfEnum.Cmd5indexOfEnum; } });
 
 // For changing validValue Constants to Values and back again
 var { transposeConstantToValidValue,
@@ -389,7 +389,7 @@ class Cmd5Accessory
          let devProperties = CMD5_DEVICE_TYPE_ENUM.properties[ this.typeIndex ];
 
          // See if the characteristic index is in the required characteristics of the device
-         let requiredIndex = devProperties.requiredCharacteristics.indexOfEnum( i => i.type === accTypeEnumIndex );
+         let requiredIndex = devProperties.requiredCharacteristics.Cmd5indexOfEnum( i => i.type === accTypeEnumIndex );
 
          let format = CMD5_ACC_TYPE_ENUM.properties[ accTypeEnumIndex ].props.format;
 
@@ -506,7 +506,7 @@ class Cmd5Accessory
                default:
                {
                   // Is this still useful?
-                  accTypeEnumIndex = CMD5_ACC_TYPE_ENUM.indexOfEnum( key );
+                  accTypeEnumIndex = CMD5_ACC_TYPE_ENUM.Cmd5indexOfEnum( key );
 
                   if ( accTypeEnumIndex < 0  )
                      // throw new Error( `OOPS: "${ key }" not found while parsing for characteristic polling. There something wrong with your config.json file?` );

package/Cmd5Platform.js

@@ -5,9 +5,6 @@ const { getAccessoryName,
         getAccessoryDisplayName } = require( "./utils/getAccessoryNameFunctions" );
 const { parseAddQueueTypes } = require( "./Cmd5PriorityPollingQueue" );
 
-
-
-
 let Logger = require( "./utils/Logger" );
 let getAccessoryUUID = require( "./utils/getAccessoryUUID" );
 let lcFirst = require( "./utils/lcFirst" );
@@ -17,6 +14,8 @@ let trueTypeOf = require( "./utils/trueTypeOf" );
 // Hierarchy variables
 let HV = require( "./utils/HV" );
 
+// Essential variables
+const { spawnSync } = require('child_process');
 let createAccessorysInformationService = require( "./utils/createAccessorysInformationService" );
 
 // Pretty Colors
@@ -37,6 +36,8 @@ 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
@@ -102,23 +103,85 @@ class Cmd5Platform
       // Create the hierarhy variables
       this.hV = new HV();
 
-      this.parseConfigForCmd5Directives( this.config );
-
-      // Update the namespace for stored variables
-      // like timeout, stateChangeResponseTime ... As it may require
-      // changes from parseConfig.
-      this.hV.update( this );
-
-      this.processNewCharacteristicDefinitions( );
-
-
       // didFinishLaunching is only called after the
       // registerPlatform completes.
       api.on( "didFinishLaunching", ( ) =>
       {
-         this.log.info( chalk.blue( "Cmd5Platform didFinishLaunching" ) );
+         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' });
+            const feedback = result.stdout.trim();
+
+            const lines = feedback.split('\n');
+            const status = lines.shift();
+            const jsonText = lines.join('\n').trim();
+
+            if (status.includes('DONE')) {
+               this.config = JSON.parse(jsonText);
+               this.log.info(status);
+               this.log.debug('Updated config:\n' + JSON.stringify(this.config, null, 2));
+            } else {
+               this.log.error('ERROR: Errors encountered running createMyPlaceConfig', 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
+         this.parseConfigForCmd5Directives( this.config );
+         this.hV.update( this );
+         this.processNewCharacteristicDefinitions( );
 
-         this.log.info( chalk.magenta( "Scanning config.json and the cache for devices to be removed/restored from cache" ) );
+         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 );
 
@@ -289,7 +352,7 @@ class Cmd5Platform
             throw new Error( `definition.props.format at index: ${ definitionIndex } is not a String.` );
 
          // Need to check if format is correct
-         let formatIndex = CMD5_FORMAT_TYPE_ENUM.properties.indexOfEnum( i => i.type === definition.props.format );
+         let formatIndex = CMD5_FORMAT_TYPE_ENUM.properties.Cmd5indexOfEnum( i => i.type === definition.props.format );
          if ( formatIndex < 0 )
             throw new Error( `definition.props.format at index: ${ definitionIndex } is not a valid format.` );
 
@@ -300,7 +363,7 @@ class Cmd5Platform
                throw new Error( `definition.props.units at index: ${ definitionIndex } is not a String.` );
 
             // Need to check if units is correct
-            let unitsIndex = CMD5_UNITS_TYPE_ENUM.properties.indexOfEnum( i => i.type === definition.props.units );
+            let unitsIndex = CMD5_UNITS_TYPE_ENUM.properties.Cmd5indexOfEnum( i => i.type === definition.props.units );
             if ( unitsIndex < 0 )
                throw new Error( `definition.props.units at index: ${ definitionIndex } is not a valid unit.` );
 
@@ -326,7 +389,7 @@ class Cmd5Platform
 
          definition.props.perms.forEach( ( perm ) =>
          {
-            let permIndex = CMD5_PERMS_TYPE_ENUM.properties.indexOfEnum( i => i.type === perm );
+            let permIndex = CMD5_PERMS_TYPE_ENUM.properties.Cmd5indexOfEnum( i => i.type === perm );
             if ( permIndex < 0 )
                throw new Error( `definition.props.perms at index: ${ definitionIndex } ${ perm } is not a valid perm.` );
 

package/README.md

@@ -25,99 +25,43 @@ An independent plugin bringing [Advantage Air](https://www.advantageair.com.au/)
   * [Fujitsu anywAIR](https://apps.apple.com/au/app/anywair/id1509639853)
 
 ## Installation
-### Raspbian/HOOBS/macOS/NAS
 1. Install Homebridge via these instructions for [Raspbian](https://github.com/homebridge/homebridge/wiki/Install-Homebridge-on-Raspbian), [HOOBS](https://support.hoobs.org/docs) or [macOS](https://github.com/homebridge/homebridge/wiki/Install-Homebridge-on-macOS), if you have not already.
 
-2. Check if <B>jq</B> and <B>curl</B> are installed (<B>curl</B> should already be):
-   ```shell
-   jq --version
-   curl --version
-   ```
-   If they are installed, the above command should return a version number. If not, install them:
-   ##### For Raspbian/Hoobs:
-   ```shell
-   sudo apt-get install <jq or curl>
-   ```
-   ##### For MacOS:
-   ```shell
-   brew install <jq or curl>
-   ```
-   ##### For Synology NAS:
-   ```shell
-   apt-get install <jq or curl>
-   ```
-   ##### For QNAP NAS:
-   ```shell
-   apk add <jq or curl>
-   ```
-   #### Important note:
-   At the time of updating this README, the `apt-get insatall` only allow jq-1.6 to be installed, which is notorously slow! To install the lastest and **MUCH faster** version of jq-1.7.1, please follow the step-by-step guide below:
-   1. Download the Source Code:
-   
-      You can download the source code "jq-1.7.1.tar.gz" for jq 1.7.1 from the official GitHub releases page (https://github.com/jqlang/jq/releases) or use the link below:
-      ```shell
-      wget https://github.com/jqlang/jq/releases/download/jq-1.7.1/jq-1.7.1.tar.gz
-      ```
-   2. Install Dependencies:
-   
-      Ensure you have the necessary build tools and dependencies installed. You can do this by running:
-      ```shell
-      sudo apt-get update
-      sudo apt-get install -y autoconf automake libtool make gcc
-      ```
-   3. Extract and Build:
-   
-      Extract the downloaded tarball and navigate to the directory:
-      ```shell
-      tar -xvzf jq-1.7.1.tar.gz
-      cd jq-1.7.1
-      chmod +x configure
-      ```
-   4. Run the following commands to build and install jq:
-      ```shell
-      ./configure
-      make
-      sudo make install
-      ```
-   5. Verify Installation:
-
-      After installation, you can verify that jq is installed correctly by running:
-      ```shell
-      jq --version
-      ```
+2. Make sure that <B>jq</B> and <B>curl</B> are installed.  Try to install <B>jq-1.7</B> if you can.  It is much faster.
+
 3. Find the `homebridge-myplace` plugin via the Homebridge UI 'Plugins' tab search function, once found, click the blue *down-arrow* at the bottom right to install.  
   
      <p align="left">
      <img width="400px" src="Screenshots/MyPlaceInstall3.png">
      </p>
 
-     Once install, `Config: homebridge-myplace` UI will pop up, then follow the steps shown in Step 4 below.
+     Once installed, `Config: homebridge-myplace` UI will pop up, then follow the steps outlined in Step 4 below.
+
+     ![MyPlace_setting_UI](https://github.com/user-attachments/assets/49d49852-908b-4479-aebc-81337c820b1a)
 
      If for some reasons, the `Config: homebridge-myplace` UI did not pop up, locate your newly installed `Homebridge Myplace` plugin and click on the three dots at the bottom right and select `Plugin Config` to get the `Config: homebridge-myplace` UI.
    
-4. Create MyPlace configuration file:
+5. Configuring MyPlace plugin:
    
-   This is the `Config: homebridge-myplace` UI where you register your system parameters and create/check the required configuration file to run this plugin. 
-        <p align="left">
-        <img width="600px" src="Screenshots/MyPlaceConfigCreator.png">
-        </p>
-
-   In <B>Device Settings</B> area, fill out the `Name`, `IP Address` and `PORT used` fields (default PORT is `2025` for most users, Fujitsu anywAIR users set this to `10211` ) and check/uncheck the self-explanatory checkboxes for `Include extra timers` and `Enable detailed debug log`, then click `SAVE`. This is to save your system parameters. Click `CLOSE` if a pop up urging you to `RESTART`.
+   In <B>Device Settings</B> area, fill out the `Name`, `IP Address` and `PORT used` fields (default PORT is `2025` for most users, Fujitsu anywAIR users set this to `10211` ) and check/uncheck the self-explanatory checkboxes for `Include extra timers` and `Enable detailed debug log`, click `SAVE` then `RESTART`. 
      
-   Go back to `Config: homebridge-myplace` UI agina (by clicking the the 3 dots at the bottom right and click `Plugin Config`) and press the `CREATE CONFIGURATION` button to create the required configuration file.
-
-   On a sucess, you may click `CHECK CONFIGURATION`to check the configuration file just created is in order. On a success it will say `Passed`; if something is incorrect, an error message will pop up telling you what needs to be fixed.
-
-   Otherwise, click `SAVE` then `RESTART`.
-
-   **HOOBS** users who do not have access to Homebridge UI (for now!) will have to run the Config Creator on a terminal:
-   ```shell
-      cd
-      <Plugin Path>/node_modules/homebridge-myplace/ConfigCreator.sh
+   For users who do not have access to Homebridge UI have to make sure that a config, as shown in the example below, is in the homebridge config.json:
+   
+   ```
+   {
+    "name": "MyPlace",
+    "devices": [
+        {
+            "name": "Aircon",
+            "ipAddress": "192.168.1.3",
+            "port": 2025,
+            "extraTimers": true,
+            "debug": false
+        }
+    ],
+    "platform": "MyPlace"
+   }
    ```
-     then follow the on-screen instructions.
-  
-     *typical `<Plugin Path>` is `/var/lib/hoobs/<bridge>` 
 
 ## How it Looks and Works
 ### (A) Aircon System (MyAir, E-zone, etc) has the following typical Homekit tiles:

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.2.0 (2025-06-27)
+
+###### (1) Simplified the setup process
+
+##### v2.1.4 (2025-03-10)
+
+###### (1) A minor bug fix to resolve the `TypeError` while loading plugin if `homebridge-cmd4` is also installed
+
 ##### v2.1.3 (2024-12-30)
 
 ###### (1) Updated complatibility of the package json file to node 22