Zum Inhalt springen
SBC-Standard Der Standard für Büchereien

config.get und config.set

Kommandos
config.get, config.set
Bereich
Gerät (config)
Profil
Verwaltbar
Antwort
Schlüssel und Wert bzw. ok

Auftrag und Antwort#

{"v":1,"cmd":"config.get","key":"idle.timeout_s"}
{"v":1,"ok":true,"result":{"key":"idle.timeout_s","value":90}}
{"v":1,"cmd":"config.set","key":"idle.timeout_s","value":120}
{"v":1,"ok":true}

Jede Anzeige entscheidet selbst, welche Schlüssel sie freigibt. Ein unbekannter Schlüssel ergibt 404 unknown_key, ein unbrauchbarer Wert 400 bad_request – in beiden Fällen bleibt die bisherige Einstellung unverändert.

Empfohlene Schlüssel#

Schlüssel Art Bedeutung
idle.timeout_s Zahl Leerlauf bis zum Ruhebild, in Sekunden
saver.timeout_s Zahl Leerlauf bis zum Bildschirmschoner; 0 schaltet ihn ab
farewell.seconds Zahl Vorgabedauer der Verabschiedung
display.lang Text Sprache, in der die Anzeige formuliert, wenn keine mitgesendet wird

Was hier nicht hingehört#

config.set ist für den laufenden Betrieb gedacht, nicht für die Einrichtung: Schriften, Farben, Hintergrundbilder und Layout bleiben Sache der Anzeige und ihrer eigenen Einstellungen.

Ob eine Anzeige gesetzte Werte dauerhaft übernimmt oder nur bis zum nächsten Start, bleibt ihr überlassen. Ein Steuerprogramm darf sich also nicht darauf verlassen, dass ein einmal gesetzter Wert einen Neustart überdauert.