Integración domótica Radio France, gratuita y de código abierto
Programas, canciones y parrilla de las emisoras de Radio France con la Open API (no oficial).
Publicado por William-De71
- Dispositivos
- Versión 0.1.0
- Requiere Gladys >=5.1.0
- ★ 0
Presentación
Esta integración muestra en Gladys lo que suena en antena en las emisoras de Radio France: France Inter, franceinfo, France Culture, France Musique, FIP, Mouv’, las emisoras locales ICI (antes France Bleu) y las radios web. Para cada emisora que siga, tendrá el programa, la sección en curso (el informativo, una columna) y la canción, y sus escenas pueden reaccionar cuando empieza un nuevo programa, una nueva sección o una nueva canción.
Los datos vienen de la Open API oficial de Radio France, con su propia clave de API. La integración no es oficial ni está vinculada a Radio France. No reproduce ningún flujo: la Open API no puede usarse para escuchar en directo.
Condiciones de uso
Usar la Open API supone aceptar sus condiciones: una clave personal, un uso privado y no comercial, datos mostrados tal cual y nunca almacenados, y el crédito «données fournies par l’Open API Radio France» (datos proporcionados por la Open API de Radio France), que muestra cada widget de la integración. La integración solo guarda los datos en memoria, una hora como mucho; /data solo contiene su contador de solicitudes y sus interruptores de seguimiento. No se usa ningún logotipo de Radio France.
Requisitos previos
- Gladys Assistant 5.1.0 o posterior.
- Una clave de la Open API gratuita y personal: cada usuario de Gladys solicita la suya.
- Acceso a Internet desde Gladys (las solicitudes van a
openapi.radiofrance.fr).
Obtener su clave de la Open API
- Cree una cuenta en developers.radiofrance.fr.
- En Mi cuenta, haga clic en Solicitar una clave de API.
- Indique el nombre de su proyecto (por ejemplo «Gladys en casa») y su finalidad (por ejemplo «mostrar lo que suena en antena en mi panel domótico»).
- Radio France revisa cada solicitud a mano y envía la clave por correo, a menudo el mismo día.
- Pegue la clave en la configuración de la integración, guarde y pulse Probar la clave de API.
Configuración
| Campo | Por defecto | Función |
|---|---|---|
| Clave de la Open API | — | Su clave. Se envía a Radio France en una cabecera de cada solicitud; nunca se vuelve a mostrar ni se escribe en los registros. |
| Idioma de los textos | Francés | Nombres de las funciones, mensajes de estado y frases de las acciones de escena. Los títulos de Radio France nunca se traducen. |
| Presupuesto diario (solicitudes) | 900 | Solicitudes que la integración se permite al día, de las 1.000 de la clave (100 a 1.000). Redúzcalo si la clave se usa en otro sitio. |
| Intervalo mínimo (segundos) | 90 | Nunca dos lecturas más seguidas que esto (60 a 600). El presupuesto puede espaciarlas más. |
Probar la clave de API lee la lista de emisoras (una solicitud), actualiza la pestaña Descubrir y muestra las solicitudes usadas hoy.
Uso
Dispositivos
Abra la pestaña Descubrir de la integración y añada las emisoras que desee. La lista viene de la API, con los nombres que Radio France les da.
| Función | Notas |
|---|---|
| Programa | El programa en antena (su nombre). Un guion si no hay ninguno: FIP y sus radios web emiten sobre todo música sin programas. |
| Sección | La sección dentro del programa: el informativo, una columna, una entrevista. Un guion entre dos secciones. |
| Canción | «Artista – Título» de la canción en antena, en las emisoras musicales. Un guion en otro caso. |
| Seguimiento | Activado por defecto. Solo se consultan las emisoras seguidas. Desactívelo para las emisoras que no escucha, o deje que una escena lo active cuando escuche. |
Cuota y lecturas
Una clave permite 1.000 solicitudes al día; por encima, Radio France la bloquea hasta el día siguiente. La integración cuenta cada solicitud que envía y consulta hasta 10 emisoras en una sola solicitud. Espera al final del programa, la sección o la canción en curso antes de volver a preguntar (nunca antes del intervalo mínimo, al menos cada 15 minutos) y reparte las solicitudes en el resto del día cuando el presupuesto escasea. Si no se sigue nada, no envía ninguna solicitud. Se supone que el contador vuelve a cero a medianoche, hora de París (Radio France no lo indica).
Las acciones de escena, el botón Actualizar y el widget «Próximos programas» usan el mismo presupuesto. Cuando se agota, lo indican y esperan a medianoche.
Widgets del panel
- En antena: el programa, el episodio, la sección, la canción, el final del programa y la hora de la última lectura, con un botón Actualizar (una solicitud, como mucho una vez por minuto).
- Próximos programas: los próximos programas de una emisora, según su parrilla (leída como mucho cada 15 minutos). FIP y sus radios web no publican su programación con antelación.
- Uso de la Open API: las solicitudes de hoy frente al presupuesto, el estado (correcto, pausa por cuota, clave rechazada…), la próxima lectura, las emisoras seguidas.
Elija la emisora en los ajustes de un widget (por defecto, la primera emisora seguida). La imagen de arriba es una ilustración generada con programas inventados, no una captura de pantalla.
Escenas
Disparadores, para las emisoras seguidas (detectados por las lecturas periódicas, así que hasta unos minutos después del inicio; nunca en la primera lectura tras un reinicio):
- Radio France: nueva canción — título, artista, álbum, año, sello discográfico.
- Radio France: empieza un programa — programa, título del episodio, resumen, página web, hora de fin.
- Radio France: empieza una sección — las mismas variables, para el informativo, una columna, una entrevista.
Acciones:
- Radio France: qué suena en antena — programa, sección, canción, artista, álbum y final del programa, para una notificación o un mensaje de voz.
- Radio France: próximos programas — los próximos programas en las próximas 12 horas, con una frase para leer («Próximamente en France Inter: …»).
Ejemplos: cuando empiece el informativo de las 7 en France Inter, subir el volumen de la radio de la cocina; cuando suene una nueva canción en FIP, mostrarla en la tele; cada tarde a las 19:00, que Gladys lea los programas de la noche de France Culture.
Solución de problemas
- «Radio France rechaza la clave de API»: compruebe la clave (sin espacios antes ni después). Una clave nueva puede tardar unos minutos en funcionar. La integración vuelve a intentarlo a los 5 minutos y luego cada vez con menos frecuencia (hasta una hora).
- «Cuota diaria alcanzada» o «Presupuesto diario agotado»: todo espera a medianoche (hora de París). Siga menos emisoras, aumente el intervalo mínimo o compruebe que la clave no la usa otro programa.
- «La Open API no responde»: el servicio o su acceso a Internet falla; la integración vuelve a intentarlo un poco más tarde. Un «error de servidor» también puede significar que la cuota de la clave se consume en otro sitio.
- Una emisora nunca se actualiza: compruebe que su interruptor Seguimiento está activado y mire el widget «Uso de la Open API». Una emisora que Radio France ha retirado de su lista ya no se consulta.
- FIP no tiene programa: es normal, FIP y sus radios web emiten sobre todo música sin programas.
- Para un problema, indique las versiones de Gladys y de la integración, el mensaje de Probar la clave de API (nunca muestra la clave) y los registros con
DEBUG=gladys-integration-sdk.
Parámetros de configuración
Estos son los parámetros que Radio France te pide en su pantalla de configuración en Gladys.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Antes de empezar | section | No | Lo que suena en las emisoras de Radio France (France Inter, franceinfo, France Culture, France Musique, FIP, Mouv’, las emisoras locales ICI y las radios web): el programa, la sección y la canción, desde la Open API oficial de Radio France. Esta integración no es oficial ni está vinculada a Radio France. No reproduce ningún flujo: la Open API no puede usarse para escuchar en directo. Cada usuario necesita su propia clave de API, gratuita, para un uso privado y no comercial. |
| Obtener su clave de API | section | No | 1. Cree una cuenta en developers.radiofrance.fr. 2. En «Mi cuenta», haga clic en «Solicitar una clave de API». 3. Indique el nombre de su proyecto (por ejemplo «Gladys en casa») y su finalidad (mostrar lo que suena en antena en mi panel domótico). 4. Radio France valida la solicitud a mano y envía la clave por correo, a menudo el mismo día. 5. Péguela abajo, guarde y use «Probar la clave de API». La clave es personal: no la comparta. |
| Clave de la Open API | secret | Sí | Se envía a Radio France en una cabecera de cada solicitud; nunca se vuelve a mostrar ni se escribe en los registros. |
| Idioma de los textos | select | No | Idioma de los nombres de las funciones, de los mensajes de estado y de los textos que devuelven las acciones de escena (Gladys no indica a la integración el idioma del usuario). Los títulos de Radio France no se traducen. |
| Cuota diaria | section | No | Radio France permite 1.000 solicitudes al día por clave y bloquea la clave por encima. La integración cuenta sus solicitudes y las reparte a lo largo del día: una solicitud lee hasta 10 emisoras y la siguiente sale cuando termina un programa o una canción. Solo se consultan las emisoras con el interruptor «Seguimiento» activado. Las acciones de escena, el botón Actualizar y el widget de programación usan el mismo presupuesto. Se supone que el contador vuelve a cero a medianoche, hora de París. |
| Presupuesto diario (solicitudes) | number | No | Solicitudes que la integración se permite al día, de las 1.000 de la clave. Redúzcalo si usa la misma clave en otro sitio. |
| Intervalo mínimo (segundos) | number | No | Nunca dos lecturas más seguidas que esto. El presupuesto puede espaciarlas más. |
| Condiciones de uso | section | No | Al usar su clave, acepta las condiciones de uso de la Open API: uso privado y no comercial, datos mostrados tal cual, nunca almacenados (la integración solo los guarda en memoria unos minutos) y con el crédito «données fournies par l’Open API Radio France», que muestra cada widget. No se reproduce ningún flujo ni se usa ningún logotipo de Radio France. |
Cómo instalar Radio France en Gladys
- En Gladys, abre Integraciones: Radio France aparece en el catálogo junto a las integraciones nativas, con una insignia de comunidad.
- Haz clic en Instalar. Gladys descarga la imagen Docker (
ghcr.io/william-de71/gladys-radio-france:0.1.0), la ejecuta en un entorno aislado del núcleo y genera la interfaz de la integración (dispositivos, descubrimiento y configuración). - Abre la pantalla de Configuración de la integración, rellena los parámetros y guarda.
- También puedes instalarla directamente desde la URL de su repositorio: https://github.com/William-De71/gladys-radio-france.
Radio France requiere Gladys >=5.1.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
Radio France 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.
- Explorar todas las integraciones, nativas y de la comunidad
- Crear y publicar tu propia integración externa
- Código fuente en GitHub — fuente de esta documentación