Aller au contenu principal

Intégration domotique Radio France, gratuite et open source

Intégration Radio France pour Gladys Assistant

Émissions, morceaux et programmes des stations Radio France via l’Open API (non officiel).

Présentation​

Cette intégration affiche dans Gladys ce qui passe à l’antenne des stations de Radio France : France Inter, franceinfo, France Culture, France Musique, FIP, Mouv’, les stations locales ICI (ex-France Bleu) et les webradios. Pour chaque station suivie, vous avez l’émission, la séquence en cours (le journal, une chronique) et le morceau, et vos scènes peuvent réagir quand une nouvelle émission, séquence ou un nouveau morceau commence.

Les données viennent de l’Open API officielle de Radio France, avec votre propre clé d’API. L’intégration est non officielle et sans lien avec Radio France. Elle ne lit aucun flux : l’Open API ne peut pas servir à l’écoute en direct.

Conditions d’utilisation​

Utiliser l’Open API, c’est accepter ses conditions : une clé personnelle, un usage privé et non commercial, des données affichées telles quelles et jamais stockées, et le crédit « données fournies par l’Open API Radio France », que chaque widget de l’intégration affiche. L’intégration ne garde les données qu’en mémoire, une heure au plus ; /data ne contient que son compteur de requêtes et vos interrupteurs de suivi. Aucun logo Radio France n’est utilisé.

Prérequis​

  • Gladys Assistant 5.1.0 ou plus récent.
  • Une clé Open API gratuite et personnelle : chaque utilisateur de Gladys demande la sienne.
  • Un accès à Internet depuis Gladys (les requêtes partent vers openapi.radiofrance.fr).

Obtenir votre clé Open API​

  1. Créez un compte sur developers.radiofrance.fr.
  2. Dans Mon compte, cliquez sur Demander une clé d’API.
  3. Indiquez le nom de votre projet (par exemple « Gladys à la maison ») et son but (par exemple « afficher ce qui passe à l’antenne sur mon tableau de bord domotique »).
  4. Radio France valide chaque demande à la main et envoie la clé par e-mail, souvent dans la journée.
  5. Collez la clé dans la configuration de l’intégration, enregistrez, puis appuyez sur Tester la clé d’API.

Configuration​

ChampPar défautRôle
Clé Open API—Votre clé. Envoyée à Radio France dans un en-tête de chaque requête, jamais réaffichée ni écrite dans les journaux.
Langue des textesFrançaisNoms des fonctionnalités, messages d’état et phrases des actions de scène. Les titres de Radio France ne sont jamais traduits.
Budget quotidien (requêtes)900Requêtes que l’intégration s’autorise par jour, sur les 1 000 de la clé (100 à 1 000). Baissez-le si la clé sert ailleurs.
Intervalle minimum (secondes)90Jamais deux relevés plus rapprochés que cela (60 à 600). Le budget peut les espacer davantage.

Tester la clé d’API lit la liste des stations (une requête), met à jour l’onglet Découverte et affiche les requêtes utilisées aujourd’hui.

Utilisation​

Appareils​

Ouvrez l’onglet Découverte de l’intégration et ajoutez les stations voulues. La liste vient de l’API, avec les noms que Radio France leur donne.

FonctionnalitéRemarques
ÉmissionL’émission à l’antenne (son nom). Un tiret s’il n’y en a pas : FIP et ses webradios passent le plus souvent de la musique sans émission.
SéquenceLa séquence dans l’émission : le journal, une chronique, un entretien. Un tiret entre deux séquences.
Morceau« Artiste – Titre » du morceau à l’antenne, sur les stations musicales. Un tiret sinon.
SuiviActivé par défaut. Seules les stations suivies sont interrogées. Désactivez-le pour les stations que vous n’écoutez pas, ou laissez une scène l’activer quand vous écoutez.

Quota et relevés​

Une clé autorise 1 000 requêtes par jour ; au-delà, Radio France la bloque jusqu’au lendemain. L’intégration compte chaque requête qu’elle envoie et interroge jusqu’à 10 stations en une seule requête. Elle attend la fin de l’émission, de la séquence ou du morceau en cours avant de redemander (jamais avant l’intervalle minimum, au moins toutes les 15 minutes), et étale les requêtes sur le reste de la journée quand le budget s’amenuise. Quand rien n’est suivi, elle n’envoie aucune requête. Le compteur est supposé repartir à zéro à minuit, heure de Paris (Radio France ne le précise pas).

Les actions de scène, le bouton Actualiser et le widget « Prochaines émissions » utilisent le même budget. Quand il est épuisé, ils le disent et attendent minuit.

Widgets du tableau de bord​

Les widgets de l’intégration : à l’antenne sur une station parlée et sur une station musicale, les prochaines émissions, l’usage de l’Open API (illustration générée, pas une capture d’écran)

  • À l’antenne : l’émission, l’épisode, la séquence, le morceau, la fin de l’émission et l’heure du dernier relevé, avec un bouton Actualiser (une requête, au plus une fois par minute).
  • Prochaines émissions : les prochaines émissions d’une station, d’après sa grille (lue au plus toutes les 15 minutes). FIP et ses webradios ne publient pas leur programme à l’avance.
  • Usage de l’Open API : les requêtes du jour face au budget, l’état (OK, pause quota, clé refusée…), le prochain relevé, les stations suivies.

Choisissez la station dans les réglages d’un widget (par défaut, la première station suivie). L’image ci-dessus est une illustration générée avec des programmes inventés, pas une capture d’écran.

Scènes​

Déclencheurs, pour les stations suivies (vus par les relevés réguliers, donc jusqu’à quelques minutes après le début ; jamais au premier relevé après un redémarrage) :

  • Radio France : nouveau morceau — titre, artiste, album, année, label.
  • Radio France : début d’émission — émission, titre de l’épisode, résumé, page web, heure de fin.
  • Radio France : début de séquence — les mêmes variables, pour le journal, une chronique, un entretien.

Actions :

  • Radio France : ce qui passe à l’antenne — émission, séquence, morceau, artiste, album et fin de l’émission, pour une notification ou un message vocal.
  • Radio France : prochaines émissions — les prochaines émissions dans les 12 heures, avec une phrase à lire (« À venir sur France Inter : … »).

Exemples : quand le journal de 7 h commence sur France Inter, monter le volume de la radio de la cuisine ; quand un nouveau morceau passe sur FIP, l’afficher sur la télé ; chaque soir à 19 h, faire lire par Gladys les émissions de la soirée sur France Culture.

Dépannage​

  • « Radio France refuse la clé d’API » : vérifiez la clé (pas d’espace avant ni après). Une nouvelle clé peut mettre quelques minutes à fonctionner. L’intégration réessaie après 5 minutes, puis de moins en moins souvent (jusqu’à une heure).
  • « Quota quotidien atteint » ou « Budget quotidien épuisé » : tout attend minuit (heure de Paris). Suivez moins de stations, augmentez l’intervalle minimum, ou vérifiez que la clé ne sert pas à un autre programme.
  • « L’Open API ne répond pas » : le service ou votre accès à Internet est en panne ; l’intégration réessaie un peu plus tard. Une « erreur serveur » peut aussi signifier que le quota de la clé est consommé ailleurs.
  • Une station ne se met jamais à jour : vérifiez que son interrupteur Suivi est activé et regardez le widget « Usage de l’Open API ». Une station que Radio France a retirée de sa liste n’est plus interrogée.
  • FIP n’a pas d’émission : c’est normal, FIP et ses webradios passent surtout de la musique sans émission.
  • Pour un problème, donnez les versions de Gladys et de l’intégration, le message de Tester la clé d’API (il n’affiche jamais la clé) et les journaux avec DEBUG=gladys-integration-sdk.

Paramètres de configuration​

Voici les paramètres demandés par Radio France dans son écran de configuration dans Gladys.

ParamètreTypeObligatoireDescription
Avant de commencersectionNonCe qui passe à l’antenne des stations Radio France (France Inter, franceinfo, France Culture, France Musique, FIP, Mouv’, les stations locales ICI et les webradios) : l’émission, la séquence et le morceau, depuis l’Open API officielle de Radio France. Cette intégration est non officielle et sans lien avec Radio France. Elle ne lit aucun flux : l’Open API ne peut pas servir à l’écoute en direct. Chaque utilisateur a besoin de sa propre clé d’API, gratuite, pour un usage privé et non commercial.
Obtenir votre clé d’APIsectionNon1. Créez un compte sur developers.radiofrance.fr. 2. Dans « Mon compte », cliquez sur « Demander une clé d’API ». 3. Indiquez le nom de votre projet (par exemple « Gladys à la maison ») et son but (afficher ce qui passe à l’antenne sur mon tableau de bord domotique). 4. Radio France valide la demande à la main et envoie la clé par e-mail, souvent dans la journée. 5. Collez-la ci-dessous et enregistrez, puis utilisez « Tester la clé d’API ». La clé est personnelle : ne la partagez pas.
Clé Open APIsecretOuiEnvoyée à Radio France dans un en-tête de chaque requête, jamais réaffichée ni écrite dans les journaux.
Langue des textesselectNonLangue des noms de fonctionnalités, des messages d’état et des textes renvoyés par les actions de scène (Gladys ne transmet pas la langue de l’utilisateur à l’intégration). Les titres de Radio France restent tels quels.
Quota quotidiensectionNonRadio France autorise 1 000 requêtes par jour et par clé, et bloque la clé au-delà. L’intégration compte ses requêtes et les répartit sur la journée : une requête lit jusqu’à 10 stations, la suivante part quand une émission ou un morceau se termine. Seules les stations dont l’interrupteur « Suivi » est activé sont interrogées. Les actions de scène, le bouton Actualiser et le widget de programme utilisent le même budget. Le compteur est supposé repartir à zéro à minuit, heure de Paris.
Budget quotidien (requêtes)numberNonRequêtes que l’intégration s’autorise par jour, sur les 1 000 de la clé. Baissez-le si vous utilisez la même clé ailleurs.
Intervalle minimum (secondes)numberNonJamais deux relevés plus rapprochés que cela. Le budget peut les espacer davantage.
Conditions d’utilisationsectionNonEn utilisant votre clé, vous acceptez les conditions d’utilisation de l’Open API : usage privé et non commercial, données affichées telles quelles, jamais stockées (l’intégration ne les garde qu’en mémoire, quelques minutes) et avec le crédit « données fournies par l’Open API Radio France », que chaque widget affiche. Aucun flux n’est lu et aucun logo Radio France n’est utilisé.

Comment installer Radio France dans Gladys​

  1. Dans Gladys, ouvrez Intégrations : Radio France apparaît dans le catalogue, aux côtés des intégrations natives, avec un badge communautaire.
  2. Cliquez sur Installer. Gladys télécharge l'image Docker (ghcr.io/william-de71/gladys-radio-france:0.1.0), la démarre dans un bac à sable isolé du cœur, et génère l'interface de l'intégration (appareils, découverte et configuration).
  3. Ouvrez l'écran Configuration de l'intégration, remplissez les paramètres, puis enregistrez.
  4. Vous pouvez aussi l'installer directement depuis l'URL de son dépôt : https://github.com/William-De71/gladys-radio-france.

Radio France nécessite Gladys >=5.1.0. Le catalogue dans Gladys se rafraîchit toutes les heures : une nouvelle version est donc disponible au plus tard une heure après sa sortie.

Vous n'utilisez pas encore Gladys ? C'est gratuit et open source : suivez le guide d'installation pour démarrer.

À propos des intégrations externes​

Radio France est une intégration externe : une intégration communautaire empaquetée dans un conteneur Docker et publiée sur GitHub, que Gladys installe en un clic et exécute dans un bac à sable isolé de son cœur. Elle est publiée et maintenue par William-De71, et non par l'équipe cœur de Gladys.

Inscrivez-vous à la newsletter Gladys Assistant

Quelques emails par mois sur les nouveautés et l'actualité du projet. Envoyés par Pierre-Gilles Leymarie, le fondateur du projet. Désinscription possible à tout moment 🙂