Zum Hauptinhalt springen

Agora Famille Smart-Home-Integration, kostenlos und Open Source

Agora Famille-Integration für Gladys Assistant

Kantine, Nachmittagsbetreuung, Rechnungen und Nachrichten des Familienportals Agora Famille.

Diese Integration verbindet Gladys mit dem Familienportal Agora Famille (von Agora Plus) deiner französischen Gemeinde: Schulkantine, Vor- und Nachmittagsbetreuung, Ferienfreizeiten, Rechnungen und Nachrichten des Rathauses.

Sie liest das Portal so, wie es dein Browser tut, mit deinem eigenen Konto, und bietet dir in Gladys:

  • ein Gerät pro Kind: was heute und morgen gebucht ist und ob es in der Kantine isst;
  • ein Gerät Familienkonto: der offene Betrag, die nächste Rechnung, die letzte Nachricht;
  • Szenen-Auslöser (neue Rechnung, Rechnung bald fällig, neue Nachricht, Buchung angenommen oder abgelehnt);
  • lesende Szenen-Aktionen (einen Tag prüfen, das Portal erneut lesen);
  • ein Dashboard-Widget.

Bevor du beginnst​

  • Es wird Gladys 5.3 oder neuer benötigt.
  • Du brauchst ein aktives Konto beim Agora-Famille-Portal deiner Gemeinde: die E-Mail-Adresse und das Passwort, mit denen du dich anmeldest.
  • Die Integration ist eine Cloud-Integration: Sie braucht Internet, um das Portal zu erreichen.

Konfiguration​

In Gladys: Integrationen → Agora Famille → Konfiguration.

FeldWas einzutragen ist
PortaladresseDie Adresse deines Portals, wie dein Browser sie anzeigt, z. B. https://portalssl.agoraplus.fr/meinestadt/pck_home.home_view#/. Nur der Name der Gemeinde (meinestadt) genügt auch.
Benutzername (E-Mail)Die E-Mail deines Familienkontos.
PasswortDas Passwort des Portals. Gladys speichert es als Geheimnis, es erscheint nie in den Protokollen.
Aktualisierungsintervall (min)Wie oft das Portal gelesen wird (standardmäßig 60 min, mindestens 15 min).
Beobachtete PlanungstageWie viele Tage im Voraus gelesen und überwacht werden (standardmäßig 14).
Rechnungserinnerung (Tage)Der Auslöser „Rechnung bald fällig“ wird so viele Tage vor dem Fälligkeitsdatum ausgelöst (standardmäßig 3, 0 schaltet ihn ab).
An den Trésor public übergebene RechnungenNummern der Rechnungen, die die Gemeinde an den Trésor public übergeben hat, durch Kommas getrennt (z. B. 164513). Siehe unten.
Ausführliche ProtokolleProtokolliert jede Anfrage an das Portal, zur Fehlersuche. Nie das Passwort.

Klicke dann auf Verbindung testen: Die Antwort nennt deine Kinder, die Zahl der gelesenen Planungstage, die offenen Rechnungen und die ungelesenen Nachrichten. Bei einem Fehler nennt sie den fehlgeschlagenen Schritt (Anmeldung, Kinder, Planung, Rechnungen, Nachrichten).

Öffne anschließend den Reiter Entdecken, um die Geräte anzulegen.

Geräte​

Agora Famille (das Konto)​

FunktionInhalt
Balance dueDer offene Betrag in Euro (alle unbezahlten Rechnungen).
Next invoiceDie nächste zu zahlende Rechnung: Betrag, Fälligkeit, Titel.
Last messageDer Betreff der letzten Nachricht der Gemeinde.

Ein Gerät pro Kind​

FunktionInhalt
TodayDie heute gebuchten Aktivitäten („Cantine, Garderie du soir“).
TomorrowDie morgen gebuchten Aktivitäten.
Canteen today1, wenn das Kind heute in der Kantine isst, sonst 0.
Canteen tomorrow1, wenn das Kind morgen in der Kantine isst, sonst 0.

Ein angefragter, von der Gemeinde noch nicht bestätigter Tag zählt als gebucht. Die Texte sind auf Französisch, wie die Aktivitäten des Portals.

Das Essen wird an seinem Namen erkannt: „cantine“, „repas“, „restauration“, „déjeuner“, „pause méridienne“… Jede Gemeinde benennt ihre Aktivitäten auf ihre Weise.

Das Cloud-Abzeichen jedes Geräts wechselt auf nicht erreichbar, solange das Portal nicht gelesen werden kann.

Szenen (Gladys 5.1+)​

Auslöser​

AuslöserWannVariablen
Eine neue Rechnung wird ausgestelltEine unbezahlte Rechnung erscheint.label, amount, due_date, invoice_id
Eine Rechnung wird bald fälligEine unbezahlte Rechnung wird innerhalb der eingestellten Tage fällig. Nur einmal.label, amount, due_date, days_left, invoice_id
Eine Nachricht wird empfangenDie Gemeinde hat eine Nachricht gesendet.subject, sender, date
Eine Buchung ändert sichEin gebuchter oder angefragter Tag ändert seinen Status (angenommen, abgelehnt, storniert…). Nach Kind und Status filterbar.child_name, activity, date, status, previous_status, meal

Die Variablen lassen sich in den folgenden Aktionen verwenden, z. B. {{triggerEvent.data.amount}}.

Das allererste Lesen des Portals löst nichts aus: Alles würde neu wirken. Ab dann werden Änderungen gezählt, auch über Neustarts hinweg (die Integration behält das letzte Lesen in /data).

Aktionen​

AktionWas sie tutAusgaben
Familienportal lesenLiest das Portal sofort.success, balance, unpaid_invoices, unread_messages
Tag eines Kindes prüfenOb das Kind an dem Tag gebucht ist (0 = heute, 1 = morgen…) und wofür.has_meal, booked_count, activities, date

Die Integration liest das Portal nur: Sie bucht und storniert nie etwas. Buchungen und Abwesenheiten werden im Portal erledigt.

Beispiele​

  • Jeden Abend um 19 Uhr: Tag eines Kindes prüfen für morgen, dann, wenn has_meal falsch ist, „Morgen keine Kantine für Léa“ senden.
  • Eine Rechnung wird bald fällig → „Rechnung über {{triggerEvent.data.amount}} € bis {{triggerEvent.data.due_date}} zahlen“ senden.
  • Eine Buchung ändert sich, gefiltert auf Abgelehnt → Benachrichtigung.

Das Widget​

Das Dashboard-Widget Agora Famille zeigt:

  • den offenen Betrag (live);
  • für jedes Kind (höchstens 5), was heute und morgen gebucht ist (grün: gebucht, orange: Anfrage offen, rot: abgelehnt);
  • die offenen Rechnungen und die letzten 3 ungelesenen Nachrichten;
  • die Uhrzeit des letzten Lesens oder den aktuellen Fehler.

Und zwei Tasten: Aktualisieren und Portal öffnen. Abwesenheiten und Buchungen werden im Portal erledigt.

An den Trésor public übergebene Rechnungen​

Wird eine Rechnung nicht rechtzeitig bezahlt, übergibt die Gemeinde sie an den Trésor public (die französische Staatskasse, „mise en impayé“). Das Portal verfolgt die Zahlung dann nicht mehr: Es zeigt sie für immer als unbezahlt, auch nachdem sie beim Trésor bezahlt wurde.

Die Integration stellt diese Rechnungen beiseite:

  • Sie zählen weder zum offenen Betrag noch als nächste Rechnung;
  • sie lösen weder „neue Rechnung“ noch „Rechnung bald fällig“ aus;
  • das Widget zeigt sie grau, mit dem Abzeichen Staatskasse.

Sie werden auf zwei Arten erkannt:

  • von selbst, wenn das Portal sie markiert (eine Rechnung im Mahnverfahren oder ein Status, der den Trésor nennt);
  • über ihre Nummer im Feld An den Trésor public übergebene Rechnungen (die im Portal angezeigte Nummer, z. B. 164513).

Fehlerbehebung​

  • „Das Portal hat Benutzername oder Passwort abgelehnt“: Prüfe sie, indem du dich im Browser beim Portal anmeldest. Ein Konto, das noch auf die Freigabe durch das Rathaus wartet, kann sich noch nicht anmelden.
  • „Das Portal antwortet nicht“: Das Portal wird vielleicht gewartet; die Integration versucht es in jedem Intervall erneut.
  • „Das Portal hat etwas Unerwartetes geantwortet“: Aktiviere Ausführliche Protokolle, klicke auf Verbindung testen und lies die Protokolle der Integration (Integrationen → Agora Famille → Überwachung).

Wichtig: keine offizielle API​

Agora Plus veröffentlicht keine API für sein Familienportal. Die Integration stellt dieselben Anfragen wie die Seiten des Portals; sie sind in einer einzigen Datei gesammelt, src/agora/endpoints.js. Ein Update des Portals oder eine anders eingerichtete Gemeinde kann Anpassungen erfordern: Eröffne dann ein Issue mit dem fehlgeschlagenen Schritt und dem HTTP-Status (nie dein Passwort).

Datenschutz​

  • Die Zugangsdaten dienen nur zur Anmeldung beim Portal deiner Gemeinde, über HTTPS.
  • Das Passwort und die Sitzungs-Cookies werden nie in die Protokolle geschrieben.
  • Das letzte Lesen des Portals (Planung, Rechnungen, Nachrichten) wird im privaten Volume /data der Integration gespeichert, um Änderungen nach einem Neustart zu erkennen. Nichts wird anderswohin gesendet.

Konfigurationseinstellungen​

Diese Einstellungen fragt Agora Famille in seinem Konfigurationsbildschirm in Gladys ab.

EinstellungTypPflichtfeldBeschreibung
Dein FamilienportalsectionNeinVerwende die Adresse und das Konto, mit denen du dich beim Agora-Famille-Portal deiner Gemeinde anmeldest. Die Integration liest das Portal wie ein Browser: Nichts wird an Dritte weitergegeben.
PortaladressestringJaDie Adresse deines Portals, wie dein Browser sie anzeigt, oder nur der Name deiner Gemeinde darin.
Benutzername (E-Mail)stringJa
PasswortsecretJa
Aktualisierungsintervall (min)numberNeinWie oft das Portal gelesen wird, in Minuten (mindestens 15).
Beobachtete PlanungstagenumberNeinWie viele Tage im Voraus die Buchungen gelesen und auf Änderungen überwacht werden.
Rechnungserinnerung (Tage)numberNeinDer Auslöser „Rechnung bald fällig“ wird so viele Tage vor dem Fälligkeitsdatum ausgelöst. 0 schaltet ihn ab.
An den Trésor public übergebene RechnungenstringNeinNummern der Rechnungen, die die Gemeinde an den Trésor public übergeben hat („mise en impayé“), durch Kommas getrennt. Das Portal zeigt sie weiter als unbezahlt: Sie werden getrennt angezeigt und nicht zum offenen Betrag gezählt. Vom Portal selbst markierte werden auch ohne dies erkannt.
Ausführliche ProtokollebooleanNeinProtokolliert jede Anfrage an das Portal (nie das Passwort). Zur Fehlersuche.

So installierst du Agora Famille in Gladys​

  1. Öffne in Gladys Integrationen: Agora Famille erscheint im Katalog neben den nativen Integrationen, mit einem Community-Badge.
  2. Klicke auf Installieren. Gladys lädt das Docker-Image (ghcr.io/prohand/gladys-agorafamille:2.0.1) herunter, startet es in einer vom Kern isolierten Sandbox und erzeugt die Oberfläche der Integration (Geräte, Erkennung und Konfiguration).
  3. Öffne den Bildschirm Konfiguration der Integration, fülle die Einstellungen aus und speichere.
  4. Du kannst sie auch direkt über die URL ihres Repositorys installieren: https://github.com/prohand/gladys-agorafamille.

Agora Famille benötigt Gladys >=5.3.0. Der Katalog in Gladys wird stündlich aktualisiert, eine neue Version ist also spätestens eine Stunde nach ihrer Veröffentlichung verfügbar.

Du nutzt Gladys noch nicht? Es ist kostenlos und Open Source: folge der Installationsanleitung, um loszulegen.

Über externe Integrationen​

Agora Famille ist eine externe Integration: eine Community-Integration, die als Docker-Container verpackt und auf GitHub veröffentlicht wird. Gladys installiert sie mit einem Klick und führt sie in einer vom Kern isolierten Sandbox aus. Sie wird von prohand veröffentlicht und gepflegt, nicht vom Gladys-Kernteam.

Abonniere den Newsletter von Gladys Assistant

Ein paar E-Mails im Monat zu neuen Releases und Neuigkeiten aus dem Projekt. Verschickt von Pierre-Gilles Leymarie, dem Gründer des Projekts. Jederzeit abbestellbar 🙂