EasyManua.ls Logo

ST VD6283 - Enum Stals_Errcode_T; Enum Stals_Control_T; Enum Stals_Control_Id_T

ST VD6283
27 pages
Print Icon
To Next Page IconTo Next Page
To Next Page IconTo Next Page
To Previous Page IconTo Previous Page
To Previous Page IconTo Previous Page
Loading...
3.5.3 enum STALS_ErrCode_t
This enumeration is aimed at defining the different errors that can be returned by the STALS driver.
Enumerator
STALS_NO_ERROR indicates no error
STALS_ERROR_INVALID_PARAMS indicates provided parameters are invalid
STALS_ERROR_INIT indicates error in the initialization of the VD6283 device
STALS_ERROR_TIME_OUT indicates a time out has expired before an operation was completed
STALS_ERROR_INVALID_DEVICE_ID indicates the provided device identifier is invalid
STALS_ERROR_WRITE indicates the trial to write on the I2C bus has failed
STALS_ERROR_READ indicates the trial to read from the I2C bus has failed
STALS_ERROR_ALREADY_STARTED indicates the device is already started
STALS_ERROR_NOT_STARTED indicates the device is not started
STALS_ERROR_NOT_SUPPORTED indicates the called function is not supported, likely because not yet
implemented
STALS_ERROR_FNCT_DEPRECATED indicates the called function is deprecated
STALS_ERROR_LAST_ERROR_CODE
3.5.4 enum STALS_Control_t
This enumeration is aimed at defining the Enable and disable flags.
Enumerator
STALS_CONTROL_DISABLE disables the feature
STALS_CONTROL_ENABLE enables the feature
3.5.5 enum STALS_Control_Id_t
This enumeration is aimed at defining the different parameters identifiers.
Enumerator
STALS_PEDESTAL_ENABLE Control to be used to enable or disable the pedestal
To enable the pedestal : STALS_SetControl(pHandle, STALS_PEDESTAL_ENABLE,
STALS_CONTROL_ENABLE);
To disable the pedestal : STALS_SetControl(pHandle, STALS_PEDESTAL_ENABLE,
STALS_CONTROL_DISABLE);
To know if the pedestal is enabled : enum STALS_Control_t Flag; STALS_GetControl(pHandle,
STALS_PEDESTAL_ENABLE, &Flag);
STALS_PEDESTAL_VALUE Control to set the value of the pedestal
For example : STALS_SetControl(pHandle, STALS_PEDESTAL_VALUE, 6);
STALS_OUTPUT_DARK_ENABLE Control to set if dark is output. For VD6283 dark count will be output on
channel 2.
STALS_SDA_DRIVE_VALUE_MA Control to set drive current in sda pad in mA when device is driving sda line.
Possible values for VD6283 are 4, 8, 12, 16, 20 mA.
STALS_SATURATION_VALUE Control to read saturation counter value.
STALS_ALS_AUTOGAIN_CTRL Control to configure als autogain feature. This enum's value is deprecated when
using STALS_SetControl or STALS_GetControl
STALS_OTP_USAGE_ENABLE Control to set if OTP information is used by driver. It is enabled by default.
Unless you are sure of the actions, do not change this value.
For example : STALS_SetControl(pHandle, STALS_OTP_USAGE_ENABLE, STALS_CONTROL_DISABLE).
STALS_WA_STATE Control to get/set workaround state:
use STALS_SetControl() to enable/disable given workaround. Msb bit of ControlValue control if wa is
enabled or disabled. Others bits are the wa number.
UM2878
Enumeration type documentation
UM2878 - Rev 1
page 19/27

Related product manuals