Veranstaltungskalender

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

Der Port kann in den Einstellungen geändert werden.

Es handelt sich um einen unidirektionalen Kommunikationskanal mit niedriger Frequenz, über den Sie alle Systemereignisse empfangen können. Eingehende Nachrichten werden nicht unterstützt.

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

Standardformat

Alle Veranstaltungen folgen einer Standardstruktur, die im Folgenden dargestellt ist:

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

Feldbeschreibungen

Champ	Typ	Beschreibung
name	string	Eindeutige Kennung des Ereignisses.
category	string	Gruppierungsbezeichnung, die zum Filtern und Ordnen verwendet wird (siehe gültige Kategorien).
level	string	Schweregrad oder Bedeutung des Ereignisses (siehe zulässige Stufen).
data	object	Nutzlast mit den für die Veranstaltung spezifischen Details.
message	string	Optionale, für Menschen lesbare Beschreibung oder Hintergrundinformationen zur Veranstaltung.

Veranstaltungskategorie

Das Feld category gruppiert die Ereignisse in folgende Kategorien:

Wert	Beschreibung
system	Haupt- oder Zentralsysteme, globale Parameter usw.
input	Verwaltung externer Eingaben (z. B. Bestellungen oder Ähnliches).
session	Ereignisse, die mit einer bestimmten Benutzersitzung zusammenhängen.
device	Geräteverwaltung, Interaktion mit dem Controller, SerialPort-Kommunikation.
module	Ereignisse eines Subsystems oder einer modularen Komponente.
feature	Ereignisse, die mit bestimmten Funktionen oder Fähigkeiten des Dienstes zusammenhängen.

Veranstaltungsstufe

Das Feld level Die Bezeichnung des Ereignisses gibt Aufschluss über dessen Schwere oder Bedeutung:

Wert	Beschreibung
info	Nur zur Information: Protokolle, Messwerte oder nicht kritische Meldungen.
notice	Zustandsänderungen oder bemerkenswerte Ereignisse.
warning	Es ist ein Problem aufgetreten oder es scheint eine Unregelmäßigkeit vorzuliegen, doch das System kann seinen Betrieb sicher fortsetzen.
error	Es ist ein Problem aufgetreten, das das Verhalten oder die Stabilität des Systems beeinträchtigen kann.
critical	Schwerwiegender Fehler, der den Betrieb des Systems erheblich beeinträchtigt.
panic	Katastrophaler Fehler: Kann zu einem Systemabsturz oder einem nicht behebbaren Zustand führen.

Veranstaltungen

Infos

Diese Liste enthält die Ereignisse, die derzeit vom System gemeldet werden. Wir entwickeln die Ereignistypen und Meldemechanismen aktiv weiter und erweitern sie.

Vorspeise

invalid-io-channel

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

Daten

Champ	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

Champ	Typ	Beschreibung
route	string	Die veraltete Straße.
substitute	string	Die empfohlene Ausweichroute.

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

settings-invalid-key

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

Daten

Champ	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.

Champ	Typ	Beschreibung
command	string	Die erhaltene veraltete Bestellung

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

Champ	Typ	Beschreibung
device_family	string	Gerätetyp: inverse ou verse_grip.
device_id	string	Die eindeutige Gerätekennung.

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

Champ	Typ	Beschreibung
device_family	string	Gerätetyp: inverse ou verse_grip.
device_id	string	Die eindeutige Gerätekennung.

{
  "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 Direktsteuerbefehl für ein Gerät mit einer zu niedrigen Frequenz empfangen wird und die Sicherheitsgrenzwerte erreicht. Es handelt sich um eine Warnung, die darauf hinweist, dass sich die Frequenz der Grenzfrequenz nähert.

Champ	Typ	Beschreibung
session_id	int	ID der betreffenden Simulationssitzung.
device_family	string	Gerätetyp: inverse ou verse_grip.
device_id	string	Die eindeutige Gerätekennung.
frequency	int	Ihre aktuelle Abtastrate 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 Direktbefehl für ein Gerät mit einer zu niedrigen Frequenz empfangen wird und die Sicherheitsgrenzwerte erreicht.

Champ	Typ	Beschreibung
session_id	int	ID der betreffenden Simulationssitzung.
device_family	string	Gerätetyp: inverse ou verse_grip.
device_id	string	Die eindeutige Gerätekennung.
frequency	int	Ihre aktuelle Abtastrate 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-Effekt für ein SDF-Objekt erstellt wird.

Champ	Typ	Beschreibung
session_id	int	ID der betreffenden Simulationssitzung.
device_id	string	Die eindeutige Gerätekennung.
hfx_id	string	Die Kennung des FX-Effekts, die bei dessen 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 ausgelöst, wenn ein FX-Effekt eines SDF-Objekts entfernt wird.

Champ	Typ	Beschreibung
session_id	int	ID der betreffenden Simulationssitzung.
device_id	string	Die eindeutige Gerätekennung.
hfx_id	string	Die ID des gelöschten FX-Effekts.

{
  "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 ausgelöst, wenn ein FX-Effekt eines SDF-Objekts aktualisiert wird.

Champ	Typ	Beschreibung
session_id	int	ID der betreffenden Simulationssitzung.
device_id	string	Die eindeutige Gerätekennung.
hfx_id	string	Die aktualisierte ID des FX-Effekts.

{
  "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 betreffenden Geräts in den Erfassungsbereich der SDF-Entität gelangt.

Champ	Typ	Beschreibung
session_id	int	ID der betreffenden Simulationssitzung.
device_id	string	Die eindeutige Gerätekennung.
hfx_id	string	Die Kennung des FX-Effekts.

{
  "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 betreffenden Geräts den Erfassungsbereich der SDF-Entität verlässt.

Champ	Typ	Beschreibung
session_id	int	ID der betreffenden Simulationssitzung.
device_id	string	Die eindeutige Gerätekennung.
hfx_id	string	Die Kennung des FX-Effekts.

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