Dev

CHANGELOG.md

@@ -0,0 +1,143 @@
+
+# GE Home Appliances (SmartHQ) Changelog
+
+## 0.6.15
+
+- Feature: Improved Support for Laundry
+- Breaking: Some enums changed names/values and may need updates to client code
+- Bugfix: More deprecation fixes
+
+## 0.6.14
+
+- Bugfix: Error checking socket status [#304]
+- Bugfix: Error with setup [#301]
+- Bugfix: Logger deprecations
+
+## 0.6.13
+
+- Bugfix: Deprecations [#290] [#297] 
+
+## 0.6.12
+
+- Bugfix: Deprecations [#271]
+
+## 0.6.11
+
+- Bugfix: Fixed convertable drawer issue [#243]
+- Bugfix: Updated app types to include electric cooktops [#252]
+- Bugfix: Updated clientsession to remove deprecation [#253]
+- Bugfix: Fixed error strings
+- Bugfix: Updated climate support for new flags introduced in 2024.2.0
+
+## 0.6.10
+
+- Bugfix: Removed additional deprecated constants [#229]
+- Bugfix: Fixed issue with climate entities [#228]
+
+## 0.6.9
+
+- Added additional fridge controls [#200]
+- Bugfix: Additional auth stability improvements [#215, #211]
+- Bugfix: Removed deprecated constants [#218]
+
+## 0.6.8
+
+- Added Dehumidifier [#114]
+- Added oven drawer sensors
+- Added oven current state sensors [#175]
+- Added descriptors to manifest [#181]
+- Bugfix: Fixed issue with oven lights [#174]
+- Bugfix: Fixed issues with dual dishwasher [#161]
+- Bugfix: Fixed disconnection issue [#169]
+
+
+## 0.6.7
+
+- Bugfix: fixed issues with dishwasher [#155]
+- Added OIM descaling sensor [#154]
+
+## 0.6.6
+
+- Bugfix: Fixed issue with region setting (EU accounts) [#130]
+- Updated the temperature conversion (@partsdotpdf)
+- Updated configuration documentation
+- Modified dishwasher to include new functionality (@NickWaterton)
+- Bugfix: Fixed oven typo (@jdc0730) [#149]
+- Bugfix: UoM updates (@morlince) [#138]
+- Updated light control (@tcgoetz) [#144]
+- Dependency version bumps
+
+## 0.6.5
+
+- Added beverage cooler support (@kksligh)
+- Added dual dishwasher support (@jkili)
+- Added initial espresso maker support (@datagen24)
+- Added whole home water heater support (@seantibor)
+
+## 0.6.3
+
+- Updated detection of invalid serial numbers (#89)
+- Updated implementation of number entities to fix deprecation warnings (#85)
+
+## 0.6.2
+
+- Fixed issue with water heater naming when no serial is present
+- Initial support for built-in air conditioners (@DaveZheng)
+
+## 0.6.1
+
+- Fixed issue with water filter life sensor (@rgabrielson11)
+
+## 0.6.0
+
+- Requires HA 2021.12.x or later
+- Enabled authentication to both US and EU regions
+- Changed the sensors to use native value/uom
+- Changed the temperatures to always be natively fahrenheit (API appears to always use this system) (@vignatyuk)
+- Initial support for Microwaves (@mbcomer, @mnestor)
+- Initial support for Water Softeners (@npentell, @drjeff)
+- Initial support for Opal Ice Makers (@mbcomer, @knobunc)
+- Initial support for Coffee Makers (@alexanv1)
+- Updated deprecated icons (@mjmeli, @schmittx)
+
+## 0.5.0
+
+- Initial support for oven hoods (@digitalbites)
+- Added extended mode support for ovens
+- Added logic to prevent multiple configurations of the same GE account
+- Fixed device info when serial not present (@Xe138)
+- Fixed issue with ovens when raw temperature not available (@chadohalloran)
+- Fixed issue where Split A/C temperature sensors report UOM incorrectly (@RobertusIT)
+- Added convertable drawer mode, proximity light, and interior lights to fridge (@groto27, @elwing00)
+## 0.4.3
+
+- Enabled support for appliances without serial numbers
+- Added support for Split A/C units (@RobertusIT)
+- Added support for Window A/C units (@mbrentrowe, @swcrawford1)
+- Added support for Portable A/C units (@luddystefenson)
+- Fixed multiple binary sensors (bad conversion from enum) (@steveredden)
+- Fixed delay time interpretation for laundry (@steveredden, @sweichbr)
+- Fixed startup issue when encountering an unknown unit type(@chansearrington, @opie546)
+- Fixed interpretation of A/C demand response power (@garulf)
+- Fixed issues with updating disabled entities (@willhayslett)
+- Advantium fixes (@willhayslett)
+
+## 0.4.1
+
+- Fixed an issue with dryer entities causing an error in HA (@steveredden)
+
+## 0.4.0
+
+- 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
+
+## 0.3.12
+
+- Initial tracked version

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Andrew Marks
+Copyright (c) 2021
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,23 +1,90 @@
-# Custom Components for Home Assistant
-
-## `ge_kitchen`
-Integration for GE WiFi-enabled kitchen appliances.  So far, I've only done fridges and ovens (because that's what I
-have), but I hope to to dishwashers next.  Because HA doesn't have Fridge or Oven platforms, both fridges and ovens are
-primarily represented as water heater entities, which works surprisingly well.  If anybody who has other GE appliances
-sees this and wants to pitch in, please shoot me a message or make a PR.  
-
-Entities card:
-
-![Entities](https://raw.githubusercontent.com/ajmarks/ha_components/master/img/appliance_entities.png)
-
-Fridge Controls:
-
-![Fridge controls](https://raw.githubusercontent.com/ajmarks/ha_components/master/img/fridge_control.png)
-
-Oven Controls:
-
-![Fridge controls](https://raw.githubusercontent.com/ajmarks/ha_components/master/img/oven_controls.png)
-
-## What happened to `shark_iq`?
-
-It's part of Home Assistant as of [0.115](https://www.home-assistant.io/blog/2020/09/17/release-115/)!
+# GE Home Appliances (SmartHQ)
+
+[![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
+- Dishwasher / F&P Dual Dishwasher 
+- Laundry (Washer/Dryer)
+- Whole Home Water Filter
+- Whole Home Water Softener
+- Whole Home Water Heater
+- A/C (Portable, Split, Window, Built-In)
+- Range Hood
+- Advantium
+- Microwave
+- Opal Ice Maker
+- Coffee Maker / Espresso Maker
+- Beverage Center
+
+**Forked from Andrew Mark's [repository](https://github.com/ajmarks/ha_components).**
+## 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:
+
+![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.
+
+## Configuration
+
+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
+
+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
+[releases]: https://github.com/simbaja/ha_gehome/releases

custom_components/ge_home/__init__.py

@@ -0,0 +1,81 @@
+"""The ge_home integration."""
+
+import logging
+from homeassistant.const import EVENT_HOMEASSISTANT_STOP
+import voluptuous as vol
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
+from homeassistant.const import CONF_REGION
+from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryNotReady
+from .const import DOMAIN
+from .exceptions import HaAuthError, HaCannotConnect
+from .update_coordinator import GeHomeUpdateCoordinator
+
+_LOGGER = logging.getLogger(__name__)
+CONFIG_SCHEMA = vol.Schema({DOMAIN: vol.Schema({})}, extra=vol.ALLOW_EXTRA)
+
+
+async def async_setup(hass: HomeAssistant, config: dict):
+    return True
+
+async def async_migrate_entry(hass: HomeAssistant, config_entry: ConfigEntry):
+    """Migrate old entry."""
+    _LOGGER.debug("Migrating from version %s", config_entry.version)
+
+    if config_entry.version == 1:
+
+        new = {**config_entry.data}
+        new[CONF_REGION] = "US"
+
+        config_entry.version = 2
+        hass.config_entries.async_update_entry(config_entry, data=new)
+
+    _LOGGER.info("Migration to version %s successful", config_entry.version)
+
+    return True    
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
+    """Set up ge_home from a config entry."""
+    hass.data.setdefault(DOMAIN, {})
+
+    #try to get existing coordinator
+    existing: GeHomeUpdateCoordinator = dict.get(hass.data[DOMAIN],entry.entry_id)
+
+    coordinator = GeHomeUpdateCoordinator(hass, entry)
+    hass.data[DOMAIN][entry.entry_id] = coordinator
+
+    # try to unload the existing coordinator
+    try:
+        if existing:
+            await coordinator.async_reset()
+    except:
+        _LOGGER.warning("Could not reset existing coordinator.")
+
+    try:
+        if not await coordinator.async_setup():
+            return False
+    except HaCannotConnect:
+        raise ConfigEntryNotReady("Could not connect to SmartHQ")
+    except HaAuthError:
+        raise ConfigEntryAuthFailed("Could not authenticate to SmartHQ")
+
+    hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STOP, coordinator.shutdown)
+
+    return True
+
+
+async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry):
+    """Unload a config entry."""
+    coordinator: GeHomeUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
+    ok = await coordinator.async_reset()
+    if ok:
+        hass.data[DOMAIN].pop(entry.entry_id)
+
+    return ok
+
+
+async def async_update_options(hass, config_entry):
+    """Update options."""
+    await hass.config_entries.async_reload(config_entry.entry_id)

custom_components/ge_home/binary_sensor.py

@@ -0,0 +1,47 @@
+"""GE Home Sensor Entities"""
+import logging
+from typing import Callable
+
+from homeassistant.components.switch import SwitchEntity
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant, callback
+from homeassistant.helpers.dispatcher import async_dispatcher_connect
+from homeassistant.helpers import entity_registry as er
+
+from .const import DOMAIN
+from .devices import ApplianceApi
+from .entities import GeErdBinarySensor
+from .update_coordinator import GeHomeUpdateCoordinator
+
+_LOGGER = logging.getLogger(__name__)
+
+async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities: Callable):
+    """GE Home binary sensors."""
+
+    _LOGGER.debug('Adding GE Binary Sensor Entities')
+    coordinator: GeHomeUpdateCoordinator = hass.data[DOMAIN][config_entry.entry_id]
+    registry = er.async_get(hass)
+
+    @callback
+    def async_devices_discovered(apis: list[ApplianceApi]):
+        _LOGGER.debug(f'Found {len(apis):d} appliance APIs')
+
+        entities = [
+            entity
+            for api in apis
+            for entity in api.entities
+            if isinstance(entity, GeErdBinarySensor) and not isinstance(entity, SwitchEntity)
+            if not registry.async_is_registered(entity.entity_id)
+        ]
+        _LOGGER.debug(f'Found {len(entities):d} unregistered binary sensors')
+        async_add_entities(entities)
+
+    #if we're already initialized at this point, call device
+    #discovery directly, otherwise add a callback based on the
+    #ready signal
+    if coordinator.initialized:
+        async_devices_discovered(coordinator.appliance_apis.values())
+    else:    
+        # add the ready signal and register the remove callback
+        coordinator.add_signal_remove_callback(
+            async_dispatcher_connect(hass, coordinator.signal_ready, async_devices_discovered))