Skip to content
This repository has been archived by the owner on Oct 11, 2022. It is now read-only.

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidMStraub committed Nov 24, 2019
1 parent 0ffa527 commit b18898e
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Home Assistant Home Connect

This is work in progress of an implementation of a Home Connect component for Home Assistant.
Integration of home appliances supporting the Home Connect standard into Home Assistant.

## Recent breaking changes

Expand All @@ -10,20 +10,22 @@ Also, you need to **change the redirect URI** compared to before: replace `.../a

## Usage

- Register an account with the [Home Connect Developer Program](https://developer.home-connect.com)
- Register a new application with the Redirect URI `https://YOUR_HOMEASSISTANT_BASE_URL:PORT/auth/external/callback` (it will not work without https, but your Home Assistant instance does *not* have to be accessible from the internet and a self-signed certificate will do)
- Make sure the `http` component in your `configuration.yaml` has the base url set to `YOUR_HOMEASSISTANT_BASE_URL:PORT` (it will not work otherwise)
- Copy the contents of `custom_components` to the `custom_components` directory of your Home Assistant configuration directory
- Add the following to your `configuration.yaml`:
1. Register an account with the [Home Connect Developer Program](https://developer.home-connect.com)
2. Register a new application with the Redirect URI `https://YOUR_HOMEASSISTANT_BASE_URL:PORT/auth/external/callback` (it will not work without https, but your Home Assistant instance does *not* have to be accessible from the internet and a self-signed certificate will do)
3. Make sure the `http` component in your `configuration.yaml` has the base url set to `YOUR_HOMEASSISTANT_BASE_URL:PORT` (it will not work otherwise)
4. Add the following to your `configuration.yaml`:
```yaml
homeconnect:
client_id: YOUR_CLIENT_ID
client_secret: YOUR_CLIENT_SECRET
```
- Navigate to the Integrations page and select "Home Connect"
5. Copy the contents of `custom_components` to the `custom_components` directory of your Home Assistant configuration directory
6. Navigate to the Integrations page and select "Home Connect"

Step 5 can also be replaced by using [HACS](https://hacs.xyz/) and adding this repository as a custom repistory.

## Feedback

This is a development preview (**use at your own risk!**). Please report problems by [opening an issue](https://github.com/DavidMStraub/homeassistant-homeconnect/issues). Feel free to report success in the [Home Assistant forum](https://community.home-assistant.io/t/home-connect-alpha-testers-wanted/82603).
Please report problems by [opening an issue](https://github.com/DavidMStraub/homeassistant-homeconnect/issues). Feel free to report success in the [Home Assistant forum](https://community.home-assistant.io/t/home-connect-alpha-testers-wanted/82603).

Pull requests are welcome!

0 comments on commit b18898e

Please sign in to comment.