Zum Haupttext springen

Siehe Einstellungen

Dieses Dokument ist /settings/ Alle vom Endpunkt zurückgegebenen Einstellungen Schlüssel, Typ(type_hint (Kriterium), Einschränkungen(metadata.constraint.range sowie gegebenenfalls locked (Kriterien) werden zusammen aufgeführt.

locked Einstellungen Lesezugriff zur Laufzeitist. Konfigurationsdateien oder Haply Hub Sie können dies über die Einstellungsseite ändern, aber damit die Änderungen wirksam werden, Der gesamte Dienst muss neu gestartet werden.. In der folgenden Tabelle sind diese Einstellungen Startwird angezeigt.

Aufbau​

Der Speicherort der Konfigurationsdatei, die die Einstellungen beim Start des Dienstes überschreibt, lautet wie folgt:

PlattformStandort
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

Die Konfigurationsdatei ordnet den Konfigurationsschlüsseln neue Werte zu. Flaches JSON-Objektist. 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 gelten die Standardwerte des Dienstes.

Beispielsweise sieht die Neudefinition der Netzwerkkonfiguration wie folgt aus:

{
"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 werden dem folgenden JSON-Format zugeordnet:

  • STRING → string
  • BOOL → bool
  • INT → int
  • FLOAT → float
  • ARR_STRING → string[]
  • VEC3 → vec3 ({x, y, z}(Objekt mit …)
  • GENERIC → json (beliebiger strukturierter Wert)

communication/…​

Dies sind die Netzwerkports und die Bind-Adressen für HTTP-, WebSocket- und Event-Stream-Server. Die meisten Einträge können nur beim Systemstart konfiguriert werden.

SchlüsselTypEinschränkungenBeschreibung
communication/serial/enabledbool—Aktiviert oder deaktiviert die Kommunikation über serielle Geräte.
communication/bind_addressstringBeim HochfahrenDies ist die IP-Adresse, an die der HTTP- und WebSocket-Server gebunden ist.
communication/bind_all_interfacesboolBeim Hochfahrenanstelle von localhost 0.0.0.0Bindet den Server.
communication/http/portintBeim HochfahrenHTTP-REST-API-Port (Standardwert 10000) ist.
communication/websocket/portintBeim HochfahrenStandard-WebSocket-Port v3.1 (Standardwert 10001) ist.
communication/websocket/legacy_portintBeim HochfahrenLegacy v3.0 WebSocket-Port (Standardwert 10000) ist.
communication/events/portintBeim HochfahrenWebSocket-Port für den Ereignisstrom (Standardwert 10020) ist.

devices/…​

devices/detection/…​

Dies sind die Richtlinien für das Scannen von seriellen Schnittstellen. Alle Einträge gehören zu den erweiterten Einstellungen.

SchlüsselTypEinschränkungenBeschreibung
devices/detection/scan_period_msintBereich 100–10.000; beim SystemstartDies ist das Intervall (in ms) für den Scan der seriellen Schnittstelle.
devices/detection/handshake_timeout_sintBereich 1–15Dies ist die Zeitbegrenzung für den Handshake pro Port (in Sekunden).
devices/detection/max_retriesintBereich 1–10Dies ist die maximale Anzahl der Handshake-Wiederholungsversuche pro Port.
devices/detection/failure_log_delay_sintBereich 1–60Dies ist die Verzögerungszeit (in Sekunden) vor der erneuten Protokollierung eines Erkennungsfehlers.
devices/detection/block_looping_portsbool—Wenn ein Loopback-Port erkannt wird, wird der Betriebszustand des Geräts gesperrt.
devices/detection/excluded_portsjson—Dies ist der Seriellport-Pfad, der bei der Erkennung übersprungen wird.
devices/detection/additional_portsstring[]—Dies ist ein zusätzlicher serieller Port, über den ohne Einschränkungen gescannt werden kann.
devices/detection/allowed_vendor_id_filterstring[]—Dies sind die zulässigen USB-Hersteller-IDs beim Auflisten der Anschlüsse.
devices/detection/port_name_substring_filterstring[]—Dies sind Teilzeichenfolgen der Portnamen für die jeweiligen Plattformen, die abgeglichen werden sollen.
devices/detection/wireless_verse_grip_description_filterstring[]—Dies ist ein Teil der Zeichenfolge zur Beschreibung des Anschlusses für die Erkennung des drahtlosen VerseGrip.
devices/detection/inverse3x_description_filterstring[]—Dies ist ein Teil einer Zeichenfolge aus der Portbeschreibung für die Inverse3x-Erkennung.
devices/detection/extra_ports (Nicht mehr verfügbar)string[]—stattdessen devices/detection/additional_portsVerwenden Sie dies. Lese- und Schreibvorgänge werden transparent über die Standardtasten weitergeleitet.

devices/inverse*/…​

Inverse3 Dies ist ein globaler Standardwert, der für alle Geräte der Gruppe gilt. Eine sessionsspezifische Überschreibung hat Vorrang.

SchlüsselTypEinschränkungenBeschreibung
devices/inverse*/filters/force_scale/gainfloatBereich 0,0–2,0Dies ist der globale Kraft-Ausgangs-Skalierungsfaktor, der für alle Geräte gilt.
devices/inverse*/filters/force_gate/gainfloatBereich 0,0–1,0Dies ist die Standard-Verstärkung des Kraftgates für eine neue Sitzung.
devices/inverse*/control_timeout_msintBereich 50–10.000Dies ist die Zeitbegrenzung (in ms) vor der Aufhebung der Gerätesteuerungssperre.
devices/inverse*/query_orientation_on_idlebool—Wenn sich das Gerät im Ruhezustand befindet, ermittelt die Firmware die Ausrichtung des Geräts.

devices/presets​

SchlüsselTypEinschränkungenBeschreibung
devices/presetsjson—Dies sind die Standard-Voreinstellungen für die Gerätekonfiguration nach Gerätetyp (inverse_arm_front_*, inverse_led_front_*, minverse_*, verse_grip_default, wireless_verse_grip_default, custom_verse_grip_default(z. B. Mount-Transformation, Basis usw.).

devices/wireless_verse_grip/…​

SchlüsselTypEinschränkungenBeschreibung
devices/wireless_verse_grip/battery/low_thresholdint—Wenn der Akkustand (%) unter diesen Wert fällt, wird eine Warnung wegen niedrigen Akkustands angezeigt.
devices/wireless_verse_grip/battery/critical_thresholdint—Wenn der Akkustand (%) unter diesen Wert fällt, wird eine Warnmeldung zum Akku angezeigt.
devices/wireless_verse_grip/battery/reset_marginint—Dies ist der Hysterese-Spielraum vor dem Aufheben der Akkuwarnung.
devices/wireless_verse_grip/filters/orientation_filterjsonBeim HochfahrenDies sind die Einstellungen für den One Euro Filter für den kabellosen VerseGrip.

features/…​

features/calibration/…​

SchlüsselTypEinschränkungenBeschreibung
features/calibration/hall_thresholdintBereich 1–32Dies ist der Füllstand des Lochsensors, bei dem während der Kalibrierung davon ausgegangen wird, dass der Stift angebracht ist.

features/grip_hook/…​

Der Griffhaken funktioniert automatisch. Solange Sie den Griff aufrecht halten, wird der Cursor fixiert.

SchlüsselTypEinschränkungenBeschreibung
features/grip_hook/enabledbool—Wenn Sie den Griff senkrecht halten, wird die automatische Verriegelung des Griffhakens aktiviert.
features/grip_hook/use_hallbool—Bei der Grifferkennung wird anstelle der Ausrichtung der Schwellenwert des Lochsensors verwendet.
features/grip_hook/hallintBereich 1–32Dies ist der Schwellenwert für den Wert des Hall-Sensors, der die Griffverriegelung auslöst.
features/grip_hook/hold_durationintBereich 10–1000Dies ist die Zeit (in ms), während der die Sperre nach Auslösen des Triggers aufrechterhalten wird.

features/navigation/bubble/…​

Dies sind die Standardwerte für das Bubble-Navigationsmodul. bubble Wird bei der ersten Aktivierung der Aktion an die Sitzung übergeben.

SchlüsselTypEinschränkungenBeschreibung
features/navigation/bubble/centervec3—Dies ist der Standardwert für die Position des Blasenmittelpunkts.
features/navigation/bubble/max_velocityfloat—Dies ist die maximale Navigationsgeschwindigkeit (m/s) im jeweiligen Geschwindigkeitsbereich.
features/navigation/bubble/velocity_zone_widthfloat—Dies ist die Breite (in m) des Geschwindigkeitsbereichs außerhalb der Blasenoberfläche.
features/navigation/bubble/reset_velocity_on_entrybool—Sobald der Cursor in die Blase eintritt, wird die Geschwindigkeit auf 0 zurückgesetzt.
features/navigation/bubble/spring_innerfloat—Dies ist der Federkonstante (N/m) im Zentrum der Blase.
features/navigation/bubble/spring_surfacefloat—Dies ist die Federkonstante (N/m) an der Oberfläche der Blase.
features/navigation/bubble/spring_outerfloat—Dies ist der Federkonstante (N/m) an der äußeren Grenze.
features/navigation/bubble/damping_innerfloat—Dies ist der Dämpfungskoeffizient (Ns/m) im Zentrum der Blase.
features/navigation/bubble/damping_surfacefloat—Dies ist der Dämpfungskoeffizient (Ns/m) an der Oberfläche einer Blase.
features/navigation/bubble/damping_outerfloat—Dies ist der Dämpfungskoeffizient (Ns/m) an der Außengrenze.
features/navigation/bubble/wall_stiffnessfloat—Dies ist die Steifigkeit (N/m) der festen Wand an der Außenkante.
features/navigation/bubble/bump_widthfloat—Dies ist die Breite (m) der taktilen Erhebungen auf der Oberfläche der Blase.
features/navigation/bubble/bump_stiffnessfloat—Dies ist die Steifigkeit (N/m) der taktilen Erhebungen auf der Oberfläche der Blasen.

features/safe_trajectory/…​

Dies ist ein Geschwindigkeitsbegrenzer für die Bewegung des Endeffektors.

SchlüsselTypEinschränkungenBeschreibung
features/safe_trajectory/enabledbool—Aktivieren Sie den Geschwindigkeitsbegrenzer für die Sicherheitsbahn.
features/safe_trajectory/max_velfloatBereich 0,01–2,0Dies ist die maximal zulässige Geschwindigkeit (m/s) des Endeffektors.

features/screensaver/…​

Dies ist eine Leerlaufanimation, die auf dem Gerät „ Inverse3 “ abgespielt wird, wenn die Sitzung das Gerät nicht steuert.

SchlüsselTypEinschränkungenBeschreibung
features/screensaver/enabledbool—Inverse3 Aktiviert die Bildschirmschoner-Animation des Geräts im Ruhezustand.
features/screensaver/speedfloatBereich 0,001–0,2Dies ist die Animationsgeschwindigkeit des Bildschirmschoners.
features/screensaver/distracted_speedfloatBereich 0,001–0,2Dies ist die Animationsgeschwindigkeit, wenn sich der Benutzer in der Nähe befindet, aber keine Eingaben vornimmt.

features/sdf/…​

Dies ist das Modul für haptische Effekte auf Basis des Signed-Distance-Field (SDF HFX).

SchlüsselTypEinschränkungenBeschreibung
features/sdf/enabledbool—Aktiviert oder deaktiviert das SDF-Haptik-Effektmodul.
features/sdf/state_outputbool—Grundsätzlich wird der SDF-Status in die Ausgabedaten des Geräts aufgenommen.
features/sdf/max_countintBereich 0–128Die maximale Anzahl aktiver SDF-Effekte (0 = unbegrenzt).
features/sdf/events/createdbool—Wenn ein neuer SDF-Effekt erstellt wird, wird ein Ereignis ausgelöst.
features/sdf/events/deletedbool—Wenn der SDF-Effekt aufgehoben wird, wird ein Ereignis ausgelöst.
features/sdf/events/updatedbool—Wenn der SDF-Effekt aktualisiert wird, wird ein Ereignis ausgelöst.
features/sdf/probe_on_zero_force/enabledbool—Das SDF-Feld wird automatisch abgefragt, wenn die ausgeübte Kraft nahe bei 0 liegt.
features/sdf/probe_on_zero_force/delayfloatBereich 0,001–60,0Dies ist die Verzögerungszeit (in Sekunden) zwischen dem Absinken der Kraft auf 0 und dem Start der automatischen Abtastung.

features/verse_grip_pairing/…​

Inverse3 sowie die Verfolgung des Anbringens und Abnehmens des Verse Grip (kabelgebunden oder kabellos). Dies bildet die Grundlage für die Benutzeroberfläche zur Kopplung des „ Haply -Hubs“.

SchlüsselTypEinschränkungenBeschreibung
features/verse_grip_pairing/enabledbool—Kopplung / Verfolgung des Anbringens und Abnehmens aktivieren.
features/verse_grip_pairing/hall_threshold_vgintBereich 1–32Bei dem kabelgebundenen VerseGrip gilt die Lochhöhe als Befestigungspunkt.
features/verse_grip_pairing/hall_threshold_wvgintBereich 1–32Bei dem kabellosen VerseGrip handelt es sich um die Lochhöhe, bei der er als befestigt gilt.
features/verse_grip_pairing/detach_debounce_msintBereich 0–1000Dies ist die Entprellphase vor der endgültigen Trennung (ms).
features/verse_grip_pairing/heartbeat_msintBereich 100–10.000Dies ist der Abstand zwischen den erzwungenen Erinnerungen (in ms).
features/verse_grip_pairing/force_attachedbool—Den Lochsensor umgehen, um den Befestigungszustand zu trueund dauerhaft festlegt (zur Umgehung von Hardwarefehlern).

serialization/…​

Ausgabeformat „Transform“ – Wirkt sich auf WebSocket- und HTTP-JSON-Nutzdaten aus.

SchlüsselTypEinschränkungenBeschreibung
serialization/explicit_fieldsbool—In der serialisierten Ausgabe werden „transform“-Felder wie der identische Standardwert (z. B. position: {0,0,0}, rotation: {w:1,…}) ist ebenfalls enthalten. Dies ist nützlich, wenn auf dem Client alle Felder explizit vorhanden sein müssen. Standardwert: false.
serialization/force_complete_transformsbool—Einschließlich der Geräte, die nur die Richtung ausgeben (Verse Grip, Wireless Verse Grip), gelten für alle „transform“-Ausgaben position, rotation, Und scaleenthält immer. Diese Geräte würden andernfalls rotationEs wird nur ausgegeben. serialization/explicit_fieldsumfasst die folgenden Funktionen. Standardwert: false.

session/…​

Einschränkungen des Sitzungsplaners und der Befehlspipeline.

SchlüsselTypEinschränkungenBeschreibung
session/min_simulation_rate_hzintBereich 20–500Dies ist die zulässige Mindestfrequenz (Hz) für die Gerätesimulation, bevor eine Warnung ausgelöst wird.
session/commands/zoh_window_msint—Fenster der Nullten Ordnung – Unterdrückt die innerhalb dieses Zeitraums empfangenen Signale (ms).
session/commands/drop_warning_thresholdint—Dies ist die Anzahl der Befehle, die innerhalb des Fensters abgelegt wurden, bevor die Warnung angezeigt wurde.
session/commands/drop_warning_window_msint—Dies ist die Größe des gleitenden Fensters (in ms), in dem die verworfenen Befehle zusammengefasst werden.
session/commands/tick_on_empty_batchbool—Selbst wenn die gesamte WebSocket-Verbindung unterbrochen wird, main_loop Der Tick wird eingeplant.