Skip to content
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
merged 43 commits into from
Jan 11, 2025
Merged
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
7e4e3e1
- Added created file to code owners.
keithle888 Nov 15, 2024
b24948c
- Revert CODEOWNERS changes
keithle888 Nov 16, 2024
4421f70
- Change title to igloohome
keithle888 Nov 16, 2024
7e42c61
- Updated documentation to show that it only polls battery level at t…
keithle888 Nov 16, 2024
c85689d
- Added created file to code owners.
keithle888 Nov 15, 2024
4cd5d08
- Revert CODEOWNERS changes
keithle888 Nov 16, 2024
de5d131
- Change title to igloohome
keithle888 Nov 16, 2024
d384220
- Updated documentation to show that it only polls battery level at t…
keithle888 Nov 16, 2024
89953d4
- Removed Lock category.
keithle888 Nov 18, 2024
238b2f9
- Removed Lock category.
keithle888 Nov 18, 2024
41ec824
- Added section for verifying successful integration
keithle888 Nov 18, 2024
b65559b
Merge remote-tracking branch 'origin/feature/igloohome' into feature/…
keithle888 Nov 18, 2024
1246ce7
- Made spelling correction.
keithle888 Nov 18, 2024
0c7dc1d
- Corrected ha_release
keithle888 Nov 18, 2024
c669bf6
Merge branch 'next' into feature/igloohome
keithle888 Nov 24, 2024
b5008b1
- Added more pre-requisites
keithle888 Nov 24, 2024
3303c3c
- Cleanup extra lines
keithle888 Nov 24, 2024
feca6fa
- Added minor troubleshooting steps
keithle888 Nov 24, 2024
781a098
- Added more clarification
keithle888 Nov 24, 2024
54acea9
- Corrected bluetooth mis-spell
keithle888 Nov 24, 2024
49a0809
- Updated formatting for better clarity
keithle888 Nov 24, 2024
0003e43
- Update spellings
keithle888 Nov 24, 2024
98f8c2d
- Added removal documentation
keithle888 Nov 30, 2024
dd95dee
Merge branch 'next' into feature/igloohome
keithle888 Dec 8, 2024
b9eaf81
- Fixed spelling mistake
keithle888 Dec 8, 2024
82e3d07
- Updated pre-requisites to be more readable
keithle888 Dec 15, 2024
2230f0b
- Added configuration section
keithle888 Dec 15, 2024
9093678
- Refined some documentation
keithle888 Dec 15, 2024
d3abf18
- Added configuration descriptions
keithle888 Dec 15, 2024
7d5408d
- Added configuration descriptions
keithle888 Dec 15, 2024
d4f33a9
Merge branch 'next' into feature/igloohome
keithle888 Dec 15, 2024
9cc46e5
Updated ha_release to 2025.2
keithle888 Jan 1, 2025
d8af046
Correct client_secret key in configuration description
keithle888 Jan 1, 2025
8e5cf2c
- Updated troubleshooting steps
keithle888 Jan 1, 2025
4f19091
- Updated description to spell out features rather than linking to do…
keithle888 Jan 1, 2025
616b30f
- removed 'verify successful integration' section
keithle888 Jan 1, 2025
ad29dac
Merge branch 'next' into feature/igloohome
keithle888 Jan 1, 2025
db3565f
- Minor correction to indentation
keithle888 Jan 1, 2025
2c3f648
- Updated integration wording to include link to igloohome products
keithle888 Jan 2, 2025
07dc7e7
- Added description of company products in headline
keithle888 Jan 11, 2025
bc0cad9
Merge branch 'next' into feature/igloohome
keithle888 Jan 11, 2025
c073a36
- Updated description with mention of igloohome product types
keithle888 Jan 11, 2025
1a29d4e
Update source/_integrations/igloohome.markdown
silamon Jan 11, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 77 additions & 0 deletions source/_integrations/igloohome.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: igloohome
description: Integrates igloohome smart access devices.
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 paired [smart access device\(s\)](https://www.igloohome.co/#products). The features of this integration includes:

- For [Bridge](https://www.igloohome.co/products/bridge) owners:
- Regular updates of all linked devices' battery level.

- For 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.
Loading