Canal des incidents

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

Les ports peuvent être modifiés dans la configuration.

Il s'agit d'un canal de communication unidirectionnel à basse fréquence qui vous permet de recevoir tous les événements du système. L'envoi de messages n'est pas pris en charge.

Ce canal 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`	Identifiant unique de l'événement.
`category`	`string`	Étiquettes de classification utilisées pour le filtrage et le regroupement (voir « Classification effective »).
`level`	`string`	La gravité ou l'importance de l'incident (voir « Niveaux de gravité »).
`data`	`object`	Chargement de données contenant les détails spécifiques de l'événement.
`message`	`string`	Description facultative de l'événement ou informations contextuelles, destinées à être lues par une personne.

Catégorisation des incidents

category Les champs classent les événements dans les catégories suivantes :

Valeur	Explication
`system`	Système central ou principal, paramètres globaux, etc.
`input`	Traitement des entrées externes (par exemple, des commandes ou d'autres types d'entrées).
`session`	Événements liés à la session d'un utilisateur spécifique.
`device`	Gestion des périphériques, interaction avec les contrôleurs, communication via le port série (SerialPort).
`module`	Événements liés aux sous-systèmes ou aux composants modulaires.
`feature`	Événements liés à des fonctionnalités ou capacités spécifiques d'un service.

Niveau d'incident

relatif à l'incident level Ce champ indique le niveau de gravité ou d'importance de l'événement :

Valeur	Explication
`info`	À titre indicatif uniquement — journaux, indicateurs ou notifications non critiques.
`notice`	Changements d'état ou événements à surveiller.
`warning`	Une anomalie est survenue ou un problème semble se présenter, mais le système peut continuer à fonctionner en toute sécurité.
`error`	Un problème est survenu, susceptible d'affecter le fonctionnement ou la stabilité du système.
`critical`	Erreur grave, perturbant considérablement le fonctionnement du système.
`panic`	Panne catastrophique — État susceptible d'entraîner un plantage ou une situation irrémédiable.

Événement

Informations

Cette liste répertorie les événements actuellement signalés par le système. Nous travaillons activement à la conception et à l'élargissement des types d'événements ainsi qu'à l'amélioration des mécanismes de signalement.

Saisie

`invalid-io-channel`

Ce message s'affiche lorsque le canal d'E/S est utilisé d'une manière non prise en charge ou imprévue.

Données

Champ	Type	Explication
`received_data`	`string`	Données brutes reçues.

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

`http-route-deprecated`

Ce message est émis lorsque le routage HTTP est obsolète et sera supprimé dans les prochaines versions.

Données

Champ	Type	Explication
`route`	`string`	Route obsolète.
`substitute`	`string`	Alternatives recommandées.

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

`settings-invalid-key`

Émis lorsque la touche de configuration est désactivée.

Données

Champ	Type	Explication
`key`	`string`	Clé de configuration 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`	Commandes obsolètes reçues

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

Équipements

`device-connected`

Indique que l'appareil est connecté et entièrement opérationnel.

Champ	Type	Explication
`device_family`	`string`	Type d'équipement :`inverse` ou `verse_grip`。
`device_id`	`string`	Identifiant unique de l'équipement.

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

`device-disconnected`

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

Champ	Type	Explication
`device_family`	`string`	Type d'équipement :`inverse` ou `verse_grip`。
`device_id`	`string`	Identifiant unique de l'équipement.

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

Conversation

`device-low-control-rate`

Ce message s'affiche lorsque le débit des commandes de contrôle direct reçues par l'équipement est trop faible et déclenche une limite de sécurité. Il s'agit d'un avertissement indiquant que le débit s'approche du seuil limite.

Champ	Type	Explication
`session_id`	`int`	ID de la session de simulation cible.
`device_family`	`string`	Type d'équipement :`inverse` ou `verse_grip`。
`device_id`	`string`	Identifiant unique de l'équipement.
`frequency`	`int`	Votre fréquence de commande actuelle (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 est émis lorsque le débit des commandes de contrôle direct reçues par l'équipement est trop faible et déclenche une limite de sécurité.

Champ	Type	Explication
`session_id`	`int`	ID de la session de simulation cible.
`device_family`	`string`	Type d'équipement :`inverse` ou `verse_grip`。
`device_id`	`string`	Identifiant unique de l'équipement.
`frequency`	`int`	Votre fréquence de commande actuelle (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 fonctionnelles

`sdf-sdf_hfx-created`

Émis lors de la création de l'entité SDF « FX ».

Champ	Type	Explication
`session_id`	`int`	ID de la session de simulation cible.
`device_id`	`string`	Identifiant unique de l'équipement.
`hfx_id`	`string`	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`

Émis lors de la suppression de l'entité SDF « FX ».

Champ	Type	Explication
`session_id`	`int`	ID de la session de simulation cible.
`device_id`	`string`	Identifiant unique de l'équipement.
`hfx_id`	`string`	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`

Émis lors de la mise à jour de l'entité SDF « FX ».

Champ	Type	Explication
`session_id`	`int`	ID de la session de simulation cible.
`device_id`	`string`	Identifiant unique de l'équipement.
`hfx_id`	`string`	Identifiant FX mis à jour.

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

Ce signal est émis lorsque le curseur de l'appareil spécifié pénètre dans la zone d'une entité SDF.

Champ	Type	Explication
`session_id`	`int`	ID de la session de simulation cible.
`device_id`	`string`	Identifiant unique de l'équipement.
`hfx_id`	`string`	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`

Ce signal est émis lorsque le curseur de l'appareil spécifié sort de la zone de l'entité SDF.

Champ	Type	Explication
`session_id`	`int`	ID de la session de simulation cible.
`device_id`	`string`	Identifiant unique de l'équipement.
`hfx_id`	`string`	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égorisation des incidents​

Niveau d'incident​

Événement​

Saisie​

invalid-io-channel​

http-route-deprecated​

settings-invalid-key​

command-deprecated​

Équipements​

device-connected​

device-disconnected​

Conversation​

device-low-control-rate​

device-critical-control-rate​

Caractéristiques fonctionnelles​

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égorisation des incidents

Niveau d'incident

Événement

Saisie

`invalid-io-channel`

`http-route-deprecated`

`settings-invalid-key`

`command-deprecated`

Équipements

`device-connected`

`device-disconnected`

Conversation

`device-low-control-rate`

`device-critical-control-rate`

Caractéristiques fonctionnelles

`sdf-sdf_hfx-created`

`sdf-sdf_hfx-deleted`

`sdf-sdf_hfx-updated`

`sdf-sdf_hfx-range-entered`

`sdf-sdf_hfx-range-exited`