Einstellungshinweise
In diesem Dokument werden folgende Punkte aufgeführt: /settings/ Alle vom Endpunkt zurückgegebenen Einstellungen sowie die jeweiligen Taste、Typ(aus type_hint) und Beschränkung(aus metadata.constraint.rangesowie, soweit zutreffend, locked).
locked Zur Laufzeit auf folgende Werte setzen:Nur Lesen。Über die Konfigurationsdatei oder Haply Hub Die Änderungen können auf der Einstellungsseite vorgenommen werden, aber damit sie wirksam werden, ist Folgendes erforderlich:Dienst vollständig neu starten。In der folgenden Tabelle sind diese Einstellungen gekennzeichnet als Start。
Konfiguration
Die Konfigurationsdatei, mit der die Einstellungen beim Start des Dienstes überschrieben werden, befindet sich an folgendem Speicherort:
| Plattform | Standort |
|---|---|
| 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 |
Eine Konfigurationsdatei ist eineFlaches JSON-Objekt, wobei die Tastenbelegung auf die Überschreibungswerte zugeordnet wird. Die Tasten müssen /settings/ Gültige Einstellungsschlüssel, die von der HTTP-Weiterleitung zurückgegeben werden (siehe API-Referenz). Für nicht angegebene Schlüssel werden die Standardwerte des Dienstes verwendet.
Beispielsweise ein Beispiel für die Netzwerkkonfiguration:
{
"communication/http/port": 8400,
"communication/websocket/port": 8500,
"communication/events/port": 9000,
"communication/bind_all_interfaces": true
}
Typzuordnung
Die von der API zurückgegebenen Typangaben entsprechen der folgenden JSON-Datenstruktur:
STRING→stringBOOL→boolINT→intFLOAT→floatARR_STRING→string[]VEC3→vec3(einschließlich{x, y, z}(Objekt)GENERIC→json(beliebiger strukturierter Wert)
communication/…
Netzwerkports und gebundene Adressen für HTTP, WebSocket und Event-Stream-Server. Die meisten Einträge werden erstbeim Startwirksam.
| Taste | Typ | Beschränkung | Erläuterung |
|---|---|---|---|
communication/serial/enabled | bool | — | Aktivieren oder Deaktivieren der Kommunikation mit seriellen Geräten. |
communication/bind_address | string | Nur beim Start | Die IP-Adressen, an die die HTTP- und WebSocket-Server gebunden sind. |
communication/bind_all_interfaces | bool | Nur beim Start | Den Server an 0.0.0.0 und nicht „localhost“. |
communication/http/port | int | Nur beim Start | HTTP-REST-API-Port (Standard) 10000). |
communication/websocket/port | int | Nur beim Start | v3.1 Haupt-WebSocket-Port (Standard 10001). |
communication/websocket/legacy_port | int | Nur beim Start | v3.0 – WebSocket-Port der alten Version (Standard) 10000). |
communication/events/port | int | Nur beim Start | Ereignisstrom-WebSocket-Port (Standard 10020). |
devices/…
devices/detection/…
Strategien für die serielle Schnittstelle. Alle Einträge sind erweiterte Optionen.
| Taste | Typ | Beschränkung | Erläuterung |
|---|---|---|---|
devices/detection/scan_period_ms | int | Bereich 100–10.000; nur beim Start | Intervall zwischen den seriellen Abtastungen (in Millisekunden). |
devices/detection/handshake_timeout_s | int | Bereich 1–15 | Zeitlimit für den Handshake pro Port (in Sekunden). |
devices/detection/max_retries | int | Bereich 1–10 | Die maximale Anzahl der Handshake-Wiederholungsversuche pro Port. |
devices/detection/failure_log_delay_s | int | Bereich 1–60 | Verzögerung (in Sekunden) vor der erneuten Protokollierung von Fehlermeldungen. |
devices/detection/block_looping_ports | bool | — | Wenn ein zirkulierender Port erkannt wird, wird verhindert, dass das Gerät in den Bereitschaftszustand wechselt. |
devices/detection/excluded_ports | json | — | Der serielle Pfad, der bei der Prüfung übersprungen werden soll. |
devices/detection/additional_ports | string[] | — | Zusätzliche serielle Schnittstellenpfade für das bedingungslose Scannen. |
devices/detection/allowed_vendor_id_filter | string[] | — | Zulässige USB-Hersteller-IDs bei der Port-Ermittlung. |
devices/detection/port_name_substring_filter | string[] | — | Plattformabhängige Teilzeichenfolgen von Portnamen, die abgeglichen werden sollen. |
devices/detection/wireless_verse_grip_description_filter | string[] | — | Port-Deskriptor-Zeichenkette für die drahtlose VerseGrip-Erkennung. |
devices/detection/inverse3x_description_filter | string[] | — | Die Port-Deskriptor-Zeichenkette für die Inverse3x-Prüfung. |
devices/detection/extra_ports (veraltet) | string[] | — | Bitte verwenden Sie stattdessen devices/detection/additional_ports。Lese- und Schreibvorgänge werden transparent an den Standardschlüssel weitergeleitet. |
devices/inverse*/…
Gilt als globaler Standardwert für alle Geräte der Serie „ Inverse3 “. Einstellungen auf Sitzungsebene haben Vorrang.
| Taste | Typ | Beschränkung | Erläuterung |
|---|---|---|---|
devices/inverse*/filters/force_scale/gain | float | Bereich 0,0–2,0 | Globale Kraftverstärkung, die auf alle Geräte angewendet wird. |
devices/inverse*/filters/force_gate/gain | float | Bereich 0,0–1,0 | Standardwert für die kraftgesteuerte Verstärkung in einer neuen Sitzung. |
devices/inverse*/control_timeout_ms | int | Bereich 50–10.000 | Zeitlimit (in Millisekunden) vor dem Aufheben der Gerätesperre. |
devices/inverse*/query_orientation_on_idle | bool | — | Wenn das Gerät im Leerlauf ist, wird die Lage des Geräts über die Firmware abgefragt. |
devices/presets
| Taste | Typ | Beschränkung | Erläuterung |
|---|---|---|---|
devices/presets | json | — | Die Standardkonfigurationsvoreinstellungen für die einzelnen Gerätetypen (z. B. „mount transform“, „basis“ usw.) umfassen inverse_arm_front_*、inverse_led_front_*、minverse_*、verse_grip_default、wireless_verse_grip_default、custom_verse_grip_default。 |
devices/wireless_verse_grip/…
| Taste | Typ | Beschränkung | Erläuterung |
|---|---|---|---|
devices/wireless_verse_grip/battery/low_threshold | int | — | Wenn der Akkustand unter diesen Prozentsatz fällt, wird eine Warnung bei niedrigem Akkustand ausgelöst. |
devices/wireless_verse_grip/battery/critical_threshold | int | — | Wenn der Ladezustand unter diesen Prozentsatz fällt, wird ein Alarm wegen starkem Ladezustandausfall ausgelöst. |
devices/wireless_verse_grip/battery/reset_margin | int | — | Die Verzögerungszeit bis zum Erscheinen der Akkustandswarnung löschen. |
devices/wireless_verse_grip/filters/orientation_filter | json | Nur beim Start | Konfiguration des „One Euro“-Filters im „VerseGrip“-Modus (drahtlos). |
features/…
features/calibration/…
| Taste | Typ | Beschränkung | Erläuterung |
|---|---|---|---|
features/calibration/hall_threshold | int | Bereich 1–32 | Wenn der Hall-Sensor während der Kalibrierung diesen Spannungspegel erreicht, wird davon ausgegangen, dass der Stift korrekt eingesetzt ist. |
features/grip_hook/…
Automatisches Greifen des Hakens – Der Cursor wird fixiert, solange der Griff aufrecht gehalten wird.
| Taste | Typ | Beschränkung | Erläuterung |
|---|---|---|---|
features/grip_hook/enabled | bool | — | Wenn der Griff aufrecht steht, wird die automatische Verriegelung des Haltehakens aktiviert. |
features/grip_hook/use_hall | bool | — | Bei der Grifferkennung wird nun der Schwellenwert des Hall-Sensors anstelle der Lage herangezogen. |
features/grip_hook/hall | int | Bereich 1–32 | Schwellenwert für den Wert des Hall-Sensors, der die Griffverriegelung auslöst. |
features/grip_hook/hold_duration | int | Bereich 10–1000 | Dauer, für die die Sperre nach der Auslösung aufrechterhalten wird (in Millisekunden). |
features/navigation/bubble/…
Die Standardwerte des Bubble-Navigationsmoduls bei der ersten Aktivierung bubble Wird beim Ausführen der Aktion in die Sitzung übertragen.
| Taste | Typ | Beschränkung | Erläuterung |
|---|---|---|---|
features/navigation/bubble/center | vec3 | — | Die Standardposition des „Bubble“-Zentrums. |
features/navigation/bubble/max_velocity | float | — | Maximale Navigationsgeschwindigkeit (m/s) innerhalb der Geschwindigkeitszone. |
features/navigation/bubble/velocity_zone_width | float | — | Breite des Geschwindigkeitsbereichs an der Außenseite der Blase (m). |
features/navigation/bubble/reset_velocity_on_entry | bool | — | Wenn der Cursor in „Bubble“ eintritt, wird die Geschwindigkeit auf null zurückgesetzt. |
features/navigation/bubble/spring_inner | float | — | Federkonstante (N/m) im Zentrum der Blase. |
features/navigation/bubble/spring_surface | float | — | Federkonstante an der Oberfläche der Blase (N/m). |
features/navigation/bubble/spring_outer | float | — | Federkonstante (N/m) an der Außenkante. |
features/navigation/bubble/damping_inner | float | — | Dämpfungskoeffizient (Ns/m) im Zentrum der Blase. |
features/navigation/bubble/damping_surface | float | — | Dämpfungskoeffizient an der Oberfläche der Blase (Ns/m). |
features/navigation/bubble/damping_outer | float | — | Dämpfungskoeffizient an der Außengrenze (Ns/m). |
features/navigation/bubble/wall_stiffness | float | — | Steifigkeit der starren Wand an der Außenkante (N/m). |
features/navigation/bubble/bump_width | float | — | Breite der taktilen Erhebungen auf der Oberfläche der Blase (m). |
features/navigation/bubble/bump_stiffness | float | — | Steifigkeit der taktilen Erhebungen auf der Oberfläche der Blase (N/m). |
features/safe_trajectory/…
Geschwindigkeitsbegrenzer für die Bewegung des Endantriebs.
| Taste | Typ | Beschränkung | Erläuterung |
|---|---|---|---|
features/safe_trajectory/enabled | bool | — | Aktivieren Sie den Geschwindigkeitsbegrenzer für die Sicherheitsspur. |
features/safe_trajectory/max_vel | float | Bereich 0,01–2,0 | Zulässige maximale Geschwindigkeit des Endantriebs (m/s). |
features/screensaver/…
Eine Leerlaufanimation, die auf dem Gerät „ Inverse3 “ angezeigt wird, wenn das Gerät nicht aktiv ist.
| Taste | Typ | Beschränkung | Erläuterung |
|---|---|---|---|
features/screensaver/enabled | bool | — | Aktivieren Sie die Bildschirmschoner-Animation bei Inaktivität auf dem Inverse3 -Gerät. |
features/screensaver/speed | float | Bereich 0,001–0,2 | Geschwindigkeit der Bildschirmschoner-Animation. |
features/screensaver/distracted_speed | float | Bereich 0,001–0,2 | Die Animationsgeschwindigkeit, wenn sich der Benutzer in der Nähe befindet, aber keine aktive Bedienung vornimmt. |
features/sdf/…
Modul für taktile Effekte auf Basis des Symbol-Distanzfelds (SDF) (SDF HFX).
| Taste | Typ | Beschränkung | Beschreibung |
|---|---|---|---|
features/sdf/enabled | bool | — | Das SDF-Haptik-Effektmodul aktivieren oder deaktivieren. |
features/sdf/state_output | bool | — | Standardmäßig wird der SDF-Status in die Ausgangslast des Geräts einbezogen. |
features/sdf/max_count | int | Bereich 0–128 | Maximale Anzahl gleichzeitig aktiver SDF-Effekte (0 (Angabe nicht erforderlich). |
features/sdf/events/created | bool | — | Dieses Ereignis wird ausgelöst, wenn ein neuer SDF-Effekt erstellt wird. |
features/sdf/events/deleted | bool | — | Ereignis, das beim Entfernen eines SDF-Effekts ausgelöst wird. |
features/sdf/events/updated | bool | — | Löst ein Ereignis aus, wenn der SDF-Effekt aktualisiert wird. |
features/sdf/probe_on_zero_force/enabled | bool | — | Wenn die ausgeübte Kraft nahezu null ist, wird das SDF-Feld automatisch erfasst. |
features/sdf/probe_on_zero_force/delay | float | Bereich 0,001–60,0 | Verzögerung (in Sekunden) zwischen dem Absinken der Kraft auf Null und der automatischen Erkennung. |
features/verse_grip_pairing/…
Inverse3 Verfolgung des Verbindungsaufbaus bzw. der Trennung vom (kabelgebundenen oder kabellosen) Verse Grip. Unterstützung der Kopplungsoberfläche des „ Haply “-Hubs.
| Taste | Typ | Beschränkung | Beschreibung |
|---|---|---|---|
features/verse_grip_pairing/enabled | bool | — | Kopplung aktivieren / Verbindung herstellen – Verfolgung beenden. |
features/verse_grip_pairing/hall_threshold_vg | int | Bereich 1–32 | Sobald der Hall-Pegel diesen Wert erreicht, gilt der kabelgebundene VerseGrip als angeschlossen. |
features/verse_grip_pairing/hall_threshold_wvg | int | Bereich 1–32 | Sobald der Hall-Pegel diesen Wert erreicht, gilt der drahtlose VerseGrip als verbunden. |
features/verse_grip_pairing/detach_debounce_ms | int | Bereich 0–1000 | Bestätige das Jitter-Fenster (in Millisekunden) vor dem Trennen der Verbindung. |
features/verse_grip_pairing/heartbeat_ms | int | Bereich 100–10.000 | Intervall zwischen den erzwungenen erneuten Benachrichtigungen (in Millisekunden). |
features/verse_grip_pairing/force_attached | bool | — | Den Verbindungsstatus dauerhaft auf „verbunden“ setzen true, Umgehung des Hall-Sensors (Ausweichlösung bei Hardwarefehlern). |
serialization/…
Einstellungen für das Ausgabeformat ändern – wirkt sich auf WebSocket- und HTTP-JSON-Nutzdaten aus.
| Taste | Typ | Beschränkung | Beschreibung |
|---|---|---|---|
serialization/explicit_fields | bool | — | In der serialisierten Ausgabe sollen jene Transformationsfelder enthalten sein, deren Wert dem identischen Standardwert entspricht (z. B. position: {0,0,0}、rotation: {w:1,…}). Dies ist nützlich, wenn der Client verlangt, dass jedes Feld explizit vorhanden sein muss. Standardwert:false。 |
serialization/force_complete_transforms | bool | — | In jedem Transformationsergebnis stets enthalten position、rotation und scale, einschließlich Geräten, die lediglich Richtungsinformationen liefern (Verse Grip, Wireless Verse Grip) – andernfalls geben diese Geräte lediglich rotation。Diese Einstellung umfasst serialization/explicit_fields Funktion. Standardwert:false。 |
session/…
Einschränkungen des Sitzungsplaners und der Befehlspipeline.
| Taste | Typ | Beschränkung | Beschreibung |
|---|---|---|---|
session/min_simulation_rate_hz | int | Bereich 20–500 | Der niedrigste zulässige Wert für die Simulationsrate des Geräts (Hz); bei Unterschreitung dieses Werts wird eine Warnung ausgelöst. |
session/commands/zoh_window_ms | int | — | Fenster der Nullordnung – Unterdrückung der innerhalb dieses Fensters empfangenen Signale (Millisekunden). |
session/commands/drop_warning_threshold | int | — | Wenn die Anzahl der im Fenster verworfenen Befehle diesen Wert erreicht, wird eine Warnung ausgelöst. |
session/commands/drop_warning_window_ms | int | — | Größe des gleitenden Fensters zur Erfassung verworfener Befehle (in Millisekunden). |
session/commands/tick_on_empty_batch | bool | — | Selbst wenn der gesamte WebSocket-Stapel verworfen wird, wird die Aufgabe einmal eingeplant. main_loop Häkchen。 |