Ereigniskanal

Die standardmäßige WebSocket-URL für Ereignisse lautet ws://localhost:10020.

Der Port kann in der Konfiguration geändert werden.

Dies ist ein Kommunikationskanal mit niedriger Frequenz und unidirektionaler Übertragung, über den Sie alle Systemereignisse empfangen können. Eingabenachrichten werden nicht unterstützt.

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

Einheitliches Format

Alle Ereignisse folgen einer Standardstruktur, wie unten dargestellt:

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

Feldbeschreibungen

Feld	Typ	Beschreibung
name	string	Eindeutige Kennung des Ereignisses.
category	string	Gruppierungsbezeichnung zur Filterung und Organisation (siehe gültige Kategorien).
level	string	Schweregrad oder Wichtigkeit des Ereignisses (siehe gültige Stufen).
data	object	Nutzdaten mit ereignisspezifischen Details.
message	string	Optionale, für Menschen lesbare Beschreibung oder Kontext zum Ereignis.

Ereigniskategorie

Das Feld category ordnet Ereignisse den folgenden Gruppen zu:

Wert	Beschreibung
system	Zentrale Kernsysteme, globale Einstellungen usw.
input	Verarbeitung externer Eingaben (z. B. Befehle oder Ähnliches).
session	Ereignisse, die sich auf eine bestimmte Benutzersitzung beziehen.
device	Geräteverwaltung, Controller-Interaktionen, SerialPort-Kommunikation.
module	Ereignisse von Subsystemen oder modularen Komponenten.
feature	Ereignisse, die mit bestimmten Dienstfunktionen verknüpft sind.

Ereignisstufe

Das Feld level gibt den Schweregrad oder die Wichtigkeit eines Ereignisses an:

Wert	Beschreibung
info	Nur informativ – Protokolle, Metriken oder unkritische Hinweise.
notice	Zustandsänderungen oder bemerkenswerte Ereignisse.
warning	Etwas ist schiefgelaufen oder wirkt unstimmig, das System kann jedoch sicher weiterarbeiten.
error	Ein Problem ist aufgetreten, das das Systemverhalten oder die Stabilität beeinträchtigen kann.
critical	Schwerwiegender Fehler, der die Systemfunktionalität erheblich stört.
panic	Katastrophaler Ausfall – kann zu einem Absturz oder einem nicht wiederherstellbaren Zustand führen.

Ereignisse

Info

Diese Liste enthält die aktuell vom System gemeldeten Ereignisse. Wir entwickeln und erweitern Ereignistypen und deren Meldung derzeit aktiv.

Eingabe

invalid-io-channel

Wird ausgelöst, wenn ein E/A-Kanal auf 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	Die empfohlene Alternative.

{
  "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 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 verbunden wurde und nun vollständig betriebsbereit ist.

Feld	Typ	Beschreibung
device_family	string	Gerätetyp: 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

Zeigt an, dass ein zuvor verbundenes Gerät getrennt wurde.

Feld	Typ	Beschreibung
device_family	string	Gerätetyp: 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 mit zu niedriger Rate eintrifft und dabei die Sicherheitsgrenzen erreicht. Dies ist eine Warnung, dass sich die Rate der Abschaltrate nähert.

Feld	Typ	Beschreibung
session_id	int	Ziel-ID der Simulationssitzung.
device_family	string	Gerätetyp: inverse oder verse_grip.
device_id	string	Die eindeutige Kennung des Geräts.
frequency	int	Ihre aktuelle Steuerrate 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 mit zu niedriger Rate eintrifft und dabei die Sicherheitsgrenzen erreicht.

Feld	Typ	Beschreibung
session_id	int	Ziel-ID der Simulationssitzung.
device_family	string	Gerätetyp: inverse oder verse_grip.
device_id	string	Die eindeutige Kennung des Geräts.
frequency	int	Ihre aktuelle Steuerrate 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 ausgegeben, wenn ein FX der SDF-Entität erstellt wird.

Feld	Typ	Beschreibung
session_id	int	Ziel-ID der Simulationssitzung.
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 ausgegeben, wenn ein FX der SDF-Entität gelöscht wird.

Feld	Typ	Beschreibung
session_id	int	Ziel-ID der Simulationssitzung.
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 ein FX der SDF-Entität aktualisiert wird.

Feld	Typ	Beschreibung
session_id	int	Ziel-ID der Simulationssitzung.
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 ausgegeben, wenn der Cursor des angegebenen Geräts in den Bereich der SDF-Entität eintritt.

Feld	Typ	Beschreibung
session_id	int	Ziel-ID der Simulationssitzung.
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 ausgegeben, wenn der Cursor des angegebenen Geräts den Bereich der SDF-Entität verlässt.

Feld	Typ	Beschreibung
session_id	int	Ziel-ID der Simulationssitzung.
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": ""
}