User's Manual

RK-5424-5 Reference Kit User’s Guide 4-29
iBeanAPI_IO.h
5. ibApi_IO_ReadRawADC()
ibApi_FUNC ibApi_IO_ReadRawADC(
ibApi_APIHANDLE api_hdl,
ibApi_DEVICEID device_id,
ibApi_UINT8 channel_index,
ibApi_UINT16* adc_value
);
This retrieves the value of the specified ADC channel in raw format. Use this call only if a raw
value is explicitly required, otherwise use ibApi_IO_ReadADC() which returns a float value
voltage. The raw return value may be converted to a voltage using
ibApi_Utils_ConvertRawAdcReadingToVoltage() found in iBeanAPI_Utils.h.
Parameters:
api_hdl: (input) API handle returned from ibApi_Open().
device_id: (input) ID of the device to be accessed.
channel_index: (input) Channel index to access.
adc_value: (output) Result of the ADC reading in raw data, not voltage. Application can use
ibApi_Utils_ConvertRawBatteryReadingToVoltage() to convert to voltage.
Return Value:
An ibApi_RESULT_SUCCESSFUL if successful, or an error code (<0) if not.
6. ibApi_IO_SetDIOConfig()
ibApi_FUNC ibApi_IO_SetDIOConfig (
ibApi_APIHANDLE api_hdl,
ibApi_DEVICEID device_id,
ibApi_UINT8 channel_index,
ibApi_IOMODE io_mode
);
This sets whether the specified DIO channel is configured for input or output, which governs
the interpretation of ibApi_IO_ReadDIO() and ibApi_IO_WriteDIO().
Parameters:
api_hdl: (input) API handle returned from ibApi_Open().
device_id: (input) ID of the device to be accessed.
channel_index: (input) Channel index to access.
io_mode: (input) Input/output mode.
Return Value:
An ibApi_RESULT_SUCCESSFUL if successful, or an error code (<0) if not.