From cfd2cab5e97e912a0a020ab4d4e608dc8df2ddbf Mon Sep 17 00:00:00 2001 From: Mick Vleeshouwer Date: Thu, 23 Dec 2021 18:06:47 +0000 Subject: [PATCH 1/4] Update Overkiz documentation --- .textlintrc.json | 1 + source/_integrations/overkiz.markdown | 67 +++++++++++++++++++++++++++ source/_integrations/somfy.markdown | 12 ++++- 3 files changed, 79 insertions(+), 1 deletion(-) create mode 100644 source/_integrations/overkiz.markdown diff --git a/.textlintrc.json b/.textlintrc.json index 54378392155a..ac8949f7298e 100644 --- a/.textlintrc.json +++ b/.textlintrc.json @@ -233,6 +233,7 @@ "SwitchBot", "Synology", "Tado", + "TaHoma", "TCP/IP", "TensorFlow", "Tesla", diff --git a/source/_integrations/overkiz.markdown b/source/_integrations/overkiz.markdown new file mode 100644 index 000000000000..0337ea8ab607 --- /dev/null +++ b/source/_integrations/overkiz.markdown @@ -0,0 +1,67 @@ +--- +title: Overkiz (by Somfy) +description: Instructions on how to integrate Overkiz based platforms with Home Assistant. +ha_category: + - Hub + - Sensor +ha_release: 2022.1.0 +ha_config_flow: true +ha_iot_class: Cloud Polling +ha_codeowners: + - '@tetienne' + - '@imicknl' + - '@vlebourl' +ha_domain: overkiz +ha_platforms: + - sensor +--- + +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 +- Rexel Energeasy Connect +- Somfy Connexoon IO +- Somfy Connexoon RTS +- Somfy TaHoma +- Somfy TaHoma Switch [(instructions)](#tahoma-switch) +- Thermor Cozytouch + +If you own a Somfy hub, you could also use the [Somfy integration](/integrations/somfy/) which uses the official API. + +### TaHoma Switch + +Multiple users reported that the TaHoma Switch will work with this integration **after** you create a scene in the TaHoma app and wait for a few hours. + +## 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 supports 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 + +**Execution queue is full on gateway: #xxxx-xxxx-xxxx (soft limit: 10)** + +The Overkiz has a limit of 10 actions that can be executed in parallel. Currently this can only be solved by adding a time-out in between your executions, where you need to take the execution time into account. + +**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, since Overkiz doesn't expose a local API on their hubs. If you are only using Somfy IO compatible devices, you could purchase a Velux KLF200 hub and use to [the Velux integration](/integrations/velux/) which has a local API. + +#### Local API via HomeKit Controller + +If your hub (e.g. Somfy TaHoma) supports HomeKit natively, your setup code will be added as a sensor in Home Assistant. Look up 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. diff --git a/source/_integrations/somfy.markdown b/source/_integrations/somfy.markdown index 52739144e069..22ef5f9bca29 100644 --- a/source/_integrations/somfy.markdown +++ b/source/_integrations/somfy.markdown @@ -17,7 +17,7 @@ ha_platforms: - switch --- -The Somfy integration will allow users to integrate their Somfy devices into Home Assistant using the [official API](https://developer.somfy.com/somfy-open-api/apis). +The Somfy integration will allow users to integrate their Somfy devices into Home Assistant using the [official API](https://developer.somfy.com/somfy-open-api/apis), unlike the [Overkiz (by Somfy)](/integrations/overkiz/) integration. ## Installation @@ -71,3 +71,13 @@ optimistic: **optimistic** mode should only be used when the integration is not able to gain information on whether a cover is open or closed (e.g., [RTS](https://www.somfysystems.com/en-us/discover-somfy/technology/radio-technology-somfy) devices). It will attempt to track the status within Home Assistant. This mode should only be used if Home Assistant is the only way you operate the blind. If you also use the physical remote control or the Somfy app, Home Assistant will become out of sync. {% include integrations/config_flow.md %} + +## Known limitations + +### Limited device support + +Unfortunately, the official Somfy API has limited device support. If your devices are not recognized in Home Assistant, you could use the [Overkiz (by Somfy) integration](/integrations/overkiz/) which has more features and devices supported. + +### Execution queue has a soft limit (10) + +The Somfy API has a limit of 10 actions that can be executed in parallel. Currently this can only be solved by adding a time-out in between your executions, where you need to take the execution time into account. \ No newline at end of file From cd038d5b37bc1c9da119fe32bccd654da9c96fc3 Mon Sep 17 00:00:00 2001 From: Mick Vleeshouwer Date: Thu, 23 Dec 2021 18:10:10 +0000 Subject: [PATCH 2/4] Update wording --- source/_integrations/overkiz.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/overkiz.markdown b/source/_integrations/overkiz.markdown index 0337ea8ab607..9a6658a01744 100644 --- a/source/_integrations/overkiz.markdown +++ b/source/_integrations/overkiz.markdown @@ -1,6 +1,6 @@ --- title: Overkiz (by Somfy) -description: Instructions on how to integrate Overkiz based platforms with Home Assistant. +description: Instructions on how to integrate hubs whom use the Overkiz platform with Home Assistant. ha_category: - Hub - Sensor From 851a6efee2af9f889b8e02b9985ae04d0a8bd96e Mon Sep 17 00:00:00 2001 From: Mick Vleeshouwer Date: Fri, 24 Dec 2021 14:11:56 +0000 Subject: [PATCH 3/4] Update categories and platforms --- source/_integrations/overkiz.markdown | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/source/_integrations/overkiz.markdown b/source/_integrations/overkiz.markdown index 9a6658a01744..6ef8c21ebba2 100644 --- a/source/_integrations/overkiz.markdown +++ b/source/_integrations/overkiz.markdown @@ -4,6 +4,9 @@ description: Instructions on how to integrate hubs whom use the Overkiz platform ha_category: - Hub - Sensor + - Button + - Lock + - Number ha_release: 2022.1.0 ha_config_flow: true ha_iot_class: Cloud Polling @@ -14,6 +17,9 @@ ha_codeowners: ha_domain: overkiz ha_platforms: - sensor + - button + - lock + - number --- 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. From a5d3cd61b56332908a2de726033085b76010cad7 Mon Sep 17 00:00:00 2001 From: Mick Vleeshouwer Date: Fri, 24 Dec 2021 14:12:45 +0000 Subject: [PATCH 4/4] Revert "Update Overkiz documentation" --- source/_integrations/somfy.markdown | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/source/_integrations/somfy.markdown b/source/_integrations/somfy.markdown index 22ef5f9bca29..52739144e069 100644 --- a/source/_integrations/somfy.markdown +++ b/source/_integrations/somfy.markdown @@ -17,7 +17,7 @@ ha_platforms: - switch --- -The Somfy integration will allow users to integrate their Somfy devices into Home Assistant using the [official API](https://developer.somfy.com/somfy-open-api/apis), unlike the [Overkiz (by Somfy)](/integrations/overkiz/) integration. +The Somfy integration will allow users to integrate their Somfy devices into Home Assistant using the [official API](https://developer.somfy.com/somfy-open-api/apis). ## Installation @@ -71,13 +71,3 @@ optimistic: **optimistic** mode should only be used when the integration is not able to gain information on whether a cover is open or closed (e.g., [RTS](https://www.somfysystems.com/en-us/discover-somfy/technology/radio-technology-somfy) devices). It will attempt to track the status within Home Assistant. This mode should only be used if Home Assistant is the only way you operate the blind. If you also use the physical remote control or the Somfy app, Home Assistant will become out of sync. {% include integrations/config_flow.md %} - -## Known limitations - -### Limited device support - -Unfortunately, the official Somfy API has limited device support. If your devices are not recognized in Home Assistant, you could use the [Overkiz (by Somfy) integration](/integrations/overkiz/) which has more features and devices supported. - -### Execution queue has a soft limit (10) - -The Somfy API has a limit of 10 actions that can be executed in parallel. Currently this can only be solved by adding a time-out in between your executions, where you need to take the execution time into account. \ No newline at end of file