https://github.com/zivid/zivid-isaac-sim
Official Zivid extension for NVIDIA Isaac Sim
https://github.com/zivid/zivid-isaac-sim
Last synced: 2 months ago
JSON representation
Official Zivid extension for NVIDIA Isaac Sim
- Host: GitHub
- URL: https://github.com/zivid/zivid-isaac-sim
- Owner: zivid
- Created: 2025-06-26T12:54:19.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-08-12T12:04:23.000Z (8 months ago)
- Last Synced: 2025-08-12T14:23:53.570Z (8 months ago)
- Language: Python
- Size: 15.5 MB
- Stars: 1
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Zivid 3D Cameras Extension for NVIDIA Isaac Sim
This is the official Isaac Sim extension for [Zivid 3D cameras](https://www.zivid.com/).
The extension provides realistic simulations of Zivid 3D cameras with accurate dimensions, masses, and camera intrinsics.
> **Note**
> This extension is experimental. API and GUI are subject to changes.
For more information on how to use the extension, check out our [Knowledge Base article](https://support.zivid.com/en/latest/api-reference/wrappers/isaac-sim.html).
![Zivid Image][header-image]
## Installation
1. Ensure you have a working [NVIDIA Isaac Sim installation]. The minimum version is **5.0.0**.
2. Clone the Zivid Isaac Sim repository:
```sh
git clone https://github.com/zivid/zivid-isaac-sim
```
3. Follow the [official instructions] on how to install and enable extensions
in Isaac Sim.
**NOTE:** To enable the extension directly, pass the following args when launching IsaacSim:
```sh
--ext-folder path/to/source/ --enable isaacsim.zivid
```
## Getting started
### Adding a Camera to Your Scene
There are two ways to add a Zivid camera to your scene:
1. **Using the Create Menu**:
- Navigate to the "Create" menu in the top menu bar.
- Select the option to add a Zivid camera to the scene. You can also add Zivid calibration boards from this menu.
2. **Using the Context Menu**:
- Right-click on a rigid body prim in the scene hierarchy.
- Select the option to add a Zivid Camera.
Note that this option is only available for rigid body prims
with a parent or ancestor that has articulation (typically robots).
### Camera Configuration
When adding a Zivid Camera, a configuration window appears where you can:
- Select the camera model
- Choose a mounting option (or no mount)
- Specify the path to the mount point prim
> **Note**: When using no mount, the camera pose may be off by 90 degrees and require manual adjustment.
### Interacting with Cameras
Once a Zivid camera is present in your scene, a new menu bar option will be available to interact with your camera.
Selecting a camera opens a docked window where you can:
- Change the camera model
- Configure camera settings
- Capture simulated point clouds
## Support
For more information about the Zivid cameras, please visit our [Knowledge Base](https://support.zivid.com/latest).
If you encounter any issues or have questions,
please [open an issue](https://github.com/zivid/zivid-isaac-sim/issues) on our GitHub repository.
## License
Zivid Samples are distributed under the [BSD license](https://github.com/zivid/zivid-halcon-samples/tree/master/LICENSE).
[NVIDIA Isaac Sim installation]: https://docs.isaacsim.omniverse.nvidia.com/4.5.0/installation/index.html
[official instructions]: https://docs.isaacsim.omniverse.nvidia.com/4.5.0/utilities/updating_extensions.html
[header-image]: https://www.zivid.com/hubfs/softwarefiles/images/zivid-generic-github-header.png
## VSCode Setup
To correctly configure the Visual Studio Code Python Language Service, first generate the .vscode/settings.json file by running:
```shell
/path/to/isaacsim/python/exe -m isaacsim --generate-vscode-settings
```
In addition add the following entry to '.vscode/settings.json'
```json
"python.analysis.extraPaths": [
path/to/source/isaacsim.zivid,
...,
]
```