Zum Hauptinhalt springen

Parameterübersicht

Dieses Dokument listet alle vom Endpunkt zurückgegebenen Parameter auf /settings/ mit ihren Schlüssel, ihre Typ (aus type_hint) und deren Einschränkungen (aus metadata.constraint.range + locked, falls zutreffend).

Ein Parameter locked est wird bei der Ausführung nur gelesen. Er kann über die Konfigurationsdatei oder auf der Einstellungsseite von Haply Hub, aber Ein vollständiger Neustart des Dienstes ist erforderlich damit die Änderungen wirksam werden. Diese Einstellungen sind gekennzeichnet Start in den folgenden Tabellen.

Konfiguration​

Die Konfigurationsdatei, mit der die Parameter beim Start des Dienstes geändert werden können, befindet sich hier:

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 ist eine flaches JSON-Objekt die die Parameterschlüssel ihren Ersatzwerten zuordnet. Die Schlüssel müssen gültige Parameterschlüssel sein, die von der Route zurückgegeben werden /settings/ HTTP (siehe API-Referenz). Für jeden nicht angegebenen Schlüssel wird der Standardwert des Dienstes verwendet.

Beispielsweise eine Änderung der Netzwerkkonfiguration:

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

Typenübereinstimmung​

Die von der API zurückgegebenen Typangaben entsprechen den folgenden JSON-Typen:

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

communication/…​

Netzwerkports und Listening-Adressen der HTTP-, WebSocket- und Ereignisstrom-Server. Die meisten Einträge können nur beim Start geändert werden.

CléTypEinschränkungenBeschreibung
communication/serial/enabledbool—Die Kommunikation mit seriellen Geräten aktivieren oder deaktivieren.
communication/bind_addressstringStartIP-Adresse, auf der die HTTP- und WebSocket-Server auf Verbindungen warten.
communication/bind_all_interfacesboolStartDie Server auf Folgendes abhören lassen: 0.0.0.0 anstelle von „localhost“.
communication/http/portintStartPort der HTTP-REST-API (standardmäßig 10000).
communication/websocket/portintStartWebSocket-Hauptport der Version 3.1 (Standard 10001).
communication/websocket/legacy_portintStartWebSocket-Port aus Version 3.0 (Standard 10000).
communication/events/portintStartWebSocket-Port des Ereignisstroms (standardmäßig 10020).

devices/…​

devices/detection/…​

Richtlinie zum Scannen serieller Schnittstellen. Alle Einträge sind für Fortgeschrittene bestimmt.

CléTypEinschränkungenBeschreibung
devices/detection/scan_period_msintBereich 100–10.000; StartIntervall zwischen zwei Abtastvorgängen der seriellen Schnittstellen (ms).
devices/detection/handshake_timeout_sintSeite 1–15Ablaufzeit der Verhandlung pro Hafen (in Sekunden).
devices/detection/max_retriesintSeite 1–10Maximale Anzahl von Verhandlungsversuchen pro Port.
devices/detection/failure_log_delay_sintBereich 1–60Zeitintervall, bevor ein Erkennungsfehler erneut protokolliert wird (s).
devices/detection/block_looping_portsbool—Die Verfügbarkeit des Geräts sperren, wenn ein Durchschleifanschluss erkannt wird.
devices/detection/excluded_portsjson—Port-Pfade, die bei der Erkennung ignoriert werden sollen.
devices/detection/additional_portsstring[]—Zusätzliche serielle Schnittstellenpfade, die systematisch durchsucht werden müssen.
devices/detection/allowed_vendor_id_filterstring[]—Zulässige USB-Anbieter-IDs bei der Port-Auflistung.
devices/detection/port_name_substring_filterstring[]—Plattformspezifische Teilzeichenfolgen von Portnamen, nach denen gesucht werden soll.
devices/detection/wireless_verse_grip_description_filterstring[]—Portbeschreibungs-Substrings für die drahtlose Erkennung von VerseGrip.
devices/detection/inverse3x_description_filterstring[]—Portbeschreibungs-Teilzeichenfolgen zur Erkennung von Inverse3x.
devices/detection/extra_ports (veraltet)string[]—Verwenden Sie stattdessen devices/detection/additional_ports. Die Lese- und Schreibvorgänge werden nahtlos an den kanonischen Schlüssel weitergeleitet.

devices/inverse*/…​

Globale Standardwerte, die auf jedes Gerät der Produktfamilie „ Inverse3 “ angewendet werden. Sitzungsspezifische Überschreibungen haben Vorrang.

CléTypEinschränkungenBeschreibung
devices/inverse*/filters/force_scale/gainfloatBereich 0,0–2,0Allgemeiner Multiplikator für die Ausgangsleistung, der auf alle Geräte angewendet wird.
devices/inverse*/filters/force_gate/gainfloatBereich 0,0–1,0Standard-Verstärkung des Force-Ports für neue Sitzungen.
devices/inverse*/control_timeout_msintBereich 50–10.000Verzögerungszeit bis zur Freigabe der Gerätesperre (ms).
devices/inverse*/query_orientation_on_idlebool—Die Ausrichtung des Geräts über die Firmware abfragen, wenn das Gerät inaktiv ist.

devices/presets​

CléTypEinschränkungenBeschreibung
devices/presetsjson—Standardkonfigurationseinstellungen des Geräts für jeden Gerätetyp (Montageumrüstung, 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/…​

CléTypEinschränkungenBeschreibung
devices/wireless_verse_grip/battery/low_thresholdint—Akku-Ladezustand in Prozent, bei dessen Unterschreitung eine Warnung wegen niedrigem Akkustand ausgelöst wird.
devices/wireless_verse_grip/battery/critical_thresholdint—Akkuladestand, bei dessen Unterschreitung eine Warnmeldung wegen kritischem Akkustand ausgelöst wird.
devices/wireless_verse_grip/battery/reset_marginint—Hysterese-Spanne vor dem Löschen einer Batterie-Warnmeldung.
devices/wireless_verse_grip/filters/orientation_filterjsonStartKonfiguration des „One Euro“-Filters für die drahtlose Ausrichtung des VerseGrip.

features/…​

features/calibration/…​

CléTypEinschränkungenBeschreibung
features/calibration/hall_thresholdintSeite 1–32Pegel des Hall-Sensors, ab dem der Stift während der Kalibrierung als angebracht gilt.

features/grip_hook/…​

Automatisches Verhalten des Greifhakens: Arretiert den Schieber, wenn der Griff senkrecht gehalten wird.

CléTypEinschränkungenBeschreibung
features/grip_hook/enabledbool—Die automatische Verriegelung des Greifhakens aktivieren, wenn der Griff senkrecht gehalten wird.
features/grip_hook/use_hallbool—Zur Erkennung des Griffs sollte der Schwellenwert des Hall-Sensors anstelle der Ausrichtung verwendet werden.
features/grip_hook/hallintSeite 1–32Schwellenwert des Hall-Sensors, der die Verriegelung des Griffs auslöst.
features/grip_hook/hold_durationintBereich 10–1000Haltedauer der Verriegelung nach der Auslösung (ms).

features/navigation/bubble/…​

Standardwerte des Navigationsmoduls „Bulle“, die bei der ersten Aktivierung eines Verhaltens an die Sitzung übergeben werden bubble.

CléTypEinschränkungenBeschreibung
features/navigation/bubble/centervec3—Standardposition des Mittelpunkts der Blase.
features/navigation/bubble/max_velocityfloat—Maximale Fahrgeschwindigkeit in der Geschwindigkeitszone (m/s).
features/navigation/bubble/velocity_zone_widthfloat—Breite des Geschwindigkeitsbereichs außerhalb der Blasenoberfläche (m).
features/navigation/bubble/reset_velocity_on_entrybool—Die Geschwindigkeit auf Null zurücksetzen, sobald der Cursor in die Blase eintritt.
features/navigation/bubble/spring_innerfloat—Steifigkeitskoeffizient in der Mitte der Blase (N/m).
features/navigation/bubble/spring_surfacefloat—Steifigkeitskoeffizient an der Oberfläche der Blase (N/m).
features/navigation/bubble/spring_outerfloat—Steifigkeitskoeffizient am äußeren Rand (N/m).
features/navigation/bubble/damping_innerfloat—Dämpfungskoeffizient im Zentrum der Blase (Ns/m).
features/navigation/bubble/damping_surfacefloat—Dämpfungskoeffizient an der Oberfläche der Blase (Ns/m).
features/navigation/bubble/damping_outerfloat—Dämpfungskoeffizient am äußeren Rand (Ns/m).
features/navigation/bubble/wall_stiffnessfloat—Steifigkeit der starren Wand am äußeren Rand (N/m).
features/navigation/bubble/bump_widthfloat—Breite der taktilen Erhebung auf der Oberfläche der Blase (m).
features/navigation/bubble/bump_stiffnessfloat—Steifigkeit der taktilen Erhebung auf der Oberfläche der Blase (N/m).

features/safe_trajectory/…​

Geschwindigkeitsbegrenzer für die Bewegung des Endeffektors.

CléTypEinschränkungenBeschreibung
features/safe_trajectory/enabledbool—Den Geschwindigkeitsbegrenzer für die sichere Fahrbahn aktivieren.
features/safe_trajectory/max_velfloatBereich 0,01–2,0Zulässige Höchstgeschwindigkeit des Endeffektors (m/s).

features/screensaver/…​

Inaktivitätsanimation, die auf Geräten mit „ Inverse3 “ abgespielt wird, wenn keine Sitzung aktiv ist.

CléTypEinschränkungenBeschreibung
features/screensaver/enabledbool—Aktivieren Sie die Bildschirmschoner-Animation bei Inaktivität auf Geräten mit „ Inverse3 “.
features/screensaver/speedfloatBereich 0,001–0,2Geschwindigkeit der Animation des Bildschirmschoners.
features/screensaver/distracted_speedfloatBereich 0,001–0,2Geschwindigkeit der Animation, wenn sich der Benutzer in der Nähe befindet, ohne zu interagieren.

features/sdf/…​

Modul für haptische Effekte mit vorzeichenbehaftetem Entfernungsfeld (SDF HFX).

CléTypEinschränkungenBeschreibung
features/sdf/enabledbool—Das SDF-Modul für haptische Effekte aktivieren oder deaktivieren.
features/sdf/state_outputbool—Den SDF-Status standardmäßig in die Ausgangsdaten des Geräts aufnehmen.
features/sdf/max_countintBereich 0–128Maximale Anzahl aktiver SDF-Effekte (0 = unbegrenzt).
features/sdf/events/createdbool—Ein Ereignis auslösen, wenn ein neuer SDF-Effekt erstellt wird.
features/sdf/events/deletedbool—Ein Ereignis auslösen, wenn ein SDF-Effekt entfernt wird.
features/sdf/events/updatedbool—Ein Ereignis auslösen, wenn ein SDF-Effekt aktualisiert wird.
features/sdf/probe_on_zero_force/enabledbool—Die SDF-Felder werden automatisch getrennt, wenn die ausgeübte Kraft nahe Null ist.
features/sdf/probe_on_zero_force/delayfloatBereich 0,001–60,0Verzögerung bis zur automatischen Abfrage, nachdem die Kraft auf Null gesunken ist (s).

features/verse_grip_pairing/…​

Überwachung des Verbindungsaufbaus und der Trennung zwischen „ Inverse3 “ und dem Verse Grip-Gerät (mit Kabel oder kabellos). Versorgt die Kopplungsschnittstelle des „ Haply Hub“ mit Strom.

CléTypEinschränkungenBeschreibung
features/verse_grip_pairing/enabledbool—Koppeln sowie die Überwachung des Anbringens und Entfernens aktivieren.
features/verse_grip_pairing/hall_threshold_vgintSeite 1–32Position des Hall-Sensors, ab der das kabelgebundene VerseGrip-Gerät als befestigt gilt.
features/verse_grip_pairing/hall_threshold_wvgintSeite 1–32Pegel des Hall-Sensors, ab dem das kabellose VerseGrip-Gerät als befestigt gilt.
features/verse_grip_pairing/detach_debounce_msintBereich 0–1000Wartezeit vor der Bestätigung einer Auszahlung (ms).
features/verse_grip_pairing/heartbeat_msintBereich 100–10.000Intervall zwischen den erzwungenen erneuten Meldungen (ms).
features/verse_grip_pairing/force_attachedbool—Den Status „festgelegt“ dauerhaft erzwingen für true, wobei der Hall-Sensor umgangen wird (Ausweichlösung bei einem Hardware-Ausfall).

serialization/…​

Formatierung der Transformationsausgaben – betrifft WebSocket- und HTTP-JSON-Nutzdaten.

CléTypEinschränkungenBeschreibung
serialization/explicit_fieldsbool—Die Transformationsfelder, deren Wert dem Standard-Identitätswert entspricht, in die serialisierte Ausgabe aufnehmen (z. B. position: {0,0,0}, rotation: {w:1,…}). Nützlich, wenn Ihr Kunde verlangt, dass jedes Feld ausdrücklich vorhanden sein muss. Standardwert: false.
serialization/force_complete_transformsbool—Immer senden position, rotation et scale an jedem Transformationsausgang, einschließlich der Geräte mit einseitiger Ausrichtung (Verse Grip, Wireless Verse Grip), die ansonsten nur rotation. Englobe serialization/explicit_fields. Standardwert: false.

session/…​

Einschränkungen des Sitzungsplaners und der Befehlspipeline.

CléTypEinschränkungenBeschreibung
session/min_simulation_rate_hzintBereich 20–500Minimal zulässige Simulationsfrequenz des Geräts (Hz) vor Auslösung einer Warnung.
session/commands/zoh_window_msint—Fenster für die Null-Ordnungserhaltung – die in diesem Fenster (ms) empfangenen Messwerte löschen.
session/commands/drop_warning_thresholdint—Anzahl der abgelehnten Bestellungen im Zeitfenster vor der Warnmeldung.
session/commands/drop_warning_window_msint—Größe des Gleitfensters für die Zählung der abgelehnten Aufträge (ms).
session/commands/tick_on_empty_batchbool—Einen Termin planen für main_loop selbst wenn ein gesamter WebSocket-Batch abgelehnt wurde.