homebridge-homeconnect

Home Connect home appliances plugin for Homebridge

Stats

StarsIssuesVersionUpdatedCreatedSize
homebridge-homeconnect
4400.23.37 months ago2 years agoMinified + gzip package size for homebridge-homeconnect in KB

Readme

homebridge-homeconnect

npm npm npm verified-by-homebridge

Home Connect home appliances plugin for Homebridge.

Home Connect, Balay, Bosch, Constructa, Gaggenau, NEFF, Siemens, and Thermador are trademarks of BSH Home Appliances.

Installation

  1. Connect your home appliances with Home Connect:
    1. Install Home Connect from the Apple App Store for your country (e.g. UK or USA).
    2. Create an account using your email address, click on the validation link in the email that will be received, and then return to the app and login.
    3. Connect the appliances to your home network, either via the app or using Wi-Fi Protected Setup (WPS).
    4. Connect the appliances to the app (by following the installation guide provided with the appliance).
  2. Obtain a Home Connect application Client ID:
    1. Sign-up for a free Home Connect Developer Program account and login.
    2. Register a new application, ensuring that the OAuth Flow is set to Device Flow, and the Home Connect User Account is the same as the email address that was used within the Home Connect app.
    3. Save the displayed Client ID to include in the Homebridge config.json file.
  3. Install this plugin using: npm install -g homebridge-homeconnect
  4. Edit config.json and add the HomeConnect platform (see example below).
  5. Run Homebridge.
  6. The Homebridge log output will include an authorisation URL. Copy the listed URL into a web browser and login to your Home Connect account. (The authorisation URL can also be found in the homebridge-config-ui-x graphical settings editor.)

Example config.json

{
    "platforms":
    [{
        "platform":     "HomeConnect",
        "clientid":     "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF"
    }]
}

The clientid should be set to the Client ID obtained from the Home Connect Developer Program for the created Device Flow application.

Additional configuration is recommended to customise the appliance programs. The easiest way to do this is via the homebridge-config-ui-x (version 4.8.1 or later) graphical settings editor. This plugin dynamically updates its configuration schema with the appropriate options for the connected appliances.

See config.json for a description of all supported configuration options.

Appliance Support

This plugin supports most capabilities of the Home Connect API that can be sensibly mapped to Apple-defined HomeKit services and characteristics. More details can be found in the functionality summary.

Apple's Home app does not support all of the features of this plugin. Some third-party HomeKit apps are recommended due to their extra functionality.

Cooking Appliances

  • CoffeeMaker:
    • Switch on/off, start/stop programs with preset options, and turn cup warmer on/off.
    • Control child lock.
    • Monitor door, program time remaining, remote control, and general operation status.
    • Automation triggers for bean container empty, water tank empty, and drip tray full.
  • CookProcessor:
    • Switch on/off.
    • Monitor program time remaining and general operation status.
    • Automation triggers for finished and aborted.
    • (The Home Connect API documentation states that "Program support is planned to be released in 2022".)
  • Hob:
    • Control alarm clock and child lock.
    • Monitor power, remote control, and general operation status.
    • Automation triggers for finished, alarm clock finished, and preheat finished.
    • (The Home Connect API documentation states that "Program support is planned to be released in 2022".)
  • Hood:
    • Switch on/off.
    • Switch fan on/off, set fan speed/intensive levels, and select manual/auto mode.
    • Switch functional light on/off and change brightness.
    • Switch ambient light on/off, change brighness, and select colour.
    • Monitor remote control and general operation status.
    • Automation trigger for finished.
  • Oven:
    • Switch on/off and start/stop programs with preset options.
    • Set sabbath mode.
    • Control alarm clock and child lock.
    • Monitor door, programs, program time remaining, remote control, and general operation status.
    • Automation triggers for finished, aborted, alarm clock finished, and preheat finished,
  • WarmingDrawer:
    • Switch on/off and start/stop programs with preset options.
    • Control child lock.
    • Monitor remote control and general operation status.

Cleaning Appliances

  • CleaningRobot:
    • Switch on/off and start/stop programs with preset options.
    • Monitor battery level, battery charging, dock, and general operation status.
    • Automation triggers for finished, aborted, dust box full, stuck, and lost.
  • Dishwasher:
    • Switch on/off and start/stop programs with preset options.
    • Switch ambient light on/off, change brighness, and select colour.
    • Control child lock.
    • Monitor door, program time remaining, remote control, and general operation status.
    • Automation triggers for finished and aborted.
  • Dryer / Washer / WasherDryer:
    • Start/stop programs with preset options.
    • Control child lock.
    • Monitor power, door, program time remaining, remote control, and general operation status.
    • Automation triggers for finished and aborted.

Cooling Appliances

  • Freezer / FridgeFreezer / Refrigerator:
    • Set freezer/refrigerator super, eco, sabbath, refrigerator vacation, and refrigerator fresh modes.
    • Control child lock.
    • Monitor power and door.
    • Automation triggers for freezer/refrigerator door and freezer temperature alarms.
  • WineCooler:
    • Set sabbath mode.
    • Control child lock.
    • Monitor power and door.

Changelog

All notable changes to this project are documented in the CHANGELOG.md file.

Version 0.20.0 of this plugin requests authorisation of additional Home Connect API scopes to allow control of Oven appliance programs. When upgrading from version 0.19.2 or earlier force a re-authorisation by deleting the ~/.homebridge/homebridge-homeconnect/persist/94a08da1fecbb6e8b46990538c7b50b2 file while Homebridge is stopped.

Reporting Issues

Report any issues on GitHub.

Please attach the relevant section of the Homebridge log file, either pasted into the issue or attached as a text file (not a screenshot). Extra debug should be enabled and captured if appropriate:

  • Homebridge debug logging: Start Homebridge with the -D option to capture the debug level messages. These are used by this plugin to log basic information about each request to the Home Connect servers (but not the actual contents of the requests or responses) and other internal state. Please enable this for any issues that involve problems connecting to the Home Connect servers, API errors, or other problems with appliance state or control.
  • HomeKit Accessory Protocol (HAP) logging: Setting the DEBUG=* environment variable before starting Homebridge results in verbose logging of all HAP-NodeJS HomeKit exchanges. Please enable this for any issues that involve problems controlling appliances from HomeKit or Siri.

Before raising an issue please check whether it relates to an expected error message and whether any similar issues already exist.

License

ISC License (ISC)
Copyright © 2019-2021 Alexander Thoukydides

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.