Ereigniskanal

Die Standard-WebSocket-Adresse für Ereignisse lautet ws://localhost:10020。

Der Port kann in der Konfiguration geändert werden.

Dies ist ein einseitiger Kommunikationskanal für niedrige Frequenzen, über den Sie alle Systemereignisse empfangen können. Das Senden von Nachrichten wird nicht unterstützt.

Dieser Kanal gewährleistet, dass für jedes Ereignis eine Nachricht gesendet wird.

Standardformat

Alle Ereignisse folgen der unten dargestellten Standardstruktur:

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

Feldbeschreibung

Feld	Typ	Erläuterung
name	string	Die eindeutige Kennung des Vorfalls.
category	string	Kategorisierungsbezeichnungen zum Filtern und Gruppieren (siehe „Gültige Kategorisierung“).
level	string	Schweregrad oder Bedeutung des Vorfalls (siehe Schweregrad).
data	object	Datenlast, die die konkreten Details des Ereignisses enthält.
message	string	Optionale Beschreibung des Ereignisses oder Kontextinformationen zum Lesen.

Ereigniskategorien

category Die Felder unterteilen die Ereignisse in folgende Kategorien:

Wert	Erläuterung
system	Kern- oder Zentralsystem, globale Einstellungen usw.
input	Verarbeitung externer Eingaben (z. B. Befehle oder andere Eingaben).
session	Ereignisse, die mit einer bestimmten Benutzersitzung zusammenhängen.
device	Geräteverwaltung, Interaktion mit Steuerungen, Kommunikation über die serielle Schnittstelle (SerialPort).
module	Ereignisse von Subsystemen oder modularen Komponenten.
feature	Ereignisse, die mit bestimmten Funktionen oder Fähigkeiten eines Dienstes zusammenhängen.

Ereignisebene

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

Wert	Erläuterung
info	Nur zu Informationszwecken – Protokolle, Kennzahlen oder nicht kritische Benachrichtigungen.
notice	Statusänderungen oder Ereignisse, die Beachtung verdienen.
warning	Es liegt eine Anomalie vor oder es scheint ein Problem zu geben, doch das System kann dennoch sicher weiterlaufen.
error	Es können Probleme auftreten, die das Systemverhalten oder die Systemstabilität beeinträchtigen können.
critical	Schwerwiegender Fehler, der die Systemfunktionen erheblich beeinträchtigt.
panic	Katastrophaler Fehler – ein Zustand, der zu einem Systemabsturz oder zu einem nicht wiederherstellbaren Zustand führen kann.

Vorfall

Informationen

Diese Liste enthält die Ereignisse, die derzeit vom System gemeldet werden. Wir arbeiten intensiv daran, die Ereignistypen und die Meldemechanismen weiterzuentwickeln und zu erweitern.

Eingabe

invalid-io-channel

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

Daten

Feld	Typ	Erläuterung
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 HTTP-Routing veraltet ist und in zukünftigen Versionen entfernt wird.

Daten

Feld	Typ	Erläuterung
route	string	Veraltete Routen.
substitute	string	Empfohlene Alternativen.

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

settings-invalid-key

Wird ausgegeben, wenn die Einstelltaste nicht funktioniert.

Daten

Feld	Typ	Erläuterung
key	string	Einstellungstaste nicht gefunden.

{
  "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	Empfangene veraltete Befehle

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

Ausrüstung

device-connected

Zeigt an, dass das Gerät angeschlossen und vollständig betriebsbereit ist.

Feld	Typ	Erläuterung
device_family	string	Gerätetyp:inverse oder verse_grip。
device_id	string	Eindeutige Kennung des Geräts.

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

device-disconnected

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	Eindeutige Kennung des Geräts.

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

Gespräch

device-low-control-rate

Wird ausgegeben, wenn die Rate der vom Gerät empfangenen direkten Steuerbefehle zu niedrig ist und die Sicherheitsgrenze ausgelöst wird. Dies ist eine Warnung, die darauf hinweist, dass sich die Rate der Abschaltgrenze nähert.

Feld	Typ	Erläuterung
session_id	int	ID der Zielsimulationssitzung.
device_family	string	Gerätetyp:inverse oder verse_grip。
device_id	string	Eindeutige Kennung des Geräts.
frequency	int	Ihre aktuelle Regelungsfrequenz (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 die Rate der direkt empfangenen Steuerbefehle zu niedrig ist und die Sicherheitsgrenze ausgelöst wird.

Feld	Typ	Erläuterung
session_id	int	ID der Zielsimulationssitzung.
device_family	string	Gerätetyp:inverse oder verse_grip。
device_id	string	Eindeutige Kennung des Geräts.
frequency	int	Ihre aktuelle Regelungsfrequenz (Hertz).

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

Funktionsmerkmale

sdf-sdf_hfx-created

Wird beim Erstellen des SDF-Entitätsobjekts „FX“ ausgelöst.

Feld	Typ	Erläuterung
session_id	int	ID der Zielsimulationssitzung.
device_id	string	Eindeutige Kennung des Geräts.
hfx_id	string	Die bei der Erstellung verwendete FX-ID.

{
  "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 beim Löschen der SDF-Entität „FX“ ausgelöst.

Feld	Typ	Erläuterung
session_id	int	ID der Zielsimulationssitzung.
device_id	string	Eindeutige Kennung des Geräts.
hfx_id	string	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 bei der Aktualisierung der SDF-Entität „FX“ ausgelöst.

Feld	Typ	Erläuterung
session_id	int	ID der Zielsimulationssitzung.
device_id	string	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 einer SDF-Entität eintritt.

Feld	Typ	Erläuterung
session_id	int	ID der Zielsimulationssitzung.
device_id	string	Eindeutige Kennung des Geräts.
hfx_id	string	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	ID der Zielsimulationssitzung.
device_id	string	Eindeutige Kennung des Geräts.
hfx_id	string	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": ""
}