Updates the teleop_se3 and record_demos scripts with more helpful description for teleop_device parameter #3642
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…arameter description for teleop_device
rwiltz
requested review from
Mayankm96,
jtigue-bdai and
ooctipus
as code owners
Mayankm96
reviewed
Oct 10, 2025
| parser.add_argument( | ||
| "--teleop_device", | ||
| type=str, | ||
| default="keyboard", |
Contributor
There was a problem hiding this comment.
This always overrides to keyboard right now. Is that intentional?
kellyguo11
approved these changes
Oct 13, 2025
| help="Device for interacting with environment. Examples: keyboard, spacemouse, gamepad, handtracking, manusvive", | ||
| help=( | ||
| "Teleop device. Set here (legacy) or via the environment config. If using the environment config, pass the" | ||
| " device key/name defined under 'teleop_devices' (it can be a custom name, not necessarily 'handtracking')." |
Contributor
There was a problem hiding this comment.
Where is teleop_devices defined?
Contributor
Author
There was a problem hiding this comment.
In the environment config
| help=( | ||
| "Teleop device. Set here (legacy) or via the environment config. If using the environment config, pass the" | ||
| " device key/name defined under 'teleop_devices' (it can be a custom name, not necessarily 'handtracking')." | ||
| " Built-ins: keyboard, spacemouse, gamepad. Not all tasks support all built-ins." |
Contributor
There was a problem hiding this comment.
Just curious, why handtracking is not one of the built-ins
Contributor
Author
There was a problem hiding this comment.
It;s robot specific and requires the retargeters to be configured.
tifchen-nvda
approved these changes
Oct 14, 2025
hougantc-nvda
pushed a commit
to hougantc-nvda/IsaacLab
that referenced
this pull request
Nov 10, 2025
…cription for teleop_device parameter (isaac-sim#3642) # Description Updates the teleop_se3 and record_demos scripts with more helpful description for teleop_device parameter. This now mentions how the teleop device is defined per task in the env config, which devices are "built-in" to the scripts, and that not all tasks will support every teleop device. <!-- Thank you for your interest in sending a pull request. Please make sure to check the contribution guidelines. Link: https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html 💡 Please try to keep PRs small and focused. Large PRs are harder to review and merge. --> Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. Fixes # (issue) <!-- As a practice, it is recommended to open an issue to have discussions on the proposed pull request. This makes it easier for the community to keep track of what is being developed or added, and if a given feature is demanded by more than one party. --> ## Type of change <!-- As you go through the list, delete the ones that are not applicable. --> - Documentation update ## Screenshots Please attach before and after screenshots of the change if applicable. <!-- Example: | Before | After | | ------ | ----- | | _gif/png before_ | _gif/png after_ | To upload images to a PR -- simply drag and drop an image while in edit mode and it should upload the image directly. You can then paste that source into the above before/after sections. --> ## Checklist - [x] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [x] I have added my name to the `CONTRIBUTORS.md` or my name already exists there <!-- As you go through the checklist above, you can mark something as done by putting an x character in it For example, - [x] I have done this task - [ ] I have not done this task --> Co-authored-by: Kelly Guo <kellyg@nvidia.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates the teleop_se3 and record_demos scripts with more helpful description for teleop_device parameter. This now mentions how the teleop device is defined per task in the env config, which devices are "built-in" to the scripts, and that not all tasks will support every teleop device.
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
List any dependencies that are required for this change.
Fixes # (issue)
Type of change
Screenshots
Please attach before and after screenshots of the change if applicable.
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there