Référence de configuration
Dans ce document,/settings/ Tous les paramètres renvoyés par le point de terminaison, dans ce Clé,Type(type_hint (origine),Contraintes(metadata.constraint.range Origine, et, le cas échéant, locked) figurent également dans la liste.
locked Ces paramètres sont, au moment de l'exécution,En lecture seule. Fichier de configuration, ou Hub Haply Vous pouvez effectuer ces modifications via la page des paramètres, mais pour que les modifications soient prises en compte,Un redémarrage complet du service est nécessaire. Ces éléments sont présentés dans le tableau ci-dessous : démarrer C'est ce qui est indiqué.
Fichier de configuration
Le fichier de configuration permettant de remplacer les paramètres au démarrage du service se trouve à l'emplacement suivant :
| plateforme | Lieu |
|---|---|
| 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 établit une correspondance entre les clés de configuration et leurs valeurs de remplacement.Objet JSON « plat ». 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). Pour les clés non spécifiées, la valeur par défaut du service est utilisée.
Par exemple, voici comment remplacer les paramètres réseau :
{
"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 aux types JSON suivants :
STRING→stringBOOL→boolINT→intFLOAT→floatARR_STRING→string[]VEC3→vec3({x, y, z}(objet possédant)GENERIC→json(valeur structurée au choix)
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 s'appliquent qu'au moment du démarrage.
| Clé | Type | Contraintes | Explication |
|---|---|---|---|
communication/serial/enabled | bool | — | Active ou désactive la communication par périphérique série. |
communication/bind_address | string | démarrer | Il s'agit de l'adresse IP à laquelle les serveurs HTTP et WebSocket se connectent. |
communication/bind_all_interfaces | bool | démarrer | et non « localhost » 0.0.0.0 Lie le serveur à. |
communication/http/port | int | démarrer | Port de l'API REST HTTP (par défaut : 10000). |
communication/websocket/port | int | démarrer | Port WebSocket de Main v3.1 (par défaut : 10001). |
communication/websocket/legacy_port | int | démarrer | Port WebSocket de Legacy v3.0 (par défaut : 10000). |
communication/events/port | int | démarrer | Port du flux d'événements WebSocket (par défaut : 10020). |
devices/…
devices/detection/…
Il s'agit de la politique de scan des ports série. Tous les éléments relèvent des paramètres avancés.
| Clé | Type | Contraintes | Explication |
|---|---|---|---|
devices/detection/scan_period_ms | int | Plage : 100–10 000 ; démarrage | Intervalle de balayage du port série (ms). |
devices/detection/handshake_timeout_s | int | Plage : 1–15 | Délai d'expiration de la négociation de connexion par port (en secondes). |
devices/detection/max_retries | int | Intervalle : 1–10 | Nombre maximal de tentatives de handshake par port. |
devices/detection/failure_log_delay_s | int | Plage : 1 à 60 | Délai (en secondes) avant qu'un échec de détection ne soit à nouveau consigné dans le journal. |
devices/detection/block_looping_ports | bool | — | Si un port en boucle est détecté, l'état « prêt » du périphérique est bloqué. |
devices/detection/excluded_ports | json | — | Chemin d'accès du port série à ignorer lors de la détection. |
devices/detection/additional_ports | string[] | — | Chemin d'accès d'un port série supplémentaire à analyser sans condition. |
devices/detection/allowed_vendor_id_filter | string[] | — | ID de fournisseur USB autorisés lors de l'énumération des ports. |
devices/detection/port_name_substring_filter | string[] | — | Sous-chaîne correspondant au nom de port spécifique à la plateforme. |
devices/detection/wireless_verse_grip_description_filter | string[] | — | Sous-chaîne de la description du port permettant de détecter le VerseGrip sans fil. |
devices/detection/inverse3x_description_filter | string[] | — | Sous-chaîne de la description du port permettant de détecter Inverse3x. |
devices/detection/extra_ports (Non recommandé) | string[] | — | Au lieu de cela devices/detection/additional_ports Veuillez l'utiliser. Les opérations de lecture et d'écriture sont transmises de manière transparente à la clé principale. |
devices/inverse*/…
Il s'agit d'un paramètre par défaut global qui s'applique à tous les appareils de la gamme « Inverse3 ». Les paramètres définis au cas par cas pour chaque session ont la priorité.
| Clé | Type | Contraintes | Explication |
|---|---|---|---|
devices/inverse*/filters/force_scale/gain | float | Plage : 0,0–2,0 | 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 | Gain par défaut de la porte de puissance pour une nouvelle session. |
devices/inverse*/control_timeout_ms | int | Plage : 50–10 000 | Délai d'expiration (en ms) avant la libération du verrouillage de contrôle du périphérique. |
devices/inverse*/query_orientation_on_idle | bool | — | Lorsque l'appareil est en veille, le micrologiciel interroge l'appareil pour connaître son orientation. |
devices/presets
| Clé | Type | Contraintes | Explication |
|---|---|---|---|
devices/presets | json | — | Préréglages de configuration par défaut pour chaque type de périphérique (inverse_arm_front_*,inverse_led_front_*,minverse_*,verse_grip_default,wireless_verse_grip_default,custom_verse_grip_default (tels que les adaptateurs de montage ou « basis »). |
devices/wireless_verse_grip/…
| Clé | Type | Contraintes | Explication |
|---|---|---|---|
devices/wireless_verse_grip/battery/low_threshold | int | — | Lorsque le niveau de charge de la batterie passe en dessous de ce pourcentage, un avertissement de batterie faible s'affiche. |
devices/wireless_verse_grip/battery/critical_threshold | int | — | Lorsque le niveau de charge de la batterie passe en dessous de ce pourcentage, une alerte de niveau critique de la batterie se déclenche. |
devices/wireless_verse_grip/battery/reset_margin | int | — | Marge d'hystérésis avant la désactivation de l'alerte de batterie. |
devices/wireless_verse_grip/filters/orientation_filter | json | démarrer | Réglage du filtre One Euro en fonction de l'orientation du VerseGrip sans fil. |
features/…
features/calibration/…
| Clé | Type | Contraintes | Explication |
|---|---|---|---|
features/calibration/hall_threshold | int | Plage : 1 à 32 | Niveau du capteur de détection de trou permettant de déterminer si le stylet est en place pendant l'étalonnage. |
features/grip_hook/…
Voici le fonctionnement du crochet de saisie automatique. Il verrouille le curseur tant que vous maintenez le crochet en position verticale.
| Clé | Type | Contraintes | Explication |
|---|---|---|---|
features/grip_hook/enabled | bool | — | Active le verrouillage automatique du crochet de la poignée lorsque celle-ci est tenue à la verticale. |
features/grip_hook/use_hall | bool | — | Pour détecter la prise en main, on utilise le seuil du capteur à trou plutôt que l'orientation. |
features/grip_hook/hall | int | Plage : 1 à 32 | Seuil de la valeur du capteur à trou qui déclenche le verrouillage de la poignée. |
features/grip_hook/hold_duration | int | Plage : 10–1 000 | Durée (en ms) pendant laquelle le verrou est maintenu après le déclenchement. |
features/navigation/bubble/…
Il s'agit des paramètres par défaut du module de navigation « Bubble ».bubble Il est transmis à la session lorsque l'action est activée pour la première fois.
| Clé | Type | Contraintes | Explication |
|---|---|---|---|
features/navigation/bubble/center | vec3 | — | Valeur par défaut de la position centrale de la bulle. |
features/navigation/bubble/max_velocity | float | — | Vitesse maximale de navigation (en m/s) dans la zone de vitesse. |
features/navigation/bubble/velocity_zone_width | float | — | 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 la bulle, la vitesse est remise à zéro. |
features/navigation/bubble/spring_inner | float | — | Coefficient de ressort au centre de la bulle (N/m). |
features/navigation/bubble/spring_surface | float | — | Coefficient de ressort à la surface de la bulle (N/m). |
features/navigation/bubble/spring_outer | float | — | Coefficient de ressort au niveau de la limite extérieure (N/m). |
features/navigation/bubble/damping_inner | float | — | Coefficient d'atténuation au centre de la bulle (Ns/m). |
features/navigation/bubble/damping_surface | float | — | Coefficient d'atténuation à la surface d'une bulle (Ns/m). |
features/navigation/bubble/damping_outer | float | — | Coefficient d'atténuation (Ns/m) à la limite extérieure. |
features/navigation/bubble/wall_stiffness | float | — | Rigidité (N/m) de la paroi rigide située à la limite extérieure. |
features/navigation/bubble/bump_width | float | — | Largeur (en m) des protubérances tactiles situées à la surface de la bulle. |
features/navigation/bubble/bump_stiffness | float | — | Rigidité (N/m) des protubérances tactiles situées à la surface de la bulle. |
features/safe_trajectory/…
Il s'agit d'un limiteur de vitesse pour les mouvements de l'effecteur terminal.
| Clé | Type | Contraintes | Explication |
|---|---|---|---|
features/safe_trajectory/enabled | bool | — | Activer le limiteur de vitesse de la trajectoire de sécurité. |
features/safe_trajectory/max_vel | float | Plage : 0,01–2,0 | Vitesse maximale admissible de l'effecteur terminal (m/s). |
features/screensaver/…
Il s'agit de l'animation d'inactivité qui s'affiche sur les appareils «Inverse3 » lorsqu'aucune session n'est en cours.
| Clé | Type | Contraintes | Explication |
|---|---|---|---|
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 | Vitesse d'animation de l'économiseur d'écran. |
features/screensaver/distracted_speed | float | Plage : 0,001 – 0,2 | Vitesse d'animation lorsque l'utilisateur se trouve à proximité mais n'interagit pas avec l'élément. |
features/sdf/…
Il s'agit du module d'effets tactiles (SDF HFX) du champ de distance signé (SDF).
| Clé | Type | Contraintes | Explication |
|---|---|---|---|
features/sdf/enabled | bool | — | Active ou désactive le module d'effets tactiles SDF. |
features/sdf/state_output | bool | — | Par défaut, l'état du SDF est inclus dans la charge utile de la sortie du périphérique. |
features/sdf/max_count | int | Plage : 0 à 128 | Nombre maximal d'effets SDF valides (0 = (sans limite). |
features/sdf/events/created | bool | — | Émet un événement lorsqu'un nouvel effet SDF est créé. |
features/sdf/events/deleted | bool | — | Émet un événement lorsque l'effet SDF est supprimé. |
features/sdf/events/updated | bool | — | Émet un événement lorsque l'effet SDF est mis à jour. |
features/sdf/probe_on_zero_force/enabled | bool | — | Lorsque la force d'impression est pratiquement nulle, le champ SDF est automatiquement détecté. |
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 force tombe à zéro 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 le Verse Grip (filaire ou sans fil) et l'interface utilisateur de couplage de l'Haply Hub.
| Clé | Type | Contraintes | Explication |
|---|---|---|---|
features/verse_grip_pairing/enabled | bool | — | Active le suivi du couplage et de la pose/du retrait. |
features/verse_grip_pairing/hall_threshold_vg | int | Plage : 1 à 32 | Il s'agit du niveau de trou pour lequel la présence d'un VerseGrip filaire est détectée. |
features/verse_grip_pairing/hall_threshold_wvg | int | Plage : 1 à 32 | Il s'agit du niveau de trou pour lequel la présence d'un VerseGrip sans fil est détectée. |
features/verse_grip_pairing/detach_debounce_ms | int | Plage : 0–1 000 | Il s'agit du temps de rebond (en ms) avant la confirmation du retrait. |
features/verse_grip_pairing/heartbeat_ms | int | Plage : 100–10 000 | Il s'agit de l'intervalle (en ms) entre les renouvellements forcés. |
features/verse_grip_pairing/force_attached | bool | — | Contourner le capteur de trou et vérifier en permanence l'état de montage true le fixer (solution de contournement en cas de panne matérielle). |
serialization/…
Il s'agit des paramètres de format de la sortie de la transformation. Ils ont une incidence sur les charges utiles WebSocket et HTTP JSON.
| Clé | Type | Contraintes | Explication |
|---|---|---|---|
serialization/explicit_fields | bool | — | Incluez dans la sortie sérialisée un champ de transformation dont la valeur par défaut est égale à l'élément d'identité (identity) (par exemple : position: {0,0,0},rotation: {w:1,…}). Cela s'avère utile lorsque le client exige que tous les champs soient explicitement spécifiés. Valeur par défaut : false。 |
serialization/force_complete_transforms | bool | — | Pour toutes les sorties de transformation, y compris les périphériques ne gérant que l'orientation (Verse Grip, Wireless Verse Grip), position,rotation,et scale affiche toujours. En général, rotation Les périphériques qui ne produisent que cela sont également concernés.serialization/explicit_fields comprend les fonctionnalités suivantes. Par défaut : false。 |
session/…
Il s'agit des limites maximales du planificateur de sessions et du pipeline de commandes.
| Clé | Type | Contraintes | Explication |
|---|---|---|---|
session/min_simulation_rate_hz | int | Plage : 20–500 | Il s'agit de la fréquence de simulation minimale (en Hz) autorisée pour l'appareil avant le déclenchement d'un avertissement. |
session/commands/zoh_window_ms | int | — | Il s'agit de la fenêtre de maintien d'ordre zéro. Elle permet de supprimer les sondes reçues pendant cette fenêtre (en ms). |
session/commands/drop_warning_threshold | int | — | Il s'agit du nombre de commandes annulées dans la fenêtre avant l'apparition d'un message d'avertissement. |
session/commands/drop_warning_window_ms | int | — | Taille de la fenêtre glissante (en ms) permettant de compter les commandes rejetées. |
session/commands/tick_on_empty_batch | bool | — | Même si l'ensemble du lot WebSocket est supprimé,main_loop Planifier les tics. |