I2C_Drivers (ARM) 1.1
SMFSW collection of HAL I2C Drivers for ARM
Loading...
Searching...
No Matches
TCS3472_ex.c File Reference

TCS3472 Driver extensions. More...

#include "TCS3472.h"
Include dependency graph for TCS3472_ex.c:

Functions

FctERR TCS3472_Set_PON (TCS3472_t *const pCpnt, const bool en)
 Oscillator Enable / Disable.
 
FctERR TCS3472_Set_AEN (TCS3472_t *const pCpnt, const bool en)
 Clear module Enable / Disable.
 
FctERR TCS3472_Set_AIEN (TCS3472_t *const pCpnt, const bool en)
 Clear interrupt module Enable / Disable.
 
FctERR TCS3472_Set_WEN (TCS3472_t *const pCpnt, const bool en)
 WAIT module Enable / Disable.
 
FctERR TCS3472_Set_Gain (TCS3472_t *const pCpnt, const TCS3472_gain gain)
 Gain configuration.
 
FctERR TCS3472_Set_Integration_Time (TCS3472_t *const pCpnt, const uint16_t integ)
 Integration time configuration.
 
FctERR TCS3472_Set_Wait_Time (TCS3472_t *const pCpnt, const uint16_t wait)
 Wait time configuration.
 
FctERR TCS3472_Get_Channels (TCS3472_t *const pCpnt, uint16_t buf[])
 Get All channels conversions.
 
FctERR TCS3472_Get_Channel (TCS3472_t *const pCpnt, uint16_t *const val, const TCS3472_chan chan)
 Get Specific channel conversion.
 
void TCS3472_INT_GPIO_Init (TCS3472_t *const pCpnt, GPIO_TypeDef *const GPIOx, const uint16_t GPIO_Pin, const GPIO_PinState GPIO_Active)
 Interrupt GPIO pin init for TCS3472.
 
bool TCS3472_INT_GPIO_Get (const TCS3472_t *const pCpnt)
 Interrupt GPIO pin getter for TCS3472.
 

Detailed Description

TCS3472 Driver extensions.

Author
SMFSW

TCS3472: Color light-to-digital converter with IR filter

Function Documentation

◆ TCS3472_Get_Channel()

FctERR TCS3472_Get_Channel ( TCS3472_t *const pCpnt,
uint16_t *const val,
const TCS3472_chan chan )

Get Specific channel conversion.

Parameters
[in]pCpnt- Pointer to TCS3472 component
[in,out]val- pointer to conversions result
[in]chan- Channel to get
Returns
FctERR - error code
Here is the call graph for this function:

◆ TCS3472_Get_Channels()

FctERR TCS3472_Get_Channels ( TCS3472_t *const pCpnt,
uint16_t buf[] )

Get All channels conversions.

Parameters
[in]pCpnt- Pointer to TCS3472 component
[in,out]buf- pointer to conversions tab result
Returns
FctERR - error code
Here is the call graph for this function:

◆ TCS3472_INT_GPIO_Get()

bool TCS3472_INT_GPIO_Get ( const TCS3472_t *const pCpnt)

Interrupt GPIO pin getter for TCS3472.

Weak Functions
TCS3472 Interrupt GPIO pin getter may be user implemented if needed
Parameters
[in]pCpnt- Pointer to TCS3472 component
Returns
INT pin state value (0: inactive, 1: active)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ TCS3472_INT_GPIO_Init()

void TCS3472_INT_GPIO_Init ( TCS3472_t *const pCpnt,
GPIO_TypeDef *const GPIOx,
const uint16_t GPIO_Pin,
const GPIO_PinState GPIO_Active )

Interrupt GPIO pin init for TCS3472.

Weak Functions
TCS3472 Interrupt GPIO pin init may be user implemented if needed
Parameters
[in]pCpnt- Pointer to TCS3472 component
[in]GPIOx- INT port
[in]GPIO_Pin- INT pin
[in]GPIO_ActiveINT pin active state
Here is the call graph for this function:

◆ TCS3472_Set_AEN()

FctERR TCS3472_Set_AEN ( TCS3472_t *const pCpnt,
const bool en )

Clear module Enable / Disable.

Parameters
[in]pCpnt- Pointer to TCS3472 component
[in]en- 0 Disable, 1 Enable
Returns
FctERR - error code
Here is the call graph for this function:

◆ TCS3472_Set_AIEN()

FctERR TCS3472_Set_AIEN ( TCS3472_t *const pCpnt,
const bool en )

Clear interrupt module Enable / Disable.

Parameters
[in]pCpnt- Pointer to TCS3472 component
[in]en- 0 Disable, 1 Enable
Returns
FctERR - error code
Here is the call graph for this function:

◆ TCS3472_Set_Gain()

FctERR TCS3472_Set_Gain ( TCS3472_t *const pCpnt,
const TCS3472_gain gain )

Gain configuration.

Parameters
[in]pCpnt- Pointer to TCS3472 component
[in]gain- Gain value
Returns
FctERR - error code
Here is the call graph for this function:
Here is the caller graph for this function:

◆ TCS3472_Set_Integration_Time()

FctERR TCS3472_Set_Integration_Time ( TCS3472_t *const pCpnt,
const uint16_t integ )

Integration time configuration.

Parameters
[in]pCpnt- Pointer to TCS3472 component
[in]integ- Integration time value (from 3ms to 614ms)
Returns
FctERR - error code
Here is the call graph for this function:
Here is the caller graph for this function:

◆ TCS3472_Set_PON()

FctERR TCS3472_Set_PON ( TCS3472_t *const pCpnt,
const bool en )

Oscillator Enable / Disable.

Parameters
[in]pCpnt- Pointer to TCS3472 component
[in]en- 0 Disable, 1 Enable
Returns
FctERR - error code
Here is the call graph for this function:

◆ TCS3472_Set_Wait_Time()

FctERR TCS3472_Set_Wait_Time ( TCS3472_t *const pCpnt,
const uint16_t wait )

Wait time configuration.

Parameters
[in]pCpnt- Pointer to TCS3472 component
[in]wait- Wait time value (from 3m to 7400ms)
Returns
FctERR - error code
Here is the call graph for this function:
Here is the caller graph for this function:

◆ TCS3472_Set_WEN()

FctERR TCS3472_Set_WEN ( TCS3472_t *const pCpnt,
const bool en )

WAIT module Enable / Disable.

Parameters
[in]pCpnt- Pointer to TCS3472 component
[in]en- 0 Disable, 1 Enable
Returns
FctERR - error code
Here is the call graph for this function: