diff --git a/CHANGELOG.md b/CHANGELOG.md index 95e40e7..04ade4b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ # GE Home Appliances (SmartHQ) Changelog -## 0.3.x +## 0.4.0 - Implemented Laundry Support (@warrenrees, @ssindsd) - Implemented Water Filter Support (@bendavis, @tumtumsback, @rgabrielson11) diff --git a/README.md b/README.md index e8cb73f..b74bed4 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,17 @@ # GE Home Appliances (SmartHQ) -## `ge_home` -Integration for GE WiFi-enabled appliances into Home Assistant. This integration currently contains fridge, oven, dishwasher, laundry washer, laundry dryer support. +Integration for GE WiFi-enabled appliances into Home Assistant. This integration currently supports the following devices: + +- Fridge +- Oven +- Dishwasher +- Laundry (Washer/Dryer) +- Whole Home Water Filter +- Advantium **Forked from Andrew Mark's [repository](https://github.com/ajmarks/ha_components).** +## Home Assistant UI Examples Entities card: ![Entities](https://raw.githubusercontent.com/simbaja/ha_components/master/img/appliance_entities.png) @@ -17,3 +24,23 @@ Oven Controls: ![Fridge controls](https://raw.githubusercontent.com/simbaja/ha_components/master/img/oven_controls.png) +## Installation (Manual) + +1. Using the tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`). +2. If you do not have a `custom_components` directory (folder) there, you need to create it. +3. In the `custom_components` directory (folder) create a new folder called `ge_home`. +4. Download _all_ the files from the `custom_components/ge_home/` directory (folder) in this repository. +5. Place the files you downloaded in the new directory (folder) you created. +6. Restart Home Assistant +7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "GE Home" + +## Installation (HACS) + +Please follow directions [here](https://hacs.xyz/docs/faq/custom_repositories/), and use https://github.com/simbaja/ha_gehome as the repository URL. +## Configuration + +Configuration is done via the HA user interface. + +## Change Log + +Please click [here](CHANGELOG.md) for change information. \ No newline at end of file diff --git a/custom_components/ge_home/manifest.json b/custom_components/ge_home/manifest.json index 4b36a55..3358a8c 100644 --- a/custom_components/ge_home/manifest.json +++ b/custom_components/ge_home/manifest.json @@ -5,5 +5,5 @@ "documentation": "https://github.com/simbaja/ha_components", "requirements": ["gehomesdk==0.3.21","magicattr==0.1.5"], "codeowners": ["@simbaja"], - "version": "0.3.21" + "version": "0.4.0" } diff --git a/img/appliance_entities.png b/img/appliance_entities.png index 5f29203..fd15829 100644 Binary files a/img/appliance_entities.png and b/img/appliance_entities.png differ diff --git a/img/fridge_control.png b/img/fridge_control.png index cd6c87e..2923429 100644 Binary files a/img/fridge_control.png and b/img/fridge_control.png differ diff --git a/img/fridge_controls_dark.png b/img/fridge_controls_dark.png index c6f52aa..fefda41 100644 Binary files a/img/fridge_controls_dark.png and b/img/fridge_controls_dark.png differ diff --git a/img/oven_controls.png b/img/oven_controls.png index 5c5b396..c8e6a8e 100644 Binary files a/img/oven_controls.png and b/img/oven_controls.png differ diff --git a/info.md b/info.md index e8cb73f..af2ad50 100644 --- a/info.md +++ b/info.md @@ -1,10 +1,17 @@ # GE Home Appliances (SmartHQ) -## `ge_home` -Integration for GE WiFi-enabled appliances into Home Assistant. This integration currently contains fridge, oven, dishwasher, laundry washer, laundry dryer support. +Integration for GE WiFi-enabled appliances into Home Assistant. This integration currently support the following devices: + +- Fridge +- Oven +- Dishwasher +- Laundry (Washer/Dryer) +- Whole Home Water Filter +- Advantium **Forked from Andrew Mark's [repository](https://github.com/ajmarks/ha_components).** +## Home Assistant UI Examples Entities card: ![Entities](https://raw.githubusercontent.com/simbaja/ha_components/master/img/appliance_entities.png) @@ -17,3 +24,30 @@ Oven Controls: ![Fridge controls](https://raw.githubusercontent.com/simbaja/ha_components/master/img/oven_controls.png) + +{% if installed %} +### Changes as compared to your installed version: + +#### Breaking Changes + +#### Changes + +#### Features + +{% if version_installed.split('.') | map('int') < '0.4.1'.split('.') | map('int') %} + +- Implemented Laundry Support (@warrenrees, @ssindsd) +- Implemented Water Filter Support (@bendavis, @tumtumsback, @rgabrielson11) +- Implemented Initial Advantium Support (@ssinsd) +- Bug fixes for ovens (@TKpizza) +- Additional authentication error handling (@rgabrielson11) +- Additional dishwasher functionality (@ssinsd) +- Introduced new select entity (@bendavis) +- Miscellaneous entity bug fixes/refinements +- Integrated new version of SDK + +{% endif %} + +#### Bugfixes + +{% endif %}