Veranstaltungskanal

Die Standard-WebSocket-URL für Ereignisse lautet ws://localhost:10020ist.

Der Port kann in den Einstellungen geändert werden.

Dieser Kanal ist ein einseitiger Kommunikationskanal mit geringer Frequenz, über den alle Ereignisse des Systems empfangen werden können. Eingangsnachrichten werden nicht unterstützt.

Dieser Kanal stellt sicher, dass bei jedem Ereignis eine Nachricht gesendet wird.

Standardformat

Alle Veranstaltungen folgen der folgenden Standardstruktur:

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

Feldbeschreibung

Feld	Typ	Beschreibung
`name`	`string`	Dies ist die eindeutige Kennung des Ereignisses.
`category`	`string`	Dies sind Gruppenbezeichnungen, die zum Filtern und Konfigurieren verwendet werden (siehe „Gültige Kategorien“).
`level`	`string`	Dies ist der Schweregrad oder die Wichtigkeit des Ereignisses (siehe gültige Stufen).
`data`	`object`	Dies ist die Nutzlast mit detaillierten Informationen zu den einzelnen Ereignissen.
`message`	`string`	Dies sind optionale Erläuterungen oder Hintergrundinformationen zum Ereignis.

Veranstaltungskategorie

category Field unterteilt Ereignisse in folgende Gruppen:

Wert	Beschreibung
`system`	Dazu gehören Kern- oder Zentralsysteme sowie globale Einstellungen.
`input`	Verarbeitung externer Eingaben (z. B. Befehle usw.).
`session`	Es handelt sich um ein Ereignis, das mit einer bestimmten Benutzersitzung zusammenhängt.
`device`	Geräteverwaltung, Interaktion mit Controllern und SerialPort-Kommunikation.
`module`	Es handelt sich um ein Ereignis eines Subsystems oder einer modularen Komponente.
`feature`	Es handelt sich um ein Ereignis, das mit bestimmten Servicefunktionen oder -kapazitäten in Verbindung steht.

Veranstaltungsstufe

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

Wert	Beschreibung
`info`	Nur zu Informationszwecken – Protokolle, Metriken oder unwichtige Benachrichtigungen.
`notice`	Es handelt sich um eine Statusänderung oder ein bemerkenswertes Ereignis.
`warning`	Es ist ein Problem aufgetreten oder eine Anomalie wurde festgestellt, das System kann jedoch weiterhin sicher betrieben werden.
`error`	Es ist ein Problem aufgetreten, das den Betrieb oder die Stabilität des Systems beeinträchtigen könnte.
`critical`	Es handelt sich um einen schwerwiegenden Fehler, der die Systemfunktionen erheblich beeinträchtigt.
`panic`	Schwerwiegender Fehler – kann zu einem Systemabsturz oder einem nicht behebbaren Zustand führen.

Veranstaltung

Informationen

Diese Liste enthält die aktuellsten Ereignisse, die vom System gemeldet werden. Wir arbeiten kontinuierlich daran, die Ereignistypen und die Art der Meldung weiterzuentwickeln und zu erweitern.

Eingabe

`invalid-io-channel`

Dies tritt auf, wenn ein E/A-Kanal nicht unterstützt wird oder auf unbeabsichtigte Weise verwendet wird.

Daten

Feld	Typ	Beschreibung
`received_data`	`string`	Dies sind die empfangenen Rohdaten.

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

`http-route-deprecated`

Dies tritt auf, wenn eine HTTP-Route nicht mehr unterstützt wird und in zukünftigen Versionen entfernt werden soll.

Daten

Feld	Typ	Beschreibung
`route`	`string`	Diese Route wird nicht mehr unterstützt.
`substitute`	`string`	Dies ist ein empfohlener Ersatz.

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

`settings-invalid-key`

Dies tritt auf, wenn der Konfigurationsschlüssel ungültig ist.

Daten

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

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

`command-deprecated`

Dies tritt auf, wenn der empfangene Befehl nicht mehr unterstützt wird und in zukünftigen Versionen entfernt werden soll.

Feld	Typ	Beschreibung
`command`	`string`	Erhaltene Anordnung zur Einstellung der Unterstützung

{
  "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 das Gerät verbunden ist und voll funktionsfähig ist.

Feld	Typ	Beschreibung
`device_family`	`string`	Gerätetyp: `inverse` oder `verse_grip`.
`device_id`	`string`	Dies ist die eindeutige Kennung des Geräts.

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

`device-disconnected`

Dies zeigt an, dass die Verbindung zu einem zuvor verbundenen Gerät getrennt wurde.

Feld	Typ	Beschreibung
`device_family`	`string`	Gerätetyp: `inverse` oder `verse_grip`.
`device_id`	`string`	Dies ist 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`

Dies tritt auf, wenn die Geschwindigkeit der direkt an das Gerät gesendeten Steuerbefehle so niedrig ist, dass die Sicherheitsgrenze erreicht wird. Dies ist eine Warnung, die darauf hinweist, dass die Geschwindigkeit sich der Sperrgeschwindigkeit nähert.

Feld	Typ	Beschreibung
`session_id`	`int`	Dies ist die ID der betreffenden Simulationssitzung.
`device_family`	`string`	Gerätetyp: `inverse` oder `verse_grip`.
`device_id`	`string`	Dies ist die eindeutige Kennung des Geräts.
`frequency`	`int`	Dies ist die aktuelle Regelungsfrequenz (in Hz).

{
  "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`

Dies tritt auf, wenn die Geschwindigkeit der direkt an das Gerät gesendeten Steuerbefehle so niedrig ist, dass die Sicherheitsgrenze erreicht wird.

Feld	Typ	Beschreibung
`session_id`	`int`	Dies ist die ID der betreffenden Simulationssitzung.
`device_family`	`string`	Gerätetyp: `inverse` oder `verse_grip`.
`device_id`	`string`	Dies ist die eindeutige Kennung des Geräts.
`frequency`	`int`	Dies ist die aktuelle Regelungsfrequenz (in Hz).

{
  "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`

Dies tritt auf, wenn ein SDF-Entity-FX erstellt wird.

Feld	Typ	Beschreibung
`session_id`	`int`	Dies ist die ID der betreffenden Simulationssitzung.
`device_id`	`string`	Dies ist die eindeutige Kennung des Geräts.
`hfx_id`	`string`	Dies ist die FX-ID, die bei der Erstellung verwendet 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`

Dies tritt auf, wenn die SDF-Entität „FX“ gelöscht wird.

Feld	Typ	Beschreibung
`session_id`	`int`	Dies ist die ID der betreffenden Simulationssitzung.
`device_id`	`string`	Dies ist die eindeutige Kennung des Geräts.
`hfx_id`	`string`	Dies ist eine 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`

Dies tritt auf, wenn das SDF-Entity FX aktualisiert wird.

Feld	Typ	Beschreibung
`session_id`	`int`	Dies ist die ID der betreffenden Simulationssitzung.
`device_id`	`string`	Dies ist die eindeutige Kennung des Geräts.
`hfx_id`	`string`	Dies ist 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`

Dies geschieht, wenn der Cursor des angegebenen Geräts in den Bereich einer SDF-Entität eintritt.

Feld	Typ	Beschreibung
`session_id`	`int`	Dies ist die ID der betreffenden Simulationssitzung.
`device_id`	`string`	Dies ist die eindeutige Kennung des Geräts.
`hfx_id`	`string`	Dies ist 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`

Tritt auf, wenn der Cursor des ausgewählten Geräts den Bereich der SDF-Entität verlässt.

Feld	Typ	Beschreibung
`session_id`	`int`	Dies ist die ID der betreffenden Simulationssitzung.
`device_id`	`string`	Dies ist die eindeutige Kennung des Geräts.
`hfx_id`	`string`	Dies ist 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": ""
}

Standardformat​

Feldbeschreibung​

Veranstaltungskategorie​

Veranstaltungsstufe​

Veranstaltung​

Eingabe​

invalid-io-channel​

http-route-deprecated​

settings-invalid-key​

command-deprecated​

Gerät​

device-connected​

device-disconnected​

Sitzung​

device-low-control-rate​

device-critical-control-rate​

Funktionen​

sdf-sdf_hfx-created​

sdf-sdf_hfx-deleted​

sdf-sdf_hfx-updated​

sdf-sdf_hfx-range-entered​

sdf-sdf_hfx-range-exited​

Standardformat

Feldbeschreibung

Veranstaltungskategorie

Veranstaltungsstufe

Veranstaltung

Eingabe

`invalid-io-channel`

`http-route-deprecated`

`settings-invalid-key`

`command-deprecated`

Gerät

`device-connected`

`device-disconnected`

Sitzung

`device-low-control-rate`

`device-critical-control-rate`

Funktionen

`sdf-sdf_hfx-created`

`sdf-sdf_hfx-deleted`

`sdf-sdf_hfx-updated`

`sdf-sdf_hfx-range-entered`

`sdf-sdf_hfx-range-exited`