Python API Reference¶

Classes:

`ADatatype`
`AprilTag`
`AprilTagConfig`
`AprilTagProperties`
`AprilTags`
`Asset`
`AssetManager`
`BoardConfig`
`Buffer`
`CalibrationHandler`
`CameraBoardSocket`	Members:
`CameraControl`
`CameraExposureOffset`	Members:
`CameraFeatures`
`CameraImageOrientation`	Members:
`CameraInfo`
`CameraModel`	Members:
`CameraProperties`
`CameraSensorConfig`
`CameraSensorType`	Members:
`CastProperties`
`ChipTemperature`
`Clock`
`ColorCameraProperties`
`Colormap`	Members:
`CpuUsage`
`CrashDump`
`DataInputQueue`
`DataOutputQueue`
`DatatypeEnum`	Members:
`DetectionNetworkProperties`
`DetectionNetworkType`	Members:
`DetectionParserOptions`
`DetectionParserProperties`
`Device`
`DeviceBase`
`DeviceBootloader`
`DeviceDesc`
`DeviceInfo`
`EdgeDetectorConfig`
`EdgeDetectorConfigData`
`EdgeDetectorProperties`
`EepromData`
`EncodedFrame`
`Extrinsics`
`FeatureTrackerConfig`
`FeatureTrackerProperties`
`FrameEvent`	Members:
`GlobalProperties`
`IMUData`
`IMUPacket`
`IMUProperties`
`IMUReport`
`IMUReportAccelerometer`
`IMUReportGyroscope`
`IMUReportMagneticField`
`IMUReportRotationVectorWAcc`
`IMUSensor`	Members:
`IMUSensorConfig`
`ImageAlignConfig`
`ImageAlignProperties`
`ImageManipConfig`
`ImgDetection`
`ImgDetections`
`ImgFrame`
`Interpolation`	Members:
`LogLevel`	Members:
`LogMessage`
`MedianFilter`	Members:
`MemoryInfo`
`MessageDemuxProperties`
`MessageGroup`
`MonoCameraProperties`
`NNData`
`NeuralNetworkProperties`
`Node`
`ObjectTrackerProperties`
`OpenVINO`
`Pipeline`
`Point2f`
`Point3f`
`PointCloudConfig`
`PointCloudData`
`PointCloudProperties`
`ProcessorType`	Members:
`ProfilingData`
`Properties`
`RawAprilTagConfig`
`RawBuffer`
`RawCameraControl`
`RawEdgeDetectorConfig`
`RawEncodedFrame`
`RawFeatureTrackerConfig`
`RawIMUData`
`RawImageAlignConfig`
`RawImageManipConfig`
`RawImgDetections`
`RawImgFrame`
`RawMessageGroup`
`RawNNData`
`RawPointCloudConfig`
`RawPointCloudData`
`RawSpatialImgDetections`
`RawStereoDepthConfig`
`RawSystemInformation`
`RawToFConfig`
`RawTrackedFeatures`
`RawTracklets`
`Rect`
`RotatedRect`
`SPIInProperties`
`SPIOutProperties`
`ScriptProperties`
`SerializationType`	Members:
`Size2f`
`SpatialDetectionNetworkProperties`
`SpatialImgDetection`
`SpatialImgDetections`
`SpatialLocationCalculatorAlgorithm`	Members:
`SpatialLocationCalculatorConfig`
`SpatialLocationCalculatorConfigData`
`SpatialLocationCalculatorConfigThresholds`
`SpatialLocationCalculatorData`
`SpatialLocationCalculatorProperties`
`SpatialLocations`
`StereoDepthConfig`
`StereoDepthProperties`
`StereoPair`
`StereoRectification`
`SyncProperties`
`SystemInformation`
`SystemLoggerProperties`
`TensorInfo`
`Timestamp`
`ToFConfig`
`ToFProperties`
`TrackedFeature`
`TrackedFeatures`
`TrackerIdAssignmentPolicy`	Members:
`TrackerType`	Members:
`Tracklet`
`Tracklets`
`UVCProperties`
`UsbSpeed`	Members:
`Version`
`VideoEncoderProperties`
`WarpProperties`
`XLinkConnection`
`XLinkDeviceState`	Members:
`XLinkError_t`	Members:
`XLinkInProperties`
`XLinkOutProperties`
`XLinkPlatform`	Members:
`XLinkProtocol`	Members:
`connectionInterface`	Members:

Exceptions:

`EepromError`
`XLinkError`
`XLinkReadError`
`XLinkWriteError`

Functions:

isDatatypeSubclassOf(arg0, arg1)

class depthai.ADatatype¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getRaw`(self)

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getRaw(self: depthai.ADatatype) → depthai.RawBuffer ¶

class depthai.AprilTag¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`bottomLeft`
`bottomRight`
`decisionMargin`
`hamming`
`id`
`topLeft`
`topRight`

__init__(self: depthai.AprilTag) → None ¶

property bottomLeft¶

property bottomRight¶

property decisionMargin¶

property hamming¶

property id¶

property topLeft¶

property topRight¶

class depthai.AprilTagConfig¶

Bases: depthai.Buffer

Classes:

`Family`	Members:
`QuadThresholds`

Methods:

`__init__`(self)
`get`(self)
`set`(self, arg0)
`setFamily`(self, family)

class Family¶

Bases: pybind11_builtins.pybind11_object

Members:

TAG_36H11

TAG_36H10

TAG_25H9

TAG_16H5

TAG_CIR21H7

TAG_STAND41H12

Attributes:

`TAG_16H5`
`TAG_25H9`
`TAG_36H10`
`TAG_36H11`
`TAG_CIR21H7`
`TAG_STAND41H12`
`name`
`value`

Methods:

__init__(self, value)

TAG_16H5 = <Family.TAG_16H5: 3>¶

TAG_25H9 = <Family.TAG_25H9: 2>¶

TAG_36H10 = <Family.TAG_36H10: 1>¶

TAG_36H11 = <Family.TAG_36H11: 0>¶

TAG_CIR21H7 = <Family.TAG_CIR21H7: 4>¶

TAG_STAND41H12 = <Family.TAG_STAND41H12: 5>¶

__init__(self: depthai.RawAprilTagConfig.Family, value: int) → None ¶

property name¶

property value¶

class QuadThresholds¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`criticalDegree`
`deglitch`
`maxLineFitMse`
`maxNmaxima`
`minClusterPixels`
`minWhiteBlackDiff`

__init__(self: depthai.RawAprilTagConfig.QuadThresholds) → None ¶

property criticalDegree¶

property deglitch¶

property maxLineFitMse¶

property maxNmaxima¶

property minClusterPixels¶

property minWhiteBlackDiff¶

__init__(self: depthai.AprilTagConfig) → None ¶

get(self: depthai.AprilTagConfig) → depthai.RawAprilTagConfig ¶

set(self: depthai.AprilTagConfig, arg0: depthai.RawAprilTagConfig) → depthai.AprilTagConfig ¶

setFamily(self: depthai.AprilTagConfig, family: depthai.RawAprilTagConfig.Family) → depthai.AprilTagConfig ¶

class depthai.AprilTagProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`initialConfig`
`inputConfigSync`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property initialConfig¶

property inputConfigSync¶

class depthai.AprilTags¶

Bases: depthai.Buffer

Methods:

`__init__`(self)
`getSequenceNum`(self)
`getTimestamp`(self)
`getTimestampDevice`(self)
`setSequenceNum`(self, arg0)
`setTimestamp`(self, arg0)
`setTimestampDevice`(self, arg0)

Attributes:

aprilTags

__init__(self: depthai.AprilTags) → None ¶

property aprilTags¶

getSequenceNum(self: depthai.AprilTags) → int ¶

getTimestamp(self: depthai.AprilTags) → datetime.timedelta ¶

getTimestampDevice(self: depthai.AprilTags) → datetime.timedelta ¶

setSequenceNum(self: depthai.AprilTags, arg0: int) → depthai.AprilTags ¶

setTimestamp(self: depthai.AprilTags, arg0: datetime.timedelta) → depthai.AprilTags ¶

setTimestampDevice(self: depthai.AprilTags, arg0: datetime.timedelta) → depthai.AprilTags ¶

class depthai.Asset¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Overloaded function.

Attributes:

`alignment`
`data`
`key`

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.Asset) -> None
__init__(self: depthai.Asset, arg0: str) -> None

property alignment¶

property data¶

property key¶

class depthai.AssetManager¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(self)
`addExisting`(self, assets)
`get`(args, *kwargs)	Overloaded function.
`getAll`(args, *kwargs)	Overloaded function.
`remove`(self, key)
`set`(args, *kwargs)	Overloaded function.
`size`(self)

__init__(self: depthai.AssetManager) → None ¶

addExisting(self: depthai.AssetManager, assets: list[depthai.Asset]) → None ¶

get(*args, **kwargs)¶

Overloaded function.

get(self: depthai.AssetManager, key: str) -> depthai.Asset
get(self: depthai.AssetManager, key: str) -> depthai.Asset

getAll(*args, **kwargs)¶

Overloaded function.

getAll(self: depthai.AssetManager) -> list[depthai.Asset]
getAll(self: depthai.AssetManager) -> list[depthai.Asset]

remove(self: depthai.AssetManager, key: str) → None ¶

set(*args, **kwargs)¶

Overloaded function.

set(self: depthai.AssetManager, asset: depthai.Asset) -> depthai.Asset
set(self: depthai.AssetManager, key: str, asset: depthai.Asset) -> depthai.Asset
set(self: depthai.AssetManager, key: str, path: Path, alignment: int = 64) -> depthai.Asset
set(self: depthai.AssetManager, key: str, data: list[int], alignment: int = 64) -> depthai.Asset

size(self: depthai.AssetManager) → int ¶

class depthai.BoardConfig¶

Bases: pybind11_builtins.pybind11_object

Classes:

`GPIO`
`GPIOMap`
`ItemsView`
`KeysView`
`Network`
`UART`
`UARTMap`
`USB`
`UVC`
`ValuesView`

Methods:

__init__(self)

Attributes:

`emmc`
`gpio`
`logDevicePrints`
`logPath`
`logSizeMax`
`logVerbosity`
`mipi4LaneRgb`
`network`
`pcieInternalClock`
`sysctl`
`uart`
`usb`
`usb3PhyInternalClock`
`uvc`
`watchdogInitialDelayMs`
`watchdogTimeoutMs`

class GPIO¶

Bases: pybind11_builtins.pybind11_object

Attributes:

Classes:

`Direction`	Members:
`Drive`	Members:
`Level`	Members:
`Mode`	Members:
`Pull`	Members:

Methods:

__init__(*args, **kwargs)

Overloaded function.

ALT_MODE_0 = <Mode.ALT_MODE_0: 0>¶

ALT_MODE_1 = <Mode.ALT_MODE_1: 1>¶

ALT_MODE_2 = <Mode.ALT_MODE_2: 2>¶

ALT_MODE_3 = <Mode.ALT_MODE_3: 3>¶

ALT_MODE_4 = <Mode.ALT_MODE_4: 4>¶

ALT_MODE_5 = <Mode.ALT_MODE_5: 5>¶

ALT_MODE_6 = <Mode.ALT_MODE_6: 6>¶

BUS_KEEPER = <Pull.BUS_KEEPER: 3>¶

DIRECT = <Mode.DIRECT: 7>¶

class Direction¶

Bases: pybind11_builtins.pybind11_object

Members:

INPUT

OUTPUT

Attributes:

`INPUT`
`OUTPUT`
`name`
`value`

Methods:

__init__(self, value)

INPUT = <Direction.INPUT: 0>¶

OUTPUT = <Direction.OUTPUT: 1>¶

__init__(self: depthai.BoardConfig.GPIO.Direction, value: int) → None ¶

property name¶

property value¶

class Drive¶

Bases: pybind11_builtins.pybind11_object

Members:

MA_2

MA_4

MA_8

MA_12

Attributes:

`MA_12`
`MA_2`
`MA_4`
`MA_8`
`name`
`value`

Methods:

__init__(self, value)

MA_12 = <Drive.MA_12: 12>¶

MA_2 = <Drive.MA_2: 2>¶

MA_4 = <Drive.MA_4: 4>¶

MA_8 = <Drive.MA_8: 8>¶

__init__(self: depthai.BoardConfig.GPIO.Drive, value: int) → None ¶

property name¶

property value¶

HIGH = <Level.HIGH: 1>¶

INPUT = <Direction.INPUT: 0>¶

LOW = <Level.LOW: 0>¶

class Level¶

Bases: pybind11_builtins.pybind11_object

Members:

LOW

HIGH

Attributes:

`HIGH`
`LOW`
`name`
`value`

Methods:

__init__(self, value)

HIGH = <Level.HIGH: 1>¶

LOW = <Level.LOW: 0>¶

__init__(self: depthai.BoardConfig.GPIO.Level, value: int) → None ¶

property name¶

property value¶

MA_12 = <Drive.MA_12: 12>¶

MA_2 = <Drive.MA_2: 2>¶

MA_4 = <Drive.MA_4: 4>¶

MA_8 = <Drive.MA_8: 8>¶

class Mode¶

Bases: pybind11_builtins.pybind11_object

Members:

ALT_MODE_0

ALT_MODE_1

ALT_MODE_2

ALT_MODE_3

ALT_MODE_4

ALT_MODE_5

ALT_MODE_6

DIRECT

Attributes:

`ALT_MODE_0`
`ALT_MODE_1`
`ALT_MODE_2`
`ALT_MODE_3`
`ALT_MODE_4`
`ALT_MODE_5`
`ALT_MODE_6`
`DIRECT`
`name`
`value`

Methods:

__init__(self, value)

ALT_MODE_0 = <Mode.ALT_MODE_0: 0>¶

ALT_MODE_1 = <Mode.ALT_MODE_1: 1>¶

ALT_MODE_2 = <Mode.ALT_MODE_2: 2>¶

ALT_MODE_3 = <Mode.ALT_MODE_3: 3>¶

ALT_MODE_4 = <Mode.ALT_MODE_4: 4>¶

ALT_MODE_5 = <Mode.ALT_MODE_5: 5>¶

ALT_MODE_6 = <Mode.ALT_MODE_6: 6>¶

DIRECT = <Mode.DIRECT: 7>¶

__init__(self: depthai.BoardConfig.GPIO.Mode, value: int) → None ¶

property name¶

property value¶

NO_PULL = <Pull.NO_PULL: 0>¶

OUTPUT = <Direction.OUTPUT: 1>¶

PULL_DOWN = <Pull.PULL_DOWN: 2>¶

PULL_UP = <Pull.PULL_UP: 1>¶

class Pull¶

Bases: pybind11_builtins.pybind11_object

Members:

NO_PULL

PULL_UP

PULL_DOWN

BUS_KEEPER

Attributes:

`BUS_KEEPER`
`NO_PULL`
`PULL_DOWN`
`PULL_UP`
`name`
`value`

Methods:

__init__(self, value)

BUS_KEEPER = <Pull.BUS_KEEPER: 3>¶

NO_PULL = <Pull.NO_PULL: 0>¶

PULL_DOWN = <Pull.PULL_DOWN: 2>¶

PULL_UP = <Pull.PULL_UP: 1>¶

__init__(self: depthai.BoardConfig.GPIO.Pull, value: int) → None ¶

property name¶

property value¶

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.BoardConfig.GPIO) -> None
__init__(self: depthai.BoardConfig.GPIO, arg0: depthai.BoardConfig.GPIO.Direction) -> None
__init__(self: depthai.BoardConfig.GPIO, arg0: depthai.BoardConfig.GPIO.Direction, arg1: depthai.BoardConfig.GPIO.Level) -> None
__init__(self: depthai.BoardConfig.GPIO, arg0: depthai.BoardConfig.GPIO.Direction, arg1: depthai.BoardConfig.GPIO.Level, arg2: depthai.BoardConfig.GPIO.Pull) -> None
__init__(self: depthai.BoardConfig.GPIO, arg0: depthai.BoardConfig.GPIO.Direction, arg1: depthai.BoardConfig.GPIO.Mode) -> None
__init__(self: depthai.BoardConfig.GPIO, arg0: depthai.BoardConfig.GPIO.Direction, arg1: depthai.BoardConfig.GPIO.Mode, arg2: depthai.BoardConfig.GPIO.Pull) -> None

property direction¶

property drive¶

property level¶

property mode¶

property pull¶

property schmitt¶

property slewFast¶

class GPIOMap¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(self)
`items`(self)
`keys`(self)
`values`(self)

__init__(self: depthai.BoardConfig.GPIOMap) → None ¶

items(self: depthai.BoardConfig.GPIOMap) → depthai.BoardConfig.ItemsView ¶

keys(self: depthai.BoardConfig.GPIOMap) → depthai.BoardConfig.KeysView ¶

values(self: depthai.BoardConfig.GPIOMap) → depthai.BoardConfig.ValuesView ¶

class ItemsView¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

class KeysView¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

class Network¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`mtu`
`xlinkTcpNoDelay`

__init__(self: depthai.BoardConfig.Network) → None ¶

property mtu¶

property xlinkTcpNoDelay¶

class UART¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

tmp

__init__(self: depthai.BoardConfig.UART) → None ¶

property tmp¶

class UARTMap¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(self)
`items`(self)
`keys`(self)
`values`(self)

__init__(self: depthai.BoardConfig.UARTMap) → None ¶

items(self: depthai.BoardConfig.UARTMap) → depthai.BoardConfig.ItemsView ¶

keys(self: depthai.BoardConfig.UARTMap) → depthai.BoardConfig.KeysView ¶

values(self: depthai.BoardConfig.UARTMap) → depthai.BoardConfig.ValuesView ¶

class USB¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`flashBootedPid`
`flashBootedVid`
`manufacturer`
`maxSpeed`
`pid`
`productName`
`vid`

__init__(self: depthai.BoardConfig.USB) → None ¶

property flashBootedPid¶

property flashBootedVid¶

property manufacturer¶

property maxSpeed¶

property pid¶

property productName¶

property vid¶

class UVC¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Overloaded function.

Attributes:

`cameraName`
`enable`
`frameType`
`height`
`width`

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.BoardConfig.UVC) -> None
__init__(self: depthai.BoardConfig.UVC, arg0: int, arg1: int) -> None

property cameraName¶

property enable¶

property frameType¶

property height¶

property width¶

class ValuesView¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

__init__(self: depthai.BoardConfig) → None ¶

property emmc¶

property gpio¶

property logDevicePrints¶

property logPath¶

property logSizeMax¶

property logVerbosity¶

property mipi4LaneRgb¶

property network¶

property pcieInternalClock¶

property sysctl¶

property uart¶

property usb¶

property usb3PhyInternalClock¶

property uvc¶

property watchdogInitialDelayMs¶

property watchdogTimeoutMs¶

class depthai.Buffer¶

Bases: depthai.ADatatype

Methods:

`__init__`(self)
`getData`(self)
`getSequenceNum`(self)
`getTimestamp`(self)
`getTimestampDevice`(self)
`setData`(args, *kwargs)	Overloaded function.
`setSequenceNum`(self, arg0)
`setTimestamp`(self, arg0)
`setTimestampDevice`(self, arg0)

__init__(self: depthai.Buffer) → None ¶

getData(self: object) → numpy.ndarray[numpy.uint8]¶

getSequenceNum(self: depthai.Buffer) → int ¶

getTimestamp(self: depthai.Buffer) → datetime.timedelta ¶

getTimestampDevice(self: depthai.Buffer) → datetime.timedelta ¶

setData(*args, **kwargs)¶

Overloaded function.

setData(self: depthai.Buffer, arg0: list[int]) -> None
setData(self: depthai.Buffer, arg0: numpy.ndarray[numpy.uint8]) -> None

setSequenceNum(self: depthai.Buffer, arg0: int) → depthai.Buffer ¶

setTimestamp(self: depthai.Buffer, arg0: datetime.timedelta) → depthai.Buffer ¶

setTimestampDevice(self: depthai.Buffer, arg0: datetime.timedelta) → depthai.Buffer ¶

class depthai.CalibrationHandler¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`eepromToJson`(self)
`eepromToJsonFile`(self, destPath)
`fromJson`(arg0)
`getBaselineDistance`(self, cam1, cam2, …)
`getCameraExtrinsics`(self, srcCamera, …)
`getCameraIntrinsics`(args, *kwargs)	Overloaded function.
`getCameraToImuExtrinsics`(self, cameraId, …)
`getCameraTranslationVector`(self, srcCamera, …)
`getDefaultIntrinsics`(self, cameraId)
`getDistortionCoefficients`(self, cameraId)
`getDistortionModel`(self, cameraId)
`getEepromData`(self)
`getFov`(self, cameraId, useSpec)
`getImuToCameraExtrinsics`(self, cameraId, …)
`getLensPosition`(self, cameraId)
`getStereoLeftCameraId`(self)
`getStereoLeftRectificationRotation`(self)
`getStereoRightCameraId`(self)
`getStereoRightRectificationRotation`(self)
`setBoardInfo`(args, *kwargs)	Overloaded function.
`setCameraExtrinsics`(self, srcCameraId, …)
`setCameraIntrinsics`(args, *kwargs)	Overloaded function.
`setCameraType`(self, cameraId, cameraModel)
`setDeviceName`(self, deviceName)
`setDistortionCoefficients`(self, cameraId, …)
`setFov`(self, cameraId, hfov)
`setImuExtrinsics`(self, destCameraId, …)
`setLensPosition`(self, cameraId, lensPosition)
`setProductName`(self, productName)
`setStereoLeft`(self, cameraId, rectifiedRotation)
`setStereoRight`(self, cameraId, rectifiedRotation)

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.CalibrationHandler) -> None
__init__(self: depthai.CalibrationHandler, arg0: Path) -> None
__init__(self: depthai.CalibrationHandler, arg0: Path, arg1: Path) -> None
__init__(self: depthai.CalibrationHandler, arg0: depthai.EepromData) -> None

eepromToJson(self: depthai.CalibrationHandler) → json¶

eepromToJsonFile(self: depthai.CalibrationHandler, destPath: Path) → bool ¶

static fromJson(arg0: json) → depthai.CalibrationHandler ¶

getBaselineDistance(self: depthai.CalibrationHandler, cam1: depthai.CameraBoardSocket = <CameraBoardSocket.???: 2>, cam2: depthai.CameraBoardSocket = <CameraBoardSocket.???: 1>, useSpecTranslation: bool = True) → float ¶

getCameraExtrinsics(self: depthai.CalibrationHandler, srcCamera: depthai.CameraBoardSocket, dstCamera: depthai.CameraBoardSocket, useSpecTranslation: bool = False) → list[list[float]]¶

getCameraIntrinsics(*args, **kwargs)¶

Overloaded function.

getCameraIntrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, resizeWidth: int = -1, resizeHeight: int = -1, topLeftPixelId: depthai.Point2f = <depthai.Point2f object at 0x7f56c0239170>, bottomRightPixelId: depthai.Point2f = <depthai.Point2f object at 0x7f56c023a4f0>, keepAspectRatio: bool = True) -> list[list[float]]
getCameraIntrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, destShape: depthai.Size2f, topLeftPixelId: depthai.Point2f = <depthai.Point2f object at 0x7f56c0237e30>, bottomRightPixelId: depthai.Point2f = <depthai.Point2f object at 0x7f56c02393f0>, keepAspectRatio: bool = True) -> list[list[float]]
getCameraIntrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, destShape: tuple[int, int], topLeftPixelId: depthai.Point2f = <depthai.Point2f object at 0x7f56c02370b0>, bottomRightPixelId: depthai.Point2f = <depthai.Point2f object at 0x7f56c0237df0>, keepAspectRatio: bool = True) -> list[list[float]]

getCameraToImuExtrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, useSpecTranslation: bool = False) → list[list[float]]¶

getCameraTranslationVector(self: depthai.CalibrationHandler, srcCamera: depthai.CameraBoardSocket, dstCamera: depthai.CameraBoardSocket, useSpecTranslation: bool = True) → list[float]¶

getDefaultIntrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket) → tuple[list[list[float]], int, int]¶

getDistortionCoefficients(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket) → list[float]¶

getDistortionModel(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket) → depthai.CameraModel ¶

getEepromData(self: depthai.CalibrationHandler) → depthai.EepromData ¶

getFov(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, useSpec: bool = True) → float ¶

getImuToCameraExtrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, useSpecTranslation: bool = False) → list[list[float]]¶

getLensPosition(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket) → int ¶

getStereoLeftCameraId(self: depthai.CalibrationHandler) → depthai.CameraBoardSocket ¶

getStereoLeftRectificationRotation(self: depthai.CalibrationHandler) → list[list[float]]¶

getStereoRightCameraId(self: depthai.CalibrationHandler) → depthai.CameraBoardSocket ¶

getStereoRightRectificationRotation(self: depthai.CalibrationHandler) → list[list[float]]¶

setBoardInfo(*args, **kwargs)¶

Overloaded function.

setBoardInfo(self: depthai.CalibrationHandler, boardName: str, boardRev: str) -> None
setBoardInfo(self: depthai.CalibrationHandler, productName: str, boardName: str, boardRev: str, boardConf: str, hardwareConf: str, batchName: str, batchTime: int, boardOptions: int, boardCustom: str = ‘’) -> None
setBoardInfo(self: depthai.CalibrationHandler, deviceName: str, productName: str, boardName: str, boardRev: str, boardConf: str, hardwareConf: str, batchName: str, batchTime: int, boardOptions: int, boardCustom: str = ‘’) -> None

setCameraExtrinsics(self: depthai.CalibrationHandler, srcCameraId: depthai.CameraBoardSocket, destCameraId: depthai.CameraBoardSocket, rotationMatrix: list[list[float]], translation: list[float], specTranslation: list[float] = [0.0, 0.0, 0.0]) → None ¶

setCameraIntrinsics(*args, **kwargs)¶

Overloaded function.

setCameraIntrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, intrinsics: list[list[float]], frameSize: depthai.Size2f) -> None
setCameraIntrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, intrinsics: list[list[float]], width: int, height: int) -> None
setCameraIntrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, intrinsics: list[list[float]], frameSize: tuple[int, int]) -> None

setCameraType(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, cameraModel: depthai.CameraModel) → None ¶

setDeviceName(self: depthai.CalibrationHandler, deviceName: str) → None ¶

setDistortionCoefficients(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, distortionCoefficients: list[float]) → None ¶

setFov(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, hfov: float) → None ¶

setImuExtrinsics(self: depthai.CalibrationHandler, destCameraId: depthai.CameraBoardSocket, rotationMatrix: list[list[float]], translation: list[float], specTranslation: list[float] = [0.0, 0.0, 0.0]) → None ¶

setLensPosition(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, lensPosition: int) → None ¶

setProductName(self: depthai.CalibrationHandler, productName: str) → None ¶

setStereoLeft(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, rectifiedRotation: list[list[float]]) → None ¶

setStereoRight(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, rectifiedRotation: list[list[float]]) → None ¶

class depthai.CameraBoardSocket¶

Bases: pybind11_builtins.pybind11_object

Members:

AUTO

CAM_A

CAM_B

CAM_C

CAM_D

CAM_E

CAM_F

CAM_G

CAM_H

RGB : Deprecated: Use CAM_A or address camera by name instead

LEFT : Deprecated: Use CAM_B or address camera by name instead

RIGHT : Deprecated: Use CAM_C or address camera by name instead

CENTER : Deprecated: Use CAM_A or address camera by name instead

Attributes:

`AUTO`
`CAM_A`
`CAM_B`
`CAM_C`
`CAM_D`
`CAM_E`
`CAM_F`
`CAM_G`
`CAM_H`
`CENTER`
`LEFT`
`RGB`
`RIGHT`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <CameraBoardSocket.AUTO: -1>¶

CAM_A = <CameraBoardSocket.CAM_A: 0>¶

CAM_B = <CameraBoardSocket.CAM_B: 1>¶

CAM_C = <CameraBoardSocket.CAM_C: 2>¶

CAM_D = <CameraBoardSocket.CAM_D: 3>¶

CAM_E = <CameraBoardSocket.CAM_E: 4>¶

CAM_F = <CameraBoardSocket.CAM_F: 5>¶

CAM_G = <CameraBoardSocket.CAM_G: 6>¶

CAM_H = <CameraBoardSocket.CAM_H: 7>¶

CENTER = <CameraBoardSocket.CAM_A: 0>¶

LEFT = <CameraBoardSocket.CAM_B: 1>¶

RGB = <CameraBoardSocket.CAM_A: 0>¶

RIGHT = <CameraBoardSocket.CAM_C: 2>¶

__init__(self: depthai.CameraBoardSocket, value: int) → None ¶

property name¶

property value¶

class depthai.CameraControl¶

Bases: depthai.Buffer

Classes:

`AntiBandingMode`	Members:
`AutoFocusMode`	Members:
`AutoWhiteBalanceMode`	Members:
`CaptureIntent`	Members:
`Command`	Members:
`ControlMode`	Members:
`EffectMode`	Members:
`FrameSyncMode`	Members:
`SceneMode`	Members:

Methods:

`__init__`(self)
`get`(self)
`getCaptureStill`(self)
`getExposureTime`(self)
`getLensPosition`(self)
`getLensPositionRaw`(self)
`getSensitivity`(self)
`set`(self, config)
`setAntiBandingMode`(self, mode)
`setAutoExposureCompensation`(self, compensation)
`setAutoExposureEnable`(self)
`setAutoExposureLimit`(args, *kwargs)	Overloaded function.
`setAutoExposureLock`(self, lock)
`setAutoExposureRegion`(self, startX, startY, …)
`setAutoFocusLensRange`(self, …)
`setAutoFocusMode`(self, mode)
`setAutoFocusRegion`(self, startX, startY, …)
`setAutoFocusTrigger`(self)
`setAutoWhiteBalanceLock`(self, lock)
`setAutoWhiteBalanceMode`(self, mode)
`setBrightness`(self, value)
`setCaptureIntent`(self, mode)
`setCaptureStill`(self, capture)
`setChromaDenoise`(self, value)
`setContrast`(self, value)
`setControlMode`(self, mode)
`setEffectMode`(self, mode)
`setExternalTrigger`(self, numFramesBurst, …)
`setFrameSyncMode`(self, mode)
`setLumaDenoise`(self, value)
`setManualExposure`(args, *kwargs)	Overloaded function.
`setManualFocus`(self, lensPosition)
`setManualFocusRaw`(self, lensPositionRaw)
`setManualWhiteBalance`(self, colorTemperatureK)
`setSaturation`(self, value)
`setSceneMode`(self, mode)
`setSharpness`(self, value)
`setStartStreaming`(self)
`setStopStreaming`(self)
`setStrobeDisable`(self)
`setStrobeExternal`(self, gpioNumber, activeLevel)
`setStrobeSensor`(self, activeLevel)

class AntiBandingMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

MAINS_50_HZ

MAINS_60_HZ

AUTO

Attributes:

`AUTO`
`MAINS_50_HZ`
`MAINS_60_HZ`
`OFF`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <AntiBandingMode.AUTO: 3>¶

MAINS_50_HZ = <AntiBandingMode.MAINS_50_HZ: 1>¶

MAINS_60_HZ = <AntiBandingMode.MAINS_60_HZ: 2>¶

OFF = <AntiBandingMode.OFF: 0>¶

__init__(self: depthai.RawCameraControl.AntiBandingMode, value: int) → None ¶

property name¶

property value¶

class AutoFocusMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

AUTO

MACRO

CONTINUOUS_VIDEO

CONTINUOUS_PICTURE

EDOF

Attributes:

`AUTO`
`CONTINUOUS_PICTURE`
`CONTINUOUS_VIDEO`
`EDOF`
`MACRO`
`OFF`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <AutoFocusMode.AUTO: 1>¶

CONTINUOUS_PICTURE = <AutoFocusMode.CONTINUOUS_PICTURE: 4>¶

CONTINUOUS_VIDEO = <AutoFocusMode.CONTINUOUS_VIDEO: 3>¶

EDOF = <AutoFocusMode.EDOF: 5>¶

MACRO = <AutoFocusMode.MACRO: 2>¶

OFF = <AutoFocusMode.OFF: 0>¶

__init__(self: depthai.RawCameraControl.AutoFocusMode, value: int) → None ¶

property name¶

property value¶

class AutoWhiteBalanceMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

AUTO

INCANDESCENT

FLUORESCENT

WARM_FLUORESCENT

DAYLIGHT

CLOUDY_DAYLIGHT

TWILIGHT

SHADE

Attributes:

`AUTO`
`CLOUDY_DAYLIGHT`
`DAYLIGHT`
`FLUORESCENT`
`INCANDESCENT`
`OFF`
`SHADE`
`TWILIGHT`
`WARM_FLUORESCENT`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <AutoWhiteBalanceMode.AUTO: 1>¶

CLOUDY_DAYLIGHT = <AutoWhiteBalanceMode.CLOUDY_DAYLIGHT: 6>¶

DAYLIGHT = <AutoWhiteBalanceMode.DAYLIGHT: 5>¶

FLUORESCENT = <AutoWhiteBalanceMode.FLUORESCENT: 3>¶

INCANDESCENT = <AutoWhiteBalanceMode.INCANDESCENT: 2>¶

OFF = <AutoWhiteBalanceMode.OFF: 0>¶

SHADE = <AutoWhiteBalanceMode.SHADE: 8>¶

TWILIGHT = <AutoWhiteBalanceMode.TWILIGHT: 7>¶

WARM_FLUORESCENT = <AutoWhiteBalanceMode.WARM_FLUORESCENT: 4>¶

__init__(self: depthai.RawCameraControl.AutoWhiteBalanceMode, value: int) → None ¶

property name¶

property value¶

class CaptureIntent¶

Bases: pybind11_builtins.pybind11_object

Members:

CUSTOM

PREVIEW

STILL_CAPTURE

VIDEO_RECORD

VIDEO_SNAPSHOT

ZERO_SHUTTER_LAG

Attributes:

`CUSTOM`
`PREVIEW`
`STILL_CAPTURE`
`VIDEO_RECORD`
`VIDEO_SNAPSHOT`
`ZERO_SHUTTER_LAG`
`name`
`value`

Methods:

__init__(self, value)

CUSTOM = <CaptureIntent.CUSTOM: 0>¶

PREVIEW = <CaptureIntent.PREVIEW: 1>¶

STILL_CAPTURE = <CaptureIntent.STILL_CAPTURE: 2>¶

VIDEO_RECORD = <CaptureIntent.VIDEO_RECORD: 3>¶

VIDEO_SNAPSHOT = <CaptureIntent.VIDEO_SNAPSHOT: 4>¶

ZERO_SHUTTER_LAG = <CaptureIntent.ZERO_SHUTTER_LAG: 5>¶

__init__(self: depthai.RawCameraControl.CaptureIntent, value: int) → None ¶

property name¶

property value¶

class Command¶

Bases: pybind11_builtins.pybind11_object

Members:

START_STREAM

STOP_STREAM

STILL_CAPTURE

MOVE_LENS

AF_TRIGGER

AE_MANUAL

AE_AUTO

AWB_MODE

SCENE_MODE

ANTIBANDING_MODE

EXPOSURE_COMPENSATION

AE_LOCK

AE_TARGET_FPS_RANGE

AWB_LOCK

CAPTURE_INTENT

CONTROL_MODE

FRAME_DURATION

SENSITIVITY

EFFECT_MODE

AF_MODE

NOISE_REDUCTION_STRENGTH

SATURATION

BRIGHTNESS

STREAM_FORMAT

RESOLUTION

SHARPNESS

CUSTOM_USECASE

CUSTOM_CAPT_MODE

CUSTOM_EXP_BRACKETS

CUSTOM_CAPTURE

CONTRAST

AE_REGION

AF_REGION

LUMA_DENOISE

CHROMA_DENOISE

WB_COLOR_TEMP

Attributes:

Methods:

__init__(self, value)

AE_AUTO = <Command.AE_AUTO: 7>¶

AE_LOCK = <Command.AE_LOCK: 13>¶

AE_MANUAL = <Command.AE_MANUAL: 6>¶

AE_REGION = <Command.AE_REGION: 45>¶

AE_TARGET_FPS_RANGE = <Command.AE_TARGET_FPS_RANGE: 14>¶

AF_MODE = <Command.AF_MODE: 26>¶

AF_REGION = <Command.AF_REGION: 46>¶

AF_TRIGGER = <Command.AF_TRIGGER: 5>¶

ANTIBANDING_MODE = <Command.ANTIBANDING_MODE: 10>¶

AWB_LOCK = <Command.AWB_LOCK: 16>¶

AWB_MODE = <Command.AWB_MODE: 8>¶

BRIGHTNESS = <Command.BRIGHTNESS: 31>¶

CAPTURE_INTENT = <Command.CAPTURE_INTENT: 17>¶

CHROMA_DENOISE = <Command.CHROMA_DENOISE: 48>¶

CONTRAST = <Command.CONTRAST: 44>¶

CONTROL_MODE = <Command.CONTROL_MODE: 18>¶

CUSTOM_CAPTURE = <Command.CUSTOM_CAPTURE: 43>¶

CUSTOM_CAPT_MODE = <Command.CUSTOM_CAPT_MODE: 41>¶

CUSTOM_EXP_BRACKETS = <Command.CUSTOM_EXP_BRACKETS: 42>¶

CUSTOM_USECASE = <Command.CUSTOM_USECASE: 40>¶

EFFECT_MODE = <Command.EFFECT_MODE: 24>¶

EXPOSURE_COMPENSATION = <Command.EXPOSURE_COMPENSATION: 11>¶

FRAME_DURATION = <Command.FRAME_DURATION: 21>¶

LUMA_DENOISE = <Command.LUMA_DENOISE: 47>¶

MOVE_LENS = <Command.MOVE_LENS: 4>¶

NOISE_REDUCTION_STRENGTH = <Command.NOISE_REDUCTION_STRENGTH: 27>¶

RESOLUTION = <Command.RESOLUTION: 34>¶

SATURATION = <Command.SATURATION: 28>¶

SCENE_MODE = <Command.SCENE_MODE: 9>¶

SENSITIVITY = <Command.SENSITIVITY: 23>¶

SHARPNESS = <Command.SHARPNESS: 35>¶

START_STREAM = <Command.START_STREAM: 1>¶

STILL_CAPTURE = <Command.STILL_CAPTURE: 3>¶

STOP_STREAM = <Command.STOP_STREAM: 2>¶

STREAM_FORMAT = <Command.STREAM_FORMAT: 33>¶

WB_COLOR_TEMP = <Command.WB_COLOR_TEMP: 49>¶

__init__(self: depthai.RawCameraControl.Command, value: int) → None ¶

property name¶

property value¶

class ControlMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

AUTO

USE_SCENE_MODE

Attributes:

`AUTO`
`OFF`
`USE_SCENE_MODE`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <ControlMode.AUTO: 1>¶

OFF = <ControlMode.OFF: 0>¶

USE_SCENE_MODE = <ControlMode.USE_SCENE_MODE: 2>¶

__init__(self: depthai.RawCameraControl.ControlMode, value: int) → None ¶

property name¶

property value¶

class EffectMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

MONO

NEGATIVE

SOLARIZE

SEPIA

POSTERIZE

WHITEBOARD

BLACKBOARD

AQUA

Attributes:

`AQUA`
`BLACKBOARD`
`MONO`
`NEGATIVE`
`OFF`
`POSTERIZE`
`SEPIA`
`SOLARIZE`
`WHITEBOARD`
`name`
`value`

Methods:

__init__(self, value)

AQUA = <EffectMode.AQUA: 8>¶

BLACKBOARD = <EffectMode.BLACKBOARD: 7>¶

MONO = <EffectMode.MONO: 1>¶

NEGATIVE = <EffectMode.NEGATIVE: 2>¶

OFF = <EffectMode.OFF: 0>¶

POSTERIZE = <EffectMode.POSTERIZE: 5>¶

SEPIA = <EffectMode.SEPIA: 4>¶

SOLARIZE = <EffectMode.SOLARIZE: 3>¶

WHITEBOARD = <EffectMode.WHITEBOARD: 6>¶

__init__(self: depthai.RawCameraControl.EffectMode, value: int) → None ¶

property name¶

property value¶

class FrameSyncMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

OUTPUT

INPUT

Attributes:

`INPUT`
`OFF`
`OUTPUT`
`name`
`value`

Methods:

__init__(self, value)

INPUT = <FrameSyncMode.INPUT: 2>¶

OFF = <FrameSyncMode.OFF: 0>¶

OUTPUT = <FrameSyncMode.OUTPUT: 1>¶

__init__(self: depthai.RawCameraControl.FrameSyncMode, value: int) → None ¶

property name¶

property value¶

class SceneMode¶

Bases: pybind11_builtins.pybind11_object

Members:

UNSUPPORTED

FACE_PRIORITY

ACTION

PORTRAIT

LANDSCAPE

NIGHT

NIGHT_PORTRAIT

THEATRE

BEACH

SNOW

SUNSET

STEADYPHOTO

FIREWORKS

SPORTS

PARTY

CANDLELIGHT

BARCODE

Attributes:

`ACTION`
`BARCODE`
`BEACH`
`CANDLELIGHT`
`FACE_PRIORITY`
`FIREWORKS`
`LANDSCAPE`
`NIGHT`
`NIGHT_PORTRAIT`
`PARTY`
`PORTRAIT`
`SNOW`
`SPORTS`
`STEADYPHOTO`
`SUNSET`
`THEATRE`
`UNSUPPORTED`
`name`
`value`

Methods:

__init__(self, value)

ACTION = <SceneMode.ACTION: 2>¶

BARCODE = <SceneMode.BARCODE: 16>¶

BEACH = <SceneMode.BEACH: 8>¶

CANDLELIGHT = <SceneMode.CANDLELIGHT: 15>¶

FACE_PRIORITY = <SceneMode.FACE_PRIORITY: 1>¶

FIREWORKS = <SceneMode.FIREWORKS: 12>¶

LANDSCAPE = <SceneMode.LANDSCAPE: 4>¶

NIGHT = <SceneMode.NIGHT: 5>¶

NIGHT_PORTRAIT = <SceneMode.NIGHT_PORTRAIT: 6>¶

PARTY = <SceneMode.PARTY: 14>¶

PORTRAIT = <SceneMode.PORTRAIT: 3>¶

SNOW = <SceneMode.SNOW: 9>¶

SPORTS = <SceneMode.SPORTS: 13>¶

STEADYPHOTO = <SceneMode.STEADYPHOTO: 11>¶

SUNSET = <SceneMode.SUNSET: 10>¶

THEATRE = <SceneMode.THEATRE: 7>¶

UNSUPPORTED = <SceneMode.UNSUPPORTED: 0>¶

__init__(self: depthai.RawCameraControl.SceneMode, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.CameraControl) → None ¶

get(self: depthai.CameraControl) → depthai.RawCameraControl ¶

getCaptureStill(self: depthai.CameraControl) → bool ¶

getExposureTime(self: depthai.CameraControl) → datetime.timedelta ¶

getLensPosition(self: depthai.CameraControl) → int ¶

getLensPositionRaw(self: depthai.CameraControl) → float ¶

getSensitivity(self: depthai.CameraControl) → int ¶

set(self: depthai.CameraControl, config: depthai.RawCameraControl) → depthai.CameraControl ¶

setAntiBandingMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.AntiBandingMode) → depthai.CameraControl ¶

setAutoExposureCompensation(self: depthai.CameraControl, compensation: int) → depthai.CameraControl ¶

setAutoExposureEnable(self: depthai.CameraControl) → depthai.CameraControl ¶

setAutoExposureLimit(*args, **kwargs)¶

Overloaded function.

setAutoExposureLimit(self: depthai.CameraControl, maxExposureTimeUs: int) -> depthai.CameraControl
setAutoExposureLimit(self: depthai.CameraControl, maxExposureTime: datetime.timedelta) -> depthai.CameraControl

setAutoExposureLock(self: depthai.CameraControl, lock: bool) → depthai.CameraControl ¶

setAutoExposureRegion(self: depthai.CameraControl, startX: int, startY: int, width: int, height: int) → depthai.CameraControl ¶

setAutoFocusLensRange(self: depthai.CameraControl, infinityPosition: int, macroPosition: int) → depthai.CameraControl ¶

setAutoFocusMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.AutoFocusMode) → depthai.CameraControl ¶

setAutoFocusRegion(self: depthai.CameraControl, startX: int, startY: int, width: int, height: int) → depthai.CameraControl ¶

setAutoFocusTrigger(self: depthai.CameraControl) → depthai.CameraControl ¶

setAutoWhiteBalanceLock(self: depthai.CameraControl, lock: bool) → depthai.CameraControl ¶

setAutoWhiteBalanceMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.AutoWhiteBalanceMode) → depthai.CameraControl ¶

setBrightness(self: depthai.CameraControl, value: int) → depthai.CameraControl ¶

setCaptureIntent(self: depthai.CameraControl, mode: depthai.RawCameraControl.CaptureIntent) → depthai.CameraControl ¶

setCaptureStill(self: depthai.CameraControl, capture: bool) → depthai.CameraControl ¶

setChromaDenoise(self: depthai.CameraControl, value: int) → depthai.CameraControl ¶

setContrast(self: depthai.CameraControl, value: int) → depthai.CameraControl ¶

setControlMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.ControlMode) → depthai.CameraControl ¶

setEffectMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.EffectMode) → depthai.CameraControl ¶

setExternalTrigger(self: depthai.CameraControl, numFramesBurst: int, numFramesDiscard: int) → depthai.CameraControl ¶

setFrameSyncMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.FrameSyncMode) → depthai.CameraControl ¶

setLumaDenoise(self: depthai.CameraControl, value: int) → depthai.CameraControl ¶

setManualExposure(*args, **kwargs)¶

Overloaded function.

setManualExposure(self: depthai.CameraControl, exposureTimeUs: int, sensitivityIso: int) -> depthai.CameraControl
setManualExposure(self: depthai.CameraControl, exposureTime: datetime.timedelta, sensitivityIso: int) -> depthai.CameraControl

setManualFocus(self: depthai.CameraControl, lensPosition: int) → depthai.CameraControl ¶

setManualFocusRaw(self: depthai.CameraControl, lensPositionRaw: float) → depthai.CameraControl ¶

setManualWhiteBalance(self: depthai.CameraControl, colorTemperatureK: int) → depthai.CameraControl ¶

setSaturation(self: depthai.CameraControl, value: int) → depthai.CameraControl ¶

setSceneMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.SceneMode) → depthai.CameraControl ¶

setSharpness(self: depthai.CameraControl, value: int) → depthai.CameraControl ¶

setStartStreaming(self: depthai.CameraControl) → depthai.CameraControl ¶

setStopStreaming(self: depthai.CameraControl) → depthai.CameraControl ¶

setStrobeDisable(self: depthai.CameraControl) → depthai.CameraControl ¶

setStrobeExternal(self: depthai.CameraControl, gpioNumber: int, activeLevel: int) → depthai.CameraControl ¶

setStrobeSensor(self: depthai.CameraControl, activeLevel: int) → depthai.CameraControl ¶

class depthai.CameraExposureOffset¶

Bases: pybind11_builtins.pybind11_object

Members:

START

MIDDLE

END

Attributes:

`END`
`MIDDLE`
`START`
`name`
`value`

Methods:

__init__(self, value)

END = <CameraExposureOffset.END: 2>¶

MIDDLE = <CameraExposureOffset.MIDDLE: 1>¶

START = <CameraExposureOffset.START: 0>¶

__init__(self: depthai.CameraExposureOffset, value: int) → None ¶

property name¶

property value¶

class depthai.CameraFeatures¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`calibrationResolution`
`configs`
`hasAutofocus`
`hasAutofocusIC`
`height`
`name`
`orientation`
`sensorName`
`socket`
`supportedTypes`
`width`

__init__(self: depthai.CameraFeatures) → None ¶

property calibrationResolution¶

property configs¶

property hasAutofocus¶

property hasAutofocusIC¶

property height¶

property name¶

property orientation¶

property sensorName¶

property socket¶

property supportedTypes¶

property width¶

class depthai.CameraImageOrientation¶

Bases: pybind11_builtins.pybind11_object

Members:

AUTO

NORMAL

HORIZONTAL_MIRROR

VERTICAL_FLIP

ROTATE_180_DEG

Attributes:

`AUTO`
`HORIZONTAL_MIRROR`
`NORMAL`
`ROTATE_180_DEG`
`VERTICAL_FLIP`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <CameraImageOrientation.AUTO: -1>¶

HORIZONTAL_MIRROR = <CameraImageOrientation.HORIZONTAL_MIRROR: 1>¶

NORMAL = <CameraImageOrientation.NORMAL: 0>¶

ROTATE_180_DEG = <CameraImageOrientation.ROTATE_180_DEG: 3>¶

VERTICAL_FLIP = <CameraImageOrientation.VERTICAL_FLIP: 2>¶

__init__(self: depthai.CameraImageOrientation, value: int) → None ¶

property name¶

property value¶

class depthai.CameraInfo¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`cameraType`
`distortionCoeff`
`extrinsics`
`height`
`intrinsicMatrix`
`specHfovDeg`
`width`

__init__(self: depthai.CameraInfo) → None ¶

property cameraType¶

property distortionCoeff¶

property extrinsics¶

property height¶

property intrinsicMatrix¶

property specHfovDeg¶

property width¶

class depthai.CameraModel¶

Bases: pybind11_builtins.pybind11_object

Members:

Perspective

Fisheye

Equirectangular

RadialDivision

Attributes:

`Equirectangular`
`Fisheye`
`Perspective`
`RadialDivision`
`name`
`value`

Methods:

__init__(self, value)

Equirectangular = <CameraModel.Equirectangular: 2>¶

Fisheye = <CameraModel.Fisheye: 1>¶

Perspective = <CameraModel.Perspective: 0>¶

RadialDivision = <CameraModel.RadialDivision: 3>¶

__init__(self: depthai.CameraModel, value: int) → None ¶

property name¶

property value¶

class depthai.CameraProperties¶

Bases: pybind11_builtins.pybind11_object

Classes:

`ColorOrder`	Members:
`WarpMeshSource`	Members:

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

class ColorOrder¶

Bases: pybind11_builtins.pybind11_object

Members:

BGR

RGB

Attributes:

`BGR`
`RGB`
`name`
`value`

Methods:

__init__(self, value)

BGR = <ColorOrder.BGR: 0>¶

RGB = <ColorOrder.RGB: 1>¶

__init__(self: depthai.CameraProperties.ColorOrder, value: int) → None ¶

property name¶

property value¶

class WarpMeshSource¶

Bases: pybind11_builtins.pybind11_object

Members:

AUTO

NONE

CALIBRATION

URI

Attributes:

`AUTO`
`CALIBRATION`
`NONE`
`URI`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <WarpMeshSource.AUTO: -1>¶

CALIBRATION = <WarpMeshSource.CALIBRATION: 1>¶

NONE = <WarpMeshSource.NONE: 0>¶

URI = <WarpMeshSource.URI: 2>¶

__init__(self: depthai.CameraProperties.WarpMeshSource, value: int) → None ¶

property name¶

property value¶

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property boardSocket¶

property calibAlpha¶

property cameraName¶

property colorOrder¶

property fp16¶

property fps¶

property imageOrientation¶

property initialControl¶

property interleaved¶

property isp3aFps¶

property ispScale¶

property numFramesPoolIsp¶

property numFramesPoolPreview¶

property numFramesPoolRaw¶

property numFramesPoolStill¶

property numFramesPoolVideo¶

property previewHeight¶

property previewKeepAspectRatio¶

property previewWidth¶

property rawPacked¶

property resolutionHeight¶

property resolutionWidth¶

property sensorCropX¶

property sensorCropY¶

property sensorType¶

property stillHeight¶

property stillWidth¶

property videoHeight¶

property videoWidth¶

property warpMeshHeight¶

property warpMeshSource¶

property warpMeshStepHeight¶

property warpMeshStepWidth¶

property warpMeshUri¶

property warpMeshWidth¶

class depthai.CameraSensorConfig¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`fov`
`height`
`maxFps`
`minFps`
`type`
`width`

__init__(self: depthai.CameraSensorConfig) → None ¶

property fov¶

property height¶

property maxFps¶

property minFps¶

property type¶

property width¶

class depthai.CameraSensorType¶

Bases: pybind11_builtins.pybind11_object

Members:

COLOR

MONO

TOF

THERMAL

Attributes:

`COLOR`
`MONO`
`THERMAL`
`TOF`
`name`
`value`

Methods:

__init__(self, value)

COLOR = <CameraSensorType.COLOR: 0>¶

MONO = <CameraSensorType.MONO: 1>¶

THERMAL = <CameraSensorType.THERMAL: 3>¶

TOF = <CameraSensorType.TOF: 2>¶

__init__(self: depthai.CameraSensorType, value: int) → None ¶

property name¶

property value¶

class depthai.CastProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`numFramesPool`
`offset`
`outputType`
`scale`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property numFramesPool¶

property offset¶

property outputType¶

property scale¶

class depthai.ChipTemperature¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`average`
`css`
`dss`
`mss`
`upa`

__init__(self: depthai.ChipTemperature) → None ¶

property average¶

property css¶

property dss¶

property mss¶

property upa¶

class depthai.Clock¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Initialize self.
`now`()

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

now() → datetime.timedelta ¶

class depthai.ColorCameraProperties¶

Bases: pybind11_builtins.pybind11_object

Classes:

`ColorOrder`	Members:
`SensorResolution`	Members:

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

class ColorOrder¶

Bases: pybind11_builtins.pybind11_object

Members:

BGR

RGB

Attributes:

`BGR`
`RGB`
`name`
`value`

Methods:

__init__(self, value)

BGR = <ColorOrder.BGR: 0>¶

RGB = <ColorOrder.RGB: 1>¶

__init__(self: depthai.ColorCameraProperties.ColorOrder, value: int) → None ¶

property name¶

property value¶

class SensorResolution¶

Bases: pybind11_builtins.pybind11_object

Members:

THE_1080_P

THE_1200_P

THE_4_K

THE_5_MP

THE_12_MP

THE_4000X3000

THE_13_MP

THE_5312X6000

THE_48_MP

THE_720_P

THE_800_P

THE_1440X1080

THE_1352X1012

THE_2024X1520

Attributes:

`THE_1080_P`
`THE_1200_P`
`THE_12_MP`
`THE_1352X1012`
`THE_13_MP`
`THE_1440X1080`
`THE_2024X1520`
`THE_4000X3000`
`THE_48_MP`
`THE_4_K`
`THE_5312X6000`
`THE_5_MP`
`THE_720_P`
`THE_800_P`
`name`
`value`

Methods:

__init__(self, value)

THE_1080_P = <SensorResolution.THE_1080_P: 0>¶

THE_1200_P = <SensorResolution.THE_1200_P: 6>¶

THE_12_MP = <SensorResolution.THE_12_MP: 2>¶

THE_1352X1012 = <SensorResolution.THE_1352X1012: 12>¶

THE_13_MP = <SensorResolution.THE_13_MP: 3>¶

THE_1440X1080 = <SensorResolution.THE_1440X1080: 11>¶

THE_2024X1520 = <SensorResolution.THE_2024X1520: 13>¶

THE_4000X3000 = <SensorResolution.THE_4000X3000: 8>¶

THE_48_MP = <SensorResolution.THE_48_MP: 10>¶

THE_4_K = <SensorResolution.THE_4_K: 1>¶

THE_5312X6000 = <SensorResolution.THE_5312X6000: 9>¶

THE_5_MP = <SensorResolution.THE_5_MP: 7>¶

THE_720_P = <SensorResolution.THE_720_P: 4>¶

THE_800_P = <SensorResolution.THE_800_P: 5>¶

__init__(self: depthai.ColorCameraProperties.SensorResolution, value: int) → None ¶

property name¶

property value¶

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property boardSocket¶

property colorOrder¶

property eventFilter¶

property fp16¶

property fps¶

property imageOrientation¶

property initialControl¶

property interleaved¶

property isp3aFps¶

property ispScale¶

property numFramesPoolIsp¶

property numFramesPoolPreview¶

property numFramesPoolRaw¶

property numFramesPoolStill¶

property numFramesPoolVideo¶

property previewHeight¶

property previewKeepAspectRatio¶

property previewWidth¶

property resolution¶

property sensorCropX¶

property sensorCropY¶

property stillHeight¶

property stillWidth¶

property videoHeight¶

property videoWidth¶

class depthai.Colormap¶

Bases: pybind11_builtins.pybind11_object

Members:

NONE

JET

TURBO

STEREO_JET

STEREO_TURBO

Attributes:

`JET`
`NONE`
`STEREO_JET`
`STEREO_TURBO`
`TURBO`
`name`
`value`

Methods:

__init__(self, value)

JET = <Colormap.JET: 2>¶

NONE = <Colormap.NONE: 0>¶

STEREO_JET = <Colormap.STEREO_JET: 4>¶

STEREO_TURBO = <Colormap.STEREO_TURBO: 3>¶

TURBO = <Colormap.TURBO: 1>¶

__init__(self: depthai.Colormap, value: int) → None ¶

property name¶

property value¶

class depthai.CpuUsage¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`average`
`msTime`

__init__(self: depthai.CpuUsage) → None ¶

property average¶

property msTime¶

class depthai.CrashDump¶

Bases: pybind11_builtins.pybind11_object

Classes:

CrashReport

Methods:

`__init__`(self)
`serializeToJson`(self)

Attributes:

`crashReports`
`depthaiCommitHash`
`deviceId`

class CrashReport¶

Bases: pybind11_builtins.pybind11_object

Classes:

`ErrorSourceInfo`
`ThreadCallstack`

Methods:

__init__(self)

Attributes:

`crashedThreadId`
`errorSource`
`processor`
`threadCallstack`

class ErrorSourceInfo¶

Bases: pybind11_builtins.pybind11_object

Classes:

`AssertContext`
`TrapContext`

Methods:

__init__(self)

Attributes:

`assertContext`
`errorId`
`trapContext`

class AssertContext¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`fileName`
`functionName`
`line`

__init__(self: depthai.CrashDump.CrashReport.ErrorSourceInfo.AssertContext) → None ¶

property fileName¶

property functionName¶

property line¶

class TrapContext¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`trapAddress`
`trapName`
`trapNumber`

__init__(self: depthai.CrashDump.CrashReport.ErrorSourceInfo.TrapContext) → None ¶

property trapAddress¶

property trapName¶

property trapNumber¶

__init__(self: depthai.CrashDump.CrashReport.ErrorSourceInfo) → None ¶

property assertContext¶

property errorId¶

property trapContext¶

class ThreadCallstack¶

Bases: pybind11_builtins.pybind11_object

Classes:

CallstackContext

Methods:

__init__(self)

Attributes:

`callStack`
`instructionPointer`
`stackBottom`
`stackPointer`
`stackTop`
`threadId`
`threadName`
`threadStatus`

class CallstackContext¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`callSite`
`calledTarget`
`context`
`framePointer`

__init__(self: depthai.CrashDump.CrashReport.ThreadCallstack.CallstackContext) → None ¶

property callSite¶

property calledTarget¶

property context¶

property framePointer¶

__init__(self: depthai.CrashDump.CrashReport.ThreadCallstack) → None ¶

property callStack¶

property instructionPointer¶

property stackBottom¶

property stackPointer¶

property stackTop¶

property threadId¶

property threadName¶

property threadStatus¶

__init__(self: depthai.CrashDump.CrashReport) → None ¶

property crashedThreadId¶

property errorSource¶

property processor¶

property threadCallstack¶

__init__(self: depthai.CrashDump) → None ¶

property crashReports¶

property depthaiCommitHash¶

property deviceId¶

serializeToJson(self: depthai.CrashDump) → json¶

class depthai.DataInputQueue¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Initialize self.
`close`(self)
`getBlocking`(self)
`getMaxSize`(self)
`getName`(self)
`isClosed`(self)
`send`(args, *kwargs)	Overloaded function.
`setBlocking`(self, blocking)
`setMaxSize`(self, maxSize)

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

close(self: depthai.DataInputQueue) → None ¶

getBlocking(self: depthai.DataInputQueue) → bool ¶

getMaxSize(self: depthai.DataInputQueue) → int ¶

getName(self: depthai.DataInputQueue) → str ¶

isClosed(self: depthai.DataInputQueue) → bool ¶

send(*args, **kwargs)¶

Overloaded function.

send(self: depthai.DataInputQueue, msg: depthai.ADatatype) -> None
send(self: depthai.DataInputQueue, rawMsg: depthai.RawBuffer) -> None

setBlocking(self: depthai.DataInputQueue, blocking: bool) → None ¶

setMaxSize(self: depthai.DataInputQueue, maxSize: int) → None ¶

class depthai.DataOutputQueue¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Initialize self.
`addCallback`(args, *kwargs)	Overloaded function.
`close`(self)
`get`(self)
`getAll`(self)
`getBlocking`(self)
`getMaxSize`(self)
`getName`(self)
`has`(self)
`isClosed`(self)
`removeCallback`(self, callbackId)
`setBlocking`(self, blocking)
`setMaxSize`(self, maxSize)
`tryGet`(self)
`tryGetAll`(self)

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

addCallback(*args, **kwargs)¶

Overloaded function.

addCallback(self: depthai.DataOutputQueue, callback: Callable) -> int
addCallback(self: depthai.DataOutputQueue, callback: Callable) -> int
addCallback(self: depthai.DataOutputQueue, callback: Callable) -> int

close(self: depthai.DataOutputQueue) → None ¶

get(self: depthai.DataOutputQueue) → depthai.ADatatype ¶

getAll(self: depthai.DataOutputQueue) → list[depthai.ADatatype]¶

getBlocking(self: depthai.DataOutputQueue) → bool ¶

getMaxSize(self: depthai.DataOutputQueue) → int ¶

getName(self: depthai.DataOutputQueue) → str ¶

has(self: depthai.DataOutputQueue) → bool ¶

isClosed(self: depthai.DataOutputQueue) → bool ¶

removeCallback(self: depthai.DataOutputQueue, callbackId: int) → bool ¶

setBlocking(self: depthai.DataOutputQueue, blocking: bool) → None ¶

setMaxSize(self: depthai.DataOutputQueue, maxSize: int) → None ¶

tryGet(self: depthai.DataOutputQueue) → depthai.ADatatype ¶

tryGetAll(self: depthai.DataOutputQueue) → list[depthai.ADatatype]¶

class depthai.DatatypeEnum¶

Bases: pybind11_builtins.pybind11_object

Members:

Buffer

ImgFrame

EncodedFrame

NNData

ImageManipConfig

CameraControl

ImgDetections

SpatialImgDetections

SystemInformation

SpatialLocationCalculatorConfig

SpatialLocationCalculatorData

EdgeDetectorConfig

AprilTagConfig

AprilTags

Tracklets

IMUData

StereoDepthConfig

FeatureTrackerConfig

TrackedFeatures

PointCloudConfig

PointCloudData

Attributes:

Methods:

__init__(self, value)

AprilTagConfig = <DatatypeEnum.AprilTagConfig: 12>¶

AprilTags = <DatatypeEnum.AprilTags: 13>¶

Buffer = <DatatypeEnum.Buffer: 0>¶

CameraControl = <DatatypeEnum.CameraControl: 5>¶

EdgeDetectorConfig = <DatatypeEnum.EdgeDetectorConfig: 11>¶

EncodedFrame = <DatatypeEnum.EncodedFrame: 2>¶

FeatureTrackerConfig = <DatatypeEnum.FeatureTrackerConfig: 17>¶

IMUData = <DatatypeEnum.IMUData: 15>¶

ImageManipConfig = <DatatypeEnum.ImageManipConfig: 4>¶

ImgDetections = <DatatypeEnum.ImgDetections: 6>¶

ImgFrame = <DatatypeEnum.ImgFrame: 1>¶

NNData = <DatatypeEnum.NNData: 3>¶

PointCloudConfig = <DatatypeEnum.PointCloudConfig: 20>¶

PointCloudData = <DatatypeEnum.PointCloudData: 21>¶

SpatialImgDetections = <DatatypeEnum.SpatialImgDetections: 7>¶

SpatialLocationCalculatorConfig = <DatatypeEnum.SpatialLocationCalculatorConfig: 9>¶

SpatialLocationCalculatorData = <DatatypeEnum.SpatialLocationCalculatorData: 10>¶

StereoDepthConfig = <DatatypeEnum.StereoDepthConfig: 16>¶

SystemInformation = <DatatypeEnum.SystemInformation: 8>¶

TrackedFeatures = <DatatypeEnum.TrackedFeatures: 22>¶

Tracklets = <DatatypeEnum.Tracklets: 14>¶

__init__(self: depthai.DatatypeEnum, value: int) → None ¶

property name¶

property value¶

class depthai.DetectionNetworkProperties¶

Bases: depthai.NeuralNetworkProperties

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

parser

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property parser¶

class depthai.DetectionNetworkType¶

Bases: pybind11_builtins.pybind11_object

Members:

YOLO

MOBILENET

Attributes:

`MOBILENET`
`YOLO`
`name`
`value`

Methods:

__init__(self, value)

MOBILENET = <DetectionNetworkType.MOBILENET: 1>¶

YOLO = <DetectionNetworkType.YOLO: 0>¶

__init__(self: depthai.DetectionNetworkType, value: int) → None ¶

property name¶

property value¶

class depthai.DetectionParserOptions¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`anchorMasks`
`anchors`
`classes`
`confidenceThreshold`
`coordinates`
`iouThreshold`
`nnFamily`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property anchorMasks¶

property anchors¶

property classes¶

property confidenceThreshold¶

property coordinates¶

property iouThreshold¶

property nnFamily¶

class depthai.DetectionParserProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

parser

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property parser¶

class depthai.Device¶

Bases: depthai.DeviceBase

Classes:

Config

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`getInputQueue`(args, *kwargs)	Overloaded function.
`getInputQueueNames`(self)
`getOutputQueue`(args, *kwargs)	Overloaded function.
`getOutputQueueNames`(self)
`getQueueEvent`(args, *kwargs)	Overloaded function.
`getQueueEvents`(args, *kwargs)	Overloaded function.

class Config¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`board`
`logLevel`
`nonExclusiveMode`
`outputLogLevel`
`version`

__init__(self: depthai.Device.Config) → None ¶

property board¶

property logLevel¶

property nonExclusiveMode¶

property outputLogLevel¶

property version¶

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.Device, pipeline: depthai.Pipeline) -> None
__init__(self: depthai.Device, pipeline: depthai.Pipeline, usb2Mode: bool) -> None
__init__(self: depthai.Device, pipeline: depthai.Pipeline, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.Device, pipeline: depthai.Pipeline, pathToCmd: Path) -> None
__init__(self: depthai.Device, pipeline: depthai.Pipeline, devInfo: depthai.DeviceInfo, usb2Mode: bool = False) -> None
__init__(self: depthai.Device, pipeline: depthai.Pipeline, deviceInfo: depthai.DeviceInfo, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.Device, pipeline: depthai.Pipeline, devInfo: depthai.DeviceInfo, pathToCmd: Path) -> None
__init__(self: depthai.Device, pipeline: depthai.Pipeline, deviceInfo: depthai.DeviceInfo) -> None
__init__(self: depthai.Device, version: depthai.OpenVINO.Version = <Version.???: 7>) -> None
__init__(self: depthai.Device, version: depthai.OpenVINO.Version, usb2Mode: bool = False) -> None
__init__(self: depthai.Device, version: depthai.OpenVINO.Version, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.Device, version: depthai.OpenVINO.Version, pathToCmd: Path) -> None
__init__(self: depthai.Device, version: depthai.OpenVINO.Version, deviceInfo: depthai.DeviceInfo, usb2Mode: bool = False) -> None
__init__(self: depthai.Device, version: depthai.OpenVINO.Version, deviceInfo: depthai.DeviceInfo, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.Device, version: depthai.OpenVINO.Version, deviceDesc: depthai.DeviceInfo, pathToCmd: Path) -> None
__init__(self: depthai.Device, config: depthai.Device.Config) -> None
__init__(self: depthai.Device, config: depthai.Device.Config, deviceInfo: depthai.DeviceInfo) -> None
__init__(self: depthai.Device, deviceInfo: depthai.DeviceInfo) -> None
__init__(self: depthai.Device, deviceInfo: depthai.DeviceInfo, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.Device, nameOrDeviceId: str) -> None
__init__(self: depthai.Device, nameOrDeviceId: str, maxUsbSpeed: depthai.UsbSpeed) -> None

getInputQueue(*args, **kwargs)¶

Overloaded function.

getInputQueue(self: depthai.Device, name: str) -> depthai.DataInputQueue
getInputQueue(self: depthai.Device, name: str, maxSize: int, blocking: bool = True) -> depthai.DataInputQueue

getInputQueueNames(self: depthai.Device) → list[str]¶

getOutputQueue(*args, **kwargs)¶

Overloaded function.

getOutputQueue(self: depthai.Device, name: str) -> depthai.DataOutputQueue
getOutputQueue(self: depthai.Device, name: str, maxSize: int, blocking: bool = True) -> depthai.DataOutputQueue

getOutputQueueNames(self: depthai.Device) → list[str]¶

getQueueEvent(*args, **kwargs)¶

Overloaded function.

getQueueEvent(self: depthai.Device, queueNames: list[str], timeout: datetime.timedelta = datetime.timedelta(days=-1, seconds=86399, microseconds=999999)) -> str
getQueueEvent(self: depthai.Device, queueName: str, timeout: datetime.timedelta = datetime.timedelta(days=-1, seconds=86399, microseconds=999999)) -> str
getQueueEvent(self: depthai.Device, timeout: datetime.timedelta = datetime.timedelta(days=-1, seconds=86399, microseconds=999999)) -> str

getQueueEvents(*args, **kwargs)¶

Overloaded function.

getQueueEvents(self: depthai.Device, queueNames: list[str], maxNumEvents: int = 18446744073709551615, timeout: datetime.timedelta = datetime.timedelta(days=-1, seconds=86399, microseconds=999999)) -> list[str]
getQueueEvents(self: depthai.Device, queueName: str, maxNumEvents: int = 18446744073709551615, timeout: datetime.timedelta = datetime.timedelta(days=-1, seconds=86399, microseconds=999999)) -> list[str]
getQueueEvents(self: depthai.Device, maxNumEvents: int = 18446744073709551615, timeout: datetime.timedelta = datetime.timedelta(days=-1, seconds=86399, microseconds=999999)) -> list[str]

class depthai.DeviceBase¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`addLogCallback`(self, callback, None])
`close`(self)	Closes the connection to device.
`factoryResetCalibration`(self)
`flashCalibration`(self, calibrationDataHandler)
`flashCalibration2`(self, arg0)
`flashEepromClear`(self)
`flashFactoryCalibration`(self, arg0)
`flashFactoryEepromClear`(self)
`getAllAvailableDevices`()
`getAllConnectedDevices`()
`getAnyAvailableDevice`(args, *kwargs)	Overloaded function.
`getAvailableStereoPairs`(self)
`getBootloaderVersion`(self)
`getCameraSensorNames`(self)
`getChipTemperature`(self)
`getCmxMemoryUsage`(self)
`getConnectedCameraFeatures`(self)
`getConnectedCameras`(self)
`getConnectedIMU`(self)
`getConnectionInterfaces`(self)
`getCrashDump`(self, clearCrashDump)
`getDdrMemoryUsage`(self)
`getDeviceByMxId`(mxId)
`getDeviceInfo`(self)
`getDeviceName`(self)
`getEmbeddedDeviceBinary`(args, *kwargs)	Overloaded function.
`getEmbeddedIMUFirmwareVersion`(self)
`getFirstAvailableDevice`(skipInvalidDevices)
`getGlobalProfilingData`()
`getIMUFirmwareUpdateStatus`(self)
`getIMUFirmwareVersion`(self)
`getIrDrivers`(self)
`getLeonCssCpuUsage`(self)
`getLeonCssHeapUsage`(self)
`getLeonMssCpuUsage`(self)
`getLeonMssHeapUsage`(self)
`getLogLevel`(self)
`getLogOutputLevel`(self)
`getMxId`(self)
`getProductName`(self)
`getProfilingData`(self)
`getStereoPairs`(self)
`getSystemInformationLoggingRate`(self)
`getUsbSpeed`(self)
`getXLinkChunkSize`(self)
`hasCrashDump`(self)
`isClosed`(self)
`isEepromAvailable`(self)
`isPipelineRunning`(self)
`readCalibration`(self)
`readCalibration2`(self)
`readCalibrationOrDefault`(self)
`readCalibrationRaw`(self)
`readFactoryCalibration`(self)
`readFactoryCalibrationOrDefault`(self)
`readFactoryCalibrationRaw`(self)
`removeLogCallback`(self, callbackId)
`setIrFloodLightBrightness`(self, mA, mask)
`setIrFloodLightIntensity`(self, intensity, mask)
`setIrLaserDotProjectorBrightness`(self, mA, mask)
`setIrLaserDotProjectorIntensity`(self, …)
`setLogLevel`(self, level)
`setLogOutputLevel`(self, level)
`setSystemInformationLoggingRate`(self, rateHz)
`setTimesync`(args, *kwargs)	Overloaded function.
`setXLinkChunkSize`(self, sizeBytes)
`startIMUFirmwareUpdate`(self, forceUpdate)
`startPipeline`(args, *kwargs)	Overloaded function.

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline) -> None
__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline, usb2Mode: bool) -> None
__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline, pathToCmd: Path) -> None
__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline, devInfo: depthai.DeviceInfo, usb2Mode: bool = False) -> None
__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline, deviceInfo: depthai.DeviceInfo, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline, devInfo: depthai.DeviceInfo, pathToCmd: Path) -> None
__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline, deviceInfo: depthai.DeviceInfo) -> None
__init__(self: depthai.DeviceBase, version: depthai.OpenVINO.Version = <Version.???: 7>) -> None
__init__(self: depthai.DeviceBase, version: depthai.OpenVINO.Version, usb2Mode: bool = False) -> None
__init__(self: depthai.DeviceBase, version: depthai.OpenVINO.Version, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.DeviceBase, version: depthai.OpenVINO.Version, pathToCmd: Path) -> None
__init__(self: depthai.DeviceBase, version: depthai.OpenVINO.Version, deviceInfo: depthai.DeviceInfo, usb2Mode: bool = False) -> None
__init__(self: depthai.DeviceBase, version: depthai.OpenVINO.Version, deviceInfo: depthai.DeviceInfo, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.DeviceBase, version: depthai.OpenVINO.Version, deviceDesc: depthai.DeviceInfo, pathToCmd: Path) -> None
__init__(self: depthai.DeviceBase, config: depthai.Device.Config) -> None
__init__(self: depthai.DeviceBase, config: depthai.Device.Config, deviceInfo: depthai.DeviceInfo) -> None
__init__(self: depthai.DeviceBase, deviceInfo: depthai.DeviceInfo) -> None
__init__(self: depthai.DeviceBase, deviceInfo: depthai.DeviceInfo, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.DeviceBase, nameOrDeviceId: str) -> None
__init__(self: depthai.DeviceBase, nameOrDeviceId: str, maxUsbSpeed: depthai.UsbSpeed) -> None

addLogCallback(self: depthai.DeviceBase, callback: Callable[[depthai.LogMessage], None]) → int ¶

close(self: depthai.DeviceBase) → None ¶: Closes the connection to device. Better alternative is the usage of context manager: with depthai.Device(pipeline) as device:

factoryResetCalibration(self: depthai.DeviceBase) → None ¶

flashCalibration(self: depthai.DeviceBase, calibrationDataHandler: depthai.CalibrationHandler) → bool ¶

flashCalibration2(self: depthai.DeviceBase, arg0: depthai.CalibrationHandler) → None ¶

flashEepromClear(self: depthai.DeviceBase) → None ¶

flashFactoryCalibration(self: depthai.DeviceBase, arg0: depthai.CalibrationHandler) → None ¶

flashFactoryEepromClear(self: depthai.DeviceBase) → None ¶

static getAllAvailableDevices() → list[depthai.DeviceInfo]¶

static getAllConnectedDevices() → list[depthai.DeviceInfo]¶

static getAnyAvailableDevice(*args, **kwargs)¶

Overloaded function.

getAnyAvailableDevice(timeout: datetime.timedelta) -> tuple[bool, depthai.DeviceInfo]
getAnyAvailableDevice() -> tuple[bool, depthai.DeviceInfo]

getAvailableStereoPairs(self: depthai.DeviceBase) → list[depthai.StereoPair]¶

getBootloaderVersion(self: depthai.DeviceBase) → Optional[depthai.Version]¶

getCameraSensorNames(self: depthai.DeviceBase) → dict[depthai.CameraBoardSocket, str]¶

getChipTemperature(self: depthai.DeviceBase) → depthai.ChipTemperature ¶

getCmxMemoryUsage(self: depthai.DeviceBase) → depthai.MemoryInfo ¶

getConnectedCameraFeatures(self: depthai.DeviceBase) → list[depthai.CameraFeatures]¶

getConnectedCameras(self: depthai.DeviceBase) → list[depthai.CameraBoardSocket]¶

getConnectedIMU(self: depthai.DeviceBase) → str ¶

getConnectionInterfaces(self: depthai.DeviceBase) → list[depthai.connectionInterface]¶

getCrashDump(self: depthai.DeviceBase, clearCrashDump: bool = True) → depthai.CrashDump ¶

getDdrMemoryUsage(self: depthai.DeviceBase) → depthai.MemoryInfo ¶

static getDeviceByMxId(mxId: str) → tuple[bool, depthai.DeviceInfo]¶

getDeviceInfo(self: depthai.DeviceBase) → depthai.DeviceInfo ¶

getDeviceName(self: depthai.DeviceBase) → object ¶

static getEmbeddedDeviceBinary(*args, **kwargs)¶

Overloaded function.

getEmbeddedDeviceBinary(usb2Mode: bool, version: depthai.OpenVINO.Version = <Version.???: 7>) -> list[int]
getEmbeddedDeviceBinary(config: depthai.Device.Config) -> list[int]

getEmbeddedIMUFirmwareVersion(self: depthai.DeviceBase) → depthai.Version ¶

static getFirstAvailableDevice(skipInvalidDevices: bool = True) → tuple[bool, depthai.DeviceInfo]¶

static getGlobalProfilingData() → depthai.ProfilingData ¶

getIMUFirmwareUpdateStatus(self: depthai.DeviceBase) → tuple[bool, int]¶

getIMUFirmwareVersion(self: depthai.DeviceBase) → depthai.Version ¶

getIrDrivers(self: depthai.DeviceBase) → list[tuple[str, int, int]]¶

getLeonCssCpuUsage(self: depthai.DeviceBase) → depthai.CpuUsage ¶

getLeonCssHeapUsage(self: depthai.DeviceBase) → depthai.MemoryInfo ¶

getLeonMssCpuUsage(self: depthai.DeviceBase) → depthai.CpuUsage ¶

getLeonMssHeapUsage(self: depthai.DeviceBase) → depthai.MemoryInfo ¶

getLogLevel(self: depthai.DeviceBase) → depthai.LogLevel ¶

getLogOutputLevel(self: depthai.DeviceBase) → depthai.LogLevel ¶

getMxId(self: depthai.DeviceBase) → str ¶

getProductName(self: depthai.DeviceBase) → object ¶

getProfilingData(self: depthai.DeviceBase) → depthai.ProfilingData ¶

getStereoPairs(self: depthai.DeviceBase) → list[depthai.StereoPair]¶

getSystemInformationLoggingRate(self: depthai.DeviceBase) → float ¶

getUsbSpeed(self: depthai.DeviceBase) → depthai.UsbSpeed ¶

getXLinkChunkSize(self: depthai.DeviceBase) → int ¶

hasCrashDump(self: depthai.DeviceBase) → bool ¶

isClosed(self: depthai.DeviceBase) → bool ¶

isEepromAvailable(self: depthai.DeviceBase) → bool ¶

isPipelineRunning(self: depthai.DeviceBase) → bool ¶

readCalibration(self: depthai.DeviceBase) → depthai.CalibrationHandler ¶

readCalibration2(self: depthai.DeviceBase) → depthai.CalibrationHandler ¶

readCalibrationOrDefault(self: depthai.DeviceBase) → depthai.CalibrationHandler ¶

readCalibrationRaw(self: depthai.DeviceBase) → list[int]¶

readFactoryCalibration(self: depthai.DeviceBase) → depthai.CalibrationHandler ¶

readFactoryCalibrationOrDefault(self: depthai.DeviceBase) → depthai.CalibrationHandler ¶

readFactoryCalibrationRaw(self: depthai.DeviceBase) → list[int]¶

removeLogCallback(self: depthai.DeviceBase, callbackId: int) → bool ¶

setIrFloodLightBrightness(self: depthai.DeviceBase, mA: float, mask: int = - 1) → bool ¶

setIrFloodLightIntensity(self: depthai.DeviceBase, intensity: float, mask: int = - 1) → bool ¶

setIrLaserDotProjectorBrightness(self: depthai.DeviceBase, mA: float, mask: int = - 1) → bool ¶

setIrLaserDotProjectorIntensity(self: depthai.DeviceBase, intensity: float, mask: int = - 1) → bool ¶

setLogLevel(self: depthai.DeviceBase, level: depthai.LogLevel) → None ¶

setLogOutputLevel(self: depthai.DeviceBase, level: depthai.LogLevel) → None ¶

setSystemInformationLoggingRate(self: depthai.DeviceBase, rateHz: float) → None ¶

setTimesync(*args, **kwargs)¶

Overloaded function.

setTimesync(self: depthai.DeviceBase, arg0: datetime.timedelta, arg1: int, arg2: bool) -> None
setTimesync(self: depthai.DeviceBase, enable: bool) -> None

setXLinkChunkSize(self: depthai.DeviceBase, sizeBytes: int) → None ¶

startIMUFirmwareUpdate(self: depthai.DeviceBase, forceUpdate: bool = False) → bool ¶

startPipeline(*args, **kwargs)¶

Overloaded function.

startPipeline(self: depthai.DeviceBase) -> None
startPipeline(self: depthai.DeviceBase, arg0: depthai.Pipeline) -> bool

class depthai.DeviceBootloader¶

Bases: pybind11_builtins.pybind11_object

Classes:

`ApplicationInfo`
`Config`
`Memory`	Members:
`MemoryInfo`
`NetworkConfig`
`Section`	Members:
`Type`	Members:
`UsbConfig`

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`bootMemory`(self, fw)
`bootUsbRomBootloader`(self)
`close`(self)	Closes the connection to device.
`createDepthaiApplicationPackage`(args, *kwargs)	Overloaded function.
`flash`(args, *kwargs)	Overloaded function.
`flashBootHeader`(self, memory, frequency, …)
`flashBootloader`(args, *kwargs)	Overloaded function.
`flashClear`(self, memory)
`flashConfig`(self, config, memory, type)
`flashConfigClear`(self, memory, type)
`flashConfigData`(self, configData, memory, type)
`flashConfigFile`(self, configData, memory, type)
`flashCustom`(args, *kwargs)	Overloaded function.
`flashDepthaiApplicationPackage`(args, *kwargs)	Overloaded function.
`flashFastBootHeader`(self, memory, frequency, …)
`flashGpioModeBootHeader`(self, memory, mode)
`flashUsbRecoveryBootHeader`(self, memory)
`flashUserBootloader`(self, progressCallback, …)
`getAllAvailableDevices`()
`getEmbeddedBootloaderBinary`(arg0)
`getEmbeddedBootloaderVersion`()
`getFirstAvailableDevice`()
`getFlashedVersion`(self)
`getMemoryInfo`(self, arg0)
`getType`(self)
`getVersion`(self)
`isAllowedFlashingBootloader`(self)
`isEmbeddedVersion`(self)
`isUserBootloader`(self)
`isUserBootloaderSupported`(self)
`readApplicationInfo`(self, memory)
`readConfig`(self, memory, type)
`readConfigData`(self, memory, type)
`readCustom`(args, *kwargs)	Overloaded function.
`saveDepthaiApplicationPackage`(args, *kwargs)	Overloaded function.

class ApplicationInfo¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`applicationName`
`firmwareVersion`
`hasApplication`

__init__(self: depthai.DeviceBootloader.ApplicationInfo) → None ¶

property applicationName¶

property firmwareVersion¶

property hasApplication¶

class Config¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(self)
`fromJson`(self)
`getDnsAltIPv4`(self)
`getDnsIPv4`(self)
`getIPv4`(self)
`getIPv4Gateway`(self)
`getIPv4Mask`(self)
`getMacAddress`(self)
`getNetworkTimeout`(self)
`getUsbMaxSpeed`(self)
`getUsbTimeout`(self)
`isStaticIPV4`(self)
`setDnsIPv4`(self, arg0, arg1)
`setDynamicIPv4`(self, arg0, arg1, arg2)
`setMacAddress`(self, arg0)
`setNetworkTimeout`(self, arg0)
`setStaticIPv4`(self, arg0, arg1, arg2)
`setUsbMaxSpeed`(self, arg0)
`setUsbTimeout`(self, arg0)
`toJson`(self)

Attributes:

`appMem`
`network`
`usb`

__init__(self: depthai.DeviceBootloader.Config) → None ¶

property appMem¶

fromJson(self: json) → depthai.DeviceBootloader.Config ¶

getDnsAltIPv4(self: depthai.DeviceBootloader.Config) → str ¶

getDnsIPv4(self: depthai.DeviceBootloader.Config) → str ¶

getIPv4(self: depthai.DeviceBootloader.Config) → str ¶

getIPv4Gateway(self: depthai.DeviceBootloader.Config) → str ¶

getIPv4Mask(self: depthai.DeviceBootloader.Config) → str ¶

getMacAddress(self: depthai.DeviceBootloader.Config) → str ¶

getNetworkTimeout(self: depthai.DeviceBootloader.Config) → datetime.timedelta ¶

getUsbMaxSpeed(self: depthai.DeviceBootloader.Config) → depthai.UsbSpeed ¶

getUsbTimeout(self: depthai.DeviceBootloader.Config) → datetime.timedelta ¶

isStaticIPV4(self: depthai.DeviceBootloader.Config) → bool ¶

property network¶

setDnsIPv4(self: depthai.DeviceBootloader.Config, arg0: str, arg1: str) → None ¶

setDynamicIPv4(self: depthai.DeviceBootloader.Config, arg0: str, arg1: str, arg2: str) → None ¶

setMacAddress(self: depthai.DeviceBootloader.Config, arg0: str) → None ¶

setNetworkTimeout(self: depthai.DeviceBootloader.Config, arg0: datetime.timedelta) → None ¶

setStaticIPv4(self: depthai.DeviceBootloader.Config, arg0: str, arg1: str, arg2: str) → None ¶

setUsbMaxSpeed(self: depthai.DeviceBootloader.Config, arg0: depthai.UsbSpeed) → None ¶

setUsbTimeout(self: depthai.DeviceBootloader.Config, arg0: datetime.timedelta) → None ¶

toJson(self: depthai.DeviceBootloader.Config) → json¶

property usb¶

class Memory¶

Bases: pybind11_builtins.pybind11_object

Members:

AUTO

FLASH

EMMC

Attributes:

`AUTO`
`EMMC`
`FLASH`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <Memory.AUTO: -1>¶

EMMC = <Memory.EMMC: 1>¶

FLASH = <Memory.FLASH: 0>¶

__init__(self: depthai.DeviceBootloader.Memory, value: int) → None ¶

property name¶

property value¶

class MemoryInfo¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`available`
`info`
`size`

__init__(self: depthai.DeviceBootloader.MemoryInfo) → None ¶

property available¶

property info¶

property size¶

class NetworkConfig¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`ipv4`
`ipv4Dns`
`ipv4DnsAlt`
`ipv4Gateway`
`ipv4Mask`
`ipv6`
`ipv6Dns`
`ipv6DnsAlt`
`ipv6Gateway`
`ipv6Prefix`
`mac`
`staticIpv4`
`staticIpv6`
`timeoutMs`

__init__(self: depthai.DeviceBootloader.NetworkConfig) → None ¶

property ipv4¶

property ipv4Dns¶

property ipv4DnsAlt¶

property ipv4Gateway¶

property ipv4Mask¶

property ipv6¶

property ipv6Dns¶

property ipv6DnsAlt¶

property ipv6Gateway¶

property ipv6Prefix¶

property mac¶

property staticIpv4¶

property staticIpv6¶

property timeoutMs¶

class Section¶

Bases: pybind11_builtins.pybind11_object

Members:

AUTO

HEADER

BOOTLOADER

BOOTLOADER_CONFIG

APPLICATION

Attributes:

`APPLICATION`
`AUTO`
`BOOTLOADER`
`BOOTLOADER_CONFIG`
`HEADER`
`name`
`value`

Methods:

__init__(self, value)

APPLICATION = <Section.APPLICATION: 3>¶

AUTO = <Section.AUTO: -1>¶

BOOTLOADER = <Section.BOOTLOADER: 1>¶

BOOTLOADER_CONFIG = <Section.BOOTLOADER_CONFIG: 2>¶

HEADER = <Section.HEADER: 0>¶

__init__(self: depthai.DeviceBootloader.Section, value: int) → None ¶

property name¶

property value¶

class Type¶

Bases: pybind11_builtins.pybind11_object

Members:

AUTO

USB

NETWORK

Attributes:

`AUTO`
`NETWORK`
`USB`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <Type.AUTO: -1>¶

NETWORK = <Type.NETWORK: 1>¶

USB = <Type.USB: 0>¶

__init__(self: depthai.DeviceBootloader.Type, value: int) → None ¶

property name¶

property value¶

class UsbConfig¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`maxUsbSpeed`
`pid`
`timeoutMs`
`vid`

__init__(self: depthai.DeviceBootloader.UsbConfig) → None ¶

property maxUsbSpeed¶

property pid¶

property timeoutMs¶

property vid¶

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.DeviceBootloader, devInfo: depthai.DeviceInfo, allowFlashingBootloader: bool = False) -> None
__init__(self: depthai.DeviceBootloader, devInfo: depthai.DeviceInfo, pathToCmd: Path, allowFlashingBootloader: bool = False) -> None
__init__(self: depthai.DeviceBootloader, nameOrDeviceId: str, allowFlashingBootloader: bool = False) -> None

bootMemory(self: depthai.DeviceBootloader, fw: list[int]) → None ¶

bootUsbRomBootloader(self: depthai.DeviceBootloader) → None ¶

close(self: depthai.DeviceBootloader) → None ¶: Closes the connection to device. Better alternative is the usage of context manager: with depthai.DeviceBootloader(deviceInfo) as bootloader:

static createDepthaiApplicationPackage(*args, **kwargs)¶

Overloaded function.

createDepthaiApplicationPackage(pipeline: depthai.Pipeline, pathToCmd: Path = ‘’, compress: bool = False, applicationName: str = ‘’, checkChecksum: bool = False) -> list[int]
createDepthaiApplicationPackage(pipeline: depthai.Pipeline, compress: bool, applicationName: str = ‘’, checkChecksum: bool = False) -> list[int]

flash(*args, **kwargs)¶

Overloaded function.

flash(self: depthai.DeviceBootloader, progressCallback: Callable[[float], None], pipeline: depthai.Pipeline, compress: bool = False, applicationName: str = ‘’, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, checkChecksum: bool = False) -> tuple[bool, str]
flash(self: depthai.DeviceBootloader, pipeline: depthai.Pipeline, compress: bool = False, applicationName: str = ‘’, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, checkChecksum: bool = False) -> tuple[bool, str]

flashBootHeader(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, frequency: int = - 1, location: int = - 1, dummyCycles: int = - 1, offset: int = - 1) → tuple[bool, str]¶

flashBootloader(*args, **kwargs)¶

Overloaded function.

flashBootloader(self: depthai.DeviceBootloader, progressCallback: Callable[[float], None], path: Path = ‘’) -> tuple[bool, str]
flashBootloader(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, type: depthai.DeviceBootloader.Type, progressCallback: Callable[[float], None], path: Path = ‘’) -> tuple[bool, str]

flashClear(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>) → tuple[bool, str]¶

flashConfig(self: depthai.DeviceBootloader, config: depthai.DeviceBootloader.Config, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, type: depthai.DeviceBootloader.Type = <Type.AUTO: -1>) → tuple[bool, str]¶

flashConfigClear(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, type: depthai.DeviceBootloader.Type = <Type.AUTO: -1>) → tuple[bool, str]¶

flashConfigData(self: depthai.DeviceBootloader, configData: json, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, type: depthai.DeviceBootloader.Type = <Type.AUTO: -1>) → tuple[bool, str]¶

flashConfigFile(self: depthai.DeviceBootloader, configData: Path, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, type: depthai.DeviceBootloader.Type = <Type.AUTO: -1>) → tuple[bool, str]¶

flashCustom(*args, **kwargs)¶

Overloaded function.

flashCustom(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, offset: int, data: list[int], progressCallback: Callable[[float], None] = None) -> tuple[bool, str]
flashCustom(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, offset: int, filename: str, progressCallback: Callable[[float], None] = None) -> tuple[bool, str]

flashDepthaiApplicationPackage(*args, **kwargs)¶

Overloaded function.

flashDepthaiApplicationPackage(self: depthai.DeviceBootloader, progressCallback: Callable[[float], None], package: list[int], memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>) -> tuple[bool, str]
flashDepthaiApplicationPackage(self: depthai.DeviceBootloader, package: list[int], memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>) -> tuple[bool, str]

flashFastBootHeader(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, frequency: int = - 1, location: int = - 1, dummyCycles: int = - 1, offset: int = - 1) → tuple[bool, str]¶

flashGpioModeBootHeader(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, mode: int) → tuple[bool, str]¶

flashUsbRecoveryBootHeader(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory) → tuple[bool, str]¶

flashUserBootloader(self: depthai.DeviceBootloader, progressCallback: Callable[[float], None], path: Path = '') → tuple[bool, str]¶

static getAllAvailableDevices() → list[depthai.DeviceInfo]¶

static getEmbeddedBootloaderBinary(arg0: depthai.DeviceBootloader.Type) → list[int]¶

static getEmbeddedBootloaderVersion() → depthai.Version ¶

static getFirstAvailableDevice() → tuple[bool, depthai.DeviceInfo]¶

getFlashedVersion(self: depthai.DeviceBootloader) → Optional[depthai.Version]¶

getMemoryInfo(self: depthai.DeviceBootloader, arg0: depthai.DeviceBootloader.Memory) → depthai.DeviceBootloader.MemoryInfo ¶

getType(self: depthai.DeviceBootloader) → depthai.DeviceBootloader.Type ¶

getVersion(self: depthai.DeviceBootloader) → depthai.Version ¶

isAllowedFlashingBootloader(self: depthai.DeviceBootloader) → bool ¶

isEmbeddedVersion(self: depthai.DeviceBootloader) → bool ¶

isUserBootloader(self: depthai.DeviceBootloader) → bool ¶

isUserBootloaderSupported(self: depthai.DeviceBootloader) → bool ¶

readApplicationInfo(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory) → depthai.DeviceBootloader.ApplicationInfo ¶

readConfig(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, type: depthai.DeviceBootloader.Type = <Type.AUTO: -1>) → depthai.DeviceBootloader.Config ¶

readConfigData(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, type: depthai.DeviceBootloader.Type = <Type.AUTO: -1>) → json¶

readCustom(*args, **kwargs)¶

Overloaded function.

readCustom(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, offset: int, size: int, filename: str, progressCallback: Callable[[float], None] = None) -> tuple[bool, str]
readCustom(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, offset: int, size: int, progressCallback: Callable[[float], None] = None) -> tuple[bool, str, list[int]]

static saveDepthaiApplicationPackage(*args, **kwargs)¶

Overloaded function.

saveDepthaiApplicationPackage(path: Path, pipeline: depthai.Pipeline, pathToCmd: Path = ‘’, compress: bool = False, applicationName: str = ‘’, checkChecksum: bool = False) -> None
saveDepthaiApplicationPackage(path: Path, pipeline: depthai.Pipeline, compress: bool, applicationName: str = ‘’, checkChecksum: bool = False) -> None

class depthai.DeviceDesc¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`mxid`
`name`
`platform`
`protocol`
`state`
`status`

__init__(self: depthai.DeviceDesc) → None ¶

property mxid¶

property name¶

property platform¶

property protocol¶

property state¶

property status¶

class depthai.DeviceInfo¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`getMxId`(self)
`getXLinkDeviceDesc`(self)

Attributes:

`desc`
`mxid`
`name`
`platform`
`protocol`
`state`
`status`

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.DeviceInfo) -> None
__init__(self: depthai.DeviceInfo, name: str, mxid: str, state: depthai.XLinkDeviceState, protocol: depthai.XLinkProtocol, platform: depthai.XLinkPlatform, status: depthai.XLinkError_t) -> None
__init__(self: depthai.DeviceInfo, mxidOrName: str) -> None
__init__(self: depthai.DeviceInfo, arg0: depthai.DeviceDesc) -> None

property desc¶

getMxId(self: depthai.DeviceInfo) → str ¶

getXLinkDeviceDesc(self: depthai.DeviceInfo) → depthai.DeviceDesc ¶

property mxid¶

property name¶

property platform¶

property protocol¶

property state¶

property status¶

class depthai.EdgeDetectorConfig¶

Bases: depthai.Buffer

Methods:

`__init__`(self)
`get`(self)
`getConfigData`(self)
`set`(self, config)
`setSobelFilterKernels`(self, …)

__init__(self: depthai.EdgeDetectorConfig) → None ¶

get(self: depthai.EdgeDetectorConfig) → depthai.RawEdgeDetectorConfig ¶

getConfigData(self: depthai.EdgeDetectorConfig) → depthai.EdgeDetectorConfigData ¶

set(self: depthai.EdgeDetectorConfig, config: depthai.RawEdgeDetectorConfig) → depthai.EdgeDetectorConfig ¶

setSobelFilterKernels(self: depthai.EdgeDetectorConfig, horizontalKernel: list[list[int]], verticalKernel: list[list[int]]) → None ¶

class depthai.EdgeDetectorConfigData¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`sobelFilterHorizontalKernel`
`sobelFilterVerticalKernel`

__init__(self: depthai.EdgeDetectorConfigData) → None ¶

property sobelFilterHorizontalKernel¶

property sobelFilterVerticalKernel¶

class depthai.EdgeDetectorProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`initialConfig`
`numFramesPool`
`outputFrameSize`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property initialConfig¶

property numFramesPool¶

property outputFrameSize¶

class depthai.EepromData¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`batchName`
`batchTime`
`boardConf`
`boardCustom`
`boardName`
`boardOptions`
`boardRev`
`cameraData`
`deviceName`
`hardwareConf`
`housingExtrinsics`
`imuExtrinsics`
`miscellaneousData`
`productName`
`stereoEnableDistortionCorrection`
`stereoRectificationData`
`stereoUseSpecTranslation`
`version`
`verticalCameraSocket`

__init__(self: depthai.EepromData) → None ¶

property batchName¶

property batchTime¶

property boardConf¶

property boardCustom¶

property boardName¶

property boardOptions¶

property boardRev¶

property cameraData¶

property deviceName¶

property hardwareConf¶

property housingExtrinsics¶

property imuExtrinsics¶

property miscellaneousData¶

property productName¶

property stereoEnableDistortionCorrection¶

property stereoRectificationData¶

property stereoUseSpecTranslation¶

property version¶

property verticalCameraSocket¶

exception depthai.EepromError¶: Bases: RuntimeError

class depthai.EncodedFrame¶

Bases: depthai.Buffer

Classes:

`FrameType`	Members:
`Profile`	Members:

Methods:

`__init__`(self)
`getBitrate`(self)
`getColorTemperature`(self)
`getExposureTime`(self)
`getFrameType`(self)
`getInstanceNum`(self)
`getLensPosition`(self)
`getLensPositionRaw`(self)
`getLossless`(self)
`getProfile`(self)
`getQuality`(self)
`getSensitivity`(self)
`getSequenceNum`(self)
`getTimestamp`(self)
`getTimestampDevice`(self)
`setBitrate`(self, arg0)
`setFrameType`(self, arg0)
`setLossless`(self, arg0)
`setProfile`(self, arg0)
`setQuality`(self, arg0)
`setSequenceNum`(self, arg0)
`setTimestamp`(self, arg0)
`setTimestampDevice`(self, arg0)

class FrameType¶

Bases: pybind11_builtins.pybind11_object

Members:

I

P

B

Unknown

Attributes:

`B`
`I`
`P`
`Unknown`
`name`
`value`

Methods:

__init__(self, value)

B = <FrameType.B: 2>¶

I = <FrameType.I: 0>¶

P = <FrameType.P: 1>¶

Unknown = <FrameType.Unknown: 3>¶

__init__(self: depthai.RawEncodedFrame.FrameType, value: int) → None ¶

property name¶

property value¶

class Profile¶

Bases: pybind11_builtins.pybind11_object

Members:

JPEG

AVC

HEVC

Attributes:

`AVC`
`HEVC`
`JPEG`
`name`
`value`

Methods:

__init__(self, value)

AVC = <Profile.AVC: 1>¶

HEVC = <Profile.HEVC: 2>¶

JPEG = <Profile.JPEG: 0>¶

__init__(self: depthai.RawEncodedFrame.Profile, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.EncodedFrame) → None ¶

getBitrate(self: depthai.EncodedFrame) → int ¶

getColorTemperature(self: depthai.EncodedFrame) → int ¶

getExposureTime(self: depthai.EncodedFrame) → datetime.timedelta ¶

getFrameType(self: depthai.EncodedFrame) → depthai.RawEncodedFrame.FrameType ¶

getInstanceNum(self: depthai.EncodedFrame) → int ¶

getLensPosition(self: depthai.EncodedFrame) → int ¶

getLensPositionRaw(self: depthai.EncodedFrame) → float ¶

getLossless(self: depthai.EncodedFrame) → bool ¶

getProfile(self: depthai.EncodedFrame) → depthai.RawEncodedFrame.Profile ¶

getQuality(self: depthai.EncodedFrame) → int ¶

getSensitivity(self: depthai.EncodedFrame) → int ¶

getSequenceNum(self: depthai.EncodedFrame) → int ¶

getTimestamp(self: depthai.EncodedFrame) → datetime.timedelta ¶

getTimestampDevice(self: depthai.EncodedFrame) → datetime.timedelta ¶

setBitrate(self: depthai.EncodedFrame, arg0: int) → depthai.EncodedFrame ¶

setFrameType(self: depthai.EncodedFrame, arg0: depthai.RawEncodedFrame.FrameType) → depthai.EncodedFrame ¶

setLossless(self: depthai.EncodedFrame, arg0: bool) → depthai.EncodedFrame ¶

setProfile(self: depthai.EncodedFrame, arg0: depthai.RawEncodedFrame.Profile) → depthai.EncodedFrame ¶

setQuality(self: depthai.EncodedFrame, arg0: int) → depthai.EncodedFrame ¶

setSequenceNum(self: depthai.EncodedFrame, arg0: int) → depthai.EncodedFrame ¶

setTimestamp(self: depthai.EncodedFrame, arg0: datetime.timedelta) → depthai.EncodedFrame ¶

setTimestampDevice(self: depthai.EncodedFrame, arg0: datetime.timedelta) → depthai.EncodedFrame ¶

class depthai.Extrinsics¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`rotationMatrix`
`specTranslation`
`toCameraSocket`
`translation`

__init__(self: depthai.Extrinsics) → None ¶

property rotationMatrix¶

property specTranslation¶

property toCameraSocket¶

property translation¶

class depthai.FeatureTrackerConfig¶

Bases: depthai.Buffer

Classes:

`CornerDetector`
`FeatureMaintainer`
`MotionEstimator`

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`get`(self)
`set`(self, config)
`setCornerDetector`(args, *kwargs)	Overloaded function.
`setFeatureMaintainer`(args, *kwargs)	Overloaded function.
`setHwMotionEstimation`(self)
`setMotionEstimator`(args, *kwargs)	Overloaded function.
`setNumTargetFeatures`(self, numTargetFeatures)
`setOpticalFlow`(args, *kwargs)	Overloaded function.

class CornerDetector¶

Bases: pybind11_builtins.pybind11_object

Classes:

`Thresholds`
`Type`	Members:

Methods:

__init__(self)

Attributes:

`cellGridDimension`
`enableSobel`
`enableSorting`
`numMaxFeatures`
`numTargetFeatures`
`thresholds`
`type`

class Thresholds¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`decreaseFactor`
`increaseFactor`
`initialValue`
`max`
`min`

__init__(self: depthai.RawFeatureTrackerConfig.CornerDetector.Thresholds) → None ¶

property decreaseFactor¶

property increaseFactor¶

property initialValue¶

property max¶

property min¶

class Type¶

Bases: pybind11_builtins.pybind11_object

Members:

HARRIS

SHI_THOMASI

Attributes:

`HARRIS`
`SHI_THOMASI`
`name`
`value`

Methods:

__init__(self, value)

HARRIS = <Type.HARRIS: 0>¶

SHI_THOMASI = <Type.SHI_THOMASI: 1>¶

__init__(self: depthai.RawFeatureTrackerConfig.CornerDetector.Type, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawFeatureTrackerConfig.CornerDetector) → None ¶

property cellGridDimension¶

property enableSobel¶

property enableSorting¶

property numMaxFeatures¶

property numTargetFeatures¶

property thresholds¶

property type¶

class FeatureMaintainer¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`enable`
`lostFeatureErrorThreshold`
`minimumDistanceBetweenFeatures`
`trackedFeatureThreshold`

__init__(self: depthai.RawFeatureTrackerConfig.FeatureMaintainer) → None ¶

property enable¶

property lostFeatureErrorThreshold¶

property minimumDistanceBetweenFeatures¶

property trackedFeatureThreshold¶

class MotionEstimator¶

Bases: pybind11_builtins.pybind11_object

Classes:

`OpticalFlow`
`Type`	Members:

Methods:

__init__(self)

Attributes:

`enable`
`opticalFlow`
`type`

class OpticalFlow¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`epsilon`
`maxIterations`