3.2.10 STALS_ErrCode_t STALS_GetUid
STALS_ErrCode_t STALS_GetUid (void *pHandle, char **pUid)
This function returns the device unique id. Unique id is a null terminated string.
Table 19. Parameters
Parameter Description
pHandle Opaque pointer used as the id of the instance of the driver
pUid Pointer on a char pointer in which address of uid string will be set
Table 20. Return values
Return value Description
STALS_NO_ERROR Success
STALS_ERROR_INVALID_PARAMS At least one of the provided parameters is invalid
3.2.11 STALS_ErrCode_t STALS_SetGain
STALS_ErrCode_t STALS_SetGain (void *pHandle, enum STALS_Channel_Id_t ChannelId, uint16_t Gain,
uint16_t *pAppliedGain)
This function sets an analog gain on the provided channel id.
Note: The gain impacts the signal output amplitude, but not the values returned by STALS_GetFlicker, unless the gain
exceeds a maximum value that will flatten the signal output because of its impact on saturation.
Table 21. Parameters
Parameter Description
pHandle Opaque pointer used as the id of the instance of the driver
ChannelId This id identifies the channel number. See Section 3.5.1 STALS_Channel_Id_t
Gain Gain in 8.8 fixed point unit
pAppliedGain
Pointer in which the value of the actual gain applied in the device is returned. Value
in 8.8 fixed point unit
Table 22.
Return values
Return value Description
STALS_NO_ERROR Success
STALS_ERROR_INVALID_PARAMS At least one of the provided parameters to the function is invalid
STALS_ERROR_ALREADY_STARTED Gain can not be set when the device is running
STALS_ERROR_WRITE Could not write any data in the device through I2C
STALS_ERROR_READ Could not read any data from the device through I2C
UM2878
STALS API definition
UM2878 - Rev 1
page 11/27
To Next Page
Loading...
