-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #121 from jdeath/aiohubspace
Move connection logic into aiohubspace
- Loading branch information
Showing
40 changed files
with
3,207 additions
and
3,311 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| __pycache__ | ||
| .idea/ | ||
| custom_components/hubspace/dump_*.json | ||
| .coverage |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,187 +1,145 @@ | ||
| [](https://github.com/jdeath/Hubspace-Homeassistant/stargazers) | ||
| # Overview | ||
| This repository provides an integration between Hubspace and Home Assistant. Due to the cloud-first | ||
| nature of Hubspace devices, an internet connection needs to be available, along with the Hubspace servers. | ||
|
|
||
| Please ask support questions in homeassistant forums: https://community.home-assistant.io/t/add-support-for-hubspace-by-afero/306645 | ||
|
|
||
| ### Background | ||
| HubSpace is reliant on a cloud connection which means this integration could break at any point. Not all | ||
| devices may be supported with and developer time will be required to add new devices. Supported | ||
| device types: | ||
| ## Supported Devices | ||
| A supported device indicates that is maps into Home Assistant. Please note that not all | ||
| devices will correctly map and may require further troubleshooting. The supported Devices | ||
| are as follows: | ||
|
|
||
| * Fan | ||
|
|
||
| * fan | ||
| * On/Off | ||
| * Speed | ||
| * Preset mode | ||
| * device-lock | ||
|
|
||
| * Freezer | ||
|
|
||
| * Error sensors | ||
|
|
||
| * Lock | ||
|
|
||
| * Lock / Unlock | ||
| * light | ||
|
|
||
| * Light | ||
|
|
||
| * On/Off | ||
| * Color Temperature | ||
| * Color Sequences | ||
| * Dimming | ||
| * RGB | ||
| * Not working | ||
| * HS (missing data dump for this device) | ||
| * RGBW (missing data dump for this device) | ||
| * RGBWW (missing data dump for this device) | ||
| * WHITE (missing data dump for this device) | ||
| * XY (missing data dump for this device) | ||
| * power-outlet | ||
| * On/Off | ||
| * switch | ||
| * On/Off | ||
| * landscape-transformer (missing data dump for this device) | ||
|
|
||
| * Outlet / Switch / Transformer | ||
|
|
||
| * On/Off | ||
| * water-valve | ||
| * Open / Close | ||
|
|
||
| ### Breaking Change: | ||
| @Expl0dingBanana did amazing work to allow configuration via the UI, async calls, robust autoscan, and treating devices correctly instead of everything as a light. A few devices are left to be tested. | ||
| * Water Valve | ||
|
|
||
| Configuration is done through the `Add Integrations` rather than configuration.yaml. | ||
| Some devices may not work after moving the configuration to the integration. Please review | ||
| the docs on how to gather the device data to send to the developer. | ||
| * Open / Close | ||
|
|
||
| No longer supports services. Many often used services are incorperated into the device types. Hopefully will be added back | ||
|
|
||
| Thanks to @dloveall and now @Expl0dingBanana this release will automatically discover most devices. Post an issue, if your device is no longer found. | ||
| ## Changelog | ||
|
|
||
| Since some of the internals were changed, so your light name may change. locks will now be locks, fans actual fans, etc | ||
| * 4.0.0 | ||
|
|
||
| To solve this, go to Settings->Devices and Services->Entities | ||
| find the light.friendlyname and delete it. then find the light.friendlyname_2 and rename it light.friendlyname | ||
| * BREAK: Sensors have new names. Old sensors marked as unavailable can be removed. | ||
| * Enabled customization of Hubspace polling intervals | ||
| * Created a button for generating debug data dumps | ||
| * Backend now uses aiohubspace to talk to Hubspace | ||
| * Removed logic on setting states within Home Assistant | ||
| * Devices are only created from the "top-level" device, rather than individually | ||
| * Added models for HPDA110NWBP and HPSA11CWB | ||
|
|
||
| ### Information : | ||
| This integration talks to the HubSpace API to set and retrieve states for all | ||
| of your registered devices. Once the devices are discovered, it will determine | ||
| device capability and show correctly within Home Assistant. | ||
| * 3.3.0 | ||
|
|
||
| _Thanks to everyone who starred my repo! To star it click on the image below, then it will be on top right. Thanks!_ | ||
| * Add binary sensors for freezers | ||
|
|
||
| * 3.2.0 | ||
|
|
||
| [](https://github.com/jdeath/hubspace-homeassistant/stargazers) | ||
| * Enable a custom timeout during initial configuration | ||
|
|
||
| ### Installation | ||
|
|
||
| ## Installation | ||
|
|
||
| #### UI (Preferred) | ||
| Add this repo as a custom repository in [HACS](https://hacs.xyz/). Add the hubspace integration. | ||
|
|
||
| Clicking this badge should add the repo for you: | ||
| [](https://my.home-assistant.io/redirect/hacs_repository/?owner=jdeath&repository=Hubspace-Homeassistant&category=integration) | ||
|
|
||
| #### Manual | ||
| Manually add repo: | ||
| Adding a custom repo directions `https://hacs.xyz/docs/faq/custom_repositories/` | ||
| Use the custom repo link `https://github.com/jdeath/Hubspace-Homeassistant` | ||
| Select the category type `integration` | ||
| Then once it's there (still in HACS) click the INSTALL button | ||
|
|
||
| Manual method: copy the hubspace/ folder in the repo to `<config_dir>/custom_components/hubspace/`. | ||
|
|
||
| ### Configuration | ||
| After HubSpace has been added through HACs, the | ||
| ## Configuration | ||
| After Hubspace has been added through HACs, the | ||
| configuration continues within the UI like other integrations. First select `Settings` | ||
| on the navigation bar, then select `Devices & services`, ensure you are on the | ||
| `Integrations` tab, then finally select `ADD INTEGRATION` at the bottom right | ||
| of the page. Search for `HubSpace` and enter your username and password and | ||
| of the page. Search for `Hubspace` and enter your username and password and | ||
| click `SUBMIT`. Entities should start appearing shortly after clicking submit. | ||
|
|
||
| If your username or password is incorrect, the form will not be submitted. | ||
| After discovered, the poll time can be configured for quicker or longer | ||
| polling intervals. By default, Hubspace is polled once every 30 seconds. | ||
|
|
||
| ### Configuration Troubleshooting | ||
|
|
||
| * Unable to authenticate with the provided credentials | ||
|
|
||
| * Ensure the provided credentials can authenticate to Hubspace | ||
|
|
||
| * Connection timed out when reaching the server | ||
|
|
||
| * Increase the timeout | ||
|
|
||
|
|
||
|
|
||
| ### Troubleshooting | ||
| # Troubleshooting | ||
| Device troubleshooting may require a data dump from Hubspace. This can | ||
| be generated within the UI, but will need to be retrieved with something | ||
| that can access Home Assistants Filestore. | ||
|
|
||
| * Navigate to the Hubspace Devices | ||
|
|
||
| * Settings -> Devices & services -> Integrations -> Hubspace | ||
|
|
||
| * Click on devices on the navigation bar underneath the Hubspace logo | ||
| * Click on the device named labeled `hubspace-<email_address>` | ||
| * Click `Press` on `Generate Debug` underneath Controls | ||
| * Open File Editor | ||
| * Click the folder icon on the top left | ||
| * Navigate to custom_components -> hubspace | ||
| * Download the required files: | ||
|
|
||
| * `_dump_hs_devices.json`: Anonymized device dumps consumed by the Hubspace integration | ||
|
|
||
|
|
||
| # FAQ | ||
|
|
||
| * I have a device in Hubspace that is not added to Home Assistant | ||
|
|
||
| * I have a device in HubSpace that is not added to Home Assistant | ||
| * Check the logs for any warning / errors around hubspace and report the issue. | ||
| * If no warning / error messages exist around HubSpace, the device type is likely | ||
| * If no warning / error messages exist around Hubspace, the device type is likely | ||
| not supported. Refer to the troubleshooting section to grab anonymized logs and | ||
| open a new issue with the logs and state the device that did not discover | ||
|
|
||
| * I have a device and its missing functionality | ||
|
|
||
| * Refer to the troubleshooting section to grab anonymized logs and | ||
| open a new issue with the logs and state the device that is not working | ||
| along with the broken functionality | ||
|
|
||
| * I have a device and its functionality is not working | ||
|
|
||
| * Refer to the troubleshooting section to grab anonymized logs and | ||
| open a new issue with the logs and state the device that is not working | ||
| along with the broken functionality | ||
| * If the developers are unable to solve the problem with the anonymized data, | ||
| the raw data may need to be provided | ||
|
|
||
| ### Support for a new model | ||
| To support a new model, the states and metadata will need to be gathered. To accomplish | ||
| this, you will need to gather the data. There are two ways to grab this information: | ||
|
|
||
| * Through a shell (target a specific device) | ||
| * Through the UI | ||
|
|
||
| #### Shell | ||
| Gathering this information through the shell is preferred as you | ||
| can target the device you want. You must have a python | ||
| interpreter installed for this to work. After it is installed, | ||
| the following setup steps must be run: | ||
|
|
||
| * (Optional) Use a virtualenv | ||
| * Unix | ||
| * ```bash | ||
| python -m pip install virtualenv | ||
| python -m virtualenv ~/.virtualenv/hubspace | ||
| source ~/.virtualenv/hubspace/bin/activate | ||
| ``` | ||
| * Windows | ||
| * ```bat | ||
| python -m pip install virtualenv | ||
| python -m virtualenv "%userprofile%\.virtualenv\hubspace" | ||
| %userprofile%\.virtualenv\hubspace\Scripts\activate.bat | ||
| ``` | ||
| * Download requirements | ||
| * ```sh | ||
| python -m pip install requests "hubspace_async>=0.0.5" asyncclick | ||
| ``` | ||
| * Goto your home directory | ||
| * Unix | ||
| * ```bash | ||
| cd ~ | ||
| ``` | ||
| * Windows | ||
| * ```bat | ||
| cd %userprofile% | ||
| ``` | ||
| * Download the anonymizer code | ||
| * ```bash | ||
| python -c "import requests; data=requests.get('https://raw.githubusercontent.com/jdeath/Hubspace-Homeassistant/main/custom_components/hubspace/anonomyize_data.py').text; fh=open('anonomyize_data.py', 'w'); fh.write(data); fh.close();" | ||
| ``` | ||
| * Run the anonymizer code (but fill in username and password) | ||
| * Determine the device (gets child_id and friendly names) | ||
| * Get all devices | ||
| * ```python | ||
| python anonomyize_data.py --username "<username>" --password "<password>" get-devs | ||
| ``` | ||
| * Gather data based on friendlyName or childID. This will create a .json file with the friendlyname in the current directory | ||
| * Get devices based on a friendlyName | ||
| * ```python | ||
| python anonomyize_data.py --username "<username>" --password "<password>" friendly-name --fn "<friendly name>" | ||
| ``` | ||
| * Get devices based on a childId | ||
| * ```python | ||
| python anonomyize_data.py --username "<username>" --password "<password>" child-id --child_id "<child_id>" | ||
| ``` | ||
|
|
||
| #### Through the UI | ||
| Gathering data through the UI provides a less targeted approach to gathering data | ||
| as it will pull all devices. This may be required if a device cannot be fixed with | ||
| a normal data dump, or you are not comfortable running python on your system. It requires | ||
| the add-on `File Editor` or a similar add-on / integration that enables you to download | ||
| files from Home Assistant. After the file downloader has been installed onto Home | ||
| Assistant, the following steps are required to gather the data: | ||
|
|
||
| * Enable Debug | ||
| * Settings -> Devices & services -> Integrations -> hubspace -> Enable debug logging | ||
| * Wait 30s - 60s for the files to generate | ||
| * Open File Editor | ||
| * Click the folder icon on the top left | ||
| * Navigate to custom_components -> hubspace | ||
| * Download the required files: | ||
| * `_dump_hs_devices.json`: Anonymized device dumps consumed by the HubSpace integration | ||
| * `_dump_hs_raw.json`: Raw data from the connector. This data is not anonymized | ||
| * Disable debug | ||
| * Settings -> Devices & services -> Integrations -> hubspace -> Disable debug logging | ||
| * I have a device that does not display the correct model | ||
|
|
||
| * Generate the debug logs and create an issue on GitHub. | ||
|
|
||
|
|
||
|
|
||
| _Thanks to everyone who starred my repo! To star it click on the image below, then it will be on top right. Thanks!_ | ||
|
|
||
| [](https://star-history.com/#jdeath/Hubspace-Homeassistant&Date) |
Oops, something went wrong.