Skip to content

Cherry-pick (#727) to release v0.2.1: Document second-viewport teleop monitoring workflow#730

Open
rwiltz wants to merge 1 commit into
isaac-sim:release/0.2.1from
rwiltz:rwiltz/cp/727/release/0.2.1
Open

Cherry-pick (#727) to release v0.2.1: Document second-viewport teleop monitoring workflow#730
rwiltz wants to merge 1 commit into
isaac-sim:release/0.2.1from
rwiltz:rwiltz/cp/727/release/0.2.1

Conversation

@rwiltz
Copy link
Copy Markdown
Collaborator

@rwiltz rwiltz commented May 27, 2026

Summary

Cherry-pick (#727) to release/0.2.1: docs only

Detailed description

  • Cherry-picks 754c87a (PR Document second-viewport teleop monitoring workflow #727) onto release/0.2.1. Clean cherry-pick, no conflicts.
  • Adds the optional "Step 2b: Monitor Recording with a Second Viewport" workflow to the static apple example (docs/pages/example_workflows/static_apple/step_2_teleoperation.rst) plus two screenshots.
  • Docs only; no code changes. Brings the teleop monitoring guidance into the 0.2.1 release so users on that branch don't silently lose demos to out-of-FOV trajectories.

## Summary
Doc two-person teleop with 2nd viewport

## Detailed description
- Per Edith's feedback, demos where the trajectory drifts outside the
robot's recording-camera FOV silently degrade policy training. A second
operator watching a viewport bound to the recording camera can catch
this live and avoid a re-record.
- Adds a new "Step 2b: Monitor Recording with a Second Viewport
(Optional)" between Steps 2 and 3 in
`docs/pages/example_workflows/static_apple/step_2_teleoperation.rst`,
with two screenshots: enabling Viewport 2 from the **Window** menu, and
pointing it at `RobotHeadCam`.
- Notes that `RobotHeadCam` is only spawned when `--enable_cameras` is
set — present by default in Step 4's `record_demos.py`, absent in the
Step 2 `teleop.py` smoke test — so readers know when the camera will
appear in the selector.
- Docs only; no code changes.

(cherry picked from commit 754c87a)
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 27, 2026

Greptile Summary

Cherry-picks the "Step 2b: Monitor Recording with a Second Viewport" section from PR #727 into the release/0.2.1 branch, adding a purely documentation change to step_2_teleoperation.rst along with two supporting screenshots.

  • Adds an optional two-person monitoring workflow that explains how to open a second Isaac Lab viewport bound to RobotHeadCam so an observer can keep every grasping trajectory inside the recording field of view during demo collection.
  • Includes a .. note:: clarifying that RobotHeadCam only appears when --enable_cameras is passed, keeping users from being confused during the smoke-test teleop.py run which omits that flag.

Confidence Score: 5/5

Docs-only cherry-pick with no code changes; safe to merge.

All three changed files are documentation assets — one RST page and two JPEG screenshots. The RST image paths resolve correctly relative to the file's location, the new section heading style matches existing steps, and the note about --enable_cameras accurately reflects the record_demos.py command already present in Step 4. No logic, config, or runtime behavior is affected.

No files require special attention.

Important Files Changed

Filename Overview
docs/pages/example_workflows/static_apple/step_2_teleoperation.rst Adds Step 2b: Monitor Recording with a Second Viewport (Optional) section with two figures, a numbered how-to list, and a note about the --enable_cameras requirement — RST syntax and image paths are correct.
docs/images/xr_enable_second_viewport.jpg New screenshot showing the Window menu with Viewport 2 toggle highlighted; referenced correctly from the RST.
docs/images/xr_second_viewport_robot_camera.jpg New screenshot showing the dual-viewport layout with the robot head-camera view; referenced correctly from the RST.

Sequence Diagram

sequenceDiagram
    participant T as Teleoperator (Headset)
    participant O as Observer (Host Monitor)
    participant Arena as Arena Application
    participant RD as record_demos.py

    Note over Arena,RD: Step 4 - Recording session starts
    RD->>Arena: launch with --enable_cameras
    Arena->>Arena: spawn RobotHeadCam at /World/envs/env_0/Robot/head_link

    Note over O,Arena: Step 2b - Dual Viewport Setup
    O->>Arena: Window menu toggle Viewport 2
    O->>Arena: select RobotHeadCam in Viewport 2 toolbar

    loop Each demonstration
        T->>Arena: "teleoperate via XR headset (Viewport 1 = stereo view)"
        Arena-->>O: Viewport 2 shows RobotHeadCam FOV (dataset view)
        O->>T: live feedback (hand at edge of frame — move right)
        T->>Arena: corrects trajectory to stay in FOV
        Arena->>RD: write frames to HDF5 (only what RobotHeadCam sees)
    end
Loading

Reviews (1): Last reviewed commit: "Document second-viewport teleop monitori..." | Re-trigger Greptile

@xyao-nv xyao-nv enabled auto-merge (squash) May 27, 2026 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants