luc-ass / homebridge-evohome

Homebridge plugin for Honeywell Evohome
29 stars 16 forks source link
homebridge homebridge-plugin homekit honeywell-evohome verified-by-homebridge

Honeywell Evohome Controller   Honeywell Evohome Controller   Honeywell Evohome Controller

Honeywell Evohome support for Homebridge

npm npm npm verified-by-homebridge

This ia a plugin to integrate Honeywell Evohome into Apple HomeKit. It is work in progress. Help is greatly appreciated!

Up until now this plugin will only add your Thermostats and central functions (for example "ECO") to Homebridge. Other devices such as domestic hot water will probably follow in the future once we can wrap our heads arround it (and have someone to test it out).

🚀 Getting Started

Homebridge with Config UI X:

  1. Go to the "Plugins" tab and search for homebridge-evohome
  2. Install the plugin and fill out the setup form

Terminal / NPM:

  1. Install this plugin using npm install -g homebridge-evohome@latest
  2. Update your configuration file (sample-config below)

⚙️ Configuration

Configuration sample:

"platforms": [
        {
            "platform": "Evohome",
            "name" : "Evohome",
            "username" : "username/email",
            "password" : "password",
            "temperatureUnit" : "Celsius",
            "locationIndex" : "0"
        }
    ]
Parameter optional accepted values info
platform no Evohome
name no any Name you want
username no your Honeywell email adress
password no your Honeywell password
temperatureUnit yes Celsius, Fahrenheit defaults to Celsius
locationIndex yes 0, 1, 2, etc. only needed if you have multiple locations
switchAway yes true, false creates a switch for away mode
switchDayOff yes true, false creates a switch for day off mode
switchEco yes true, false creates a switch for eco settings
switchHeatingOff yes true, false creates a switch to tur off the heating
switchCustom yes true, false creates a switch for your custom mode
childBridge yes true, false allows you to have persistent accessories, if plugin is run inside a child bridge
temperatureAboveAsOff yes true, false allows you to displays thermostats as off, if room temperature is above target temperature

📝 Roadmap

⚠️ Known Issues & Notes

🧪 Beta Testing

This part talks about testing pre-release version of the plugin. I strongly recommend, that you don't do this in your production environment. It will frequently reset accessories and break automations. If you still want to or have been asked to, this is my preferred way of installing from github:

In Homebridge Config UI X Terminal:

# go to node module directory
cd node_modules
# remove homebridge-evohome and contents
rm -r homebridge-evohome
# recreate the folder
mkdir homebridge-evohome
# clone repo to folder
git clone --single-branch --branch main https://github.com/luc-ass/homebridge-evohome.git ./homebridge-evohome
# cd into folder
cd homebridge-evohome
# install plugin
npm install

Now restart Homebridge