Chaîne des événements
L'URL WebSocket par défaut pour les événements est ws://localhost:10020C'est.
Vous pouvez modifier le port dans les paramètres.
Ce canal est un canal de communication unidirectionnel à faible fréquence qui permet de recevoir tous les événements du système. Les messages entrants ne sont pas pris en charge.
Ce canal garantit l'envoi d'un seul message par événement.
Format standard
Tous les événements suivent la structure standard suivante :
{
"name": "device-connected",
"category": "device",
"level": "notice",
"data": {},
"message": ""
}
Description des champs
| Champ | Type | Description |
|---|---|---|
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 la configuration (voir les catégories valides). |
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 les détails de chaque événement. |
message | string | Il s'agit d'une description facultative ou d'informations contextuelles concernant l'événement. |
Catégories d'événements
category Field classe les événements dans les catégories suivantes :
| valeur | Description |
|---|---|
system | Il s'agit notamment des systèmes centraux ou clés, des paramètres globaux, etc. |
input | Il s'agit du traitement des entrées externes (par exemple, des commandes, etc.). |
session | Il s'agit d'un événement lié à une session utilisateur spécifique. |
device | La gestion des périphériques, l'interaction avec les contrôleurs et la communication via SerialPort. |
module | Il s'agit d'un événement lié à un sous-système ou à un composant modulaire. |
feature | Il s'agit d'un événement lié à une fonctionnalité ou à une capacité spécifique d'un service. |
Niveau de l'événement
Événement level Ce champ indique le niveau de gravité ou d'importance de l'événement :
| valeur | Description |
|---|---|
info | À titre informatif — il s'agit de journaux, de métriques ou de notifications sans importance. |
notice | Il s'agit d'un changement d'état ou d'un é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 nuit considérablement au bon fonctionnement du système. |
panic | Erreur fatale — Peut entraîner un plantage ou un état irrécupérable. |
Événement
Cette liste présente les événements les plus récents actuellement signalés par le système. Nous travaillons en permanence à la conception et à l'élargissement des types d'événements et des méthodes de signalement.
Saisie
invalid-io-channel
Ce problème survient lorsque le canal d'E/S n'est pas pris en charge ou est utilisé de manière non prévue.
Données
| Champ | Type | Description |
|---|---|---|
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 problème survient lorsque la route HTTP n'est plus prise en charge et doit être supprimée dans une prochaine version.
Données
| Champ | Type | Description |
|---|---|---|
route | string | Il s'agit d'un itinéraire dont la prise en charge a été interrompue. |
substitute | string | Il s'agit d'une alternative recommandée. |
{
"name": "http-route-deprecated",
"category": "input",
"level": "warning",
"data": {
"route": "/the/old/way",
"substitute": "/the/new/way"
}
}
settings-invalid-key
Cette erreur se produit lorsque la clé de configuration n'est pas valide.
Données
| Champ | Type | Description |
|---|---|---|
key | string | Cette clé est 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 n'est plus prise en charge et doit être supprimée dans une prochaine version.
| Champ | Type | Description |
|---|---|---|
command | string | Reçu : ordre de suspension de l'assistance |
{
"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 fonctionne correctement.
| Champ | Type | Description |
|---|---|---|
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 l'appareil précédemment connecté a été interrompue.
| Champ | Type | Description |
|---|---|---|
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 phénomène se produit lorsque la vitesse des commandes de contrôle direct de réception vers l'appareil est trop faible et atteint la limite de sécurité. Il s'agit d'un avertissement indiquant que la vitesse est proche de la vitesse de blocage.
| Champ | Type | Description |
|---|---|---|
session_id | int | Il s'agit de l'identifiant 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 Hz). |
{
"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 problème survient lorsque la vitesse des commandes de contrôle direct de la réception sur l'appareil est trop faible et atteint le seuil de sécurité.
| Champ | Type | Description |
|---|---|---|
session_id | int | Il s'agit de l'identifiant 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 Hz). |
{
"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
Cela se produit lors de la création de l'entité SDF FX.
| Champ | Type | Description |
|---|---|---|
session_id | int | Il s'agit de l'identifiant 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
Cela se produit lorsque l'entité SDF FX est supprimée.
| Champ | Type | Description |
|---|---|---|
session_id | int | Il s'agit de l'identifiant 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
Cela se produit lors de la mise à jour de l'entité SDF FX.
| Champ | Type | Description |
|---|---|---|
session_id | int | Il s'agit de l'identifiant 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 nouveau numéro d'identification 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
Cet événement se produit lorsque le curseur de l'appareil spécifié pénètre dans la zone de portée d'une entité SDF.
| Champ | Type | Description |
|---|---|---|
session_id | int | Il s'agit de l'identifiant 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. |
{
"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 erreur se produit lorsque le curseur de l'appareil spécifié sort de la zone couverte par l'entité SDF.
| Champ | Type | Description |
|---|---|---|
session_id | int | Il s'agit de l'identifiant 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. |
{
"name": "sdf-sdf_hfx-range-exited",
"category": "feature",
"level": "notice",
"data": {
"session_id": 3,
"device_id": "1A2B",
"hfx_id": "my_fx_name"
},
"message": ""
}