aa90e99678
* Add local api documentation * tiny tweaks --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
3.4 KiB
title, description, ha_category, ha_release, ha_config_flow, ha_iot_class, ha_codeowners, ha_domain, ha_dhcp, ha_zeroconf, ha_platforms, ha_integration_type
| title | description | ha_category | ha_release | ha_config_flow | ha_iot_class | ha_codeowners | ha_domain | ha_dhcp | ha_zeroconf | ha_platforms | ha_integration_type | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Overkiz | Instructions on how to integrate hubs whom use the Overkiz platform with Home Assistant. |
|
2022.2 | true | Local Polling |
|
overkiz | true | true |
|
hub |
The Overkiz (by Somfy) integration platform is used by many different vendors, like Somfy, Hitachi, and Atlantic. This integration will allow users to integrate their devices into Home Assistant using the Overkiz API.
Supported hubs
- Atlantic Cozytouch
- Hitachi Hi Kumo
- Nexity Eugénie
- Somfy Connectivity Kit
- Somfy Connexoon IO (local API available)
- Somfy Connexoon RTS (local API available)
- Somfy TaHoma (local API available)
- Somfy TaHoma Beecon (local API available)
- Somfy TaHoma Switch (local API available)
- Thermor Cozytouch
Supported devices
Over 6000 devices from 60 brands are compatible with the Overkiz platform. This integration will retrieve your devices and map them to the relevant Home Assistant platforms.
{% include integrations/config_flow.md %}
Known limitations
Z-Wave, Hue and Sonos not supported
Even though most Overkiz hubs support adding Z-Wave, Hue, and Sonos devices, this isn't supported in the Overkiz integration. All these platforms have native integrations in Home Assistant which are more stable and feature-rich.
Overkiz API limits
Server busy, please try again later. (Too many executions)
During peak hours, it could happen that the Overkiz platform is unable to execute your command. The integration will try to retry this command, however, this is not guaranteed to succeed.
Internet connectivity required
This integration communicates via the cloud-based Overkiz API in most cases. Depending on your hub and devices, there are options which communicate over your local network.
Local API via Somfy TaHoma Developer Mode
The Somfy TaHoma v2, Somfy Connexoon and Somfy TaHoma Switch support the Somfy TaHoma Developer Mode (local API). During setup, you can choose Local API. This allows you to use the local API in Home Assistant. Climate devices are not supported via the Somfy TaHoma Developer Mode.
Local API via HomeKit Controller
If your hub (e.g. Somfy Connectivity Kit) supports HomeKit natively, your setup code will be added as a sensor in Home Assistant. Find your hub in Home Assistant and retrieve the value from the HomeKit Setup Code sensor. You can now configure the HomeKit Controller integration in Home Assistant and benefit from local support. Only a limited set of devices is supported.
Local API via Velux KLF200 hub
If you are only using Somfy IO-compatible devices, you could purchase a Velux KLF200 hub and use the Velux integration which has a local API.