Skip to content

[1.7] Backport OVXR 0.2 support and active eye render-product paths (#1554) - #1557

Merged
hougantc-nvda merged 9 commits into
release/1.7.xfrom
hougantc/ovxr-0.2-1.7
Nov 19, 2026
Merged

hougantc-nvda merged 9 commits into
release/1.7.xfrom
hougantc/ovxr-0.2-1.7

Conversation

@hougantc-nvda

Copy link
Copy Markdown
Contributor

Description

Backport of #1554 to release/1.7.x: upgrade the Isaac Capture teleoperation extra to OVXR 0.2.0.1794933073, which uses OVRTX 0.7.0.1794596436 and OVStage 0.4.0.1794520352, and expose the stereo eye paths through the read-only OvxrSession.eye_render_product_paths property. OVUI stays at 0.3.0.

The nine commits of #1554 are cherry-picked onto release/1.7.x without conflicts. Of the files that PR changes, only pyproject.toml differs between the two branches, and only in lines the PR does not touch. #1554 is approved but not merged yet; this PR should merge after it.

Why 1.7

1.7 is the first public release that ships the OVXR integration; 1.6 has no ovxr extra. Without this backport, 1.7 publishes an integration pinned to OVXR 0.1 that 1.8 replaces one release later.

Breaking change

The ovxr extra now requires OVRTX 0.7 and OVStage 0.4. An application on OVRTX 0.6 can no longer resolve isaaccapture[ovxr] from 1.7, and no public release would support OVRTX 0.6 through that extra. Installs that do not use the ovxr extra are unaffected. The guide's "Upgrading from OVXR 0.1" section covers the migration.

Type of change

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Documentation update

Testing

  • Linux, Python 3.12, with the released OVXR 0.2, OVRTX 0.7 and OVStage 0.4 packages installed: 237 of the 238 tests in tests/python/core/ovxr_session_manager pass on this branch in a checkout without built native modules. The remaining test imports the full package in a subprocess and needs those modules; CI runs it against a build.
  • The full pre-commit suite passed with the CI skip setting.
  • Not run on this branch: the Sphinx docs build, and live headset rendering or the desktop mirror on a GPU. The live end-to-end check reported on Support OVXR 0.2 and expose active stereo render-product paths #1554 used the main-based wheel.

Checklist

  • Read the contribution guidelines.
  • Ran the linter and formatter.
  • Updated documentation and added regression tests.
  • Signed off the commits per the DCO.

🤖 Generated with Claude Code

hougantc-nvda and others added 9 commits November 19, 2026 18:26
Upgrade the OVXR extra and adapt camera output mapping to the typed OVRTX 0.7 handles while preserving numeric IDs for frame consumers. Honor per-output readiness and release detached frame plans during shutdown.

Cover the provider contracts in the session tests and document the dependency and API changes for downstream integrations.

Signed-off-by: hougantc <hougantc@nvidia.com>
Copy the ordered eye paths while the bound frame plan is valid so applications and the desktop mirror can select the actual eye images. Preserve auxiliary camera selection and make the pair available without a mirror. Cover readiness, provider-chosen and explicit paths, frame storage reuse, and shutdown.

Signed-off-by: hougantc <hougantc@nvidia.com>
Signed-off-by: hougantc <hougantc@nvidia.com>
Release a detached frame plan exactly once after context destruction, so a
failed release cannot leave a plan that a later close() would cancel on a
missing context. Record that failure even when no earlier error exists.

Move eye-path capture into a helper that warns when the bound pair differs
from the configured render products, and expose the pump's pair through a
read-only property.

Pin the completed-status constant and the null-handle check to the OVRTX
bindings in tests, and document the mirror menu and eye-path lifetime.

Signed-off-by: Hougant Chen <hougantc@nvidia.com>
Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Check that the wheel extra, the source-tree extra and the installation guide
name the same OVXR release, and that the guide names the OVRTX and OVStage
versions that release requires.

Name the LdrColor event status when a produced frame has no completed color
output, so a failed output is distinguishable from a missing one.

Read the mirror's product menu in tests through the view handed to its
worker rather than through the consumer's private mailbox.

Signed-off-by: Hougant Chen <hougantc@nvidia.com>
Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
The wheel reads each extra from a requirements file while the source tree
lists them in pyproject.toml. Compare the base dependencies and every extra,
not only ovxr, and check that the guide names the pinned OVUI.

Signed-off-by: Hougant Chen <hougantc@nvidia.com>
Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Read the eye pair from every bound plan instead of caching the first one, and
log a plan without both eyes once rather than ending the session for an
informational accessor.

Validate the mirror's camera products at construction. A clash with the eye
paths, known only at the first frame, is reported once instead of raising on
every frame.

Name OVRTX's error message, or a missing output handle, when a produced frame
has no usable color output.

Signed-off-by: Hougant Chen <hougantc@nvidia.com>
Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
A later incomplete plan kept reporting the previous frame's pair through
the session property and FrameOutputs. Reset it so consumers never see a
stale pair for the current frame.

Signed-off-by: Hougant Chen <hougantc@nvidia.com>
Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Address review feedback on the OVXR 0.2 upgrade.

The readiness wait still uses only the per-output event when OVRTX
supplies one. A CUDA output without an event is outside the OVRTX 0.7
contract, so drain the producer stream when there is one, and report
once when there is neither instead of reading silently.

A bound plan without both eye products is an expected condition:
return None and log one plain warning instead of raising and catching.

Signed-off-by: Hougant Chen <hougantc@nvidia.com>
Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 19, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

@github-actions

Copy link
Copy Markdown
Contributor

✅ Preview deployed: https://NVIDIA.github.io/IsaacCapture/preview/pr-1557/

Built from commit 31b3ae3. It may take a minute for the updated preview to appear.

@hougantc-nvda
hougantc-nvda merged commit 9dc438c into release/1.7.x Nov 19, 2026
38 checks passed
@hougantc-nvda
hougantc-nvda deleted the hougantc/ovxr-0.2-1.7 branch November 19, 2026 19:31
github-actions Bot added a commit that referenced this pull request Nov 19, 2026

This branch was successfully deployed

1 active deployment
dev — 31b3ae34 Deployed Nov 19, 2026 by hougantc-nvda via publish-wheel #7109
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants