homebridge-myplace 2.0.2 → 2.0.3

package/CHANGELOG.md

@@ -1,4 +1,6 @@
 ### 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.0.2 (2024-09-18)
+##### v2.0.3 (2024-09-27)
+
+###### (1) Bug fixes to ConfigCreator.sh and CheckConfig.sh
+###### (2) Minor update to README.md
 
-###### (1) Re-coded ConfigCreator to use jq to create all config and enabled updating of devices info in config.json even when it is run from terminal.

package/CheckConfig.sh

@@ -1,22 +1,13 @@
 #!/bin/bash
 #
-# This script is to check the Cmd5 configuration file for myplace plugin
+# This script is to check the MyPlace configuration file for myplace plugin
 #
 # Usage ./CheckConfig.sh                                                                   
 # 
 
-# define the possible names for MyPlace platform
-cmd5Platform1="\"platform\": \"MyPlace\""
-cmd5Platform2="\"platform\": \"homebridge-myplace\""
-
-# define some file variables
-homebridgeConfigJson=""           # homebridge config.json
-configJson="config.json.copy"     # a working copy of homebridge config.json
-
 # fun color stuff
 BOLD=$(tput bold)
 TRED=$(tput setaf 1)
-#TGRN=$(tput setaf 2)
 TYEL=$(tput setaf 3)
 TPUR=$(tput setaf 5)
 TLBL=$(tput setaf 6)
@@ -27,13 +18,14 @@ function readHomebridgeConfigJson()
    INPUT=""
    homebridgeConfigJson=""
    getHomebridgeConfigJsonPath
-   if [ "${fullPath}" != "" ]; then homebridgeConfigJson="${fullPath}"; fi 
- 
-   # if no config.json file found, ask user to input the full path
-   if [ -z "${homebridgeConfigJson}" ]; then
-      homebridgeConfigJson=""
+   if [ "${fullPath}" != "" ]; then
+      homebridgeConfigJson="${fullPath}"
+      echo "${TLBL}INFO: Valid Homebridge config.json found: ${homebridgeConfigJson}${TNRM}"
+      echo ""
+   else
+      # if no valid config.json file found, ask user to manually specify the full path
       echo ""
-      echo "${TPUR}WARNING: No valid Homebridge config.json file located by the script!${TNRM}"
+      echo "${TPUR}WARNING: No valid Homebridge config.json located by the script!${TNRM}"
       echo ""
       until [ -n "${INPUT}" ]; do
          echo "${TYEL}Please enter the full path of your Homebridge config.json file,"
@@ -41,7 +33,6 @@ function readHomebridgeConfigJson()
          read -r -p "${BOLD}> ${TNRM}" INPUT
          if [ -z "${INPUT}" ]; then
             echo "${TPUR}WARNING: No Homebridge config.json file specified"
-            cleanUp
             exit 1
          elif expr "${INPUT}" : '[./a-zA-Z0-9]*/config.json$' >/dev/null; then
             if [ -f "${INPUT}" ]; then
@@ -60,29 +51,21 @@ function readHomebridgeConfigJson()
             INPUT=""
          fi
       done
-   fi
-   if [ -f "${homebridgeConfigJson}" ]; then
-      if [ -z "${INPUT}" ]; then
-         echo "${TLBL}INFO: The Homebridge config.json found: ${homebridgeConfigJson}${TNRM}"
+      # check that this specified config.json is valid - has "MyPlace" platform in it.
+      fullPath="${homebridgeConfigJson}"
+      checkForMyPlacePlatformInFile
+      if [ -z "${myPlacePlatformFound}" ]; then
          echo ""
+         echo "${TRED}ERROR: MyPlace Config specified in \"${homebridgeConfigJson}\" is invalid. Please ensure that homebridge-myplace plugin is installed and configured${TNRM}"
+         exit 1
       else
          echo ""
-         echo "${TLBL}INFO: The Homebridge config.json specified: ${homebridgeConfigJson}${TNRM}"
+         echo "${TLBL}INFO: Valid Homebridge config.json specified: ${homebridgeConfigJson}${TNRM}"
          echo ""
       fi
-      # expand the json just in case it is in compact form
-      jq --indent 4 '.' "${homebridgeConfigJson}" > "${configJson}"
-      checkForPlatformCmd5InHomebridgeConfigJson
-      if [ -z "${validFile}" ]; then
-         echo ""
-         echo "${TRED}ERROR: no Cmd5 Config found in \"${homebridgeConfigJson}\"! Please ensure that Homebridge-MyPlace plugin is installed${TNRM}"
-         cleanUp
-         exit 1
-      fi
    fi
 }
 
-
 function getGlobalNodeModulesPathForFile()
 {
    file="$1"
@@ -170,8 +153,8 @@ function getHomebridgeConfigJsonPath()
    if [ -n "${Hoobs}" ]; then
       fullPath="${MYPLACE_SH_PATH%/*/*/*}/config.json"
       if [ -f "${fullPath}" ]; then
-         checkForCmd5PlatformNameInFile
-         if [ -z "${cmd5PlatformNameFound}" ]; then
+         checkForMyPlacePlatformInFile
+         if [ -z "${myPlacePlatformFound}" ]; then
             fullPath=""
          fi 
          return
@@ -183,8 +166,8 @@ function getHomebridgeConfigJsonPath()
          1)
             fullPath="/var/lib/homebridge/config.json"
             if [ -f "${fullPath}" ]; then
-               checkForCmd5PlatformNameInFile
-               if [ -n "${cmd5PlatformNameFound}" ]; then 
+               checkForMyPlacePlatformInFile
+               if [ -n "${myPlacePlatformFound}" ]; then 
                   return
                else
                   fullPath=""
@@ -194,8 +177,8 @@ function getHomebridgeConfigJsonPath()
          2)
             fullPath="$HOME/.homebridge/config.json"
             if [ -f "${fullPath}" ]; then
-               checkForCmd5PlatformNameInFile
-               if [ -n "${cmd5PlatformNameFound}" ]; then 
+               checkForMyPlacePlatformInFile
+               if [ -n "${myPlacePlatformFound}" ]; then 
                   return
                else
                   fullPath=""
@@ -208,8 +191,8 @@ function getHomebridgeConfigJsonPath()
             for ((i = 1; i <= noOfInstances; i ++)); do
                fullPath=$(echo "${foundPath}"|sed -n "${i}"p)
                if [ -f "${fullPath}" ]; then
-                  checkForCmd5PlatformNameInFile   
-                  if [ -n "${cmd5PlatformNameFound}" ]; then 
+                  checkForMyPlacePlatformInFile   
+                  if [ -n "${myPlacePlatformFound}" ]; then 
                      return
                   else
                      fullPath=""
@@ -223,8 +206,8 @@ function getHomebridgeConfigJsonPath()
             for ((i = 1; i <= noOfInstances; i ++)); do
                fullPath=$(echo "${foundPath}"|sed -n "${i}"p)
                if [ -f "${fullPath}" ]; then
-                  checkForCmd5PlatformNameInFile   
-                  if [ -n "${cmd5PlatformNameFound}" ]; then 
+                  checkForMyPlacePlatformInFile   
+                  if [ -n "${myPlacePlatformFound}" ]; then 
                      return
                   else
                      fullPath=""
@@ -238,8 +221,8 @@ function getHomebridgeConfigJsonPath()
             for ((i = 1; i <= noOfInstances; i ++)); do
                fullPath=$(echo "${foundPath}"|sed -n "${i}"p)
                if [ -f "${fullPath}" ]; then
-                  checkForCmd5PlatformNameInFile   
-                  if [ -n "${cmd5PlatformNameFound}" ]; then 
+                  checkForMyPlacePlatformInFile   
+                  if [ -n "${myPlacePlatformFound}" ]; then 
                      return
                   else
                      fullPath=""
@@ -253,8 +236,8 @@ function getHomebridgeConfigJsonPath()
             for ((i = 1; i <= noOfInstances; i ++)); do
                fullPath=$(echo "${foundPath}"|sed -n "${i}"p)
                if [ -f "${fullPath}" ]; then
-                  checkForCmd5PlatformNameInFile   
-                  if [ -n "${cmd5PlatformNameFound}" ]; then 
+                  checkForMyPlacePlatformInFile   
+                  if [ -n "${myPlacePlatformFound}" ]; then 
                      return
                   else
                      fullPath=""
@@ -266,60 +249,15 @@ function getHomebridgeConfigJsonPath()
    done
 }
 
-function checkForPlatformCmd5InHomebridgeConfigJson()
-{
-   validFile=""
-   for ((tryIndex = 1; tryIndex <= 2; tryIndex ++)); do
-      case $tryIndex in
-         1)
-            validFile=$(grep -n "${cmd5Platform1}" "${configJson}"|cut -d":" -f1)
-            if [ -n "${validFile}" ]; then
-               return
-            fi
-         ;;
-         2)
-            validFile=$(grep -n "${cmd5Platform2}" "${configJson}"|cut -d":" -f1)
-            if [ -n "${validFile}" ]; then
-               return
-            fi
-         ;;
-      esac
-   done
-}
-
-function checkForCmd5PlatformNameInFile()
-{
-   cmd5PlatformNameFound=""
-
-   for ((Index = 1; Index <= 2; Index ++)); do
-      case $Index in
-         1)
-            cmd5PlatformName=$(echo "${cmd5Platform1}"|cut -d'"' -f4)
-            cmd5PlatformNameFound=$(grep -n "\"${cmd5PlatformName}\"" "${fullPath}"|cut -d":" -f1)
-            if [ -n "${cmd5PlatformNameFound}" ]; then
-               return
-            fi
-         ;;
-         2)
-            cmd5PlatformName=$(echo "${cmd5Platform2}"|cut -d'"' -f4)
-            cmd5PlatformNameFound=$(grep -n "\"${cmd5PlatformName}\"" "${fullPath}"|cut -d":" -f1)
-            if [ -n "${cmd5PlatformNameFound}" ]; then
-               return
-            fi
-         ;;
-      esac
-   done
-}
-
- 
-function cleanUp()
+function checkForMyPlacePlatformInFile()
 {
-   rm -f "${configJson}"
+   myPlacePlatformFound=""
+   myPlacePlatformFound=$(grep -n "\"MyPlace\"" "${fullPath}" )
 }
 
 # main starts here
 
-echo "${TYEL}This script is to check that the Cmd5 configuration file meets all requirements${TNRM}"
+echo "${TYEL}This script is to check that the MyPlace configuration file meets all requirements${TNRM}"
 echo ""
 
 echo "${TYEL}CheckConfig engine:${TNRM}"
@@ -369,5 +307,4 @@ readHomebridgeConfigJson
 if [[ -f "${homebridgeConfigJson}" && -f "${MYPLACE_SH_PATH}" ]]; then
    echo "${TYEL}CheckConfig in progress.......${TNRM}"
    node "${CHECKCONFIG_PATH}" "$MYPLACE_SH_PATH" "${homebridgeConfigJson}"
-   cleanUp
 fi

package/ConfigCreator.sh

@@ -56,11 +56,6 @@ TNRM=$(tput sgr0)
 
 function myPlaceBasicKeys()
 {
-   local debugMyPlace="false"
-
-   if [[ "${AAdebug}" = "true" || "${AAdebug2}" = "true" || "${AAdebug3}" = "true" ]]; then
-      debugMyPlace="true"
-   fi
    myPlaceBasicKeys="{}"
    myPlaceBasicKeys=$( echo "${myPlaceBasicKeys}" | jq ".title |= \"MyPlace configuration generated by Configuration Creator\"" \
                                                   | jq ".debug |= ${debugMyPlace}" \
@@ -542,10 +537,9 @@ function updateMyPlaceDevices()
 function extractMyPlaceConfigFromConfigJson()
 {
    noOfPlatforms=$(( $( echo "${config}" | jq ".platforms|keys" | wc -w) - 2 ))
-   myPlacePlatformName=$(echo "${myPlacePlatform}"|cut -d'"' -f4)
    for ((i=0; i<noOfPlatforms; i++)); do
       plaftorm=$( echo "${config}" | jq ".platforms[${i}].platform" )
-      if [ "${plaftorm}" = "\"${myPlacePlatformName}\"" ]; then
+      if [ "${plaftorm}" = "\"${myPlacePlatform}\"" ]; then
          myPlaceConfig=$( echo "${config}" | jq ".platforms[${i}]" )
          configMyPlaceLess=$( echo "${config}" | jq "del(.platforms[${i}])" )
          break
@@ -746,7 +740,7 @@ function getHomebridgeConfigJsonPath()
       fullPath="${MYPLACE_SH_PATH%/*/*/*}/config.json"
       if [ -f "${fullPath}" ]; then
          checkForMyPlacePlatformNameInFile
-         if [ -z "${myPlacePlatformNameFound}" ]; then
+         if [ -z "${myPlacePlatformFound}" ]; then
             fullPath=""
          fi
          return
@@ -760,7 +754,7 @@ function getHomebridgeConfigJsonPath()
             fullPath="/var/lib/homebridge/config.json"
             if [ -f "${fullPath}" ]; then
                checkForMyPlacePlatformNameInFile
-               if [ -n "${myPlacePlatformNameFound}" ]; then
+               if [ -n "${myPlacePlatformFound}" ]; then
                   return
                else
                   fullPath=""
@@ -772,7 +766,7 @@ function getHomebridgeConfigJsonPath()
             fullPath="$HOME/.homebridge/config.json"
             if [ -f "${fullPath}" ]; then
                checkForMyPlacePlatformNameInFile
-               if [ -n "${myPlacePlatformNameFound}" ]; then
+               if [ -n "${myPlacePlatformFound}" ]; then
                   return
                else
                   fullPath=""
@@ -786,7 +780,7 @@ function getHomebridgeConfigJsonPath()
                fullPath=$(echo "${foundPath}"|sed -n "${i}"p)
                if [ -f "${fullPath}" ]; then
                   checkForMyPlacePlatformNameInFile
-                  if [ -n "${myPlacePlatformNameFound}" ]; then
+                  if [ -n "${myPlacePlatformFound}" ]; then
                      return
                   else
                      fullPath=""
@@ -801,7 +795,7 @@ function getHomebridgeConfigJsonPath()
                fullPath=$(echo "${foundPath}"|sed -n "${i}"p)
                if [ -f "${fullPath}" ]; then
                   checkForMyPlacePlatformNameInFile
-                  if [ -n "${myPlacePlatformNameFound}" ]; then
+                  if [ -n "${myPlacePlatformFound}" ]; then
                      return
                   else
                      fullPath=""
@@ -816,7 +810,7 @@ function getHomebridgeConfigJsonPath()
                fullPath=$(echo "${foundPath}"|sed -n "${i}"p)
                if [ -f "${fullPath}" ]; then
                   checkForMyPlacePlatformNameInFile
-                  if [ -n "${myPlacePlatformNameFound}" ]; then
+                  if [ -n "${myPlacePlatformFound}" ]; then
                      return
                   else
                      fullPath=""
@@ -831,7 +825,7 @@ function getHomebridgeConfigJsonPath()
                fullPath=$(echo "${foundPath}"|sed -n "${i}"p)
                if [ -f "${fullPath}" ]; then
                   checkForMyPlacePlatformNameInFile
-                  if [ -n "${myPlacePlatformNameFound}" ]; then
+                  if [ -n "${myPlacePlatformFound}" ]; then
                      return
                   else
                      fullPath=""
@@ -868,20 +862,20 @@ function checkForPlatformMyPlaceInHomebridgeConfigJson()
 
 function checkForMyPlacePlatformNameInFile()
 {
-   myPlacePlatformNameFound=""
+   myPlacePlatformFound=""
 
    for ((Index = 1; Index <= 2; Index ++)); do
       case $Index in
          1)
            
-            myPlacePlatformNameFound=$(grep "\"${myPlacePlatform1}\"" "${fullPath}")
-            if [ -n "${myPlacePlatformNameFound}" ]; then
+            myPlacePlatformFound=$(grep "\"${myPlacePlatform1}\"" "${fullPath}")
+            if [ -n "${myPlacePlatformFound}" ]; then
                return
             fi
          ;;
          2)
-            myPlacePlatformNameFound=$(grep "\"${myPlacePlatform2}\"" "${fullPath}")
-            if [ -n "${myPlacePlatformNameFound}" ]; then
+            myPlacePlatformFound=$(grep "\"${myPlacePlatform2}\"" "${fullPath}")
+            if [ -n "${myPlacePlatformFound}" ]; then
                return
             fi
          ;;
@@ -1165,19 +1159,38 @@ for ((n=1; n<=noOfTablets; n++)); do
    fi
    sysType=$(echo "$myAirData" | jq -e ".system.sysType" | sed 's/ /_/g' | sed 's/\"//g')
    tspModel=$(echo "$myAirData" | jq -e ".system.tspModel" | sed 's/ /_/g' | sed 's/\"//g')
-   # Create the myPlaceModelQueue for this AA system
-   myPlaceModelQueue
 
    hasAircons=$(echo "$myAirData"|jq -e ".system.hasAircons")
    noOfAircons=$(echo "$myAirData"|jq -e ".system.noOfAircons")
    hasLights=$(echo "$myAirData"|jq -e ".system.hasLights")
    hasThings=$(echo "$myAirData"|jq -e ".system.hasThings")
 
-   # Create the ${myPlaceBasicKeys}, ${myPlaceConstantsAA} and ${myPlaceQueueTypesAA}
+   # Read the existing Homebridge config.json file
+   readHomebridgeConfigJson
+
+   # Extract MyPlace platform
+   extractMyPlaceConfigFromConfigJson
+
+   # Create the ${myPlaceBasicKeys}
+   # First check whether the original MyPlace platform has its "debug=true" for nonAA system, if so leave that as "true"
+   debugPresence=$( echo "${myPlaceConfig}" | jq ".constants" | grep -v ":2025-debug" | grep "\-debug" )
+   debugMyPlace=false
+   if [ -n "${debugPresence}" ]; then
+      debugMyPlace=true
+   else
+      if [[ "${AAdebug}" = "true" || "${AAdebug2}" = "true" ||"${AAdebug3}" = "true" ]]; then
+         debugMyPlace=true
+      fi
+   fi
    myPlaceBasicKeys
-   myPlaceConstants 
+
+   # Create the ${myPlaceConstantsAA} and ${myPlaceQueueTypesAA}
+   myPlaceConstants
    myPlaceQueueTypes
 
+   # Create the myPlaceModelQueue for this AA system
+   myPlaceModelQueue
+
    # Create the $myPlaceAccessoriesAA
    # Aircon systems
    if [ "$hasAircons" = true ]; then
@@ -1260,14 +1273,10 @@ for ((n=1; n<=noOfTablets; n++)); do
 
 done
 
-# Read the existing Homebridge config.json file
-readHomebridgeConfigJson
-
-# Extract all non-AA related MyPlace devices
-extractMyPlaceConfigFromConfigJson
+# Extract all non-AA related MyPlace accessories, constants and queueTypes
 extractNonAAaccessoriesrConstantsQueueTypesMisc
 
-# Extract related "devices" keys
+# Extract the MyPlace "devices" keys
 extractMyPlaceDevices
 if [ "${UIversion}" = "nonUI" ]; then 
    updateMyPlaceDevices
@@ -1276,7 +1285,7 @@ fi
 # Assemble a complete MyPlace configuration file for AA device(s)
 assembleMyPlaceConfigAA
 
-# Assemble a complete MyPlace configuration file for AA devices(s) with the extracted with non-AA devices, if any.
+# Assemble a complete MyPlace configuration file for AA devices(s) with the extracted non-AA devices (if any).
 assembleMyPlaceConfigAAwithNonAA
 
 # Write the assembled AA + non-AA MyPlace configuration into the Homebridge config.json

package/README.md

@@ -28,7 +28,7 @@ An independent plugin bringing [Advantage Air](https://www.advantageair.com.au/)
 ### 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. 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.
+2. 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.  Once install, click on the three dots at the bottom right and select `JSON Config`, a pop-up box showing a small config in it. Do not edit anything but click `SAVE`.  More pop-up boxes may appear, click `SAVE` to all until you are prompted to `RESTART HOMEBRIDGE`.  You do not need to restart homebridge but can click `CLOSE` now to move on to the next step.
   
      <p align="left">
      <img width="400px" src="Screenshots/MyPlaceInstall3.png">
@@ -38,10 +38,7 @@ An independent plugin bringing [Advantage Air](https://www.advantageair.com.au/)
    jq --version
    curl --version
    ```
-   If they are installed, the above command should return a version number.
-
-4. If not already, install <B>jq</B> and <B>curl</B> via your Homebridge UI terminal or through ssh:
-
+   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>
@@ -59,21 +56,23 @@ An independent plugin bringing [Advantage Air](https://www.advantageair.com.au/)
    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. To install the lastest and **MUCH faster** version of jq-1.7.1, please follow the step-by-step guide below:
+   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:
+   
+      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
-      https://github.com/jqlang/jq/releases/download/jq-1.7.1/jq-1.7.1.tar.gz
+      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:
+   
+      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
+      sudo apt-get install -y autoconf automake libtool make gcc
       ```
    3. Extract and Build:
-   Extract the downloaded tarball and navigate to the directory:
+   
+      Extract the downloaded tarball and navigate to the directory:
       ```shell
       tar -xvzf jq-1.7.1.tar.gz
       cd jq-1.7.1
@@ -86,12 +85,13 @@ An independent plugin bringing [Advantage Air](https://www.advantageair.com.au/)
       sudo make install
       ```
    5. Verify Installation:
+
       After installation, you can verify that jq is installed correctly by running:
       ```shell
       jq --version
       ```
 
-6. Create your Homebridge `config.json`
+4. Create MyPlace configuration file:
    
    Go to the 'Plugins' tab in Homebridge UI, locate your newly installed `Homebridge Myplace` plugin and click the three dots on the bottom right, select `Plugin Config` and it should launch the <B>Configuration Creator and Checker</B> and <B>Device 
    Settings</B> page.
@@ -100,10 +100,12 @@ An independent plugin bringing [Advantage Air](https://www.advantageair.com.au/)
         </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 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 HOMEBRIDGE`.
-
-   *Please use only alphanumeric, space, and apostrophe characters for `Name`.*
      
-    Go back to `Plugin Config` again and press the `CREATE CONFIGURATION` button to create the required configuration file.  On a sucess, 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 Homebridge.
+   Go back to `Plugin Config` again 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 HOMEBRIDGE`.
 
    **HOOBS** users who do not have access to Homebridge UI (for now!) will have to run the Config Creator on a terminal:
    ```shell
@@ -137,14 +139,16 @@ Both the <B>Thermostat</B> and <B>Fan</B> switch has associated fan speed contro
 <img width="240px" src="Screenshots/Timer_homekit_UI.png">
 </p>
 
-A timer is repurposed from <B>Lightbulb</B> accessory and its <B>%-brightness</B> as proxy for duration configured to represent 6 minutes per 1%. 10%-timer is then a 60-minutes or 1-hour timer and 25%-timer is a 2.5-hours timer. A maximum of 10-hour timer (100%-timer) can be set. This timer will turn ON or OFF the Aircon system.
+A timer is repurposed from <B>Lightbulb</B> accessory and its <B>%-brightness</B> as proxy for timer duration, configured to represent 6 minutes per 1%. So a 10%-timer is a 60-minutes or 1-hour timer and 25%-timer is a 2.5-hours timer. A maximum of 10-hour timer (100%-timer) can be set. This timer will turn ON or OFF the Aircon system.
 
-If <B>Include extra timers</B> is checked during the setup process, 3 more timers would have been created- a <B>Fan Timer</B>, a <B>Cool Timer</B> and a <B>Heat Timer</B>:
+If <B>Include extra timers</B> was selected during the setup process, 3 more timers would have been created- a <B>Fan Timer</B>, a <B>Cool Timer</B> and a <B>Heat Timer</B>:
 <p align="left">
 <img width="300px" src="Screenshots/FancyTimers_homekit_tiles.png">
 </p>
 
-These timers will turn ON the Aircon system in specific mode as their names suggest. *Please note that the icons on the Timer tiles in the example above have been deliberately changed to distinguish them from lights. All timers are repurposed from <B>Lightbulb</B> accessory.*
+These timers will turn ON the Aircon system in specific mode as their names suggest. 
+
+*Please note that the icons on the Timer tiles in the example above have been deliberately changed to distinguish them from lights.*
 
 #### (iii) Zone Control
 <p align="left">
@@ -154,7 +158,9 @@ These timers will turn ON the Aircon system in specific mode as their names sugg
 
 Zone control is repurposed from <B>Fan</B> accessory with its <B>%-rotationSpeed</B> as proxy for zone %-open.  
 
-For zones with temperature sensors and with myZone defined, a <B>myZone</B> switch, repurposed from <B>rotationDirection</B> will appear as a round button. Turn this button <B>ON</B> to set this zone as myZone.  *Please note that as per Advantage Air system design, myZone cannot be turned <B>OFF</B>. It can only be turned <B>OFF</B> by setting another zone as myZone.  Moreover, %-open for these zones cannot be set.  It is set automatically by the system.*
+For zones with temperature sensors and with myZone defined, a <B>myZone</B> switch, repurposed from <B>rotationDirection</B> will appear as a round button. Turn this button <B>ON</B> to set this zone as myZone.  
+
+*Please note that as per Advantage Air system design, myZone cannot be turned <B>OFF</B>. It can only be turned <B>OFF</B> by setting another zone as myZone.  Moreover, %-open for zones with temperature sensors cannot be set manually.  It is set automatically by the system.*
 
 For zone current temperature info, click the setting button.
 

package/RUNNING_CHANGELOG.md

@@ -1,4 +1,9 @@
 ### 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.0.3 (2024-09-27)
+
+###### (1) Bug fixes to ConfigCreator.sh and CheckConfig.sh
+###### (2) Minor update to README.md
+
 ##### v2.0.2 (2024-09-18)
 
 ###### (1) Re-coded ConfigCreator to use jq to create all config and enabled updating of devices info in config.json even when it is run from terminal.

package/package.json

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