What the ZED SDK does
The ZED SDK is the software Stereolabs provides to run its ZED cameras. A stereo camera captures two images from slightly different positions, and the SDK compares them to work out how far away each pixel is. On top of that depth data it adds motion tracking, 3D mapping and AI detection, so an application receives finished spatial information rather than raw pictures. Our explainer on how a stereo camera measures depth covers the optics behind it.
The SDK is a library plus a set of tools. Developers call it from C++, Python, C# or C. The Python package is called pyzed and is installed by a script shipped with the SDK. The tools include ZED Explorer for checking that a camera streams, ZED Depth Viewer for inspecting depth and point clouds, ZED Sensor Viewer for the IMU and other sensors, and calibration and diagnostic utilities. Its tutorials and code samples are on GitHub under the MIT licence.
Every ZED camera needs it. That includes the USB models such as the ZED 2i and ZED Mini, the GMSL2 ZED X family and the ZED X One cameras, which can be used singly or paired as a custom stereo rig.
Modules in the ZED SDK
The SDK is organised into modules, and an application turns on only the ones it needs, because each one adds GPU load.
-
//
Depth sensing. Produces a depth map, a disparity map and a coloured point cloud for every frame, with confidence values per pixel.
-
//
Positional tracking. Estimates the camera’s position and orientation from the images and the built-in IMU (visual-inertial odometry), so a robot knows where it is and how it has moved.
-
//
Spatial mapping and plane detection. Builds a 3D mesh or fused point cloud of the surroundings and finds floors, walls and tables.
-
//
Object detection and body tracking. Detects people and objects in 3D using built-in models, or a custom detector you supply, and tracks human skeletons.
-
//
Global localisation. Fuses GNSS data with visual tracking so outdoor machines can work in world coordinates.
-
//
Recording, streaming and fusion. Records SVO files for later replay, streams cameras over a local network and combines several cameras into one view of a scene.
ZED SDK depth modes
Depth is the most demanding module, and the depth mode sets the balance between accuracy and frame rate. Since version 5.0 the SDK uses neural network depth by default. The older computer vision modes (PERFORMANCE, QUALITY and ULTRA) are deprecated but still available in the API.
| Depth mode | Best for | Introduced | On smaller Jetson modules |
|---|---|---|---|
| NEURAL_LIGHT | Highest frame rate, several cameras or limited GPU | SDK 5.0 | The usual choice on an Orin Nano 4GB |
| NEURAL | General robotics, navigation and AR | SDK 3.7 | Around 30 fps with one camera on Orin Nano 8GB or Orin NX 8GB |
| NEURAL_PLUS | Inspection, 3D reconstruction, small or distant objects | SDK 4.1 | Below 10 fps on the same modules |
| CUSTOM (experimental) | Feeding in depth from your own stereo network | SDK 5.4 | Depends on your model |
| NONE | Recording or image capture without depth | All versions | Lowest load |
Stereolabs’ figures show a Jetson AGX Orin holding about 30 fps with four cameras in NEURAL, so the module choice sets how many cameras a system can run. An SVO recording stores the raw images, not depth, so footage recorded with depth turned off can be replayed later in any depth mode. Version 5.5 adds an INT8 option for NEURAL depth, which trades a little accuracy for speed.
Hardware and software requirements
-
//
PC. Windows 10 or 11, or Ubuntu 22.04 or later, with an NVIDIA GPU of compute capability 7.5 (Turing) or newer. Stereolabs suggests 16 GB of RAM and an RTX GPU with more than 6 GB of memory.
-
//
Embedded. NVIDIA Jetson Orin or Thor running Jetson Linux, with at least 4 GB of memory. Each SDK installer is built for a specific JetPack and L4T release.
-
//
Camera connection. USB 3.0 for the ZED 2i and ZED Mini (USB 2.0 limits them to VGA at 30 fps). GMSL2 cameras such as the ZED X need a GMSL2 capture card or a carrier board with a deserialiser, plus the ZED X driver.
-
//
Minimum version per camera. Newer cameras need newer SDKs: the ZED X needs version 4.0 or later, the ZED X Nano 5.3 and the ZED X One Core 5.5.
Installing the SDK and connecting it to your software
Stereolabs offers a separate installer for each platform: an executable for Windows and a .run file for Ubuntu and for each supported JetPack release. The installer must match the CUDA version on a PC, or the JetPack version on a Jetson. Our guide to JetPack 6 and its software stack explains those versions. After installing, open ZED Explorer and ZED Depth Viewer first: if the camera streams and shows depth there, any later fault lies in your own code, not the hardware.
From there the SDK connects to most robotics and vision tools. Stereolabs maintains integrations for ROS 2, NVIDIA Isaac ROS and Isaac Sim, Docker, GStreamer, OpenCV, PyTorch, YOLO detectors and the Unity and Unreal game engines. For robots, the ROS 2 node is the usual route, and our white paper on the ZED ROS2 wrapper on NVIDIA Jetson walks through building that stack in the right order.
Using the ZED SDK in industrial systems
Stereo depth with built-in tracking suits machines that move or handle objects: autonomous mobile robots, forklifts, robotic arms, agricultural vehicles and inspection systems. Here the main work is version control and GPU budget.
Fix the JetPack, ZED X driver and ZED SDK versions for each product build, because a mismatch is the most common cause of a camera that will not open. Check the GPU load of the depth mode and modules you need at your real camera count before choosing the Jetson module. And record SVO files during commissioning, so problems can be replayed off the machine.
Our stereo cameras include the USB ZED 2i and ZED Mini and the GMSL2 ZED X family. We also list Stereolabs GMSL frame grabbers for Jetson Orin, and the ZED Box Mini sits among our rugged Jetson computers.
Quick answers on the ZED SDK
ZED SDK: common questions
What is pyzed?
The ZED SDK’s Python API. It is installed with the get_python_api.py script that ships with the SDK, and it gives Python code the same camera, depth and tracking functions as C++.
Does the ZED SDK need an NVIDIA GPU?
Yes. Depth and AI modules run through CUDA, so a PC needs an NVIDIA GPU of the Turing generation or newer, and embedded systems use a Jetson Orin or Thor module.
How do you install the ZED SDK?
Download the installer that matches your platform. Choose the build for your Windows or Ubuntu CUDA version, or for your exact JetPack release, run it, then test the camera in ZED Explorer.
Which ZED SDK version do I need?
Usually the latest. Each camera has a minimum version, and the newest release supports every current ZED camera. On a fielded product, pin the version you validated.
Can the ZED SDK use my own depth model?
Experimentally, yes. Since version 5.4 the CUSTOM depth mode accepts depth or disparity from your own network and runs mapping and detection on it.
We supply ZED cameras with the Jetson computer they run on, and as standard we install JetPack, the ZED X driver and a matched ZED SDK version before the system ships.