Robots · Simulation · marine robotics

Virtual RobotX (VRX) simulation environment

Virtual RobotX (VRX) simulation environment, adapted from osrf/vrx. It reads read_sim_clock and read_task_info; runs publish_left_thrust, publish_right_thrust, publish_left_thrust_position and publish_right_thrust_position. publish_left_thrust: publish one Float64 command on /wamv/thrusters/left/thrust; the receipt is transmission evidence only, not motion, thrust attainment or stopping. A simulator: the market serves it with a stand-in that needs no simulator install.

simulatedRisk R2Apache-2.0contract_checkedserved on the fake backend
openai4s lab add robots/osrf__vrx

Install

Three ways to run this device. Each one serves its fake backend: no instrument, no simulator install and no upstream checkout.

OpenAI4S (one command)

shell
openai4s lab add robots/osrf__vrx

Installs the device into the OpenAI4S Lab on its fake backend and starts it. First time? See setup below.

Or, in the workbench, open the Lab tab → Market → Install.

Standalone MHS endpoint

shell
git clone --depth 1 https://github.com/PKU-YuanGroup/OpenMHS.git && cd OpenMHS
PYTHONPATH=MHS/sdk/src python3 -m mhs serve robots/osrf__vrx --port 7400
# in a second terminal, from the same directory:
PYTHONPATH=MHS/sdk/src python3 -m mhs describe --endpoint http://127.0.0.1:7400

Serves the device as an MHS endpoint on port 7400 from an OpenMHS clone (Python 3.10 or later, standard library only); describe prints what it offers.

Any MCP host (Claude Desktop, Cursor, …)

mcp configuration
{
  "mcpServers": {
    "vrx": {
      "command": "python3",
      "args": [
        "-m",
        "mhs",
        "serve",
        "robots/osrf__vrx",
        "--mcp"
      ],
      "env": {
        "PYTHONPATH": "/path/to/OpenMHS/MHS/sdk/src"
      }
    }
  }
}

Add this server to the host's MCP configuration and replace /path/to/OpenMHS with the path of your OpenMHS clone. The host starts the server and talks to it on stdin and stdout.

What it does

Measures

  • read_sim_clock
  • read_task_info

Adjusts

Nothing declared.

Actions

publish_left_thrust
Publish one Float64 command on /wamv/thrusters/left/thrust; the receipt is transmission evidence only, not motion, thrust attainment or stopping.
publish_right_thrust
Publish one Float64 command on /wamv/thrusters/right/thrust; the receipt is transmission evidence only, not motion, thrust attainment or stopping.
publish_left_thrust_position
Publish one Float64 command on /wamv/thrusters/left/pos; the receipt is transmission evidence only, not joint motion or stopping.
publish_right_thrust_position
Publish one Float64 command on /wamv/thrusters/right/pos; the receipt is transmission evidence only, not joint motion or stopping.

Names as the driver declares them. Units, limits and the safety declaration are in the package's REFERENCE.md.

First-time setup

The OpenAI4S workbench with the OpenMHS lab, from a source checkout:

shell
# OpenAI4S workbench with the OpenMHS lab (source checkout)
git clone --recursive https://github.com/PKU-YuanGroup/OpenAI4S.git
cd OpenAI4S && ./setup.sh && source .venv/bin/activate
openai4s lab add robots/osrf__vrx
openai4s serve        # open the Lab tab

The standalone endpoint and the MCP server need only an OpenMHS clone and Python 3.10 or later. More in the market's getting-started guide and on the OpenAI4S host page.

Source and evidence

Upstream
osrf/vrx
Pinned commit
7609d1bd90ce
Licence
Apache-2.0
Stars
751
Evidence
contract_checked on the fake backend
Backends
fake

The driver package MHS/drivers/robots/osrf__vrx wraps the upstream code at the pinned commit. Its REFERENCE.md documents the full contract: every value, action, unit, limit and the safety declaration.