Ereignis-Kanal

Die Standard-URL für den Ereignis-Websocket lautet ws://localhost:10020.

Der Port kann in der Konfiguration geändert werden.

Dies ist ein unidirektionaler Kommunikationskanal mit niedriger Frequenz, über den Sie alle Systemereignisse empfangen können. Es werden keine Eingangsmeldungen unterstützt.

Dieser Kanal garantiert, dass für jedes Ereignis eine Nachricht gesendet wird.

Kanonisches Format

Alle Veranstaltungen folgen einer Standardstruktur, wie unten dargestellt:

{
  "name": "device-connected",
  "category": "device",
  "level": "notice",
  "data": {},
  "message": ""
}

Feldbeschreibungen

Feld	Typ	Beschreibung
name	string	Eindeutiger Bezeichner für das Ereignis.
category	string	Gruppierungsetikett, das zur Filterung und Organisation verwendet wird (siehe gültige Kategorien).
level	string	Schwere oder Bedeutung des Ereignisses (siehe gültige Stufen).
data	object	Payload mit ereignisspezifischen Details.
message	string	Optionale, von Menschen lesbare Beschreibung oder Kontext für das Ereignis.

Kategorie der Veranstaltung

Die category sind die Ereignisse in die folgenden Gruppen unterteilt:

Wert	Beschreibung
system	Kern- oder Zentralsysteme, globale Einstellungen, usw.
input	Behandlung externer Eingaben (z. B. Befehle oder andere).
session	Ereignisse, die sich auf eine bestimmte Benutzersitzung beziehen.
device	Geräteverwaltung, Controller-Interaktionen, SerialPort-Kommunikation.
module	Ereignisse des Subsystems oder der modularen Komponente.
feature	Ereignisse, die an bestimmte Dienstmerkmale oder Fähigkeiten gebunden sind.

Ereignis-Ebene

Die Veranstaltung level gibt den Schweregrad oder die Bedeutung eines Ereignisses an:

Wert	Beschreibung
info	Nur zur Information - Protokolle, Metriken oder unkritische Hinweise.
notice	Staatliche Änderungen oder bemerkenswerte Ereignisse.
warning	Etwas ist schief gelaufen oder scheint nicht in Ordnung zu sein, aber das System kann sicher weiterlaufen.
error	Es ist ein Problem aufgetreten, das das Systemverhalten oder die Stabilität beeinträchtigen kann.
critical	Schwerer Fehler, der die Systemfunktionalität erheblich stört.
panic	Katastrophales Versagen - kann zu einem Absturz oder einem nicht wiederherstellbaren Zustand führen.

Veranstaltungen

Infos

Diese Liste ist die aktuelle Liste der Ereignisse, die derzeit vom System gemeldet werden. Wir arbeiten aktiv an der Entwicklung und Erweiterung von Ereignistypen und Berichten.

Eingabe

invalid-io-channel

Wird ausgelöst, wenn ein E/A-Kanal auf eine nicht unterstützte oder unbeabsichtigte Weise verwendet wird.

Daten

Feld	Typ	Beschreibung
received_data	string	Die empfangenen Rohdaten.

{
  "name": "invalid-io-channel",
  "category": "input",
  "level": "warning",
  "data": {
    "received_data": "<raw_input_here>"
  }
}

http-route-deprecated

Wird ausgegeben, wenn eine HTTP-Route veraltet ist und in einer zukünftigen Version entfernt wird.

Daten

Feld	Typ	Beschreibung
route	string	Die veraltete Route.
substitute	string	Der empfohlene Ersatz.

{
  "name": "http-route-deprecated",
  "category": "input",
  "level": "warning",
  "data": {
    "route": "/the/old/way",
    "substitute": "/the/new/way"
  }
}

settings-invalid-key

Wird ausgegeben, wenn ein Einstellungsschlüssel ungültig ist.

Daten

Feld	Typ	Beschreibung
key	string	Der Schlüssel, der nicht gefunden wurde.

{
  "name": "settings-invalid-key",
  "category": "input",
  "level": "warning",
  "data": {
    "key": "devices/none-existent/key"
  }
}

command-deprecated

Wird ausgegeben, wenn ein eingehender Befehl veraltet ist und in einer zukünftigen Version entfernt werden wird.

Feld	Typ	Beschreibung
command	string	Der empfangene veraltete Befehl

{
  "name": "command-deprecated",
  "category": "input",
  "level": "warning",
  "data": {
    "command": "example_cmd"
  },
  "message": "The command `example_cmd` is deprecated and is replaced by `this_one`."
}

Gerät

device-connected

Zeigt an, dass ein Gerät eine Verbindung hergestellt hat und nun voll funktionsfähig ist.

Feld	Typ	Beschreibung
device_family	string	Typ des Geräts: inverse oder verse_grip.
device_id	string	Die eindeutige Kennung des Geräts.

{
  "name": "device-connected",
  "category": "device",
  "level": "notice",
  "data": {
    "device_family": "inverse",
    "device_id": "04BA"
  }
}

device-disconnected

Bedeutet, dass ein zuvor verbundenes Gerät getrennt wurde.

Feld	Typ	Beschreibung
device_family	string	Typ des Geräts: inverse oder verse_grip.
device_id	string	Die eindeutige Kennung des Geräts.

{
  "name": "device-disconnected",
  "category": "device",
  "level": "notice",
  "data": {
    "device_family": "verse_grip",
    "device_id": "61548"
  }
}

Sitzung

device-low-control-rate

Wird ausgegeben, wenn ein eingehender direkter Steuerbefehl für ein Gerät eine zu niedrige Drehzahl erreicht und die Sicherheitsgrenzwerte erreicht. Dies ist eine Warnung, dass sich die Drehzahl der Abschaltdrehzahl nähert.

Feld	Typ	Beschreibung
session_id	int	ID der Zielsimulationssitzung.
device_family	string	Typ des Geräts: inverse oder verse_grip.
device_id	string	Die eindeutige Kennung des Geräts.
frequency	int	Ihre aktuelle Regelungsfrequenz in Hertz.

{
  "name": "device-low-control-rate",
  "category": "session",
  "level": "warning",
  "data": {
    "session_id": 3,
    "device_family": "inverse",
    "device_id": "1A2B",
    "frequency": 260
  },
  "message": ""
}

device-critical-control-rate

Wird ausgegeben, wenn ein eingehender direkter Steuerbefehl für ein Gerät eine zu niedrige Rate erreicht und die Sicherheitsgrenzwerte erreicht.

Feld	Typ	Beschreibung
session_id	int	ID der Zielsimulationssitzung.
device_family	string	Typ des Geräts: inverse oder verse_grip.
device_id	string	Die eindeutige Kennung des Geräts.
frequency	int	Ihre aktuelle Regelungsfrequenz in Hertz.

{
  "name": "device-critical-control-rate",
  "category": "session",
  "level": "error",
  "data": {
    "session_id": 3,
    "device_family": "inverse",
    "device_id": "1A2B",
    "frequency": 82
  },
  "message": ""
}

Funktionen

sdf-sdf_hfx-created

Wird bei der Erstellung einer SDF-Entität FX ausgegeben.

Feld	Typ	Beschreibung
session_id	int	ID der Zielsimulationssitzung.
device_id	string	Die eindeutige Kennung des Geräts.
hfx_id	string	Die FX-ID, mit der es erstellt wurde.

{
  "name": "sdf-sdf_hfx-created",
  "category": "feature",
  "level": "notice",
  "data": {
    "session_id": 3,
    "device_id": "1A2B",
    "hfx_id": "my_fx_name"
  },
  "message": ""
}

sdf-sdf_hfx-deleted

Wird ausgelöst, wenn eine SDF-Entität „FX“ gelöscht wird.

Feld	Typ	Beschreibung
session_id	int	ID der Zielsimulationssitzung.
device_id	string	Die eindeutige Kennung des Geräts.
hfx_id	string	Die gelöschte FX-ID.

{
  "name": "sdf-sdf_hfx-deleted",
  "category": "feature",
  "level": "notice",
  "data": {
    "session_id": 3,
    "device_id": "1A2B",
    "hfx_id": "my_fx_name"
  },
  "message": ""
}

sdf-sdf_hfx-updated

Wird ausgegeben, wenn eine SDF-Entität FX aktualisiert wird.

Feld	Typ	Beschreibung
session_id	int	ID der Zielsimulationssitzung.
device_id	string	Die eindeutige Kennung des Geräts.
hfx_id	string	Die aktualisierte FX-ID.

{
  "name": "sdf-sdf_hfx-updated",
  "category": "feature",
  "level": "notice",
  "data": {
    "session_id": 3,
    "device_id": "1A2B",
    "hfx_id": "my_fx_name"
  },
  "message": ""
}

sdf-sdf_hfx-range-entered

Wird ausgelöst, wenn der Cursor des angegebenen Geräts in den Bereich der SDF-Entität eintritt.

Feld	Typ	Beschreibung
session_id	int	ID der Zielsimulationssitzung.
device_id	string	Die eindeutige Kennung des Geräts.
hfx_id	string	Die FX-ID.

{
  "name": "sdf-sdf_hfx-range-entered",
  "category": "feature",
  "level": "notice",
  "data": {
    "session_id": 3,
    "device_id": "1A2B",
    "hfx_id": "my_fx_name"
  },
  "message": ""
}

sdf-sdf_hfx-range-exited

Wird ausgelöst, wenn der Cursor des angegebenen Geräts den Bereich der SDF-Entität verlässt.

Feld	Typ	Beschreibung
session_id	int	ID der Zielsimulationssitzung.
device_id	string	Die eindeutige Kennung des Geräts.
hfx_id	string	Die FX-ID.

{
  "name": "sdf-sdf_hfx-range-exited",
  "category": "feature",
  "level": "notice",
  "data": {
    "session_id": 3,
    "device_id": "1A2B",
    "hfx_id": "my_fx_name"
  },
  "message": ""
}