Canal d'événements

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

Le port peut être modifié dans la configuration.

Il s'agit d'un canal de communication à faible fréquence et à transmission unidirectionnelle, qui vous permet de recevoir tous les événements du système. Les messages d'entrée ne sont pas pris en charge.

Ce canal garantit qu'un seul message est envoyé pour chaque événement.

Format uniforme

Tous les événements suivent une structure standard, comme illustré ci-dessous :

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

Descriptions des champs

Feld	Type	Description
`name`	`string`	Identifiant unique de l'événement.
`category`	`string`	Nom du groupe utilisé pour le filtrage et l'organisation (voir les catégories valides).
`level`	`string`	Gravité ou importance de l'événement (voir les niveaux applicables).
`data`	`object`	Données d'utilisation avec des détails spécifiques à chaque événement.
`message`	`string`	Description facultative, compréhensible par l'utilisateur, ou contexte relatif à l'événement.

Catégorie d'événement

Le champ category a classé les événements dans les groupes suivants :

Valeur	Description
`system`	Systèmes centraux, paramètres généraux, etc.
`input`	Traitement des entrées externes (par exemple, des 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 via le port série.
`module`	Événements liés aux sous-systèmes ou aux composants modulaires.
`feature`	Événements liés à certaines fonctions de service.

Niveau d'événement

Le champ level indique le degré de gravité ou l'importance d'un événement :

Valeur	Description
`info`	À titre purement informatif – protocoles, indicateurs ou remarques sans caractère critique.
`notice`	Changements de situation ou événements notables.
`warning`	Un problème est survenu ou quelque chose semble anormal, mais le système peut continuer à fonctionner en toute sécurité.
`error`	Un problème est survenu qui peut affecter le fonctionnement ou la stabilité du système.
`critical`	Erreur grave qui perturbe considérablement le fonctionnement du système.
`panic`	Panne catastrophique – peut entraîner un plantage ou un état irrémédiable.

Événements

Informations

Cette liste répertorie les événements actuellement signalés par le système. Nous travaillons actuellement activement au développement et à l'enrichissement des types d'événements et de leurs notifications.

Saisie

`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

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

Ce message s'affiche lorsqu'une route HTTP est obsolète et sera supprimée dans une prochaine version.

Données

Feld	Type	Description
`route`	`string`	L'itinéraire obsolète.
`substitute`	`string`	L'alternative recommandée.

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

`settings-invalid-key`

Ce message s'affiche lorsqu'une clé de paramétrage n'est pas valide.

Données

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

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

`command-deprecated`

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

Feld	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 a été connecté et qu'il est désormais pleinement opérationnel.

Feld	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é.

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

Séance

`device-low-control-rate`

Ce message s'affiche lorsqu'une commande directe entrante destinée à un appareil est reçue avec un débit trop faible et atteint ainsi les limites de sécurité. Il s'agit d'un avertissement indiquant que le débit s'approche de la limite de coupure.

Feld	Type	Description
`session_id`	`int`	Identifiant de la session de simulation.
`device_family`	`string`	Type d'appareil : `inverse` ou `verse_grip`.
`device_id`	`string`	L'identifiant unique de l'appareil.
`frequency`	`int`	Votre taux d'imposition actuel 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 lorsqu'une commande directe entrante destinée à un appareil est reçue à une fréquence trop faible et atteint ainsi les limites de sécurité.

Feld	Type	Description
`session_id`	`int`	Identifiant de la session de simulation.
`device_family`	`string`	Type d'appareil : `inverse` ou `verse_grip`.
`device_id`	`string`	L'identifiant unique de l'appareil.
`frequency`	`int`	Votre taux d'imposition actuel en Hertz.

{
  "name": "device-critical-control-rate",
  "category": "session",
  "level": "error",
  "data": {
    "session_id": 3,
    "device_family": "inverse",
    "device_id": "1A2B",
    "frequency": 82
  },
  "message": ""
}

Fonctions

`sdf-sdf_hfx-created`

Ce message s'affiche lorsqu'un FX de l'entité SDF est créé.

Feld	Type	Description
`session_id`	`int`	Identifiant de la session de simulation.
`device_id`	`string`	L'identifiant unique de l'appareil.
`hfx_id`	`string`	L'identifiant FX avec lequel il a été créé.

{
  "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 lorsqu'un FX de l'entité SDF est supprimé.

Feld	Type	Description
`session_id`	`int`	Identifiant de la session de simulation.
`device_id`	`string`	L'identifiant unique de l'appareil.
`hfx_id`	`string`	L'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 généré lorsqu'un FX de l'entité SDF est mis à jour.

Feld	Type	Description
`session_id`	`int`	Identifiant de la session de simulation.
`device_id`	`string`	L'identifiant unique de l'appareil.
`hfx_id`	`string`	Le FX-ID 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 message est généré lorsque le curseur de l'appareil spécifié pénètre dans la zone de l'entité SDF.

Feld	Type	Description
`session_id`	`int`	Identifiant de la session de simulation.
`device_id`	`string`	L'identifiant unique de l'appareil.
`hfx_id`	`string`	L'FX-ID.

{
  "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 message s'affiche lorsque le curseur de l'appareil spécifié quitte la zone de l'entité SDF.

Feld	Type	Description
`session_id`	`int`	Identifiant de la session de simulation.
`device_id`	`string`	L'identifiant unique de l'appareil.
`hfx_id`	`string`	L'FX-ID.

{
  "name": "sdf-sdf_hfx-range-exited",
  "category": "feature",
  "level": "notice",
  "data": {
    "session_id": 3,
    "device_id": "1A2B",
    "hfx_id": "my_fx_name"
  },
  "message": ""
}

Format uniforme​

Descriptions des champs​

Catégorie d'événement​

Niveau d'événement​

Événements​

Saisie​

invalid-io-channel​

http-route-deprecated​

settings-invalid-key​

command-deprecated​

Appareil​

device-connected​

device-disconnected​

Séance​

device-low-control-rate​

device-critical-control-rate​

Fonctions​

sdf-sdf_hfx-created​

sdf-sdf_hfx-deleted​

sdf-sdf_hfx-updated​

sdf-sdf_hfx-range-entered​

sdf-sdf_hfx-range-exited​

Format uniforme

Descriptions des champs

Catégorie d'événement

Niveau d'événement

Événements

Saisie

`invalid-io-channel`

`http-route-deprecated`

`settings-invalid-key`

`command-deprecated`

Appareil

`device-connected`

`device-disconnected`

Séance

`device-low-control-rate`

`device-critical-control-rate`

Fonctions

`sdf-sdf_hfx-created`

`sdf-sdf_hfx-deleted`

`sdf-sdf_hfx-updated`

`sdf-sdf_hfx-range-entered`

`sdf-sdf_hfx-range-exited`