Data Types for the AFBR-S50 Explorer Demo Application

AFBR-S50 Explorer Application - Data Types. More...

Collaboration diagram for Data Types for the AFBR-S50 Explorer Demo Application:

Data Structures
struct	explorer_cfg_t
struct	explorer_t

Enumerations
enum	ExplorerApp_SerialCommandCodes {   CMD_SOFTWARE_INFO = 0x05 ,   CMD_SOFTWARE_VERSION = 0x0C ,   CMD_MODULE_TYPE = 0x0E ,   CMD_MODULE_UID = 0x0F ,   CMD_MEASUREMENT_SINGLE_SHOT = 0x10 ,   CMD_MEASUREMENT_START = 0x11 ,   CMD_MEASUREMENT_STOP = 0x12 ,   CMD_DEVICE_ABORT = 0x13 ,   CMD_DEVICE_REINIT = 0x15 ,   CMD_MEASUREMENT_CALIBRATION = 0x18 ,   CMD_FLASH = 0x19 ,   CMD_MEASUREMENT_DATA_FULL_DEBUG = 0x31 ,   CMD_MEASUREMENT_DATA_FULL = 0x32 ,   CMD_MEASUREMENT_DATA_3D_DEBUG = 0x33 ,   CMD_MEASUREMENT_DATA_3D = 0x34 ,   CMD_MEASUREMENT_DATA_1D_DEBUG = 0x35 ,   CMD_MEASUREMENT_DATA_1D = 0x36 ,   CMD_CONFIGURATION_DATA_OUTPUT_MODE = 0x41 ,   CMD_CONFIGURATION_MEASUREMENT_MODE = 0x42 ,   CMD_CONFIGURATION_FRAME_TIME = 0x43 ,   CMD_CONFIGURATION_DUAL_FREQUENCY_MODE = 0x44 ,   CMD_CONFIGURATION_SMART_POWER_SAVE = 0x45 ,   CMD_CONFIGURATION_SHOT_NOISE_MONITOR_MODE = 0x46 ,   CMD_CONFIGURATION_XTALK_MONITOR_MODE = 0x47 ,   CMD_CONFIGURATION_DCA = 0x52 ,   CMD_CONFIGURATION_PBA = 0x54 ,   CMD_CONFIGURATION_SPI = 0x58 ,   CMD_CONFIGURATION_UART = 0x59 ,   CMD_CALIBRATION_GLOBAL_RANGE_OFFSET = 0x61 ,   CMD_CALIBRATION_PIXEL_RANGE_OFFSETS = 0x67 ,   CMD_CALIBRATION_PIXEL_RANGE_OFFSETS_RESET = 0x68 ,   CMD_CALIBRATION_RANGE_OFFSET_SAMPLE_TIME = 0x69 ,   CMD_CALIBRATION_XTALK_VECTOR_TABLE = 0x62 ,   CMD_CALIBRATION_XTALK_RESET_VECTOR_TABLE = 0x63 ,   CMD_CALIBRATION_XTALK_SAMPLE_TIME = 0x64 ,   CMD_CALIBRATION_XTALK_MAX_AMPLITUDE = 0x65 ,   CMD_CALIBRATION_XTALK_PIXEL_2_PIXEL = 0x66 }
enum	explorer_flash_cmd_t {   CMD_FLASH_CLEAR_USER_CALIBRATION = 0x44 ,   CMD_FLASH_CLEAR_ALL = 0xFF }
enum	explorer_cal_sequence_t {   CALIBRATION_SEQUENCE_XTALK = 2 ,   CALIBRATION_SEQUENCE_OFFSETS = 5 }
enum	data_output_mode_t {   DATA_OUTPUT_STREAMING_FULL_DEBUG = 2 ,   DATA_OUTPUT_STREAMING_FULL = 3 ,   DATA_OUTPUT_STREAMING_3D_DEBUG = 4 ,   DATA_OUTPUT_STREAMING_3D = 5 ,   DATA_OUTPUT_STREAMING_1D_DEBUG = 6 ,   DATA_OUTPUT_STREAMING_1D = 7 }

Detailed Description

AFBR-S50 Explorer Application - Data Types.

---

Definitions for AFBR-S50 Explorer Application specific data types.

Enumeration Type Documentation

data_output_mode_t

enum data_output_mode_t

Available data output modes for the SCI interface.

Enumerator
DATA_OUTPUT_STREAMING_FULL_DEBUG	Streaming data output of 1D and 3D measurement data, raw samples and auxiliary and debug information.
DATA_OUTPUT_STREAMING_FULL	Streaming data output of 1D and 3D measurement data and auxiliary information.
DATA_OUTPUT_STREAMING_3D_DEBUG	Streaming data output of 3D measurement data, auxiliary and debug information.
DATA_OUTPUT_STREAMING_3D	Streaming data output of 3D measurement data and auxiliary information.
DATA_OUTPUT_STREAMING_1D_DEBUG	Streaming data output of 1D measurement data, auxiliary and debug information.
DATA_OUTPUT_STREAMING_1D	Streaming data output of 1D measurement data only.

explorer_cal_sequence_t

enum explorer_cal_sequence_t

Calibration sequences for SCI interface.

Enumerator
CALIBRATION_SEQUENCE_XTALK	Crosstalk calibration sequence.
CALIBRATION_SEQUENCE_OFFSETS	Range offsets calibration sequence.

explorer_flash_cmd_t

enum explorer_flash_cmd_t

Flash sub-commands.

Enumerator
CMD_FLASH_CLEAR_USER_CALIBRATION	Clears all (API) user (i.e. actual) values from the non-volatile flash memory.
CMD_FLASH_CLEAR_ALL	Clears all data from the non-volatile flash memory.

ExplorerApp_SerialCommandCodes

enum ExplorerApp_SerialCommandCodes

Command byte definitions.

Enumerator
CMD_SOFTWARE_INFO	Gets the information about current software and device (e.g. version, device id, device family, ...)
CMD_SOFTWARE_VERSION	Gets the current software version number.
CMD_MODULE_TYPE	Gets the current module information.
CMD_MODULE_UID	Gets the current module identification number.
CMD_MEASUREMENT_SINGLE_SHOT	Invokes the single measurement shot command.
CMD_MEASUREMENT_START	Starts the time-scheduled measurements with given frame rate.
CMD_MEASUREMENT_STOP	Stops the time-scheduled measurements (after the current frame finishes).
CMD_DEVICE_ABORT	Aborts all device activity.
CMD_DEVICE_REINIT	Reinitializes the device with default configuration.
CMD_MEASUREMENT_CALIBRATION	Executes the calibration measurement sequence.
CMD_FLASH	Executed a flash read/write/clear command.
CMD_MEASUREMENT_DATA_FULL_DEBUG	Gets a raw measurement data set containing the raw device readout samples. ‍/ CMD_MEASUREMENT_DATA_RAW = 0x30, /! Gets a full measurement data set containing all available data.
CMD_MEASUREMENT_DATA_FULL	Gets a full measurement data set containing all essential data.
CMD_MEASUREMENT_DATA_3D_DEBUG	Gets a 3D measurement data set including distance, amplitude, raw and debug data per pixel.
CMD_MEASUREMENT_DATA_3D	Gets a 3D measurement data set including distance and amplitude data per pixel.
CMD_MEASUREMENT_DATA_1D_DEBUG	Gets a 1D measurement data set including a single distance and amplitude value plus debug information.
CMD_MEASUREMENT_DATA_1D	Gets a 1D measurement data set including a single distance and amplitude value.
CMD_CONFIGURATION_DATA_OUTPUT_MODE	Gets or sets the configuration of the measurement data output mode
CMD_CONFIGURATION_MEASUREMENT_MODE	Gets or sets the configuration of the measurement data evaluation method
CMD_CONFIGURATION_FRAME_TIME	Gets or sets the measurement frame time.
CMD_CONFIGURATION_DUAL_FREQUENCY_MODE	Gets or sets the Dual Frequency Mode.
CMD_CONFIGURATION_SMART_POWER_SAVE	Gets or sets the Smart Power Save Mode Enabled flag.
CMD_CONFIGURATION_SHOT_NOISE_MONITOR_MODE	Gets or sets the Shot Noise Monitor mode.
CMD_CONFIGURATION_XTALK_MONITOR_MODE	Gets or sets the Crosstalk Monitor mode.
CMD_CONFIGURATION_DCA	Gets or sets a full DCA (Dynamic Configuration Adaption) configuration set.
CMD_CONFIGURATION_PBA	Gets or sets a full PBA (Pixel Binning Algorithm) configuration set.
CMD_CONFIGURATION_SPI	Gets or sets a full SPI configuration set. Gets or sets the UART configuration, i.e. the baud rate.
CMD_CONFIGURATION_UART
CMD_CALIBRATION_GLOBAL_RANGE_OFFSET	Gets or sets the global range offset.
CMD_CALIBRATION_PIXEL_RANGE_OFFSETS	Gets or sets the custom pixel range offsets.
CMD_CALIBRATION_PIXEL_RANGE_OFFSETS_RESET	Resets the custom pixel range offsets.
CMD_CALIBRATION_RANGE_OFFSET_SAMPLE_TIME	Gets or sets the range offset calibration sequence sample time.
CMD_CALIBRATION_XTALK_VECTOR_TABLE	Gets or sets the custom crosstalk vector table.
CMD_CALIBRATION_XTALK_RESET_VECTOR_TABLE	Resets the custom crosstalk vector table.
CMD_CALIBRATION_XTALK_SAMPLE_TIME	Gets or sets the crosstalk calibration sequence sample time.
CMD_CALIBRATION_XTALK_MAX_AMPLITUDE	Gets or sets the crosstalk calibration sequence maximum amplitude threshold.
CMD_CALIBRATION_XTALK_PIXEL_2_PIXEL	Gets or sets the pixel-to-pixel crosstalk compensation parameters.