-
-
Notifications
You must be signed in to change notification settings - Fork 7.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added documentation for new integration igloohome #35784
Merged
+77
−0
Merged
Changes from 39 commits
Commits
Show all changes
43 commits
Select commit
Hold shift + click to select a range
7e4e3e1
- Added created file to code owners.
keithle888 b24948c
- Revert CODEOWNERS changes
keithle888 4421f70
- Change title to igloohome
keithle888 7e42c61
- Updated documentation to show that it only polls battery level at t…
keithle888 c85689d
- Added created file to code owners.
keithle888 4cd5d08
- Revert CODEOWNERS changes
keithle888 de5d131
- Change title to igloohome
keithle888 d384220
- Updated documentation to show that it only polls battery level at t…
keithle888 89953d4
- Removed Lock category.
keithle888 238b2f9
- Removed Lock category.
keithle888 41ec824
- Added section for verifying successful integration
keithle888 b65559b
Merge remote-tracking branch 'origin/feature/igloohome' into feature/…
keithle888 1246ce7
- Made spelling correction.
keithle888 0c7dc1d
- Corrected ha_release
keithle888 c669bf6
Merge branch 'next' into feature/igloohome
keithle888 b5008b1
- Added more pre-requisites
keithle888 3303c3c
- Cleanup extra lines
keithle888 feca6fa
- Added minor troubleshooting steps
keithle888 781a098
- Added more clarification
keithle888 54acea9
- Corrected bluetooth mis-spell
keithle888 49a0809
- Updated formatting for better clarity
keithle888 0003e43
- Update spellings
keithle888 98f8c2d
- Added removal documentation
keithle888 dd95dee
Merge branch 'next' into feature/igloohome
keithle888 b9eaf81
- Fixed spelling mistake
keithle888 82e3d07
- Updated pre-requisites to be more readable
keithle888 2230f0b
- Added configuration section
keithle888 9093678
- Refined some documentation
keithle888 d3abf18
- Added configuration descriptions
keithle888 7d5408d
- Added configuration descriptions
keithle888 d4f33a9
Merge branch 'next' into feature/igloohome
keithle888 9cc46e5
Updated ha_release to 2025.2
keithle888 d8af046
Correct client_secret key in configuration description
keithle888 8e5cf2c
- Updated troubleshooting steps
keithle888 4f19091
- Updated description to spell out features rather than linking to do…
keithle888 616b30f
- removed 'verify successful integration' section
keithle888 ad29dac
Merge branch 'next' into feature/igloohome
keithle888 db3565f
- Minor correction to indentation
keithle888 2c3f648
- Updated integration wording to include link to igloohome products
keithle888 07dc7e7
- Added description of company products in headline
keithle888 bc0cad9
Merge branch 'next' into feature/igloohome
keithle888 c073a36
- Updated description with mention of igloohome product types
keithle888 1a29d4e
Update source/_integrations/igloohome.markdown
silamon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 |
---|---|---|
@@ -0,0 +1,77 @@ | ||
--- | ||
title: igloohome | ||
description: Integrates igloohome devices via the igloodeveloper API. | ||
ha_category: | ||
- Sensor | ||
ha_release: 2025.2 | ||
ha_config_flow: true | ||
ha_iot_class: Cloud Polling | ||
ha_codeowners: | ||
- '@keithle888' | ||
ha_domain: igloohome | ||
ha_platforms: | ||
- sensor | ||
ha_integration_type: device | ||
--- | ||
|
||
The **igloohome** {% term integration %} grants Home Assistant access to your [device\(s\)](https://www.igloohome.co/#products) with the following features: | ||
keithle888 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- [Bridge](https://www.igloohome.co/products/bridge) owners: | ||
- Regular updates of all linked devices' battery level. | ||
|
||
- Non-bridge owners: | ||
- Regular updates of devices' last-known battery level. | ||
- Battery levels are updated by using the sync function on igloohome mobile app with the device. | ||
|
||
## Prerequisites | ||
|
||
- You own an igloohome device(s) and have paired them to an account. | ||
- Have an active subscription on [iglooaccess](https://access.igloocompany.co/register) with the same account. | ||
|
||
## Setup | ||
|
||
Once you have registered and activated your [iglooaccess](https://access.igloocompany.co/register) account: | ||
|
||
- [Sign in](https://access.igloocompany.co/login). | ||
- Jump to [API access](https://access.igloocompany.co/api-access). | ||
- Create a set of credentials with the name `Home Assistant`. | ||
- Copy out the `Client ID` & `Client Secret`. | ||
keithle888 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Keep these credentials secure and never share them with others. | ||
- Add this integration to your Home Assistant instance. | ||
- Copy the `Client ID` & `Client Secret` to the respective text fields when prompted by the integration. | ||
- The integration will retrieve the devices under your account and create entries for them in Home Assistant. | ||
|
||
{% include integrations/config_flow.md %} | ||
|
||
{% configuration_basic %} | ||
Client ID: | ||
description: "Client ID provided by your iglooaccess account." | ||
required: true | ||
type: string | ||
Client secret: | ||
description: "Client Secret provided by your iglooaccess account." | ||
required: true | ||
type: string | ||
{% endconfiguration_basic %} | ||
|
||
## Removing the integration | ||
|
||
This integration follows standard integration removal. No extra steps are required. | ||
|
||
{% include integrations/remove_device_service.md %} | ||
|
||
## Troubleshooting | ||
|
||
Some generic troubleshooting steps: | ||
|
||
- Ensure that your subscription is still active. | ||
|
||
### Battery levels not updating | ||
|
||
- If you are using a bridge, ensure that it is linked to the correct devices. | ||
- If you do not have a bridge. Sync the device with the igloohome mobile app, then reload the config entry associated to the device. | ||
|
||
### Authentication problems | ||
|
||
- Verify that your [API credentials](https://access.igloocompany.co/api-access) are correctly filled in. | ||
- Ensure your API credentials have not expired or been revoked. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just this description left and then we're done. :D
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @silamon , ah okay gotcha. I moved the migrated of the API into the main body rather than this description and mentioned the smart access devices as requested.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We've agreed earlier that the api shouldn't be mentioned to the end customer. So, there should be no mention of the api at all.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @silamon ,
This is actually question I've left for you.
I've seen multiple integrations (e.g. SmartThings) include the mention of the API. I understand that a non-tech user would not care about the API mention. However, mentioning the API has helpful for me to understand how the integration works on a high-level and the potential implications of it.
If you would still prefer not mentioning the API at all, I can strip it out.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've opened #36870 to add it back. I've been a bit too strict about this.