Zum Haupttext springen

HTTP

Grundsätzlich gilt für HTTP-Dienste, dass http://localhost:10001beginnt dort.

Der Port kann in den Einstellungendes Dienstes geändert werden.

Übersicht​

In diesem Abschnitt werden die vom Dienst bereitgestellten HTTP-Routen beschrieben.

Alle folgenden Routen verwenden die Standard-Basis-URL http://localhost:10001dient als Grundlage.

Standard-Antwortumschlag​

Jeder Endpunkt gibt eine der beiden folgenden Hüllkurven zurück:

Antwort ohne Daten (bei Endpunkten, die nur für Änderungen vorgesehen sind):

{ "ok": true }
{ "ok": false, "error": "reason string" }

Datenantwort (wird bei GET-Anfragen sowie bei POST-/DELETE-Anfragen an Konfigurations-Endpunkte verwendet, die die übergebenen Werte unverändert zurückgeben):

{ "ok": true, "data": { "..." : "..." } }
{ "ok": false, "error": "reason string" }

Syntax des Geräteauswahloperators​

Der Pfad auf Geräteebene lautet /{device_type}/{id_or_index}/... Es wird ein Muster verwendet. {device_type}und {id_or_index} Ein Pfadsegment identifiziert das Zielgerät.

Beispiel für ein WegsegmentBedeutung
inverse3/0Der erste Eintrag, der durch den Index (beginnend bei 0) angegeben wird Inverse3
inverse3/A14Die Geräte-ID lautet A14in Inverse3
inverse3/*Alle Geräte unter Inverse3 (Platzhalter)
verse_grip/0Der erste „Verse Grip“, der als Index festgelegt wurde
wireless_verse_grip/*Alle Wireless Verse Grip-Modelle
*inverse/*Die gesamte Inverse-Produktreihe (Inverse3, Inverse3x, Minverse)
*verse_grip/*Alle Geräte der Verse Grip-Serie (Verse Grip, Wireless VG)

Regeln für Platzhalter:

  • GETlehnt Selektoren ab, die mehrdeutig sind oder Platzhalter enthalten (400 Rückgabe).
  • POSTWow DELETEerlaubt Platzhalter – die Aktion wird auf alle Geräte angewendet, die den Kriterien entsprechen.

Sitzungsselektor​

Endpunkte im Sitzungsbereich (basis, mount, preset, transform, filters) dienen zur Identifizierung der Sitzung ?session=<expr> Es sind Abfrageparameter erforderlich.

AusdruckBedeutung
(Auslassung)Alle Sitzungen (nur DELETE)
#123 oder 123Die Sitzung mit der ID 123
:-1Letzte Sitzung gemäß Index
:0Erste Sitzung gemäß Index

Beispiel: GET /inverse3/0/config/basis?session=:0


Version​

Methode: GET
URL: http://localhost:10001/version

Beispielantwort:

{
"build_time": "2024-08-07T16:01:53Z",
"git_branch": "main",
"git_describe": "3.5.0-2-gce34c39e",
"git_hash": "ce34c39e",
"git_tag": "3.5.0",
"project_name": "haply-inverse-service",
"project_version": "3.5.0"
}

Expertenstatus​

Methode: GET
URL: http://localhost:10001/expert/status

Gibt detaillierte Statusinformationen zurück, darunter Daten zu Erkennung, Geräten, Sitzungen und globalen Einstellungen.


Gerät​

Methode: GET
URL: http://localhost:10001/devices

config, state, statusGibt eine Liste der derzeitigen Geräte zurück, einschließlich [...].

wahlweise ?session=<expr>Durch die Übergabe von können Sie den Snapshot aus der Perspektive einer bestimmten Sitzung filtern (wobei die Werte für „basis“, „mount“ und „transform“ dieser Sitzung auf die zurückgegebenen Werte angewendet werden).

Beispielantwort:

{
"inverse3": [
{
"device_id": "04BA",
"config": { "...": "..." },
"state": { "...": "..." },
"status": { "...": "..." }
}
]
}

Sitzung​

MethodePfadBeschreibung
HOLEN/sessionsGesamtliste der aktiven v3.1-Sitzungen anzeigen
HOLEN/sessions/{session_id}Abfrage einer einzelnen Sitzung
HOLEN/sessions/{session_id}/profileAbfrage des Namens eines Sitzungsprofils
BEITRAG/sessions/{session_id}/profileEinstellungen für das Sitzungsprofil
LÖSCHEN/sessions/{session_id}/profileProfil "default"Zurücksetzen auf

BEITRAG /sessions/{session_id}/profile Text:

{
"name": "my_profile"
}

Hafen​

Methode: POST
URL: http://localhost:10001/ports/{port}/reset

Der gesperrte serielle Anschluss wird entsperrt. { "ok": true }gibt zurück.


Gerätekonfiguration​

Alle Konfigurations-Endpunkte (config) sind /{device_type}/{id_or_index}/config/{setting} Es wird ein Muster verwendet.

Endpunkte im Sitzungsbereich (basis, mount, preset) sind zusätzlich ?session=<expr> Es sind Abfrageparameter erforderlich.

Handpräferenz (Handedness, nur für „ Inverse3 “)​

MethodePfadHaupttextAntwort
HOLEN/{device_type}/{id}/config/handedness--"left" oder "right"
BEITRAG/{device_type}/{id}/config/handedness"left" oder "right"Gibt den Eingabewert unverändert zurück
LÖSCHEN/{device_type}/{id}/config/handedness--"right" (Standardwert)

Drehmomentskalierung (nur für „Inverse3 “)​

MethodePfadHaupttextAntwort
HOLEN/{device_type}/{id}/config/torque_scaling--{ "enabled": bool }
BEITRAG/{device_type}/{id}/config/torque_scaling{ "enabled": bool }Gibt den Eingabewert unverändert zurück
LÖSCHEN/{device_type}/{id}/config/torque_scaling--{ "enabled": false }

Schwerkraftkompensation (nur für „Inverse3 “)​

MethodePfadHaupttextAntwort
HOLEN/{device_type}/{id}/config/gravity_compensation--{ "enabled": bool, "scaling_factor": float }
BEITRAG/{device_type}/{id}/config/gravity_compensation{ "enabled": bool, "scaling_factor": float }Gibt den Eingabewert unverändert zurück
LÖSCHEN/{device_type}/{id}/config/gravity_compensation--{ "enabled": true, "scaling_factor": 1.0 }

Basis (alle Geräte, Sitzungsbereich)​

MethodePfadHaupttextAntwort
HOLEN/{device_type}/{id}/config/basis?session=--{ "permutation": "XYZ" }
BEITRAG/{device_type}/{id}/config/basis?session={ "permutation": "ZXY" }Gibt den Eingabewert unverändert zurück
LÖSCHEN/{device_type}/{id}/config/basis?session=--{ "permutation": "XYZ" }

Einbinden (alle Geräte, Sitzungsbereich)​

MethodePfadHaupttextAntwort
HOLEN/{device_type}/{id}/config/mount?session=--{ "transform": {...} }
BEITRAG/{device_type}/{id}/config/mount?session={ "transform": {...} }Gibt den Eingabewert unverändert zurück
LÖSCHEN/{device_type}/{id}/config/mount?session=--Identitätsabbildung (identity transform)

Transformationsstruktur (wird in „mount“ und „state/transform“ verwendet):

{
"transform": {
"position": { "x": 0, "y": 0, "z": 0 },
"rotation": { "x": 0, "y": 0, "z": 0, "w": 1 },
"scale": { "x": 1, "y": 1, "z": 1 }
}
}

Voreinstellungen (alle Geräte, Sitzungsbereich)​

MethodePfadHaupttextAntwort
HOLEN/{device_type}/{id}/config/preset?session=--{ "preset": "arm_front_centered" }
BEITRAG/{device_type}/{id}/config/preset?session={ "preset": "arm_front_centered" }Rückgabewert
LÖSCHEN/{device_type}/{id}/config/preset?session=--{ "preset": "device_defaults" }

Mögliche Werte: device_defaults, arm_front, arm_front_centered, led_front, led_front_centered, custom.


Gerätefilter (nur für „Inverse3 “, gilt für die gesamte Sitzung)​

Filter-Endpunkte sind /{device_type}/{id}/config/filters/{filter}?session=<expr> Verwendet den Pfad.

Dämpfung​

Es steuert sowohl die gleichmäßige Dämpfung als auch die gerichtete Dämpfung. Der POST-Text muss mindestens ein Feld enthalten.

MethodePfadHaupttextAntwort
HOLEN/{device_type}/{id}/config/filters/damping?session=--{ "scalar": float, "vector": { "x": f, "y": f, "z": f } }
BEITRAG/{device_type}/{id}/config/filters/damping?session={ "scalar": float } oder { "vector": {...} } oder beidesRückgabewert
LÖSCHEN/{device_type}/{id}/config/filters/damping?session=--Beide auf 0 zurücksetzen

Krafttor​

MethodePfadHaupttextAntwort
HOLEN/{device_type}/{id}/config/filters/force_gate?session=--{ "gain": float }
BEITRAG/{device_type}/{id}/config/filters/force_gate?session={ "gain": float }Rückgabewert
LÖSCHEN/{device_type}/{id}/config/filters/force_gate?session=--Der Standardwert für „Gain“ in den Einstellungen

Gerätestatus​

Konvertierung (alle Geräte, sitzungsweit)​

Arbeitsbereichsumwandlung (vom Geräteraum in den Anwendungsraum).

MethodePfadHaupttextAntwort
HOLEN/{device_type}/{id}/state/transform?session=--{ "transform": {...} }
BEITRAG/{device_type}/{id}/state/transform?session={ "transform": {...} }Rückgabewert
LÖSCHEN/{device_type}/{id}/state/transform?session=--Identitätsabbildung

Konfiguration speichern​

Inverse3 Funktioniert nur auf dem Gerät. Warnung: Speichern Sie die Konfiguration nicht zu häufig, da die Anzahl der Speichervorgänge, die auf einem Gerät durchgeführt werden können, begrenzt ist (ca. 10.000 EEPROM-Schreibvorgänge).

Methode: POST
URL: http://localhost:10001/save_configuration

Beispieltext:

{
"device_id": "049D"
}

Beispielantwort:

{
"ok": true
}

Einstellungen​

Für die folgenden Elemente werden automatisch Konfigurations-Endpunkte erstellt:

  • Alle Einstellungen einschließlich Metadaten auflisten
  • Einzelnen Einstellungswert lesen
  • Einstellungen übernehmen (einzeln oder gesammelt)
  • Tasten auf Standardwerte zurücksetzen

Alle Referenzangaben zu den Einstellungsschlüsseln finden Sie hier

Route​

MethodeRouteBeschreibung
HOLEN/settings/Lädt alle Einstellungsschlüssel, Werte und Metadaten.
BEITRAG/settings/Mehrere Einstellungen werden gleichzeitig in einem Schritt angewendet.
HOLEN/settings/{key}Ruft den aktuellen Werteines bestimmten Konfigurationsschlüssels ab.
BEITRAG/settings/{key}Wendet einen neuen Wertauf einen bestimmten Schlüssel an.
LÖSCHEN/settings/{key}Die Tasten werden auf die Standardeinstellungenzurückgesetzt.

Antwortformat​

HOLEN /settings/ (Alle Einstellungen)​

Gibt ein Objekt zurück, dessen Schlüssel die Einstellungsschlüssel sind. Jeder Eintrag enthält Folgendes:

  • value: Aktueller Wert
  • metadata: Typ + Einschränkungen + Sperrstatus

Beispiele für Einträge:

{
"devices/detection/timeout": {
"metadata": {
"constraint": {
"range": {
"max": 15,
"min": 1,
"step": 0
}
},
"locked": false,
"type_hint": "INT"
},
"value": 5
}
}

HOLEN /settings/{key} (Einzelne Einstellung)​

Es werden nur die Werte (ohne Metadaten) für den angeforderten Schlüssel zurückgegeben.

Einstellungen übernehmen​

BEITRAG /settings/ (Pauschalanwendung)​

Mehrere Tasten werden gleichzeitig angewendet.

Empfohlenes Format des Textes: Ein JSON-Objekt, das Schlüssel Werten zuordnet.

{
"devices/detection/timeout": 5,
"devices/detection/advanced/wvg_description_filter": ["Haply USB Transceiver", "Haply Handle"]
}

BEITRAG /settings/{key} (Einmalige Anwendung)​

Wendet einen neuen Wert auf einen einzelnen Schlüssel an.

Empfohlenes Format für den Text: entweder ein JSON-Rohwert oder ein umschlossener Wert (aus Gründen der Klarheit wird ein umschlossener Wert empfohlen).

{
"value": 5
}

Einstellungen zurücksetzen​

LÖSCHEN /settings/{key}​

Setzt die Taste auf den Standardwert zurück.

Dies entspricht der Option „Auf Standardwerte zurücksetzen“.

Typhinweis​

Der Service type_hintwird automatisch abgeleitet. Bei komplexen Typen wird als Ersatzwert GENERICDies wird verwendet.

Unterstützte Hinweise:

  • BOOL
  • INT
  • FLOAT
  • STRING
  • VEC2
  • VEC3
  • VEC4
  • TRANSFORM
  • ARR_INT
  • ARR_FLOAT
  • ARR_STRING
  • GENERIC

Veraltete Endpunkte, die nicht mehr verwendet werden​

mehrere POST Endpunkte sind zwar weiterhin zulässig, es wird jedoch eine Warnung bezüglich der Einstellung der Nutzung ausgegeben, und 4.0wird entfernt. Detaillierte Informationen zum Stilllegungsplan → Tabelle mit Ausweichrouten finden Sie unter 3.5 MigrationsleitfadenSiehe dort.