Skip to content

Commit b8a1f9d

Browse files
committed
docs(moveit): document macOS auto-headless behavior
Mirror the turtlebot3 README updates for the MoveIt demo: the runner now falls back to headless when no display is present, so the docs no longer tell macOS users to set up X11/XQuartz.
1 parent bbf4eb9 commit b8a1f9d

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Panda robot arm demo with pick-and-place manipulation:
110110
```bash
111111
cd demos/moveit_pick_place
112112
./run-demo.sh
113-
# RViz will open with Panda arm (or use --headless), Web UI at http://localhost:3000
113+
# RViz will open with Panda arm (on macOS / headless hosts it runs headless automatically), Web UI at http://localhost:3000
114114
# Move the arm: ./move-arm.sh demo
115115
# Inject faults: ./inject-planning-failure.sh
116116
# Check faults: ./check-faults.sh

demos/moveit_pick_place/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This demo demonstrates:
2424

2525
- Docker and docker-compose
2626
- `curl` and `jq` installed on the host (required for host-side scripts)
27-
- X11 display server (for Gazebo GUI) or `--headless` mode
27+
- (Optional) X11 display server for the RViz/Gazebo GUI on Linux with a desktop. Not needed on macOS or headless hosts - the demo falls back to headless automatically.
2828
- (Optional) NVIDIA GPU + [nvidia-container-toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html) - recommended for smooth Gazebo rendering
2929
- ~7 GB disk space for Docker image
3030

@@ -46,6 +46,8 @@ That's it! The script will:
4646
**REST API:** http://localhost:8080/api/v1/
4747
**Web UI:** http://localhost:3000/
4848

49+
**On macOS:** Docker Desktop has no X server, so `run-demo.sh` detects this and starts **headless automatically** - no XQuartz needed. The RViz/Gazebo window is not shown, but MoveIt planning, ros2_medkit, the REST API (`http://localhost:8080`) and the Web UI (`http://localhost:3000`) all run. Drive the demo from the Web UI and the helper scripts (`./move-arm.sh`, `./inject-planning-failure.sh`). The same auto-fallback applies to any host without a `DISPLAY` (for example a headless Linux server).
50+
4951
### 2. Available Options
5052

5153
```bash
@@ -437,7 +439,7 @@ Container scripts are stored under `/var/lib/ros2_medkit/scripts/moveit-planning
437439

438440
| Problem | Cause | Solution |
439441
|---------|-------|----------|
440-
| RViz window doesn't appear | X11 not set up | Run `xhost +local:docker` or use `--headless` |
442+
| RViz window doesn't appear | No X display (e.g. macOS Docker Desktop) | On macOS / headless hosts the demo runs headless automatically; on Linux with a desktop run `xhost +local:docker` |
441443
| "Package not found" error | Build failed | Rebuild with `./run-demo.sh --no-cache` |
442444
| No faults appearing | Monitor not connected | Check `ros2 node list` includes `manipulation_monitor` |
443445
| Docker build fails | Apt package missing | Check if MoveIt 2 Jazzy packages are available |

0 commit comments

Comments
 (0)