BltTofApi Manual

From BlueWiki

(Difference between revisions)
Jump to: navigation, search
(→BTAopen)
(→BTAgetFrame)
Line 197: Line 197:
|
|
* An error occured while accessing registers on the devide  
* An error occured while accessing registers on the devide  
 +
|-
 +
|BTA_StatusUnexpectedDataFormat
 +
|
 +
* The device is not configured correctly for the currently set frame mode
|}
|}

Revision as of 14:18, 4 September 2014

Contents

1 BTAgetVersion

BTA_StatusOutOfMemory
  • The given buildDateTime string is not long enough
  • The given supportedDeviceTypes array is not long enough
BTA_StatusRuntimeError
  • There was an error while copying the information into the given buffers.


2 BTAinitConfig

BTA_StatusInvalidParameter
  • The given config structure is not valid


3 BTAopen

BTA_StatusOutOfMemory
  • Not enough memory for the SDK instance
BTA_StatusRuntimeError
  • A thread could not be started
  • A mutex could not be initialized
BTA_StatusDeviceUnreachable
  • The connection attempt was not successful
  • The given serialNumer does not match any of the connected devices
BTA_StatusCommunicationError
  • The connection was established, but communication failed
BTA_StatusInvalidParameter
  • 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
  • The given frameMode is not supported by the device

4 BTAclose

BTA_StatusInvalidParameter
  • The given handle is invalid
BTA_StatusRuntimeError
  • A thread could not be stopped
  • A mutex could not be closed
  • A The resources are still under usage in another thread


5 BTAgetDeviceInfo

BTA_StatusInvalidParameter
  • The given handle is not valid
BTA_StatusOutOfMemory
  • The device info struct could not be allocated
BTA_StatusCommunicationError
  • There was an error when reading information from the camera


6 BTAsetKeepAliveMsgInterval

BTA_StatusInvalidParameter
  • The given handle is not valid
BTA_StatusIllegalOperation
  • BTAclose was called from a different thread


7 BTAsetControlCrcEnabled

BTA_StatusInvalidParameter
  • The given handle is not valid
BTA_StatusIllegalOperation
  • BTAclose was called from a different thread


8 BTAsetFrameMode

BTA_StatusInvalidParameter
  • The given handle is not valid
BTA_StatusIllegalOperation
  • BTAclose was called from a different thread
BTA_StatusNotSupported
  • The given frameMode is not supported by the device
BTA_StatusCommunicationError
  • An error occured while accessing registers on the devide


9 BTAsendReset

BTA_StatusInvalidParameter
  • The given handle is not valid
BTA_StatusIllegalOperation
  • BTAclose was called from a different thread
BTA_StatusNotConnected
  • The connection to the device has been lost
BTA_StatusDeviceUnreachable
  • Reading from or writing to the device resulted in an error
BTA_StatusProtocolViolation
  • Something went wrong internally, please contact Bluetechnix support
BTA_StatusInvalidAddress
  • The given register address is not valid
BTA_StatusIllegalOperation
  • Reading/writing the given register is not allowed


10 BTAgetFrame

BTA_StatusInvalidParameter
  • The given handle is not valid
BTA_StatusIllegalOperation
  • BTAclose was called from a different thread
BTA_StatusRuntimeError
  • Queueing is not configured properly
  • Device could not convert raw data
BTA_StatusNotSupported
  • The data received from the device can not be used (with current frameMode)
BTA_StatusTimeOut
  • No frame received from device within timeout
BTA_StatusOutOfMemory
  • Could not allocate memory for internal use
BTA_StatusCommunicationError
  • An error occured while accessing registers on the devide
BTA_StatusUnexpectedDataFormat
  • The device is not configured correctly for the currently set frame mode

11 BTAgetIntegrationTime

same as BTAreadRegister

12 BTAsetIntegrationTime

same as BTAwriteRegister

BTA_StatusInvalidParameter
  • The given integration time is not valid


13 BTAgetFrameRate

same as BTAreadRegister


14 BTAsetFrameRate

same as BTAwriteRegister

BTA_StatusInvalidParameter
  • The given frame rate time is not valid


15 BTAgetGlobalOffset

same as BTAreadRegister

BTA_StatusInvalidConfiguration
  • For the current device configuration (e.g. modulation frequency) the operation can not be performed


16 BTAsetGlobalOffset

same as BTAreadRegister same as BTAwriteRegister

BTA_StatusInvalidParameter
  • The given offset is not valid


17 BTAreadRegister

BTA_StatusInvalidParameter
  • The given handle is not valid
  • The given registerCount is not valid
BTA_StatusIllegalOperation
  • BTAclose was called from a different thread
BTA_StatusNotConnected
  • The connection to the device has been lost
BTA_StatusDeviceUnreachable
  • Reading from or writing to the device resulted in an error
BTA_StatusProtocolViolation
  • Something went wrong internally, please contact Bluetechnix support
BTA_StatusInvalidAddress
  • The given register address is not valid
BTA_StatusIllegalOperation
  • Reading/writing the given register is not allowed
BTA_StatusOutOfMemory
  • Could not allocate memory

18 BTAwriteRegister

BTA_StatusInvalidParameter
  • The given handle is not valid
  • The given registerCount is not valid
  • The given register value is not valid
BTA_StatusIllegalOperation
  • BTAclose was called from a different thread
BTA_StatusNotConnected
  • The connection to the device has been lost
BTA_StatusDeviceUnreachable
  • Reading from or writing to the device resulted in an error
BTA_StatusProtocolViolation
  • Something went wrong internally, please contact Bluetechnix support
BTA_StatusInvalidAddress
  • The given register address is not valid
BTA_StatusIllegalOperation
  • Reading/writing the given register is not allowed

19 BTAflashUpdate

BTA_StatusInvalidParameter
  • The given handle is not valid
  • The given flash target is not valid
  • The given flash ID is not valid
BTA_StatusIllegalOperation
  • BTAclose was called from a different thread
BTA_StatusNotConnected
  • The connection to the device has been lost
BTA_StatusDeviceUnreachable
  • Reading from or writing to the device resulted in an error
BTA_StatusProtocolViolation
  • Something went wrong internally, please contact Bluetechnix support
BTA_StatusInvalidAddress
  • The given register address is not valid
BTA_StatusIllegalOperation
  • Reading/writing the given register is not allowed
BTA_StatusRuntimeError
  • The device did not respond as expected during the update process
BTA_StatusCommunicationError
  • There was an error during the file transmission
BTA_StatusOutOfMemory
  • Not enough memory for performing the update process
BTA_StatusFlashingFailed
  • Flash Update failed

20 BTAfirmwareUpdate

same as BTAflashUpdate

BTA_StatusInvalidParameter
  • The given handle is not valid
  • The given file name is not valid
BTA_StatusOutOfMemory
  • Not enough memory for reading in the firmware file
BTA_StatusRuntimeError
  • The file could not be (fully) read

21 BTAgetDistances

BTA_StatusInvalidParameter
  • The given frame or a given buffer is not valid
BTA_StatusInvalidDataFormat
  • The given frame does not contain distance data


22 BTAgetAmplitudes

BTA_StatusInvalidParameter
  • The given frame or a given buffer is not valid
BTA_StatusInvalidDataFormat
  • The given frame does not contain amplitude data


23 BTAgetFlags

BTA_StatusInvalidParameter
  • The given frame or a given buffer is not valid
BTA_StatusInvalidDataFormat
  • The given frame does not contain flag data


24 BTAgetXYZcoordinates

BTA_StatusInvalidParameter
  • The given frame or a given buffer is not valid
BTA_StatusInvalidDataFormat
  • The given frame does not contain x/y/z data


25 BTAfreeFrame

BTA_StatusInvalidParameter
  • The given frame is not valid


26 BTAfreeDeviceInfo

BTA_StatusInvalidParameter
  • The given deviceInfo is not valid


27 BTAwriteCurrentConfigToNvm

same as BTAwriteRegister and BTAreadRegister

BTA_StatusRuntimeError
  • The device reports, that the write process was not successful

28 BTArestoreDefaultConfig

same as BTAwriteRegister and BTAreadRegister

BTA_StatusRuntimeError
  • The device reports, that the restore process was not successful
Retrieved from "https://support.bluetechnix.at/wiki/BltTofApi_Manual"
Personal tools