From 93e4c968b0e36ed5c747cd6cb3ed5f747638ece8 Mon Sep 17 00:00:00 2001 From: Nik Rolls Date: Mon, 11 May 2020 19:50:54 +1200 Subject: [PATCH] Final tweaks for 0.1.0 --- .devcontainer/devcontainer.json | 13 +-- .vscode/settings.json | 11 ++- README.md | 139 +++++++++++++++----------------- 3 files changed, 79 insertions(+), 84 deletions(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index a16ad5f..d27657b 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -2,7 +2,7 @@ "name": "Goldair Climate dev", "image": "ludeeus/container:integration", "context": "..", - "appPort": ["8123:8123"], + "appPort": 8123, "postCreateCommand": "dc install", "runArgs": ["-e", "GIT_EDITOR=code --wait"], "extensions": [ @@ -12,15 +12,10 @@ "esbenp.prettier-vscode" ], "settings": { - "files.eol": "\n", + "files.exclude": { + "config/custom_components/goldair_climate": true + }, "python.pythonPath": "/usr/local/bin/python", - "python.linting.pylintEnabled": true, - "python.linting.enabled": true, - "python.formatting.provider": "black", - "editor.formatOnPaste": false, - "editor.formatOnSave": true, - "editor.formatOnType": true, - "files.trimTrailingWhitespace": true, "terminal.integrated.shell.linux": "/bin/bash" }, "mounts": [ diff --git a/.vscode/settings.json b/.vscode/settings.json index c35e1af..937b603 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,5 +1,10 @@ { - "files.exclude": { - "config/custom_components/goldair_climate": true - } + "editor.formatOnPaste": false, + "editor.formatOnSave": true, + "editor.formatOnType": true, + "files.eol": "\n", + "files.trimTrailingWhitespace": true, + "python.linting.pylintEnabled": true, + "python.linting.enabled": true, + "python.formatting.provider": "black" } diff --git a/README.md b/README.md index 98d6087..ba7b58d 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,55 @@ -Home Assistant Goldair WiFi Climate component -============================================= +# Home Assistant Goldair WiFi Climate component -The `goldair_climate` component integrates -[Goldair WiFi-enabled heaters](http://www.goldair.co.nz/product-catalogue/heating/wifi-heaters), WiFi-enabled [dehumidifiers](http://www.goldair.co.nz/product-catalogue/heating/dehumidifiers), and [WiFi-enabled fans](http://www.goldair.co.nz/product-catalogue/cooling/pedestal-fans/40cm-dc-quiet-fan-with-wifi-and-remote-gcpf315) into Home Assistant, enabling control of setting the following parameters via the UI and the following services: +The `goldair_climate` component integrates [Goldair WiFi-enabled heaters](http://www.goldair.co.nz/product-catalogue/heating/wifi-heaters), WiFi-enabled [dehumidifiers](http://www.goldair.co.nz/product-catalogue/heating/dehumidifiers), and [WiFi-enabled fans](http://www.goldair.co.nz/product-catalogue/cooling/pedestal-fans/40cm-dc-quiet-fan-with-wifi-and-remote-gcpf315) into Home Assistant, enabling control of setting the following parameters via the UI and the following services: **Heaters** -* **power** (on/off) -* **mode** (Comfort, Eco, Anti-freeze) -* **target temperature** (`5`-`35` in Comfort mode, `5`-`21` in Eco mode, in °C) -* **power level** (via the swing mode setting because no appropriate HA option exists: `Auto`, `1`-`5`, `Stop`) + +- **power** (on/off) +- **mode** (Comfort, Eco, Anti-freeze) +- **target temperature** (`5`-`35` in Comfort mode, `5`-`21` in Eco mode, in °C) +- **power level** (via the swing mode setting because no appropriate HA option exists: `Auto`, `1`-`5`, `Stop`) Current temperature is also displayed. **Demudifiers** -* **power** (on/off) -* **mode** (Normal, Low, High, Dry clothes, Air clean) -* **target humidity** (`30`-`80`%) + +- **power** (on/off) +- **mode** (Normal, Low, High, Dry clothes, Air clean) +- **target humidity** (`30`-`80`%) Current temperature is displayed, and current humidity is available as a property. The "tank full" state is available via the **error** attribute, and if you want to you can easily surface this to a top-level entity using a [template sensor](https://www.home-assistant.io/integrations/template/). **Fans** -* **power** (on/off) -* **mode** (Normal, Eco, Sleep) -* **fan mode** (`1`-`12`) -* **swing** (on/off) + +- **power** (on/off) +- **mode** (Normal, Eco, Sleep) +- **fan mode** (`1`-`12`) +- **swing** (on/off) **Light** -* **LED display** (on/off) + +- **LED display** (on/off) **Lock** (heaters and dehumidifiers) -* **Child lock** (on/off) + +- **Child lock** (on/off) There was previously a sensor option, however this is easily achieved using a [template sensor](https://www.home-assistant.io/integrations/template/) and therefore is no longer supported. --- ### Warning + Please note, this component has currently only been tested with the Goldair GPPH (inverter), GPDH420 (dehumidifier), and GCPF315 fan, however theoretically it should also work with GEPH and GPCV heater devices, may work with the GPDH440 dehumidifier and any other Goldair heaters, dehumidifiers or fans based on the Tuya platform. --- -Installation ------------- -The preferred installation method is via [HACS](https://hacs.xyz/). Once you have HACS set up, simply follow the [instructions for adding a custom repository](https://hacs.xyz/docs/navigation/settings#custom-repositories) and then the integration will be available to install like any other. +## Installation + +Installation is via the [Home Assistant Community Store (HACS)](https://hacs.xyz/), which is the best place to get third-party integrations for Home Assistant. Once you have HACS set up, simply follow the [instructions for adding a custom repository](https://hacs.xyz/docs/navigation/settings#custom-repositories) and then the integration will be available to install like any other. -Alternatively you can copy the contents of this repository's `custom_components` directory to your `/custom_components` directory, however you will not get automatic updates this way. +## Configuration -Configuration -------------- You can easily configure your devices using the Integrations UI at `Home Assistant > Configuration > Integrations > +`. This is the preferred method as things will be unlikely to break as this integration is upgraded. You will need to provide your device's IP address, device ID and local key; the last two can be found using [the instructions below](#finding-your-device-id-and-local-key). If you would rather configure using yaml, add the following lines to your `configuration.yaml` file (but bear in mind that if the configuration options change your configuration may break until you update it to match the changes): @@ -64,83 +66,76 @@ goldair_climate: ### Configuration variables #### name -    *(string) (Required)* Any unique for the device; required because the Tuya API doesn't provide - the one you set in the app. + +    _(string) (Required)_ Any unique name for the device; required because the Tuya API doesn't provide the one you set in the app. #### host -    *(string) (Required)* IP or hostname of the device. + +    _(string) (Required)_ IP or hostname of the device. #### device_id -    *(string) (Required)* Device ID retrieved - [as per the instructions below](#finding-your-device-id-and-local-key). + +    _(string) (Required)_ Device ID retrieved +[as per the instructions below](#finding-your-device-id-and-local-key). #### local_key -    *(string) (Required)* Local key retrieved - [as per the instructions below](#finding-your-device-id-and-local-key). + +    _(string) (Required)_ Local key retrieved +[as per the instructions below](#finding-your-device-id-and-local-key). #### type -    *(string) (Optional)* The type of Goldair device. `auto` to automatically detect the device type, or if that doesn't work, select from the available options `heater`, `dehumidifier` or `fan`. -    *Default value: auto* +    _(string) (Optional)_ The type of Goldair device. `auto` to automatically detect the device type, or if that doesn't work, select from the available options `heater`, `dehumidifier` or `fan`. +    _Default value: auto_ #### climate -    *(boolean) (Optional)* Whether to surface this appliance as a climate device. -    *Default value: true* +    _(boolean) (Optional)_ Whether to surface this appliance as a climate device. + +    _Default value: true_ #### display_light -    *(boolean) (Optional)* Whether to surface this appliance's LED display control as a light. -    *Default value: false* +    _(boolean) (Optional)_ Whether to surface this appliance's LED display control as a light. + +    _Default value: false_ #### child_lock -    *(boolean) (Optional)* Whether to surface this appliances's child lock as a lock device (not supported for fans). -    *Default value: false* +    _(boolean) (Optional)_ Whether to surface this appliances's child lock as a lock device (not supported for fans). + +    _Default value: false_ + +## Heater gotchas -Heater gotchas --------------- -Goldair heaters have individual target temperatures for their Comfort and Eco modes, whereas Home Assistant only supports -a single target temperature. Therefore, when you're in Comfort mode you will set the Comfort temperature (`5`-`35`), and -when you're in Eco mode you will set the Eco temperature (`5`-`21`), just like you were using the heater's own control -panel. Bear this in mind when writing automations that change the operation mode and set a temperature at the same time: -you must change the operation mode *before* setting the new target temperature, otherwise you will set the current -thermostat rather than the new one. +Goldair heaters have individual target temperatures for their Comfort and Eco modes, whereas Home Assistant only supports a single target temperature. Therefore, when you're in Comfort mode you will set the Comfort temperature (`5`-`35`), and when you're in Eco mode you will set the Eco temperature (`5`-`21`), just like you were using the heater's own control panel. Bear this in mind when writing automations that change the operation mode and set a temperature at the same time: you must change the operation mode _before_ setting the new target temperature, otherwise you will set the current thermostat rather than the new one. -When switching to Anti-freeze mode, the heater will set the current power level to `1` as if you had manually chosen it. -When you switch back to other modes, you will no longer be in `Auto` and will have to set it again if this is what you -wanted. This could be worked around in code however it would require storing state that may be cleared if HA is -restarted and due to this unreliability it's probably best that you just factor it into your automations. +When switching to Anti-freeze mode, the heater will set the current power level to `1` as if you had manually chosen it. When you switch back to other modes, you will no longer be in `Auto` and will have to set it again if this is what you wanted. This could be worked around in code however it would require storing state that may be cleared if HA is restarted and due to this unreliability it's probably best that you just factor it into your automations. -When child lock is enabled, the heater's display will flash with the child lock symbol (`[]`) whenever you change -something in HA. This can be confusing because it's the same behaviour as when you try to change something via the -heater's own control panel and the change is rejected due to being locked, however rest assured that the changes *are* -taking effect. +When child lock is enabled, the heater's display will flash with the child lock symbol (`[]`) whenever you change something in HA. This can be confusing because it's the same behaviour as when you try to change something via the heater's own control panel and the change is rejected due to being locked, however rest assured that the changes _are_ taking effect. -Fan gotchas ------------ -In my experience, fans don't like to receive a lot of commands in a short period of time. They will emit two fast beeps when accepting a command, and two slow beeps when rejecting one. If you are writing automations for your fan and need to set multiple properties, you may need to put a delay of around 5 seconds or more between each. +## Fan gotchas -Finding your device ID and local key ------------------------------------- -You can find these keys the same way as you would for any Tuya local integration. You'll need the Tuya Smart app rather -than the Goldair app (the Goldair app is just a re-branded clone of Tuya Smart). +In my experience, fans can be a bit flaky. If they become unresponsive, give them about 60 seconds to wake up again. -* [Instructions for iOS](https://github.com/codetheweb/tuyapi/blob/master/docs/SETUP.md) -* [Instructions for Android](https://github.com/codetheweb/tuyapi/blob/cdb4289/docs/SETUP_DEPRECATED.md#capture-https-traffic) +## Finding your device ID and local key + +You can find these keys the same way as you would for any Tuya local integration. You'll need the Goldair app or the Tuya Tuya Smart app (the Goldair app is just a rebranded Tuya app), then follow these instructions. + +- [Instructions for iOS](https://github.com/codetheweb/tuyapi/blob/master/docs/SETUP.md) +- [Instructions for Android](https://github.com/codetheweb/tuyapi/blob/cdb4289/docs/SETUP_DEPRECATED.md#capture-https-traffic) You're looking for `uuid` (this is the device ID) and the `localKey` values. -Next steps ----------- -This component needs specs! Once they're written I'm considering submitting it to the HA team for inclusion in standard -installations. Please report any issues and feel free to raise pull requests. +## Next steps + +This component needs specs! Once they're written I'm considering submitting it to the HA team for inclusion in standard installations. Please report any issues and feel free to raise pull requests. + +## Acknowledgements -Acknowledgements ----------------- None of this would have been possible without some foundational discovery work to get me started: -* [TarxBoy](https://github.com/TarxBoy)'s [investigation using codetheweb/tuyapi](https://github.com/codetheweb/tuyapi/issues/31) to figure out the correlation of the cryptic DPS states -* [sean6541](https://github.com/sean6541)'s [tuya-homeassistant](https://github.com/sean6541/tuya-homeassistant) library giving an example of integrating Tuya devices with Home Assistant -* [clach04](https://github.com/clach04)'s [python-tuya](https://github.com/clach04/python-tuya) library +- [TarxBoy](https://github.com/TarxBoy)'s [investigation using codetheweb/tuyapi](https://github.com/codetheweb/tuyapi/issues/31) to figure out the correlation of the cryptic DPS states +- [sean6541](https://github.com/sean6541)'s [tuya-homeassistant](https://github.com/sean6541/tuya-homeassistant) library giving an example of integrating Tuya devices with Home Assistant +- [clach04](https://github.com/clach04)'s [python-tuya](https://github.com/clach04/python-tuya) library