Veranstaltungskanal

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

Die Portnummer kann in den Einstellungen geändert werden.

Es handelt sich hierbei um einen selten genutzten unidirektionalen Kommunikationskanal, über den voraussichtlich alle Ereignisse innerhalb des Systems empfangen werden können. Eingangsnachrichten werden nicht unterstützt.

Dieser Kanal garantiert, dass bei jedem Ereignis mindestens eine Nachricht gesendet wird.

Standardformat

Alle Veranstaltungen folgen der unten dargestellten Standardstruktur:

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

Feldbeschreibung

Feld	Typ	Erläuterung
`name`	`string`	Dies ist die eindeutige Kennung des Events.
`category`	`string`	Dies sind Gruppenbezeichnungen, die zum Filtern und Ordnen 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 eine Nutzlast, die ereignisspezifische Details enthält.
`message`	`string`	Eine beliebige, für Menschen lesbare Beschreibung oder ein Kontext zu einem Ereignis.

Veranstaltungskategorie

category „Field“ unterteilt Ereignisse in folgende Gruppen:

Wert	Erläuterung
`system`	Kern- oder Kernsysteme, globale Einstellungen usw.
`input`	Verarbeitung externer Eingaben (z. B. Befehle usw.).
`session`	Ereignisse, die sich auf eine bestimmte Benutzersitzung beziehen.
`device`	Geräteverwaltung, Interaktion mit dem Controller, SerialPort-Kommunikation.
`module`	Ereignisse von Subsystemen oder modularen Komponenten.
`feature`	Ereignisse, die mit bestimmten Dienstfunktionen oder -fähigkeiten in Zusammenhang stehen.

Veranstaltungsebene

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

Wert	Erläuterung
`info`	Nur zur Information – Protokolle, Metriken oder Benachrichtigungen mit geringer Priorität.
`notice`	Veränderungen des Zustands oder bemerkenswerte Ereignisse.
`warning`	Es ist ein Problem aufgetreten oder es liegt eine Störung vor, das System kann jedoch den Betrieb sicher fortsetzen.
`error`	Es ist ein Problem aufgetreten, das sich möglicherweise auf den Betrieb oder die Stabilität des Systems auswirkt.
`critical`	Es handelt sich um einen schwerwiegenden Fehler, der die Funktionsfähigkeit des Systems erheblich beeinträchtigt.
`panic`	Schwerwiegender Fehler – Kann zu einem Systemabsturz oder einem nicht behebbaren Zustand führen.

Veranstaltung

Anmerkungen

Diese Liste enthält die Ereignisse, die das System derzeit meldet. Derzeit arbeiten wir intensiv daran, die Arten der Ereignisse und die Meldinhalte zu gestalten und zu erweitern.

Eingabe

`invalid-io-channel`

Dies tritt auf, wenn I/O-Kanäle auf eine nicht unterstützte oder unbeabsichtigte Weise verwendet werden.

Daten

Feld	Typ	Erläuterung
`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`

Diese Meldung wird ausgegeben, wenn eine HTTP-Route als veraltet gilt und in zukünftigen Versionen entfernt wird.

Daten

Feld	Typ	Erläuterung
`route`	`string`	Diese Route wird nicht mehr empfohlen.
`substitute`	`string`	Dies ist eine empfohlene Alternativroute.

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

`settings-invalid-key`

Wird ausgegeben, wenn der Konfigurationsschlüssel ungültig ist.

Daten

Feld	Typ	Erläuterung
`key`	`string`	Ein 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 der empfangene Befehl veraltet ist und in zukünftigen Versionen entfernt wird.

Feld	Typ	Erläuterung
`command`	`string`	Dies ist ein empfangener, nicht empfohlener 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`

Dies zeigt an, dass das Gerät angeschlossen und voll funktionsfähig ist.

Feld	Typ	Erläuterung
`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 unterbrochen wurde.

Feld	Typ	Erläuterung
`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`

Diese Meldung wird ausgegeben, wenn die Empfangsrate der direkten Steuerbefehle für das Gerät zu niedrig ist und die Sicherheitsgrenze erreicht wird. Dies ist eine Warnung, die darauf hinweist, dass sich die Rate dem Cut-off-Wert nähert.

Feld	Typ	Erläuterung
`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 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`

Diese Meldung wird ausgegeben, wenn die Empfangsrate der direkten Steuerbefehle für das Gerät zu niedrig ist und dadurch die Sicherheitsgrenzen erreicht werden.

Feld	Typ	Erläuterung
`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 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 die SDF-Entität „FX“ erstellt wird.

Feld	Typ	Erläuterung
`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`

Wird ausgegeben, wenn die SDF-Entität „FX“ gelöscht wird.

Feld	Typ	Erläuterung
`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`

Wird ausgegeben, wenn die SDF-Entität „FX“ aktualisiert wurde.

Feld	Typ	Erläuterung
`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`

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

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

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

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

Veranstaltungsebene​

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

Veranstaltungsebene

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`