HTTP

デフォルトでは、HTTPサービスはオンで起動する： http://localhost:10000.

ポートは、サービスの設定で変更できます。

概要

このセクションでは、本サービスが公開しているHTTPルートについて説明します。

以下のすべてのルートは、デフォルトのベースURLを使用することを前提としています： http://localhost:10000.

---

バージョン

方法： GET
URL： http://localhost:10000/version

回答例

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

---

デバイス

方法： GET
URL： http://localhost:10000/devices

現在のデバイス一覧を返します。これには以下が含まれます： config, stateそして status.

回答例

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

フォース・スケール

方法： POST
URL： http://localhost:10000/force_scale

ボディの例：

{
  "force_scale": 0.5
}

回答例

{
  "ok": true
}

---

重力補償

方法： POST
URL： http://localhost:10000/gravity_compensation

ボディの例：

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

回答例

{
  "ok": true
}

---

トルク・スケーリング

方法： POST
URL： http://localhost:10000/torque_scaling

ボディの例：

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

回答例

{
  "ok": true
}

---

デバイスの利便性

方法： POST
URL： http://localhost:10000/device_handedness

ボディの例：

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

回答例

{
  "ok": true
}

---

設定の保存

Inverse3 デバイスでのみ動作します。警告コンフィギュレーションを頻繁に保存することは避けてください。 保存できる数には限りがあります。

方法： POST
URL： http://localhost:10000/save_configuration

ボディの例：

{
  "device_id": "049D"
}

回答例

{
  "ok": true
}

---

シリアルイネーブル

すべてのシリアル通信を有効または無効にします。シリアル通信が無効になっている場合、デバイスへのコマンド送信はできません。

方法： POST
URL： http://localhost:10000/serial_enable

ボディの例：

{
  "enable": true
}

回答例

{
  "ok": true
}

---

設定

以下の設定エンドポイントは自動生成されます：

• すべての設定（メタデータを含む）を表示する
• 単一の設定値を読み取る
• 設定の適用（個別または一括）
• キーをデフォルト値にリセットする

すべての設定キーの参照はこちらでご確認いただけます

ルート

方法	ルート	説明
取得	/settings/	すべての設定キー、値、およびメタデータを取得します。
投稿	/settings/	複数の設定をまとめて一度に適用します。
取得	/settings/{key}	特定の設定キーの現在の値を取得します。
投稿	/settings/{key}	特定のキーに新しい値を割り当てる。
削除	/settings/{key}	キーをデフォルト値にリセットします。

応答形状

取得 /settings/ （すべての設定）

指定されたキーをキーとして持つオブジェクトを返します。各エントリには以下が含まれます：

• value: 現在の値
• metadata: 型 + 制約 + ロック状態

入力例：

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

取得 /settings/{key} （単一設定）

指定されたキーの値のみ（メタデータは含まない）を返します。

設定の適用

投稿 /settings/ (一括適用)

複数のキーをまとめて適用します。

推奨されるデータ形式：キーと値を対応付けたJSONオブジェクト。

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

投稿 /settings/{key} （単品購入）

1つのキーに新しい値を割り当てます。

推奨されるデータ形式：生のJSON値、またはラップされた値（可読性を高めるため、ラップされた値を推奨します）。

{
  "value": 5
}

設定のリセット

削除 /settings/{key}

キーをデフォルト値に戻します。

これは「デフォルト設定に戻す」ことと同じです。

型ヒント

このサービスは推論する type_hint 自動的に。 GENERIC は、複合型のフォールバックとして使用されます。

対応しているヒント：

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