-
-
Notifications
You must be signed in to change notification settings - Fork 8k
Add documentation for the Cielo Home integration #42477
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
Open
ihsan-cielo
wants to merge
18
commits into
home-assistant:next
Choose a base branch
from
cielo-connect:add/cielo_home-docs
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
ab83efe
Add documentation for the Cielo Home integration
ihsan-cielo f818eef
Adding ha_release
ihsan-cielo 6b320cb
Removing company link, not required
ihsan-cielo 9143bfb
Adding Synonyms Prerequisites
ihsan-cielo c7fca72
Using bold for only UI keywords
ihsan-cielo 09a5abb
Improving docs Content
ihsan-cielo bb8d2c9
Improving docs Content
ihsan-cielo 6878e09
Minor Improving docs Content
ihsan-cielo 1e7871a
Minor Change: Improving docs Content
ihsan-cielo 3e55022
Minor Change: Improving docs Content
ihsan-cielo c1eacc9
Minor Change: Adding integration Setting Link
ihsan-cielo 439e745
Minor Fix: Removing unnecessary bold statements
ihsan-cielo caed71a
Apply suggestions from code review
ihsan-cielo 4f2b4e1
Apply suggestions from code review
ihsan-cielo c685393
removing line length limit
ihsan-cielo 6d57ef6
Apply suggestions from code review
ihsan-cielo 26edd5b
Apply suggestions from code review
ihsan-cielo 7d181c4
Apply suggestions from code review
ihsan-cielo 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
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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,157 @@ | ||
| --- | ||
| title: Cielo Home | ||
| description: Instructions on how to integrate Cielo smart thermostats in Home Assistant. | ||
| ha_category: | ||
| - Climate | ||
| ha_iot_class: Cloud Polling | ||
| ha_release: 2026.1 | ||
| ha_config_flow: true | ||
| ha_codeowners: | ||
| - '@cielo-connect' | ||
| - '@ihsan-cielo' | ||
|
|
||
| ha_domain: cielo_home | ||
| ha_platforms: | ||
| - climate | ||
| ha_integration_type: integration | ||
| ha_quality_scale: bronze | ||
| --- | ||
|
|
||
| The **Cielo Home** {% term integration %} allows you to control [Cielo](https://www.cielowigle.com) devices directly from Home Assistant, using the cloud-based **Cielo Connect API**. | ||
|
|
||
| ## Supported devices | ||
|
|
||
| The **Cielo Home** {% term integration %} supports the following devices. | ||
|
|
||
| - **Cielo Breez Max**: Smart thermostat for mini-splits. | ||
| - **Cielo Breez Edge Pro**: Smart thermostat for mini-splits. | ||
| - **Cielo Thermostat Eco**: Smart thermostat for central HVAC systems. | ||
| - **Cielo Smart Thermostat**: Smart thermostat for central HVAC systems. | ||
|
|
||
c0ffeeca7 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Prerequisites | ||
|
|
||
| Before integrating the Cielo devices with Home Assistant, ensure that: | ||
|
|
||
| - Your Cielo device is already registered in the **Cielo Home** app. | ||
| - The device is among the supported devices listed above. | ||
| - The device has a configured remote (automatically or manually). | ||
| - Your Home Assistant server has internet access. | ||
| - Before proceeding, ensure the Cielo device is fully compatible with Home Assistant. | ||
|
|
||
c0ffeeca7 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ### Important API key rules | ||
|
|
||
| To safeguard security and prevent unauthorized access, Cielo enforces the following API security restrictions: | ||
|
|
||
| - Each API key can be used only once. | ||
| - A new API key cannot be generated until the current one is revoked. | ||
| - You may generate a maximum of 3 keys per month. | ||
| - Once a new API key is generated, wait 60 seconds for it to be displayed on the screen. | ||
| - Revoking an API key will disconnect Home Assistant immediately or within about a minute. | ||
c0ffeeca7 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Obtaining an API key | ||
|
|
||
| 1. Visit the [Cielo Web Portal](https://home.cielowigle.com). | ||
| 2. Open the Menu by selecting the hamburger menu icon {% icon "mdi:menu" %} at the top left side. | ||
| 3. Select **Home Assistant** from the sidebar. | ||
| 4. The API key will be displayed. Copy the API key from the dialog. | ||
|
|
||
|
|
||
| {% tip %} | ||
| If the message **This key is already used** appears, you must first revoke the old key before generating a new one. | ||
| {% endtip %} | ||
|
|
||
| {% include integrations/config_flow.md %} | ||
|
|
||
| If authentication succeeds, Home Assistant will automatically create the climate entities for all supported Cielo devices in your account. | ||
|
|
||
| {% note %} | ||
|
|
||
| If you add or set up a new Cielo device after configuring the integration in Home Assistant, you must reload the integration: | ||
|
|
||
| 1. Go to {% my integrations title="**Settings** > **Devices & services**" %}. | ||
| 2. Select **Cielo Home** and in the right corner, select the three dots {% icon "mdi:dots-vertical" %} menu. | ||
| 3. Select **Reload**. | ||
|
|
||
| {% endnote %} | ||
|
|
||
| ## Supported functionality | ||
|
|
||
| Each supported device exposes at least one **climate** entity. | ||
|
|
||
| {% note %} | ||
|
|
||
| Depending on device support, some entities might not be available as the device does not support them. | ||
|
|
||
| {% endnote %} | ||
|
|
||
| ### Climates | ||
|
|
||
| The climate platform integrates the compatible Cielo devices into Home Assistant, allowing control through its user interface. | ||
|
|
||
| #### Cielo Breez Max & Cielo Breez Edge Pro | ||
|
|
||
| - **HVAC modes** (varies by device): Heat, Cool, Dry, Fan, Auto, Off | ||
| - **Temperature control**: Provide a target temperature where applicable. | ||
| - **Fan modes**: Provide a fan mode if applicable. | ||
| - **Vertical swing position**: Provide a vertical swing position where applicable. | ||
| - **Presets**: Home, Away, Sleep, & Pets (where supported & defined) | ||
|
|
||
| {% note %} | ||
|
|
||
| Some fan modes or swing positions depend on the device’s remote configuration. | ||
|
|
||
| {% endnote %} | ||
|
|
||
| #### Cielo Smart Thermostat & Cielo Smart Thermostat Eco | ||
|
|
||
| - **HVAC modes** (varies by equipment): Cool, Auto, Heat, Off | ||
| - **Temperature control**: Set the temperature setpoint. | ||
| - **Presets**: Home, Away, Sleep & pets (where supported and defined) | ||
c0ffeeca7 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Data updates | ||
|
|
||
| This integration relies on cloud {% term polling %}, with data refreshed approximately every 120 seconds (2 minutes). If the Cielo API or your device becomes unavailable, Home Assistant will automatically retry. | ||
|
|
||
| - Manual changes made in the Cielo Home app or via IR remote are synced automatically on the next poll. | ||
|
|
||
| {% note %} | ||
|
|
||
| If the device is added after the integration, you need to reload the Cielo Home integration. | ||
|
|
||
| {% endnote %} | ||
|
|
||
| ## Actions | ||
|
|
||
| This integration does _not_ provide any custom service actions. All controls are performed using the standard Home Assistant climate services. | ||
|
|
||
| ## API limitations | ||
|
|
||
| - API key cannot be reused. | ||
| - Revoking an API key will immediately disconnect Home Assistant. | ||
| - You can generate a maximum of three API keys within last 30 days. | ||
c0ffeeca7 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Troubleshooting | ||
|
|
||
| This integration relies on an active internet connection and access to the Cielo Home API. Here are a few things to check before raising an issue: | ||
|
|
||
| - Confirm that your Home Assistant has internet access. | ||
| - Verify that your Cielo device is online by checking its status in the Cielo Home app. | ||
| - Ensure that the device’s remote configuration is complete. Devices without remotes will not expose HVAC modes. | ||
| - Check that your API key is still valid and hasn’t been revoked. | ||
| - Reconfigure the integration and provide a freshly generated key. | ||
| - Try refreshing the entities manually in Home Assistant. | ||
c0ffeeca7 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| If devices still fail to load after these steps, please contact [Cielo Tech Support](https://support.cielowigle.com/). | ||
|
|
||
| ## Removing the integration | ||
|
|
||
| This integration follows standard integration removal. No extra steps are required. | ||
|
|
||
| {% include integrations/remove_device_service.md %} | ||
|
|
||
| {% note %} | ||
|
|
||
| **Optional**: Revoke your API key in the [Cielo Home Web Portal](https://home.cielowigle.com). | ||
|
|
||
| {% endnote %} | ||
|
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.