homebridge-myplace v1.1.5

homebridge-myplace

An independent plugin bringing Advantage Air 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
• MyAir4
• MyAir
• E-zone
• Fujitsu anywAIR

Installation

Raspbian/HOOBS/macOS/NAS

1. Install Homebridge via these instructions for Raspbian, HOOBS or 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.

   Please note that if you have homebridge-cmd4 installed, you have to uninstall it before installing this plugin, otherwise there will be some conflicts and one of them will not run. If you do use homebridge-cmd4 for some other purposes, you can include the same config in homebridge-myplace and it will still run as if it is in homebridge-cmd4.

3. Check if jq and curl are installed (curl should already be):

jq -V
curl -V

If they are installed, the above command should return a version number.

4. If not already, install jq and curl via your Homebridge UI terminal or through ssh:

# Raspbian/Hoobs:
sudo apt-get install <jq or curl>

# macOS:
brew install <jq or curl>

# Synology NAS:
apt-get install <jq or curl>

# QNAP NAS:
apk add <jq or curl>

5. Create your Homebridge config.json

   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 Configuration Creator and Checker and Device Settings page.

   In Device Settings 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.

   Go back to Plugin Config again and press the CREATE CONFIGURATION button to create the required configuration file. On a sucess, click CHECK CONFIGURATIONto 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. Click CLOSE 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:

   cd
   <Plugin Path>/node_modules/homebridge-myplace/ConfigCreator.sh

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:

(i) Thermostat, Fan Switch and Fan Speed Control

Thermostat is where the desired target temperature can be set.

Thermostat has 4 modes- Off, Cool, Heat and Auto. It does not have dry and fan modes. As such, the Thermostat Auto mode is repurposed as dry mode in this plugin and a separate Fan switch is used for fan mode.

Both the Thermostat and Fan 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 - low, mid, high and auto or ezfan and the %-rotationSpeed is snapped to 25% for low, 50% for mid, 90% for high and 100% for auto or ezfan.

(ii) Timer

A timer is repurposed from Lightbulb accessory and its %-brightness 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.

If Include extra timers is checked during the setup process, 3 more timers would have been created- a Fan Timer, a Cool Timer and a Heat Timer:

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 Lightbulb accessory.

(iii) Zone Control

Zone control is repurposed from Fan accessory with its %-rotationSpeed as proxy for zone %-open.

For zones with temperature sensors and with myZone defined, a myZone switch, repurposed from rotationDirection will appear as a round button. Turn this button ON to set this zone as myZone. Please note that as per Advantage Air system design, myZone cannot be turned OFF. It can only be turned OFF by setting another zone as myZone. Moreover, %-open for these zones cannot be set. It is set automatically by the system.

For zone current temperature info, click the setting button.

(B) Lights

Light with dimmer has a slider to control its brightness while a light without dimmer just has a simple ON/OFF light switch.

(C) Garage Door and Blinds

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!

Special Thanks

1. Many thanks to Mitch Williams who has created the wonderful 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 for his fantastic homebridge-cmd4 plugin which I have forked and used it as the main engine for 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 for details.