Voir les paramètres
Ce document est /settings/ Tous les paramètres renvoyés par le point de terminaison clé, Type(type_hint (critère), Conditions restrictives(metadata.constraint.range et, le cas échéant, locked (critères) sont répertoriés ci-dessous.
locked Les paramètres sont En lecture seule à l'exécutionC'est-à-dire les fichiers de configuration ou Hub Haply Vous pouvez modifier ces paramètres via la page des paramètres, mais pour que les modifications prennent effet, Il faut redémarrer l'ensemble du service.. Dans le tableau ci-dessous, ces paramètres sont démarrerest indiqué par .
Composition
L'emplacement du fichier de configuration permettant de redéfinir les paramètres au démarrage du service est le suivant :
| 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 |
Les fichiers de configuration établissent une correspondance entre les clés de configuration et leurs valeurs de remplacement Objet JSON platC'est ça. La clé est /settings/ Il doit s'agir d'une clé de configuration valide renvoyée par la route HTTP (Référence API (voir). Les clés non spécifiées utilisent les valeurs par défaut du service.
Par exemple, la redéfinition de la configuration réseau se présente comme suit :
{
"communication/http/port": 8400,
"communication/websocket/port": 8500,
"communication/events/port": 9000,
"communication/bind_all_interfaces": true
}
Mappage des types
Les indications de type renvoyées par l'API correspondent au format JSON suivant :
STRING→stringBOOL→boolINT→intFLOAT→floatARR_STRING→string[]VEC3→vec3({x, y, z}(objet possédant)GENERIC→json(valeur structurée arbitraire)
communication/…
Il s'agit des ports réseau et des adresses de liaison des serveurs HTTP, WebSocket et de flux d'événements. La plupart de ces paramètres ne peuvent être configurés qu'au démarrage.
| clé | Type | Conditions restrictives | Description |
|---|---|---|---|
communication/serial/enabled | bool | — | Active ou désactive la communication par port série. |
communication/bind_address | string | Au démarrage | Il s'agit de l'adresse IP à laquelle les serveurs HTTP et WebSocket sont liés. |
communication/bind_all_interfaces | bool | Au démarrage | au lieu de « localhost » 0.0.0.0Lie le serveur à celui-ci. |
communication/http/port | int | Au démarrage | Port de l'API REST HTTP (valeur par défaut 10000) est. |
communication/websocket/port | int | Au démarrage | Port WebSocket par défaut de la version 3.1 (valeur par défaut 10001) est. |
communication/websocket/legacy_port | int | Au démarrage | Port WebSocket Legacy v3.0 (valeur par défaut 10000) est. |
communication/events/port | int | Au démarrage | Port WebSocket du flux d'événements (valeur par défaut 10020) est. |
devices/…
devices/detection/…
Il s'agit de la politique de balayage des ports série. Tous les éléments relèvent des paramètres avancés.
| clé | Type | Conditions restrictives | Description |
|---|---|---|---|
devices/detection/scan_period_ms | int | Plage : 100–10 000 ; au démarrage | Il s'agit de l'intervalle de balayage du port série (en ms). |
devices/detection/handshake_timeout_s | int | Plage 1–15 | Voici le délai maximal (en secondes) pour la procédure de négociation de connexion par port. |
devices/detection/max_retries | int | Plage : 1 à 10 | Il s'agit du nombre maximal de tentatives de handshake par port. |
devices/detection/failure_log_delay_s | int | Plage : 1 à 60 | Il s'agit du délai (en secondes) avant l'enregistrement d'un nouvel échec de détection. |
devices/detection/block_looping_ports | bool | — | Si un port de bouclage est détecté, l'état de préparation de l'appareil est désactivé. |
devices/detection/excluded_ports | json | — | Il s'agit du chemin d'accès au port série à ignorer lors de la détection. |
devices/detection/additional_ports | string[] | — | Il s'agit d'un chemin d'accès à un port série supplémentaire permettant d'effectuer des analyses sans condition. |
devices/detection/allowed_vendor_id_filter | string[] | — | Voici la liste des identifiants de fournisseur USB autorisés lors de l'énumération des ports. |
devices/detection/port_name_substring_filter | string[] | — | Il s'agit de sous-chaînes de noms de ports spécifiques à chaque plateforme à faire correspondre. |
devices/detection/wireless_verse_grip_description_filter | string[] | — | Il s'agit d'une partie de la chaîne de caractères décrivant le port pour la détection sans fil du VerseGrip. |
devices/detection/inverse3x_description_filter | string[] | — | Il s'agit d'une sous-chaîne de la description des ports pour la détection d'Inverse3x. |
devices/detection/extra_ports (Obsolète) | string[] | — | au lieu de cela devices/detection/additional_portsVeuillez utiliser cette fonction. Les opérations de lecture et d'écriture sont transmises de manière transparente via les clés standard. |
devices/inverse*/…
Inverse3 Il s'agit d'une valeur par défaut globale qui s'applique à tous les appareils de la famille. Les modifications par session ont la priorité.
| clé | Type | Conditions restrictives | Description |
|---|---|---|---|
devices/inverse*/filters/force_scale/gain | float | Plage : 0,0–2,0 | Il s'agit du facteur de multiplication de la puissance de sortie global, applicable à tous les appareils. |
devices/inverse*/filters/force_gate/gain | float | Intervalle : 0,0–1,0 | Il s'agit du gain par défaut du « Power Gate » pour une nouvelle session. |
devices/inverse*/control_timeout_ms | int | Plage : 50–10 000 | Il s'agit du délai (en ms) avant le déverrouillage du contrôle du périphérique. |
devices/inverse*/query_orientation_on_idle | bool | — | Lorsque l'appareil est inactif, le micrologiciel vérifie l'orientation de l'appareil. |
devices/presets
| clé | Type | Conditions restrictives | Description |
|---|---|---|---|
devices/presets | json | — | Il s'agit des préréglages de configuration par défaut pour chaque type d'appareil (inverse_arm_front_*, inverse_led_front_*, minverse_*, verse_grip_default, wireless_verse_grip_default, custom_verse_grip_default(transformation de montage (mount transform), base, etc.). |
devices/wireless_verse_grip/…
| clé | Type | Conditions restrictives | Description |
|---|---|---|---|
devices/wireless_verse_grip/battery/low_threshold | int | — | Si le niveau de charge de la batterie (%) passe en dessous de cette valeur, un avertissement de batterie faible s'affiche. |
devices/wireless_verse_grip/battery/critical_threshold | int | — | Si le niveau de charge de la batterie (%) descend en dessous de cette valeur, une alerte de batterie faible s'affiche. |
devices/wireless_verse_grip/battery/reset_margin | int | — | Il s'agit de la marge d'hystérésis avant le désactivation de l'alerte de batterie. |
devices/wireless_verse_grip/filters/orientation_filter | json | Au démarrage | Il s'agit des paramètres du filtre One Euro pour le VerseGrip sans fil. |
features/…
features/calibration/…
| clé | Type | Conditions restrictives | Description |
|---|---|---|---|
features/calibration/hall_threshold | int | Plage 1–32 | Il s'agit du niveau du capteur à trou qui, pendant l'étalonnage, est considéré comme étant équipé d'un stylet. |
features/grip_hook/…
Le crochet de saisie fonctionne automatiquement. Il maintient le curseur en place tant que vous tenez la poignée en position verticale.
| clé | Type | Conditions restrictives | Description |
|---|---|---|---|
features/grip_hook/enabled | bool | — | Cela active le verrouillage automatique du crochet de la poignée lorsque celle-ci est tenue bien droite. |
features/grip_hook/use_hall | bool | — | Pour la détection de la prise en main, on utilise le seuil du capteur de trou plutôt que la direction. |
features/grip_hook/hall | int | Plage 1–32 | Il s'agit du seuil de la valeur du capteur à effondrement qui déclenche le verrouillage de la poignée. |
features/grip_hook/hold_duration | int | Plage : 10–1 000 | Il s'agit de la durée (en ms) pendant laquelle le verrouillage est maintenu après le déclenchement. |
features/navigation/bubble/…
Il s'agit des valeurs par défaut du module de navigation « Bubble ». bubble Il est transmis à la session lors de la première activation de l'action.
| clé | Type | Conditions restrictives | Description |
|---|---|---|---|
features/navigation/bubble/center | vec3 | — | Il s'agit de la valeur par défaut pour la position centrale de la bulle. |
features/navigation/bubble/max_velocity | float | — | Il s'agit de la vitesse de navigation maximale (en m/s) dans cette plage de vitesse. |
features/navigation/bubble/velocity_zone_width | float | — | Il s'agit de la largeur (en mètres) de la zone de vitesse située à l'extérieur de la surface de la bulle. |
features/navigation/bubble/reset_velocity_on_entry | bool | — | Lorsque le curseur entre dans une bulle, sa vitesse est réinitialisée à 0. |
features/navigation/bubble/spring_inner | float | — | Il s'agit du coefficient de ressort (N/m) au centre de la bulle. |
features/navigation/bubble/spring_surface | float | — | Il s'agit du coefficient de ressort (N/m) à la surface de la bulle. |
features/navigation/bubble/spring_outer | float | — | Il s'agit du coefficient de ressort (N/m) au niveau de la limite extérieure. |
features/navigation/bubble/damping_inner | float | — | Il s'agit du coefficient d'atténuation (Ns/m) au centre de la bulle. |
features/navigation/bubble/damping_surface | float | — | Il s'agit du coefficient d'atténuation (Ns/m) à la surface d'une bulle. |
features/navigation/bubble/damping_outer | float | — | Il s'agit du coefficient d'atténuation (Ns/m) à la limite extérieure. |
features/navigation/bubble/wall_stiffness | float | — | Il s'agit de la rigidité (N/m) du mur rigide situé à la limite extérieure. |
features/navigation/bubble/bump_width | float | — | Il s'agit de la largeur (en m) des protubérances tactiles à la surface de la bulle. |
features/navigation/bubble/bump_stiffness | float | — | Il s'agit de la rigidité (N/m) des protubérances tactiles à la surface des bulles. |
features/safe_trajectory/…
Il s'agit d'un limiteur de vitesse pour les mouvements de l'effecteur terminal.
| clé | Type | Conditions restrictives | Description |
|---|---|---|---|
features/safe_trajectory/enabled | bool | — | Activez le limiteur de vitesse de sécurité. |
features/safe_trajectory/max_vel | float | Plage : 0,01–2,0 | Il s'agit de la vitesse maximale autorisée (en m/s) de l'effecteur terminal. |
features/screensaver/…
Il s'agit d'une animation d'inactivité qui s'affiche sur les appareils Inverse3 lorsque la session n'est pas active.
| clé | Type | Conditions restrictives | Description |
|---|---|---|---|
features/screensaver/enabled | bool | — | Inverse3 Active l'animation de l'économiseur d'écran lorsque l'appareil est inactif. |
features/screensaver/speed | float | Plage : 0,001 – 0,2 | Il s'agit de la vitesse d'animation de l'économiseur d'écran. |
features/screensaver/distracted_speed | float | Plage : 0,001 – 0,2 | Il s'agit de la vitesse d'animation lorsque l'utilisateur se trouve à proximité mais n'effectue aucune action. |
features/sdf/…
Il s'agit d'un module d'effets haptiques basé sur le champ de distance signé (SDF HFX).
| clé | Type | Conditions restrictives | Description |
|---|---|---|---|
features/sdf/enabled | bool | — | Active ou désactive le module d'effets haptiques SDF. |
features/sdf/state_output | bool | — | Par défaut, la charge utile de sortie de l'appareil inclut l'état SDF. |
features/sdf/max_count | int | Plage : 0 à 128 | Il s'agit du nombre maximal d'effets SDF actifs (0 = illimité). |
features/sdf/events/created | bool | — | Lorsqu'un nouvel effet SDF est créé, un événement est déclenché. |
features/sdf/events/deleted | bool | — | Si l'effet SDF est supprimé, un événement est déclenché. |
features/sdf/events/updated | bool | — | Un événement est déclenché lorsque l'effet SDF est mis à jour. |
features/sdf/probe_on_zero_force/enabled | bool | — | Le champ SDF est automatiquement sondé lorsque la force appliquée est proche de zéro. |
features/sdf/probe_on_zero_force/delay | float | Plage : 0,001–60,0 | Il s'agit du temps de retard (en secondes) entre le moment où la puissance tombe à 0 et le début de la sonde automatique. |
features/verse_grip_pairing/…
Inverse3 Il s'agit du suivi de la connexion et de la déconnexion entre l'appareil et le Verse Grip (filaire ou sans fil). Cela sert de base à l'interface utilisateur de couplage du Hub « Haply ».
| clé | Type | Conditions restrictives | Description |
|---|---|---|---|
features/verse_grip_pairing/enabled | bool | — | Active le suivi du couplage / de la connexion et de la déconnexion. |
features/verse_grip_pairing/hall_threshold_vg | int | Plage 1–32 | Pour le VerseGrip filaire, il s'agit du niveau de trou considéré comme étant fixé. |
features/verse_grip_pairing/hall_threshold_wvg | int | Plage 1–32 | Pour le VerseGrip sans fil, il s'agit du niveau de trou considéré comme étant fixé. |
features/verse_grip_pairing/detach_debounce_ms | int | Plage : 0–1 000 | Il s'agit de la période de rebond précédant la confirmation de la séparation (en ms). |
features/verse_grip_pairing/heartbeat_ms | int | Plage : 100–10 000 | Il s'agit de l'intervalle entre les rappels forcés (en ms). |
features/verse_grip_pairing/force_attached | bool | — | En contournant le capteur de trou, vérifier l'état de fixation truepour le verrouiller de manière permanente (afin de contourner les pannes matérielles). |
serialization/…
Format de sortie « Transform » — A une incidence sur les charges utiles JSON des protocoles WebSocket et HTTP.
| clé | Type | Conditions restrictives | Description |
|---|---|---|---|
serialization/explicit_fields | bool | — | Dans une sortie sérialisée, les champs de transformation tels que la valeur par défaut d'identité (par exemple : position: {0,0,0}, rotation: {w:1,…}) est également inclus. Cela s'avère utile lorsque tous les champs doivent être explicitement présents au niveau du client. Valeur par défaut : false. |
serialization/force_complete_transforms | bool | — | À toutes les sorties « transform », y compris les dispositifs qui n'affichent que la direction (Verse Grip, Wireless Verse Grip) : position, rotation, Et puis scalecomprend toujours. Ces appareils, qui, sans cela, rotationAffiche uniquement. serialization/explicit_fieldscomprend les opérations suivantes. Valeur par défaut : false. |
session/…
Il s'agit de limitations liées au planificateur de sessions et au pipeline de commandes.
| clé | Type | Conditions restrictives | Description |
|---|---|---|---|
session/min_simulation_rate_hz | int | Plage : 20–500 | Il s'agit de la fréquence minimale admissible (en Hz) de la simulation de l'appareil avant le déclenchement d'un avertissement. |
session/commands/zoh_window_ms | int | — | Fenêtre de retenue d'ordre zéro — Supprime les sondes reçues pendant cet intervalle (ms). |
session/commands/drop_warning_threshold | int | — | Il s'agit du nombre de commandes déposées dans la fenêtre avant l'apparition de l'avertissement. |
session/commands/drop_warning_window_ms | int | — | Taille de la fenêtre glissante utilisée pour agréger les commandes perdues (en ms). |
session/commands/tick_on_empty_batch | bool | — | Même si l'ensemble de la session WebSocket a été interrompu, main_loop Planification des tics. |