ha_gehome/README.md

91 lines
4.0 KiB
Markdown
Raw Normal View History

# GE Home Appliances (SmartHQ)
2021-07-31 17:10:56 -06:00
[![GitHub Release][releases-shield]][releases]
[![GitHub Activity][commits-shield]][commits]
[![License][license-shield]](LICENSE)
[![hacs][hacsbadge]][hacs]
Integration for GE WiFi-enabled appliances into Home Assistant. This integration currently supports the following devices:
- Fridge
- Oven
2022-10-16 08:44:14 -06:00
- Dishwasher / F&P Dual Dishwasher
- Laundry (Washer/Dryer)
- Whole Home Water Filter
2021-12-11 09:06:30 -07:00
- Whole Home Water Softener
2022-10-16 08:44:14 -06:00
- Whole Home Water Heater
- A/C (Portable, Split, Window, Built-In)
2021-12-11 09:06:30 -07:00
- Range Hood
- Advantium
2021-12-11 09:06:30 -07:00
- Microwave
- Opal Ice Maker
2022-10-16 08:44:14 -06:00
- Coffee Maker / Espresso Maker
- Beverage Center
**Forked from Andrew Mark's [repository](https://github.com/ajmarks/ha_components).**
2022-04-30 17:51:24 -06:00
## Updates
2022-04-30 17:51:24 -06:00
Unfortunately, I'm pretty much at the end of what I can do without assistance from others with these devices that can help provide logs. I'll do what I can to make updates if there's something broken, but I am not really able to add new functionality if I can't get a little help to do so.
v0.6.6 (#153) * - updated water heater naming * - initial support for built-in AC units * Add support for Built-In AC Unit Built-In AC unit operation and function is similar to a WAC. `gehomesdk` version bumped from 0.4.25 to 0.4.27 to include latest ErdApplianceType enum. * Update README.md Update README.md to include Built-In AC as supported device * - updated zero serial number detection (resolves #89) * - updated version - updated changelog * - hopefully fixed recursion bug with numbers * - added cooktop support * - fixed circular reference * Add support for fridges with reduced support for ERD codes (no turbo mode, no current temperature reporting, no temperature setpoint limit reporting, no door status reporting). This change has been tested on a Fisher & Paykel RF610AA. * - added dual dishwasher support - updated documentation - version bumps * - added water heater support * - added basic espresso maker device * - bugfixes * - rewrote initialization (resolves #99) * - added logic to prevent double registration of entities * - added correct min/max temps for water heaters * Fix CoffeeMaker after the NumberEntity refactoring * - added fix for CGY366P2TS1 (#116) to try to get the cooktop status, but fail more gracefully if it isn't supported * - fixed region setting in update coordinator * - version bump - doc update - string fixes * - updated the temperature conversion to use non-deprecated HASS methods * - updated documentation (@gleepwurp) * - more documentation updates * - updated dishwasher for new functionality - updated documentation * updated uom for liquid volume per HA specifications * - fixed typo in oven (#149) * - updated change log - fixed oven light control (#144) --------- Co-authored-by: Rob Schmidt <rwschmidt26@gmail.com> Co-authored-by: Federico Sevilla <federico@sevilla.id.au> Co-authored-by: alexanv1 <44785744+alexanv1@users.noreply.github.com>
2023-04-22 23:05:15 -06:00
## Home Assistant UI Examples
Entities card:
![Entities](https://raw.githubusercontent.com/simbaja/ha_components/master/img/appliance_entities.png)
Fridge Controls:
![Fridge controls](https://raw.githubusercontent.com/simbaja/ha_components/master/img/fridge_control.png)
Oven Controls:
![Fridge controls](https://raw.githubusercontent.com/simbaja/ha_components/master/img/oven_controls.png)
A/C Controls:
![A/C controls](https://raw.githubusercontent.com/simbaja/ha_components/master/img/ac_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.
v0.6.6 (#153) * - updated water heater naming * - initial support for built-in AC units * Add support for Built-In AC Unit Built-In AC unit operation and function is similar to a WAC. `gehomesdk` version bumped from 0.4.25 to 0.4.27 to include latest ErdApplianceType enum. * Update README.md Update README.md to include Built-In AC as supported device * - updated zero serial number detection (resolves #89) * - updated version - updated changelog * - hopefully fixed recursion bug with numbers * - added cooktop support * - fixed circular reference * Add support for fridges with reduced support for ERD codes (no turbo mode, no current temperature reporting, no temperature setpoint limit reporting, no door status reporting). This change has been tested on a Fisher & Paykel RF610AA. * - added dual dishwasher support - updated documentation - version bumps * - added water heater support * - added basic espresso maker device * - bugfixes * - rewrote initialization (resolves #99) * - added logic to prevent double registration of entities * - added correct min/max temps for water heaters * Fix CoffeeMaker after the NumberEntity refactoring * - added fix for CGY366P2TS1 (#116) to try to get the cooktop status, but fail more gracefully if it isn't supported * - fixed region setting in update coordinator * - version bump - doc update - string fixes * - updated the temperature conversion to use non-deprecated HASS methods * - updated documentation (@gleepwurp) * - more documentation updates * - updated dishwasher for new functionality - updated documentation * updated uom for liquid volume per HA specifications * - fixed typo in oven (#149) * - updated change log - fixed oven light control (#144) --------- Co-authored-by: Rob Schmidt <rwschmidt26@gmail.com> Co-authored-by: Federico Sevilla <federico@sevilla.id.au> Co-authored-by: alexanv1 <44785744+alexanv1@users.noreply.github.com>
2023-04-22 23:05:15 -06:00
## Configuration
v0.6.6 (#153) * - updated water heater naming * - initial support for built-in AC units * Add support for Built-In AC Unit Built-In AC unit operation and function is similar to a WAC. `gehomesdk` version bumped from 0.4.25 to 0.4.27 to include latest ErdApplianceType enum. * Update README.md Update README.md to include Built-In AC as supported device * - updated zero serial number detection (resolves #89) * - updated version - updated changelog * - hopefully fixed recursion bug with numbers * - added cooktop support * - fixed circular reference * Add support for fridges with reduced support for ERD codes (no turbo mode, no current temperature reporting, no temperature setpoint limit reporting, no door status reporting). This change has been tested on a Fisher & Paykel RF610AA. * - added dual dishwasher support - updated documentation - version bumps * - added water heater support * - added basic espresso maker device * - bugfixes * - rewrote initialization (resolves #99) * - added logic to prevent double registration of entities * - added correct min/max temps for water heaters * Fix CoffeeMaker after the NumberEntity refactoring * - added fix for CGY366P2TS1 (#116) to try to get the cooktop status, but fail more gracefully if it isn't supported * - fixed region setting in update coordinator * - version bump - doc update - string fixes * - updated the temperature conversion to use non-deprecated HASS methods * - updated documentation (@gleepwurp) * - more documentation updates * - updated dishwasher for new functionality - updated documentation * updated uom for liquid volume per HA specifications * - fixed typo in oven (#149) * - updated change log - fixed oven light control (#144) --------- Co-authored-by: Rob Schmidt <rwschmidt26@gmail.com> Co-authored-by: Federico Sevilla <federico@sevilla.id.au> Co-authored-by: alexanv1 <44785744+alexanv1@users.noreply.github.com>
2023-04-22 23:05:15 -06:00
Configuration is done via the HA user interface. You need to have your device registered with the [SmartHQ](https://www.geappliances.com/connect) website.
Once the HACS Integration of GE Home is completed:
1. Navigate to Settings --> Devices & Services
2. Click **Add Integration** blue button on the bottom-right of the page
3. Locate the **GE Home (SmartHQ)** "Brand" (Integration)
4. Click on the integration, and you will be prompted to enter a Username, Password and Location (US or EU)
5. Enter the email address you used to register/connect your device as the Username
6. Same with the password
7. Select the region you registered your device in (US or EU).
8. Once you submit, the integration will log in and get all your connected devices.
9. You can define in which area you device is, then click **Finish**
10. Your sensors should appear as **sensor.<serial_number>_<sensor_function>**
ie: sensor.fs12345678_dishwasher_cycle_name
## Change Log
2021-07-31 17:10:56 -06:00
Please click [here](CHANGELOG.md) for change information.
[commits-shield]: https://img.shields.io/github/commit-activity/y/simbaja/ha_gehome.svg?style=for-the-badge
[commits]: https://github.com/simbaja/ha_gehome/commits/master
[hacs]: https://github.com/custom-components/hacs
[hacsbadge]: https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge
[license-shield]: https://img.shields.io/github/license/simbaja/ha_gehome.svg?style=for-the-badge
[maintenance-shield]: https://img.shields.io/badge/maintainer-Jack%20Simbach%20%40simbaja-blue.svg?style=for-the-badge
[releases-shield]: https://img.shields.io/github/release/simbaja/ha_gehome.svg?style=for-the-badge
2022-10-16 08:44:14 -06:00
[releases]: https://github.com/simbaja/ha_gehome/releases