Aller au contenu principal

Intégration domotique XMLTV TV guide, gratuite et open source

Intégration XMLTV TV guide pour Gladys Assistant

Ce qui passe maintenant, ensuite et ce soir sur vos chaînes, depuis tout guide XMLTV.

Ce qui passe maintenant, ensuite et ce soir sur les chaînes que vous suivez, lu dans n'importe quel guide XMLTV : un appareil par chaîne, un widget pour le tableau de bord, un déclencheur de scène sur des mots-clés (« Top 14 », « Koh-Lanta ») et deux actions de scène.

Testée contre de vrais guides publics (xmltvfr.fr, epgshare01), pas encore sur beaucoup d'installations Gladys : vos retours sont bienvenus sur le forum Gladys.

Ce qu'il faut​

  • Gladys Assistant 5.1.0 ou plus récent.
  • L'adresse d'un guide XMLTV qui couvre vos chaînes, .xml ou .xml.gz (voir plus bas). Ni compte, ni clé d'API.

Trouver un guide​

  • France, Belgique, Suisse, Afrique francophone : xmltvfr.fr publie des guides gratuits, refaits chaque jour, par exemple https://xmltvfr.fr/xmltv/xmltv_tnt.xml.gz (chaînes de la TNT, 1 Mo) ou https://xmltvfr.fr/xmltv/xmltv.xml.gz (toutes les chaînes, 18 Mo).
  • Autres pays : le projet iptv-org/epg recense les sources et les outils pour fabriquer un guide ; des sites communautaires publient des guides prêts à l'emploi par pays.
  • Votre box ou fournisseur IPTV : beaucoup donnent une adresse XMLTV (souvent …/xmltv.php?username=…&password=…). Elle est acceptée telle quelle, et jamais écrite dans les journaux.
  • Un fichier : un guide copié dans le volume de données de l'intégration se lit avec une adresse comme /data/guide.xml.gz.

Mise en place​

  1. Dans Intégrations → XMLTV TV guide → Configuration, renseignez l'adresse du guide.
  2. Dans Chaînes suivies, listez les chaînes, séparées par des virgules, 20 au plus : leur identifiant dans le guide (TF1.fr) ou leur nom (France 2). Le bouton Lister les chaînes (avec une recherche comme france) affiche les identifiants et les noms du guide.
  3. Choisissez le début de soirée (21 h par défaut) et la fréquence de téléchargement du guide (toutes les 12 heures par défaut).
  4. Si vous le souhaitez, saisissez des mots-clés pour les scènes et le délai pour prévenir en avance.
  5. Appuyez sur Tester le guide : il télécharge le guide et dit quelles chaînes suivies il contient, et jusqu'à quand.
  6. Dans l'onglet Découverte, ajoutez les chaînes voulues dans Gladys.

La langue des textes règle les noms des fonctionnalités, les textes publiés et les sorties des scènes (français par défaut).

L'appareil de chaque chaîne​

FonctionnalitéExemple
En ce momentLa traversée de Paris
Fin du programme en cours22:35
Temps restant (minutes)42
Ensuite22:35 · Les enfants du siècle
Ce soir21:10 · La traversée de Paris

« Ce soir » est le premier programme d'au moins 20 minutes qui commence à partir de 10 minutes avant le début de soirée (la météo et les bandes-annonces sont sautées), ou le programme diffusé à cette heure-là. Une fois terminé, il affiche celui du lendemain soir, précédé de « demain ». Les heures sont dans le fuseau horaire de Gladys.

Tableau de bord​

Le widget Programme TV liste jusqu'à 8 chaînes ajoutées à Gladys, sous le nom que vous leur avez donné : ce qui passe en ce moment avec le temps restant, ou (réglage Afficher) ce soir avec l'heure de début. La pastille peut être masquée. Un appui sur une chaîne montre maintenant, ensuite et ce soir, avec les horaires, l'épisode et la catégorie.

Scènes​

Déclencheurs​

Programme avec un mot-clé : un programme dont le titre contient un des mots-clés configurés commence sur une chaîne suivie (accents et majuscules ignorés). Filtres : le mot-clé (tel qu'écrit dans la configuration), la chaîne, et le moment — au début, ou avant le début du délai réglé dans la configuration. Variables : mot-clé, chaîne, titre, sous-titre, catégorie, début, fin, durée. Un programme déjà commencé au démarrage de l'intégration ne déclenche rien.

Actions​

  • Lire le programme d'une chaîne : maintenant, ensuite ou ce soir sur une chaîne. Sorties : trouvé (1 ou 0), chaîne, titre, sous-titre, catégorie, jour, début, fin, et les minutes avant le début (ou restantes, pour maintenant).
  • Chercher un programme : la prochaine diffusion d'un titre (ou d'une partie du titre) sur les chaînes suivies, mêmes sorties.

Idées de scènes​

  • À 20 h, dire « Ce soir sur France 2 : {{title}} à {{start}} ».
  • « Top 14 » commence dans 10 minutes : envoyer un message et allumer la télé.
  • Chaque samedi matin, chercher « Koh-Lanta » et annoncer son jour.

Téléchargements et charge​

  • Le guide est téléchargé au démarrage, puis toutes les 6, 12 ou 24 heures, par une requête conditionnelle : un guide inchangé n'est pas retéléchargé. Un échec est retenté 30 minutes plus tard, et les programmes déjà connus restent affichés.
  • Le guide est lu en flux, même quand il pèse des centaines de mégaoctets : seules les chaînes suivies sont gardées (100 Mo de mémoire au plus pendant la lecture du guide complet de xmltvfr.fr, moins de 60 Mo au repos).
  • Les programmes des chaînes suivies sont mis en cache dans le volume de données : un redémarrage ne retélécharge pas le guide avant l'heure.
  • Les états sont calculés chaque minute en mémoire, et publiés seulement quand ils changent.

Respectez les conditions du guide utilisé : les guides gratuits sont refaits une ou deux fois par jour, les télécharger plus souvent n'apporte rien.

Dépannage​

  • « L'adresse ne mène pas à un guide XMLTV » : l'adresse renvoie une page web (connexion, erreur). Ouvrez-la dans un navigateur : elle doit télécharger un fichier .xml ou .xml.gz.
  • Une chaîne suivie est « introuvable » : utilisez Lister les chaînes avec une partie de son nom, et copiez son identifiant.
  • « Aucun programme » : le guide n'a aucun programme pour cette chaîne à cette heure ; certains guides ne couvrent que quelques jours.
  • Horaires décalés : vérifiez le fuseau horaire de Gladys ; les dates du guide portent leur propre décalage.

Limites​

  • XMLTV seulement (.xml ou gzip .xml.gz ; ni .zip ni .xz).
  • 20 chaînes suivies, programmes gardés jusqu'à 8 jours à l'avance.
  • Ni image, ni résumé, ni enregistrement : c'est un guide, pas un démodulateur (voir l'intégration Enigma2 pour les démodulateurs).

Paramètres de configuration​

Voici les paramètres demandés par XMLTV TV guide dans son écran de configuration dans Gladys.

ParamètreTypeObligatoireDescription
FonctionnementsectionNonIndiquez l'adresse d'un guide XMLTV (.xml ou .xml.gz), puis les chaînes suivies. Appuyez sur « Tester le guide » et ajoutez les chaînes depuis l'onglet Découverte. Le guide est téléchargé au plus toutes les 6 heures.
Adresse du guidestringOuiUne adresse https:// ou http://, ou un fichier du volume de données (/data/guide.xml.gz).
Chaînes suiviesstringNonIdentifiants ou noms des chaînes du guide, séparés par des virgules, 20 au plus. « Lister les chaînes » les affiche.
Début de soiréeselectNonLe programme « Ce soir » est le premier qui commence à partir de cette heure.
Télécharger le guideselectNon
Mots-clés pour les scènesstringNonTitres à guetter sur les chaînes suivies, séparés par des virgules. Leur début déclenche « Programme avec un mot-clé ».
Prévenir en avanceselectNonLe déclencheur peut aussi partir autant de minutes avant le début.
Langue des textesselectNonNoms des fonctionnalités, textes publiés et sorties des scènes. Le widget suit le tableau de bord.

Comment installer XMLTV TV guide dans Gladys​

  1. Dans Gladys, ouvrez Intégrations : XMLTV TV guide 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/guim31/gladys-xmltv:1.0.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/guim31/gladys-xmltv.

XMLTV TV guide 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​

XMLTV TV guide 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 guim31, 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 🙂