homebridge-myplace 2.1.4 → 2.2.0

package/CHANGELOG.md

@@ -1,4 +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.4 (2025-03-10)
+##### v2.2.0 (2025-06-27)
 
-###### (1) A minor bug fix to resolve the `TypeError` while loading plugin if `homebridge-cmd4` is also installed
+###### (1) Simplified the setup process

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 );
 

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,8 @@
 ### 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

package/config.schema.json

@@ -9,11 +9,12 @@
     "properties": {
       "name": {
         "type": "string",
-        "default": "MyPlace",
-        "required": true
+        "default": "MyPlace"
       },
       "devices": {
         "type": "array",
+        "minItems": 1,
+        "maxItems": 3,
         "items": {
           "title": "AdvantageAir device",
           "type": "object",
@@ -22,7 +23,6 @@
               "title": "Name",
               "description": "The name of the AdvantageAir device, default=Aircon",
               "type": "string",
-              "required": true,
               "default": "Aircon"
             },
             "ipAddress": {
@@ -30,357 +30,32 @@
               "description": "The device's IP address. It is recommended to set a static IP for this device.",
               "type": "string",
               "format": "ipv4",
-              "required": true,
               "placeholder": "192.168.0.1"
             },
             "port": {
               "title": "PORT used",
               "description": "The PORT number used for this device, default=2025.",
               "type": "number",
-              "required": true,
-              "default": "2025"
+              "default": 2025
             },
             "extraTimers": {
               "title": "Include extra timers",
               "description": "Include extra timers to turn on the Aircon in specific mode: Cool, Heat or Vent.",
               "type": "boolean",
-              "required": false,
               "default": false
             },
             "debug": {
               "title": "Enable detailed debug log",
               "description": "Enables a detailed debug log. Useful when trying to figure out issues with the plugin.",
               "type": "boolean",
-              "required": false,
               "default": false
             }
-          }
-        }
-      },
-      "title": {
-        "type": "string"
-      },
-      "debug": {
-        "type": "boolean"
-      },
-      "outputConstants": {
-        "type": "boolean"
-      },
-      "statusMsg": {
-        "type": "boolean"
-      },
-      "timeout": {
-        "type": "number"
-      },
-      "stateChangeResponseTime": {
-        "type": "number"
-      },
-      "constants": {
-        "type": "array",
-        "required": false,
-        "items": {
-          "type": "object",
-          "properties": {
-            "key": {
-              "type": "string"
-            },
-            "value": {
-              "type": "string"
-            }
-          }
-        }
-      },
-      "queueTypes": {
-        "type": "array",
-        "required": false,
-        "items": {
-          "type": "object",
-          "properties": {
-            "queue": {
-              "type": "string"
-            },
-            "queueType": {
-              "type": "string"
-            }
-          }
-        }
-      },
-      "accessories": {
-        "type": "array",
-        "required": false,
-        "items": {
-          "type": "object",
-          "properties": {
-            "type": {
-              "type": "string"
-            },
-            "displayName": {
-              "type": "string"
-            },
-            "active": {
-              "type": "number"
-            },
-            "brightness": {
-              "type": "number"
-            },
-            "on": {
-              "type": "boolean"
-            },
-            "rotationSpeed": {
-              "type": "number"
-            },
-            "rotationDirection": {
-              "type": "number"
-            },
-            "currentHeatingCoolingState": {
-              "type": "string"
-            },
-            "targetHeatingCoolingState": {
-              "type": "string"
-            },
-            "currentDoorState": {
-              "type": "number"
-            },
-            "targetDoorState": {
-              "type": "number"
-            },
-            "currentPosition": {
-              "type": "number"
-            },
-            "targetPosition": {
-              "type": "number"
-            },
-            "currentTemperature": {
-              "type": "number"
-            },
-            "targetTemperature": {
-              "type": "number"
-            },
-            "temperatureDisplayUnits": {
-              "type": "string"
-            },
-            "obstructionDetected": {
-              "type": "boolean"
-            },
-            "name": {
-              "type": "string"
-            },
-            "manufacturer": {
-              "type": "string"
-            },
-            "model": {
-              "type": "string"
-            },
-            "positionState": {
-              "type": "number"
-            },
-            "serialNumber": {
-              "type": "string"
-            },
-            "queue": {
-              "type": "string"
-            },
-            "polling": {
-              "type": "boolean"
-            },
-            "polling": {
-              "type": "array",
-              "required": false,
-              "items": {
-                "type": "object",
-                "properties": {
-                  "characteristic": {
-                    "type": "string"
-                  }
-                }
-              }
-            },
-            "props": {
-              "type": "object",
-              "required": false,
-              "properties": {
-                "brightness": {
-                  "type": "object",
-                  "properties": {
-                    "minStep": {
-                      "type": "number"
-                    }
-                  }
-                },
-                "currentTemperature": {
-                  "type": "object",
-                  "properties": {
-                    "maxValue": {
-                      "type": "number"
-                    },
-                    "minValue": {
-                      "type": "number"
-                    },
-                    "minStep": {
-                      "type": "number"
-                    }
-                  }
-                },
-                "rotationSpeed": {
-                  "type": "object",
-                  "properties": {
-                    "minStep": {
-                      "type": "number"
-                    }
-                  }
-                },
-                "targetTemperature": {
-                  "type": "object",
-                  "properties": {
-                    "maxValue": {
-                      "type": "number"
-                    },
-                    "minValue": {
-                      "type": "number"
-                    },
-                    "minStep": {
-                      "type": "number"
-                    }
-                  }
-                }
-              }
-            },
-            "state_cmd": {
-              "type": "string"
-            },
-            "state_cmd_suffix": {
-              "type": "string"
-            },
-            "linkedTypes": {
-              "type": "array",
-              "required": false,
-              "items": {
-                "type": "object",
-                "properties": {
-                  "type": {
-                    "type": "string"
-                  },
-                  "displayName": {
-                    "type": "string"
-                  },
-                  "active": {
-                    "type": "number"
-                  },
-                  "on": {
-                    "type": "boolean"
-                  },
-                  "brightness": {
-                    "type": "number"
-                  },
-                  "currentTemperature": {
-                    "type": "number"
-                  },
-                  "targetTemperature": {
-                    "type": "number"
-                  },
-                  "currentHeatingCoolingState": {
-                    "type": "string"
-                  },
-                  "targetHeatingCoolingState": {
-                    "type": "string"
-                  },
-                  "temperatureDisplayUnits": {
-                    "type": "string"
-                  },
-                  "rotationSpeed": {
-                    "type": "number"
-                  },
-                  "rotationDirection": {
-                    "type": "number"
-                  },
-                  "name": {
-                    "type": "string"
-                  },
-                  "manufacturer": {
-                    "type": "string"
-                  },
-                  "model": {
-                    "type": "string"
-                  },
-                  "serialNumber": {
-                    "type": "string"
-                  },
-                  "queue": {
-                    "type": "string"
-                  },
-                  "polling": {
-                    "type": "array",
-                    "items": {
-                      "type": "object",
-                      "properties": {
-                        "characteristic": {
-                          "type": "string"
-                        }
-                      }
-                    }
-                  },
-                  "props": {
-                    "type": "object",
-                    "properties": {
-                      "brightness": {
-                        "type": "object",
-                        "properties": {
-                          "minStep": {
-                            "type": "number"
-                          }
-                        }
-                      },
-                      "currentTemperature": {
-                        "type": "object",
-                        "properties": {
-                          "maxValue": {
-                            "type": "number"
-                          },
-                          "minValue": {
-                            "type": "number"
-                          },
-                          "minStep": {
-                            "type": "number"
-                          }
-                        }
-                      },
-                      "rotationSpeed": {
-                        "type": "object",
-                        "properties": {
-                          "minStep": {
-                            "type": "number"
-                          }
-                        }
-                      },
-                      "targetTemperature": {
-                        "type": "object",
-                        "properties": {
-                          "maxValue": {
-                            "type": "number"
-                          },
-                          "minValue": {
-                            "type": "number"
-                          },
-                          "minStep": {
-                            "type": "number"
-                          }
-                        }
-                      }
-                    }
-                  },
-                  "state_cmd": {
-                    "type": "string"
-                  },
-                  "state_cmd_suffix": {
-                    "type": "string"
-                  }
-                }
-              }
-            }
-          }
+          },
+          "required": ["name", "ipAddress", "port"]
         }
       }
-    }
+    },
+    "required": ["name", "devices"]
   },
   "layout": [
     {