explorer_types.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef EXPLORER_API_TYPES_H
#define EXPLORER_API_TYPES_H
 
/*!***************************************************************************
 * @defgroup    explorer_types Data Types for the AFBR-S50 Explorer Demo Application
 * @ingroup     explorer_app
 * @brief       AFBR-S50 Explorer Application - Data Types
 * @details     Definitions for AFBR-S50 Explorer Application specific data types.
 * @addtogroup  explorer_types
 * @{
 *****************************************************************************/
 
#include "argus.h"
#include "sci/sci.h"
 
enum ExplorerApp_SerialCommandCodes
{
    CMD_SOFTWARE_INFO = 0x05,
    CMD_SOFTWARE_VERSION = 0x0C,
    CMD_MODULE_TYPE = 0x0E,
    CMD_MODULE_UID = 0x0F,
 
    /* Generic measurement commands. */
    CMD_MEASUREMENT_SINGLE_SHOT = 0x10,
    CMD_MEASUREMENT_START = 0x11,
    CMD_MEASUREMENT_STOP = 0x12,
    CMD_MEASUREMENT_START_TEACH_IN = 0x20,
    CMD_MEASUREMENT_STOP_TEACH_IN = 0x22,
    CMD_DEVICE_ABORT = 0x13,
    CMD_DEVICE_REINIT = 0x15,
    CMD_MEASUREMENT_CALIBRATION = 0x18,
 
    CMD_FLASH = 0x19,
 
#if EXPLORER_API_PRO
 
    CMD_DEBUG_MODE = 0x16,
 
    CMD_EEPROM = 0x17,
 
    CMD_STACK_USAGE = 0x09,
 
    CMD_INJECT_FAULT = 0x0D,
 
    CMD_SPI_WRITE = 0x1A,
    CMD_SPI_READ = 0x1C,
    CMD_SPI_TRANSFER = 0x1D,
    CMD_SPI_RESPONSE = 0x1E,
#endif
 
//  /*! Gets a raw measurement data set containing the raw device readout samples. */
//  CMD_MEASUREMENT_DATA_RAW = 0x30,
    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,
 
#if EXPLORER_API_PRO
 
    CMD_CONFIGURATION = 0x40,
    CMD_CONFIGURATION_DEFAULT = 0x50,
#endif
 
    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,
 
#if EXPLORER_API_PRO
    CMD_CALIBRATION = 0x60,
    CMD_CALIBRATION_DEFAULT = 0x70,
    #endif
 
    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,
 
};
 
typedef enum explorer_flash_cmd_t
{
#if EXPLORER_API_PRO
 
    CMD_FLASH_CONFIGURATION_SAVE = 0x11,
    CMD_FLASH_CONFIGURATION_LOAD = 0x12,
    CMD_FLASH_CONFIGURATION_CLEAR = 0x13,
    CMD_FLASH_CONFIGURATION_RESET = 0x14,
 
    CMD_FLASH_CALIBRATION_SAVE = 0x21,
    CMD_FLASH_CALIBRATION_LOAD = 0x22,
    CMD_FLASH_CALIBRATION_CLEAR = 0x23,
    CMD_FLASH_CALIBRATION_RESET = 0x24,
 
    CMD_FLASH_SETTINGS_SAVE = 0x31,
    CMD_FLASH_SETTINGS_LOAD = 0x32,
    CMD_FLASH_SETTINGS_CLEAR = 0x33,
    CMD_FLASH_SETTINGS_RESET = 0x34,
#endif
 
    CMD_FLASH_CLEAR_USER_CALIBRATION = 0x44,
 
    CMD_FLASH_CLEAR_ALL = 0xFF,
 
} explorer_flash_cmd_t;
 
typedef enum explorer_cal_sequence_t
{
#if EXPLORER_API_PRO
 
    CALIBRATION_SEQUENCE_VSUB = 1,
#endif
 
    CALIBRATION_SEQUENCE_XTALK = 2,
 
#if EXPLORER_API_PRO
 
    CALIBRATION_SEQUENCE_PLL = 4,
#endif
 
    CALIBRATION_SEQUENCE_OFFSETS = 5,
 
} explorer_cal_sequence_t;
 
 
typedef 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
 
} data_output_mode_t;
 
typedef struct explorer_cfg_t
{
    uint32_t SPIBaudRate;
 
    volatile uint8_t DebugMode;
 
    volatile data_output_mode_t DataOutputMode;
 
} explorer_cfg_t;
 
typedef struct explorer_t
{
    sci_device_t DeviceID;
 
    explorer_cfg_t Configuration;
 
    argus_hnd_t * Argus;
 
} explorer_t;
 
#if EXPLORER_API_PRO
 
typedef enum explorer_faults_t
{
    EXPLORER_FAUL_NONE = 0,
 
    EXPLORER_FAULT_SKIP_GPIO_IRQ = 1,
 
    EXPLORER_FAULT_SKIP_SPI_IRQ = 2,
 
} explorer_faults_t;
 
#endif
 
 
#endif /* EXPLORER_API_TYPES_H */