Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ofalvai authored Nov 22, 2021
1 parent 1e00c57 commit 3766995
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@
[![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg)](https://github.com/custom-components/hacs)
[![codecov](https://codecov.io/gh/ofalvai/home-assistant-candy/branch/main/graph/badge.svg?token=HE0AIQOGAD)](https://codecov.io/gh/ofalvai/home-assistant-candy)

Custom component for [Home Assistant](https://homeassistant.io) that integrates Candy/Haier Wi-Fi washing machines (also known as Simply-Fi).

This is still work-in-progress, it may not support every appliance type or feature. Open a PR or issue if you have a model that's not supported.
Custom component for [Home Assistant](https://homeassistant.io) that integrates Candy/Haier/Simply-Fi home appliances.


## Features
Expand All @@ -16,12 +14,12 @@ This is still work-in-progress, it may not support every appliance type or featu
- oven
- dishwasher
- Uses the local API and its status endpoint
- Creates various sensors, such as overall state and remaining time. Everything else is exposed as sensor attributes
- Creates various sensors, such as device state and remaining time. Everything else is exposed as sensor attributes

## Installation

1. Install [HACS](https://hacs.xyz/)
2. Go to the integrations list in HACS and install this custom repo
2. Go to the integrations list in HACS and search for `Candy Simply-Fi`
4. Restart Home Assistant
5. Go to the Integrations page, click Add integrations and select `Candy`
6. Complete the config flow
Expand All @@ -31,3 +29,9 @@ This is still work-in-progress, it may not support every appliance type or featu
You need the IP address of the machine and the encryption key. This can be guessed with [CandySimplyFi-tool](https://github.com/MelvinGr/CandySimplyFi-tool).


## My device isn't supported. Can you help?

Yes. If you have an appliance that is not supported yet, or you see an error, head over to the [Discussions section](https://github.com/ofalvai/home-assistant-candy/discussions/categories/device-support-improvements). Open a new thread or comment to an existing one with the following information:

- The status API response of your device (use [CandySimplyFi-tool](https://github.com/MelvinGr/CandySimplyFi-tool) to get the JSON)
- A brief explanation of what each field means in the response and how it changes based on the device state, eg. _The `SpinSp` field is probably the spin speed divided by 100, I have seen values 6, 8, 10 and 12 in the response_

0 comments on commit 3766995

Please sign in to comment.