Time-of-Flight-SDK
Public Member Functions | Public Attributes | List of all members
aditof::ADSDErrors Class Reference

Error codes from the ADSD3500, ADSD3100, ADSD3030 Usage: Included with aditof/camera.h For example: ADSDErrors err; LOG(INFO) << err.GetStringADSD3500(0x0001);. More...

#include <adsd_errs.h>

Public Member Functions

std::string GetStringADSD3500 (uint16_t value)
 Returns a string for a given target (adsdType) and error code for the ADSD3500. More...
 
std::string GetStringADSD3100 (uint16_t value)
 Returns a string for a given target (adsdType) and error code for the ADSD3100. More...
 
std::string GetStringADSD3030 (uint16_t value)
 Returns a string for a given target (adsdType) and error code for the ADSD3030. More...
 

Public Attributes

const uint16_t ADSD3500_STATUS_INVALID_MODE = 0x0001
 Mode selected is invalid.
 
const uint16_t ADSD3500_STATUS_INVALID_JBLF_FILTER_SIZE = 0x0002
 The JBLF filter size speficied is incorrect.
 
const uint16_t ADSD3500_STATUS_UNSUPPORTED_CMD = 0x0003
 An unsupported command was sent to the ASDD3500.
 
const uint16_t ADSD3500_STATUS_INVALID_MEMORY_REGION = 0x0004
 TODO.
 
const uint16_t ADSD3500_STATUS_INVALID_FIRMWARE_CRC = 0x0005
 The ADSD3500 firmware CRC check failed.
 
const uint16_t ADSD3500_STATUS_INVALID_IMAGER = 0x0006
 The imager firmware is not valid.
 
const uint16_t ADSD3500_STATUS_INVALID_CCB = 0x0007
 The imager CCB file is not valid.
 
const uint16_t ADSD3500_STATUS_FLASH_HEADER_PARSE_ERROR = 0x0008
 Flash update error.
 
const uint16_t ADSD3500_STATUS_FLASH_FILE_PARSE_ERROR = 0x0009
 Flash update error.
 
const uint16_t ADSD3500_STATUS_SPIM_ERROR = 0x000A
 SPI Master error occured, which this impacts the ADSD3500 - image communication.
 
const uint16_t ADSD3500_STATUS_INVALID_CHIPID = 0x000B
 The imager chip ID is invalid.
 
const uint16_t ADSD3500_STATUS_IMAGER_COMMUNICATION_ERROR = 0x000C
 SPI Master error occured during communication between the ASDSD3500 and the imager. More...
 
const uint16_t ADSD3500_STATUS_IMAGER_BOOT_FAILURE = 0x000D
 Unable to boot the imager.
 
const uint16_t ADSD3500_STATUS_IMAGER_ERROR = 0x0010
 The imager reported an error.
 
const uint16_t ADSD3500_STATUS_TIMEOUT_ERROR = 0x0011
 This is when timer is expired but ADSD3500 is not able to send out frame due to some error.
 
const uint16_t ADSD3500_STATUS_DYNAMIC_MODE_SWITCHING_NOT_ENABLED = 0x0013
 Dynamic mode switching is being set, but it is not enabled.
 
const uint16_t ADSD3500_STATUS_INVALID_DYNAMIC_MODE_COMPOSITIONS = 0x0014
 The selected dyanamic mode configuration is not valid.
 
const uint16_t ADSD3500_STATUS_INVALID_PHASE_INVALID_VALUE = 0x0015
 An incorrect phase invalid value specified.
 
const uint16_t ADSD3500_STATUS_FIRMWARE_UPDATE_COMPLETE = 0x000E
 Firmware update is complete.
 
const uint16_t ADSD3500_STATUS_NVM_WRITE_COMPLETE = 0x000F
 NVM update is complete.
 
const uint16_t ADSD3100_ERR_MODE_USECASE = 0x0001
 Invalid mode selection. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_MODE_MODE_DRIVER = 0x0002
 Invalid LD mode selection. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_PLLLOCK_LOCK1 = 0x0004
 PLLLOCK error location 1. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_PLLLOCK_LOCK2
 PLLLOCK error location 2. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010) More...
 
const uint16_t ADSD3100_ERR_PLLLOCK_LOCK3
 PLLLOCK error location 3. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010) More...
 
const uint16_t ADSD3100_ERR_OVERHEAT_IMAGER = 0x0010
 Imager sensor overheat. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_OVERHEAT_LD = 0x0020
 Laser driver overheat. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_LASER_CHIPID = 0x0040
 Laser driver invalid chip ID. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_LASER_LPS = 0x0080
 Corrupted laser driver data. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_LASER_NO_DIFFUSER = 0x0100
 Laser diffuser problem. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_LASER_SHORT = 0x0140
 Laser driver shorted to GND. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_LVDS_HIGH_DC = 0x0180
 Laser driver duty cycle too large. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_LVDS_PULSE_LONG = 0x01C0
 Laser driver active time too long. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_LVDS_OPEN_SHORT = 0x0200
 Laser driver input open or short detected. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_LASER_LONG_LEN_ON = 0x0240
 Laser driver enabled for too long of time. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_LASER_SHORT_LEN_OFF = 0x0280
 Laser driver disabled for too short of time. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_LASER_LPS_READ = 0x02C0
 Laser driver corrupted data. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_LASER_VLD_LOW = 0x0300
 Laser driver supply too low. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 
const uint16_t ADSD3100_ERR_LASER_VLD_HIGH = 0x0340
 Laser driver supply too high. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)
 

Detailed Description

Error codes from the ADSD3500, ADSD3100, ADSD3030 Usage: Included with aditof/camera.h For example: ADSDErrors err; LOG(INFO) << err.GetStringADSD3500(0x0001);.

Definition at line 51 of file adsd_errs.h.

Member Function Documentation

◆ GetStringADSD3030()

std::string aditof::ADSDErrors::GetStringADSD3030 ( uint16_t  value)
inline

Returns a string for a given target (adsdType) and error code for the ADSD3030.

Parameters
[in]value- Error value
Returns
Error string

Definition at line 159 of file adsd_errs.h.

◆ GetStringADSD3100()

std::string aditof::ADSDErrors::GetStringADSD3100 ( uint16_t  value)
inline

Returns a string for a given target (adsdType) and error code for the ADSD3100.

Parameters
[in]value- Error value
Returns
Error string

Definition at line 141 of file adsd_errs.h.

◆ GetStringADSD3500()

std::string aditof::ADSDErrors::GetStringADSD3500 ( uint16_t  value)
inline

Returns a string for a given target (adsdType) and error code for the ADSD3500.

Parameters
[in]value- Error value
Returns
Error string

Definition at line 123 of file adsd_errs.h.

Member Data Documentation

◆ ADSD3100_ERR_PLLLOCK_LOCK2

const uint16_t aditof::ADSDErrors::ADSD3100_ERR_PLLLOCK_LOCK2
Initial value:
=
0x0008

PLLLOCK error location 2. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)

Definition at line 274 of file adsd_errs.h.

◆ ADSD3100_ERR_PLLLOCK_LOCK3

const uint16_t aditof::ADSDErrors::ADSD3100_ERR_PLLLOCK_LOCK3
Initial value:
=
0x000C

PLLLOCK error location 3. Imager error codes read via "Get Imager Error Code" (0x0038) command Note, this only valid if "Get Status" (0x0020) reports a value of "ADSD3500_STATUS_IMAGER_ERROR" (0x0010)

Definition at line 281 of file adsd_errs.h.

◆ ADSD3500_STATUS_IMAGER_COMMUNICATION_ERROR

const uint16_t aditof::ADSDErrors::ADSD3500_STATUS_IMAGER_COMMUNICATION_ERROR = 0x000C

SPI Master error occured during communication between the ASDSD3500 and the imager.

Definition at line 215 of file adsd_errs.h.


The documentation for this class was generated from the following file: