BltTofApi Manual

From BlueWiki

(Difference between revisions)
Jump to: navigation, search
(Environment)
 
(9 intermediate revisions not shown)
Line 1: Line 1:
-
= Environment =
+
-delete me-
-
 
+
-
== Windows ==
+
-
 
+
-
Please take a look at the example project for a reference on how to compile an application using a BTA library. Things to consider are:
+
-
* Macro: #define PLAT_WINDOWS
+
-
* Macro: #define PLAT_32BIT or #define PLAT_64_BIT
+
-
 
+
-
== Linux ==
+
-
 
+
-
== Arm (Linux) ==
+
-
 
+
-
= Reference Manual =
+
-
 
+
-
== BTAgetVersion ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusOutOfMemory
+
-
| -17
+
-
|
+
-
* The given buildDateTime string is not long enough
+
-
* The given supportedDeviceTypes array is not long enough
+
-
|-
+
-
|BTA_StatusRuntimeError
+
-
| -16
+
-
|
+
-
* There was an error while copying the information into the given buffers.
+
-
|}
+
-
 
+
-
== BTAinitConfig ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given config structure is not valid
+
-
|}
+
-
 
+
-
 
+
-
== BTAopen ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusOutOfMemory
+
-
| -17
+
-
|
+
-
* Not enough memory for the SDK instance
+
-
|-
+
-
|BTA_StatusRuntimeError
+
-
| -16
+
-
|
+
-
* A thread could not be started
+
-
* A mutex could not be initialized
+
-
|-
+
-
|BTA_StatusDeviceUnreachable
+
-
| -6
+
-
|
+
-
* The connection attempt was not successful
+
-
* The given serialNumer does not match any of the connected devices
+
-
|-
+
-
|BTA_StatusCommunicationError
+
-
| -24
+
-
|
+
-
* The connection was established, but communication failed
+
-
|-
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given config struct pointer is not valid
+
-
* The given handle pointer is not valid
+
-
* The non-default calibration file could not be found or is not a valid calibration file
+
-
|-
+
-
|BTA_StatusNotSupported
+
-
| -21
+
-
|
+
-
* The given frameMode is not supported by the device
+
-
|}
+
-
 
+
-
== BTAclose ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given handle is invalid
+
-
|-
+
-
|BTA_StatusRuntimeError
+
-
| -16
+
-
|
+
-
* A thread could not be stopped
+
-
* A mutex could not be closed
+
-
* A The resources are still under usage in another thread
+
-
|}
+
-
 
+
-
 
+
-
== BTAgetDeviceInfo ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given handle is not valid
+
-
|-
+
-
|BTA_StatusOutOfMemory
+
-
| -17
+
-
|
+
-
* The device info struct could not be allocated
+
-
|-
+
-
|BTA_StatusCommunicationError
+
-
| -24
+
-
|
+
-
* There was an error when reading information from the camera
+
-
|}
+
-
 
+
-
 
+
-
== BTAsetKeepAliveMsgInterval ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given handle is not valid
+
-
|-
+
-
|BTA_StatusIllegalOperation
+
-
| -2
+
-
|
+
-
* BTAclose was called from a different thread
+
-
|-
+
-
|BTA_StatusInvalidProtocolVersion
+
-
| -14
+
-
|
+
-
* The camera's protocol version is not supported
+
-
|}
+
-
 
+
-
== BTAsetControlCrcEnabled ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given handle is not valid
+
-
|-
+
-
|BTA_StatusIllegalOperation
+
-
| -2
+
-
|
+
-
* BTAclose was called from a different thread
+
-
|}
+
-
 
+
-
 
+
-
== BTAsetFrameMode ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given handle is not valid
+
-
|-
+
-
|BTA_StatusIllegalOperation
+
-
| -2
+
-
|
+
-
* BTAclose was called from a different thread
+
-
|-
+
-
|BTA_StatusNotSupported
+
-
| -21
+
-
|
+
-
* The given frameMode is not supported by the device
+
-
|-
+
-
|BTA_StatusCommunicationError
+
-
| -24
+
-
|
+
-
* An error occured while accessing registers on the devide
+
-
|}
+
-
 
+
-
 
+
-
== BTAsendReset ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given handle is not valid
+
-
|-
+
-
|BTA_StatusIllegalOperation
+
-
| -2
+
-
|
+
-
* BTAclose was called from a different thread
+
-
|-
+
-
|BTA_StatusNotConnected
+
-
| -12
+
-
|
+
-
* The connection to the device has been lost
+
-
|-
+
-
|BTA_StatusDeviceUnreachable
+
-
| -6
+
-
|
+
-
* Reading from or writing to the device resulted in an error
+
-
|-
+
-
|BTA_StatusProtocolViolation
+
-
| -4
+
-
|
+
-
* Something went wrong internally, please contact Bluetechnix support
+
-
|-
+
-
|BTA_StatusInvalidAddress
+
-
| -10
+
-
|
+
-
* The given register address is not valid
+
-
|-
+
-
|BTA_StatusIllegalOperation
+
-
| -2
+
-
|
+
-
* Reading/writing the given register is not allowed
+
-
|-
+
-
|BTA_StatusInvalidProtocolVersion
+
-
| -14
+
-
|
+
-
* The camera's protocol version is not supported
+
-
|}
+
-
 
+
-
== BTAgetFrame ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given handle is not valid
+
-
|-
+
-
|BTA_StatusIllegalOperation
+
-
| -2
+
-
|
+
-
* BTAclose was called from a different thread
+
-
|-
+
-
|BTA_StatusRuntimeError
+
-
| -16
+
-
|
+
-
* Queueing is not configured properly
+
-
* Device could not convert raw data
+
-
|-
+
-
|BTA_StatusNotSupported
+
-
| -21
+
-
|
+
-
* The data received from the device can not be used (with current frameMode)
+
-
|-
+
-
|BTA_StatusTimeOut
+
-
| -5
+
-
|
+
-
* No frame received from device within timeout
+
-
|-
+
-
|BTA_StatusOutOfMemory
+
-
| -17
+
-
|
+
-
* Could not allocate memory for internal use
+
-
|-
+
-
|BTA_StatusCommunicationError
+
-
| -24
+
-
|
+
-
* An error occured while accessing registers on the devide
+
-
|-
+
-
|BTA_StatusUnexpectedDataFormat
+
-
| -26
+
-
|
+
-
* The device is not configured correctly for the currently set frame mode
+
-
|}
+
-
 
+
-
== BTAgetIntegrationTime ==
+
-
 
+
-
same as BTAreadRegister
+
-
 
+
-
== BTAsetIntegrationTime ==
+
-
 
+
-
same as BTAwriteRegister
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given integration time is not valid
+
-
|}
+
-
 
+
-
 
+
-
== BTAgetFrameRate ==
+
-
 
+
-
same as BTAreadRegister
+
-
 
+
-
 
+
-
== BTAsetFrameRate ==
+
-
 
+
-
same as BTAwriteRegister
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given frame rate time is not valid
+
-
|}
+
-
 
+
-
 
+
-
== BTAgetGlobalOffset ==
+
-
 
+
-
same as BTAreadRegister
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidConfiguration
+
-
| -23
+
-
|
+
-
* For the current device configuration (e.g. modulation frequency) the operation can not be performed
+
-
|}
+
-
 
+
-
 
+
-
== BTAsetGlobalOffset ==
+
-
 
+
-
same as BTAreadRegister
+
-
same as BTAwriteRegister
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given offset is not valid
+
-
|}
+
-
 
+
-
 
+
-
== BTAreadRegister ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given handle is not valid
+
-
* The given registerCount is not valid
+
-
|-
+
-
|BTA_StatusIllegalOperation
+
-
| -2
+
-
|
+
-
* BTAclose was called from a different thread
+
-
|-
+
-
|BTA_StatusNotConnected
+
-
| -12
+
-
|
+
-
* The connection to the device has been lost
+
-
|-
+
-
|BTA_StatusDeviceUnreachable
+
-
| - 6
+
-
|
+
-
* Reading from or writing to the device resulted in an error
+
-
|-
+
-
|BTA_StatusProtocolViolation
+
-
| -4
+
-
|
+
-
* Something went wrong internally, please contact Bluetechnix support
+
-
|-
+
-
|BTA_StatusInvalidAddress
+
-
| -10
+
-
|
+
-
* The given register address is not valid
+
-
|-
+
-
|BTA_StatusIllegalOperation
+
-
| -2
+
-
|
+
-
* Reading/writing the given register is not allowed
+
-
|-
+
-
|BTA_StatusOutOfMemory
+
-
| -17
+
-
|
+
-
* Could not allocate memory
+
-
|-
+
-
|BTA_StatusInvalidProtocolVersion
+
-
| -14
+
-
|
+
-
* The camera's protocol version is not supported
+
-
|}
+
-
 
+
-
== BTAwriteRegister ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given handle is not valid
+
-
* The given registerCount is not valid
+
-
* The given register value is not valid
+
-
|-
+
-
|BTA_StatusIllegalOperation
+
-
| -2
+
-
|
+
-
* BTAclose was called from a different thread
+
-
|-
+
-
|BTA_StatusNotConnected
+
-
| -12
+
-
|
+
-
* The connection to the device has been lost
+
-
|-
+
-
|BTA_StatusDeviceUnreachable
+
-
| -6
+
-
|
+
-
* Reading from or writing to the device resulted in an error
+
-
|-
+
-
|BTA_StatusProtocolViolation
+
-
| -4
+
-
|
+
-
* Something went wrong internally, please contact Bluetechnix support
+
-
|-
+
-
|BTA_StatusInvalidAddress
+
-
| -10
+
-
|
+
-
* The given register address is not valid
+
-
|-
+
-
|BTA_StatusIllegalOperation
+
-
| -2
+
-
|
+
-
* Reading/writing the given register is not allowed
+
-
|-
+
-
|BTA_StatusInvalidProtocolVersion
+
-
| -14
+
-
|
+
-
* The camera's protocol version is not supported
+
-
|}
+
-
 
+
-
== BTAflashUpdate ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given handle is not valid
+
-
* The given flash target is not valid
+
-
* The given flash ID is not valid
+
-
|-
+
-
|BTA_StatusIllegalOperation
+
-
| -2
+
-
|
+
-
* BTAclose was called from a different thread
+
-
|-
+
-
|BTA_StatusNotConnected
+
-
| -12
+
-
|
+
-
* The connection to the device has been lost
+
-
|-
+
-
|BTA_StatusDeviceUnreachable
+
-
| -6
+
-
|
+
-
* Reading from or writing to the device resulted in an error
+
-
|-
+
-
|BTA_StatusProtocolViolation
+
-
| -4
+
-
|
+
-
* Something went wrong internally, please contact Bluetechnix support
+
-
|-
+
-
|BTA_StatusInvalidAddress
+
-
| -10
+
-
|
+
-
* The given register address is not valid
+
-
|-
+
-
|BTA_StatusIllegalOperation
+
-
| -2
+
-
|
+
-
* Reading/writing the given register is not allowed
+
-
|-
+
-
|BTA_StatusRuntimeError
+
-
| -16
+
-
|
+
-
* The device did not respond as expected during the update process
+
-
|-
+
-
|BTA_StatusCommunicationError
+
-
| -24
+
-
|
+
-
* There was an error during the file transmission
+
-
|-
+
-
|BTA_StatusOutOfMemory
+
-
| -17
+
-
|
+
-
* Not enough memory for performing the update process
+
-
|-
+
-
|BTA_StatusFlashingFailed 
+
-
| -22
+
-
|
+
-
* Flash Update failed
+
-
|-
+
-
|BTA_StatusInvalidProtocolVersion
+
-
| -14
+
-
|
+
-
* The camera's protocol version is not supported
+
-
|-
+
-
|BTA_StatusInvalidFile
+
-
| -25
+
-
|
+
-
* The provided file is not suitable
+
-
|}
+
-
 
+
-
== BTAfirmwareUpdate ==
+
-
 
+
-
same as BTAflashUpdate
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given handle is not valid
+
-
* The given file name is not valid
+
-
|-
+
-
|BTA_StatusOutOfMemory
+
-
| -17
+
-
|
+
-
* Not enough memory for reading in the firmware file
+
-
|-
+
-
|BTA_StatusRuntimeError
+
-
| -16
+
-
|
+
-
* The file could not be (fully) read
+
-
|}
+
-
 
+
-
== BTAgetDistances ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given frame or a given buffer is not valid
+
-
|-
+
-
|BTA_StatusInvalidDataFormat
+
-
| -15
+
-
|
+
-
* The given frame does not contain distance data
+
-
|}
+
-
 
+
-
 
+
-
== BTAgetAmplitudes ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given frame or a given buffer is not valid
+
-
|-
+
-
|BTA_StatusInvalidDataFormat
+
-
| -15
+
-
|
+
-
* The given frame does not contain amplitude data
+
-
|}
+
-
 
+
-
 
+
-
== BTAgetFlags ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given frame or a given buffer is not valid
+
-
|-
+
-
|BTA_StatusInvalidDataFormat
+
-
| -15
+
-
|
+
-
* The given frame does not contain flag data
+
-
|}
+
-
 
+
-
 
+
-
== BTAgetXYZcoordinates ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given frame or a given buffer is not valid
+
-
|-
+
-
|BTA_StatusInvalidDataFormat
+
-
| -15
+
-
|
+
-
* The given frame does not contain x/y/z data
+
-
|}
+
-
 
+
-
 
+
-
== BTAfreeFrame ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given frame is not valid
+
-
|}
+
-
 
+
-
 
+
-
== BTAfreeDeviceInfo ==
+
-
 
+
-
{|cellpadding="5"
+
-
|BTA_StatusInvalidParameter
+
-
| -1
+
-
|
+
-
* The given deviceInfo is not valid
+
-
|}
+
-
 
+
-
 
+
-
== BTAwriteCurrentConfigToNvm ==
+
-
 
+
-
same as BTAwriteRegister and BTAreadRegister
+
-
{|cellpadding="5"
+
-
|BTA_StatusRuntimeError
+
-
| -16
+
-
|
+
-
* The device reports, that the write process was not successful
+
-
|}
+
-
 
+
-
== BTArestoreDefaultConfig ==
+
-
 
+
-
same as BTAwriteRegister and BTAreadRegister
+
-
{|cellpadding="5"
+
-
|BTA_StatusRuntimeError
+
-
| -16
+
-
|
+
-
* The device reports, that the restore process was not successful
+
-
|}
+

Current revision as of 12:26, 16 September 2014

-delete me-

Personal tools