Deprecation Note

The service currently supports two different JSON formats: 3.0 and 3.x. Both versions are available concurrently, ensuring backward compatibility. If you are using the 3.0 format in your simulations, no changes are required—it will continue to work as before. However, you are encouraged to update to the 3.x version to take advantage of its enhancements and improved performance for game engine integration.

warning

3.0 API version support will be dropped for 4.0

• 3.0 Version API

  • Fully documented in the 3.0.x documentation pages.
  • HTTP accessible by default on ****http://localhost:10000/3.0/..
  • Websockets accessible by default on port 10000.

• 3.x Version API

  • Fully documented in the 3.x documentation pages.
  • HTTP accessible by default on http://localhost:10001/.
  • Websockets accessible by default on port 10001.
  • Offers improvements in functionality and faster integration with game engines.

Feel free to upgrade to the latest format at your convenience to leverage its benefits without any disruption to your existing workflows.

Simulation-channel command replacements (3.x)

The two session-level commands below are deprecated and will be removed in a future major version. They are still accepted on the wire for backward compatibility, but new integrations should use the configure entries listed in the replacement column.

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" } } } ] }

Value mapping:

Old coordinate_origin	New preset
device_base	arm_front (or defaults)
workspace_center	arm_front_centered

Presets are applied per-device via inverse3[*].configure.preset (or configure.preset on verse grip / wireless verse grip device entries), not as a session-wide switch. See the Configure section in the simulation reference for the full list of preset names.

session.set_basis → session.configure.basis

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

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

Axis-sign convention changed

The axis-sign interpretation differs between the two commands. A permutation that produced the correct mapping under session.set_basis can produce an inverted transformation under session.configure.basis — you may need to negate the sign on one or more axes when migrating.

Example: a session that ran correctly with session.set_basis + "permutation": "X-ZY" will typically need "permutation": "XZ-Y" under session.configure.basis. Always re-verify the resulting transform before shipping a migration.