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} et {id_or_index} 標的となるデバイスを特定します。
| 経路セグメントの例 | 意味 |
|---|---|
inverse3/0 | インデックス順(0を基点)のInverse3 |
inverse3/A14 | Inverse3 デバイスの識別子は A14 |
inverse3/* | Inverse3 のすべてのデバイス(ワイルドカード) |
verse_grip/0 | 人差し指に合わせた「プレミア・バース・グリップ」 |
wireless_verse_grip/* | すべてのワイヤレス・バース・グリップ |
*inverse/* | Inverse シリーズの全機種(Inverse3 、Inverse3x、Minverse ) |
*verse_grip/* | Verse Grip シリーズ全機種(Verse Grip、Wireless VG) |
ワイルドカードに関する規則:
GET曖昧なセレクタやワイルドカードを含むセレクタを拒否する(返り値は400).POSTetDELETEワイルドカードを受け付けます:この操作は、条件に一致するすべてのデバイスに対して適用されます。
セッションセレクター
セッションスコープ内の終端ポイント(basis、mount、preset、transform、filters)には、リクエストパラメータが必要です。 ?session=<expr> セッションを識別するために。
| 表現 | 意味 |
|---|---|
| (省略) | すべてのセッション(DELETEのみ) |
#123 ou 123 | セッションIDが123であるセッション |
:-1 | インデックスに基づく最後のセッション |
:0 | 索引に基づく第1セッション |
例: 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 et status.
また、以下を送信することもできます ?session=<expr> 特定のセッションの観点に基づいてスナップショットをフィルタリングするため(そのセッションのベース、マウント、および変換を、返される値に適用します)。
回答例:
{
"inverse3": [
{
"device_id": "04BA",
"config": { "...": "..." },
"state": { "...": "..." },
"status": { "...": "..." }
}
]
}
セッション
| メソッド | シェマン | 説明 |
|---|---|---|
| 取得 | /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 のみ)
| メソッド | シェマン | 軍団 | 回答 |
|---|---|---|---|
| 取得 | /{device_type}/{id}/config/handedness | -- | "left" ou "right" |
| 投稿 | /{device_type}/{id}/config/handedness | "left" ou "right" | 戻り値 |
| 削除 | /{device_type}/{id}/config/handedness | -- | "right" (デフォルト) |
トルクのスケーリング(Inverse3 のみ)
| メソッド | シェマン | 軍団 | 回答 |
|---|---|---|---|
| 取得 | /{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 のみ)
| メソッド | シェマン | 軍団 | 回答 |
|---|---|---|---|
| 取得 | /{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 } |
基本(すべての端末、セッション範囲内)
| メソッド | シェマン | 軍団 | 回答 |
|---|---|---|---|
| 取得 | /{device_type}/{id}/config/basis?session= | -- | { "permutation": "XYZ" } |
| 投稿 | /{device_type}/{id}/config/basis?session= | { "permutation": "ZXY" } | 戻り値 |
| 削除 | /{device_type}/{id}/config/basis?session= | -- | { "permutation": "XYZ" } |
マウント(すべてのデバイス、セッションの範囲内)
| メソッド | シェマン | 軍団 | 回答 |
|---|---|---|---|
| 取得 | /{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 }
}
}
プリセット(すべてのデバイス、セッション内に限定)
| メソッド | シェマン | 軍団 | 回答 |
|---|---|---|---|
| 取得 | /{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リクエストの本文には、少なくとも1つのフィールドが含まれている必要があります。
| メソッド | シェマン | 軍団 | 回答 |
|---|---|---|---|
| 取得 | /{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 } ou { "vector": {...} } どちらか、あるいは両方 | 戻り値 |
| 削除 | /{device_type}/{id}/config/filters/damping?session= | -- | 2つのリセット |
強行突破
| メソッド | シェマン | 軍団 | 回答 |
|---|---|---|---|
| 取得 | /{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= | -- | 設定で定義されたデフォルトのゲイン |
デバイスの状態
変換(すべてのデバイス、セッション内に限定)
ワークスペースの変換(デバイスの空間からアプリケーションの空間へ)。
| メソッド | シェマン | 軍団 | 回答 |
|---|---|---|---|
| 取得 | /{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} (アプリケーション固有)
1つのキーに新しい値を割り当てます。
推奨されるボディ形式:生のJSON値、またはラッパー化された値(可読性を高めるため、後者が推奨されます)。
{
"value": 5
}
設定のリセット
削除 /settings/{key}
キーをデフォルト値にリセットします。
これは「デフォルト値にリセットする」ことと同じです。
タイプ別適応症
このサービスは自動的に差し引かれます type_hint. GENERIC 複雑な型に対する代替手段として使用されます。
適用対象となる適応症:
BOOLINTFLOATSTRINGVEC2VEC3VEC4TRANSFORMARR_INTARR_FLOATARR_STRINGGENERIC
非推奨となったレガシーエンドポイント
複数の終端点 POST これらは引き続き受け入れられますが、非推奨の警告が表示され、
次のバージョンでは削除される予定です。 4.0. こちらをご覧ください 移行ガイド 3.5
非推奨パスと代替パスの対応関係の完全な一覧については、以下をご覧ください。