https://github.com/imicknl/ha-tahoma
Custom component for Home Assistant to interact with smart devices via Somfy TaHoma or other OverKiz based API's.
https://github.com/imicknl/ha-tahoma
cozytouch hacktoberfest hi-kumo home-assistant nexity overkiz rexel somfy tahoma
Last synced: over 1 year ago
JSON representation
Custom component for Home Assistant to interact with smart devices via Somfy TaHoma or other OverKiz based API's.
- Host: GitHub
- URL: https://github.com/imicknl/ha-tahoma
- Owner: iMicknl
- License: mit
- Created: 2020-06-04T09:28:14.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-22T00:49:29.000Z (over 1 year ago)
- Last Synced: 2025-03-28T14:07:30.583Z (over 1 year ago)
- Topics: cozytouch, hacktoberfest, hi-kumo, home-assistant, nexity, overkiz, rexel, somfy, tahoma
- Language: Python
- Homepage:
- Size: 1.51 MB
- Stars: 157
- Watchers: 16
- Forks: 31
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://GitHub.com/iMicknl/ha-tahoma/releases/)
[](https://analytics.home-assistant.io/custom_integrations.json)
[](https://www.home-assistant.io/integrations/overkiz/)
[](https://open.vscode.dev/iMicknl/ha-tahoma/)
[](https://discord.gg/RRXuSVDAzG)
# (deprecated) Overkiz (by Somfy) - Home Assistant
Since Home Assistant 2022.2 the Overkiz (by Somfy) integration is available in core and thus this custom component is **deprecated**. New functionality will only be added to the core integration. If you miss functionality in the core integration, please create an issue [here](https://github.com/home-assistant/core/issues).
>Custom component for Home Assistant to interact with smart devices via the Overkiz platform.
## 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
### 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. See [#507](https://github.com/iMicknl/ha-tahoma/issues/507) for context.
## Supported devices
Most of the devices supported by your hub should be supported. If it is not the case or working correctly, have a look [here](#device-not-supported--working-correctly).
## Installation
You can install this integration via [HACS](#hacs) or [manually](#manual).
### HACS
This integration is included in HACS. Search for the `Overkiz (by Somfy)` integration and choose install. Reboot Home Assistant and configure the 'Overkiz (by Somfy)' integration via the integrations page or press the blue button below.
[](https://my.home-assistant.io/redirect/config_flow_start/?domain=tahoma)
### Manual
Copy the `custom_components/tahoma` to your `custom_components` folder. Reboot Home Assistant and configure the 'Overkiz (by Somfy)' integration via the integrations page or press the blue button below.
[](https://my.home-assistant.io/redirect/config_flow_start/?domain=tahoma)
## Advanced
### Available services
After installation this integration adds new services to Home Assistant which can be used in automations. The new services are:
+ Overkiz (by Somfy): Set cover position with low speed (tahoma.set_cover_position_low_speed, only added if supported by the device)
+ Overkiz (by Somfy): My position (cover) (tahoma.set_cover_my_position)
+ Overkiz (by Somfy): Execute command (tahoma.execute_command)
+ Overkiz (by Somfy): Get execution history (tahoma.get_execution_history)
## Events
This component listen for events returned by Overkiz. In case of command failure, the event will forwarded to Home Assistant.
You can subscribe to the `overkiz.event` event type in Developer Tools/Events in order to examine the event data JSON for the correct parameters to use in your automations. For example, `overkiz.event` returns event data JSON similar to the following when your cover is blocked.
```JSON
{
"event_type": "overkiz.event",
"data": {
"event_name": "ExecutionStateChangedEvent",
"failure_type_code": 106,
"failure_type": "CMDCANCELLED"
},
"origin": "LOCAL",
"time_fired": "2021-09-28T20:03:57.102478+00:00",
"context": {
"id": "92a84240d914b43ceaf1aee3249568f6",
"parent_id": null,
"user_id": null
}
}
```
You can find the list of available failure_type [here](https://github.com/iMicknl/python-overkiz-api/blob/main/pyoverkiz/enums/general.py#L34).
### Enable debug logging
The [logger](https://www.home-assistant.io/integrations/logger/) integration lets you define the level of logging activities in Home Assistant. Turning on debug mode will show more information about unsupported devices in your logbook.
```yaml
logger:
default: critical
logs:
custom_components.tahoma: debug
```
### Device not supported
If your device is not visible in the device list of Home Assistant (/config/devices/dashboard), you need to turn on [debug logging](#enable-debug-logging) first. Copy your Home Assistant log (Configuration > Logs) and create a [new issue](https://github.com/iMicknl/ha-tahoma/issues/new/choose).
### Device not working correctly
If your device is listed in the device list, you need to turn on [debug logging](#enable-debug-logging) first. Copy your Home Assistant log (Configuration > Logs) and create a [new issue](https://github.com/iMicknl/ha-tahoma/issues/new/choose).
In order to gather more information, you can use the `tahoma.get_execution_history` service which will print your execution history to the Home Assistant log. Run the commands via the official vendor app (e.g. TaHoma) and include your log in the issue.
### Retrieve HomeKit code
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](https://www.home-assistant.io/integrations/homekit_controller/) integration in Home Assistant.