- updated documentation (@gleepwurp)

This commit is contained in:
Jack Simbach 2023-01-22 20:28:39 -05:00
parent 52a69a1ac6
commit faeaa90f5d
3 changed files with 19 additions and 2 deletions

View File

@ -4,6 +4,7 @@
## 0.6.6
- Fixed issue with region setting (EU accounts) [#130]
- Updated configuration documentation
## 0.6.5

View File

@ -26,6 +26,7 @@ Integration for GE WiFi-enabled appliances into Home Assistant. This integratio
## Updates
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.
## Home Assistant UI Examples
Entities card:
@ -56,9 +57,24 @@ A/C Controls:
## 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.
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

View File

@ -3,7 +3,7 @@
"name": "GE Home (SmartHQ)",
"config_flow": true,
"documentation": "https://github.com/simbaja/ha_gehome",
"requirements": ["gehomesdk==0.5.7","magicattr==0.1.5","slixmpp==1.7.1"],
"requirements": ["gehomesdk==0.5.8","magicattr==0.1.5","slixmpp==1.7.1"],
"codeowners": ["@simbaja"],
"version": "0.6.6"
}