User Manual

EK-5209-5 Evaluation Kit User’s Guide A-17
iBeanAPI_IO.h
Functions
This structure is used by ibApi_IO_GetDeviceCaps() to return various static device
attributes that are predetermined at manufacturing time.
Structure Fields:
struct_size The value size of (ibApi_IO_DEVICECAPS) should be
assigned to this field prior to calling
ibApi_IO_GetDeviceCaps(). This allows future
versions of the API to extend the struct without breaking
binary compatibility.
num_dio_channels This is the number of DIO channels (i.e., the channel index
passed to ibApi_IO_ReadDIO() must be less than this).
num_adc_channels This is the number of DIO channels (i.e., the channel index
passed to ibApi_IO_ReadADC() must be less than this).
adc_resolution_bits This is the number of bits of resolution supported by the
A/D converter, i.e. the maximum value for the raw data will
be (1<<adc_rsolution_bits)-1.
serial_input_buffer_depth This is the number of input data packets slots for which
packets can be pending to be read by the API-based
application.
serial_output_buffer_depth This is the number of output data packet slots for which
packets can be pending to be send by the monitor.
1. ibApi_IO_GetDeviceCaps()
ibApi_FUNC ibApi_IO_GetDeviceCaps (
ibApi_APIHANDLE api_hdl,
ibApi_DEVICEID device_id,
ibApi_IO_DEVICECAPS * device_caps
);
This function retrieves various static device attributes that are predetermined at
manufacturing time. Thus, these values only need to be queried once for a particular device.
See ibApi_IO_DEVICECAPS above for details.
Note: To avoid memory corruption, size of (ibApi_IO_DEVICECAPS) must be assigned
to the “struct_size” field prior to calling this function.
Parameters:
api_hdl: (input) API handle returned from ibApi_Open().
device_id: (input) ID of the device to be accessed.
device_caps: (output) Pointer to variable storing the result.
Return Value:
An ibApi_RESULT_SUCCESS if successful, error code (<0) if not.