Skip to main content

Overkiz integration for Gladys Assistant

Overkiz integration for Gladys Assistant

Control your Overkiz devices (Somfy TaHoma, Connexoon, Cozytouch...).

View on GitHubAll external integrations

Control your Overkiz-based devices from Gladys Assistant: Somfy TaHoma, TaHoma Switch, Connexoon, Atlantic Cozytouch, Rexel Energeasy Connect, Hitachi Hi Kumo and Bouygues Flexom hubs are supported through the Overkiz cloud API.

What it does​

  • Covers: roller shutters, awnings, screens, venetian blinds, curtains, pergolas, garage doors, gates and windows — open, close, stop and set the position.
  • Lights: on/off and brightness.
  • Switches and plugs: on/off.
  • Sensors: temperature, humidity, luminance, contact (opening), occupancy (motion), smoke, water leak, CO2 and electric power/energy.
  • Battery: every device that reports one, covers and lights included. Devices with a gauge get a battery level in percent; those that only report a status — most IO and RTS sensors — get a "low battery" indicator instead.
  • Water heaters: operating mode (eco, manual, auto, away), boost, hot water setpoint, hot water left (in litres drawable at 40 °C), whether the appliance is heating, and the water temperature. Requires Gladys 4.85 or later, which is where the water heater category was added.

Device states are refreshed in near real time through the Overkiz event API, so a shutter moved from a physical remote is reflected in Gladys within seconds.

Not supported yet​

  • Heating: radiators, underfloor heating and heat pumps (HeatingSystem) are not mapped to Gladys devices yet. Atlantic Cozytouch, Thermor, Sauter and Hitachi Hi Kumo hubs do connect and their water heaters are supported, but their heating devices will not show up in discovery yet.
  • Water heaters other than Atlantic / Thermor / Sauter are mapped for what they report, but their vendor-specific commands (Hitachi Hi Kumo in particular) are not wired yet: expect the sensors to work and some controls to be missing.
  • Locks, alarms and ventilation (DoorLock, Alarm, AirFlow).
  • On metering plugs and modules, Overkiz often publishes the power reading on a separate sub-device: it then appears as its own device in discovery, carrying the same name as its parent.

Prerequisites​

  • An Overkiz-based hub (Somfy TaHoma, TaHoma Switch, Connexoon, Cozytouch...) already set up with the vendor's app.
  • The email and password of your vendor account (the same credentials you use in the TaHoma / Cozytouch app).

Configuration​

  1. Install the integration from the Gladys store.
  2. Open the Configuration tab.
  3. Pick the Server matching your hub (Somfy Europe for TaHoma / TaHoma Switch / Connexoon in Europe).
  4. Enter your account email and password, then save.
  5. Use the Test the connection button to verify the credentials.
  6. Open the Discovery tab, run a scan, and create the devices you want in Gladys.

Troubleshooting​

  • Connection failed: double-check the server selection and your credentials by logging into the vendor's app. Somfy may temporarily lock the account after too many failed attempts.
  • A device is missing: only device types listed above are supported. Run a new scan from the Discovery tab after adding a device to your hub. If your device should be supported but is not, use the List the raw devices action: it writes what Overkiz says about each of your devices to the integration logs, which is what a mapping needs. The dump carries your hub serial number — anonymize it before sharing.
  • States seem stale: the event polling period can be lowered in the Configuration tab (10 s minimum). Keep in mind the Overkiz cloud rate-limits aggressive polling.
  • My water heater offers fewer modes than the appliance does: only the modes your appliance actually exposes are offered. A boost is a control of its own rather than a mode, because that is how these appliances report it.

Configuration settings​

These are the settings Overkiz asks for in its configuration screen in Gladys.

SettingTypeRequiredDescription
Overkiz accountsectionNoConnect with the credentials of your Overkiz-based hub. Pick the server matching your hub, then enter the email and password of your provider account. Covers, lights, switches, sensors and water heaters are supported; heating devices are not mapped yet.
Server (hub type)selectYes
Email / usernamestringYes
PasswordsecretYes
Event polling period (s)numberNoHow often events are fetched from the Overkiz cloud, in seconds.

How to install Overkiz in Gladys​

  1. In Gladys, open Integrations: Overkiz appears in the catalog, next to the native integrations, with a community badge.
  2. Click Install. Gladys pulls the Docker image (ghcr.io/cicoub13/gladys-overkiz:1.3.0), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration).
  3. Open the Configuration screen of the integration, fill in the settings, and save.
  4. You can also install it directly from its repository URL: https://github.com/cicoub13/gladys-overkiz.

Overkiz requires Gladys >=4.85.0. The catalog inside Gladys refreshes every hour, so a new version becomes available at most one hour after its release.

Not running Gladys yet? It is free and open source: follow the installation guide to get started.

About external integrations​

Overkiz is an external integration: a community integration packaged as a Docker container and published on GitHub, that Gladys installs in one click and runs in a sandbox isolated from its core. It is published and maintained by cicoub13, not by the Gladys core team.

Subscribe to the Gladys Assistant newsletter

A few emails per month about new releases and project news. Sent by Pierre-Gilles Leymarie, founder of the project. Unsubscribe anytime 🙂
Last updated on