Chaîne des événements

L'URL WebSocket par défaut pour les événements est ws://localhost:10020 .

Le numéro de port peut être modifié dans les paramètres.

Il s'agit d'un canal de communication unidirectionnel à faible fréquence, qui devrait permettre de recevoir tous les événements du système. Les messages entrants ne sont pas pris en charge.

Cette chaîne garantit l'envoi d'un message pour chaque événement.

Format standard

Tous les événements suivent la structure standard présentée ci-dessous :

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

Description des champs

Champ	Type	Explication
`name`	`string`	Il s'agit de l'identifiant unique de l'événement.
`category`	`string`	Il s'agit d'étiquettes de groupe utilisées pour le filtrage et le classement (voir les catégories disponibles).
`level`	`string`	Il s'agit du niveau de gravité ou d'importance de l'événement (voir les niveaux valides).
`data`	`object`	Il s'agit d'une charge utile contenant des détails spécifiques à l'événement.
`message`	`string`	Il s'agit d'une description ou d'un contexte facultatif, rédigé dans un format lisible par l'utilisateur, concernant l'événement.

Catégories d'événements

category Le champ classe les événements dans les groupes suivants :

Valeur	Explication
`system`	Systèmes centraux ou fondamentaux, paramètres globaux, etc.
`input`	Traitement des entrées externes (par exemple : commandes, etc.).
`session`	Événements liés à une session utilisateur spécifique.
`device`	Gestion des périphériques, interaction avec le contrôleur, communication via SerialPort.
`module`	Événements liés à un sous-système ou à un composant modulaire.
`feature`	Événement lié à une fonctionnalité ou à une capacité spécifique d'un service.

Niveau de l'événement

Événements level Ce champ indique le niveau de gravité ou d'importance de l'événement :

Valeur	Explication
`info`	À titre informatif uniquement — journaux, métriques ou notifications de faible importance.
`notice`	Changement d'état ou événement notable.
`warning`	Un problème est survenu ou une anomalie a été détectée, mais le système peut continuer à fonctionner en toute sécurité.
`error`	Un problème susceptible d'affecter le fonctionnement ou la stabilité du système s'est produit.
`critical`	Il s'agit d'une erreur grave qui entrave considérablement le fonctionnement du système.
`panic`	Défaut critique — Peut entraîner un plantage ou un état irrémédiable.

Événement

Remarques

Cette liste répertorie les événements actuellement signalés par le système. Nous travaillons actuellement activement à la conception et à l'enrichissement des types d'événements et des informations fournies.

Saisie

`invalid-io-channel`

Ce problème survient lorsque les canaux d'E/S sont utilisés d'une manière non prise en charge ou non prévue.

Données

Champ	Type	Explication
`received_data`	`string`	Voici les données brutes reçues.

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

`http-route-deprecated`

Ce message s'affiche lorsque la racine HTTP est obsolète et qu'elle sera supprimée dans une version future.

Données

Champ	Type	Explication
`route`	`string`	Il s'agit d'un itinéraire qui n'est plus recommandé.
`substitute`	`string`	Voici l'itinéraire alternatif recommandé.

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

`settings-invalid-key`

Ce message s'affiche lorsque la clé de configuration est désactivée.

Données

Champ	Type	Explication
`key`	`string`	Il s'agit d'une clé introuvable.

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

`command-deprecated`

Ce message s'affiche lorsque la commande reçue est obsolète et sera supprimée dans une prochaine version.

Champ	Type	Explication
`command`	`string`	Voici la commande non recommandée qui a été 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`."
}

Appareil

`device-connected`

Cela indique que l'appareil est connecté et pleinement opérationnel.

Champ	Type	Explication
`device_family`	`string`	Type d'appareil :`inverse` ou bien `verse_grip`。
`device_id`	`string`	Il s'agit de l'identifiant unique de l'appareil.

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

`device-disconnected`

Cela indique que la connexion avec un appareil précédemment connecté a été interrompue.

Champ	Type	Explication
`device_family`	`string`	Type d'appareil :`inverse` ou bien `verse_grip`。
`device_id`	`string`	Il s'agit de 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 lorsque le débit de réception des commandes de contrôle direct destinées au périphérique est trop faible et atteint les limites de sécurité. Il s'agit d'un avertissement indiquant que le débit se rapproche du seuil de coupure.

Champ	Type	Explication
`session_id`	`int`	Il s'agit de l'ID de la session de simulation concernée.
`device_family`	`string`	Type d'appareil :`inverse` ou bien `verse_grip`。
`device_id`	`string`	Il s'agit de l'identifiant unique de l'appareil.
`frequency`	`int`	Il s'agit de la 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`

Ce message s'affiche lorsque le débit de réception des commandes de contrôle direct destinées à l'appareil est trop faible et que les limites de sécurité sont atteintes.

Champ	Type	Explication
`session_id`	`int`	Il s'agit de l'ID de la session de simulation concernée.
`device_family`	`string`	Type d'appareil :`inverse` ou bien `verse_grip`。
`device_id`	`string`	Il s'agit de l'identifiant unique de l'appareil.
`frequency`	`int`	Il s'agit de la 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": ""
}

Fonctionnalités

`sdf-sdf_hfx-created`

Ce document est publié lorsque l'entité SDF FX est créée.

Champ	Type	Explication
`session_id`	`int`	Il s'agit de l'ID de la session de simulation concernée.
`device_id`	`string`	Il s'agit de l'identifiant unique de l'appareil.
`hfx_id`	`string`	Il s'agit de l'identifiant FX utilisé lors de la création.

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

Ce message s'affiche lorsque l'entité SDF « FX » est supprimée.

Champ	Type	Explication
`session_id`	`int`	Il s'agit de l'ID de la session de simulation concernée.
`device_id`	`string`	Il s'agit de l'identifiant unique de l'appareil.
`hfx_id`	`string`	Il s'agit d'un 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`

Ce message est émis lorsque l'entité SDF « FX » est mise à jour.

Champ	Type	Explication
`session_id`	`int`	Il s'agit de l'ID de la session de simulation concernée.
`device_id`	`string`	Il s'agit de l'identifiant unique de l'appareil.
`hfx_id`	`string`	Voici le nouvel 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`

Elle est émise lorsque le curseur de l'appareil spécifié entre dans la zone de l'entité SDF.

Champ	Type	Explication
`session_id`	`int`	Il s'agit de l'ID de la session de simulation concernée.
`device_id`	`string`	Il s'agit de l'identifiant unique de l'appareil.
`hfx_id`	`string`	C'est un 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`

Cette commande est émise lorsque le curseur de l'appareil spécifié sort de la zone couverte par l'entité SDF.

Champ	Type	Explication
`session_id`	`int`	Il s'agit de l'ID de la session de simulation concernée.
`device_id`	`string`	Il s'agit de l'identifiant unique de l'appareil.
`hfx_id`	`string`	C'est un 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 standard​

Description des champs​

Catégories d'événements​

Niveau de l'événement​

Événement​

Saisie​

invalid-io-channel​

http-route-deprecated​

settings-invalid-key​

command-deprecated​

Appareil​

device-connected​

device-disconnected​

Session​

device-low-control-rate​

device-critical-control-rate​

Fonctionnalités​

sdf-sdf_hfx-created​

sdf-sdf_hfx-deleted​

sdf-sdf_hfx-updated​

sdf-sdf_hfx-range-entered​

sdf-sdf_hfx-range-exited​

Format standard

Description des champs

Catégories d'événements

Niveau de l'événement

Événement

Saisie

`invalid-io-channel`

`http-route-deprecated`

`settings-invalid-key`

`command-deprecated`

Appareil

`device-connected`

`device-disconnected`

Session

`device-low-control-rate`

`device-critical-control-rate`

Fonctionnalités

`sdf-sdf_hfx-created`

`sdf-sdf_hfx-deleted`

`sdf-sdf_hfx-updated`

`sdf-sdf_hfx-range-entered`

`sdf-sdf_hfx-range-exited`