homebridge-cmd4-AdvantageAir
Catered shell script to integrate air conditioner control units by Advantage Air into Homekit using the plug-in homebridge-cmd4.
No affiliation with Advantage Air.
Supported Control Units:
- Air Conditioning:
Note: zone10 does not appear to work with this plug-in.
- Extras:
- MyPlace
- Lights
- Garage Door
- Gate
- Motion Sensors
- Blinds
- MyPlace
Note: Config for these extras can be found here.
How It Looks:
Air Conditioning - Thermostat Mode (with Fan Speed) and Fan Mode:
Air Conditioning - Zone Control and Temperature Sensors:
Air Conditioning - Zone Control without Temperature Sensors:
MyPlace Extras - Lights:
MyPlace Extras - Garage Door / Gate: Note: Garage Door / Gate will appear in Apple CarPlay.
Installation:
Raspbian/HOOBS/macOS/NAS:
- Install Homebridge via these instructions for Raspbian, HOOBS or macOS.
- Install the homebridge-cmd4 plug-in via the Homebridge UI 'plugins' tab search function.
- Install
homebridge-cmd4-AdvantageAir
plug-in via the Homebridge UI 'plugins' tab search function.
- Install jq via your Homebridge UI terminal or through ssh:
# Raspbian/Hoobs:
sudo apt-get install jq
# macOS:
brew install jq
# Synology/QNAP NAS
apk add jq
- Check if curl is installed (it should already be):
curl -V
- If curl does not return a version number, install via:
# Raspbian/Hoobs:
sudo apt-get install curl
# macOS:
brew install curl
# Synology/QNAP NAS
apk add curl
- Automatically create your Homebridge
config.json
by stepping through one of the following four methods:
- Homebridge users with access to the Homebridge web UI can skip to
Step 8
. - Homebridge users without access to the Homebridge web UI can use the following terminal instructions.
- HOOBS users do not have access to our Homebridge UI (for now!) and will have to use the following terminal instructions.
- Read through and follow the Wiki guide to create your own config step by step. This should all be edited from the Homebridge UI tab.
- NOTE: Two accessories cannot have the exact same
displayName
in your config. E.g. A switch and temperature sensor cannot both be named 'Kitchen'.
- Go to the 'plugins' tab in Homebridge UI and locate your newly installed
homebridge-cmd4-AdvantageAir
. ClickSETTINGS
and it should launch the 'Advantage Air Configuration Creator'.
- Scroll down to the 'AdvantageAir Device Settings' area and fill out the
Name
andIP Address
fields (if you have more than one Advantage Air tablet, you can clickAdd new device
to setup the others), and then clickSAVE
. It will close the UI and you will need to open it once more as per Step 8. - Tick/untick the
"Fan" setup as "FanSwitch"
checkbox, then press theCONFIG CREATOR
button; your Advantage Air config has now been created! - Click
CHECK CONFIGURATION
. It will check over your installation and config to make sure you have everything correct. On a success it will sayPassed
; if something is incorrect, an error message will pop up telling you what it is that you have missed and need to fix.
Windows OS
I have not successfully set this up on a Windows OS Homebridge server yet. If you have and want to contribute; please reach out and let me know how you did it. Otherwise I strongly suggest you buy a dedicated Raspberry Pi for Homebridge.
Further Notes
You can read more about this project and how to create your config on the Wiki page.
How You Can Help:
- Open Issues/Tickets.
- Report Bugs/Errors.
- Suggest Improvements and Features you would like to see!
- Help test the beta releases! See the Wiki to find out how to 'sign up'.
- Create a fork, add or fix something yourself and create a Pull Request to be merged back into this project and released!
- Let me know if you have a Control Unit or App that works that is not confirmed in my Supported List!
- Let me know if you can figure out how to get this running on Windows 10/11 Homebridge.
- Feel free to let me know you are loving the project by give me a
Star
! It is nice to have an idea how many people use this project!
Special Thanks:
- The evolution, improvements and continuously tireless work of John Talbot, who has not only improved these shell scripts beyond measure and created the Homebridge UI integration; but continues to improve homebridge-cmd4 to further cater to this work and my end users.
- The hard work and valued coding experince of Ung Sing Wong that has led to the many amazing features in a short space of time; and no doubt more to come in the future!
- This would never have kicked off without the patience and kindness of TimofeyK helping out a new starter find his feet.
- Lastly, but certainly not least, is my beautiful Wife who has put up with what has become an obsession of mine to get our air conditioner and many other devices into Homekit. May she forever be misunderstood by Siri for my amusement...
LICENSE:
This plugin is distributed under the MIT license. See LICENSE for details.