Chaîne des événements

L'URL par défaut du websocket de l'événement est ws://localhost:10020. Note : 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>"
  }
}

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"
  }
}