Saltar al contenido principal

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

Integración Freebox para Gladys Assistant

Control your Freebox home automation devices, players and cameras from Gladys.

info

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

This integration lets you control your Freebox from Gladys Assistant, directly over your local network, with no cloud involved.

Features​

  • Freebox home automation: opening sensors, motion sensors, battery level, roller shutters (state and position).

  • Freebox Players (compatible models, see below): power, volume, mute, tuning a channel by its number, media control (play/pause, stop, previous, next, rewind and fast forward) and remote control keys (channel up/down, TV, home, guide, info, record, arrow keys, OK and back).

    ℹ️ "Next" / "Previous" do not change channel: they are media commands (track or chapter of what is playing). To zap, use "Channel" (direct number), or "Channel up" / "Channel down".

    ℹ️ "Play" and "Pause" act as a toggle: the Freebox API exposes a single play_pause command for both, so the two buttons do the same thing.

    ℹ️ "Mute" is a toggle too: each press mutes or restores the sound based on the player's real state, read right before the command is sent.

    ⚠️ Some keys are not guaranteed. Only power, volume, tuning by channel number and media control rely on the API documented by Free. The navigation keys (arrows, OK, back, home, guide, info, channel up/down) use an undocumented endpoint that may stop working after a Freebox update.

    ℹ️ Media commands depend on what the player is currently playing: on the home screen, with no active media, they may have no effect. Use the navigation keys to start a channel or a piece of content first.

  • Freebox cameras: image shown on the dashboard (refreshed automatically) and on demand, captured from the video stream with ffmpeg.

  • Actions: pair, test the connection, reboot the Freebox and unpair, right from the configuration screen.

Requirements​

  • A Freebox (Delta, Ultra, Pop, Revolution...) with the home automation server enabled.
  • Gladys Assistant and this integration must run on the same local network as the Freebox (access to mafreebox.freebox.fr).

Pairing​

  1. Open the Freebox integration configuration screen in Gladys.
  2. Click the "Pair with the Freebox" button.
  3. Walk to your Freebox Server: its LCD screen shows an authorization request. Press the right arrow to confirm.
  4. The pairing is remembered: you only need to do it once.

⏱️ You have about 55 seconds to press the right arrow on the LCD screen. After that delay, pairing fails with the message "authorization was not confirmed on the LCD screen": just run the "Pair with the Freebox" action again. Make sure you are standing next to your Freebox before clicking the button.

Permissions to enable (important)​

After pairing, open your Freebox settings:

Freebox OS > Settings > Access management > Applications > Gladys Assistant

and enable the following permissions:

  • Home automation and alarm management (sensors, shutters)
  • Camera access
  • Freebox Player control

⚠️ Without these boxes ticked, the matching devices will not appear during discovery. This is the most common cause of a missing device.

Once the permissions are granted, run a device scan: Gladys will list every device detected on your Freebox. Pick the ones you want to create.

Freebox Player POP / Android TV limitation​

Freebox Player POP units (and other Android TV-based players) are not controllable through this integration: Free does not expose the local control API on those models (the player is reported with api_available: false and is therefore skipped). To control a Player POP, use an Android TV integration (ADB protocol), which is out of scope here.

The Players of the Delta and Revolution Freebox (which expose the local player API) remain fully controllable.

Rebooting the Freebox​

The "Reboot the Freebox" action on the configuration screen restarts your Freebox Server. There is no shutdown action: the Freebox API only exposes a reboot (a powered-off box could not be turned back on remotely).

Parámetros de configuración​

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

ParámetroTipoObligatorioDescripción
Connect your FreeboxsectionNoThis integration talks to your Freebox Server over your local network. To pair it, click "Pair with the Freebox" below, then physically confirm the authorization on your Freebox Server LCD screen (press the right arrow on the box). You have about 55 seconds to confirm, so stand next to your Freebox before clicking; if the delay expires, just run the action again. The pairing is done only once.
Grant the permissionssectionNoAfter pairing, open your Freebox settings (Freebox OS > Settings > Access management > Applications > Gladys Assistant) and enable the Home automation, Camera and Player permissions. Without them, the matching devices will not appear during discovery.

Cómo instalar Freebox en Gladys​

  1. En Gladys, abre Integraciones: Freebox 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/william-de71/gladys-freebox:1.1.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/William-De71/gladys-freebox.

Freebox 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​

Freebox 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 William-De71, 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 🙂