Version : 3.5.x

Chaîne des événements

L'URL par défaut du websocket de l'événement est ws://localhost:10020.

Le port peut être modifié dans la configuration.

Il s'agit d'un canal de communication unidirectionnel à basse fréquence où vous pouvez vous attendre à recevoir tous les événements du système. Aucun message d'entrée n'est pris en charge.

Ce canal garantit l'envoi d'un message pour chaque événement.

Format canonique

Tous les événements suivent une structure standard, comme indiqué ci-dessous :

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

Description des champs

Champ d'application	Type	Description
`name`	`string`	Identifiant unique de l'événement.
`category`	`string`	Étiquette de regroupement utilisée pour le filtrage et l'organisation (voir les catégories valides).
`level`	`string`	Gravité ou importance de l'événement (voir les niveaux de validité).
`data`	`object`	Charge utile contenant des détails spécifiques à l'événement.
`message`	`string`	Description facultative lisible par l'homme ou contexte de l'événement.

Catégorie d'événement

Les category organise les événements dans les groupes suivants :

Valeur	Description
`system`	Systèmes centraux, paramètres globaux, etc.
`input`	Traitement des entrées externes (par exemple, commandes ou autres).
`session`	Événements liés à une session utilisateur spécifique.
`device`	Gestion des périphériques, interactions avec les contrôleurs, communication SerialPort.
`module`	Événements relatifs aux sous-systèmes ou aux composants modulaires.
`feature`	Événements liés à des caractéristiques ou à des capacités de service spécifiques.

Niveau de l'événement

L'événement level indique la gravité ou l'importance d'un événement :

Valeur	Description
`info`	Informations uniquement - journaux, mesures ou avis non critiques.
`notice`	Changements dans l'état ou événements notables.
`warning`	Quelque chose s'est mal passé ou semble hors service, mais le système peut continuer à fonctionner en toute sécurité.
`error`	Un problème s'est produit qui peut avoir un impact sur le comportement ou la stabilité du système.
`critical`	Erreur grave qui perturbe considérablement le fonctionnement du système.
`panic`	Défaillance catastrophique - peut conduire à un crash ou à un état irrécupérable.

Evénements

info

Cette liste est la liste actuelle des événements actuellement signalés par le système. Nous travaillons activement à la conception et à l'extension des types d'événements et des rapports.

Entrée

`invalid-io-channel`

Déclenché lorsqu'un canal d'E/S est utilisé d'une manière non prise en charge ou non voulue.

Données

Champ d'application	Type	Description
`received_data`	`string`	Les données brutes reçues.

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

`http-route-deprecated`

Généré lorsqu'une route HTTP est obsolète et sera supprimée dans une prochaine version.

Données

Champ d'application	Type	Description
`route`	`string`	L'itinéraire obsolète.
`substitute`	`string`	Le produit de substitution recommandé.

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

`settings-invalid-key`

Générée lorsqu'une clé de paramètres n'est pas valide.

Données

Champ d'application	Type	Description
`key`	`string`	La clé qui n'a pas été retrouvée.

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

`command-deprecated`

Émise lorsqu'une commande entrante est obsolète et sera supprimée dans une version ultérieure.

Champ d'application	Type	Description
`command`	`string`	La commande dépréciée reçue

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

Dispositif

`device-connected`

Indique qu'un appareil s'est connecté et qu'il est maintenant pleinement opérationnel.

Champ d'application	Type	Description
`device_family`	`string`	Type d'appareil : `inverse` ou `verse_grip`.
`device_id`	`string`	L’identifiant unique de l’appareil.

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

`device-disconnected`

Signifie qu'un appareil précédemment connecté a été déconnecté.

Champ d'application	Type	Description
`device_family`	`string`	Type d'appareil : `inverse` ou `verse_grip`.
`device_id`	`string`	L’identifiant unique de l’appareil.

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

Session

`device-low-control-rate`

Ce message s'affiche lorsqu'une commande de contrôle directe reçue pour un périphérique atteint une fréquence trop faible et atteint les limites de sécurité. Il s'agit d'un avertissement indiquant que la fréquence approche de la fréquence de coupure.

Champ d'application	Type	Description
`session_id`	`int`	Identifiant de la session de simulation cible.
`device_family`	`string`	Type d'appareil : `inverse` ou `verse_grip`.
`device_id`	`string`	L’identifiant unique de l’appareil.
`frequency`	`int`	Votre fréquence de commande actuelle en 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`

Généré lorsqu'une commande de contrôle directe reçue pour un périphérique atteint un débit trop faible et atteint les limites de sécurité.

Champ d'application	Type	Description
`session_id`	`int`	Identifiant de la session de simulation cible.
`device_family`	`string`	Type d'appareil : `inverse` ou `verse_grip`.
`device_id`	`string`	L’identifiant unique de l’appareil.
`frequency`	`int`	Votre fréquence de commande actuelle en hertz.

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

Caractéristiques

`sdf-sdf_hfx-created`

Généré lors de la création d'une entité SDF FX.

Champ d'application	Type	Description
`session_id`	`int`	Identifiant de la session de simulation cible.
`device_id`	`string`	L’identifiant unique de l’appareil.
`hfx_id`	`string`	L'identifiant FX avec lequel il a été créé.

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

Généré lors de la suppression d'une entité SDF FX.

Champ d'application	Type	Description
`session_id`	`int`	Identifiant de la session de simulation cible.
`device_id`	`string`	L’identifiant unique de l’appareil.
`hfx_id`	`string`	L'identifiant FX supprimé.

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

Généré lors de la mise à jour d'une entité SDF FX.

Champ d'application	Type	Description
`session_id`	`int`	Identifiant de la session de simulation cible.
`device_id`	`string`	L’identifiant unique de l’appareil.
`hfx_id`	`string`	La nouvelle version de l'identifiant FX.

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

Émis lorsque le curseur de l'appareil concerné pénètre dans la zone de l'entité SDF.

Champ d'application	Type	Description
`session_id`	`int`	Identifiant de la session de simulation cible.
`device_id`	`string`	L’identifiant unique de l’appareil.
`hfx_id`	`string`	L'identifiant FX.

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

Généré lorsque le curseur de l'appareil concerné sort de la zone de l'entité SDF.

Champ d'application	Type	Description
`session_id`	`int`	Identifiant de la session de simulation cible.
`device_id`	`string`	L’identifiant unique de l’appareil.
`hfx_id`	`string`	L'identifiant FX.

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

Format canonique​

Description des champs​

Catégorie d'événement​

Niveau de l'événement​

Evénements​

Entrée​

invalid-io-channel​

http-route-deprecated​

settings-invalid-key​

command-deprecated​

Dispositif​

device-connected​

device-disconnected​

Session​

device-low-control-rate​

device-critical-control-rate​

Caractéristiques​

sdf-sdf_hfx-created​

sdf-sdf_hfx-deleted​

sdf-sdf_hfx-updated​

sdf-sdf_hfx-range-entered​

sdf-sdf_hfx-range-exited​

Format canonique

Description des champs

Catégorie d'événement

Niveau de l'événement

Evénements

Entrée

`invalid-io-channel`

`http-route-deprecated`

`settings-invalid-key`

`command-deprecated`

Dispositif

`device-connected`

`device-disconnected`

Session

`device-low-control-rate`

`device-critical-control-rate`

Caractéristiques

`sdf-sdf_hfx-created`

`sdf-sdf_hfx-deleted`

`sdf-sdf_hfx-updated`

`sdf-sdf_hfx-range-entered`

`sdf-sdf_hfx-range-exited`