3.5 への移行

このページは、Inverse Service 3.5 の統合アップグレードガイドです。サービスに残っているすべての非推奨項目について説明します。具体的には、4.0 削除が予定されているレガシーな 3.0 ワイヤーフォーマット、非推奨の HTTP エンドポイント、および非推奨のセッションチャネルシミュレーションコマンドです。

ここに記載されているすべての非推奨項目は、下位互換性を確保するため、引き続きワイヤ上で受け付けられます。アップグレードしても問題が生じることはありません。移行は、ご都合の良いタイミングで計画してください。

`3.0` と `3.x` API バージョン

このサービスでは、2つのJSONフォーマットを同時に提供しています。ポート 10000 のレガシーな 3.0 フォーマットとポート 10001 現在の 3.x フォーマットです。どちらも下位互換性を確保するため、引き続き利用可能な状態が維持されます。3.0 の統合は、アップグレード後も変更なしで動作し続けます。

警告

4.0 それでは 3.0 APIバージョンのサポートが終了します。

3.0 API
- 詳細は 3.0.x ドキュメント・ページに記載されています。
- HTTP は http://localhost:10000/3.0/ で利用できます。
- Websockets はポート 10000 で利用できます。
3.x API
- 詳細は 3.x ドキュメント・ページに記載されています。
- HTTP は http://localhost:10001/ で利用できます。
- Websockets はポート 10001 で利用できます。
- 機能が改善され、ゲームエンジンとの統合が高速化されました。

アップグレードは、ご都合の良いタイミングで行ってください。既存のワークフローが中断されることはありません。

非推奨の HTTP エンドポイント

以下のエンドポイントは引き続き受け付けられますが、非推奨である旨の警告が表示されます。4.0 で削除される予定です。代わりに、置き換え先のルートをご利用ください。

推奨されないパス	置換先
`POST /force_scale`	`POST /settings/devices/force_scale`
`POST /gravity_compensation`	`POST /{type}/{id}/config/gravity_compensation`
`POST /torque_scaling`	`POST /{type}/{id}/config/torque_scaling`
`POST /device_handedness`	`POST /{type}/{id}/config/handedness`
`POST /serial_enable`	`POST /settings/system/serial_enable`
`POST /experimental/features/grip_dropped_simulation_stopper`	`POST /settings/features/grip_hook/enabled`
`POST /experimental/features/screensaver_enable`	`POST /settings/features/screensaver/enabled`

各非推奨ルートは、イベントチャネルで http-route-deprecated イベントを発生させます。このイベントには、旧ルートと置き換え先のルートの両方が含まれます。

非推奨のセッションチャネルコマンド

以下の2つのセッションレベルのシミュレーションコマンドは非推奨であり、今後のメジャーバージョンで削除される予定です。ワイヤー上では引き続き受け付けられます。新しい統合では、置換列に記載されている configure エントリをご利用ください。

各非推奨コマンドは、イベントチャネルで command-deprecated イベントを発生させます。

`session.set_coordinate_origin` → `inverse3[*].configure.preset`

// Old — deprecated
{ "session": { "set_coordinate_origin": { "coordinate_origin": "workspace_center" } } }

// New — canonical
{ "inverse3": [ { "device_id": "…", "configure": { "preset": { "preset": "arm_front_centered" } } } ] }

値のマッピング：

旧 `coordinate_origin`	新しいプリセット
`device_base`	`arm_front`（または `defaults`）
`workspace_center`	`arm_front_centered`

プリセットは、セッション全体の切り替えとしてではなく、デバイスごとに適用されます。適用するには inverse3[*].configure.preset（または verse grip / ワイヤレス verse grip デバイスエントリの configure.preset）を使用します。プリセット名の完全な一覧については、シミュレーションリファレンスの「Configure」セクションを参照してください。

`session.set_basis` → `session.configure.basis`

// Old — deprecated
{ "session": { "set_basis": { "basis": { "permutation": "X-ZY" } } } }

// New — canonical
{ "session": { "configure": { "basis": { "permutation": "XZ-Y" } } } }

軸の符号規則が変更されました

参考文献

設定リファレンス
WebSocket プロトコル— 完全なスナップショットとストリーミングフレームのレイアウト。
AsyncAPI リファレンス— すべての v3.1 ペイロードの機械可読なスキーマ。
HTTP API リファレンス— 上記の非推奨エンドポイントの代替先を含む、現在の HTTP ルートの Swagger UI。

3.0 と 3.x API バージョン​

非推奨の HTTP エンドポイント​

非推奨のセッションチャネルコマンド​

session.set_coordinate_origin → inverse3[*].configure.preset​

session.set_basis → session.configure.basis​

参考文献​