Fil d'actualités

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

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

Il s'agit d'un canal de communication unidirectionnel à basse fréquence, sur lequel vous pouvez recevoir tous les événements du système. Aucun message entrant 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, présentée ci-dessous :

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

Descriptions des champs

Champ	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 autorisées).
`level`	`string`	Gravité ou importance de l'événement (voir les niveaux autorisés).
`data`	`object`	Données utiles contenant les détails spécifiques à l'événement.
`message`	`string`	Description ou contexte facultatif de l'événement, lisible par une personne.

Catégorie d'événement

Le champ category regroupe les événements dans les catégories suivantes :

Valeur	Description
`system`	Systèmes principaux ou centraux, paramètres globaux, etc.
`input`	Gestion 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 le contrôleur, communication via SerialPort.
`module`	Événements liés à un sous-système ou à un composant modulaire.
`feature`	Événements liés à des fonctionnalités ou à des capacités spécifiques du service.

Niveau de l'événement

Le champ level Le terme utilisé pour désigner l'événement en indique la gravité ou l'importance :

Valeur	Description
`info`	À titre informatif uniquement : journaux, mesures ou avis non critiques.
`notice`	Changements de situation ou événements marquants.
`warning`	Un problème est survenu ou semble anormal, mais le système peut continuer à fonctionner en toute sécurité.
`error`	Un problème est survenu qui pourrait affecter le fonctionnement ou la stabilité du système.
`critical`	Erreur grave qui perturbe considérablement le fonctionnement du système.
`panic`	Défaillance catastrophique : peut entraîner un plantage ou un état irrécupérable.

Événements

info

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

Entrée

`invalid-io-channel`

Se déclenche lorsqu'un canal d'E/S est utilisé d'une manière non prise en charge ou non prévue.

Données

Champ	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	Type	Description
`route`	`string`	La route désaffectée.
`substitute`	`string`	L'itinéraire de remplacement recommandé.

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

`settings-invalid-key`

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

Données

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

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

`command-deprecated`

Généré lorsqu'une commande entrante est obsolète et sera supprimée dans une future version.

Champ	Type	Description
`command`	`string`	La commande obsolète 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`

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

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

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

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

Généré lorsqu'une commande de contrôle directe entrante destinée à un appareil est reçue à une cadence trop faible et atteint les limites de sécurité. Il s'agit d'un avertissement indiquant que la cadence s'approche de la cadence limite.

Champ	Type	Description
`session_id`	`int`	Identifiant de la session de simulation concernée.
`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 contrôle 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 entrante destinée à un appareil est reçue à une fréquence trop faible et atteint les limites de sécurité.

Champ	Type	Description
`session_id`	`int`	Identifiant de la session de simulation concernée.
`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 contrôle 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`

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

Champ	Type	Description
`session_id`	`int`	Identifiant de la session de simulation concernée.
`device_id`	`string`	L'identifiant unique de l'appareil.
`hfx_id`	`string`	L'identifiant de l'effet FX utilisé lors de sa 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`

Généré lorsqu'un effet FX d'une entité SDF est supprimé.

Champ	Type	Description
`session_id`	`int`	Identifiant de la session de simulation concernée.
`device_id`	`string`	L'identifiant unique de l'appareil.
`hfx_id`	`string`	L'identifiant de l'effet FX a été 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 lorsqu'un effet FX d'une entité SDF est mis à jour.

Champ	Type	Description
`session_id`	`int`	Identifiant de la session de simulation concernée.
`device_id`	`string`	L'identifiant unique de l'appareil.
`hfx_id`	`string`	L'identifiant de l'effet FX a été 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`

Émis lorsque le curseur de l'appareil concerné entre dans la zone de couverture de l'entité SDF.

Champ	Type	Description
`session_id`	`int`	Identifiant de la session de simulation concernée.
`device_id`	`string`	L'identifiant unique de l'appareil.
`hfx_id`	`string`	L'identifiant de l'effet 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`

Émis lorsque le curseur de l'appareil concerné sort de la zone de couverture de l'entité SDF.

Champ	Type	Description
`session_id`	`int`	Identifiant de la session de simulation concernée.
`device_id`	`string`	L'identifiant unique de l'appareil.
`hfx_id`	`string`	L'identifiant de l'effet 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​

Descriptions des champs​

Catégorie d'événement​

Niveau de l'événement​

Événements​

Entrée​

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 canonique

Descriptions des champs

Catégorie d'événement

Niveau de l'événement

Événements

Entrée

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