迁移到 3.5
本页是 Inverse Service 3.5 的综合升级指南。它涵盖了该服务中仍保留的所有已弃用项:计划在 4.0 已从中移除的旧版本 3.0 传输格式、已弃用的 HTTP 端点以及已弃用的会话通道模拟命令。
此处列出的所有已弃用项在传输层仍会出于向后兼容性而被接受。升级不会导致任何故障,请根据您的实际情况安排迁移。
3.0 与 3.x API 版本
该服务同时提供两种并行的 JSON 格式:端口 10000 旧版 3.0 格式以及端口 10001 当前的 3.x 格式。这两种格式都将保留,以确保向后兼容,3.0 升级后,该集成将无需任何修改即可继续运行。
注意
3.0 API 版本支持将于 4.0 已停止提供。
-
3.0应用程序接口- 完整文档请参阅
3.0.x文档页面。 HTTP位于 http://localhost:10000/3.0/。Websockets位于端口10000。
- 完整文档请参阅
-
3.x应用程序接口- 完整文档请参阅
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
事件,其中同时包含旧路由及其替代路由。
已弃用的会话通道命令
以下两个会话级模拟命令已被废弃,并将在未来的重大版本中移除。这些命令在传输层仍会被接受;新开发的集成应改用“替代”列中列出的命令。 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)需按设备逐一应用,而非作为会话级全局开关。完整的预设名称列表请参阅仿真参考中的 “配置”一章。
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。