HTTP
デフォルトでは、HTTP サービスは http://localhost:10001 開始しました。
このポートは、サービスの設定で変更できます。
概要
このセクションでは、本サービスが提供するHTTPルートについて説明します。
以下のすべてのルートは、標準のベースURLを起点としています: http://localhost:10001.
回答の標準的な構成
すべてのエンドポイントは、次の2つの応答構造のいずれかを返します:
データなしの応答(変更のみを行うエンドポイントで使用されます):
{ "ok": true }
{ "ok": false, "error": "reason string" }
データを含む応答(GET および、受け取った値を返す設定エンドポイントでの POST/DELETE で使用されます):
{ "ok": true, "data": { "..." : "..." } }
{ "ok": false, "error": "reason string" }
デバイスセレクタの構文
デバイスレベルのルートは、以下のパターンに従います /{device_type}/{id_or_index}/.... パスセグメント {device_type} und {id_or_index} 対象デバイスを特定します。
| 例となるパスセグメント | 意味 |
|---|---|
inverse3/0 | インデックス(0から始まる)に基づく最初のInverse3 デバイス |
inverse3/A14 | Inverse3 デバイスID付き A14 |
inverse3/* | すべてのInverse3 デバイス(プレースホルダー) |
verse_grip/0 | インデックスに基づく最初のヴァース・グリップ |
wireless_verse_grip/* | すべてのワイヤレス・ヴァース・グリップ |
*inverse/* | Inverseシリーズの全機種(Inverse3 、Inverse3x、Minverse ) |
*verse_grip/* | Verse-Grip シリーズ全機種(Verse Grip、Wireless VG) |
プレースホルダーのルール:
GET曖昧なセレクタやワイルドカードセレクタを拒否します(400).POSTundDELETEプレースホルダーを受け入れる――この操作は、条件に一致するすべてのデバイスに適用されます。
セッションセレクター
セッション関連のエンドポイント(basis、mount、preset、transform、filters)には、クエリパラメータが必要です。 ?session=<expr>、セッションを識別するために。
| 出力 | 意味 |
|---|---|
| (省略) | すべてのセッション(DELETEのみ) |
#123 oder 123 | 数値ID 123 の会議 |
:-1 | インデックス別の最終セッション |
:0 | インデックスに基づく最初の会議 |
例: GET /inverse3/0/config/basis?session=:0
バージョン
方法: GET
URL: http://localhost:10001/version
回答例:
{
"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"
}
エキスパートステータス
方法: GET
URL: http://localhost:10001/expert/status
検出結果、デバイス、セッション、グローバル設定など、詳細なステータス情報を返します。
機器
方法: GET
URL: http://localhost:10001/devices
現在のデバイス一覧を返します。これには以下が含まれます。 config, state und status.
必要に応じて、 ?session=<expr> を渡して、スナップショットを特定のセッションの視点に絞り込みます(この際、そのセッションのベース、マウント、および変換が、返される値に適用されます)。
回答例:
{
"inverse3": [
{
"device_id": "04BA",
"config": { "...": "..." },
"state": { "...": "..." },
"status": { "...": "..." }
}
]
}
会議
| 方法 | Pfad | 説明 |
|---|---|---|
| 取得 | /sessions | v3.1のすべてのアクティブなセッションを一覧表示する |
| 取得 | /sessions/{session_id} | 単一のセッションを取得する |
| 取得 | /sessions/{session_id}/profile | セッションプロファイルの名前を取得する |
| 投稿 | /sessions/{session_id}/profile | セッションプロファイルを設定します |
| 削除 | /sessions/{session_id}/profile | プロフィールを設定する "default" 戻る |
POSTによる本文 /sessions/{session_id}/profile:
{
"name": "my_profile"
}
ポート
方法: POST
URL: http://localhost:10001/ports/{port}/reset
ブロックされているシリアルポートのロックを解除します。 { "ok": true } 戻る。
デバイスの設定
すべての構成エンドポイントは、次のパターンを使用します。 /{device_type}/{id_or_index}/config/{setting}.
セッション関連のエンドポイント(basis、mount、preset)には、さらにクエリパラメータが必要です ?session=<expr>.
利き手(Inverse3 のみ)
| 方法 | Pfad | 本文 | 回答 |
|---|---|---|---|
| 取得 | /{device_type}/{id}/config/handedness | -- | "left" oder "right" |
| 投稿 | /{device_type}/{id}/config/handedness | "left" oder "right" | 返される値 |
| 削除 | /{device_type}/{id}/config/handedness | -- | "right" (標準) |
トルクのスケーリング(Inverse3 のみ)
| 方法 | Pfad | 本文 | 回答 |
|---|---|---|---|
| 取得 | /{device_type}/{id}/config/torque_scaling | -- | { "enabled": bool } |
| 投稿 | /{device_type}/{id}/config/torque_scaling | { "enabled": bool } | 返される値 |
| 削除 | /{device_type}/{id}/config/torque_scaling | -- | { "enabled": false } |
重力補正(Inverse3 のみ)
| 方法 | Pfad | 本文 | 回答 |
|---|---|---|---|
| 取得 | /{device_type}/{id}/config/gravity_compensation | -- | { "enabled": bool, "scaling_factor": float } |
| 投稿 | /{device_type}/{id}/config/gravity_compensation | { "enabled": bool, "scaling_factor": float } | 返される値 |
| 削除 | /{device_type}/{id}/config/gravity_compensation | -- | { "enabled": true, "scaling_factor": 1.0 } |
基準(すべてのデバイス、セッション単位)
| 方法 | Pfad | 本文 | 回答 |
|---|---|---|---|
| 取得 | /{device_type}/{id}/config/basis?session= | -- | { "permutation": "XYZ" } |
| 投稿 | /{device_type}/{id}/config/basis?session= | { "permutation": "ZXY" } | 返される値 |
| 削除 | /{device_type}/{id}/config/basis?session= | -- | { "permutation": "XYZ" } |
マウント(すべてのデバイス、セッション単位)
| 方法 | Pfad | 本文 | 回答 |
|---|---|---|---|
| 取得 | /{device_type}/{id}/config/mount?session= | -- | { "transform": {...} } |
| 投稿 | /{device_type}/{id}/config/mount?session= | { "transform": {...} } | 返される値 |
| 削除 | /{device_type}/{id}/config/mount?session= | -- | アイデンティティの変容 |
変換の構造(mount および 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 }
}
}
プリセット(すべてのデバイス、セッション単位)
| 方法 | Pfad | 本文 | 回答 |
|---|---|---|---|
| 取得 | /{device_type}/{id}/config/preset?session= | -- | { "preset": "arm_front_centered" } |
| 投稿 | /{device_type}/{id}/config/preset?session= | { "preset": "arm_front_centered" } | 返される値 |
| 削除 | /{device_type}/{id}/config/preset?session= | -- | { "preset": "device_defaults" } |
利用可能な値: device_defaults, arm_front, arm_front_centered, led_front, led_front_centered, custom.
デバイスフィルター(Inverse3 のみ、セッション単位)
フィルタのエンドポイントを使用する /{device_type}/{id}/config/filters/{filter}?session=<expr>.
減衰
均一な減衰と方向依存の減衰の両方を制御します。POST-Body には、少なくとも 1 つのフィールドが存在する必要があります。
| 方法 | Pfad | 本文 | 回答 |
|---|---|---|---|
| 取得 | /{device_type}/{id}/config/filters/damping?session= | -- | { "scalar": float, "vector": { "x": f, "y": f, "z": f } } |
| 投稿 | /{device_type}/{id}/config/filters/damping?session= | { "scalar": float } oder { "vector": {...} } あるいはその両方 | 戻り値 |
| 削除 | /{device_type}/{id}/config/filters/damping?session= | -- | 両方をゼロにリセット |
フォース・ゲート
| 方法 | Pfad | 本文 | 回答 |
|---|---|---|---|
| 取得 | /{device_type}/{id}/config/filters/force_gate?session= | -- | { "gain": float } |
| 投稿 | /{device_type}/{id}/config/filters/force_gate?session= | { "gain": float } | 返される値 |
| 削除 | /{device_type}/{id}/config/filters/force_gate?session= | -- | 標準設定による利点 |
機器の状態
変換(すべてのデバイス、セッション単位)
ワークスペースの変換(デバイス領域からアプリケーション領域へ)。
| 方法 | Pfad | 本文 | 回答 |
|---|---|---|---|
| 取得 | /{device_type}/{id}/state/transform?session= | -- | { "transform": {...} } |
| 投稿 | /{device_type}/{id}/state/transform?session= | { "transform": {...} } | 返される値 |
| 削除 | /{device_type}/{id}/state/transform?session= | -- | アイデンティティの変容 |
設定を保存する
Inverse3 搭載デバイスでのみ動作します。警告:1台のデバイスにつき書き込み回数は限られているため、設定の保存は頻繁に行わないでください (EEPROMへの書き込み回数は約10,000回まで)。
方法: POST
URL: http://localhost:10001/save_configuration
本文の例:
{
"device_id": "049D"
}
回答例:
{
"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} (単発利用)
個々のキーに対して新しい値を適用します。
推奨されるボディ形式:生のJSON値、またはオブジェクトに格納された値のいずれか(可読性を高めるため、後者が推奨されます)。
{
"value": 5
}
設定のリセット
削除 /settings/{key}
キーをデフォルト値にリセットします。
これは「標準値にリセットする」に相当します。
入力に関する注意事項
このサービスは type_hint 自動的に終了します。 GENERIC 複雑な型の代替手段として使用されます。
サポートされているヒント:
BOOLINTFLOATSTRINGVEC2VEC3VEC4TRANSFORMARR_INTARR_FLOATARR_STRINGGENERIC
旧式のレガシーエンドポイント
いくつか POST-エンドポイントは引き続き受け入れられますが、非推奨の警告が表示され、
今後 4.0 削除されました。詳しくは 3.5 への移行ガイド
旧ルートから代替ルートへの完全な対応表については。