Zum Hauptinhalt springen

HTTP

Standardmäßig wird der HTTP-Dienst unter folgendem Pfad gestartet: http://localhost:10001.

Der Port kann in den Serviceeinstellungen geändert werden.

Überblick​

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

Alle unten aufgeführten Routen setzen die standardmäßige Basis-URL voraus: http://localhost:10001.

Standard-Antwortumschlag​

Alle Endpunkte geben eine von zwei Hüllkurven zurück:

Antwort ohne Daten (wird nur von Änderungsendpunkten verwendet):

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

Datenantwort (wird von GET sowie von POST/DELETE an Konfigurations-Endpunkten verwendet, die den angewendeten Wert zurückgeben):

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

Syntax des Geräteselektors​

Die Routen auf Geräteebene verwenden das Muster /{device_type}/{id_or_index}/.... Die Wegabschnitte {device_type} et {id_or_index} identifizieren das oder die betroffenen Geräte.

Beispiel für einen WegabschnittBedeutung
inverse3/0Premier Inverse3 , gemäß dem Index (Basis 0)
inverse3/A14Inverse3 Die Gerätekennung lautet A14
inverse3/*Alle Geräte Inverse3 (Platzhalter)
verse_grip/0Premier Verse Grip nach dem Index
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 verwirft mehrdeutige oder Platzhalter enthaltende Selektoren (gibt 400).
  • POST et DELETE akzeptieren Platzhalter: Die Aktion wird auf alle entsprechenden Geräte angewendet.

Sitzungsauswahl​

Endpunkte im Sitzungsbereich (basis, mount, preset, transform, filters) erfordern einen Abfrageparameter. ?session=<expr> zur Identifizierung der Sitzung.

AusdruckBedeutung
(ausgelassen)Alle Sitzungen (nur DELETE)
#123 ou 123Sitzung mit der numerischen Kennung 123
:-1Letzte Sitzung gemäß Index
:0Erste Sitzung gemäß dem 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

Liefert detaillierte Informationen zum Status, einschließlich Erkennung, Geräte, Sitzungen und globale Einstellungen.


Geräte​

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

Gibt die aktuelle Geräteübersicht zurück, einschließlich config, state et status.

Sie können auch Folgendes übermitteln ?session=<expr> um den Snapshot aus der Perspektive einer bestimmten Sitzung zu filtern (wendet die Basis, den Mount und die Transformationen dieser Sitzung auf die zurückgegebenen Werte an).

Beispielantwort:

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

Sitzungen​

MethodeCheminBeschreibung
HOLEN/sessionsAlle aktiven v3.1-Sitzungen auflisten
HOLEN/sessions/{session_id}Eine Sitzung einrichten
HOLEN/sessions/{session_id}/profileDen Namen des Sitzungsprofils abrufen
BEITRAG/sessions/{session_id}/profileSitzungsprofil festlegen
LÖSCHEN/sessions/{session_id}/profileProfil zurücksetzen auf "default"

Hauptteil der POST-Anfrage /sessions/{session_id}/profile :

{
"name": "my_profile"
}

Anschlüsse​

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

Setzt einen blockierten seriellen Anschluss zurück. Gibt zurück { "ok": true }.


Gerätekonfiguration​

Alle Konfigurationsendpunkte verwenden das Muster /{device_type}/{id_or_index}/config/{setting}.

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

Lateralität (nur „Inverse3 “)​

MethodeCheminKorpsAntwort
HOLEN/{device_type}/{id}/config/handedness--"left" ou "right"
BEITRAG/{device_type}/{id}/config/handedness"left" ou "right"Rückgabewert
LÖSCHEN/{device_type}/{id}/config/handedness--"right" (Standard)

Skalierung des Drehmoments (nur „Inverse3 “)​

MethodeCheminKorpsAntwort
HOLEN/{device_type}/{id}/config/torque_scaling--{ "enabled": bool }
BEITRAG/{device_type}/{id}/config/torque_scaling{ "enabled": bool }Rückgabewert
LÖSCHEN/{device_type}/{id}/config/torque_scaling--{ "enabled": false }

Schwerkraftkompensation (nur „Inverse3 “)​

MethodeCheminKorpsAntwort
HOLEN/{device_type}/{id}/config/gravity_compensation--{ "enabled": bool, "scaling_factor": float }
BEITRAG/{device_type}/{id}/config/gravity_compensation{ "enabled": bool, "scaling_factor": float }Rückgabewert
LÖSCHEN/{device_type}/{id}/config/gravity_compensation--{ "enabled": true, "scaling_factor": 1.0 }

Grundlage (alle Geräte, die sich in Reichweite der Sitzung befinden)​

MethodeCheminKorpsAntwort
HOLEN/{device_type}/{id}/config/basis?session=--{ "permutation": "XYZ" }
BEITRAG/{device_type}/{id}/config/basis?session={ "permutation": "ZXY" }Rückgabewert
LÖSCHEN/{device_type}/{id}/config/basis?session=--{ "permutation": "XYZ" }

Einbinden (alle Geräte, die sich in Reichweite befinden)​

MethodeCheminKorpsAntwort
HOLEN/{device_type}/{id}/config/mount?session=--{ "transform": {...} }
BEITRAG/{device_type}/{id}/config/mount?session={ "transform": {...} }Rückgabewert
LÖSCHEN/{device_type}/{id}/config/mount?session=--Identitätswandel

Struktur der Transformation (wird von „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 }
}
}

Voreinstellung (alle Geräte, auf die aktuelle Sitzung beschränkt)​

MethodeCheminKorpsAntwort
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" }

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


Gerätefilter (nur „Inverse3 “, auf die aktuelle Sitzung beschränkt)​

Die Endpunkte der Filter verwenden /{device_type}/{id}/config/filters/{filter}?session=<expr>.

Abschreibung​

Steuert sowohl die gleichmäßige Dämpfung als auch die richtungsabhängige Dämpfung. Im Hauptteil der POST-Anfrage muss mindestens ein Feld vorhanden sein.

MethodeCheminKorpsAntwort
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 } ou { "vector": {...} } oder beidesRückgabewerte
LÖSCHEN/{device_type}/{id}/config/filters/damping?session=--die beiden Rücksetzungen

Türöffner​

MethodeCheminKorpsAntwort
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=--in den Einstellungen festgelegte Standardverstärkung

Gerätezustand​

Umwandlung (alle Geräte, auf die Sitzung beschränkt)​

Umwandlung des Arbeitsraums (vom Geräteraum in den Anwendungsraum).

MethodeCheminKorpsAntwort
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ätswandel

Konfiguration speichern​

Funktioniert ausschließlich mit folgenden Geräten Inverse3. Achtung: Speichern Sie die Konfiguration nicht zu oft, da die Anzahl der möglichen Speichervorgänge auf einem Gerät begrenzt ist (ca. 10.000 EEPROM-Schreibvorgänge).

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

Beispiel für einen Textblock:

{
"device_id": "049D"
}

Beispielantwort:

{
"ok": true
}

Einstellungen​

Die Parameterendpunkte werden automatisch generiert für:

  • Liste aller Parameter (einschließlich Metadaten)
  • Auslesen des Werts eines einzelnen Parameters
  • Anwendung von Parametern (einzeln oder stapelweise)
  • Zurücksetzen eines Schlüssels auf seine Standardwerte

Die Referenzen aller Parameterschlüssel finden Sie hier

Routen​

MethodeRouteBeschreibung
HOLEN/settings/Alle Parameterschlüssel, deren Werte und Metadaten abrufen.
BEITRAG/settings/Mehrere Einstellungen gleichzeitig anwenden (im Stapelverfahren).
HOLEN/settings/{key}Den aktuellen Wert eines bestimmten Parameterschlüssels abrufen.
BEITRAG/settings/{key}Einem bestimmten Schlüssel einen neuen Wert zuweisen.
LÖSCHEN/settings/{key}Einen Schlüssel auf seine Standardwerte zurücksetzen.

Form der Antwort​

HOLEN /settings/ (alle Parameter)​

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

  • value : der Barwert
  • metadata : Typ, Einschränkungen und 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} (einzelner Parameter)​

Gibt ausschließlich den Wert (ohne Metadaten) des angeforderten Schlüssels zurück.

Anwendung der Parameter​

BEITRAG /settings/ (Antrag pro Los)​

Bringen Sie mehrere Schlüssel gleichzeitig an.

Empfohlenes Format: Ein JSON-Objekt, in dem Schlüssel ihren Werten zugeordnet sind.

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

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

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

Empfohlenes Format für den Hauptteil: entweder ein roher JSON-Wert oder ein gekapselter Wert (vorzugsweise, um die Übersichtlichkeit zu gewährleisten).

{
"value": 5
}

Einstellungen zurücksetzen​

LÖSCHEN /settings/{key}​

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

Das entspricht einem „Zurücksetzen auf die Standardwerte“.

Indikationen vom Typ​

Der Dienst zieht automatisch ab type_hint. GENERIC wird als Ausweichlösung für komplexe Typen verwendet.

Erstattungsfähige Indikationen:

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

Veraltete Endpunkte​

Mehrere Endpunkte POST werden weiterhin akzeptiert, lösen jedoch eine Veraltungswarnung aus und werden in der Version entfernt 4.0. Lesen Sie den Migrationsleitfaden 3.5 für die vollständige Übersicht über die Zuordnung zwischen den nicht mehr empfohlenen Routen und den Ausweichrouten.