Aller au contenu principal

Intégration domotique Agora Famille Calendrier, gratuite et open source

Intégration Agora Famille Calendrier pour Gladys Assistant

Réservations (cantine, périscolaire, loisirs) et factures Agora Famille dans votre calendrier.

Cette intégration met dans le calendrier de Gladys ce que le portail famille Agora Famille (édité par Agora Plus) de votre commune sait de vos enfants :

  • un calendrier par enfant : les jours réservés (cantine, périscolaire, accueil de loisirs…), aux horaires donnés par le portail ;
  • un calendrier des factures : chaque facture à payer, le jour de sa date limite, avec le montant restant (jamais arrondi).

Elle ne fait que lire le portail : elle ne réserve ni n'annule jamais rien. Les réservations et les absences se font sur le portail ; le calendrier suit à la lecture suivante.

Elle complète l'intégration Agora Famille (appareils, déclencheurs de scène, widget) ; les deux peuvent tourner ensemble.

Avant de commencer​

  • Il faut Gladys 5.3 ou plus récent.
  • Il vous faut un compte actif sur le portail Agora Famille de votre commune : l'adresse e-mail et le mot de passe avec lesquels vous vous y connectez.
  • L'intégration est de type cloud : elle a besoin d'internet pour joindre le portail.

Activer l'intégration (chaque utilisateur)​

Un calendrier, ce sont des données personnelles : chaque utilisateur de Gladys active l'intégration pour lui-même, avec son propre compte.

Dans Gladys : Intégrations → Agora Famille Calendrier → Configuration, bloc « Mes calendriers » :

ChampCe qu'il faut y mettre
Adresse du portailL'adresse de votre portail telle que l'affiche votre navigateur, par ex. https://portalssl.agoraplus.fr/maville/pck_home.home_view#/. Le seul nom de la commune (maville) suffit aussi.
Identifiant (e-mail)L'e-mail de votre compte famille.
Mot de passeLe mot de passe du portail. Il est stocké comme un secret par Gladys et n'apparaît jamais dans les logs.
Factures transmises au Trésor public (facultatif)Numéros des factures que la commune a transmises au Trésor public, séparés par des virgules (ex. 164513). Voir plus bas.

Puis cliquez sur Activer. Vos calendriers apparaissent dans la vue Calendrier de Gladys après la première lecture du portail.

Deux parents peuvent activer l'intégration chacun de leur côté, avec le même compte du portail ou deux comptes : chacun a ses propres calendriers.

Privé ou partagé​

Un calendrier créé par l'intégration est privé au départ : vous seul le voyez. Pour qu'il serve aux scènes (déclencheur « un événement du calendrier approche ») et au reste de la maison, partagez-le dans les réglages du calendrier. Vous pouvez aussi désactiver la synchronisation d'un calendrier : l'intégration le laisse alors de côté.

Réglages de l'intégration (administrateur)​

ChampCe qu'il fait
Intervalle de lecture (min)Fréquence de lecture du portail (60 min par défaut, 15 min minimum).
Jours à venirCombien de jours à venir vont dans les calendriers (30 par défaut, 90 au plus).
Jours passés tenus à jourCombien de jours passés sont encore mis à jour (7 par défaut). Les jours plus anciens restent tels quels dans le calendrier.
Événements sur la journéeAffiche chaque réservation sur toute la journée au lieu des horaires du portail (désactivé par défaut).
Calendrier des facturesAjoute le calendrier des factures à payer (activé par défaut). Le désactiver supprime ce calendrier.
Logs détaillésJournalise chaque requête au portail, pour le dépannage. Jamais le mot de passe.

Le bouton Synchroniser maintenant relit le portail pour tous les utilisateurs et dit, pour chacun, combien d'enfants, d'événements et de calendriers ont été mis à jour, ou ce qui a échoué.

Ce qui va dans les calendriers​

Un calendrier par enfant (« Léa – Agora Famille »)​

  • Un événement par activité réservée : son nom est celui du portail (« Restauration scolaire », « Garderie soir »…).
  • Une journée demandée et pas encore validée par la commune porte la mention « (en attente) ».
  • Les horaires sont ceux que donne le portail ; sans horaires, l'événement prend toute la journée.
  • La description reprend le lieu et la période du portail, et l'état (« Réservé », « Demande en attente »). Un lien ouvre le portail.

Un jour annulé sur le portail disparaît du calendrier à la lecture suivante.

Le calendrier des factures (« Factures Agora Famille »)​

  • Un événement sur la journée, à la date limite de paiement de chaque facture non payée : « Facture à payer : 64,80 € ».
  • La description reprend le libellé de la facture et, si elle est en partie payée, le montant total et le reste à payer.
  • Une facture payée disparaît du calendrier à la lecture suivante.
  • Ce calendrier n'existe pas si la commune n'a pas le module de factures.

Factures transmises au Trésor public​

Quand une facture n'est pas payée à temps, la commune la transmet au Trésor public (« mise en impayé »). Le portail ne suit alors plus son paiement et la montre impayée pour toujours, même une fois payée au Trésor.

Ces factures ne vont pas dans le calendrier des factures. Elles sont reconnues toutes seules quand le portail les marque (contentieux, ou un état qui parle du Trésor), sinon par leur numéro, dans le champ Factures transmises au Trésor public de votre compte.

Exemples de scènes​

Une fois le calendrier d'un enfant partagé :

  • Un événement du calendrier approche, calendrier « Léa – Agora Famille », 1 heure avant → notification « Léa va bientôt au centre de loisirs ».
  • Un événement du calendrier approche, calendrier « Factures Agora Famille », 3 jours avant → notification « Une facture Agora Famille arrive à échéance ».

Dépannage​

L'état de chaque utilisateur s'affiche en haut de l'écran de configuration.

  • « Renseignez l'adresse du portail… dans « Mes calendriers » » : le compte de cet utilisateur est incomplet.
  • « Le portail a refusé l'identifiant ou le mot de passe » : vérifiez-les en vous connectant au portail dans un navigateur. Un compte en attente de validation par la mairie ne peut pas encore se connecter.
  • « Le portail ne répond pas » : le portail est peut-être en maintenance ; l'intégration réessaie à chaque intervalle. Rien n'est effacé des calendriers en attendant.
  • « Le portail a répondu quelque chose d'inattendu » : cochez Logs détaillés, cliquez sur Synchroniser maintenant et consultez les logs de l'intégration.

Important : pas d'API officielle​

Agora Plus ne publie pas d'API pour son portail famille. L'intégration utilise les mêmes requêtes que les pages du portail ; elles sont regroupées dans un seul fichier, src/agora/endpoints.js. Une mise à jour du portail peut demander de les ajuster : ouvrez alors une issue en indiquant l'étape qui échoue et le code HTTP renvoyé (jamais votre mot de passe).

Confidentialité​

  • Les identifiants de chaque utilisateur servent uniquement à se connecter au portail de sa commune, en HTTPS.
  • Le mot de passe et la session ne sont jamais écrits dans les logs.
  • Le planning et les factures ne vont que dans les calendriers Gladys de l'utilisateur qui a activé l'intégration. Rien n'est écrit sur le disque, rien n'est envoyé ailleurs.

Paramètres de configuration​

Voici les paramètres demandés par Agora Famille Calendrier dans son écran de configuration dans Gladys.

ParamètreTypeObligatoireDescription
Intervalle de lecture (min)numberNonFréquence de lecture du portail, en minutes (15 minimum).
Jours à venirnumberNonCombien de jours à venir de réservations et de factures vont dans les calendriers.
Jours passés tenus à journumberNonCombien de jours passés sont encore mis à jour depuis le portail. Les jours plus anciens restent tels quels.
Événements sur la journéebooleanNonAffiche chaque réservation sur toute la journée au lieu des horaires donnés par le portail.
Calendrier des facturesbooleanNonAjoute un calendrier des factures à payer, à leur date limite.
Logs détaillésbooleanNonJournalise chaque requête au portail (jamais le mot de passe). Pour le dépannage.

Comment installer Agora Famille Calendrier dans Gladys​

  1. Dans Gladys, ouvrez Intégrations : Agora Famille Calendrier 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/prohand/gladys-calendar-agorafamille:1.0.2), 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/prohand/gladys-calendar-agorafamille.

Agora Famille Calendrier nécessite Gladys >=5.3.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​

Agora Famille Calendrier 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 prohand, 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 🙂