Zum Hauptinhalt springen

HTTP

Standardmäßig ist der HTTP-Dienst http://localhost:10001 wird damit gestartet.

Die Portnummer kannin den Einstellungendes Dienstes geändert werden.

Zusammenfassung​

In diesem Abschnitt werden die vom Dienst veröffentlichten HTTP-Routen erläutert.

Alle folgenden Pfade beziehen sich auf die Standard-Basis-URL http://localhost:10001 geht davon aus, dass …

Standard-Ansprechkurve​

Alle Endpunkte geben eine der beiden folgenden Envelope-Typen zurück:

Antwort ohne Daten(wird bei Endpunkten verwendet, die ausschließlich für Änderungsvorgänge vorgesehen sind):

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

Antwort mit Daten(wird neben GET auch bei POST/DELETE für Konfigurations-Endpunkte verwendet, die angewendete Werte zurückgeben):

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

Syntax des Geräteauswahlfelds​

Der Root-Zugang auf Geräteebene ist /{device_type}/{id_or_index}/... Verwenden Sie das Muster.{device_type} und {id_or_index} Geben Sie das betreffende Gerät im Pfadsegment an.

Das besagte WegsegmentBedeutung
inverse3/0Der erste Eintrag, der durch den Index (ab 0) angegeben wurde Inverse3
inverse3/A14Geräte-ID A14 の Inverse3
inverse3/*Alle Geräte unter Inverse3 (Platzhalter)
verse_grip/0Der erste „Verse Grip“, der im Index angegeben wurde
wireless_verse_grip/*Alle Wireless Verse Grip-Modelle
*inverse/*Alle Geräte der Inverse-Familie (Inverse3, Inverse3x,Minverse)
*verse_grip/*Alle Geräte der Verse Grip-Familie (Verse Grip, Wireless VG)

Regeln für Platzhalter:

  • GET lehnt Selektoren ab, die mehrdeutige Selektoren oder Selektoren mit Platzhaltern enthalten (400 zurückgibt).
  • POST und DELETE Akzeptiert Platzhalter. Die Aktion wird auf alle übereinstimmenden Geräte angewendet.

Sitzungsauswahl​

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

FormelBedeutung
(ausgelassen)Alle Sitzungen (nur DELETE)
#123 oder 123Sitzung mit der ID 123
:-1Letzte Sitzung nach Index
:0Erste Sitzung anhand des 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 Erkennungsdaten, Geräte, Sitzungen und globale Einstellungen.


Gerät​

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

config、state、status Gibt eine Liste der derzeitigen Geräte zurück, einschließlich …

bei Bedarf ?session=<expr> Wenn Sie dies angeben, können Sie den Snapshot auf die Perspektive einer bestimmten Sitzung eingrenzen (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​

MethodePassErläuterung
HOLEN/sessionsAlle aktiven v3.1-Sitzungen auflisten
HOLEN/sessions/{session_id}Eine einzelne Sitzung abrufen
HOLEN/sessions/{session_id}/profileDen Namen des Sitzungsprofils abrufen
BEITRAG/sessions/{session_id}/profileSitzungsprofil konfigurieren
LÖSCHEN/sessions/{session_id}/profileProfil "default" Zurücksetzen

BEITRAG /sessions/{session_id}/profile Der Text:

{
"name": "my_profile"
}

Port​

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

Löscht den gesperrten seriellen Anschluss.{ "ok": true } gibt zurück.


Geräteeinstellungen​

Alle Konfigurations-Endpunkte sind /{device_type}/{id_or_index}/config/{setting} Verwenden Sie das Muster.

Bei den Endpunkten im Sitzungsbereich (basis, mount, preset) gibt es außerdem ?session=<expr> Es sind Abfrageparameter erforderlich.

Dominante Hand (nur „Inverse3 “)​

MethodePassKarosserieAntwort
HOLEN/{device_type}/{id}/config/handedness--"left" oder "right"
BEITRAG/{device_type}/{id}/config/handedness"left" oder "right"der zurückgegebene Wert
LÖSCHEN/{device_type}/{id}/config/handedness--"right"(Standard)

Torx-Skalierung (nurInverse3 )​

MethodePassKarosserieAntwort
HOLEN/{device_type}/{id}/config/torque_scaling--{ "enabled": bool }
BEITRAG/{device_type}/{id}/config/torque_scaling{ "enabled": bool }der zurückgegebene Wert
LÖSCHEN/{device_type}/{id}/config/torque_scaling--{ "enabled": false }

Schwerkraftkompensation (nurInverse3 )​

MethodePassKarosserieAntwort
HOLEN/{device_type}/{id}/config/gravity_compensation--{ "enabled": bool, "scaling_factor": float }
BEITRAG/{device_type}/{id}/config/gravity_compensation{ "enabled": bool, "scaling_factor": float }der zurückgegebene Wert
LÖSCHEN/{device_type}/{id}/config/gravity_compensation--{ "enabled": true, "scaling_factor": 1.0 }

Basis (alle Geräte, Sitzungsbereich)​

MethodePassKarosserieAntwort
HOLEN/{device_type}/{id}/config/basis?session=--{ "permutation": "XYZ" }
BEITRAG/{device_type}/{id}/config/basis?session={ "permutation": "ZXY" }der zurückgegebene Wert
LÖSCHEN/{device_type}/{id}/config/basis?session=--{ "permutation": "XYZ" }

Mount (alle Geräte, Sitzungsbereich)​

MethodePassKarosserieAntwort
HOLEN/{device_type}/{id}/config/mount?session=--{ "transform": {...} }
BEITRAG/{device_type}/{id}/config/mount?session={ "transform": {...} }der zurückgegebene Wert
LÖSCHEN/{device_type}/{id}/config/mount?session=--Identitätstransformation (identity transform)

Struktur von „Transform“(verwendet in „mount“ und „state/transform“):

{
"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, pro Sitzung)​

MethodePassKarosserieAntwort
HOLEN/{device_type}/{id}/config/preset?session=--{ "preset": "arm_front_centered" }
BEITRAG/{device_type}/{id}/config/preset?session={ "preset": "arm_front_centered" }der zurückgegebene Wert
LÖSCHEN/{device_type}/{id}/config/preset?session=--{ "preset": "device_defaults" }

Verfügbare Werte: device_defaults, arm_front, arm_front_centered, led_front, led_front_centered, custom。


Gerätefilter (nurInverse3 , pro Sitzung)​

Die Endpunkte des Filters sind /{device_type}/{id}/config/filters/{filter}?session=<expr> wird verwendet.

Dumping​

Es werden sowohl die gleichmäßige Dämpfung als auch die richtungsabhängige Dämpfung gesteuert. Der POST-Body muss mindestens ein Feld enthalten.

MethodePassKarosserieAntwort
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 beidesder zurückgegebene Wert
LÖSCHEN/{device_type}/{id}/config/filters/damping?session=--Beide auf Null zurücksetzen

Force Gate​

MethodePassKarosserieAntwort
HOLEN/{device_type}/{id}/config/filters/force_gate?session=--{ "gain": float }
BEITRAG/{device_type}/{id}/config/filters/force_gate?session={ "gain": float }der zurückgegebene Wert
LÖSCHEN/{device_type}/{id}/config/filters/force_gate?session=--Standardwert für „gain“ in den Einstellungen

Gerätezustand​

Transform (alle Geräte, pro Sitzung)​

Arbeitsbereichsumsetzung (Umwandlung vom Geräteraum in den Anwendungsraum).

MethodePassKarosserieAntwort
HOLEN/{device_type}/{id}/state/transform?session=--{ "transform": {...} }
BEITRAG/{device_type}/{id}/state/transform?session={ "transform": {...} }der zurückgegebene Wert
LÖSCHEN/{device_type}/{id}/state/transform?session=--Identitätsabbildung

Einstellungen speichern​

Inverse3 Funktioniert nur auf diesem Gerät. Warnung: Speichern Sie die Einstellungen nicht zu häufig. Die Anzahl der Speichervorgänge, die auf einem Gerät möglich sind, ist begrenzt (ca. 10.000 Schreibvorgänge in den EEPROM).

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

Beispiele für den Textkörper:

{
"device_id": "049D"
}

Beispiel für eine Antwort:

{
"ok": true
}

Einstellungen​

Die Endpunkte für die Konfiguration werden automatisch für folgende Elemente generiert:

  • Liste aller Einstellungen abrufen (einschließlich Metadaten)
  • Auslesen eines einzelnen Einstellwerts
  • Einstellungen anwenden (einzeln oder gesammelt)
  • Zurücksetzen des Schlüssels auf den Standardwert

Eine Liste der Konfigurationsschlüssel finden Siehier.

Route​

MethodeRouteErläuterung
HOLEN/settings/AlleKonfigurationsschlüssel, Werte und Metadaten abrufen.
BEITRAG/settings/MehrereEinstellungen werden gleichzeitig übernommen.
HOLEN/settings/{key}Ruftden aktuellen Werteines bestimmten Konfigurationsschlüssels ab.
BEITRAG/settings/{key}Wendeteinen neuen Wert auf einen bestimmten Schlüsselan.
LÖSCHEN/settings/{key}Setzt den Schlüssel aufden Standardwertzurück.

Format der Antwort​

HOLEN /settings/(Alle Einstellungen)​

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

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

Beispiel für einen Eintrag:

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

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

GibtnurdenWertdes angegebenen Schlüssels zurück (ohne Metadaten).

Einstellungen übernehmen​

BEITRAG /settings/(Pauschalanwendung)​

Mehrere Schlüssel werden gleichzeitig angewendet.

Empfohlene Body-Form: Ein JSON-Objekt, das die Zuordnung von Schlüsseln zu Werten darstellt.

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

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

Einem einzelnen Schlüssel wird ein neuer Wert zugewiesen.

Empfohlenes Format für den Body: entweder ein roher JSON-Wert oder ein gekapselter Wert (aus Gründen der Übersichtlichkeit wird das gekapselte Format empfohlen).

{
"value": 5
}

Einstellungen zurücksetzen​

LÖSCHEN /settings/{key}​

Setzt den Schlüssel auf den Standardwert zurück.

Das entspricht der Funktion „Auf Standardwerte zurücksetzen“.

Typhinweise​

Der Service ist type_hint wird automatisch ermittelt. Bei komplexen Typen wird als Fallback GENERIC wird verwendet.

Unterstützte Tipps:

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

Veraltete Endpunkte, von deren Verwendung abgeraten wird​

einige POST Endpunkte werden weiterhin akzeptiert, es wird jedoch eine Warnung angezeigt, dass sie nicht mehr empfohlen werden. Diese sind 4.0 soll gelöscht werden. Eine vollständige Zuordnungstabelle von veralteten Pfaden zu den Ersatzpfaden finden Sie unter:3.5 MigrationsanleitungBitte sehen Sie sich das an.