homebridge-myplace
v2.4.2
Published
Exec Plugin bringing Advanatge Air MyPlace system to Homekit
Maintainers
Readme
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
Installation
Install Homebridge via these instructions for Raspbian, HOOBS, macOS or Windows, if you have not already.
Make sure that jq and curl are installed. Try to install jq-1.7 if you can. It is much faster.
Find the
homebridge-myplaceplugin via the Homebridge UI 'Plugins' tab search function, once found, click the blue down-arrow at the bottom right to install.Once installed,
Config: homebridge-myplaceUI will pop up, then follow the steps outlined in Step 4 below.If for some reasons, the
Config: homebridge-myplaceUI did not pop up, locate your newly installedHomebridge Myplaceplugin and click on the three dots at the bottom right and selectPlugin Configto get to theHomebridge MyPlaceUI.Configuring MyPlace plugin:
In Device Settings area, fill out the
Name,IP AddressandPORT usedfields (default PORT is2025for most users, Fujitsu anywAIR users set this to10211) and check/uncheck the self-explanatory checkboxes forInclude extra timersandEnable detailed debug log for this device, clickSAVEthenRESTART.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 checkEnable detailed debug log for this pluginto 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
ipAddressis 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:
(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, dedicated Fan and Dry switch accessories are used for fan and dry mode.
Both the Fan and Dry switch accessories have 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 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 Include extra timers was selected 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.
(iii) Zone Control
Zone control is repurposed from Fan accessory with its %-rotationSpeed as proxy for Zone damper %-open and rotationDirection as myZone button. Thermostat accessory is used for setting the Zone target temperature.
There are three possible Zone Control configurations depending on the setup of your Aircon system:
(a) A non temperature controlled Zone: If your system has no temperature sensors, then there will only be a simple Fan accessory for your Zone Control. The Fan slider is for adjusting the desired damper %-open manually.
(b) A temperature controlled Zone but without myZone defined: If your system has temperature sensors but myZone is not defined, then there will be a simple Fan accessory and a Thermostat 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 Thermostat 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 Thermostat 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.
(c) A temperature controlled Zone with myZone defined: If your system has temperature sensors and myZone is defined, then there will be a round button for setting this zone as myZone in addition to a simple Fan accessory and a Thermostat accessory as detailed in (b) above.
Please note that myZone cannot be turned Off as per AdvantageAir system design. It can only be turned Off by setting another zone as myZone. However, if a Zone, which is set as myZone, is turned off by sliding the Fan slider to zero, this plugin will automatically set another open Zone to be myZone 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 myZone.
(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) Fans
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
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.
- Many thanks to Mitch Williams who has initiated 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.
- Many thanks also to John Talbot for his fantastic 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.
- 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.
