HTTP
Standardmäßig wird der HTTP-Dienst unter folgender Adresse gestartet:http://localhost:10001。
Der Port kannin der Konfigurationdes Dienstes geändert werden.
Überblick
In diesem Abschnitt werden die von diesem Dienst veröffentlichten HTTP-Routen aufgeführt.
Alle folgenden Routen basieren auf der Standard-Basis-URL http://localhost:10001 als Voraussetzung.
Standard-Antwortstruktur
Alle Endpunkte geben eine der beiden folgenden Strukturen zurück:
Keine Datenantwort(für Endpunkte, die ausschließlich zur Änderung von Daten dienen):
{ "ok": true }
{ "ok": false, "error": "reason string" }
Datenantwort(für GET-Anfragen sowie für POST-/DELETE-Anfragen an Konfigurations-Endpunkte, bei denen bereits angewendete Werte zurückgegeben werden):
{ "ok": true, "data": { "..." : "..." } }
{ "ok": false, "error": "reason string" }
Syntax des Geräteauswahl-Tools
Verwendung von Routing auf Geräteebene /{device_type}/{id_or_index}/... Format. Pfadabschnitt {device_type} und {id_or_index} Zur Identifizierung des Zielgeräts.
| Beispiel für einen Pfadabschnitt | Bedeutung |
|---|---|
inverse3/0 | Der erste Eintrag, der anhand des Index (beginnend bei 0) ausgewählt wurde Inverse3 |
inverse3/A14 | Die Geräte-ID lautet A14 的 Inverse3 |
inverse3/* | Alle Geräte unter Inverse3 (Platzhalter) |
verse_grip/0 | Der erste „Verse Grip“, der im Index ausgewählt wurde |
wireless_verse_grip/* | Alle Wireless Verse Grip-Modelle |
*inverse/* | Alle Geräte der Inverse-Serie (Inverse3, Inverse3x,Minverse) |
*verse_grip/* | Alle Geräte der Verse Grip-Serie (Verse Grip, Wireless VG) |
Regeln für Platzhalter:
GETSelektoren, die mehrdeutig sind oder Platzhalter enthalten, werden abgelehnt (gibt400).POSTundDELETEEs werden Platzhalter unterstützt; die Aktion wird auf alle übereinstimmenden Geräte angewendet.
Sitzungsauswahl
Endpunkte auf Sitzungsebene (basis, mount, preset, transform, filters) erfordern die Verwendung von ?session=<expr> Abfrageparameter zur Identifizierung der Sitzung.
| Ausdruck | Bedeutung |
|---|---|
| (Auslassung) | Alle Sitzungen (nur DELETE) |
#123 oder 123 | Die Sitzung mit der ID 123 |
:-1 | Die letzte Sitzung, die über den Index ausgewählt wurde |
:0 | Die erste Sitzung, die über den Index ausgewählt wurde |
Beispiel:GET /inverse3/0/config/basis?session=:0
Version
Vorgehensweise: 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
Vorgehensweise: GET
URL: http://localhost:10001/expert/status
Gibt detaillierte Statusinformationen zurück, darunter Informationen zu Überwachung, Geräten, Sitzungen und globalen Einstellungen.
Ausrüstung
Vorgehensweise: GET
URL: http://localhost:10001/devices
Zurück zur aktuellen Geräteliste, einschließlich config、state und status。
kann optional übergeben werden ?session=<expr> Parameter, der den Snapshot auf die Perspektive der angegebenen Sitzung filtert (wobei die Basis, die Einbindung und die Transformation dieser Sitzung auf den Rückgabewert angewendet werden).
Beispielantwort:
{
"inverse3": [
{
"device_id": "04BA",
"config": { "...": "..." },
"state": { "...": "..." },
"status": { "...": "..." }
}
]
}
Gespräch
| Methode | Pfad | Erläuterung |
|---|---|---|
| HOLEN | /sessions | Alle aktiven v3.1-Sitzungen auflisten |
| HOLEN | /sessions/{session_id} | Eine einzelne Sitzung abrufen |
| HOLEN | /sessions/{session_id}/profile | Den Namen des Sitzungsprofils abrufen |
| BEITRAG | /sessions/{session_id}/profile | Sitzungsprofil einrichten |
| LÖSCHEN | /sessions/{session_id}/profile | Die Konfigurationsdatei auf folgende Werte zurücksetzen: "default" |
BEITRAG /sessions/{session_id}/profile Anfrage-Body:
{
"name": "my_profile"
}
Anschluss
Vorgehensweise: POST
URL: http://localhost:10001/ports/{port}/reset
Die blockierte serielle Schnittstelle freigeben. Zurück { "ok": true }。
Gerätekonfiguration
Alle Konfigurationsendpunkte verwenden /{device_type}/{id_or_index}/config/{setting} Format.
Endpunkte auf Sitzungsebene (basis, mount, preset) benötigen außerdem ?session=<expr> Abfrageparameter.
Einstellungen für die linke und rechte Hand (nur „ Inverse3“)
| Methode | Pfad | Anfragetext | Antwort |
|---|---|---|---|
| HOLEN | /{device_type}/{id}/config/handedness | -- | "left" oder "right" |
| BEITRAG | /{device_type}/{id}/config/handedness | "left" oder "right" | Ausgabewert |
| LÖSCHEN | /{device_type}/{id}/config/handedness | -- | "right"(Standard) |
Drehmomentskalierung (nur Inverse3)
| Methode | Pfad | Anfragetext | Antwort |
|---|---|---|---|
| HOLEN | /{device_type}/{id}/config/torque_scaling | -- | { "enabled": bool } |
| BEITRAG | /{device_type}/{id}/config/torque_scaling | { "enabled": bool } | Ausgabewert |
| LÖSCHEN | /{device_type}/{id}/config/torque_scaling | -- | { "enabled": false } |
Schwerkraftkompensation (nur Inverse3)
| Methode | Pfad | Anfragetext | Antwort |
|---|---|---|---|
| HOLEN | /{device_type}/{id}/config/gravity_compensation | -- | { "enabled": bool, "scaling_factor": float } |
| BEITRAG | /{device_type}/{id}/config/gravity_compensation | { "enabled": bool, "scaling_factor": float } | Ausgabewert |
| LÖSCHEN | /{device_type}/{id}/config/gravity_compensation | -- | { "enabled": true, "scaling_factor": 1.0 } |
Basis (alle Geräte, auf Sitzungsebene)
| Methode | Pfad | Anfragetext | Antwort |
|---|---|---|---|
| HOLEN | /{device_type}/{id}/config/basis?session= | -- | { "permutation": "XYZ" } |
| BEITRAG | /{device_type}/{id}/config/basis?session= | { "permutation": "ZXY" } | Ausgabewert |
| LÖSCHEN | /{device_type}/{id}/config/basis?session= | -- | { "permutation": "XYZ" } |
Mount (alle Geräte, auf Sitzungsebene)
| Methode | Pfad | Anfragetext | Antwort |
|---|---|---|---|
| HOLEN | /{device_type}/{id}/config/mount?session= | -- | { "transform": {...} } |
| BEITRAG | /{device_type}/{id}/config/mount?session= | { "transform": {...} } | Ausgabewert |
| LÖSCHEN | /{device_type}/{id}/config/mount?session= | -- | Identitätsabbildung |
„Transform“-Struktur(für „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, auf Sitzungsebene)
| Methode | Pfad | Anfragetext | Antwort |
|---|---|---|---|
| HOLEN | /{device_type}/{id}/config/preset?session= | -- | { "preset": "arm_front_centered" } |
| BEITRAG | /{device_type}/{id}/config/preset?session= | { "preset": "arm_front_centered" } | Ausgabewert |
| 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 (gilt nur für Inverse3, auf Sitzungsebene)
Verwendung von Filterendpunkten /{device_type}/{id}/config/filters/{filter}?session=<expr>。
Dämpfung
Gleichzeitige Steuerung der gleichmäßigen Dämpfung und der richtungsabhängigen Dämpfung. Der POST-Anfrage-Body muss mindestens ein Feld enthalten.
| Methode | Pfad | Anfragetext | Antwort |
|---|---|---|---|
| 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 beides gleichzeitig | Ausgabewert |
| LÖSCHEN | /{device_type}/{id}/config/filters/damping?session= | -- | Beide werden auf Null zurückgesetzt |
Kraftgesteuert
| Methode | Pfad | Anfragetext | Antwort |
|---|---|---|---|
| HOLEN | /{device_type}/{id}/config/filters/force_gate?session= | -- | { "gain": float } |
| BEITRAG | /{device_type}/{id}/config/filters/force_gate?session= | { "gain": float } | Ausgabewert |
| LÖSCHEN | /{device_type}/{id}/config/filters/force_gate?session= | -- | Standardverstärkung in den Einstellungen |
Gerätestatus
Umwandlung (alle Geräte, auf Sitzungsebene)
Arbeitsraumtransformation (vom Geräteraum zum Anwendungsraum).
| Methode | Pfad | Anfragetext | Antwort |
|---|---|---|---|
| HOLEN | /{device_type}/{id}/state/transform?session= | -- | { "transform": {...} } |
| BEITRAG | /{device_type}/{id}/state/transform?session= | { "transform": {...} } | Ausgabewert |
| LÖSCHEN | /{device_type}/{id}/state/transform?session= | -- | Identitätsabbildung |
Konfiguration speichern
Gilt nur für Geräte vom Typ „ Inverse3 “. Warnung: Vermeiden Sie es, die Konfiguration zu häufig zu speichern, da die Anzahl der Speichervorgänge pro Gerät begrenzt ist (ca. 10.000 EEPROM-Schreibvorgänge).
Vorgehensweise: POST
URL: http://localhost:10001/save_configuration
Beispiel für einen Request-Body:
{
"device_id": "049D"
}
Beispielantwort:
{
"ok": true
}
Einstellungen
Die Endpunktkonfiguration bietet automatisch folgende Funktionen:
- Alle Einstellungen auflisten (einschließlich Metadaten)
- Den Wert einer einzelnen Einstellung auslesen
- Anwendungseinstellungen (einzeln oder in großen Mengen)
- Eine bestimmte Einstellung auf den Standardwert zurücksetzen
Eine Beschreibung aller Einstelltasten finden Siehier.
Routing
| Methode | Routing | Beschreibung |
|---|---|---|
| HOLEN | /settings/ | AlleEinstellungsschlüssel, Werte und Metadaten abrufen. |
| BEITRAG | /settings/ | MehrereEinstellungen auf einmal anwenden. |
| HOLEN | /settings/{key} | Den aktuellen Wertdes angegebenen Einstellungsschlüssels abrufen. |
| BEITRAG | /settings/{key} | Umeinen neuen Wertauf den angegebenen Schlüssel anzuwenden. |
| LÖSCHEN | /settings/{key} | Eine bestimmte Taste auf ihrenStandardwertzurücksetzen. |
Antwortstruktur
HOLEN /settings/(Alle Einstellungen)
Gibt ein Objekt zurück, dessen Schlüssel der angegebene Schlüssel ist. Jeder Eintrag enthält:
value: Aktueller Wertmetadata: 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)
Gibtnur den Wertdes angeforderten Schlüssels zurück (ohne Metadaten).
App-Einstellungen
BEITRAG /settings/(Massenanwendung)
Mehrere Schlüssel auf einmal anwenden.
Empfohlenes Format für den Anfragetext: Ein JSON-Objekt, in dem Schlüssel Werten zugeordnet sind.
{
"devices/detection/timeout": 5,
"devices/detection/advanced/wvg_description_filter": ["Haply USB Transceiver", "Haply Handle"]
}
BEITRAG /settings/{key}(Einzelne Anwendung)
Einen neuen Wert auf einen einzelnen Schlüssel anwenden.
Empfohlenes Format für den Anfragetext: Roh-JSON-Werte oder verpackte Werte (die Verwendung der verpackten Form wird empfohlen, um die Lesbarkeit zu verbessern).
{
"value": 5
}
Einstellungen zurücksetzen
LÖSCHEN /settings/{key}
Setzen Sie diesen Schlüssel auf seinen Standardwert zurück.
Das entspricht „Auf Standardwerte zurücksetzen“.
Typhinweise
Der Dienst leitet dies automatisch ab type_hint。Bei komplexen Typen wird auf GENERIC。
Tipps zur Unterstützung:
BOOLINTFLOATSTRINGVEC2VEC3VEC4TRANSFORMARR_INTARR_FLOATARR_STRINGGENERIC
Veraltete, nicht mehr unterstützte Endpunkte
Es gibt noch einige POST Der Endpunkt ist weiterhin verfügbar, es wird jedoch eine Verwendungswarnung ausgegeben,
und er wird 4.0 Entfernen Sie dies. Siehe 3.5 Leitfaden zur Migration,
Sehen Sie sich die vollständige Übersicht über veraltete Pfade und alternative Routen an.