Aller au contenu principal

Guide de configuration

Ce document répertorie /settings/ Tous les paramètres renvoyés par le point de terminaison, ainsi que, pour chaque paramètre, Touche,Type(Source : type_hint) et Contrainte(Source : metadata.constraint.range, ainsi que, le cas échéant, locked).

locked Configurer à l'exécution comme suit :Lecture seule。Via un fichier de configuration ou Hub Haply Effectuez les modifications dans la page de configuration, mais pour que celles-ci prennent effet, il fautRedémarrer complètement le service。Dans le tableau ci-dessous, ces paramètres sont indiqués par démarrer。

Configuration​

Le fichier de configuration permettant de remplacer les paramètres lors du démarrage du service se trouve à l'emplacement suivant :

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

Un fichier de configuration est unObjet JSON « plat », permet d'attribuer une touche à une valeur de remplacement. La touche doit être /settings/ Clés de configuration valides renvoyées par le routage HTTP (voir Documentation de l'API). Les clés non spécifiées utiliseront les valeurs par défaut du service.

Par exemple, voici un exemple de configuration réseau :

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

Mappage de types​

Les indications de type renvoyées par l'API correspondent à la structure de données JSON suivante :

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

communication/…​

Ports réseau et adresses de liaison des serveurs HTTP, WebSocket et de flux d'événements. La plupart des entrées ne prennent effetqu'au démarrage.

ToucheTypeContrainteExplication
communication/serial/enabledbool—Activer ou désactiver la communication avec les périphériques série.
communication/bind_addressstringUniquement au démarrageLes adresses IP auxquelles sont associés les serveurs HTTP et WebSocket.
communication/bind_all_interfacesboolUniquement au démarrageLier le serveur à 0.0.0.0 et non « localhost ».
communication/http/portintUniquement au démarragePort de l'API REST HTTP (par défaut) 10000).
communication/websocket/portintUniquement au démarragev3.1 Port WebSocket principal (par défaut) 10001).
communication/websocket/legacy_portintUniquement au démarragev3.0 Ancien port WebSocket (par défaut) 10000).
communication/events/portintUniquement au démarragePort WebSocket pour le flux d'événements (par défaut) 10020).

devices/…​

devices/detection/…​

Stratégie de balayage des ports série. Toutes les entrées correspondent à des options avancées.

ToucheTypeContrainteExplication
devices/detection/scan_period_msintPlage : 100–10 000 ; uniquement au démarrageIntervalle entre deux balayages du port série (en millisecondes).
devices/detection/handshake_timeout_sintPlage : 1–15Délai d'expiration de la négociation pour chaque port (en secondes).
devices/detection/max_retriesintPlage : 1–10Nombre maximal de tentatives de négociation par port.
devices/detection/failure_log_delay_sintPlage : 1 à 60Délai (en secondes) avant la réenregistrement du journal des échecs de détection.
devices/detection/block_looping_portsbool—Lorsqu'un port en boucle est détecté, empêcher l'appareil de passer à l'état « prêt ».
devices/detection/excluded_portsjson—Chemin d'accès au port série à ignorer lors du test.
devices/detection/additional_portsstring[]—Chemin d'accès supplémentaire au port série pour la numérisation sans condition.
devices/detection/allowed_vendor_id_filterstring[]—ID de fabricant USB autorisés lors de l'énumération des ports.
devices/detection/port_name_substring_filterstring[]—Sous-chaîne de nom de port utilisée pour la correspondance, qui varie selon la plateforme.
devices/detection/wireless_verse_grip_description_filterstring[]—Chaîne de caractères décrivant le port utilisé pour la détection sans fil de VerseGrip.
devices/detection/inverse3x_description_filterstring[]—Chaîne de caractères décrivant le descripteur de port utilisé pour la détection Inverse3x.
devices/detection/extra_ports (obsolète)string[]—Veuillez utiliser à la place devices/detection/additional_ports. Les opérations de lecture et d'écriture sont transmises de manière transparente à la clé de spécification.

devices/inverse*/…​

Valeurs par défaut globales applicables à tous les appareils de la gamme Inverse3 . Les paramètres de remplacement au niveau de la session ont la priorité.

ToucheTypeContrainteExplication
devices/inverse*/filters/force_scale/gainfloatPlage : 0,0–2,0Facteur de multiplication de la force de sortie global applicable à tous les appareils.
devices/inverse*/filters/force_gate/gainfloatIntervalle : 0,0–1,0Gain de commande par tension par défaut pour la nouvelle session.
devices/inverse*/control_timeout_msintPlage : 50–10 000Délai d'expiration (en millisecondes) avant la libération du verrou de contrôle du périphérique.
devices/inverse*/query_orientation_on_idlebool—Lorsque l'appareil est inactif, il interroge le micrologiciel pour connaître son orientation.

devices/presets​

ToucheTypeContrainteExplication
devices/presetsjson—Les préréglages de configuration par défaut pour chaque type d'équipement (transformation de montage, base, etc.) couvrent inverse_arm_front_*,inverse_led_front_*,minverse_*,verse_grip_default,wireless_verse_grip_default,custom_verse_grip_default。

devices/wireless_verse_grip/…​

ToucheTypeContrainteExplication
devices/wireless_verse_grip/battery/low_thresholdint—L'alerte de batterie faible se déclenche lorsque le niveau de charge est inférieur à ce pourcentage.
devices/wireless_verse_grip/battery/critical_thresholdint—Une alerte de niveau de charge très faible se déclenche lorsque la charge est inférieure à ce pourcentage.
devices/wireless_verse_grip/battery/reset_marginint—Supprimer la marge de retard avant l'avertissement de niveau de charge.
devices/wireless_verse_grip/filters/orientation_filterjsonUniquement au démarrageConfiguration du filtre « One Euro » en mode sans fil « VerseGrip ».

features/…​

features/calibration/…​

ToucheTypeContrainteExplication
features/calibration/hall_thresholdintPlage : 1 à 32Pendant la procédure d'étalonnage, lorsque le capteur à effet Hall atteint ce niveau de tension, le stylo est considéré comme correctement installé.

features/grip_hook/…​

Comportement automatique du crochet de préhension : le curseur se verrouille lorsque la poignée est en position verticale.

ToucheTypeContrainteExplication
features/grip_hook/enabledbool—Lorsque la poignée est en position verticale, le verrouillage automatique du crochet de préhension s'active.
features/grip_hook/use_hallbool—La détection de la prise en main utilise désormais le seuil du capteur à effet Hall plutôt que l'orientation.
features/grip_hook/hallintPlage : 1 à 32Seuil de valeur du capteur à effet Hall déclenchant le verrouillage de la prise.
features/grip_hook/hold_durationintPlage : 10–1 000Durée pendant laquelle le verrouillage est maintenu après le déclenchement (en millisecondes).

features/navigation/bubble/…​

Valeurs par défaut du module de navigation « Bubble » lors de sa première activation bubble La session est transmise lors de l'exécution de l'action.

ToucheTypeContrainteExplication
features/navigation/bubble/centervec3—Position par défaut du centre de la bulle.
features/navigation/bubble/max_velocityfloat—Vitesse maximale de navigation (en m/s) dans la zone de vitesse.
features/navigation/bubble/velocity_zone_widthfloat—Largeur de la zone de vitesse à l'extérieur de la bulle (m).
features/navigation/bubble/reset_velocity_on_entrybool—Lorsque le curseur entre dans Bubble, sa vitesse est remise à zéro.
features/navigation/bubble/spring_innerfloat—Coefficient de ressort au centre de la bulle (N/m).
features/navigation/bubble/spring_surfacefloat—Coefficient de ressort à la surface de la bulle (N/m).
features/navigation/bubble/spring_outerfloat—Coefficient de ressort (N/m) au niveau de la limite extérieure.
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 (Ns/m) au niveau de la limite extérieure.
features/navigation/bubble/wall_stiffnessfloat—Rigidité (N/m) de la paroi rigide au niveau de la limite extérieure.
features/navigation/bubble/bump_widthfloat—Largeur des reliefs tactiles à la surface de la bulle (m).
features/navigation/bubble/bump_stiffnessfloat—Rigidité (N/m) des reliefs tactiles à la surface de la bulle.

features/safe_trajectory/…​

Limiteur de vitesse pour le mouvement des actionneurs finaux.

ToucheTypeContrainteExplication
features/safe_trajectory/enabledbool—Activer le limiteur de vitesse de sécurité.
features/safe_trajectory/max_velfloatPlage : 0,01–2,0Vitesse maximale autorisée de l'actionneur terminal (m/s).

features/screensaver/…​

Animation d'inactivité diffusée sur l'appareil « Inverse3 » lorsqu'aucun périphérique n'est connecté.

ToucheTypeContrainteExplication
features/screensaver/enabledbool—Activer l'animation d'écran de veille sur l'appareil Inverse3 .
features/screensaver/speedfloatPlage : 0,001 – 0,2Vitesse de l'animation de l'écran de veille.
features/screensaver/distracted_speedfloatPlage : 0,001 – 0,2Vitesse de l'animation lorsque l'utilisateur est à proximité mais n'effectue aucune action.

features/sdf/…​

Module d'effets tactiles « Symbolic Distance Field » (SDF HFX).

ToucheTypeContrainteDescription
features/sdf/enabledbool—Activer ou désactiver le module d'effets tactiles SDF.
features/sdf/state_outputbool—Par défaut, l'état SDF est inclus dans la charge de sortie de l'appareil.
features/sdf/max_countintPlage : 0 à 128Nombre maximal d'effets SDF pouvant être activés simultanément (0 (sans restriction).
features/sdf/events/createdbool—Événement déclenché lors de la création d'un nouvel effet SDF.
features/sdf/events/deletedbool—Événement déclenché lors de la suppression d'un effet SDF.
features/sdf/events/updatedbool—Événement déclenché lors de la mise à jour des effets SDF.
features/sdf/probe_on_zero_force/enabledbool—Lorsque la force appliquée est proche de zéro, le champ SDF est détecté automatiquement.
features/sdf/probe_on_zero_force/delayfloatPlage : 0,001–60,0Délai (en secondes) entre la chute de la force à zéro et le début de la détection automatique.

features/verse_grip_pairing/…​

Inverse3 Suivi de la connexion/déconnexion avec le Verse Grip (filaire ou sans fil). Prise en charge de l'interface d'appairage du hub « Haply ».

ToucheTypeContrainteDescription
features/verse_grip_pairing/enabledbool—Activer le couplage / Connexion-Déconnexion du suivi.
features/verse_grip_pairing/hall_threshold_vgintPlage : 1 à 32Lorsque le niveau de Hall atteint cette valeur, le VerseGrip filaire est considéré comme connecté.
features/verse_grip_pairing/hall_threshold_wvgintPlage : 1 à 32Lorsque le niveau de Hall atteint cette valeur, le VerseGrip sans fil est considéré comme connecté.
features/verse_grip_pairing/detach_debounce_msintPlage : 0–1 000Confirmer la fenêtre d'anti-rebond (en millisecondes) avant la déconnexion.
features/verse_grip_pairing/heartbeat_msintPlage : 100–10 000Intervalle (en millisecondes) entre les renouvellements forcés des notifications.
features/verse_grip_pairing/force_attachedbool—Définir de manière permanente l'état « connecté » comme true, en contournant le capteur à effet Hall (solution de contournement en cas de défaillance matérielle).

serialization/…​

Paramètres de conversion du format de sortie — Cela affecte les charges JSON WebSocket et HTTP.

ToucheTypeContrainteDescription
serialization/explicit_fieldsbool—Inclure dans la sortie sérialisée les champs de transformation dont la valeur est égale à leur valeur par défaut (par exemple position: {0,0,0},rotation: {w:1,…}). Cela s'avère utile lorsque le client exige que chaque champ soit explicitement présent. Valeur par défaut :false。
serialization/force_complete_transformsbool—Veillez à toujours inclure dans chaque sortie de transformation position,rotation et scale, y compris les appareils ne fournissant que des informations de direction (Verse Grip, Wireless Verse Grip) — sans quoi ces appareils ne transmettent que rotation. Ce paramètre couvre serialization/explicit_fields Fonctionnalité. Valeur par défaut :false。

session/…​

Limites du planificateur de sessions et du pipeline de commandes.

ToucheTypeContrainteDescription
session/min_simulation_rate_hzintPlage : 20–500Valeur minimale acceptable de la fréquence de simulation de l'équipement (Hz) ; en dessous de cette valeur, un avertissement est déclenché.
session/commands/zoh_window_msint—Fenêtre de conservation d'ordre zéro — Suppression des détections reçues au cours de cette fenêtre (en millisecondes).
session/commands/drop_warning_thresholdint—Un avertissement est déclenché lorsque le nombre de commandes rejetées dans la fenêtre atteint cette valeur.
session/commands/drop_warning_window_msint—Taille de la fenêtre glissante (en millisecondes) utilisée pour compter les commandes ignorées.
session/commands/tick_on_empty_batchbool—Même si l'ensemble du lot WebSocket est rejeté, la tâche est tout de même planifiée une fois. main_loop coche。