AFBR-S50 API Reference Manual  v1.6.5
AFBR-S50 Time-of-Flight Sensor SDK for Embedded Software
explorer_types.h
Go to the documentation of this file.
1 /*************************************************************************/
37 #ifndef EXPLORER_API_TYPES_H
38 #define EXPLORER_API_TYPES_H
39 
40 /*!***************************************************************************
41  * @defgroup explorer_types Data Types for the AFBR-S50 Explorer Demo Application
42  * @ingroup explorer_app
43  * @brief AFBR-S50 Explorer Application - Data Types
44  * @details Definitions for AFBR-S50 Explorer Application specific data types.
45  * @addtogroup explorer_types
46  * @{
47  *****************************************************************************/
48 
49 #include "argus.h"
50 #include "sci/sci.h"
51 
54 {
64 
65  /* Generic measurement commands. */
82 
84  CMD_FLASH = 0x19,
85 
86 #if EXPLORER_API_PRO
87 
88  CMD_DEBUG_MODE = 0x16,
89 
91  CMD_EEPROM = 0x17,
92 
94  CMD_STACK_USAGE = 0x09,
95 
97  CMD_INJECT_FAULT = 0x0D,
98 
100  CMD_SPI_WRITE = 0x1A,
102  CMD_SPI_READ = 0x1C,
104  CMD_SPI_TRANSFER = 0x1D,
106  CMD_SPI_RESPONSE = 0x1E,
107 #endif
108 
109 // /*! Gets a raw measurement data set containing the raw device readout samples. */
110 // CMD_MEASUREMENT_DATA_RAW = 0x30,
123 
124 #if EXPLORER_API_PRO
125 
126  CMD_CONFIGURATION = 0x40,
128  CMD_CONFIGURATION_DEFAULT = 0x50,
129 #endif
130 
145 
154 
155 #if EXPLORER_API_PRO
156  CMD_CALIBRATION = 0x60,
158  CMD_CALIBRATION_DEFAULT = 0x70,
159  #endif
160 
168 
179 
180 };
181 
184 {
185 #if EXPLORER_API_PRO
186 
187  CMD_FLASH_CONFIGURATION_SAVE = 0x11,
189  CMD_FLASH_CONFIGURATION_LOAD = 0x12,
191  CMD_FLASH_CONFIGURATION_CLEAR = 0x13,
193  CMD_FLASH_CONFIGURATION_RESET = 0x14,
194 
196  CMD_FLASH_CALIBRATION_SAVE = 0x21,
198  CMD_FLASH_CALIBRATION_LOAD = 0x22,
200  CMD_FLASH_CALIBRATION_CLEAR = 0x23,
202  CMD_FLASH_CALIBRATION_RESET = 0x24,
203 
205  CMD_FLASH_SETTINGS_SAVE = 0x31,
207  CMD_FLASH_SETTINGS_LOAD = 0x32,
209  CMD_FLASH_SETTINGS_CLEAR = 0x33,
211  CMD_FLASH_SETTINGS_RESET = 0x34,
212 #endif
213 
216 
219 
221 
224 {
225 #if EXPLORER_API_PRO
226 
227  CALIBRATION_SEQUENCE_VSUB = 1,
228 #endif
229 
232 
233 #if EXPLORER_API_PRO
234 
235  CALIBRATION_SEQUENCE_PLL = 4,
236 #endif
237 
240 
242 
243 
245 typedef enum data_output_mode_t
246 {
249 
252 
255 
258 
261 
264 
266 
268 typedef struct explorer_cfg_t
269 {
271  uint32_t SPIBaudRate;
272 
274  volatile uint8_t DebugMode;
275 
278 
280 
282 typedef struct explorer_t
283 {
286 
289 
292 
293 } explorer_t;
294 
295 #if EXPLORER_API_PRO
296 
299 typedef enum explorer_faults_t
300 {
302  EXPLORER_FAUL_NONE = 0,
303 
307  EXPLORER_FAULT_SKIP_GPIO_IRQ = 1,
308 
312  EXPLORER_FAULT_SKIP_SPI_IRQ = 2,
313 
314 } explorer_faults_t;
315 
316 #endif
317 
318 
320 #endif /* EXPLORER_API_TYPES_H */
DATA_OUTPUT_STREAMING_1D
@ DATA_OUTPUT_STREAMING_1D
Definition: explorer_types.h:263
explorer_cfg_t::DataOutputMode
volatile data_output_mode_t DataOutputMode
Definition: explorer_types.h:277
DATA_OUTPUT_STREAMING_1D_DEBUG
@ DATA_OUTPUT_STREAMING_1D_DEBUG
Definition: explorer_types.h:260
CMD_SOFTWARE_VERSION
@ CMD_SOFTWARE_VERSION
Definition: explorer_types.h:59
CMD_CALIBRATION_GLOBAL_RANGE_OFFSET
@ CMD_CALIBRATION_GLOBAL_RANGE_OFFSET
Definition: explorer_types.h:161
sci_device_t
uint8_t sci_device_t
Definition: sci.h:99
DATA_OUTPUT_STREAMING_FULL_DEBUG
@ DATA_OUTPUT_STREAMING_FULL_DEBUG
Definition: explorer_types.h:248
CMD_CALIBRATION_XTALK_SAMPLE_TIME
@ CMD_CALIBRATION_XTALK_SAMPLE_TIME
Definition: explorer_types.h:174
explorer_cfg_t::SPIBaudRate
uint32_t SPIBaudRate
Definition: explorer_types.h:271
explorer_cal_sequence_t
explorer_cal_sequence_t
Definition: explorer_types.h:223
ExplorerApp_SerialCommandCodes
ExplorerApp_SerialCommandCodes
Definition: explorer_types.h:53
explorer_t::Configuration
explorer_cfg_t Configuration
Definition: explorer_types.h:288
CMD_CALIBRATION_RANGE_OFFSET_SAMPLE_TIME
@ CMD_CALIBRATION_RANGE_OFFSET_SAMPLE_TIME
Definition: explorer_types.h:167
CMD_MEASUREMENT_START_TEACH_IN
@ CMD_MEASUREMENT_START_TEACH_IN
Definition: explorer_types.h:73
explorer_flash_cmd_t
explorer_flash_cmd_t
Definition: explorer_types.h:183
explorer_t
Definition: explorer_types.h:282
CMD_CALIBRATION_PIXEL_RANGE_OFFSETS
@ CMD_CALIBRATION_PIXEL_RANGE_OFFSETS
Definition: explorer_types.h:163
CMD_MODULE_TYPE
@ CMD_MODULE_TYPE
Definition: explorer_types.h:61
data_output_mode_t
data_output_mode_t
Definition: explorer_types.h:245
CMD_CONFIGURATION_MEASUREMENT_MODE
@ CMD_CONFIGURATION_MEASUREMENT_MODE
Definition: explorer_types.h:134
sci.h
SCI: The main interface.
CMD_MEASUREMENT_DATA_FULL_DEBUG
@ CMD_MEASUREMENT_DATA_FULL_DEBUG
Definition: explorer_types.h:112
DATA_OUTPUT_STREAMING_FULL
@ DATA_OUTPUT_STREAMING_FULL
Definition: explorer_types.h:251
CMD_CONFIGURATION_PBA
@ CMD_CONFIGURATION_PBA
Definition: explorer_types.h:149
CMD_MEASUREMENT_DATA_3D
@ CMD_MEASUREMENT_DATA_3D
Definition: explorer_types.h:118
CMD_DEVICE_REINIT
@ CMD_DEVICE_REINIT
Definition: explorer_types.h:79
CMD_MEASUREMENT_STOP_TEACH_IN
@ CMD_MEASUREMENT_STOP_TEACH_IN
Definition: explorer_types.h:75
CMD_MEASUREMENT_DATA_FULL
@ CMD_MEASUREMENT_DATA_FULL
Definition: explorer_types.h:114
DATA_OUTPUT_STREAMING_3D_DEBUG
@ DATA_OUTPUT_STREAMING_3D_DEBUG
Definition: explorer_types.h:254
CMD_FLASH_CLEAR_ALL
@ CMD_FLASH_CLEAR_ALL
Definition: explorer_types.h:218
argus_hnd_t
struct argus_hnd_t argus_hnd_t
Definition: argus_def.h:320
CMD_CONFIGURATION_SHOT_NOISE_MONITOR_MODE
@ CMD_CONFIGURATION_SHOT_NOISE_MONITOR_MODE
Definition: explorer_types.h:142
argus.h
This file is part of the AFBR-S50 API.
CMD_CONFIGURATION_XTALK_MONITOR_MODE
@ CMD_CONFIGURATION_XTALK_MONITOR_MODE
Definition: explorer_types.h:144
CMD_MEASUREMENT_STOP
@ CMD_MEASUREMENT_STOP
Definition: explorer_types.h:71
explorer_cfg_t
Definition: explorer_types.h:268
CMD_MEASUREMENT_CALIBRATION
@ CMD_MEASUREMENT_CALIBRATION
Definition: explorer_types.h:81
CMD_SOFTWARE_INFO
@ CMD_SOFTWARE_INFO
Definition: explorer_types.h:57
explorer_t::Argus
argus_hnd_t * Argus
Definition: explorer_types.h:291
CMD_CONFIGURATION_DATA_OUTPUT_MODE
@ CMD_CONFIGURATION_DATA_OUTPUT_MODE
Definition: explorer_types.h:132
CMD_CONFIGURATION_UART
@ CMD_CONFIGURATION_UART
Definition: explorer_types.h:153
CALIBRATION_SEQUENCE_XTALK
@ CALIBRATION_SEQUENCE_XTALK
Definition: explorer_types.h:231
CMD_CALIBRATION_XTALK_VECTOR_TABLE
@ CMD_CALIBRATION_XTALK_VECTOR_TABLE
Definition: explorer_types.h:170
CMD_MODULE_UID
@ CMD_MODULE_UID
Definition: explorer_types.h:63
CMD_MEASUREMENT_START
@ CMD_MEASUREMENT_START
Definition: explorer_types.h:69
CMD_CONFIGURATION_DCA
@ CMD_CONFIGURATION_DCA
Definition: explorer_types.h:147
CMD_FLASH_CLEAR_USER_CALIBRATION
@ CMD_FLASH_CLEAR_USER_CALIBRATION
Definition: explorer_types.h:215
CMD_CONFIGURATION_SPI
@ CMD_CONFIGURATION_SPI
Definition: explorer_types.h:151
CMD_MEASUREMENT_SINGLE_SHOT
@ CMD_MEASUREMENT_SINGLE_SHOT
Definition: explorer_types.h:67
explorer_cfg_t::DebugMode
volatile uint8_t DebugMode
Definition: explorer_types.h:274
CMD_CALIBRATION_PIXEL_RANGE_OFFSETS_RESET
@ CMD_CALIBRATION_PIXEL_RANGE_OFFSETS_RESET
Definition: explorer_types.h:165
CMD_DEVICE_ABORT
@ CMD_DEVICE_ABORT
Definition: explorer_types.h:77
CMD_CONFIGURATION_FRAME_TIME
@ CMD_CONFIGURATION_FRAME_TIME
Definition: explorer_types.h:136
CMD_MEASUREMENT_DATA_1D_DEBUG
@ CMD_MEASUREMENT_DATA_1D_DEBUG
Definition: explorer_types.h:120
CMD_CALIBRATION_XTALK_RESET_VECTOR_TABLE
@ CMD_CALIBRATION_XTALK_RESET_VECTOR_TABLE
Definition: explorer_types.h:172
CMD_MEASUREMENT_DATA_1D
@ CMD_MEASUREMENT_DATA_1D
Definition: explorer_types.h:122
CALIBRATION_SEQUENCE_OFFSETS
@ CALIBRATION_SEQUENCE_OFFSETS
Definition: explorer_types.h:239
CMD_MEASUREMENT_DATA_3D_DEBUG
@ CMD_MEASUREMENT_DATA_3D_DEBUG
Definition: explorer_types.h:116
DATA_OUTPUT_STREAMING_3D
@ DATA_OUTPUT_STREAMING_3D
Definition: explorer_types.h:257
CMD_CONFIGURATION_DUAL_FREQUENCY_MODE
@ CMD_CONFIGURATION_DUAL_FREQUENCY_MODE
Definition: explorer_types.h:138
CMD_CALIBRATION_XTALK_MAX_AMPLITUDE
@ CMD_CALIBRATION_XTALK_MAX_AMPLITUDE
Definition: explorer_types.h:176
explorer_t::DeviceID
sci_device_t DeviceID
Definition: explorer_types.h:285
CMD_CONFIGURATION_SMART_POWER_SAVE
@ CMD_CONFIGURATION_SMART_POWER_SAVE
Definition: explorer_types.h:140
CMD_CALIBRATION_XTALK_PIXEL_2_PIXEL
@ CMD_CALIBRATION_XTALK_PIXEL_2_PIXEL
Definition: explorer_types.h:178
CMD_FLASH
@ CMD_FLASH
Definition: explorer_types.h:84