homebridge-myplace 2.3.0 → 2.3.1

package/CHANGELOG.md

@@ -1,7 +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.3.0 (2025-10-02)
+##### v2.3.1 (2025-10-22)
 
-###### (1) Automatic device discovery: AdvantageAir devices can now be auto-discovered if no IP is specified, or if the configured IP is invalid or inaccessible.
-###### (2) Smart fan detection: Any lighting switch with a name ending in " Fan" or " Ex", or starting with "Fan " or "Ex ", will now be treated as a fan accessory.
-###### (3) Accessory limit option: Added an optional parameter to cap the number of accessories created by this plugin (Homebridge supports a maximum of 149 accessories per bridge).
-###### (4) Stability improvements: Bug fixes and under-the-hood enhancements for improved reliability and robustness.
+###### (1) Allow up to 5 retries of inaccessible device before proceeding to auto-discovery.
+###### (2) Minor bug fixes.

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

package/MyPlace.sh

@@ -1,32 +1,7 @@
 #!/bin/bash
 
 #########################################################################
-# Many thanks to John Talbot of homebridge-cmd4 and Mitch Williams of 
-# homebridge-cmd4-advantageair for all their inital works from which this
-# work was evolved from...
-#
-# Evolution credited to @uswong:
-# 1. Fan speed control (2022)
-# 2. Store myAirData in cache up to 2 minutes (2022)
-# 3. Extend the control to lights and things (2022)
-# 4. Update cache on Set request (2022)
-# 5. Zone closing control (2022)
-# 6. ConfigCreator - Created homebridge UI and developed scriptes to automate 
-#    the generation of configuration file required (2023)
-# 7. Optional extra timers to turn on aircon in specific mode (2023)
-# 8. Added myZone capability (2023)
-# 9. Added temperature control for zones with temperature sensor (2024)
-#
-# Game changer 1: storing myAirData in cache up to 2 minutes was a real game
-# changer. This allows a big system with hundreds of devices to run properly,
-# otherwise the AdvantageAir tablet will get overwhelmed with Get requests and
-# will stop working.
-#
-# Game changer 2: ConfigCreator was another game changer.  It was a dreadful
-# task to create a configureation file especially for a big system with
-# hundred of devices, many users shy away from it.  To be able to automate
-# the generation of the configureation file make this plugin so easy and
-# simple to set up. 
+# This shell script interacts with the AdvantageAir device
 #########################################################################
 
 # Lets be explicit
@@ -158,13 +133,13 @@ function logError()
    } > "$fileName"
 
    if [ "${io}" = "Set" ]; then
-      logQueryAirConDiagnostic "Unhandled $io $device $characteristic $value rc=$rc - this accessory is most likely offline"
+      logDiagnostic "Unhandled $io $device $characteristic $value rc=$rc - this accessory is most likely offline"
    elif [ "${io}" = "Get" ]; then
-      logQueryAirConDiagnostic "Unhandled $io $device $characteristic rc=$rc - this accessory is most likely offline!"
+      logDiagnostic "Unhandled $io $device $characteristic rc=$rc - this accessory is most likely offline!"
    fi
 }
 
-function logQueryAirConDiagnostic()
+function logDiagnostic()
 {
    if [ "$debugSpecified" != true ]; then
       return
@@ -223,16 +198,16 @@ function queryAirCon()
       tf=$(cat "$dateFile")
       dt=$(( t0 - tf ))
       if [ "$dt" -le 120 ]; then
-         useFileCache=true 
+         useFileCache=true
       elif [[ "$dt" -gt 180  &&  -f "$lockFile" ]]; then # an earlier curl may have timed out
          tlf=$(cat "$lockFile")
          dtlf=$(( t0 - tlf ))
 
          # If earlier curl timed out, recover by removing the lockFile and try again in 1.2s (max 5 tries)
-         if [ "$dtlf" -ge 60 ]; then 
+         if [ "$dtlf" -ge 60 ]; then
             rm "$lockFile"
             rc=99
-            logQueryAirConDiagnostic "queryAirCon_calls_earlier_curl_timed_out $tf $t0 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
+            logDiagnostic "get_data_earlier_curl_timed_out $tf $t0 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
 
             # To test the logic, issue this comment
             if [ "$selfTest" = "TEST_ON" ]; then
@@ -243,7 +218,7 @@ function queryAirCon()
          fi
       fi
    fi
-   logQueryAirConDiagnostic "queryAirCon_calls $tf $t0 $dt $useFileCache itr=$iteration $io $device $characteristic $url" 
+   logDiagnostic "get_data $tf $t0 $dt $useFileCache itr=$iteration $io $device $characteristic $url"
 
    # If $lockFile is detected, iterate until it is deleted or 60s whichever is earlier
    # The $lockfile can be there for 1s to 60s (even beyond occasionally) for a big system, with an average of ~6s
@@ -258,9 +233,9 @@ function queryAirCon()
 
          # earlier curl has timed out (timeout:60000) - this rarely happen (<0.1% of the time)
          # flag it, remove the $lockFile and copy the existing cached file, try again next cycle.
-         if [ "$dtlf" -ge 60 ]; then  
+         if [ "$dtlf" -ge 60 ]; then
             rc=98
-            logQueryAirConDiagnostic "queryAirCon_timed_out_so_copy_earlier_cache $t0 $t2 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
+            logDiagnostic "get_timed_out_so_copy_earlier_cache $t0 $t2 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
 
             # Remove the lockFile
             rm "$lockFile"
@@ -269,12 +244,12 @@ function queryAirCon()
             if [ "$selfTest" = "TEST_ON" ]; then
                echo "Earlier \"curl\" to getSystemData has timed out, recover and just copy the earlier cache"
             fi
-            break 
+            break
          fi
       done
       myAirData=$( cat "$MY_AIRDATA_FILE" )
       rc=$?
-      logQueryAirConDiagnostic "queryAirCon_copy  $t0 $t2 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
+      logDiagnostic "get_copy $t0 $t2 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
 
       # To test the logic, issue this comment
       if [ "$selfTest" = "TEST_ON" ]; then
@@ -297,24 +272,24 @@ function queryAirCon()
          #Need to parse to ensure the json file is not empty
          parseMyAirDataWithJq ".aircons.$ac.info" "${exitOnFail}"
          if [ "$rc" = "0" ]; then
-            t2=$(date '+%s') 
+            t2=$(date '+%s')
             echo "$t2" > "$dateFile"  # overwrite $dateFile
-            #if $myAirData is not the same as the cached file, overwrite it with the new $myAirData 
+            #if $myAirData is not the same as the cached file, overwrite it with the new $myAirData
             if [ -f "$MY_AIRDATA_FILE" ]; then isMyAirDataSameAsCached; fi
             if [ $sameAsCached = false ]; then echo "$myAirData" > "$MY_AIRDATA_FILE"; fi
             dt=$((t2 - t0))  # time-taken for curl command to complete
-            logQueryAirConDiagnostic "queryAirCon_curl  $t0 $t2 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
+            logDiagnostic "get_curl $t0 $t2 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
          else
             echo "{}" > "$MY_AIRDATA_FILE"
-            echo "$t2" > "$dateFile" 
-            logQueryAirConDiagnostic "queryAirCon_curl_invalid $t0 $t2 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
+            echo "$t2" > "$dateFile"
+            logDiagnostic "get_curl_invalid $t0 $t2 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
             # just in case
             unset myAirData
          fi
       else
          echo "{}" > "$MY_AIRDATA_FILE"
-         echo "$t2" > "$dateFile" 
-         logQueryAirConDiagnostic "queryAirCon_curl_failed $t0 $t2 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
+         echo "$t2" > "$dateFile"
+         logDiagnostic "get_curl_failed $t0 $t2 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
          unset myAirData
       fi
       rm "$lockFile"
@@ -347,7 +322,7 @@ function isMyAirDataSameAsCached()
       return
    fi
    # For aircon system with temperature sensors, "rssi" and "measuredTemp" are changing all the time
-   # do not need to compare "rssi" but if "measuredTemp" is changed, cached file will be updated 
+   # do not need to compare "rssi" but if "measuredTemp" is changed, cached file will be updated
    # compare only the aircons, lights and things - all the rest does not matter
    aircons=$(echo "$myAirData"|jq -ec ".aircons[]"|sed s/rssi\":[0-9]*/rssi\":0/g)
    lights=$(echo "$myAirData"|jq -ec ".myLights.lights[]")
@@ -387,9 +362,9 @@ function setAirConUsingIteration()
       curlResult=$(curl --fail -s -g "$url")
       rc=$?
       curlResult=$(echo "${curlResult}" | grep false)
-      if [[ "$rc" = "0" && -n "${curlResult}" ]]; then rc=5; fi 
+      if [[ "$rc" = "0" && -n "${curlResult}" ]]; then rc=5; fi
 
-      logQueryAirConDiagnostic "setAirCon_curl $t3 rc=$rc itr=$i $io $device $characteristic $value $url"
+      logDiagnostic "set_curl $t3 rc=$rc itr=$i $io $device $characteristic $value $url"
 
       if [ "$rc" = "0" ]; then
          # update $MY_AIRDATA_FILE directly instead of fetching a new copy from AdvantageAir controller after a set command
@@ -400,7 +375,7 @@ function setAirConUsingIteration()
       fi
 
       if [ "$exitOnFail" = "1" ]; then
-         logQueryAirConDiagnostic "setAirCon_curl_failed $t3 rc=$rc $io $device $characteristic $value $url"
+         logDiagnostic "set_curl_failed $t3 rc=$rc $io $device $characteristic $value $url"
          logError "SetAirCon_curl failed" "" "$io" "$url"
          exit $rc
       fi
@@ -412,7 +387,7 @@ function setAirConUsingIteration()
 function updateMyAirDataCachedFile()
 {
    local url="$1"
- 
+
    # This script to parse the curl $url: input   - 'http://192.168.0.31:2025/setAircon?json={ac1:{zones:{z04:{state:open}}}}'
    #             into jq set path:      output  - '.aircons.ac1.zones.z04.state="open"'
 
@@ -420,11 +395,11 @@ function updateMyAirDataCachedFile()
    #                                     output  - '.aircons.ac1.zones.z04.value=90'
 
    #                                     input   - 'http://192.168.0.31:2025/setAircon?json={ac1:{info:{state:on,mode:vent}}}'
-   #                                     output1 - '.aircons.ac1.info.state="on"    
+   #                                     output1 - '.aircons.ac1.info.state="on"
    #                                     output2 - '.aircons.ac1.info.mode="vent"
 
    local setNumber
-   local setMode 
+   local setMode
    local jqPathToSetJson
    local jqPathToSetJsonState
 
@@ -454,7 +429,7 @@ function updateMyAirDataCachedFile()
          ;;
       setLight)
          setJqPath=$(echo "$setJqPath"|sed s/setLight?json=id./.myLights.lights.\"/|sed s/,/\"./)
-         if [ -n "$setNumber" ]; then 
+         if [ -n "$setNumber" ]; then
             jqPathToSetJson=$setJqPath
          else  # value is a string
             setJqPath=${setJqPath//=/=\"}
@@ -471,7 +446,7 @@ function updateMyAirDataCachedFile()
 
 function updateMyAirDataCachedFileWithJq()
 {
-   # this script to use jq to update the $MY_AIRDATA_FILE 
+   # this script to use jq to update the $MY_AIRDATA_FILE
 
    local url="$1"
    local jqPath="$2"
@@ -481,13 +456,13 @@ function updateMyAirDataCachedFileWithJq()
    rc=$?
    if [ "$rc" = "0" ]; then
       echo "$updatedMyAirData" > "$MY_AIRDATA_FILE"
-      logQueryAirConDiagnostic "setAirCon_setJson $t3 rc=$rc $io $device $characteristic $jqPath"
+      logDiagnostic "set_json $t3 rc=$rc $io $device $characteristic $jqPath"
       if [ "$selfTest" = "TEST_ON" ]; then
          # For Testing, you can compare whats sent
          echo "Setting json: $jqPath"
       fi
    else
-      logQueryAirConDiagnostic "setAirCon_setJson_failed $t3 rc=$rc $io $device $characteristic $jqPath"
+      logDiagnostic "set_json_failed $t3 rc=$rc $io $device $characteristic $jqPath"
       logError "setAirCon_setJson jq failed" "$jqPath" "" "$url"
       exit $rc
    fi
@@ -503,7 +478,7 @@ function parseMyAirDataWithJq()
    # Understanding jq options
    # -e                  (Upon bad data, exit with return code )
    # Updates global variable jqResult
-   jqResult=$( echo "$myAirData" | jq -e "$jqPath" )
+   jqResult=$( echo "$myAirData" | jq -er "$jqPath" )
    rc=$?
    if [ "$rc" = "1" ] && [ "$jqResult" = false ]; then   # "false" is an acceptable answer
       rc=0
@@ -514,7 +489,7 @@ function parseMyAirDataWithJq()
          echo "Parsing for jqPath failed: $jqPath";
       fi
       if [ "$exitOnFail" = "1" ]; then
-         logQueryAirConDiagnostic "parseMyAirDataWithJq_failed rc=$rc jqResult=$jqResult $io $device $characteristic $jqPath"
+         logDiagnostic "parseMyAirDataWithJq_failed rc=$rc jqResult=$jqResult $io $device $characteristic $jqPath"
          logError "jq failed" "$rc" "$jqResult" "" "$jqPath"
          exit $rc
       fi
@@ -590,17 +565,17 @@ function closeZoneWithZoneOpenCounter()
 
 function setMyZoneToAnOpenedZoneWithTempSensorWithPriorityToCzones()
 {
-   # set myZone to an open zone with priority to an open cZone.  
+   # set myZone to an open zone with priority to an open cZone.
    # Note: this routine is only called for the case where zoneOpen > noOfConstants.
 
    for cZone in $cZone1 $cZone2 $cZone3; do
       if [[ "${cZone}" != "z00" && "${cZone}" != "${zone}" ]]; then
          parseMyAirDataWithJq ".aircons.$ac.zones.${cZone}.state"
-         if [ "${jqResult}" = '"open"' ]; then
+         if [ "${jqResult}" = "open" ]; then
             parseMyAirDataWithJq ".aircons.$ac.zones.${cZone}.rssi"
             if [ "${jqResult}" != "0" ]; then
                myZone="${cZone}"
-               myZoneValue=$((10#$( echo "${myZone}" | cut -d"z" -f2 ))) 
+               myZoneValue=$((10#$( echo "${myZone}" | cut -d"z" -f2 )))
                setAirConUsingIteration "http://$IP:$PORT/setAircon?json={$ac:{info:{myZone:$myZoneValue}}}"
                myZoneAssigned=true
                # the target temperature of myZone needs to be copied to the system target temperature
@@ -617,7 +592,7 @@ function setMyZoneToAnOpenedZoneWithTempSensorWithPriorityToCzones()
       ZoneStr=$( printf "z%02d" "${Zone}" )
       if [[ "${ZoneStr}" != "${zone}" && "${ZoneStr}" != "${cZone1}" && "${ZoneStr}" != "${cZone2}" && "${ZoneStr}" != "${cZone3}" ]]; then
          parseMyAirDataWithJq ".aircons.$ac.zones.${ZoneStr}.state"
-         if [ "${jqResult}" = '"open"' ]; then
+         if [ "${jqResult}" = "open" ]; then
             parseMyAirDataWithJq ".aircons.$ac.zones.${ZoneStr}.rssi"
             if [ "${jqResult}" != "0" ]; then
                myZone="${ZoneStr}"
@@ -635,13 +610,13 @@ function setMyZoneToAnOpenedZoneWithTempSensorWithPriorityToCzones()
 
 function openAclosedCzone()
 {
-   # Open up a closed cZone 
+   # Open up a closed cZone
    # Note: this routine is only called for the case where zoneOpen = noOfConstants.
 
    for cZone in $cZone1 $cZone2 $cZone3; do
       if [ "${cZone}" != "z00" ]; then
          parseMyAirDataWithJq ".aircons.$ac.zones.${cZone}.state"
-         if [ "${jqResult}" = '"close"' ]; then
+         if [ "${jqResult}" = "close" ]; then
             openZoneInFullWithZoneOpenCounter "${cZone}"
             return
          fi
@@ -656,7 +631,7 @@ function openAclosedZoneWithTempSensorWithPriorityToCzones()
    for cZone in $cZone1 $cZone2 $cZone3; do
       if [[ "${cZone}" != "z00" && "${cZone}" != "${zone}" ]]; then
          parseMyAirDataWithJq ".aircons.$ac.zones.${cZone}.state"
-         if [ "${jqResult}" = '"close"' ]; then
+         if [ "${jqResult}" = "close" ]; then
             parseMyAirDataWithJq ".aircons.$ac.zones.${cZone}.rssi"
             if [ "${jqResult}" != "0" ]; then
                openZoneInFullWithZoneOpenCounter "${cZone}"
@@ -670,7 +645,7 @@ function openAclosedZoneWithTempSensorWithPriorityToCzones()
       ZoneStr=$( printf "z%02d" "${Zone}" )
       if [[ "${ZoneStr}" != "${zone}" && "${ZoneStr}" != "${cZone1}" && "${ZoneStr}" != "${cZone2}" && "${ZoneStr}" != "${cZone3}" ]]; then
          parseMyAirDataWithJq ".aircons.$ac.zones.${ZoneStr}.state"
-         if [ "${jqResult}" = '"close"' ]; then
+         if [ "${jqResult}" = "close" ]; then
             parseMyAirDataWithJq ".aircons.$ac.zones.${ZoneStr}.rssi"
             if [ "${jqResult}" != "0" ]; then
                openZoneInFullWithZoneOpenCounter "${ZoneStr}"
@@ -729,30 +704,30 @@ function queryTimerStateFile()
 
    # Get the state of the fan mode
    if [ $fanTimerSpecified = true ]; then
-      if [[ "${acState}" = '"on"' && "${acMode}" = '"vent"' ]]; then
+      if [[ "${acState}" = "on" && "${acMode}" = "vent" ]]; then
          fanState=1
       else
          fanState=0
       fi
-      logQueryAirConDiagnostic "queryFanTimer           ${t0} ${t0} fanState=${fanState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
+      logDiagnostic "get_FanTimer        ${t0} fanState=${fanState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
 
    # Get the state of the cool mode
    elif [ $coolTimerSpecified = true ]; then
-      if [[ "${acState}" = '"on"' && "${acMode}" = '"cool"' ]]; then
+      if [[ "${acState}" = "on" && "${acMode}" = "cool" ]]; then
          coolState=1
       else
          coolState=0
       fi
-      logQueryAirConDiagnostic "queryCoolTimer          ${t0} ${t0} coolState=${coolState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
+      logDiagnostic "get_CoolTimer       ${t0} coolState=${coolState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
 
    # Get the state of the heat mode
    elif [ $heatTimerSpecified = true ]; then
-      if [[ "${acState}" = '"on"' && "${acMode}" = '"heat"' ]]; then
+      if [[ "${acState}" = "on" && "${acMode}" = "heat" ]]; then
          heatState=1
       else
          heatState=0
       fi
-      logQueryAirConDiagnostic "queryHeatTimer          ${t0} ${t0} heatState=${heatState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
+      logDiagnostic "get_HeatTimer       ${t0} heatState=${heatState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
    fi
 }
 
@@ -762,7 +737,7 @@ function updateTimer()
    local mode="$2"
 
    if [ "$selfTest" = "TEST_ON" ]; then
-      t0=$((setTime + 2)) 
+      t0=$((setTime + 2))
    fi
 
    # Update fan timer
@@ -797,11 +772,11 @@ function updateTimer()
 
    # Diagnostic logging
    if [ $fanTimerSpecified = true ]; then
-      logQueryAirConDiagnostic "updateFanTimer          ${t0} ${t0} fanState=${fanState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
+      logDiagnostic "upd_FanTimer        ${t0} fanState=${fanState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
    elif [ $coolTimerSpecified = true ]; then
-      logQueryAirConDiagnostic "updateCoolTimer         ${t0} ${t0} coolState=${coolState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
+      logDiagnostic "upd_CoolTimer       ${t0} coolState=${coolState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
    elif [ $heatTimerSpecified = true ]; then
-      logQueryAirConDiagnostic "updateHeatTimer         ${t0} ${t0} heatState=${heatState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
+      logDiagnostic "upd_HeatTimer       ${t0} heatState=${heatState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
    fi
 
    if [ "${mode}" = "vent" ]; then mode="fan"; fi
@@ -820,23 +795,21 @@ function updateTimerStateFile()
 
    # Diagnostic logging
    if [ "${io}" = "Get" ]; then
-      prefix="update"
-      space=""
+      prefix="upd"
    else
       prefix="set"
-      space="e  "
    fi
 
    if [ "$selfTest" = "TEST_ON" ]; then
-      echo "Update the timer state file: ${TIMER_STATE_FILE} with timeToOn: ${timeToOn} and timeToOff: ${timeToOff}" 
+      echo "Update the timer state file: ${TIMER_STATE_FILE} with timeToOn: ${timeToOn} and timeToOff: ${timeToOff}"
    fi
 
    if [ $fanTimerSpecified = true ]; then
-      logQueryAirConDiagnostic "${prefix}FanTimerStateFil${space}  ${t0} ${t0} fanState=${fanState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
+      logDiagnostic "${prefix}_FanTimerState   ${t0} fanState=${fanState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
    elif [ $coolTimerSpecified = true ]; then
-      logQueryAirConDiagnostic "${prefix}CoolTimerStateFil${space} ${t0} ${t0} coolState=${coolState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
+      logDiagnostic "${prefix}_CoolTimerState  ${t0} coolState=${coolState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
    elif [ $heatTimerSpecified = true ]; then
-      logQueryAirConDiagnostic "${prefix}HeatTimerStateFil${space} ${t0} ${t0} heatState=${heatState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
+      logDiagnostic "${prefix}_HeatTimerState  ${t0} heatState=${heatState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
    fi
 }
 
@@ -893,7 +866,7 @@ if [ $argEND -ge $argSTART ]; then
             PORT="2025"
             ;;
          noOtherThermostat)
-            # If only the control unit Thermostat is specified, ie no zone Thermostat is defined 
+            # If only the control unit Thermostat is specified, ie no zone Thermostat is defined
             noOtherThermostat=true
             ;;
          fanSpeed)
@@ -1002,9 +975,9 @@ if [ "$io" = "Get" ]; then
       # Gets the current temperature.
       CurrentTemperature )
          # check whether a zone is defined, if so, use the measuredTemp of this zone
-         # if not, check myZone is defined, if so, use the measuredTemp of myZone 
-         # if not, check rssi is defined for cZone1, if so, use measuredTemp of cZone1 
-         # if not again, use setTemp   
+         # if not, check myZone is defined, if so, use the measuredTemp of myZone
+         # if not, check rssi is defined for cZone1, if so, use measuredTemp of cZone1
+         # if not again, use setTemp
 
          if [ $zoneSpecified = true ]; then
             parseMyAirDataWithJq ".aircons.$ac.zones.$zone.measuredTemp"
@@ -1013,7 +986,7 @@ if [ "$io" = "Get" ]; then
          fi
          parseMyAirDataWithJq ".aircons.$ac.info.myZone"
          myZone=$( printf "z%02d" "$jqResult" )
-         if [ "${myZone}" != "z00" ]; then 
+         if [ "${myZone}" != "z00" ]; then
             parseMyAirDataWithJq ".aircons.$ac.zones.$myZone.measuredTemp"
             echo "$jqResult"
             exit 0
@@ -1025,7 +998,7 @@ if [ "$io" = "Get" ]; then
             parseMyAirDataWithJq ".aircons.$ac.zones.$cZone1.measuredTemp"
             echo "$jqResult"
             exit 0
-         else 
+         else
             parseMyAirDataWithJq ".aircons.$ac.info.setTemp"
             echo "$jqResult"
             exit 0
@@ -1041,7 +1014,7 @@ if [ "$io" = "Get" ]; then
             # check whether myZone is defined
             parseMyAirDataWithJq ".aircons.$ac.info.myZone"
             myZone=$( printf "z%02d" "$jqResult" )
-            if [ "${myZone}" != "z00" ]; then 
+            if [ "${myZone}" != "z00" ]; then
                parseMyAirDataWithJq ".aircons.$ac.zones.$myZone.setTemp"
                echo "$jqResult"
                exit 0
@@ -1058,8 +1031,8 @@ if [ "$io" = "Get" ]; then
          parseMyAirDataWithJq ".aircons.$ac.info.state"
          state="$jqResult"
          # If the state of the Aircon is Off, set Main Thermostat to Off (0) and Zone Thermostat to Auto (3)
-         if [  "$state" = '"off"' ]; then
-            if [ $zoneSpecified = true ]; then 
+         if [  "$state" = "off" ]; then
+            if [ $zoneSpecified = true ]; then
                # set to "AUTO" for zoneThermostat
                echo 3
                exit 0
@@ -1074,17 +1047,17 @@ if [ "$io" = "Get" ]; then
          parseMyAirDataWithJq ".aircons.$ac.info.mode"
          mode="$jqResult"
          case "$mode" in
-            '"heat"' )
+            "heat" )
                # Thermostat in Heat Mode.
                echo 1
                exit 0
             ;;
-            '"cool"' )
+            "cool" )
                # Thermostat in Cool Mode.
                echo 2
                exit 0
             ;;
-            '"vent"' )
+            "vent" )
                # for Fan mode, set main Thermostat to Off (0) or zone Thermostat to Auto (3)
                if [ $zoneSpecified = true ]; then
                   echo 3
@@ -1094,7 +1067,7 @@ if [ "$io" = "Get" ]; then
                   exit 0
                fi
             ;;
-            '"dry"' )
+            "dry" )
                # Dry mode, set Thermostat to Auto Mode as a proxy.
                echo 3
                exit 0
@@ -1134,7 +1107,7 @@ if [ "$io" = "Get" ]; then
          if [ $zoneSpecified = true ]; then
             # Damper open/closed = Switch on/off = 1/0
             parseMyAirDataWithJq ".aircons.$ac.zones.$zone.state"
-            if [ "$jqResult" = '"open"' ]; then
+            if [ "$jqResult" = "open" ]; then
                echo 1
                exit 0
             else
@@ -1164,7 +1137,7 @@ if [ "$io" = "Get" ]; then
             # fanSpecified is true when no zone (z01) given or timer given
             # Updates global variable jqResult
             parseMyAirDataWithJq ".aircons.$ac.info.state"
-            if [  "$jqResult" = '"off"' ]; then
+            if [  "$jqResult" = "off" ]; then
                echo 0
                exit 0
             else
@@ -1174,22 +1147,22 @@ if [ "$io" = "Get" ]; then
                parseMyAirDataWithJq ".aircons.$ac.info.mode"
                mode="$jqResult"
                case "$mode" in
-                  '"heat"' )
+                  "heat" )
                      # Fan does not support Heat Mode.
                      echo 0
                      exit 0
                   ;;
-                  '"cool"' )
+                  "cool" )
                      # Fan does not support Cool Mode.
                      echo 0
                      exit 0
                   ;;
-                  '"vent"' )
+                  "vent" )
                      # Set Fan to On.
                      echo 1
                      exit 0
                   ;;
-                  '"dry"' )
+                  "dry" )
                      # Fan does not support Dry Mode.
                      echo 0
                      exit 0
@@ -1204,7 +1177,7 @@ if [ "$io" = "Get" ]; then
          elif [ $zoneSpecified = true ]; then
             # Damper open/closed = Switch on/off = 1/0
             parseMyAirDataWithJq ".aircons.$ac.zones.$zone.state"
-            if [ "$jqResult" = '"open"' ]; then
+            if [ "$jqResult" = "open" ]; then
                echo 1
                exit 0
             else
@@ -1287,7 +1260,7 @@ if [ "$io" = "Get" ]; then
                exit 0
          elif [ $lightSpecified = true ]; then
             parseMyAirDataWithJq ".myLights.lights.\"${lightID}\".state"
-            if [ "$jqResult" = '"on"' ]; then
+            if [ "$jqResult" = "on" ]; then
                echo 1
                exit 0
             else
@@ -1332,17 +1305,17 @@ if [ "$io" = "Get" ]; then
          elif [ $timerEnabled = true ]; then
             parseMyAirDataWithJq ".aircons.$ac.info.state"
             # Get the timer countDowqnToOff value if the state of the aircon is "on"
-            if [ "$jqResult" = '"on"' ]; then
+            if [ "$jqResult" = "on" ]; then
                parseMyAirDataWithJq ".aircons.$ac.info.countDownToOff"
                timerInPercentage=$(((jqResult / 6) + (jqResult % 6 > 0)))
-               timerInPercentage=$((timerInPercentage < 100? timerInPercentage : 100)) 
+               timerInPercentage=$((timerInPercentage < 100? timerInPercentage : 100))
                echo $((timerInPercentage > 1? timerInPercentage : 1))
                exit 0
             # Get the timer countDownToOn value if the state of the aircon is "off"
             else
                parseMyAirDataWithJq ".aircons.$ac.info.countDownToOn"
                timerInPercentage=$(((jqResult / 6) + (jqResult % 6 > 0)))
-               timerInPercentage=$((timerInPercentage < 100? timerInPercentage : 100)) 
+               timerInPercentage=$((timerInPercentage < 100? timerInPercentage : 100))
                echo $timerInPercentage
                exit 0
             fi
@@ -1364,15 +1337,15 @@ if [ "$io" = "Get" ]; then
          else
             # Update the current fan speed
             parseMyAirDataWithJq ".aircons.$ac.info.fan"
-            if [ "$jqResult" = '"low"' ]; then
+            if [ "$jqResult" = "low" ]; then
                #25% as low speed
                echo 25
                exit 0
-            elif [ "$jqResult" = '"medium"' ]; then
+            elif [ "$jqResult" = "medium" ]; then
                #50% as medium speed
                echo 50
                exit 0
-            elif [ "$jqResult" = '"high"' ]; then
+            elif [ "$jqResult" = "high" ]; then
                #90% as high speed
                echo 90
                exit 0
@@ -1431,7 +1404,7 @@ if [ "$io" = "Set" ]; then
          else
             setAirConUsingIteration "http://$IP:$PORT/setAircon?json={$ac:{info:{setTemp:$value}}}"
             # if myZone is defined, set the target temperature to the defined myZone too
-            if [ "${myZone}" != "z00" ]; then 
+            if [ "${myZone}" != "z00" ]; then
                setAirConUsingIteration "http://$IP:$PORT/setAircon?json={$ac:{zones:{$myZone:{setTemp:$value}}}}"
             elif [ $noOtherThermostat = true ]; then
                # if myZone is not defined and noOtherThermostat=true, set the target temperature to all zones with temperature sensors
@@ -1477,7 +1450,7 @@ if [ "$io" = "Set" ]; then
                # Before setting myZone open the zone if it is currently closed
                myZoneValue=$(( 10#$( echo "${zone}" | cut -d'z' -f2 ) ))
                parseMyAirDataWithJq ".aircons.$ac.zones.$zone.state"
-               if [ "${jqResult}" = '"close"' ]; then
+               if [ "${jqResult}" = "close" ]; then
                   setAirConUsingIteration "http://$IP:$PORT/setAircon?json={$ac:{zones:{$zone:{state:open}}}}"
                fi
                setAirConUsingIteration "http://$IP:$PORT/setAircon?json={$ac:{info:{myZone:$myZoneValue}}}"
@@ -1515,7 +1488,7 @@ if [ "$io" = "Set" ]; then
                # the aircon system before closing any zone:
                # > if the only zone(s) open is/are the constant zone(s), leave it open (and set it to 100%).
                # > if the constant zone(s) is/are in close state, and to close this zone will reduce the number
-               # > of zones open below ${noOfConstants}, then one constant zone will open (and set to 100%) before 
+               # > of zones open below ${noOfConstants}, then one constant zone will open (and set to 100%) before
                # > closing this zone.
 
                # retrieve myZone, nZones, noOfConstants, cZone1, cZone2 and cZone3 from $myAirData
@@ -1547,7 +1520,7 @@ if [ "$io" = "Set" ]; then
                   do
                      zoneStr=$( printf "z%02d" "$a" )
                      parseMyAirDataWithJq ".aircons.$ac.zones.$zoneStr.state"
-                     if [ "$jqResult" = '"open"' ]; then
+                     if [ "$jqResult" = "open" ]; then
                         zoneOpen=$((zoneOpen + 1))
                      fi
                   done
@@ -1557,7 +1530,7 @@ if [ "$io" = "Set" ]; then
                   # If there are more than "$noOfConstants" zones open, it is safe to close this zone.
                   # BUT if this zone is myZone then set myZone to an open cZone or if all cZones are
                   # closed, set myZone to a next open zone before closing this zone.
-                  if [ "${zone}" = "${myZone}" ]; then 
+                  if [ "${zone}" = "${myZone}" ]; then
                      setMyZoneToAnOpenedZoneWithTempSensorWithPriorityToCzones
                      if [ "$myZoneAssigned" = false ]; then
                         openAclosedZoneWithTempSensorWithPriorityToCzones
@@ -1577,8 +1550,8 @@ if [ "$io" = "Set" ]; then
                else
                   # If only "$noOfConstants" zones open and the zone to close is not a cZone but a myZone, then open a
                   # closed zone with temperature sensor with priority to cZones and set myZone to it before closing this
-                  # zone. If the zone to close is also not a myZone, then just open a closed cZone before closing this zone. 
-                  if [ "${zone}" = "${myZone}" ]; then 
+                  # zone. If the zone to close is also not a myZone, then just open a closed cZone before closing this zone.
+                  if [ "${zone}" = "${myZone}" ]; then
                      openAclosedZoneWithTempSensorWithPriorityToCzones
                      setMyZoneToAnOpenedZoneWithTempSensorWithPriorityToCzones
                   else
@@ -1709,7 +1682,7 @@ if [ "$io" = "Set" ]; then
             # Make 10% to 1 hour (1% = 6 minutes) and capped at a max of 600 minutes
             timerInMinutes=$((value * 6))
             parseMyAirDataWithJq ".aircons.$ac.info.state"
-            if [ "$jqResult" = '"on"' ]; then
+            if [ "$jqResult" = "on" ]; then
                setAirConUsingIteration "http://$IP:$PORT/setAircon?json={$ac:{info:{countDownToOff:$timerInMinutes}}}"
             else
                setAirConUsingIteration "http://$IP:$PORT/setAircon?json={$ac:{info:{countDownToOn:$timerInMinutes}}}"

package/README.md

@@ -1,180 +1,180 @@
-<span align="center">
-
-<p align="center">
-<img src="Screenshots/homebridge-myplace.png" width="220">
-</p>
-
-# homebridge-myplace
-
-[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
-[![homebridge-myplace](https://badgen.net/npm/v/homebridge-myplace?icon=npm)](https://www.npmjs.com/package/homebridge-myplace)
-[![npm](https://badgen.net/npm/dt/homebridge-myplace?label=downloads)](https://www.npmjs.com/package/homebridge-myplace)
-[![mit-license](https://badgen.net/npm/license/lodash)](https://github.com/uswong/homebridge-myplace/blob/master/LICENSE)
-[![join-discord](https://badgen.net/badge/icon/discord?icon=discord&label=homebridge-myplace)](https://discord.gg/uaEXgtt72q)
-
-
-</span>
-
-An independent plugin bringing [Advantage Air](https://www.advantageair.com.au/) MyPlace System, its smaller siblings (E-zone, MyAir, MyAir4, etc) and its cousins (e.g. Fujitsu AnywAir) to Homekit.
-
-## Supported Advantage Air Control Units
-  * [MyPlace](https://apps.apple.com/au/app/myplace/id996398299)
-  * [MyAir4](https://apps.apple.com/au/app/myair4/id925994861)
-  * [MyAir](https://apps.apple.com/au/app/myair/id481563583)
-  * [E-zone](https://apps.apple.com/au/app/e-zone/id925994857)
-  * [Fujitsu anywAIR](https://apps.apple.com/au/app/anywair/id1509639853)
-
-## Installation
-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. 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 installed, `Config: homebridge-myplace` UI will pop up, then follow the steps outlined in Step 4 below.
-
-     <img width="750px" alt="image" src="https://github.com/user-attachments/assets/0f60e1ee-b7d6-46de-959b-5e42a8ede80f" />
-
-
-     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 to the `Homebridge MyPlace` UI.
-   
-4. Configuring MyPlace plugin:
-   
-   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 for this device`, click `SAVE` then `RESTART`.
-
-   For advanced users, you can expand the **Advanced Plugin Settings** to `Specify the maximum number of accessories (between 1 to 149) to be configured for this plugin`. Homebridge has a grand limit of 149 accessories that can be bridged; it may crash if the total number of accessories from all installed plugins exceeds this limit. You can also check `Enable detailed debug log for this plugin` to view detailed logs and help diagnose any plugin issues.
-     
-   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",
-    "debug": false,
-    "maxAccessories": 120,
-    "devices": [
-        {
-            "name": "Aircon",
-            "ipAddress": "192.168.50.117",
-            "port": 2025,
-            "extraTimers": true,
-            "debug": false
-        }
-    ],
-    "platform": "MyPlace"
-   }
-   ```
-
-   From version 2.3.0 onwards, if the `ipAddress` is missing, incorrectly formatted, or inaccessible, the plugin will automatically discover your connected AdvantageAir systems and configure them.
-
-## How it Looks and Works
-### (A) Aircon System (MyAir, E-zone, etc) has the following typical Homekit tiles:
-<p align="left">
-<img width="300px" src="Screenshots/Aircon_homekit_tiles.png">
-</p>
-
-#### (i) Thermostat, Fan Switch and Fan Speed Control
-<p align="left">
-<img width="240px" src="Screenshots/Thermostat_homekit_UI.png">
- <img width="240px" src="Screenshots/FanSwitch_homekit_UI.png">
-</p>
-
-<B>Thermostat</B> is where the desired target temperature can be set.  
-
-<B>Thermostat</B> has 4 modes- <B>Off</B>, <B>Cool</B>, <B>Heat</B> and <B>Auto</B>. It does not have <B>dry</B> and <B>fan</B> modes.  As such, the <B>Thermostat Auto</B> mode is repurposed as <B>dry</B> mode in this plugin and a separate <B>Fan</B> switch is used for <B>fan</B> mode.
-
-Both the <B>Thermostat</B> and <B>Fan</B> switch has associated fan speed control and either one can be used to set the fan speed. It is duplicated only for convenience. The fan speed control has 4 tiers - <B>low</B>, <B>mid</B>, <B>high</B> and <B>auto</B> or <B>ezfan</B> and the %-rotationSpeed is snapped to 25% for <B>low</B>, 50% for <B>mid</B>, 90% for <B>high</B> and 100% for <B>auto</B> or <B>ezfan</B>.
-
-#### (ii) Timer
-<p align="left">
-<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 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> 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.*
-
-#### (iii) Zone Control
-<p align="left">
-<img width="760px" src="Screenshots/variousZoneControls_homekit_UI.png">
-</p>
-
-Zone control is repurposed from <B>Fan</B> accessory with its <B>%-rotationSpeed</B> as proxy for Zone damper %-open and <B>rotationDirection</B> as <B>myZone</B> button.  <B>Thermostat</B> accessory is used for setting the Zone target temperature.
-
-There are three possible Zone Control configurations depending on the setup of your Aircon system:
-
-<B>(a) A non temperature controlled Zone:</B> If your system has no temperature sensors, then there will only be a simple <B>Fan</B> accessory for your Zone Control.  The Fan slider is for adjusting the desired damper %-open manually.
-
-<B>(b) A temperature controlled Zone but without myZone defined:</B> If your system has temperature sensors but <B>myZone</B> is not defined, then there will be a simple <B>Fan</B> accessory and a <B>Thermostat</B> accessory.           
-
-The Fan slider here is to show the damper %-open for this zone for your INFO only. It is set automatically by the system, it cannot be adjusted manually. To turn off the Zone, slide the slider to zero. To turn it on, tap anywhere within the slider.
-
-The <B>Thermostat</B> is for setting the target temperature for this zone by moving the big white dot. The small white dot is an indicating of the measured temperature of the Zone for your INFO. The mode on this <B>Thermostat</B> is also just for your INFO only. It will show `Cool` or `Heat` when the Aircon mode is `Cool` or `Heat` respectively. It will show `Auto` when the state of the Aircon is `Off` or the mode is `vent` or `dry`. You cannot change the state or the mode of the Aircon here.
-
-<B>(c) A temperature controlled Zone with myZone defined:</B> If your system has temperature sensors and <B>myZone</B> is defined, then there will be a round button for setting this zone as <B>myZone</B> in addition to a simple <B>Fan</B> accessory and a <B>Thermostat</B> accessory as detailed in <B>(b)</B> above.
-
-Please note that <B>myZone</B> cannot be turned `Off` as per AdvantageAir system design. It can only be turned `Off` by setting another zone as <B>myZone</B>.  However, if a Zone, which is set as <B>myZone</B>, is turned off by sliding the Fan slider to zero, this plugin will automatically set another open Zone to be <B>myZone</B> with preference to an open Constant Zone. If there is no other open Zone, then this plugin will open a Zone with preference to a Constant Zone and set it as <B>myZone</B>.
-
-### (B) Lights
-<p align="left">
-<img width="300px" src="Screenshots/Lights_homekit_tiles.png">
-</p>
-
-<p align="left">
-<img width="240px" src="Screenshots/LightWithDimmer_homekit_UI.png">
-<img width="240px" src="Screenshots/LightSwitch_homekit_UI.png">
-</p>
-
-Light with dimmer has a slider to control its brightness while a light without dimmer just has a simple ON/OFF light switch.
-
-### (C) Fans
-
-<p align="left">
-<img width="150px" src="Screenshots/Fan_homekit_tile.jpg">
-</p>
-
-<p align="left">
-<img width="240px" src="Screenshots/Fan_homekit_UI.jpg">
-</p>
-
-From version 2.3.0 onwards, any light switch whose name ends with ‘ Fan’ or ‘ Ex’, or begins with ‘Fan ’ or ‘Ex ’, will be treated as a fan accessory. In HomeKit, its icon will appear as a fan (as shown above) instead of a lightbulb. 
-
-### (D) Garage Door and Blinds
-<p align="left">
-<img width="300px" src="Screenshots/Garage&Blinds_homekit_tiles.png">
-</p>
-
-<p align="left">
-<img width="240px" src="Screenshots/Garage_homekit_UI.png">
-<img width="240px" src="Screenshots/Blinds_homekit_UI.png">
-</p>
-
-Garage Door is either Opened or Closed, hence it appears as a simple switch while Blinds can be partially open, as such, it has a slider to set the %-open.
-
-## How You Can Help
-* Report Bugs/Errors by opening Issues/Tickets.
-* Suggest Improvements and Features you would like to see!
-* If you are loving this plugin or using this plugin, please feel free to give me a `Star`!
-
-
-## Special Thanks
-
-This project would not have been possible without the work of others in the Homebridge community.
-
-1. Many thanks to [Mitch Williams](https://github.com/mitch7391) who has created the wonderful [homebridge-cmd4-AdvantageAir](https://github.com/mitch7391/homebridge-cmd4-AdvantageAir) plugin and has allowed me to participate in its development and in the process I have leant a lot about GitHub and on **bash** and **javascript** coding in homebridge environment.
-2. Many thanks also to [John Talbot](https://github.com/ztalbot2000) for his fantastic [homebridge-cmd4](https://github.com/ztalbot2000/homebridge-cmd4) plugin which I forked and reused most of the original logic, with some modifications and adjustments to meet the requirements of this plugin.
-3. And never forget to thank my beautiful wife who has put up with my obsession on this.....
-
-
-## LICENSE
-This plugin is distributed under the MIT license. See [LICENSE](https://github.com/uswong/homebridge-myplace/blob/main/LICENSE) for details.
+<span align="center">
+
+<p align="center">
+<img src="Screenshots/homebridge-myplace.png" width="220">
+</p>
+
+# homebridge-myplace
+
+[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
+[![homebridge-myplace](https://badgen.net/npm/v/homebridge-myplace?icon=npm)](https://www.npmjs.com/package/homebridge-myplace)
+[![npm](https://badgen.net/npm/dt/homebridge-myplace?label=downloads)](https://www.npmjs.com/package/homebridge-myplace)
+[![mit-license](https://badgen.net/npm/license/lodash)](https://github.com/uswong/homebridge-myplace/blob/master/LICENSE)
+[![join-discord](https://badgen.net/badge/icon/discord?icon=discord&label=homebridge-myplace)](https://discord.gg/uaEXgtt72q)
+
+
+</span>
+
+An independent plugin bringing [Advantage Air](https://www.advantageair.com.au/) MyPlace System, its smaller siblings (E-zone, MyAir, MyAir4, etc) and its cousins (e.g. Fujitsu AnywAir) to Homekit.
+
+## Supported Advantage Air Control Units
+  * [MyPlace](https://apps.apple.com/au/app/myplace/id996398299)
+  * [MyAir4](https://apps.apple.com/au/app/myair4/id925994861)
+  * [MyAir](https://apps.apple.com/au/app/myair/id481563583)
+  * [E-zone](https://apps.apple.com/au/app/e-zone/id925994857)
+  * [Fujitsu anywAIR](https://apps.apple.com/au/app/anywair/id1509639853)
+
+## Installation
+1. Install Homebridge via these instructions for [Raspbian](https://github.com/homebridge/homebridge/wiki/Install-Homebridge-on-Raspbian), [HOOBS](https://support.hoobs.org/docs), [macOS](https://github.com/homebridge/homebridge/wiki/Install-Homebridge-on-macOS) or [Windows](https://github.com/homebridge/homebridge/wiki/Install-Homebridge-on-Virtual-Machine), if you have not already.
+
+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 installed, `Config: homebridge-myplace` UI will pop up, then follow the steps outlined in Step 4 below.
+
+     <img width="750px" alt="image" src="https://github.com/user-attachments/assets/0f60e1ee-b7d6-46de-959b-5e42a8ede80f" />
+
+
+     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 to the `Homebridge MyPlace` UI.
+   
+5. Configuring MyPlace plugin:
+   
+   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 for this device`, click `SAVE` then `RESTART`.
+
+   For advanced users, you can expand the **Advanced Plugin Settings** to `Specify the maximum number of accessories (between 1 to 149) to be configured for this plugin`. Homebridge has a grand limit of 149 accessories that can be bridged; it may crash if the total number of accessories from all installed plugins exceeds this limit. You can also check `Enable detailed debug log for this plugin` to view detailed logs and help diagnose any plugin issues.
+     
+   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",
+    "debug": false,
+    "maxAccessories": 120,
+    "devices": [
+        {
+            "name": "Aircon",
+            "ipAddress": "192.168.50.117",
+            "port": 2025,
+            "extraTimers": true,
+            "debug": false
+        }
+    ],
+    "platform": "MyPlace"
+   }
+   ```
+
+   From version 2.3.0 onwards, if the `ipAddress` is missing, incorrectly formatted, or inaccessible, the plugin will automatically discover your connected AdvantageAir systems and configure them.
+
+## How it Looks and Works
+### (A) Aircon System (MyAir, E-zone, etc) has the following typical Homekit tiles:
+<p align="left">
+<img width="300px" src="Screenshots/Aircon_homekit_tiles.png">
+</p>
+
+#### (i) Thermostat, Fan Switch and Fan Speed Control
+<p align="left">
+<img width="240px" src="Screenshots/Thermostat_homekit_UI.png">
+ <img width="240px" src="Screenshots/FanSwitch_homekit_UI.png">
+</p>
+
+<B>Thermostat</B> is where the desired target temperature can be set.  
+
+<B>Thermostat</B> has 4 modes- <B>Off</B>, <B>Cool</B>, <B>Heat</B> and <B>Auto</B>. It does not have <B>dry</B> and <B>fan</B> modes.  As such, the <B>Thermostat Auto</B> mode is repurposed as <B>dry</B> mode in this plugin and a separate <B>Fan</B> switch is used for <B>fan</B> mode.
+
+Both the <B>Thermostat</B> and <B>Fan</B> switch has associated fan speed control and either one can be used to set the fan speed. It is duplicated only for convenience. The fan speed control has 4 tiers - <B>low</B>, <B>mid</B>, <B>high</B> and <B>auto</B> or <B>ezfan</B> and the %-rotationSpeed is snapped to 25% for <B>low</B>, 50% for <B>mid</B>, 90% for <B>high</B> and 100% for <B>auto</B> or <B>ezfan</B>.
+
+#### (ii) Timer
+<p align="left">
+<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 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> 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.*
+
+#### (iii) Zone Control
+<p align="left">
+<img width="760px" src="Screenshots/variousZoneControls_homekit_UI.png">
+</p>
+
+Zone control is repurposed from <B>Fan</B> accessory with its <B>%-rotationSpeed</B> as proxy for Zone damper %-open and <B>rotationDirection</B> as <B>myZone</B> button.  <B>Thermostat</B> accessory is used for setting the Zone target temperature.
+
+There are three possible Zone Control configurations depending on the setup of your Aircon system:
+
+<B>(a) A non temperature controlled Zone:</B> If your system has no temperature sensors, then there will only be a simple <B>Fan</B> accessory for your Zone Control.  The Fan slider is for adjusting the desired damper %-open manually.
+
+<B>(b) A temperature controlled Zone but without myZone defined:</B> If your system has temperature sensors but <B>myZone</B> is not defined, then there will be a simple <B>Fan</B> accessory and a <B>Thermostat</B> accessory.           
+
+The Fan slider here is to show the damper %-open for this zone for your INFO only. It is set automatically by the system, it cannot be adjusted manually. To turn off the Zone, slide the slider to zero. To turn it on, tap anywhere within the slider.
+
+The <B>Thermostat</B> is for setting the target temperature for this zone by moving the big white dot. The small white dot is an indicating of the measured temperature of the Zone for your INFO. The mode on this <B>Thermostat</B> is also just for your INFO only. It will show `Cool` or `Heat` when the Aircon mode is `Cool` or `Heat` respectively. It will show `Auto` when the state of the Aircon is `Off` or the mode is `vent` or `dry`. You cannot change the state or the mode of the Aircon here.
+
+<B>(c) A temperature controlled Zone with myZone defined:</B> If your system has temperature sensors and <B>myZone</B> is defined, then there will be a round button for setting this zone as <B>myZone</B> in addition to a simple <B>Fan</B> accessory and a <B>Thermostat</B> accessory as detailed in <B>(b)</B> above.
+
+Please note that <B>myZone</B> cannot be turned `Off` as per AdvantageAir system design. It can only be turned `Off` by setting another zone as <B>myZone</B>.  However, if a Zone, which is set as <B>myZone</B>, is turned off by sliding the Fan slider to zero, this plugin will automatically set another open Zone to be <B>myZone</B> with preference to an open Constant Zone. If there is no other open Zone, then this plugin will open a Zone with preference to a Constant Zone and set it as <B>myZone</B>.
+
+### (B) Lights
+<p align="left">
+<img width="300px" src="Screenshots/Lights_homekit_tiles.png">
+</p>
+
+<p align="left">
+<img width="240px" src="Screenshots/LightWithDimmer_homekit_UI.png">
+<img width="240px" src="Screenshots/LightSwitch_homekit_UI.png">
+</p>
+
+Light with dimmer has a slider to control its brightness while a light without dimmer just has a simple ON/OFF light switch.
+
+### (C) Fans
+
+<p align="left">
+<img width="150px" src="Screenshots/Fan_homekit_tile.jpg">
+</p>
+
+<p align="left">
+<img width="240px" src="Screenshots/Fan_homekit_UI.jpg">
+</p>
+
+From version 2.3.0 onwards, any light switch whose name ends with ‘ Fan’ or ‘ Ex’, or begins with ‘Fan ’ or ‘Ex ’, will be treated as a fan accessory. In HomeKit, its icon will appear as a fan (as shown above) instead of a lightbulb. 
+
+### (D) Garage Door and Blinds
+<p align="left">
+<img width="300px" src="Screenshots/Garage&Blinds_homekit_tiles.png">
+</p>
+
+<p align="left">
+<img width="240px" src="Screenshots/Garage_homekit_UI.png">
+<img width="240px" src="Screenshots/Blinds_homekit_UI.png">
+</p>
+
+Garage Door is either Opened or Closed, hence it appears as a simple switch while Blinds can be partially open, as such, it has a slider to set the %-open.
+
+## How You Can Help
+* Report Bugs/Errors by opening Issues/Tickets.
+* Suggest Improvements and Features you would like to see!
+* If you are loving this plugin or using this plugin, please feel free to give me a `Star`!
+
+
+## Special Thanks
+
+This project would not have been possible without the work of others in the Homebridge community.
+
+1. Many thanks to [Mitch Williams](https://github.com/mitch7391) who has initiated [homebridge-cmd4-AdvantageAir](https://github.com/mitch7391/homebridge-cmd4-AdvantageAir) plugin and has allowed me to participate in its development and in the process I have leant a lot about GitHub and on **bash** and **javascript** coding in homebridge environment.
+2. Many thanks also to [John Talbot](https://github.com/ztalbot2000) for his fantastic [homebridge-cmd4](https://github.com/ztalbot2000/homebridge-cmd4) plugin which I forked and reused most of the original logic, with some modifications and adjustments to meet the requirements of this plugin.
+3. And never forget to thank my beautiful wife who has put up with my obsession on this.....
+
+
+## LICENSE
+This plugin is distributed under the MIT license. See [LICENSE](https://github.com/uswong/homebridge-myplace/blob/main/LICENSE) for details.

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.3.1 (2025-10-22)
+
+###### (1) Allow up to 5 retries of inaccessible device before proceeding to auto-discovery.
+###### (2) Minor bug fixes.
+
 ##### v2.3.0 (2025-10-02)
 
 ###### (1) Automatic device discovery: AdvantageAir devices can now be auto-discovered if no IP is specified, or if the configured IP is invalid or inaccessible.

package/package.json

@@ -1,7 +1,7 @@
 {
    "name": "homebridge-myplace",
    "description": "Exec Plugin bringing Advanatge Air MyPlace system to Homekit",
-   "version": "2.3.0",
+   "version": "2.3.1",
    "license": "MIT",
    "author": {
       "name": "Ung Sing"
@@ -32,7 +32,7 @@
    "devDependencies": {
       "@commitlint/cli": "^17.6.7",
       "@commitlint/config-conventional": "^16.0.0",
-      "@eslint/js": "^9.36.0",
+      "@eslint/js": "^9.37.0",
       "@typescript-eslint/eslint-plugin": "^8.0.0",
       "@typescript-eslint/parser": "^8.0.0",
       "background-eslint-hook": "^1.0.0",

package/utils/updateConfig.js

@@ -3,6 +3,11 @@ const { devicesAutoDiscovery } = require("./devicesAutoDiscovery");
 const { createMyPlaceConfig } = require("./createMyPlaceConfig");
 const chalk = require("chalk");
 
+// Helper function to delay execution
+function delay(ms) {
+  return new Promise(resolve => setTimeout(resolve, ms));
+}
+
 async function updateConfig(config, log, pluginPath) {
   // Enforce maxAccessories: default 149 (Homebridge hard limit)
   const maxAccessories = (typeof config.maxAccessories === "number"
@@ -80,12 +85,61 @@ async function updateConfig(config, log, pluginPath) {
       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;
+
+          while (retryCount < maxRetries && !retrySuccess) {
+            retryCount++;
+            log.info(chalk.yellow(`⏳ Device 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;
+              }
+            }
+          }
+
+          // If we exhausted all retries and still failed, log the final error
+          if (!retrySuccess) {
+            log.warn(`❌ All ${maxRetries} retry attempts failed. Last error: ${lastRetryError.message}`);
+          }
+        }
+
         if (devicesAutoDiscoveryCounter === 0) {
           log.info(chalk.yellow("🔍 Starting devices auto-discovery..."));
         } else {