Aller au contenu principal

Référence des paramètres

Ce document répertorie tous les paramètres renvoyés par le point de terminaison /settings/ avec leur clé, leur type (provenant de type_hint) et leurs contraintes (provenant de metadata.constraint.range + locked, le cas échéant).

Un paramètre locked est en lecture seule lors de l'exécution. Il peut être modifié via le fichier de configuration ou depuis la page des paramètres de Hub Haply, mais un redémarrage complet du service est nécessaire pour que les modifications soient prises en compte. Ces paramètres sont signalés démarrer dans les tableaux ci-dessous.

Configuration​

Le fichier de configuration permettant de modifier les paramètres au démarrage du service se trouve ici :

PlateformeEmplacement
WindowsC:\ProgramData\Haply\Inverse\haply-inverse-service-config.json
macOS/Library/Application Support/Haply/Inverse/haply-inverse-service-config.json
Linux/etc/haply-inverse-service/haply-inverse-service-config.json

Le fichier de configuration est un objet JSON plat qui associe les clés de paramètres à leurs valeurs de remplacement. Les clés doivent être des clés de paramètres valides renvoyées par la route /settings/ HTTP (voir la documentation de l'API). Toute clé non spécifiée utilise la valeur par défaut du service.

Par exemple, une modification de la configuration réseau :

{
"communication/http/port": 8400,
"communication/websocket/port": 8500,
"communication/events/port": 9000,
"communication/bind_all_interfaces": true
}

Correspondance des types​

Les indications de type renvoyées par l'API correspondent aux types JSON suivants :

  • STRING → string
  • BOOL → bool
  • INT → int
  • FLOAT → float
  • ARR_STRING → string[]
  • VEC3 → vec3 (objet avec {x, y, z})
  • GENERIC → json (valeur structurée arbitraire)

communication/…​

Ports réseau et adresses d'écoute des serveurs HTTP, WebSocket et de flux d'événements. La plupart des entrées ne peuvent être modifiées qu'au démarrage.

CléTypeContraintesDescription
communication/serial/enabledbool—Activer ou désactiver la communication avec les périphériques série.
communication/bind_addressstringdémarrageAdresse IP sur laquelle les serveurs HTTP et WebSocket sont à l'écoute.
communication/bind_all_interfacesbooldémarrageConfigurer les serveurs pour qu'ils écoutent sur 0.0.0.0 au lieu de « localhost ».
communication/http/portintdémarragePort de l'API REST HTTP (par défaut 10000).
communication/websocket/portintdémarragePort WebSocket principal de la version 3.1 (par défaut) 10001).
communication/websocket/legacy_portintdémarragePort WebSocket hérité de la version 3.0 (par défaut) 10000).
communication/events/portintdémarragePort WebSocket du flux d'événements (par défaut 10020).

devices/…​

devices/detection/…​

Politique de balayage des ports série. Tous les niveaux sont avancés.

CléTypeContraintesDescription
devices/detection/scan_period_msintplage 100–10 000 ; démarrageIntervalle entre deux balayages des ports série (ms).
devices/detection/handshake_timeout_sintplage 1–15Délai d'expiration de la négociation par port(s).
devices/detection/max_retriesintplage 1–10Nombre maximal de tentatives de négociation par port.
devices/detection/failure_log_delay_sintplage 1–60Délai avant d'enregistrer à nouveau un échec de détection (s).
devices/detection/block_looping_portsbool—Bloquer la disponibilité de l'appareil lorsqu'un port en boucle est détecté.
devices/detection/excluded_portsjson—Série « Chemins des ports » à ignorer lors de la détection.
devices/detection/additional_portsstring[]—Chemins d'accès aux ports série supplémentaires à analyser systématiquement.
devices/detection/allowed_vendor_id_filterstring[]—Identifiants de fournisseur USB autorisés lors de l'énumération des ports.
devices/detection/port_name_substring_filterstring[]—Sous-chaînes de nom de port spécifiques à chaque plateforme à rechercher.
devices/detection/wireless_verse_grip_description_filterstring[]—Sous-chaînes de description de port pour la détection sans fil de VerseGrip.
devices/detection/inverse3x_description_filterstring[]—Sous-chaînes de description de port pour la détection de l'Inverse3x.
devices/detection/extra_ports (obsolète)string[]—Utilisez plutôt devices/detection/additional_ports. Les lectures et les écritures sont transmises de manière transparente à la clé canonique.

devices/inverse*/…​

Valeurs par défaut globales appliquées à chaque appareil de la gamme « Inverse3 ». Les substitutions propres à chaque session ont la priorité.

CléTypeContraintesDescription
devices/inverse*/filters/force_scale/gainfloatplage 0,0–2,0Multiplicateur global de la puissance de sortie appliqué à tous les appareils.
devices/inverse*/filters/force_gate/gainfloatplage 0,0–1,0Gain par défaut de la porte de force pour les nouvelles sessions.
devices/inverse*/control_timeout_msintplage 50–10 000Délai d'expiration avant le déverrouillage du contrôle de l'appareil (ms).
devices/inverse*/query_orientation_on_idlebool—Interroger le micrologiciel sur l'orientation de l'appareil lorsque celui-ci est inactif.

devices/presets​

CléTypeContraintesDescription
devices/presetsjson—Paramètres de configuration par défaut de l'appareil pour chaque type d'appareil (montage en transformation, de base, etc. pour inverse_arm_front_*, inverse_led_front_*, minverse_*, verse_grip_default, wireless_verse_grip_default, custom_verse_grip_default).

devices/wireless_verse_grip/…​

CléTypeContraintesDescription
devices/wireless_verse_grip/battery/low_thresholdint—Pourcentage de charge de la batterie en dessous duquel un avertissement de batterie faible se déclenche.
devices/wireless_verse_grip/battery/critical_thresholdint—Pourcentage de charge de la batterie en dessous duquel une alerte de niveau critique de la batterie se déclenche.
devices/wireless_verse_grip/battery/reset_marginint—Marge d'hystérésis avant la suppression d'un avertissement de batterie.
devices/wireless_verse_grip/filters/orientation_filterjsondémarrageConfiguration du filtre « One Euro » pour l'orientation sans fil du VerseGrip.

features/…​

features/calibration/…​

CléTypeContraintesDescription
features/calibration/hall_thresholdintplage 1 à 32Niveau du capteur à effet Hall à partir duquel le stylet est considéré comme fixé pendant l'étalonnage.

features/grip_hook/…​

Fonctionnement automatique du crochet de préhension : verrouille le curseur lorsque la poignée est tenue à la verticale.

CléTypeContraintesDescription
features/grip_hook/enabledbool—Activer le verrouillage automatique du crochet de préhension lorsque la poignée est tenue à la verticale.
features/grip_hook/use_hallbool—Utiliser le seuil du capteur à effet Hall plutôt que l'orientation pour détecter la poignée.
features/grip_hook/hallintplage 1 à 32Seuil de valeur du capteur à effet Hall déclenchant le verrouillage de la poignée.
features/grip_hook/hold_durationintplage 10–1 000Durée de maintien du verrouillage après le déclenchement (ms).

features/navigation/bubble/…​

Valeurs par défaut du module de navigation « bulle », transmises à la session lors de la première activation d'un comportement bubble.

CléTypeContraintesDescription
features/navigation/bubble/centervec3—Position par défaut du centre de la bulle.
features/navigation/bubble/max_velocityfloat—Vitesse maximale de navigation dans la zone de vitesse (m/s).
features/navigation/bubble/velocity_zone_widthfloat—Largeur de la zone de vitesse à l'extérieur de la surface de la bulle (m).
features/navigation/bubble/reset_velocity_on_entrybool—Réinitialiser la vitesse à zéro lorsque le curseur entre dans la bulle.
features/navigation/bubble/spring_innerfloat—Coefficient de rigidité au centre de la bulle (N/m).
features/navigation/bubble/spring_surfacefloat—Coefficient de rigidité à la surface de la bulle (N/m).
features/navigation/bubble/spring_outerfloat—Coefficient de rigidité à la limite extérieure (N/m).
features/navigation/bubble/damping_innerfloat—Coefficient d'amortissement au centre de la bulle (Ns/m).
features/navigation/bubble/damping_surfacefloat—Coefficient d'amortissement à la surface de la bulle (Ns/m).
features/navigation/bubble/damping_outerfloat—Coefficient d'amortissement à la limite extérieure (Ns/m).
features/navigation/bubble/wall_stiffnessfloat—Rigidité de la paroi rigide à la limite extérieure (N/m).
features/navigation/bubble/bump_widthfloat—Largeur de la bosse tactile à la surface de la bulle (m).
features/navigation/bubble/bump_stiffnessfloat—Rigidité de la bosse tactile à la surface de la bulle (N/m).

features/safe_trajectory/…​

Limiteur de vitesse pour le mouvement de l'effecteur terminal.

CléTypeContraintesDescription
features/safe_trajectory/enabledbool—Activer le limiteur de vitesse de trajectoire sécuritaire.
features/safe_trajectory/max_velfloatplage 0,01–2,0Vitesse maximale autorisée de l'effecteur terminal (m/s).

features/screensaver/…​

Animation d'inactivité diffusée sur les appareils Inverse3 lorsqu'aucune session n'est active.

CléTypeContraintesDescription
features/screensaver/enabledbool—Activer l'animation de l'économiseur d'écran en cas d'inactivité sur les appareils Inverse3.
features/screensaver/speedfloatplage 0,001–0,2Vitesse d'animation de l'économiseur d'écran.
features/screensaver/distracted_speedfloatplage 0,001–0,2Vitesse de l'animation lorsque l'utilisateur se trouve à proximité sans interagir.

features/sdf/…​

Module d'effets haptiques à champ de distance signé (SDF HFX).

CléTypeContraintesDescription
features/sdf/enabledbool—Activer ou désactiver le module d'effets haptiques SDF.
features/sdf/state_outputbool—Inclure l'état SDF dans les données de sortie de l'appareil par défaut.
features/sdf/max_countintplage 0–128Nombre maximal d'effets SDF actifs (0 = illimité).
features/sdf/events/createdbool—Déclencher un événement lorsqu'un nouvel effet SDF est créé.
features/sdf/events/deletedbool—Déclencher un événement lorsqu'un effet SDF est supprimé.
features/sdf/events/updatedbool—Déclencher un événement lorsqu'un effet SDF est mis à jour.
features/sdf/probe_on_zero_force/enabledbool—Détecter automatiquement les champs SDF lorsque la force appliquée est proche de zéro.
features/sdf/probe_on_zero_force/delayfloatplage 0,001–60,0Délai avant le sondage automatique une fois que la force est tombée à zéro (s).

features/verse_grip_pairing/…​

Suivi de la connexion et de la déconnexion entre l'Inverse3 t l'appareil Verse Grip (avec ou sans fil). Alimente l'interface d'appairage du hub « Haply ».

CléTypeContraintesDescription
features/verse_grip_pairing/enabledbool—Activer l'appairage et le suivi de la mise en place et du retrait.
features/verse_grip_pairing/hall_threshold_vgintplage 1 à 32Niveau du capteur à effet Hall à partir duquel l'appareil filaire VerseGrip est considéré comme fixé.
features/verse_grip_pairing/hall_threshold_wvgintplage 1 à 32Niveau du capteur à effet Hall à partir duquel l'appareil sans fil VerseGrip est considéré comme fixé.
features/verse_grip_pairing/detach_debounce_msintplage 0–1 000Délai d'anti-rebond avant de confirmer un retrait (ms).
features/verse_grip_pairing/heartbeat_msintplage 100–10 000Intervalle entre les renotifications forcées (ms).
features/verse_grip_pairing/force_attachedbool—Forcer en permanence l'état « fixé » à true, en contournant le capteur à effet Hall (solution de contournement en cas de panne matérielle).

serialization/…​

Mise en forme des résultats de transformation — concerne les charges utiles WebSocket et HTTP JSON.

CléTypeContraintesDescription
serialization/explicit_fieldsbool—Inclure les champs de transformation dont la valeur correspond à la valeur d'identité par défaut dans la sortie sérialisée (par exemple position: {0,0,0}, rotation: {w:1,…}). Utile lorsque votre client exige que chaque champ soit explicitement présent. Valeur par défaut : false.
serialization/force_complete_transformsbool—Toujours diffuser position, rotation et scale sur chaque sortie de transformation, y compris pour les appareils à orientation unique (Verse Grip, Wireless Verse Grip), qui n'émettent par ailleurs que rotation. Englobe serialization/explicit_fields. Valeur par défaut : false.

session/…​

Limites du planificateur de session et du pipeline de commandes.

CléTypeContraintesDescription
session/min_simulation_rate_hzintplage 20–500Fréquence minimale acceptable de simulation de l'appareil (Hz) avant le déclenchement d'un avertissement.
session/commands/zoh_window_msint—Fenêtre de maintien d'ordre zéro — supprimer les sondes reçues pendant cette fenêtre (ms).
session/commands/drop_warning_thresholdint—Nombre de commandes rejetées dans la fenêtre avant l'avertissement.
session/commands/drop_warning_window_msint—Durée de la fenêtre glissante pour le comptage des commandes rejetées (ms).
session/commands/tick_on_empty_batchbool—Planifier un rendez-vous de main_loop même lorsqu'un lot WebSocket entier a été rejeté.