mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-24 17:57:14 +00:00
Improve Overkiz documentation (#36505)
This commit is contained in:
Mick Vleeshouwer
GitHub
parent
a5bb5daa70
commit
6576d07242
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Overkiz
|
||||
description: Instructions on how to integrate hubs whom use the Overkiz platform with Home Assistant.
|
||||
description: Instructions on how to integrate hubs that use the Overkiz IoT platform with Home Assistant.
|
||||
ha_category:
|
||||
- Alarm
|
||||
- Binary sensor
|
||||
@ -49,39 +49,70 @@ ha_platforms:
|
||||
ha_integration_type: 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.
|
||||
The Overkiz (by Somfy) IoT 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
|
||||
## Supported hubs & devices
|
||||
|
||||
- Atlantic Cozytouch
|
||||
- Bouygues Flexom
|
||||
- Hitachi Hi Kumo
|
||||
- Nexity Eugénie
|
||||
- Rexel Energeasy
|
||||
- Sauter Cozytouch
|
||||
- Simu LiveIn2
|
||||
- Somfy Connectivity Kit
|
||||
- Somfy Connexoon IO _(local API available)_
|
||||
- Somfy Connexoon RTS _(local API available)_
|
||||
- Somfy TaHoma _(local API available)_
|
||||
- Somfy TaHoma v2 _(local API available)_
|
||||
- Somfy TaHoma Beecon _(local API available)_
|
||||
- Somfy TaHoma Switch _(local API available)_
|
||||
- Thermor Cozytouch
|
||||
|
||||
## Supported devices
|
||||
- Ubiwizz
|
||||
|
||||
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 %}
|
||||
|
||||
The Overkiz integration supports both the Overkiz cloud API and the local API (only supported by some Somfy hubs). For compatible Somfy hubs, you can connect locally, allowing device control without an internet connection. Start by selecting the server or app that you use to control your devices.
|
||||
|
||||
### Login to Overkiz (Cloud API)
|
||||
|
||||
{% configuration_basic %}
|
||||
"Username":
|
||||
description: "Username for your Overkiz cloud account (account you use in your IoT app)."
|
||||
Password:
|
||||
description: "Password for your Overkiz cloud account (account you use in your IoT app)."
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
### Login to Overkiz (Local API)
|
||||
|
||||
To use the local API, you will need to activate the [Somfy TaHoma Developer Mode](https://github.com/Somfy-Developer/Somfy-TaHoma-Developer-Mode?tab=readme-ov-file#getting-started) via the Somfy website. Activating this mode will enable a local API on your TaHoma box. Your cloud credentials are required to negotiate a token with the cloud API to authenticate your calls to the local API. This is a one-time setup and the token will be stored in your Home Assistant configuration.
|
||||
|
||||
Scenarios and climate entities are **not** supported via the Somfy TaHoma Developer Mode.
|
||||
|
||||
{% configuration_basic %}
|
||||
"Host":
|
||||
description: "The hostname or IP address of your Overkiz hub. The hostname is your Gateway PIN + .local:8443 (e.g. 1234-4567-8912.local)."
|
||||
"Username":
|
||||
description: "Username for your Overkiz cloud account (account you use in your IoT app)."
|
||||
Password:
|
||||
description: "Password for your Overkiz cloud account (account you use in your IoT app)."
|
||||
Verify SSL:
|
||||
description: "Verify the SSL certificate of your hub. This option is available only when connecting via the hostname."
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
## Data updates
|
||||
|
||||
This integration retrieves data from Overkiz every 30 seconds to ensure timely updates. If you only have stateless devices (RTS protocol), the integration will poll for new data every hour to reduce unnecessary load on the Overkiz API.
|
||||
|
||||
## Known limitations
|
||||
|
||||
### Zigbee, Z-Wave, Hue, and Sonos devices not supported
|
||||
|
||||
Even though most Overkiz hubs support adding Zigbee, 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.
|
||||
Even though most Overkiz hubs support adding Zigbee, Z-Wave, Hue, and Sonos devices, this isn't supported in the Overkiz integration. All these platforms have native integrations in Home Assistant, which provide more frequent state updates and are more feature-rich.
|
||||
|
||||
### Stateless RTS covers
|
||||
|
||||
Covers that use the RTS protocol are stateless and do not report their state back to the hub. This means that Home Assistant will not know the state of the device after it has been controlled.
|
||||
|
||||
If you only control your RTS cover from Home Assistant, you can use the [template cover](/integrations/cover.template/) to create a stateful cover entity. This will allow you to keep track of the current state (open or closed) and use the cover in automations and scenes.
|
||||
RTS covers do not report their state back to the hub, so Home Assistant cannot track their state after they are controlled. If you only control your RTS cover from Home Assistant, you can use the [template cover](/integrations/cover.template/) to create a stateful cover entity. This will help you track the current state (open or closed) and use the cover in automations and scenes.
|
||||
|
||||
```yaml
|
||||
cover:
|
||||
@ -114,18 +145,22 @@ During peak hours, it could happen that the Overkiz platform is unable to execut
|
||||
|
||||
The Overkiz API only supports 10 requests in its execution queue. If you try to command more devices at the same time, for example with a group, this will fail with `EXEC_QUEUE_FULL`. To work around this, you can create a scenario in the corresponding application and call that scenario instead after syncing it in the integration.
|
||||
|
||||
### Internet connectivity required
|
||||
### Device support via the local API
|
||||
|
||||
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.
|
||||
Various sensors, scenarios, and climate entities are **not** supported via the Somfy TaHoma Developer Mode due to limitations of the local API. If your device functions with the Cloud API but not with the Local API, this is an inherent limitation of the Local API and cannot be resolved.
|
||||
|
||||
#### Local API via Somfy TaHoma Developer Mode
|
||||
### Device support via HomeKit
|
||||
|
||||
The Somfy TaHoma v2, Somfy Connexoon and Somfy TaHoma Switch support the [Somfy TaHoma Developer Mode (local API)](https://github.com/Somfy-Developer/Somfy-TaHoma-Developer-Mode). 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.
|
||||
If your hub (e.g. Somfy Connectivity Kit) supports HomeKit, a sensor named **HomeKit Setup Code** will be added to Home Assistant. To configure the [HomeKit Controller](/integrations/homekit_controller/) integration for local control, follow these steps:
|
||||
|
||||
#### Local API via HomeKit Controller
|
||||
1. Locate the **HomeKit Setup Code** sensor in Home Assistant.
|
||||
2. Retrieve the setup code value from the sensor.
|
||||
3. Use this setup code to configure the [HomeKit Controller](/integrations/homekit_controller/) integration in Home Assistant.
|
||||
|
||||
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](/integrations/homekit_controller/) integration in Home Assistant and benefit from local support. Only a [limited set of devices is supported](https://service.somfy.com/downloads/nl_v5/tahoma-homekitcompatibilitylist_eng.pdf).
|
||||
Please note that only a [limited set of devices is supported via HomeKit](https://service.somfy.com/downloads/nl_v5/tahoma-homekitcompatibilitylist_eng.pdf).
|
||||
|
||||
#### Local API via Velux KLF200 hub
|
||||
## Removing the integration
|
||||
|
||||
If you are only using Somfy IO-compatible devices, you could purchase a Velux KLF200 hub and use [the Velux integration](/integrations/velux/) which has a local API.
|
||||
This integration follows standard integration removal. No extra steps are required.
|
||||
|
||||
{% include integrations/remove_device_service.md %}
|
||||
Loading…
x
Reference in New Issue
Block a user