org.bytedeco.depthai

Class DeviceBootloader

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.depthai.DeviceBootloader

All Implemented Interfaces:

AutoCloseable

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeviceBootloader.Version Bootloader version structure

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

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

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
DeviceBootloader(DeviceInfo devInfo) Connects to or boots device in bootloader mode depending on devInfo state.
DeviceBootloader(DeviceInfo devInfo, BytePointer pathToBootloader) Connects to or boots device in bootloader mode depending on devInfo state with a custom bootloader firmware.
DeviceBootloader(DeviceInfo devInfo, depthai.Type type) Connects to device in bootloader of specified type.
DeviceBootloader(DeviceInfo devInfo, int type)
DeviceBootloader(DeviceInfo devInfo, String pathToBootloader)
DeviceBootloader(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
void	_close() Explicitly closes connection to device.
static BytePointer	createDepthaiApplicationPackage(Pipeline pipeline)
static BytePointer	createDepthaiApplicationPackage(Pipeline pipeline, BytePointer pathToCmd) Creates application package which can be flashed to depthai device.
static ByteBuffer	createDepthaiApplicationPackage(Pipeline pipeline, String pathToCmd)
static depthai.Type	DEFAULT_TYPE() Default Bootloader type
Pointer	flash(depthai.ProgressCallback progressCallback, Pipeline pipeline) Flashes a give pipeline to the board.
Pointer	flashBootloader(depthai.Memory memory, depthai.Type type, depthai.ProgressCallback progressCallback)
Pointer	flashBootloader(depthai.Memory memory, depthai.Type type, depthai.ProgressCallback progressCallback, BytePointer path) Flash selected bootloader to the current board
Pointer	flashBootloader(depthai.ProgressCallback progressCallback)
Pointer	flashBootloader(depthai.ProgressCallback progressCallback, BytePointer path) Flashes bootloader to the current board
Pointer	flashBootloader(depthai.ProgressCallback progressCallback, String path)
Pointer	flashBootloader(int memory, int type, depthai.ProgressCallback progressCallback)
Pointer	flashBootloader(int memory, int type, depthai.ProgressCallback progressCallback, String path)
Pointer	flashDepthaiApplicationPackage(depthai.ProgressCallback progressCallback, byte[] _package)
Pointer	flashDepthaiApplicationPackage(depthai.ProgressCallback progressCallback, ByteBuffer _package)
Pointer	flashDepthaiApplicationPackage(depthai.ProgressCallback progressCallback, BytePointer _package) Flashes a specific depthai application package that was generated using createDepthaiApplicationPackage or saveDepthaiApplicationPackage
static DeviceInfo	getAllAvailableDevices() Searches for connected devices in either UNBOOTED or BOOTLOADER states.
static BytePointer	getEmbeddedBootloaderBinary()
static BytePointer	getEmbeddedBootloaderBinary(depthai.Type type)
static ByteBuffer	getEmbeddedBootloaderBinary(int type)
static DeviceBootloader.Version	getEmbeddedBootloaderVersion()
static Pointer	getFirstAvailableDevice() Searches for connected devices in either UNBOOTED or BOOTLOADER states and returns first available.
DeviceBootloader.Version	getVersion()
boolean	isClosed() Is the device already closed (or disconnected)
boolean	isEmbeddedVersion()
static void	saveDepthaiApplicationPackage(BytePointer path, Pipeline pipeline)
static void	saveDepthaiApplicationPackage(BytePointer path, Pipeline pipeline, BytePointer pathToCmd) Saves application package to a file which can be flashed to depthai device.
static void	saveDepthaiApplicationPackage(String path, Pipeline pipeline)
static void	saveDepthaiApplicationPackage(String path, Pipeline pipeline, String pathToCmd)

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

Constructor Detail

DeviceBootloader

public DeviceBootloader(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

DeviceBootloader

public DeviceBootloader(@Const @ByRef
                        DeviceInfo devInfo)

Connects to or boots device in bootloader mode depending on devInfo state.

Parameters:

devInfo - DeviceInfo of which to boot or connect to

DeviceBootloader

public DeviceBootloader(@Const @ByRef
                        DeviceInfo devInfo,
                        depthai.Type type)

Connects to device in bootloader of specified type. Throws if it wasn't possible. This constructor will automatically boot into specified bootloader type if not already running

Parameters:

devInfo - DeviceInfo of which to boot or connect to

type - Type of bootloader to boot/connect to.

DeviceBootloader

public DeviceBootloader(@Const @ByRef
                        DeviceInfo devInfo,
                        @Cast(value="dai::bootloader::Type")
                        int type)

DeviceBootloader

public DeviceBootloader(@Const @ByRef
                        DeviceInfo devInfo,
                        @StdString
                        BytePointer pathToBootloader)

Connects to or boots device in bootloader mode depending on devInfo state with a custom bootloader firmware.

Parameters:

devInfo - DeviceInfo of which to boot or connect to

pathToBootloader - Custom bootloader firmware to boot

DeviceBootloader

public DeviceBootloader(@Const @ByRef
                        DeviceInfo devInfo,
                        @StdString
                        String pathToBootloader)

Method Detail

DEFAULT_TYPE

@MemberGetter
public static depthai.Type DEFAULT_TYPE()

Default Bootloader type

getFirstAvailableDevice

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

Searches for connected devices in either UNBOOTED or BOOTLOADER states and returns first available.

Returns:

Tuple of boolean and DeviceInfo. If found boolean is true and DeviceInfo describes the device. Otherwise false

getAllAvailableDevices

@StdVector
public static DeviceInfo getAllAvailableDevices()

Searches for connected devices in either UNBOOTED or BOOTLOADER states.

Returns:

Vector of all found devices

createDepthaiApplicationPackage

@Cast(value="uint8_t*")
 @StdVector
public static BytePointer createDepthaiApplicationPackage(@ByRef
                                                                                              Pipeline pipeline,
                                                                                              @StdString
                                                                                              BytePointer pathToCmd)

Creates application package which can be flashed to depthai device.

Parameters:

pipeline - Pipeline from which to create the application package

pathToCmd - Optional path to custom device firmware

Returns:

Depthai application package

createDepthaiApplicationPackage

@Cast(value="uint8_t*")
 @StdVector
public static BytePointer createDepthaiApplicationPackage(@ByRef
                                                                                              Pipeline pipeline)

createDepthaiApplicationPackage

@Cast(value="uint8_t*")
 @StdVector
public static ByteBuffer createDepthaiApplicationPackage(@ByRef
                                                                                             Pipeline pipeline,
                                                                                             @StdString
                                                                                             String pathToCmd)

saveDepthaiApplicationPackage

public static void saveDepthaiApplicationPackage(@StdString
                                                 BytePointer path,
                                                 @ByRef
                                                 Pipeline pipeline,
                                                 @StdString
                                                 BytePointer pathToCmd)

Saves application package to a file which can be flashed to depthai device.

Parameters:

path - Path where to save the application package

pipeline - Pipeline from which to create the application package

pathToCmd - Optional path to custom device firmware

saveDepthaiApplicationPackage

public static void saveDepthaiApplicationPackage(@StdString
                                                 BytePointer path,
                                                 @ByRef
                                                 Pipeline pipeline)

saveDepthaiApplicationPackage

public static void saveDepthaiApplicationPackage(@StdString
                                                 String path,
                                                 @ByRef
                                                 Pipeline pipeline,
                                                 @StdString
                                                 String pathToCmd)

saveDepthaiApplicationPackage

public static void saveDepthaiApplicationPackage(@StdString
                                                 String path,
                                                 @ByRef
                                                 Pipeline pipeline)

getEmbeddedBootloaderVersion

@ByVal
public static DeviceBootloader.Version getEmbeddedBootloaderVersion()

Returns:

Embedded bootloader version

getEmbeddedBootloaderBinary

@Cast(value="std::uint8_t*")
 @StdVector
public static BytePointer getEmbeddedBootloaderBinary(depthai.Type type)

Returns:

Embedded bootloader binary

getEmbeddedBootloaderBinary

@Cast(value="std::uint8_t*")
 @StdVector
public static BytePointer getEmbeddedBootloaderBinary()

getEmbeddedBootloaderBinary

@Cast(value="std::uint8_t*")
 @StdVector
public static ByteBuffer getEmbeddedBootloaderBinary(@Cast(value="dai::bootloader::Type")
                                                                                              int type)

flash

@ByVal
 @Cast(value="std::tuple<bool,std::string>*")
public Pointer flash(depthai.ProgressCallback progressCallback,
                                                                          @ByRef
                                                                          Pipeline pipeline)

Flashes a give pipeline to the board.

Parameters:

progressCallback - Callback that sends back a value between 0..1 which signifies current flashing progress

pipeline - Pipeline to flash to the board

flashDepthaiApplicationPackage

@ByVal
 @Cast(value="std::tuple<bool,std::string>*")
public Pointer flashDepthaiApplicationPackage(depthai.ProgressCallback progressCallback,
                                                                                                   @Cast(value="uint8_t*") @StdVector
                                                                                                   BytePointer _package)

Flashes a specific depthai application package that was generated using createDepthaiApplicationPackage or saveDepthaiApplicationPackage

Parameters:

progressCallback - Callback that sends back a value between 0..1 which signifies current flashing progress

package - Depthai application package to flash to the board

flashDepthaiApplicationPackage

@ByVal
 @Cast(value="std::tuple<bool,std::string>*")
public Pointer flashDepthaiApplicationPackage(depthai.ProgressCallback progressCallback,
                                                                                                   @Cast(value="uint8_t*") @StdVector
                                                                                                   ByteBuffer _package)

flashDepthaiApplicationPackage

@ByVal
 @Cast(value="std::tuple<bool,std::string>*")
public Pointer flashDepthaiApplicationPackage(depthai.ProgressCallback progressCallback,
                                                                                                   @Cast(value="uint8_t*") @StdVector
                                                                                                   byte[] _package)

flashBootloader

@ByVal
 @Cast(value="std::tuple<bool,std::string>*")
public Pointer flashBootloader(depthai.ProgressCallback progressCallback,
                                                                                    @StdString
                                                                                    BytePointer path)

Flashes bootloader to the current board

Parameters:

progressCallback - Callback that sends back a value between 0..1 which signifies current flashing progress

path - Optional parameter to custom bootloader to flash

flashBootloader

@ByVal
 @Cast(value="std::tuple<bool,std::string>*")
public Pointer flashBootloader(depthai.ProgressCallback progressCallback)

flashBootloader

@ByVal
 @Cast(value="std::tuple<bool,std::string>*")
public Pointer flashBootloader(depthai.ProgressCallback progressCallback,
                                                                                    @StdString
                                                                                    String path)

flashBootloader

@ByVal
 @Cast(value="std::tuple<bool,std::string>*")
public Pointer flashBootloader(depthai.Memory memory,
                                                                                    depthai.Type type,
                                                                                    depthai.ProgressCallback progressCallback,
                                                                                    @StdString
                                                                                    BytePointer path)

Flash selected bootloader to the current board

Parameters:

memory - Memory to flash

type - Bootloader type to flash

progressCallback - Callback that sends back a value between 0..1 which signifies current flashing progress

path - Optional parameter to custom bootloader to flash

flashBootloader

@ByVal
 @Cast(value="std::tuple<bool,std::string>*")
public Pointer flashBootloader(depthai.Memory memory,
                                                                                    depthai.Type type,
                                                                                    depthai.ProgressCallback progressCallback)

flashBootloader

@ByVal
 @Cast(value="std::tuple<bool,std::string>*")
public Pointer flashBootloader(@Cast(value="dai::bootloader::Memory")
                                                                                    int memory,
                                                                                    @Cast(value="dai::bootloader::Type")
                                                                                    int type,
                                                                                    depthai.ProgressCallback progressCallback,
                                                                                    @StdString
                                                                                    String path)

flashBootloader

@ByVal
 @Cast(value="std::tuple<bool,std::string>*")
public Pointer flashBootloader(@Cast(value="dai::bootloader::Memory")
                                                                                    int memory,
                                                                                    @Cast(value="dai::bootloader::Type")
                                                                                    int type,
                                                                                    depthai.ProgressCallback progressCallback)

getVersion

@ByVal
public DeviceBootloader.Version getVersion()

Returns:

Version of current running bootloader

isEmbeddedVersion

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

Returns:

True whether the bootloader running is flashed or booted by library

_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)