Saltar al contenido principal

Integración domótica Overkiz, gratuita y de código abierto

Integración Overkiz para Gladys Assistant

Control your Overkiz devices (Somfy TaHoma, Connexoon, Cozytouch...), up to 3 accounts.

info

La documentación de esta integración la escribe su autor y, por ahora, solo está disponible en inglés.

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.

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​

  • Gladys 4.86 or later.
  • 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.

Several Overkiz accounts​

Overkiz powers hubs from several brands, and each brand keeps its own account on its own server. If you own more than one — a Somfy hub for your covers and an Atlantic Cozytouch account for a Thermor water heater, say — fill in the Overkiz account 2 section (and 3 if needed) with its own server, email and password. The three accounts run side by side and their devices show up in the same Discovery list.

To stop using an account, clear its email and save. Avoid picking the blank entry in the Server list: it is not a valid value and the save is rejected.

The event polling period is a single setting shared by every account.

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.
  • Only one of my accounts connects: the connection status turns red as soon as one configured account fails, and names the one at fault — the others keep working normally. Test the connection reports each account separately.
  • A second account's devices disappeared from Discovery: an account that is momentarily disconnected stops offering its devices there; the ones you already created in Gladys are untouched, and the rest come back on the next connection.
  • 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.

Parámetros de configuración​

Estos son los parámetros que Overkiz te pide en su pantalla de configuración en Gladys.

ParámetroTipoObligatorioDescripción
Overkiz account 1sectionNoConnect with the credentials of your Overkiz-based hub. Pick the server matching your hub, then enter the email and password of your provider account. Up to 3 accounts can run side by side — a Somfy hub for your covers and a Cozytouch account for your water heater, for instance. Covers, lights, switches, sensors and water heaters are supported; heating devices are not mapped yet.
Server (hub type)selectSí
Email / usernamestringSí
PasswordsecretSí
Overkiz account 2 (optional)sectionNoLeave the email and the password empty if you have a single Overkiz account. Fill them in to add a second hub or a second provider — for example an Atlantic Cozytouch account for a water heater, next to a Somfy hub for your covers. To disable this account later, clear the email.
Server (hub type)selectNo
Email / usernamestringNo
PasswordsecretNo
Overkiz account 3 (optional)sectionNoA third account, same principle. Leave it empty if you do not need it.
Server (hub type)selectNo
Email / usernamestringNo
PasswordsecretNo
AdvancedsectionNo
Event polling period (s)numberNoHow often events are fetched from the Overkiz cloud, in seconds. Applies to every configured account.

Cómo instalar Overkiz en Gladys​

  1. En Gladys, abre Integraciones: Overkiz aparece en el catálogo junto a las integraciones nativas, con una insignia de comunidad.
  2. Haz clic en Instalar. Gladys descarga la imagen Docker (ghcr.io/cicoub13/gladys-overkiz:1.6.0), la ejecuta en un entorno aislado del núcleo y genera la interfaz de la integración (dispositivos, descubrimiento y configuración).
  3. Abre la pantalla de Configuración de la integración, rellena los parámetros y guarda.
  4. También puedes instalarla directamente desde la URL de su repositorio: https://github.com/cicoub13/gladys-overkiz.

Overkiz requiere Gladys >=4.86.0. El catálogo de Gladys se actualiza cada hora, así que una nueva versión está disponible como máximo una hora después de publicarse.

¿Todavía no usas Gladys? Es gratuito y de código abierto: sigue la guía de instalación para empezar.

Sobre las integraciones externas​

Overkiz es una integración externa: una integración comunitaria empaquetada como contenedor Docker y publicada en GitHub. Gladys la instala con un clic y la ejecuta en un entorno aislado del núcleo. La publica y mantiene cicoub13, no el equipo principal de Gladys.

Suscríbete a la newsletter de Gladys Assistant

Unos pocos correos al mes sobre nuevas versiones y novedades del proyecto. Enviados por Pierre-Gilles Leymarie, fundador del proyecto. Puedes darte de baja cuando quieras 🙂