HTTP

Standardmäßig wird der HTTP-Dienst eingeschaltet: http://localhost:10000. Hinweis: Der Port kann in der Konfiguration des Dienstes geändert werden.

Version

Methode: GET

URL: http://localhost:10000/version

Beispiel für eine Antwort:

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

Geräte

Methode: GET

URL: http://localhost:10000/devices

Beispiel für eine Antwort:

{
  "inverse3": [
    {
      "device_id": "04BA",
      "config": {
        "type": "inverse3",
        "device_info": {
          "minor_version": 1,
          "major_version": 7,
          "id": "04BA",
          "device_type": 4,
          "uuid": "2D35F80DD9005F599B68F49944CB04BA"
        },
        "port": "COM13",
        "extended_device_id": "2D35F80DD9005F599B68F49944CB04BA",
        "extended_firmware_version": "8C20FDC8010AA1E15AA133CDA2534874",
        "gravity_compensation": {
          "enabled": true,
          "scaling_factor": 1
        },
        "handedness": "right",
        "torque_scaling": {
          "enabled": true
        }
      },
      "state": {
        "angular_position": {
          "a0": -69.31704,
          "a1": 137.62952,
          "a2": 19.832787
        },
        "angular_velocity": {
          "a0": 0,
          "a1": 0,
          "a2": 0
        },
        "body_orientation": {
          "x": -0.01940918,
          "y": 0.7026367,
          "z": 0.00048828125,
          "w": 0.7113037
        },
        "cursor_position": {
          "x": 0.07842738,
          "y": -0.14836666,
          "z": 0.14297646
        },
        "cursor_velocity": {
          "x": -0.011969013,
          "y": 0.0012009288,
          "z": -0.043197
        },
        "mode": "idle"
      },
      "status": {
        "calibrated": false,
        "in_use": false,
        "power_supply": true,
        "ready": true,
        "started": true
      }
    }
  ],
  "verse_grip": [
    {
      "device_id": "61548",
      "config": {
        "port": "COM3",
        "type": "verse_grip"
      },
      "state": {
        "button": false,
        "hall": 0,
        "orientation": {
          "x": -0.5019531,
          "y": 0.8632202,
          "z": -0.048095703,
          "w": -0.022338867
        }
      },
      "status": {
        "error": 0,
        "ready": true
      }
    }
  ],
  "wireless_verse_grip": [
    {
      "device_id": "0",
      "config": {
        "port": "COM6",
        "type": "wireless_verse_grip",
        "major_version": 1,
        "minor_version": 4,
        "hardware_version": 1
      },
      "state": {
        "battery_level": 0.816,
        "battery_voltage": 3.77,
        "buttons": {
          "a": false,
          "b": false,
          "c": false
        },
        "hall": 16,
        "orientation": {
          "x": -0.019866943,
          "y": -0.017486572,
          "z": 0.05508423,
          "w": -0.9963989
        }
      },
      "status": {
        "connected": true,
        "awake": true,
        "ready": true
      }
    }
  ]
}

Kraft-Skala

Methode: POST

URL: http://localhost:10000/force_scale

Beispiel Körper:

{
  "force_scale": 0.5
}

Beispiel für eine Antwort:

{
  "ok": true
}

Schwerkraft-Kompensation

Methode: POST

URL: http://localhost:10000/gravity_compensation

Beispiel Körper:

{
  "device_id": "049D",
  "enable": true,
  "gravity_scaling_factor": 0.8
}

Beispiel für eine Antwort:

{
  "ok": true
}

Skalierung des Drehmoments

Methode: POST

URL: http://localhost:10000/torque_scaling

Beispiel Körper:

{
  "device_id": "049D",
  "enable": true
}

Beispiel für eine Antwort:

{
  "ok": true
}

Handlichkeit des Geräts

Methode: POST

URL: http://localhost:10000/device_handedness

Beispiel Körper:

{
  "device_id": "049D",
  "handedness": "right"
}

Beispiel für eine Antwort:

{
  "ok": true
}

Konfiguration speichern

Funktioniert nur mit Inverse3 . Warnung: Vermeiden Sie es, die Konfiguration zu oft zu speichern, da es nur eine begrenzte Anzahl von Speicherungen gibt, die auf ein bestimmtes Gerät angewendet werden kann.

Methode: POST

URL: http://localhost:10000/save_configuration

Beispiel Körper:

{
  "device_id": "049D"
}

Beispiel für eine Antwort:

{
  "ok": true
}

Serielle Freigabe

Aktivieren oder deaktivieren Sie die gesamte serielle Kommunikation. Wenn die serielle Kommunikation deaktiviert ist, ist es nicht möglich, Befehle an die Geräte zu senden.

Methode: POST

URL: http://localhost:10000/serial_enable

Beispiel Körper:

{
  "enable": true
}

Beispiel für eine Antwort:

{
  "ok": true
}

Grip Vertikalstopper

Aktivieren oder deaktivieren Sie die experimentelle Funktion des vertikalen Griffstoppers. Diese Funktion überprüft die Ausrichtung des drahtlosen VerseGrip, um zu erkennen wenn der VerseGrip fallen gelassen wird. Wenn sie ausgelöst wird, wird der Inverse3 in seiner aktuellen Position in Positionskontrolle versetzt, damit der Endeffektor nicht herunterfällt. Sie wird automatisch deaktiviert, wenn der VerseGrip wieder aufgenommen wird.

Experimentelle

Da es sich um eine experimentelle Funktion handelt, ist sie standardmäßig deaktiviert und muss zur Aktivierung explizit aktiviert werden.

Methode: POST

URL: http://localhost:10000/experimental/features/grip_dropped_simulation_stopper

Beispiel Körper:

{
  "enable": true,
  "hall_effect_threshold": 17
}

Beispiel für eine Antwort:

{
  "ok": true
}