バージョン3.5への移行

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

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

`3.0` 大 `3.x` APIのバージョン

このサービスは、2種類のJSON形式を同時に提供しています。ポート 10000のレガシー 3.0 フォーマットとポート 10001現在の 3.x フォーマットです。どちらのフォーマットも下位互換性を確保するため引き続き使用可能であり、 3.0 連動機能は、アップグレード後も変更なく引き続き動作します。

警告

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

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​

参考資料​