Litter-Robot Smart-Home-Integration, kostenlos und Open Source
Whisker Litter-Robot 3 und 4, Feeder-Robot: Schublade, Streu, Katzenbesuche, Reinigung.
Veröffentlicht von guim31
- Geräte
- Version 1.0.1
- Erfordert Gladys >=5.1.0
- ★ 0
Verfolge deine selbstreinigenden Katzentoiletten und deinen Futterautomaten von Whisker in Gladys: den Litter-Robot 3 Connect, den Litter-Robot 4 und den Feeder-Robot. Sieh, wann die Abfallschublade geleert werden muss, wann die Katze zuletzt da war (und was sie wiegt, beim Litter-Robot 4), werde bei einem Fehler gewarnt, und starte eine Reinigung oder gib eine Portion aus, vom Dashboard oder aus einer Szene.
Die Integration nutzt die Whisker-Cloud mit dem Konto der Whisker-App, wie die App selbst und wie die Home-Assistant-Integration. Die Integration ist nicht mit Whisker verbunden: Litter-Robot, Feeder-Robot und Whisker sind Marken ihres Inhabers.
Ohne die Hardware entwickelt: Rückmeldungen willkommen. Diese Integration wurde mit den echten Antworten der Whisker-Cloud gebaut und getestet, die die Bibliothek pylitterbot und Home Assistant veröffentlichen, nicht mit einem echten Roboter. Wenn etwas nicht wie beschrieben funktioniert, sag es im Gladys-Forum oder in den Issues.
Was du brauchst
- Gladys Assistant 5.1.0 oder neuer, mit Internetzugang.
- Einen Litter-Robot 3 Connect (das WLAN-Modell), einen Litter-Robot 4 und/oder einen Feeder-Robot, bereits in der Whisker-App eingerichtet.
- Die E-Mail-Adresse und das Passwort dieses Whisker-Kontos. Ein Konto, das bei der Anmeldung einen zweiten Faktor verlangt, wird nicht unterstützt: Melde dich zuerst einmal in der App an.
Der Litter-Robot 5 und der Litter-Robot 3 ohne WLAN werden nicht unterstützt.
Einrichtung
- Installiere die Integration aus dem Gladys-Katalog.
- Gib unter Konfiguration die E-Mail-Adresse und das Passwort deines Whisker-Kontos ein und speichere.
- Klicke auf Verbindung testen: Die Meldung unter der Schaltfläche listet die im Konto gefundenen Roboter mit ihrem Zustand auf.
- Öffne den Tab Entdecken: ein Gerät pro Roboter. Klicke auf Hinzufügen, wähle einen Raum und speichere.
Optionen:
- Aktualisierungsintervall: wie oft die Roboter aus der Whisker-Cloud gelesen werden, 2, 5 (Standard), 10 oder 15 Minuten. Ein Litter-Robot 4 und ein Feeder-Robot senden ihre Änderungen zusätzlich live; ein Litter-Robot 3 wird nur in diesem Intervall gelesen.
- Gewichtseinheit: Kilogramm oder Pfund, für das Gewicht der Katze im Widget.
- Feeder-Robot: Portionen pro Tag: die meisten Portionen, die Gladys in 24 Stunden ausgeben darf (standardmäßig 4, mindestens eine Minute Abstand). Siehe Aktionen.
- Sprache der Funktionsnamen: Englisch, Französisch (Standard), Deutsch oder Spanisch. Die Namen werden beim Hinzufügen eines Geräts vergeben; die Zustände der Roboter und die Meldungen der Szenen folgen ebenfalls dieser Sprache.
Das Passwort wird nur an den Anmeldedienst von Whisker (Amazon Cognito) gesendet. Die Integration bewahrt die erhaltenen Sitzungstoken in ihrem privaten Speicher auf, damit ein Neustart sich nicht erneut mit dem Passwort anmeldet.
Die Geräte
Litter-Robot 3 Connect
| Funktion | Was es ist |
|---|---|
| Zustand | Der Zustand im Klartext: Bereit, Reinigung läuft, Schublade voll… |
| Abfallschublade | Füllstand der Schublade in %, aus den Zyklen seit dem Leeren berechnet |
| Zyklen seit dem Leeren | Reinigungszyklen seit dem letzten Zurücksetzen des Zählers |
| Reinigung starten | Taste: startet jetzt einen Reinigungszyklus |
| Schubladenanzeige zurücksetzen | Taste: sagt dem Roboter, dass die Schublade geleert wurde (Zähler auf null) |
| Reinigungsverzögerung | Minuten zwischen dem Gehen der Katze und der Reinigung: 3, 7 oder 15 |
| Nachtlicht | Schalter: Nachtlicht an oder aus |
| Tastensperre | Schalter: sperrt die Tasten des Roboters |
| Schlafmodus | Ob eine Schlafphase eingestellt ist (nur lesen) |
| Letzter Besuch | Datum und Uhrzeit des letzten Katzenbesuchs, den die Integration sah |
Litter-Robot 4
| Funktion | Was es ist |
|---|---|
| Zustand | Der Zustand im Klartext |
| Abfallschublade | Füllstand der Schublade in %, wie der Roboter ihn misst |
| Streuhöhe | Die Streumenge in der Trommel, in % |
| Gewicht der Katze (g) | Das zuletzt vom Roboter gemessene Gewicht, in Gramm (SmartWeight) |
| Reinigungszyklen (gesamt) | Alle Reinigungszyklen seit der Inbetriebnahme |
| Reinigung starten | Taste: startet jetzt einen Reinigungszyklus |
| Reinigungsverzögerung | 3, 7, 15, 25 oder 30 Minuten |
| Nachtlichtmodus | Aus, An oder Automatisch |
| Tastensperre | Schalter: sperrt die Tasten des Roboters |
| Schlafmodus | Ob an mindestens einem Tag eine Schlafphase eingestellt ist (nur lesen) |
| Letzter Besuch | Datum und Uhrzeit des letzten Katzenbesuchs, den die Integration sah |
Gladys hat keine Masseeinheit: Das Gewicht ist eine Zahl in Gramm, die Einheit steht im Namen. Verlauf und Szenen („Gewicht unter 3500“) funktionieren wie gewohnt.
Feeder-Robot
| Funktion | Was es ist |
|---|---|
| Zustand | Bereit, Motor blockiert, Ausgabeschacht voll, Im Akkubetrieb, Offline |
| Futterstand | Das restliche Futter im Vorratsbehälter, in % (in Stufen des Sensors) |
| Portionen heute | Seit Mitternacht ausgegebene Portionen, Mahlzeiten und Extraportionen |
| Letzte Mahlzeit | Datum, Name und Portionen der letzten Mahlzeit oder Extraportion |
| Eine Portion ausgeben | Taste: jetzt eine Portion, innerhalb der Tagesgrenze |
| Automatisches Nachtlicht | Schalter |
| Tastensperre | Schalter |
Ein Roboter, den die Whisker-Cloud als offline meldet, trägt in Gladys ein „nicht erreichbar“-Abzeichen.
Dashboard
Das Widget Litter-Robot zeigt eine Katzentoilette (die in seinen Einstellungen gewählte, sonst die erste): die Füllstände von Schublade und Streu, die Besuche heute, ihren Zustand, ihren Letzten Besuch und ihr Letztes Gewicht, und die Tasten:
- Reinigen: startet einen Reinigungszyklus (Gladys fragt vorher nach);
- Schublade geleert (Litter-Robot 3): setzt den Schubladenzähler auf null.
Szenen
Auslöser
- Katzenbesuch: Eine Katze hat den Litter-Robot benutzt. Die Integration erkennt es, wenn der Roboter seinen Countdown vor der Reinigung startet, oder, wenn dieser Moment zwischen zwei Lesungen lag, wenn der Zykluszähler steigt (eine von Gladys gestartete Reinigung zählt nicht). Filter: der Roboter. Informationen für die Szene: Name des Roboters, Zuletzt gemessenes Gewicht (kg) und (lb) (Litter-Robot 4), Besuche heute.
- Abfallschublade voll: Der Roboter meldet seine Schublade voll, einmal pro Füllung. Informationen: Name des Roboters, Füllstand der Schublade (%).
- Roboterfehler: Ein Roboter meldet einen Fehler oder geht offline. Filter: der Roboter und die Art des Fehlers (Fehler des Trommelmotors, Einklemmen erkannt, Fehler des Katzensensors, Haube abgenommen, Roboter offline, Motor des Futterautomaten blockiert). Informationen: Name des Roboters, Art des Fehlers (Code), Fehler, im Klartext.
Aktionen
- Litter-Robot-Reinigung starten: startet jetzt einen Zyklus. Abgelehnt, solange der Roboter eine Katze erkennt.
- Feeder-Robot-Portion ausgeben: jetzt eine Portion. Um deine Katze vor einer Szene in einer Schleife zu schützen, gibt Gladys in 24 Stunden höchstens die in der Konfiguration eingestellte Zahl an Portionen aus, und nie zwei innerhalb einer Minute. Darüber hinaus tut die Aktion nichts und sagt es: Das Ergebnis Portion ausgegeben ist dann „nein“, und Verbleibende Portionen (24 h) sagt, wie viele übrig sind. Die in der Whisker-App geplanten Mahlzeiten zählen nicht.
Szenen-Ideen
- Schublade leeren: Auslöser Abfallschublade voll → Nachricht „Die Schublade der Katzentoilette ist voll, du bist dran!“.
- Die Gesundheit der Katze im Blick: Auslöser Katzenbesuch → Bedingung Besuche heute größer als 8 → benachrichtigen, ungewöhnlich viele Besuche können auf ein Harnwegsproblem hinweisen. Oder eine Szene auf der Funktion Gewicht der Katze (g): unter 3500 → benachrichtigen.
- Reinigen, wenn niemand zu Hause ist: Auslöser „alle sind gegangen“ → Aktion Litter-Robot-Reinigung starten.
- Fehleralarm: Auslöser Roboterfehler mit der Art Fehler des Trommelmotors oder Einklemmen erkannt → Nachricht mit Fehler, im Klartext.
Aktualisierung, Kontingente und Datenschutz
- Die Roboter werden alle paar Minuten gelesen (das Aktualisierungsintervall), dazu eine Lesung einige Sekunden nach einem Befehl; jede Roboterfamilie wird einmal pro Stunde neu aufgelistet, um einen dem Konto hinzugefügten Roboter zu finden. Ein Litter-Robot 4 und ein Feeder-Robot werden live über das Abonnement verfolgt, das die Whisker-App nutzt.
- Whisker veröffentlicht weder Kontingente noch Bedingungen für diese API, die die seiner App ist; die Integration hält das Tempo der Home-Assistant-Integration (standardmäßig 5 Minuten) und hört nach einem abgelehnten Passwort auf oder wenn Whisker das Konto drosselt (15 Minuten).
- Im privaten Speicher der Integration: die Sitzungstoken, ein Hash der E-Mail-Adresse, die Besuche des Tages und die von Gladys ausgegebenen Portionen. Nie das Passwort; die Protokolle enthalten nie das Passwort, die E-Mail-Adresse oder ein Token.
Fehlerbehebung
- „E-Mail oder Passwort von Whisker abgelehnt“: Prüfe sie in der Whisker-App und speichere die Konfiguration erneut. Nach einer Ablehnung versucht es die Integration nicht von selbst: Speichere die Konfiguration oder klicke auf Verbindung testen.
- „Dein Whisker-Konto verlangt einen weiteren Schritt“: Melde dich einmal in der Whisker-App an (neues Passwort, Bestätigungscode) und teste dann die Verbindung.
- „Die Whisker-Cloud antwortet nicht“: ein Ausfall des Internets oder von Whisker; die Integration versucht es bei der nächsten Aktualisierung erneut.
- Kein Gerät im Tab Entdecken: Klicke auf Verbindung testen; das Konto muss das sein, in dem die Roboter eingerichtet sind (kein geteiltes Konto).
- Ein Besuch oder Zustand kommt verspätet: Ein Litter-Robot 3 wird nur im Aktualisierungsintervall gelesen; senke es auf 2 Minuten.
- Mehr Details: Setze
LOG_LEVEL=debugfür die Integration und lies ihre Protokolle.
Grenzen
- Ohne die Hardware entwickelt: Die Befehle folgen pylitterbot und der Whisker-App, wurden aber nicht an einem echten Roboter ausprobiert.
- Nur Litter-Robot 3 Connect, Litter-Robot 4 und Feeder-Robot; kein Litter-Robot 5, keine Tierprofile (das Gewicht ist die letzte Messung des Roboters, kein Gewicht pro Katze: Bei mehreren Katzen ist es die zuletzt eingetretene).
- Die Besuche sind die, die die Integration seit ihrer Installation gesehen hat; sie liest nicht den Verlauf der Whisker-App.
- Der Litter-Robot 3 hat hier keine Live-Aktualisierung: Er wird im Aktualisierungsintervall gelesen.
- Keine Bearbeitung von Schlafplänen oder Mahlzeitenplänen: Nutze die Whisker-App.
- Die Cloud ist nötig: Ohne Internet kann nichts gelesen oder gesteuert werden.
Konfigurationseinstellungen
Diese Einstellungen fragt Litter-Robot in seinem Konfigurationsbildschirm in Gladys ab.
| Einstellung | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
| Dein Whisker-Konto | section | Nein | Das Konto der Whisker-App, in dem dein Litter-Robot 3 Connect, Litter-Robot 4 oder Feeder-Robot eingerichtet ist. Die Integration liest sie über die Whisker-Cloud, wie die App. Nicht mit Whisker verbunden. |
| E-Mail-Adresse | string | Ja | Die E-Mail-Adresse, mit der du dich in der Whisker-App anmeldest. |
| Passwort | secret | Ja | Das Passwort der Whisker-App. Wird nur an den Anmeldedienst von Whisker gesendet, nie in die Protokolle geschrieben. |
| Optionen | section | Nein | Ein Litter-Robot 4 und ein Feeder-Robot senden ihre Änderungen live; jeder Roboter wird zusätzlich im Intervall unten neu gelesen. |
| Aktualisierungsintervall | select | Nein | Wie oft die Roboter aus der Whisker-Cloud gelesen werden. Die einzige Quelle für einen Litter-Robot 3. |
| Gewichtseinheit | select | Nein | Für das Gewicht der Katze im Widget (Litter-Robot 4). Die Gerätefunktion ist in Gramm. |
| Feeder-Robot: Portionen pro Tag | select | Nein | Höchstens so viele von Gladys ausgegebene Portionen in 24 Stunden, im Abstand von einer Minute, damit eine Szene in einer Schleife den Vorrat nicht leert. Die Mahlzeiten der Whisker-App zählen nicht. |
| Sprache der Funktionsnamen | select | Nein | Namen der Funktionen beim Hinzufügen eines Geräts, und Sprache der Roboterzustände und der Szenenmeldungen. |
So installierst du Litter-Robot in Gladys
- Öffne in Gladys Integrationen: Litter-Robot erscheint im Katalog neben den nativen Integrationen, mit einem Community-Badge.
- Klicke auf Installieren. Gladys lädt das Docker-Image (
ghcr.io/guim31/gladys-litter-robot:1.0.1) herunter, startet es in einer vom Kern isolierten Sandbox und erzeugt die Oberfläche der Integration (Geräte, Erkennung und Konfiguration). - Öffne den Bildschirm Konfiguration der Integration, fülle die Einstellungen aus und speichere.
- Du kannst sie auch direkt über die URL ihres Repositorys installieren: https://github.com/guim31/gladys-litter-robot.
Litter-Robot benötigt Gladys >=5.1.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
Litter-Robot 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 guim31 veröffentlicht und gepflegt, nicht vom Gladys-Kernteam.
- Alle Integrationen durchsuchen, native und aus der Community
- Deine eigene externe Integration bauen und veröffentlichen
- Quellcode auf GitHub — Quelle dieser Dokumentation