2024.12.5
Home ▸ Integrations ▸

Overkiz

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 & devices

  • Atlantic Cozytouch
  • Bouygues Flexom
  • Hitachi Hi Kumo
  • Nexity Eugénie
  • Sauter Cozytouch
  • Simu LiveIn2
  • Somfy Connectivity Kit
  • Somfy Connexoon IO (local API available)
  • Somfy Connexoon RTS (local API available)
  • Somfy TaHoma v2 (local API available)
  • Somfy TaHoma Beecon (local API available)
  • Somfy TaHoma Switch (local API available)
  • Thermor Cozytouch
  • 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.

Configuration

To add the Overkiz hub to your Home Assistant instance, use this My button:

Overkiz can be auto-discovered by Home Assistant. If an instance was found, it will be shown as Discovered. You can then set it up right away.

Manual configuration steps

If it wasn’t discovered automatically, don’t worry! You can set up a manual integration entry:

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)

Username

Username for your Overkiz cloud account (account you use in your IoT app).

Password

Password for your Overkiz cloud account (account you use in your IoT app).

Login to Overkiz (Local API)

To use the local API, you will need to activate the Somfy TaHoma Developer Mode 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.

Host

The hostname or IP address of your Overkiz hub. The hostname is your Gateway PIN + .local:8443 (e.g. 1234-4567-8912.local).

Username

Username for your Overkiz cloud account (account you use in your IoT app).

Password

Password for your Overkiz cloud account (account you use in your IoT app).

Verify SSL

Verify the SSL certificate of your hub. This option is available only when connecting via the hostname.

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 provide more frequent state updates and are more feature-rich.

Stateless RTS covers

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 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.

cover:
  - platform: template
    covers:
      stateful_rts_test_shutter: # unique ID
        friendly_name: "Stateful RTS Test Shutter" # your name
        optimistic: true # default when no state is available
        open_cover:
          - action: cover.open_cover
            target:
              entity_id: cover.rts_test_shutter # change to your device id
        close_cover:
          - action: cover.close_cover
            target:
              entity_id: cover.rts_test_shutter # change to your device id
        stop_cover:
          - action: cover.stop_cover
            target:
              entity_id: cover.rts_test_shutter # change to your device id

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.

Execution queue is full on gateway

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.

Device support via the local API

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.

Device support via HomeKit

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 integration for local control, follow these steps:

  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 integration in Home Assistant.

Please note that only a limited set of devices is supported via HomeKit.

Removing the integration

This integration follows standard integration removal. No extra steps are required.

To remove an integration instance from Home Assistant

  1. Go to Settings > Devices & services and select the integration card.
  2. From the list of devices, select the integration instance you want to remove.
  3. Next to the entry, select the three-dot menu. Then, select Delete.