org.bytedeco.depthai

Class Device

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.depthai.Device

All Implemented Interfaces:

AutoCloseable

@Namespace(value="dai")
 @NoOffset
 @Properties(inherit=depthai.class)
public class Device
extends Pointer

Represents the DepthAI device with the methods to interact with it.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_SYSTEM_INFORMATION_LOGGING_RATE_HZ
static long	EVENT_QUEUE_MAXIMUM_SIZE

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Device()
Device(int version) Connects to any available device with a DEFAULT_SEARCH_TIME timeout.
Device(int version, boolean usb2Mode) Connects to any available device with a DEFAULT_SEARCH_TIME timeout.
Device(int version, BytePointer pathToCmd) Connects to any available device with a DEFAULT_SEARCH_TIME timeout.
Device(int version, DeviceInfo devInfo)
Device(int version, DeviceInfo devInfo, boolean usb2Mode) Connects to device specified by devInfo.
Device(int version, DeviceInfo devInfo, BytePointer pathToCmd) Connects to device specified by devInfo.
Device(int version, DeviceInfo devInfo, String pathToCmd)
Device(int version, String pathToCmd)
Device(Pipeline pipeline) Connects to any available device with a DEFAULT_SEARCH_TIME timeout.
Device(Pipeline pipeline, boolean usb2Mode) Connects to any available device with a DEFAULT_SEARCH_TIME timeout.
Device(Pipeline pipeline, BytePointer pathToCmd) Connects to any available device with a DEFAULT_SEARCH_TIME timeout.
Device(Pipeline pipeline, DeviceInfo devInfo)
Device(Pipeline pipeline, DeviceInfo devInfo, boolean usb2Mode) Connects to device specified by devInfo.
Device(Pipeline pipeline, DeviceInfo devInfo, BytePointer pathToCmd) Connects to device specified by devInfo.
Device(Pipeline pipeline, DeviceInfo devInfo, String pathToCmd)
Device(Pipeline pipeline, String pathToCmd)
Device(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
void	_close() Explicitly closes connection to device.
int	addLogCallback(depthai.LogCallback callback) Add a callback for device logging.
static Pointer	DEFAULT_SEARCH_TIME() Default search time for constructors which discover devices
static float	DEFAULT_SYSTEM_INFORMATION_LOGGING_RATE_HZ() Default rate at which system information is logged
static long	EVENT_QUEUE_MAXIMUM_SIZE() Maximum number of elements in event queue
boolean	flashCalibration(CalibrationHandler calibrationDataHandler) Stores the Calibration and Device information to the Device EEPROM
static DeviceInfo	getAllAvailableDevices() Returns all connected devices
static Pointer	getAnyAvailableDevice() Gets any available device
ChipTemperature	getChipTemperature() Retrieves current chip temperature as measured by device
MemoryInfo	getCmxMemoryUsage() Retrieves current CMX memory information from device
IntPointer	getConnectedCameras() Get cameras that are connected to the device
MemoryInfo	getDdrMemoryUsage() Retrieves current DDR memory information from device
static Pointer	getDeviceByMxId(BytePointer mxId) Finds a device by MX ID.
static Pointer	getDeviceByMxId(String mxId)
DeviceInfo	getDeviceInfo() Get the Device Info object o the device which is currently running
static BytePointer	getEmbeddedDeviceBinary(boolean usb2Mode)
static BytePointer	getEmbeddedDeviceBinary(boolean usb2Mode, int version) Gets device firmware binary for a specific OpenVINO version
static Pointer	getFirstAvailableDevice() Gets first available device.
DataInputQueue	getInputQueue(BytePointer name) Gets an input queue corresponding to stream name.
DataInputQueue	getInputQueue(BytePointer name, int maxSize)
DataInputQueue	getInputQueue(BytePointer name, int maxSize, boolean blocking) Gets an input queue corresponding to stream name.
DataInputQueue	getInputQueue(String name)
DataInputQueue	getInputQueue(String name, int maxSize)
DataInputQueue	getInputQueue(String name, int maxSize, boolean blocking)
StringVector	getInputQueueNames() Get all available input queue names
CpuUsage	getLeonCssCpuUsage() Retrieves average CSS Leon CPU usage
MemoryInfo	getLeonCssHeapUsage() Retrieves current CSS Leon CPU heap information from device
CpuUsage	getLeonMssCpuUsage() Retrieves average MSS Leon CPU usage
MemoryInfo	getLeonMssHeapUsage() Retrieves current MSS Leon CPU heap information from device
depthai.LogLevel	getLogLevel() Gets current logging severity level of the device.
depthai.LogLevel	getLogOutputLevel() Gets logging level which decides printing level to standard output.
BytePointer	getMxId() Get MxId of device
DataOutputQueue	getOutputQueue(BytePointer name) Gets an output queue corresponding to stream name.
DataOutputQueue	getOutputQueue(BytePointer name, int maxSize)
DataOutputQueue	getOutputQueue(BytePointer name, int maxSize, boolean blocking) Gets a queue corresponding to stream name, if it exists, otherwise it throws.
DataOutputQueue	getOutputQueue(String name)
DataOutputQueue	getOutputQueue(String name, int maxSize)
DataOutputQueue	getOutputQueue(String name, int maxSize, boolean blocking)
StringVector	getOutputQueueNames() Get all available output queue names
BytePointer	getQueueEvent()
BytePointer	getQueueEvent(BytePointer queueName)
BytePointer	getQueueEvent(BytePointer queueName, Pointer timeout) Gets or waits until specified queue has received a message
BytePointer	getQueueEvent(Pointer timeout) Gets or waits until any queue has received a message
String	getQueueEvent(String queueName)
String	getQueueEvent(String queueName, Pointer timeout)
BytePointer	getQueueEvent(StringVector queueNames)
BytePointer	getQueueEvent(StringVector queueNames, Pointer timeout) Gets or waits until any of specified queues has received a message
StringVector	getQueueEvents()
StringVector	getQueueEvents(BytePointer queueName)
StringVector	getQueueEvents(BytePointer queueName, long maxNumEvents, Pointer timeout) Gets or waits until specified queue has received a message
StringVector	getQueueEvents(long maxNumEvents, Pointer timeout) Gets or waits until any any queue has received a message
StringVector	getQueueEvents(String queueName)
StringVector	getQueueEvents(String queueName, long maxNumEvents, Pointer timeout)
StringVector	getQueueEvents(StringVector queueNames)
StringVector	getQueueEvents(StringVector queueNames, long maxNumEvents, Pointer timeout) Gets or waits until any of specified queues has received a message
float	getSystemInformationLoggingRate() Gets current rate of system information logging ("info" severity) in Hz.
depthai.UsbSpeed	getUsbSpeed() Retrieves USB connection speed
boolean	isClosed() Is the device already closed (or disconnected)
boolean	isPipelineRunning() Checks if devices pipeline is already running
CalibrationHandler	readCalibration() Fetches the EEPROM data from the device and loads it into CalibrationHandler object
boolean	removeLogCallback(int callbackId) Removes a callback
void	setLogLevel(depthai.LogLevel level) Sets the devices logging severity level.
void	setLogLevel(int level)
void	setLogOutputLevel(depthai.LogLevel level) Sets logging level which decides printing level to standard output.
void	setLogOutputLevel(int level)
void	setSystemInformationLoggingRate(float rateHz) Sets rate of system information logging ("info" severity).
boolean	startPipeline() Deprecated.
boolean	startPipeline(Pipeline pipeline) Starts the execution of a given pipeline

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EVENT_QUEUE_MAXIMUM_SIZE

public static final long EVENT_QUEUE_MAXIMUM_SIZE

DEFAULT_SYSTEM_INFORMATION_LOGGING_RATE_HZ

public static final float DEFAULT_SYSTEM_INFORMATION_LOGGING_RATE_HZ

Constructor Detail

Device

public Device(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Device

public Device(@Const @ByRef
              Pipeline pipeline)

Connects to any available device with a DEFAULT_SEARCH_TIME timeout.

Parameters:

pipeline - Pipeline to be executed on the device

Device

public Device(@Const @ByRef
              Pipeline pipeline,
              @Cast(value="bool")
              boolean usb2Mode)

Connects to any available device with a DEFAULT_SEARCH_TIME timeout.

Parameters:

pipeline - Pipeline to be executed on the device

usb2Mode - Boot device using USB2 mode firmware

Device

public Device(@Const @ByRef
              Pipeline pipeline,
              @Cast(value="const char*")
              BytePointer pathToCmd)

Connects to any available device with a DEFAULT_SEARCH_TIME timeout.

Parameters:

pipeline - Pipeline to be executed on the device

pathToCmd - Path to custom device firmware

Device

public Device(@Const @ByRef
              Pipeline pipeline,
              String pathToCmd)

Device

public Device(@Const @ByRef
              Pipeline pipeline,
              @Const @ByRef
              DeviceInfo devInfo,
              @Cast(value="bool")
              boolean usb2Mode)

Connects to device specified by devInfo.

Parameters:

pipeline - Pipeline to be executed on the device

devInfo - DeviceInfo which specifies which device to connect to

usb2Mode - Boot device using USB2 mode firmware

Device

public Device(@Const @ByRef
              Pipeline pipeline,
              @Const @ByRef
              DeviceInfo devInfo)

Device

public Device(@Const @ByRef
              Pipeline pipeline,
              @Const @ByRef
              DeviceInfo devInfo,
              @Cast(value="const char*")
              BytePointer pathToCmd)

Connects to device specified by devInfo.

Parameters:

pipeline - Pipeline to be executed on the device

devInfo - DeviceInfo which specifies which device to connect to

pathToCmd - Path to custom device firmware

Device

public Device(@Const @ByRef
              Pipeline pipeline,
              @Const @ByRef
              DeviceInfo devInfo,
              String pathToCmd)

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version)

Connects to any available device with a DEFAULT_SEARCH_TIME timeout.

Parameters:

version - OpenVINO version which the device will be booted with. Default is Pipeline::DEFAULT_OPENVINO_VERSION

Device

public Device()

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version,
              @Cast(value="bool")
              boolean usb2Mode)

Connects to any available device with a DEFAULT_SEARCH_TIME timeout.

Parameters:

version - OpenVINO version which the device will be booted with

usb2Mode - Boot device using USB2 mode firmware

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version,
              @Cast(value="const char*")
              BytePointer pathToCmd)

Connects to any available device with a DEFAULT_SEARCH_TIME timeout.

Parameters:

version - OpenVINO version which the device will be booted with

pathToCmd - Path to custom device firmware

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version,
              String pathToCmd)

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version,
              @Const @ByRef
              DeviceInfo devInfo,
              @Cast(value="bool")
              boolean usb2Mode)

Connects to device specified by devInfo.

Parameters:

version - OpenVINO version which the device will be booted with

devInfo - DeviceInfo which specifies which device to connect to

usb2Mode - Boot device using USB2 mode firmware

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version,
              @Const @ByRef
              DeviceInfo devInfo)

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version,
              @Const @ByRef
              DeviceInfo devInfo,
              @Cast(value="const char*")
              BytePointer pathToCmd)

Connects to device specified by devInfo.

Parameters:

version - OpenVINO version which the device will be booted with

devInfo - DeviceInfo which specifies which device to connect to

pathToCmd - Path to custom device firmware

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version,
              @Const @ByRef
              DeviceInfo devInfo,
              String pathToCmd)

Method Detail

DEFAULT_SEARCH_TIME

@MemberGetter
 @ByRef
 @Cast(value="const std::chrono::seconds*")
public static Pointer DEFAULT_SEARCH_TIME()

Default search time for constructors which discover devices

EVENT_QUEUE_MAXIMUM_SIZE

@MemberGetter
 @Cast(value="const std::size_t")
public static long EVENT_QUEUE_MAXIMUM_SIZE()

Maximum number of elements in event queue

DEFAULT_SYSTEM_INFORMATION_LOGGING_RATE_HZ

@MemberGetter
public static float DEFAULT_SYSTEM_INFORMATION_LOGGING_RATE_HZ()

Default rate at which system information is logged

getAnyAvailableDevice

@ByVal
 @Cast(value="std::tuple<bool,dai::DeviceInfo>*")
public static Pointer getAnyAvailableDevice()

Gets any available device

Returns:

Tuple of bool and DeviceInfo. Bool specifies if device was found. DeviceInfo specifies the found device

getFirstAvailableDevice

@ByVal
 @Cast(value="std::tuple<bool,dai::DeviceInfo>*")
public static Pointer getFirstAvailableDevice()

Gets first available device. Device can be either in XLINK_UNBOOTED or XLINK_BOOTLOADER state

Returns:

Tuple of bool and DeviceInfo. Bool specifies if device was found. DeviceInfo specifies the found device

getDeviceByMxId

@ByVal
 @Cast(value="std::tuple<bool,dai::DeviceInfo>*")
public static Pointer getDeviceByMxId(@StdString
                                                                                               BytePointer mxId)

Finds a device by MX ID. Example: 14442C10D13EABCE00

Parameters:

mxId - MyraidX ID which uniquely specifies a device

Returns:

Tuple of bool and DeviceInfo. Bool specifies if device was found. DeviceInfo specifies the found device

getDeviceByMxId

@ByVal
 @Cast(value="std::tuple<bool,dai::DeviceInfo>*")
public static Pointer getDeviceByMxId(@StdString
                                                                                               String mxId)

getAllAvailableDevices

@StdVector
public static DeviceInfo getAllAvailableDevices()

Returns all connected devices

Returns:

Vector of connected devices

getEmbeddedDeviceBinary

@Cast(value="std::uint8_t*")
 @StdVector
public static BytePointer getEmbeddedDeviceBinary(@Cast(value="bool")
                                                                                           boolean usb2Mode,
                                                                                           @Cast(value="dai::OpenVINO::Version")
                                                                                           int version)

Gets device firmware binary for a specific OpenVINO version

Parameters:

usb2Mode - USB2 mode firmware

version - Version of OpenVINO which firmware will support

Returns:

Firmware binary

getEmbeddedDeviceBinary

@Cast(value="std::uint8_t*")
 @StdVector
public static BytePointer getEmbeddedDeviceBinary(@Cast(value="bool")
                                                                                           boolean usb2Mode)

isPipelineRunning

@Cast(value="bool")
public boolean isPipelineRunning()

Checks if devices pipeline is already running

Returns:

True if running, false otherwise

startPipeline

@Cast(value="bool")
 @Deprecated
public boolean startPipeline()

Deprecated.

Starts the execution of the devices pipeline

Returns:

True if pipeline started, false otherwise

startPipeline

@Cast(value="bool")
public boolean startPipeline(@Const @ByRef
                                                 Pipeline pipeline)

Starts the execution of a given pipeline

Parameters:

pipeline - OpenVINO version of the pipeline must match the one which the device was booted with.

Returns:

True if pipeline started, false otherwise

setLogLevel

public void setLogLevel(depthai.LogLevel level)

Sets the devices logging severity level. This level affects which logs are transfered from device to host.

Parameters:

level - Logging severity

setLogLevel

public void setLogLevel(@Cast(value="dai::LogLevel")
                        int level)

getLogLevel

public depthai.LogLevel getLogLevel()

Gets current logging severity level of the device.

Returns:

Logging severity level

getDeviceInfo

@ByVal
public DeviceInfo getDeviceInfo()

Get the Device Info object o the device which is currently running

Returns:

DeviceInfo of the current device in execution

setLogOutputLevel

public void setLogOutputLevel(depthai.LogLevel level)

Sets logging level which decides printing level to standard output. If lower than setLogLevel, no messages will be printed

Parameters:

level - Standard output printing severity

setLogOutputLevel

public void setLogOutputLevel(@Cast(value="dai::LogLevel")
                              int level)

getLogOutputLevel

public depthai.LogLevel getLogOutputLevel()

Gets logging level which decides printing level to standard output.

Returns:

Standard output printing severity

addLogCallback

public int addLogCallback(depthai.LogCallback callback)

Add a callback for device logging. The callback will be called from a separate thread with the LogMessage being passed.

Parameters:

callback - Callback to call whenever a log message arrives

Returns:

Id which can be used to later remove the callback

removeLogCallback

@Cast(value="bool")
public boolean removeLogCallback(int callbackId)

Removes a callback

Parameters:

callbackId - Id of callback to be removed

Returns:

True if callback was removed, false otherwise

setSystemInformationLoggingRate

public void setSystemInformationLoggingRate(float rateHz)

Sets rate of system information logging ("info" severity). Default 1Hz If parameter is less or equal to zero, then system information logging will be disabled

Parameters:

rateHz - Logging rate in Hz

getSystemInformationLoggingRate

public float getSystemInformationLoggingRate()

Gets current rate of system information logging ("info" severity) in Hz.

Returns:

Logging rate in Hz

getOutputQueue

@SharedPtr
public DataOutputQueue getOutputQueue(@StdString
                                                 BytePointer name)

Gets an output queue corresponding to stream name. If it doesn't exist it throws

Parameters:

name - Queue/stream name, created by XLinkOut node

Returns:

Smart pointer to DataOutputQueue

getOutputQueue

@SharedPtr
public DataOutputQueue getOutputQueue(@StdString
                                                 String name)

getOutputQueue

@SharedPtr
public DataOutputQueue getOutputQueue(@StdString
                                                 BytePointer name,
                                                 @Cast(value="unsigned int")
                                                 int maxSize,
                                                 @Cast(value="bool")
                                                 boolean blocking)

Gets a queue corresponding to stream name, if it exists, otherwise it throws. Also sets queue options

Parameters:

name - Queue/stream name, set in XLinkOut node

maxSize - Maximum number of messages in queue

blocking - Queue behavior once full. True specifies blocking and false overwriting of oldest messages. Default: true

Returns:

Smart pointer to DataOutputQueue

getOutputQueue

@SharedPtr
public DataOutputQueue getOutputQueue(@StdString
                                                 BytePointer name,
                                                 @Cast(value="unsigned int")
                                                 int maxSize)

getOutputQueue

@SharedPtr
public DataOutputQueue getOutputQueue(@StdString
                                                 String name,
                                                 @Cast(value="unsigned int")
                                                 int maxSize,
                                                 @Cast(value="bool")
                                                 boolean blocking)

getOutputQueue

@SharedPtr
public DataOutputQueue getOutputQueue(@StdString
                                                 String name,
                                                 @Cast(value="unsigned int")
                                                 int maxSize)

getOutputQueueNames

@ByVal
public StringVector getOutputQueueNames()

Get all available output queue names

Returns:

Vector of output queue names

getInputQueue

@SharedPtr
public DataInputQueue getInputQueue(@StdString
                                               BytePointer name)

Gets an input queue corresponding to stream name. If it doesn't exist it throws

Parameters:

name - Queue/stream name, set in XLinkIn node

Returns:

Smart pointer to DataInputQueue

getInputQueue

@SharedPtr
public DataInputQueue getInputQueue(@StdString
                                               String name)

getInputQueue

@SharedPtr
public DataInputQueue getInputQueue(@StdString
                                               BytePointer name,
                                               @Cast(value="unsigned int")
                                               int maxSize,
                                               @Cast(value="bool")
                                               boolean blocking)

Gets an input queue corresponding to stream name. If it doesn't exist it throws. Also sets queue options

Parameters:

name - Queue/stream name, set in XLinkOut node

maxSize - Maximum number of messages in queue

blocking - Queue behavior once full. True: blocking, false: overwriting of oldest messages. Default: true

Returns:

Smart pointer to DataInputQueue

getInputQueue

@SharedPtr
public DataInputQueue getInputQueue(@StdString
                                               BytePointer name,
                                               @Cast(value="unsigned int")
                                               int maxSize)

getInputQueue

@SharedPtr
public DataInputQueue getInputQueue(@StdString
                                               String name,
                                               @Cast(value="unsigned int")
                                               int maxSize,
                                               @Cast(value="bool")
                                               boolean blocking)

getInputQueue

@SharedPtr
public DataInputQueue getInputQueue(@StdString
                                               String name,
                                               @Cast(value="unsigned int")
                                               int maxSize)

getInputQueueNames

@ByVal
public StringVector getInputQueueNames()

Get all available input queue names

Returns:

Vector of input queue names

getQueueEvents

@ByVal
public StringVector getQueueEvents(@Const @ByRef
                                          StringVector queueNames,
                                          @Cast(value="std::size_t")
                                          long maxNumEvents,
                                          @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                          Pointer timeout)

Gets or waits until any of specified queues has received a message

Parameters:

queueNames - Names of queues for which to block

maxNumEvents - Maximum number of events to remove from queue - Default is unlimited

timeout - Timeout after which return regardless. If negative then wait is indefinite - Default is -1

Returns:

Names of queues which received messages first

getQueueEvents

@ByVal
public StringVector getQueueEvents(@Const @ByRef
                                          StringVector queueNames)

getQueueEvents

@ByVal
public StringVector getQueueEvents(@StdString
                                          BytePointer queueName,
                                          @Cast(value="std::size_t")
                                          long maxNumEvents,
                                          @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                          Pointer timeout)

Gets or waits until specified queue has received a message

Parameters:

queueName - Name of queues for which to wait for

maxNumEvents - Maximum number of events to remove from queue. Default is unlimited

timeout - Timeout after which return regardless. If negative then wait is indefinite. Default is -1

Returns:

Names of queues which received messages first

getQueueEvents

@ByVal
public StringVector getQueueEvents(@StdString
                                          BytePointer queueName)

getQueueEvents

@ByVal
public StringVector getQueueEvents(@StdString
                                          String queueName,
                                          @Cast(value="std::size_t")
                                          long maxNumEvents,
                                          @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                          Pointer timeout)

getQueueEvents

@ByVal
public StringVector getQueueEvents(@StdString
                                          String queueName)

getQueueEvents

@ByVal
public StringVector getQueueEvents(@Cast(value="std::size_t")
                                          long maxNumEvents,
                                          @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                          Pointer timeout)

Gets or waits until any any queue has received a message

Parameters:

maxNumEvents - Maximum number of events to remove from queue. Default is unlimited

timeout - Timeout after which return regardless. If negative then wait is indefinite. Default is -1

Returns:

Names of queues which received messages first

getQueueEvents

@ByVal
public StringVector getQueueEvents()

getQueueEvent

@StdString
public BytePointer getQueueEvent(@Const @ByRef
                                            StringVector queueNames,
                                            @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                            Pointer timeout)

Gets or waits until any of specified queues has received a message

Parameters:

queueNames - Names of queues for which to wait for

timeout - Timeout after which return regardless. If negative then wait is indefinite. Default is -1

Returns:

Queue name which received a message first

getQueueEvent

@StdString
public BytePointer getQueueEvent(@Const @ByRef
                                            StringVector queueNames)

getQueueEvent

@StdString
public BytePointer getQueueEvent(@StdString
                                            BytePointer queueName,
                                            @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                            Pointer timeout)

Gets or waits until specified queue has received a message

Parameters:

queueNames - Name of queues for which to wait for

timeout - Timeout after which return regardless. If negative then wait is indefinite. Default is -1

Returns:

Queue name which received a message

getQueueEvent

@StdString
public BytePointer getQueueEvent(@StdString
                                            BytePointer queueName)

getQueueEvent

@StdString
public String getQueueEvent(@StdString
                                       String queueName,
                                       @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                       Pointer timeout)

getQueueEvent

@StdString
public String getQueueEvent(@StdString
                                       String queueName)

getQueueEvent

@StdString
public BytePointer getQueueEvent(@ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                            Pointer timeout)

Gets or waits until any queue has received a message

Parameters:

timeout - Timeout after which return regardless. If negative then wait is indefinite. Default is -1

Returns:

Queue name which received a message

getQueueEvent

@StdString
public BytePointer getQueueEvent()

getMxId

@StdString
public BytePointer getMxId()

Get MxId of device

Returns:

MxId of connected device

getConnectedCameras

@StdVector
 @Cast(value="dai::CameraBoardSocket*")
public IntPointer getConnectedCameras()

Get cameras that are connected to the device

Returns:

Vector of connected cameras

getDdrMemoryUsage

@ByVal
public MemoryInfo getDdrMemoryUsage()

Retrieves current DDR memory information from device

Returns:

Used, remaining and total ddr memory

getCmxMemoryUsage

@ByVal
public MemoryInfo getCmxMemoryUsage()

Retrieves current CMX memory information from device

Returns:

Used, remaining and total cmx memory

getLeonCssHeapUsage

@ByVal
public MemoryInfo getLeonCssHeapUsage()

Retrieves current CSS Leon CPU heap information from device

Returns:

Used, remaining and total heap memory

getLeonMssHeapUsage

@ByVal
public MemoryInfo getLeonMssHeapUsage()

Retrieves current MSS Leon CPU heap information from device

Returns:

Used, remaining and total heap memory

getChipTemperature

@ByVal
public ChipTemperature getChipTemperature()

Retrieves current chip temperature as measured by device

Returns:

Temperature of various onboard sensors

getLeonCssCpuUsage

@ByVal
public CpuUsage getLeonCssCpuUsage()

Retrieves average CSS Leon CPU usage

Returns:

Average CPU usage and sampling duration

getLeonMssCpuUsage

@ByVal
public CpuUsage getLeonMssCpuUsage()

Retrieves average MSS Leon CPU usage

Returns:

Average CPU usage and sampling duration

flashCalibration

@Cast(value="bool")
public boolean flashCalibration(@ByVal
                                                    CalibrationHandler calibrationDataHandler)

Stores the Calibration and Device information to the Device EEPROM

Parameters:

calibrationObj - CalibrationHandler object which is loaded with calibration information.

Returns:

true on successful flash, false on failure

readCalibration

@ByVal
public CalibrationHandler readCalibration()

Fetches the EEPROM data from the device and loads it into CalibrationHandler object

Returns:

The CalibrationHandler object containing the calibration currently flashed on device EEPROM

getUsbSpeed

public depthai.UsbSpeed getUsbSpeed()

Retrieves USB connection speed

Returns:

USB connection speed of connected device if applicable. Unknown otherwise.

_close

@Name(value="close")
public void _close()

Explicitly closes connection to device. \note This function does not need to be explicitly called as destructor closes the device automatically

isClosed

@Cast(value="bool")
public boolean isClosed()

Is the device already closed (or disconnected)