Référence des paramètres
Ce document répertorie tous les paramètres du terminal /settings/ renvoie, avec son Clé, leur Type (extrait de type_hint) et leurs Restrictions (extrait de metadata.constraint.range + locked, le cas échéant).
Une locked- Le réglage est lisible uniquement lors de l'exécution. Elle peut être configurée via le fichier de configuration ou via la page des paramètres de Hub Haply peuvent être modifiées, mais Pour que les modifications prennent effet, un redémarrage complet du service est nécessaire.. Ces paramètres sont indiqués dans les tableaux ci-dessous avec démarrer marqué.
Configuration
Le fichier de configuration, qui permet de remplacer les paramètres lors du démarrage du service, se trouve ici :
| Plateforme | Emplacement |
|---|---|
| Windows | C:\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 des clés de paramétrage à des valeurs de remplacement. Les clés doivent être des clés de paramétrage valides, fournies par la /settings/ La route HTTP doit être renvoyée (voir Référence API). Les clés non spécifiées utilisent 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
}
Attribution de type
Les indications de type renvoyées par l'API correspondent aux types JSON suivants :
STRING→stringBOOL→boolINT→intFLOAT→floatARR_STRING→string[]VEC3→vec3(Objet avec{x, y, z})GENERIC→json(valeur structurée quelconque)
communication/…
Ports réseau et adresses Bind pour les serveurs HTTP, WebSocket et Event Stream. La plupart des entrées ne s'appliquent qu'au démarrage (boot).
| Clé | Type | Restrictions | Description |
|---|---|---|---|
communication/serial/enabled | bool | — | Activer ou désactiver la communication série entre les appareils. |
communication/bind_address | string | démarrer | Adresse IP à laquelle les serveurs HTTP et WebSocket sont liés. |
communication/bind_all_interfaces | bool | démarrer | Serveur et 0.0.0.0 au lieu de se connecter à localhost. |
communication/http/port | int | démarrer | Port de l'API HTTP-REST (par défaut : 10000). |
communication/websocket/port | int | démarrer | Port principal pour WebSocket v3.1 (par défaut : 10001). |
communication/websocket/legacy_port | int | démarrer | Port hérité pour WebSocket v3.0 (norme : 10000). |
communication/events/port | int | démarrer | Port pour le flux d'événements WebSocket (par défaut : 10020). |
devices/…
devices/detection/…
Directives relatives à l'analyse des ports série. Toutes les options sont des paramètres avancés.
| Clé | Type | Restrictions | Description |
|---|---|---|---|
devices/detection/scan_period_ms | int | Plage 100–10 000 ; démarrage | Intervalle entre les analyses des ports série (ms). |
devices/detection/handshake_timeout_s | int | Plage 1–15 | Délai d'expiration de la poignée de main par port(s). |
devices/detection/max_retries | int | Plage 1–10 | Nombre maximal de tentatives de handshake par port. |
devices/detection/failure_log_delay_s | int | Plage 1–60 | Délai avant qu'une erreur de reconnaissance ne soit à nouveau enregistrée (s). |
devices/detection/block_looping_ports | bool | — | Bloquer la mise en service de l'appareil lorsqu'un port en boucle est détecté. |
devices/detection/excluded_ports | json | — | Chemins d'accès aux ports série qui sont ignorés lors de la détection. |
devices/detection/additional_ports | string[] | — | Chemins d'accès supplémentaires des ports série qui sont toujours analysés. |
devices/detection/allowed_vendor_id_filter | string[] | — | Identifiants de fournisseur USB autorisés lors de l'énumération des ports. |
devices/detection/port_name_substring_filter | string[] | — | Sous-chaînes de noms de ports spécifiques à la plateforme, utilisées pour le filtrage. |
devices/detection/wireless_verse_grip_description_filter | string[] | — | Sous-chaînes de la description du port permettant de détecter le Wireless-VerseGrip. |
devices/detection/inverse3x_description_filter | string[] | — | Sous-chaînes de la description du port permettant de détecter Inverse3x. |
devices/detection/extra_ports (obsolète) | string[] | — | Au lieu de cela devices/detection/additional_ports utiliser. Les accès en lecture et en écriture sont redirigés de manière transparente vers la clé canonique. |
devices/inverse*/…
Paramètres par défaut globaux applicables à tous les appareils de la gamme « Inverse3 ». Les modifications spécifiques à une session ont la priorité.
| Clé | Type | Restrictions | Description |
|---|---|---|---|
devices/inverse*/filters/force_scale/gain | float | Intervalle 0,0–2,0 | Multiplicateur global de la puissance, appliqué à tous les appareils. |
devices/inverse*/filters/force_gate/gain | float | Intervalle 0,0–1,0 | Renforcement standard du « Kraft-Gate » pour les nouvelles séances. |
devices/inverse*/control_timeout_ms | int | Plage : 50–10 000 | Délai d'expiration après lequel le verrouillage de la commande de l'appareil est levé (ms). |
devices/inverse*/query_orientation_on_idle | bool | — | Interroger le micrologiciel pour connaître l'orientation de l'appareil au repos. |
devices/presets
| Clé | Type | Restrictions | Description |
|---|---|---|---|
devices/presets | json | — | Configurations standard par type d'appareil (transformation de montage, configuration 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é | Type | Restrictions | Description |
|---|---|---|---|
devices/wireless_verse_grip/battery/low_threshold | int | — | Niveau de batterie en pourcentage en dessous duquel un avertissement de batterie faible est déclenché. |
devices/wireless_verse_grip/battery/critical_threshold | int | — | Niveau de batterie en pourcentage, en dessous duquel une alarme est déclenchée en cas de niveau de batterie critique. |
devices/wireless_verse_grip/battery/reset_margin | int | — | Marge d'hystérésis avant la réinitialisation d'un avertissement concernant la batterie. |
devices/wireless_verse_grip/filters/orientation_filter | json | démarrer | Configuration du filtre « One-Euro » pour l'orientation du Wireless-VerseGrip. |
features/…
features/calibration/…
| Clé | Type | Restrictions | Description |
|---|---|---|---|
features/calibration/hall_threshold | int | Plage 1–32 | Niveau du capteur Hall à partir duquel la broche est considérée comme connectée lors de l'étalonnage. |
features/grip_hook/…
Comportement automatique du « Grip-Hook » : bloque le curseur tant que la poignée est maintenue en position verticale.
| Clé | Type | Restrictions | Description |
|---|---|---|---|
features/grip_hook/enabled | bool | — | Activer le verrouillage automatique du Grip-Hook lorsque la poignée est maintenue en position verticale. |
features/grip_hook/use_hall | bool | — | Pour la détection de la prise en main, utiliser le seuil du capteur à effet Hall plutôt que l'orientation. |
features/grip_hook/hall | int | Plage 1–32 | Seuil du capteur à effet Hall qui déclenche le verrouillage de la poignée. |
features/grip_hook/hold_duration | int | Plage 10–1 000 | Durée pendant laquelle le blocage est maintenu après son déclenchement (ms). |
features/navigation/bubble/…
Valeurs par défaut du module de navigation « Bubble » – elles sont transmises à la session dès qu’un bubble- lorsque ce comportement est activé pour la première fois.
| Clé | Type | Restrictions | Description |
|---|---|---|---|
features/navigation/bubble/center | vec3 | — | Position par défaut du centre de la bulle. |
features/navigation/bubble/max_velocity | float | — | Vitesse de navigation maximale dans la zone de vitesse (m/s). |
features/navigation/bubble/velocity_zone_width | float | — | Largeur de la zone de vitesse en dehors de la surface de la « bulle » (m). |
features/navigation/bubble/reset_velocity_on_entry | bool | — | Remettre la vitesse à zéro lorsque le curseur entre dans la bulle. |
features/navigation/bubble/spring_inner | float | — | Coefficient de Feder au centre de la bulle (N/m). |
features/navigation/bubble/spring_surface | float | — | Coefficient de frottement à la surface de la bulle (N/m). |
features/navigation/bubble/spring_outer | float | — | Coefficient de Feder à la limite extérieure (N/m). |
features/navigation/bubble/damping_inner | float | — | Coefficient d'amortissement au centre de la bulle (Ns/m). |
features/navigation/bubble/damping_surface | float | — | Coefficient d'amortissement à la surface de la bulle (Ns/m). |
features/navigation/bubble/damping_outer | float | — | Coefficient d'amortissement à la limite extérieure (Ns/m). |
features/navigation/bubble/wall_stiffness | float | — | Rigidité de la paroi rigide à la limite extérieure (N/m). |
features/navigation/bubble/bump_width | float | — | Largeur de la relief tactile à la surface de la bulle (m). |
features/navigation/bubble/bump_stiffness | float | — | Rigidité de la protubérance tactile à la surface de la bulle (N/m). |
features/safe_trajectory/…
Limiteur de vitesse pour le mouvement de l'effecteur terminal.
| Clé | Type | Restrictions | Description |
|---|---|---|---|
features/safe_trajectory/enabled | bool | — | Activer le limiteur de vitesse pour garantir des trajectoires sûres. |
features/safe_trajectory/max_vel | float | Plage 0,01–2,0 | Vitesse maximale autorisée de l'effecteur terminal (m/s). |
features/screensaver/…
Animation diffusée en arrière-plan sur les appareils Inverse3 lorsqu'aucune session ne les contrôle.
| Clé | Type | Restrictions | Description |
|---|---|---|---|
features/screensaver/enabled | bool | — | Activer l'animation de l'économiseur d'écran en mode veille sur les appareils Inverse3. |
features/screensaver/speed | float | Intervalle 0,001–0,2 | Vitesse de l'animation de l'économiseur d'écran. |
features/screensaver/distracted_speed | float | Intervalle 0,001–0,2 | Vitesse d'animation lorsque l'utilisateur se trouve à proximité, mais n'interagit pas. |
features/sdf/…
Module pour les effets haptiques basé sur les champs de distance signés (SDF HFX).
| Clé | Type | Restrictions | Description |
|---|---|---|---|
features/sdf/enabled | bool | — | Active ou désactive le module dédié aux effets haptiques SDF. |
features/sdf/state_output | bool | — | Intègre par défaut le statut SDF dans les charges utiles de sortie de l'appareil. |
features/sdf/max_count | int | Plage 0–128 | Nombre maximal d'effets SDF actifs (0 = illimité). |
features/sdf/events/created | bool | — | Déclenche un événement lorsqu'un nouvel effet SDF est créé. |
features/sdf/events/deleted | bool | — | Déclenche un événement lorsqu'un effet SDF est supprimé. |
features/sdf/events/updated | bool | — | Déclenche un événement lorsqu'un effet SDF est mis à jour. |
features/sdf/probe_on_zero_force/enabled | bool | — | Interroger automatiquement les champs SDF lorsque la force appliquée est proche de zéro. |
features/sdf/probe_on_zero_force/delay | float | Plage : 0,001–60,0 | Temporisation avant la requête automatique, une fois que la force est tombée à zéro (s). |
features/verse_grip_pairing/…
Détection de la connexion et de la déconnexion entre un « Inverse3 » et un « Verse Grip » (avec ou sans fil). Basé sur l'interface de couplage de l'Haply Hub.
| Clé | Type | Restrictions | Description |
|---|---|---|---|
features/verse_grip_pairing/enabled | bool | — | Active le couplage ou la détection de la connexion et de la déconnexion. |
features/verse_grip_pairing/hall_threshold_vg | int | Plage 1–32 | Niveau de signal à partir duquel un VerseGrip filaire est considéré comme connecté. |
features/verse_grip_pairing/hall_threshold_wvg | int | Plage 1–32 | Niveau de signal à partir duquel un VerseGrip sans fil est considéré comme connecté. |
features/verse_grip_pairing/detach_debounce_ms | int | Plage 0–1 000 | Intervalle de temps d'Entprell avant qu'une coupure ne soit prise en compte (ms). |
features/verse_grip_pairing/heartbeat_ms | int | Plage 100–10 000 | Intervalle entre les nouvelles notifications forcées (ms). |
features/verse_grip_pairing/force_attached | bool | — | Force l'état « connecté » de manière permanente (true) et contourne le capteur à effet Hall (solution de contournement en cas de défaillances matérielles). |
serialization/…
Mise en forme de la sortie de la transformation – concerne les charges utiles WebSocket et HTTP JSON.
| Clé | Type | Restrictions | Description |
|---|---|---|---|
serialization/explicit_fields | bool | — | Inclut dans la sortie sérialisée les champs de transformation dont la valeur par défaut correspond à leur identité (par exemple : position: {0,0,0}, rotation: {w:1,…}). Utile si votre client exige que tous les champs soient explicitement présents. Par défaut : false. |
serialization/force_complete_transforms | bool | — | Y a-t-il toujours, dans chaque résultat de transformation, position, rotation et scale aus, même pour les appareils qui ne mesurent que l'orientation (Verse Grip, Wireless Verse Grip) et qui, par ailleurs, ne font que rotation dépenser. Comprend serialization/explicit_fields. Norme : false. |
session/…
Valeurs limites pour le planificateur de sessions et le pipeline de commandes.
| Clé | Type | Restrictions | Description |
|---|---|---|---|
session/min_simulation_rate_hz | int | Plage 20–500 | Fréquence de simulation minimale acceptable de l'appareil (Hz) ; si cette valeur n'est pas atteinte, un avertissement est émis. |
session/commands/zoh_window_ms | int | — | Fenêtre de retenue d'ordre zéro – supprime les requêtes reçues pendant cette fenêtre (ms). |
session/commands/drop_warning_threshold | int | — | Nombre de commandes rejetées dans la fenêtre à partir duquel un avertissement est émis. |
session/commands/drop_warning_window_ms | int | — | Taille de la fenêtre glissante utilisée pour compter les commandes rejetées (ms). |
session/commands/tick_on_empty_batch | bool | — | Plante-en un main_loop- Cochez cette case même lorsqu'un lot WebSocket entier a été rejeté. |