Konfigurationsreferenz
In diesem Dokument wird,/settings/ Alle vom Endpunkt zurückgegebenen Einstellungen, deren Schlüssel、Typ(type_hint Herkunft),Einschränkungen(metadata.constraint.range Herkunft sowie, falls zutreffend, locked) haben wir in einer Übersicht zusammengefasst.
locked Die Einstellungen werden bei der AusführungNur-Lese-Zugriff. Konfigurationsdatei oder Haply Hub Sie können dies über die Einstellungsseite ändern, doch damit die Änderungen wirksam werden,Ein vollständiger Neustart des Dienstes ist erforderlich. Diese sind in der folgenden Tabelle aufgeführt Start wird angezeigt.
Konfigurationsdatei
Die Konfigurationsdatei, mit der die Einstellungen beim Start des Dienstes überschrieben werden können, befindet sich an folgendem Speicherort:
| Plattform | Ort |
|---|---|
| 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 ordnet den Konfigurationsschlüsseln die entsprechenden Werte zu.Flaches JSON-Objekt. Der Schlüssel lautet:/settings/ Es muss sich um einen gültigen Konfigurationsschlüssel handeln, der von der HTTP-Route zurückgegeben wird (API-Referenz(siehe dort). Für nicht angegebene Schlüssel werden die Standardwerte des Dienstes verwendet.
Beispielsweise erfolgt das Überschreiben der Netzwerkeinstellungen wie folgt:
{
"communication/http/port": 8400,
"communication/websocket/port": 8500,
"communication/events/port": 9000,
"communication/bind_all_interfaces": true
}
Typzuordnung
Die von der API zurückgegebenen Typhinweise entsprechen den folgenden JSON-Typen:
STRING→stringBOOL→boolINT→intFLOAT→floatARR_STRING→string[]VEC3→vec3({x, y, z}(Objekt, das … besitzt)GENERIC→json(beliebiger strukturierter Wert)
communication/…
Dies sind die Netzwerkports und Bind-Adressen für HTTP, WebSocket und den Event-Stream-Server. Die meisten Einträge gelten nur beim Systemstart.
| Schlüssel | Typ | Einschränkungen | Erläuterung |
|---|---|---|---|
communication/serial/enabled | bool | — | Aktiviert oder deaktiviert die Kommunikation mit seriellen Geräten. |
communication/bind_address | string | Start | Dies ist die IP-Adresse, an die der HTTP- und WebSocket-Server gebunden ist. |
communication/bind_all_interfaces | bool | Start | nicht „localhost“, sondern 0.0.0.0 den Server daran bindet. |
communication/http/port | int | Start | Port der HTTP-REST-API (Standard ist 10000). |
communication/websocket/port | int | Start | Haupt v3.1 WebSocket-Port (Standard ist 10001). |
communication/websocket/legacy_port | int | Start | Legacy v3.0 WebSocket-Port (Standardwert ist 10000). |
communication/events/port | int | Start | Port des WebSocket-Ereignisstroms (Standardwert ist 10020). |
devices/…
devices/detection/…
Dies sind die Scan-Richtlinien für die serielle Schnittstelle. Alle Einträge sind erweiterte Einstellungen.
| Schlüssel | Typ | Einschränkungen | Erläuterung |
|---|---|---|---|
devices/detection/scan_period_ms | int | Bereich 100–10000; boot | Scan-Intervall für den seriellen Anschluss (ms). |
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 | Maximale Anzahl der Wiederholungsversuche für den Handshake pro Port. |
devices/detection/failure_log_delay_s | int | Bereich 1–60 | Verzögerungszeit (in Sekunden), bis ein Erkennungsfehler erneut protokolliert wird. |
devices/detection/block_looping_ports | bool | — | Wird ein Port im Schleifenzustand erkannt, wird der Bereitschaftszustand des Geräts blockiert. |
devices/detection/excluded_ports | json | — | Pfad des seriellen Anschlusses, der bei der Erkennung übersprungen werden soll. |
devices/detection/additional_ports | string[] | — | Pfad zu einem zusätzlichen seriellen Anschluss, der bedingungslos gescannt werden soll. |
devices/detection/allowed_vendor_id_filter | string[] | — | USB-Hersteller-IDs, die bei der Auflistung der Anschlüsse zugelassen werden. |
devices/detection/port_name_substring_filter | string[] | — | Teilzeichenfolge des plattformspezifischen Portnamens, die abgeglichen werden soll. |
devices/detection/wireless_verse_grip_description_filter | string[] | — | Teilzeichenfolge aus der Portbeschreibung zur Erkennung des kabellosen VerseGrip. |
devices/detection/inverse3x_description_filter | string[] | — | Teilzeichenfolge aus der Portbeschreibung zur Erkennung von Inverse3x. |
devices/detection/extra_ports (Nicht empfohlen) | string[] | — | Stattdessen devices/detection/additional_ports Bitte verwenden Sie diese Funktion. Lese- und Schreibvorgänge werden transparent an den regulären Schlüssel weitergeleitet. |
devices/inverse*/…
Dies ist die globale Standardeinstellung, die für alle Geräte der Inverse3 -Reihe gilt. Übergeordnete Einstellungen für einzelne Sitzungen haben Vorrang.
| Schlüssel | Typ | Einschränkungen | Erläuterung |
|---|---|---|---|
devices/inverse*/filters/force_scale/gain | float | Bereich 0,0–2,0 | Ein globaler Multiplikator für die Leistungsabgabe, der für alle Geräte gilt. |
devices/inverse*/filters/force_gate/gain | float | Bereich 0,0–1,0 | Standard-Verstärkung des Power-Gates für eine neue Sitzung. |
devices/inverse*/control_timeout_ms | int | Bereich 50–10.000 | Zeitlimit (in ms) bis zur Aufhebung der Sperre für die Gerätesteuerung. |
devices/inverse*/query_orientation_on_idle | bool | — | Wenn sich das Gerät im Ruhezustand befindet, fragt die Firmware die Ausrichtung des Geräts ab. |
devices/presets
| Schlüssel | Typ | Einschränkungen | Erläuterung |
|---|---|---|---|
devices/presets | json | — | Standard-Konfigurationsvoreinstellungen für die einzelnen Gerätetypen (inverse_arm_front_*、inverse_led_front_*、minverse_*、verse_grip_default、wireless_verse_grip_default、custom_verse_grip_default (z. B. Adapter für verschiedene Halterungen oder „basis“ usw.). |
devices/wireless_verse_grip/…
| Schlüssel | Typ | Einschränkungen | Erläuterung |
|---|---|---|---|
devices/wireless_verse_grip/battery/low_threshold | int | — | Wenn der Akkustand unter diesen Prozentsatz fällt, wird eine Warnung wegen niedrigen Akkustands ausgegeben. |
devices/wireless_verse_grip/battery/critical_threshold | int | — | Wenn der Akkustand unter diesen Prozentsatz fällt, wird eine Akkumeldung der Gefahrenstufe ausgelöst. |
devices/wireless_verse_grip/battery/reset_margin | int | — | Hysterese-Spielraum vor dem Aufheben der Akkuwarnung. |
devices/wireless_verse_grip/filters/orientation_filter | json | Start | Einstellung des One-Euro-Filters in Abhängigkeit von der Ausrichtung des kabellosen VerseGrip. |
features/…
features/calibration/…
| Schlüssel | Typ | Einschränkungen | Erläuterung |
|---|---|---|---|
features/calibration/hall_threshold | int | Bereich 1–32 | Der Schwellenwert des Hall-Sensors, bei dem während der Kalibrierung erkannt wird, dass der Stift aufgesetzt ist. |
features/grip_hook/…
So funktioniert der automatische Griffhaken: Solange Sie den Griff senkrecht halten, wird der Cursor fixiert.
| Schlüssel | Typ | Einschränkungen | Erläuterung |
|---|---|---|---|
features/grip_hook/enabled | bool | — | Aktiviert die automatische Verriegelung des Griffhakens, wenn der Griff senkrecht gehalten wird. |
features/grip_hook/use_hall | bool | — | Zur Erkennung des Griffs wird nicht die Ausrichtung, sondern der Schwellenwert des Hall-Sensors verwendet. |
features/grip_hook/hall | int | Bereich 1–32 | Schwellenwert für den Wert des Lochsensors, der die Griffverriegelung auslöst. |
features/grip_hook/hold_duration | int | Bereich 10–1000 | Zeitdauer (in ms), während der die Sperre nach dem Auslösen aufrechterhalten wird. |
features/navigation/bubble/…
Dies sind die Standardeinstellungen des Bubble-Navigationsmoduls.bubble Wird der Aktion bei ihrer ersten Aktivierung an die Sitzung übergeben.
| Schlüssel | Typ | Einschränkungen | Erläuterung |
|---|---|---|---|
features/navigation/bubble/center | vec3 | — | Standardwert für die Position des Mittelpunkts der Blase. |
features/navigation/bubble/max_velocity | float | — | Maximale Navigationsgeschwindigkeit (m/s) innerhalb der Geschwindigkeitszone. |
features/navigation/bubble/velocity_zone_width | float | — | Breite der Geschwindigkeitszone außerhalb der Blasenoberfläche (m). |
features/navigation/bubble/reset_velocity_on_entry | bool | — | Wenn der Cursor in die Blase gelangt, 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 Blasenoberfläche (N/m). |
features/navigation/bubble/spring_outer | float | — | Federkonstante (N/m) an der äußeren Begrenzung. |
features/navigation/bubble/damping_inner | float | — | Dämpfungskoeffizient (Ns/m) im Zentrum der Blase. |
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 (N/m) der starren Wand an der äußeren Begrenzung. |
features/navigation/bubble/bump_width | float | — | Breite der taktilen Erhebungen auf der Oberfläche der Blase (m). |
features/navigation/bubble/bump_stiffness | float | — | Steifigkeit (N/m) der taktilen Erhebungen auf der Oberfläche der Blase. |
features/safe_trajectory/…
Dies ist ein Geschwindigkeitsbegrenzer für die Bewegung des Endeffektors.
| Schlüssel | Typ | Einschränkungen | Erläuterung |
|---|---|---|---|
features/safe_trajectory/enabled | bool | — | Aktivieren Sie den Geschwindigkeitsbegrenzer für die sichere Fahrbahn. |
features/safe_trajectory/max_vel | float | Bereich 0,01–2,0 | Maximal zulässige Geschwindigkeit des Endeffektors (m/s). |
features/screensaver/…
Dies ist die Leerlaufanimation, die auf dem Gerät „Inverse3 “ angezeigt wird, wenn keine Sitzung aktiv ist.
| Schlüssel | Typ | Einschränkungen | Erläuterung |
|---|---|---|---|
features/screensaver/enabled | bool | — | Inverse3 Aktiviert die Bildschirmschoner-Animation im Leerlauf auf dem 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, das Gerät aber nicht bedient. |
features/sdf/…
Dies ist das Haptik-Effektmodul (SDF HFX) für das Signalisierte Distanzfeld (SDF).
| Schlüssel | Typ | Einschränkungen | Erläuterung |
|---|---|---|---|
features/sdf/enabled | bool | — | Aktiviert oder deaktiviert das SDF-Haptik-Effektmodul. |
features/sdf/state_output | bool | — | Standardmäßig wird der SDF-Status in die Nutzdaten der Geräteausgabe aufgenommen. |
features/sdf/max_count | int | Bereich 0–128 | Die maximale Anzahl gültiger 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 der SDF-Effekt entfernt wird. |
features/sdf/events/updated | bool | — | Es wird ein Ereignis ausgelöst, wenn der SDF-Effekt aktualisiert wird. |
features/sdf/probe_on_zero_force/enabled | bool | — | Wenn die Inka-Kraft nahezu null ist, wird das SDF-Feld automatisch abgefragt. |
features/sdf/probe_on_zero_force/delay | float | Bereich 0,001–60,0 | Dies ist die Verzögerungszeit (in Sekunden) zwischen dem Absinken der Kraft auf Null und dem Start der automatischen Abtastung. |
features/verse_grip_pairing/…
Inverse3 Dies ist die Nachverfolgung des Anbringens und Abnehmens des (kabelgebundenen oder kabellosen) Verse Grip. Damit wird die Pairing-Benutzeroberfläche desHaply -Hubs aktiviert.
| Schlüssel | Typ | Einschränkungen | Erläuterung |
|---|---|---|---|
features/verse_grip_pairing/enabled | bool | — | Aktiviert die Kopplung sowie die Nachverfolgung beim Anbringen und Abnehmen. |
features/verse_grip_pairing/hall_threshold_vg | int | Bereich 1–32 | Dies ist die Bohrungsebene, bei der festgestellt wird, dass ein kabelgebundener VerseGrip montiert ist. |
features/verse_grip_pairing/hall_threshold_wvg | int | Bereich 1–32 | Dies ist die Ebene, auf der festgestellt wird, dass ein drahtloser VerseGrip angebracht ist. |
features/verse_grip_pairing/detach_debounce_ms | int | Bereich 0–1000 | Dies ist die Entprellzeit (in ms) vor der Bestätigung des Entfernens. |
features/verse_grip_pairing/heartbeat_ms | int | Bereich 100–10.000 | Dies ist das Intervall (in ms) für die erzwungene erneute Benachrichtigung. |
features/verse_grip_pairing/force_attached | bool | — | Den Hall-Sensor umgehen und den Einbauzustand stets true Befestigen Sie es (als Abhilfemaßnahme bei einem Hardwareausfall). |
serialization/…
Hier werden die Formateinstellungen für die Transformationsausgabe festgelegt. Dies wirkt sich auf die Payloads von WebSocket und HTTP-JSON aus.
| Schlüssel | Typ | Einschränkungen | Erläuterung |
|---|---|---|---|
serialization/explicit_fields | bool | — | Fügen Sie der serialisierten Ausgabe ein Transformationsfeld hinzu, dessen Wert dem Standardwert der Einheitsmatrix (Identität) entspricht (Beispiel: position: {0,0,0}、rotation: {w:1,…}). Dies ist nützlich, wenn der Client die explizite Angabe aller Felder verlangt. Standard: false。 |
serialization/force_complete_transforms | bool | — | Bei allen Transform-Ausgaben, einschließlich der Geräte, die ausschließlich die Ausrichtung verarbeiten (Verse Grip, Wireless Verse Grip), position、rotation、sowie scale wird stets ausgegeben. Normalerweise rotation Auch Geräte, die ausschließlich [...], ausgeben, fallen darunter.serialization/explicit_fields umfasst folgende Funktionen. Standard: false。 |
session/…
Dies sind die Obergrenzen für den Sitzungsplaner und die Befehlspipeline.
| Schlüssel | Typ | Einschränkungen | Erläuterung |
|---|---|---|---|
session/min_simulation_rate_hz | int | Bereich 20–500 | Dies ist der zulässige untere Grenzwert für die Simulationsrate des Geräts (Hz), bevor eine Warnung ausgegeben wird. |
session/commands/zoh_window_ms | int | — | Dies ist das Null-Ordnungs-Hold-Fenster. In diesem Fenster werden empfangene Signale unterdrückt (ms). |
session/commands/drop_warning_threshold | int | — | Die Anzahl der Befehle, die im Fenster verworfen wurden, bevor die Warnung ausgegeben wurde. |
session/commands/drop_warning_window_ms | int | — | Dies ist die Größe des gleitenden Fensters (in ms) zum Zählen der verworfenen Befehle. |
session/commands/tick_on_empty_batch | bool | — | Selbst wenn der gesamte WebSocket-Batch verworfen wird,main_loop den Tick planen. |