Nachrichten Client → Server

Nachrichtenformat

Jede Nachricht ist ein JSON-Objekt mit genau einem Schlüssel der obersten Ebene, der den Befehl identifiziert. Der Wert ist ein Objekt, dessen Struktur vom Befehl abhängt.

Alle Client-Befehlsschlüssel stehen in GROSSBUCHSTABEN (z. B. DU, SV, SA, GC).

Befehlsübersicht

Alle Nachrichten, die ein Modul oder eine Property ansprechen, verwenden folgende Struktur:

{
  "COMMANDE": {
    "m": {
      "NomDuModule": {
        "p": {
          "nomDeLaPropriété": { ... }
        }
      }
    }
  }
}

wobei m für modules und p für properties steht.

Sitzungsverwaltung

DU — Vollständigen Dump anfordern

Muss unmittelbar nach der Verbindung gesendet werden. Der Server antwortet mit einer d-Nachricht, die alle Module enthält.

{ "DU": { "language": "fr" } }

XX — Heartbeat

Alle 30 Sekunden zu senden, um die Verbindung aktiv zu halten. Der Server antwortet mit xx.

{ "XX": {} }

LO — Anmeldung

Erforderlich, wenn der Server die Zugriffskontrolle aktiviert hat (grant-client ist "-1" in der Dump-Antwort).

{
  "LO": {
    "user": "username",
    "pw": "password",
    "language": "fr"
  }
}

IL — Sprache ändern

Ändert die Sprache der übersetzten Bezeichnungen ohne erneute Verbindung.

{ "IL": { "language": "fr" } }

Aktualisierung von Property-Werten

SV — Wert eines einzelnen Elements senden

Zu verwenden, wenn directedit beim Element true ist — sendet den Wert eines einzelnen Elements sofort. Bei einem Element mit directedit: false lehnt das Backend es ab (Fehler im Modul-Log, nichts wird angewendet): stattdessen SA verwenden.

{
  "SV": {
    "m": {
      "Focus": {
        "p": {
          "parameters": {
            "e": {
              "iterations": 7
            }
          }
        }
      }
    }
  }
}

e enthält genau ein Paar Elementname: Wert.

SA — Alle Elementwerte senden

Wird verwendet, um alle editierbaren Elemente einer Property auf einmal zu übermitteln (z. B. aus einem Formular). Wird auch verwendet, wenn directedit false ist.

{
  "SA": {
    "m": {
      "Focus": {
        "p": {
          "parameters": {
            "e": {
              "iterations": 7,
              "exposure": 3.5,
              "active": true
            }
          }
        }
      }
    }
  }
}

DP — Property-Dump anfordern

Bittet den Server, den vollständigen Zustand einer Property erneut zu senden, als wäre sie gerade (neu) geladen worden — nützlich, um eine Property zu aktualisieren, bei der ein Client eine Desynchronisation vermutet, ohne das ganze Modul neu zu laden. Der Server antwortet mit einer ap-Nachricht für genau diese Property.

{
  "DP": {
    "m": {
      "Focus": {
        "p": {
          "parameters": {}
        }
      }
    }
  }
}

Kein e-Feld: DP bezieht sich auf die gesamte Property, nicht auf ein einzelnes Element.

Icon-Aktionen

preicon1/preicon2/posticon1/posticon2 (Properties) und preicon/posticon (Elemente, siehe Datenmodell) sind keine Dekoration: jedes ist eine klickbare Aktion. Ein nicht-leerer Wert ist der Name des zu rendernden Google-Fonts-Icons (Material Icons); ein Klick darauf sendet den passenden Befehl unten, ganz ohne Wert oder Parameter — ein leeres Payload, das einfach die Property (oder das Element) adressiert. Was die Aktion serverseitig tatsächlich tut (Profil speichern, Profil laden, Prozess starten…), entscheidet allein das Modul; die einzige Aufgabe des Clients ist, das Icon zu rendern und den Klick unverändert weiterzugeben.

Ein leerer String bedeutet, dass an dieser Stelle kein Icon vorhanden ist — nichts zu rendern, folglich nichts zu klicken oder zu senden. Für ein leeres Icon-Feld sollte weder ein Platzhalter gerendert noch ein Klick-Handler registriert werden.

I1 — Klick auf preicon1 der Property

{
  "I1": {
    "m": {
      "Focus": {
        "p": {
          "saveprofile": {}
        }
      }
    }
  }
}

I2 — Klick auf preicon2 der Property

{
  "I2": {
    "m": {
      "Focus": {
        "p": {
          "loadprofile": {}
        }
      }
    }
  }
}

I3 — Klick auf posticon1 der Property

Gleiche Struktur wie I1 / I2.

I4 — Klick auf posticon2 der Property

Gleiche Struktur wie I1 / I2.

J1 — Klick auf preicon des Elements

{
  "J1": {
    "m": {
      "Focus": {
        "p": {
          "devices": {
            "e": {
              "myDevice": {}
            }
          }
        }
      }
    }
  }
}

J2 — Klick auf posticon des Elements

Gleiche Struktur wie J1.

Profilverwaltung

PL — Profil laden

{
  "PL": {
    "m": {
      "Focus": {
        "profile": "myProfile"
      }
    }
  }
}

Der Server antwortet mit einer fl-Nachricht (Profil geladen) und sendet anschließend die aktualisierten Property-Werte.

PS — Profil speichern

{
  "PS": {
    "m": {
      "Focus": {
        "profile": "myProfile"
      }
    }
  }
}

Der Server antwortet mit einer fs-Nachricht (Profil gespeichert).

Grid-Operationen

Grid-Befehle betreffen eine bestimmte Property innerhalb eines Moduls. Alle verwenden die m / p-Struktur.

GC — Grid-Zeile erstellen

Fügt der Grid eine neue Zeile mit den übergebenen Elementwerten hinzu.

{
  "GC": {
    "m": {
      "Sequencer": {
        "p": {
          "sequence": {
            "e": {
              "target": "M31",
              "exposure": 120,
              "count": 10
            }
          }
        }
      }
    }
  }
}

Der Server antwortet mit einer gc-Nachricht, die den Index der neuen Zeile bestätigt.

GU — Grid-Zeile aktualisieren

Aktualisiert eine bestimmte Zeile (nullbasierter Index i) mit neuen Elementwerten.

{
  "GU": {
    "m": {
      "Sequencer": {
        "p": {
          "sequence": {
            "i": 1,
            "e": {
              "target": "M42",
              "exposure": 60
            }
          }
        }
      }
    }
  }
}

GD — Grid-Zeile löschen

Löscht die Zeile mit Index i (nullbasiert).

{
  "GD": {
    "m": {
      "Sequencer": {
        "p": {
          "sequence": {
            "i": 0
          }
        }
      }
    }
  }
}

GF — Grid-Zeile auswählen

Fordert den Server auf, eine Grid-Zeile in die editierbaren Elemente der Property zu laden (wird verwendet, wenn eine Zeile zur Bearbeitung angeklickt wird).

{
  "GF": {
    "m": {
      "Sequencer": {
        "p": {
          "sequence": {
            "i": 2
          }
        }
      }
    }
  }
}

GH — Grid-Zeile nach oben verschieben

Verschiebt die Zeile mit Index i um eine Position nach oben.

{
  "GH": {
    "m": {
      "Sequencer": {
        "p": {
          "sequence": {
            "i": 3
          }
        }
      }
    }
  }
}

GB — Grid-Zeile nach unten verschieben

Verschiebt die Zeile mit Index i um eine Position nach unten.

{
  "GB": {
    "m": {
      "Sequencer": {
        "p": {
          "sequence": {
            "i": 2
          }
        }
      }
    }
  }
}

GR — Grid zurücksetzen

Leert das gesamte Grid einer Property (alle Zeilen entfernt) — nicht nur eine einzelne Zeile wie GD. Der Server sendet daraufhin gr.

{
  "GR": {
    "m": {
      "Sequencer": {
        "p": {
          "sequence": {}
        }
      }
    }
  }
}

Kein i-Feld: GR bezieht sich auf das gesamte Grid, nicht auf eine einzelne Zeile.

Modul-Lebenszyklus

CL — Konfiguration laden

Lädt alle Module einer gespeicherten Konfiguration (Liste in controllerdata.availableconfs, siehe Controller).

{ "CL": { "name": "modules" } }

CS — Aktuelle Konfiguration speichern

Speichert die Menge der aktuell geladenen Module unter dem angegebenen Namen (GlobalDatastore ist nie enthalten).

{ "CS": { "name": "modules" } }

ML — Modul laden

Fordert den Server auf, ein Modul dynamisch zu laden. Diese Befehle richten sich an den Controller: der Payload verwendet nicht den m/p-Umschlag.

{ "ML": { "lib": "focus", "label": "MyFocuser", "profile": "default" } }

{ "ML": { "lib": "libostdummy", "label": "MyDummy" } }

Error loading library MyDummy - Cannot load library libostlibostdummy: cannot open shared object file: No such file or directory

{ "ML": { "lib": "dummy", "label": "MyDummy" } }

MK — Modul entladen

Fordert den Server auf, ein laufendes Modul zu entladen, bezeichnet durch seinen Namen.

{ "MK": { "name": "MyFocuser" } }

GlobalDatastore kann nicht entladen werden: die Anfrage wird abgelehnt (Fehlermeldung in den Logs).

Modul abfragen

QY — Modul abfragen

Generischer, pro Modul definierter Anfrage-/Antwort-Mechanismus: einem Modul eine benannte Frage mit Parametern stellen, eine benannte Antwort über qa zurückerhalten. Welche Anfragenamen ein Modul tatsächlich versteht (falls überhaupt), entscheidet allein das Modul — das Protokoll definiert nur die Hülle. Zu beachten: keine p-Hülle hier, QY adressiert das Modul selbst, nicht eine seiner Properties.

{
  "QY": {
    "m": {
      "Sequencer": {
        "query": "profileduration",
        "params": { "profile": "default" }
      }
    }
  }
}

Dateisystem

FS — Überwachten Ordner wählen

Bestimmt den Ordner, dessen Dateiliste der Server veröffentlicht (siehe Dateisystem). Der Pfad ist relativ zum Webroot; die leere Zeichenkette bezeichnet das Wurzelverzeichnis.

{ "FS": { "folder": "/Sequencer/gam Cyg/LIGHT/Luminance" } }

Die Änderung gilt global für den Server (alle Clients sehen die neue Liste). Der Pfad wird nicht validiert: ein nicht existierender Ordner ergibt eine leere Liste.

Steuerung des eingebetteten INDI-Servers

Diese Befehle sind nur verfügbar, wenn der Server über eine eingebettete INDI-Instanz verfügt.

YA und YZ haben keinen Payload ({"YA": {}}). Bei YL, YR, YS, YC und YD ist driver das Feld binary eines Eintrags aus controllerdata.indidrivers. Bei YK ist name ein Schlüssel von controllerdata.indiconfigurations (siehe Controller) — es startet alle unter diesem Namen gespeicherten Treiber, unabhängig von CL/CS, die die aktiven Treiber stattdessen in eine Modulkonfiguration bündeln.

Zusammenfassung der Zugriffskontrolle

Befehle, die ohne ausreichende Rechte gesendet werden, werden vom Server stillschweigend ignoriert.