RomM Smart-Home-Integration, kostenlos und Open Source

RomM in Gladys: Spiele und Plattformen deiner Retro-Bibliothek, neue Spiele, Scans.
Bring deinen RomM-Server (die selbst gehostete Verwaltung deiner Retro-Spielebibliothek) ĂŒber dein lokales Netzwerk in Gladys: die Spiele, die Plattformen, die GröĂe der Bibliothek, die Spiele noch ohne Metadaten, die zuletzt hinzugefĂŒgten Spiele auf einem Dashboard, Szenen, die auf ein neues Spiel oder das Ende eines Scans reagieren, und eine Szenenaktion zum Scannen der Bibliothek.
Die Integration wurde mit einem echten RomM 5.4.1 getestet (das offizielle Docker-Image, mit Homebrew-Spielen), noch nicht in einer echten Gladys-Installation: RĂŒckmeldungen sind im Gladys-Forum oder in den Issues willkommen.
Was du brauchstâ
- Gladys Assistant 5.1.0 oder neuer.
- Einen RomM-Server, den Gladys erreicht (gleiches Netzwerk), auf dem Port
seiner WeboberflĂ€che (standardmĂ€Ăig
8080). RomM 5.4 oder neuer, um einen Scan aus Gladys zu starten. - Eine Anmeldung, eine der beiden:
- empfohlen, ein Client-API-Token: Ăffne in RomM dein Profil, dann
Client API tokens, erstelle ein Token mit den Rechten View ROMs,
View platforms und, um die Scans zu sehen und zu starten, Run tasks
(Admin-Konto), und kopiere es (es beginnt mit
rmm_); - oder Benutzername und Passwort eines RomM-Benutzers (ein Admin, um die Scans zu sehen und zu starten).
- empfohlen, ein Client-API-Token: Ăffne in RomM dein Profil, dann
Client API tokens, erstelle ein Token mit den Rechten View ROMs,
View platforms und, um die Scans zu sehen und zu starten, Run tasks
(Admin-Konto), und kopiere es (es beginnt mit
Einrichtungâ
- Installiere die Integration aus dem Gladys-Katalog.
- Gib unter Konfiguration die Adresse von RomM ein (zum Beispiel
192.168.1.2:8080; ohne Port wird8080verwendet), dann das Client-API-Token oder Benutzername und Passwort. - Speichere und klicke auf Verbindung testen: Die Meldung unter der SchaltflĂ€che nennt die Version von RomM, die Spiele und die GröĂe der Bibliothek, die Plattformen und die Spiele ohne Metadaten.
- Ăffne den Tab Entdecken: ein GerĂ€t fĂŒr den Server. Klicke auf HinzufĂŒgen, wĂ€hle einen Raum und speichere.
Optionen:
- Aktualisierungsintervall: 1 bis 10 Minuten (standardmĂ€Ăig 2 Minuten). Jede Aktualisierung sind fĂŒnf kleine Anfragen an die API von RomM.
- Sprache der Funktionsnamen: die Namen der Funktionen beim HinzufĂŒgen des GerĂ€ts (standardmĂ€Ăig Französisch) und die SĂ€tze der Szenenaktionen.
Die Integration liest RomM. Etwas Àndert sie nur, wenn du es verlangst: die SchaltflÀche Scannen des Widgets und die Szenenaktion RomM-Bibliothek scannen.
Das GerĂ€tâ
Ein GerÀt, RomM gefolgt von der Adresse des Servers:
| Funktion | Was sie liefert |
|---|---|
| Online | 1, wenn RomM antwortet, sonst 0 |
| Plattformen | Plattformen mit Spielen in der Bibliothek |
| Spiele | Spiele in der Bibliothek |
| GröĂe der Bibliothek | GröĂe der Spieldateien auf der Festplatte, in GB |
| Spiele ohne Metadaten | Spiele, die RomM keiner Metadatenquelle zuordnen konnte |
| Zuletzt hinzugefĂŒgtes Spiel | sein Name und seine Plattform, als Text |
Die Zahlen Àndern sich bei jeder Aktualisierung.
Dashboardâ
Das Widget RomM zeigt drei Kacheln (Spiele, Plattformen, Spiele ohne Metadaten), den laufenden Scan mit seinem Fortschritt, die Liste der zuletzt hinzugefĂŒgten Spiele (Name, Plattform und Datum) und eine SchaltflĂ€che Scannen, die einen schnellen Scan startet (nur neue Spiele).
FĂŒge es im Dashboard-Editor hinzu. Einstellungen: die Anzahl der Spiele in der Liste (3, 5 oder 8), ein Schalter zum Ausblenden der Kacheln und einer zum Ausblenden der SchaltflĂ€che. Es funktioniert schon vor dem HinzufĂŒgen des GerĂ€ts.
Szenenâ
Auslöserâ
- Spiel in RomM hinzugefĂŒgt: Ein neues Spiel ist in der RomM-Bibliothek
erschienen (nach einem Scan oder Upload). Filter: Plattform (der Name der
Plattform, genau wie RomM ihn anzeigt, zum Beispiel
Game Boy Advance; leer: beliebig). An die Aktionen weitergegebene Informationen: der Name des Spiels, seine Plattform, sein Dateiname, der Link zum Spiel in RomM und die Anzahl der Spiele in der Bibliothek. Solange RomM noch die Metadaten eines Spiels sucht, wartet das Ereignis auf seinen endgĂŒltigen Namen (höchstens 30 Minuten). - RomM-Scan beendet: Ein Scan der Bibliothek ist beendet, egal wer ihn
gestartet hat (Gladys, die WeboberflÀche von RomM, ihr Zeitplan).
Informationen: der Scan-Typ, wie RomM ihn nennt (
Quick ScanâŠ), die neuen, die erkannten und die gescannten Spiele (von RomM gezĂ€hlt), die Spiele in der Bibliothek und die Dauer in Minuten. Braucht ein Konto, das die Aufgaben sieht (Admin oder Token mit Run tasks).
Jedes Ereignis wird nur einmal gemeldet, auch nach einem Neustart der Integration. Was RomM beim Start der Integration schon hatte, wird nicht gemeldet.
Aktionenâ
- RomM-Bibliothek scannen: startet einen Scan wie die SchaltflÀche Scan von RomM. Option Was scannen: Nur neue Spiele (schnell) (Standard), Spiele ohne Metadaten (um die Metadatenquellen erneut zu versuchen) oder Ganze Bibliothek (vollstÀndig, langsam). Braucht RomM 5.4 oder neuer und ein Admin-Konto (oder ein Token mit Run tasks). LÀuft schon ein Scan, schlÀgt die Aktion fehl.
- Neueste RomM-Spiele lesen: liest RomM sofort und liefert einen Satz fĂŒr eine Nachricht oder Sprachansage, etwa âRomM: 152 Spiele auf 6 Plattformen. Zuletzt hinzugefĂŒgt: Tobu Tobu Girl (Game Boy), âŠâ, mit den Zahlen getrennt (Spiele, Plattformen, Spiele ohne Metadaten, Name und Plattform des zuletzt hinzugefĂŒgten Spiels). Option: die Anzahl der im Satz genannten Spiele (standardmĂ€Ăig 3).
Szenenideenâ
- Jede Nacht um 3 Uhr die RomM-Bibliothek scannen; wenn der Scan mit neuen Spielen beendet ist, dir eine Nachricht schicken: â{new_games} neue(s) Spiel(e) in RomMâ.
- Wenn ein Spiel auf der Plattform Game Boy Advance hinzugefĂŒgt wird, die Kinder benachrichtigen: âNeues Spiel: {name}â.
- Am Samstagmorgen die neuesten RomM-Spiele lesen und den Satz ĂŒber den Lautsprecher im Wohnzimmer ansagen.
Fehlerbehebungâ
- âRomM antwortet nichtâ: PrĂŒfe die Adresse und den Port (
8080) und ob Gladys den Server erreicht (gleiches Netzwerk, Firewall). - âRomM hat die Anmeldung abgelehntâ: Kopiere das Client-API-Token erneut (ein Token kann ablaufen oder widerrufen werden) oder prĂŒfe Benutzername und Passwort.
- âDieses Konto kann die Spiele nicht lesenâ: Dem Token fehlen die Rechte View ROMs und View platforms: Erstelle ein neues mit diesen Rechten.
- âEin Scan braucht ein Admin-Kontoâ: Der Benutzer ist kein Admin oder dem Token fehlt Run tasks. Die Spiele werden weiter gelesen; RomM-Scan beendet löst nicht aus.
- âEinen Scan aus Gladys zu starten braucht RomM 5.4 oder neuerâ: Aktualisiere RomM; Ă€ltere Versionen starten einen Scan nur aus ihrer WeboberflĂ€che.
- âKein RomM unter dieser Adresseâ: Ein anderer Dienst antwortet auf diesem Port.
- âDie Adresse leitet umâ: Ein Reverse-Proxy leitet auf eine Anmeldeseite oder auf HTTPS um; gib die direkte Adresse von RomM in deinem Netzwerk ein.
- Mehr Details: Setze das
LOG_LEVELder Integration aufdebugund öffne ihre Protokolle.
Grenzenâ
- Die Zahlen und die Ereignisse sind so frisch wie das Aktualisierungsintervall.
- Nur die 10 neuesten Spiele werden bei jeder Aktualisierung verglichen: Bei mehr als 10 neuen Spielen auf einmal (ein ganzer Ordner kopiert) werden die Spiele gezÀhlt, aber nicht alle gemeldet.
- Die Zahlen von RomM-Scan beendet sind die von RomM, das weniger Spiele zÀhlen kann, als wirklich hinzugekommen sind.
- Kein Cover im Widget: Die Cover von RomM brauchen eine Anmeldung, die das Dashboard nicht hat.
- Die Integration ist fĂŒr die API von RomM 5 geschrieben (getestet mit 5.4.1): Eine kĂŒnftige Version, die sie Ă€ndert, kann ein Update erfordern.
- Nicht mit RomM verbunden.
Konfigurationseinstellungenâ
Diese Einstellungen fragt RomM in seinem Konfigurationsbildschirm in Gladys ab.
| Einstellung | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
| RomM-Server | section | Nein | Adresse von RomM und Anmeldung. Die Integration liest die Bibliothek; sie startet einen Scan nur, wenn du es verlangst. |
| Adresse | string | Nein | IP-Adresse oder Name des Servers, mit dem Port der WeboberflĂ€che (standardmĂ€Ăig 8080). |
| Client-API-Token | secret | Nein | Empfohlen: Profil â Client API tokens in RomM, mit View ROMs, View platforms und Run tasks. Sonst die zwei Felder darunter. |
| Benutzername | string | Nein | Nur ohne Token: ein RomM-Benutzer (Admin, um Scans zu sehen und zu starten). |
| Passwort | secret | Nein | |
| Aktualisierungsintervall | select | Nein | Wie oft RomM gelesen wird: neue Spiele, Zahlen, Scans. |
| Sprache der Funktionsnamen | select | Nein | Namen der Funktionen beim HinzufĂŒgen des GerĂ€ts und SĂ€tze der Szenenaktionen. |
So installierst du RomM in Gladysâ
- Ăffne in Gladys Integrationen: RomM erscheint im Katalog neben den nativen Integrationen, mit einem Community-Badge.
- Klicke auf Installieren. Gladys lÀdt das Docker-Image (
ghcr.io/guim31/gladys-romm:1.0.0) 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-romm.
RomM 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â
RomM 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