Übersicht über die Einstellungen
Dieses Dokument listet alle Einstellungen auf, die der Endpunkt /settings/ zurückgibt, mit ihrem Schlüssel, ihrem Typ (aus type_hint) und ihre Einschränkungen (aus metadata.constraint.range + locked, sofern zutreffend).
Eine locked-Einstellung ist zur Laufzeit nur lesbar. Sie kann über die Konfigurationsdatei oder über die Einstellungsseite von Haply Hub geändert werden, doch Damit die Änderungen wirksam werden, ist ein vollständiger Neustart des Dienstes erforderlich. Diese Einstellungen sind in den folgenden Tabellen mit Start gekennzeichnet.
Konfiguration
Die Konfigurationsdatei, mit der die Einstellungen beim Start des Dienstes überschrieben werden, befindet sich hier:
| Plattform | Speicherort |
|---|---|
| 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 |
Die Konfigurationsdatei ist eine einfaches JSON-Objekt, das Einstellungsschlüssel auf Überschreibungswerte abbildet. Schlüssel müssen gültige Einstellungsschlüssel sein, die von der /settings/ HTTP-Route zurückgegeben werden (siehe API-Referenz). Nicht angegebene Schlüssel verwenden den Standardwert des Dienstes.
Zum Beispiel eine Überschreibung der 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 den folgenden JSON-Typen:
STRING→stringBOOL→boolINT→intFLOAT→floatARR_STRING→string[]VEC3→vec3(Objekt mit{x, y, z})GENERIC→json(beliebiger strukturierter Wert)
communication/…
Netzwerk-Ports und Bind-Adressen für die HTTP-, WebSocket- und Event-Stream-Server. Die meisten Einträge sind nur beim Systemstart (boot) wirksam.
| Schlüssel | Typ | Einschränkungen | Beschreibung |
|---|---|---|---|
communication/serial/enabled | bool | — | Serielle Gerätekommunikation aktivieren oder deaktivieren. |
communication/bind_address | string | Start | IP-Adresse, an die die HTTP- und WebSocket-Server gebunden werden. |
communication/bind_all_interfaces | bool | Start | Server und 0.0.0.0 statt an „localhost“ zu binden. |
communication/http/port | int | Start | Port der HTTP-REST-API (Standard: 10000). |
communication/websocket/port | int | Start | Hauptport für WebSocket v3.1 (Standard: 10001). |
communication/websocket/legacy_port | int | Start | Legacy-Port für WebSocket v3.0 (Standard: 10000). |
communication/events/port | int | Start | Port für den WebSocket-Ereignisstrom (Standard: 10020). |
devices/…
devices/detection/…
Richtlinie zum Scannen von seriellen Schnittstellen. Alle Einträge sind erweiterte Einstellungen.
| Schlüssel | Typ | Einschränkungen | Beschreibung |
|---|---|---|---|
devices/detection/scan_period_ms | int | Bereich 100–10.000; boot | Intervall zwischen den Abfragen der seriellen Schnittstellen (ms). |
devices/detection/handshake_timeout_s | int | Bereich 1–15 | Handshake-Timeout pro Port (s). |
devices/detection/max_retries | int | Bereich 1–10 | Maximale Anzahl an Handshake-Wiederholungen pro Port. |
devices/detection/failure_log_delay_s | int | Bereich 1–60 | Verzögerung, bevor ein Erkennungsfehler erneut protokolliert wird (s). |
devices/detection/block_looping_ports | bool | — | Die Gerätebereitschaft blockieren, wenn ein Looping-Port erkannt wird. |
devices/detection/excluded_ports | json | — | Pfade serieller Anschlüsse, die bei der Erkennung übersprungen werden. |
devices/detection/additional_ports | string[] | — | Zusätzliche Pfade für serielle Schnittstellen, die immer gescannt werden. |
devices/detection/allowed_vendor_id_filter | string[] | — | USB-Hersteller-IDs, die bei der Port-Aufzählung zugelassen sind. |
devices/detection/port_name_substring_filter | string[] | — | Plattformspezifische Teilzeichenfolgen von Portnamen, nach denen gefiltert wird. |
devices/detection/wireless_verse_grip_description_filter | string[] | — | Teilzeichenfolgen der Portbeschreibung zur Erkennung von Wireless-VerseGrip. |
devices/detection/inverse3x_description_filter | string[] | — | Teilzeichenfolgen der Portbeschreibung zur Erkennung von Inverse3x. |
devices/detection/extra_ports (veraltet) | string[] | — | Stattdessen devices/detection/additional_ports verwenden. Lese- und Schreibzugriffe werden transparent an den kanonischen Schlüssel weitergeleitet. |
devices/inverse*/…
Globale Standardwerte, die für alle Geräte der „ Inverse3 “-Familie gelten. Sitzungsspezifische Überschreibungen haben Vorrang.
| Schlüssel | Typ | Einschränkungen | Beschreibung |
|---|---|---|---|
devices/inverse*/filters/force_scale/gain | float | Bereich 0,0–2,0 | Globaler Multiplikator für die Kraftabgabe, der auf alle Geräte angewendet wird. |
devices/inverse*/filters/force_gate/gain | float | Bereich 0,0–1,0 | Standardmäßige Verstärkung des Kraft-Gates für neue Sitzungen. |
devices/inverse*/control_timeout_ms | int | Bereich 50–10.000 | Zeitlimit, nach dessen Ablauf die Sperre der Gerätesteuerung aufgehoben wird (ms). |
devices/inverse*/query_orientation_on_idle | bool | — | Die Ausrichtung des Geräts im Leerlauf über die Firmware abfragen. |
devices/presets
| Schlüssel | Typ | Einschränkungen | Beschreibung |
|---|---|---|---|
devices/presets | json | — | Standardgerätkonfigurationen nach Gerätetyp (Montagetransformation, Basis usw. für inverse_arm_front_*, inverse_led_front_*, minverse_*, verse_grip_default, wireless_verse_grip_default, custom_verse_grip_default). |
devices/wireless_verse_grip/…
| Schlüssel | Typ | Einschränkungen | Beschreibung |
|---|---|---|---|
devices/wireless_verse_grip/battery/low_threshold | int | — | Akkustand in Prozent, unterhalb dessen eine Warnung bei niedrigem Akkustand ausgelöst wird. |
devices/wireless_verse_grip/battery/critical_threshold | int | — | Akkustand in Prozent, unterhalb dessen bei kritischem Akkustand ein Alarm ausgelöst wird. |
devices/wireless_verse_grip/battery/reset_margin | int | — | Hysterese-Spielraum, bevor eine Akkuwarnung zurückgesetzt wird. |
devices/wireless_verse_grip/filters/orientation_filter | json | Start | Konfiguration des One-Euro-Filters zur Ausrichtung des Wireless-VerseGrip. |
features/…
features/calibration/…
| Schlüssel | Typ | Einschränkungen | Beschreibung |
|---|---|---|---|
features/calibration/hall_threshold | int | Bereich 1–32 | Hall-Sensor-Pegel, ab dem der Stift bei der Kalibrierung als eingesteckt gilt. |
features/grip_hook/…
Automatisches Verhalten des Grip-Hooks – sperrt den Cursor, solange der Griff aufrecht gehalten wird.
| Schlüssel | Typ | Einschränkungen | Beschreibung |
|---|---|---|---|
features/grip_hook/enabled | bool | — | Die automatische Verriegelung des Grip-Hooks aktivieren, wenn der Griff aufrecht gehalten wird. |
features/grip_hook/use_hall | bool | — | Verwenden Sie für die Griff-Erkennung den Schwellenwert des Hall-Sensors anstelle der Ausrichtung. |
features/grip_hook/hall | int | Bereich 1–32 | Hall-Sensor-Schwellenwert, der die Griffverriegelung auslöst. |
features/grip_hook/hold_duration | int | Bereich 10–1000 | Dauer, für die die Sperre nach dem Auslösen aufrechterhalten wird (ms). |
features/navigation/bubble/…
Standardwerte des Bubble-Navigationsmoduls – werden an die Sitzung übergeben, sobald ein bubble-Verhalten zum ersten Mal aktiviert wird.
| Schlüssel | Typ | Einschränkungen | Beschreibung |
|---|---|---|---|
features/navigation/bubble/center | vec3 | — | Standardposition des Bubble-Mittelpunkts. |
features/navigation/bubble/max_velocity | float | — | Maximale Fahrgeschwindigkeit in der Geschwindigkeitszone (m/s). |
features/navigation/bubble/velocity_zone_width | float | — | Breite der Geschwindigkeitszone außerhalb der Bubble-Oberfläche (m). |
features/navigation/bubble/reset_velocity_on_entry | bool | — | Die Geschwindigkeit auf null zurücksetzen, wenn der Cursor in die Blase eintritt. |
features/navigation/bubble/spring_inner | float | — | Federkoeffizient am Mittelpunkt der Blase (N/m). |
features/navigation/bubble/spring_surface | float | — | Federkoeffizient an der Blasenoberfläche (N/m). |
features/navigation/bubble/spring_outer | float | — | Federkoeffizient an der äußeren Grenze (N/m). |
features/navigation/bubble/damping_inner | float | — | Dämpfungskoeffizient am Mittelpunkt der Blase (Ns/m). |
features/navigation/bubble/damping_surface | float | — | Dämpfungskoeffizient an der Blasenoberfläche (Ns/m). |
features/navigation/bubble/damping_outer | float | — | Dämpfungskoeffizient an der äußeren Grenze (Ns/m). |
features/navigation/bubble/wall_stiffness | float | — | Steifigkeit der harten Wand an der äußeren Grenze (N/m). |
features/navigation/bubble/bump_width | float | — | Breite der taktilen Erhebung auf der Bubble-Oberfläche (m). |
features/navigation/bubble/bump_stiffness | float | — | Steifigkeit der taktilen Erhebung auf der Bubble-Oberfläche (N/m). |
features/safe_trajectory/…
Geschwindigkeitsbegrenzer für die Bewegung des Endeffektors.
| Schlüssel | Typ | Einschränkungen | Beschreibung |
|---|---|---|---|
features/safe_trajectory/enabled | bool | — | Den Geschwindigkeitsbegrenzer für sichere Fahrspuren aktivieren. |
features/safe_trajectory/max_vel | float | Bereich 0,01–2,0 | Maximal zulässige Geschwindigkeit des Endeffektors (m/s). |
features/screensaver/…
Animation, die im Leerlauf auf „ Inverse3 “-Geräten abgespielt wird, wenn keine Sitzung aktiv ist.
| Schlüssel | Typ | Einschränkungen | Beschreibung |
|---|---|---|---|
features/screensaver/enabled | bool | — | Die Bildschirmschoner-Animation im Leerlauf auf Geräten mit „ Inverse3 “ aktivieren. |
features/screensaver/speed | float | Bereich 0,001–0,2 | Geschwindigkeit der Bildschirmschoner-Animation. |
features/screensaver/distracted_speed | float | Bereich 0,001–0,2 | Animationsgeschwindigkeit, wenn sich der Benutzer in der Nähe befindet, aber nicht interagiert. |
features/sdf/…
Modul für haptische Effekte auf Basis von Signed Distance Fields (SDF HFX).
| Schlüssel | Typ | Einschränkungen | Beschreibung |
|---|---|---|---|
features/sdf/enabled | bool | — | Aktiviert oder deaktiviert das Modul für SDF-Haptikeffekte. |
features/sdf/state_output | bool | — | Fügt den SDF-Status standardmäßig in die Ausgabedaten des Geräts ein. |
features/sdf/max_count | int | Bereich 0–128 | Maximale Anzahl aktiver SDF-Effekte (0 = unbegrenzt). |
features/sdf/events/created | bool | — | Löst ein Ereignis aus, wenn ein neuer SDF-Effekt erstellt wird. |
features/sdf/events/deleted | bool | — | Löst ein Ereignis aus, wenn ein SDF-Effekt gelöscht wird. |
features/sdf/events/updated | bool | — | Löst ein Ereignis aus, wenn ein SDF-Effekt aktualisiert wird. |
features/sdf/probe_on_zero_force/enabled | bool | — | SDF-Felder automatisch abfragen, wenn die ausgeübte Kraft nahe Null liegt. |
features/sdf/probe_on_zero_force/delay | float | Bereich 0,001–60,0 | Verzögerung vor der automatischen Abfrage, nachdem die Kraft auf null gesunken ist (s). |
features/verse_grip_pairing/…
Erfassung des Verbindungs- und Trennungsvorgangs zwischen einem „ Inverse3 “ und einem „Verse Grip“ (kabelgebunden oder kabellos). Grundlage: die Kopplungsoberfläche von „ Haply -Hub“.
| Schlüssel | Typ | Einschränkungen | Beschreibung |
|---|---|---|---|
features/verse_grip_pairing/enabled | bool | — | Aktiviert die Kopplung bzw. die Erfassung des Verbindungsaufbaus und der Trennung. |
features/verse_grip_pairing/hall_threshold_vg | int | Bereich 1–32 | Hall-Pegel, ab dem ein kabelgebundener VerseGrip als angeschlossen gilt. |
features/verse_grip_pairing/hall_threshold_wvg | int | Bereich 1–32 | Hall-Pegel, ab dem ein kabelloser VerseGrip als angeschlossen gilt. |
features/verse_grip_pairing/detach_debounce_ms | int | Bereich 0–1000 | Entprellzeitfenster, bevor eine Trennung übernommen wird (ms). |
features/verse_grip_pairing/heartbeat_ms | int | Bereich 100–10.000 | Intervall zwischen erzwungenen erneuten Benachrichtigungen (ms). |
features/verse_grip_pairing/force_attached | bool | — | Erzwingt dauerhaft den Status „verbunden“ (true) und umgeht den Hall-Sensor (Workaround bei Hardwarefehlern). |
serialization/…
Formatierung der Transformationsausgabe – betrifft die Payloads von WebSocket und HTTP-JSON.
| Schlüssel | Typ | Einschränkungen | Beschreibung |
|---|---|---|---|
serialization/explicit_fields | bool | — | Bezieht Transformationsfelder, die ihrem Standardwert für die Identität entsprechen, in die serialisierte Ausgabe ein (z. B. position: {0,0,0}, rotation: {w:1,…}). Nützlich, wenn Ihr Client verlangt, dass alle Felder explizit vorhanden sind. Standard: false. |
serialization/force_complete_transforms | bool | — | Erscheint in jeder Transformationsausgabe immer position, rotation und scale auch bei Geräten, die lediglich die Ausrichtung erfassen (Verse Grip, Wireless Verse Grip) und ansonsten nur rotation ausgeben. Umfasst serialization/explicit_fields. Standard: false. |
session/…
Grenzwerte für den Session-Scheduler und die Befehlspipeline.
| Schlüssel | Typ | Einschränkungen | Beschreibung |
|---|---|---|---|
session/min_simulation_rate_hz | int | Bereich 20–500 | Minimal zulässige Simulationsrate des Geräts (Hz); wird dieser Wert unterschritten, wird eine Warnung ausgegeben. |
session/commands/zoh_window_ms | int | — | Zero-Order-Hold-Fenster – unterdrückt Abfragen, die innerhalb dieses Fensters eingehen (ms). |
session/commands/drop_warning_threshold | int | — | Anzahl der verworfenen Befehle innerhalb des Zeitfensters, ab der eine Warnung ausgegeben wird. |
session/commands/drop_warning_window_ms | int | — | Größe des gleitenden Fensters zum Zählen verworfener Befehle (ms). |
session/commands/tick_on_empty_batch | bool | — | Pflanze einen main_loop- Setze dieses Häkchen auch dann, wenn ein gesamter WebSocket-Batch verworfen wurde. |