TCS3472_proc.h File Reference

TCS3472 Driver procedures. More...

#include "sarmfsw.h"
#include "TCS3472.h"
#include "shared_CLS.h"

Include dependency graph for TCS3472_proc.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	TCS3472_t
	TCS3472 user interface struct. More...

Macros
#define	TCS34725_CHIP_ID   0x44U
	TCS34721/TCS34725 Chip ID to check against.
#define	TCS34727_CHIP_ID   0x4DU
	TCS34723/TCS34727 Chip ID to check against.
#define	TCS3472_IR_COUNT   0.0f
	Counts per uW/cm2 for IR channel.
#define	TCS3472_CLEAR_COUNT   0.0f
	Counts per uW/cm2 for Clear channel.
#define	TCS3472_RED_COUNT   0.0f
	Counts per uW/cm2 for Red channel.
#define	TCS3472_GREEN_COUNT   0.0f
	Counts per uW/cm2 for Green channel.
#define	TCS3472_BLUE_COUNT   0.0f
	Counts per uW/cm2 for Blue channel.

Functions
FctERR	TCS3472_Init_Sequence (TCS3472_t *const pCpnt)
	Initialization Sequence for TCS3472 peripheral.
uint32_t	TCS3472_Get_Temp (const TCS3472_t *const pCpnt)
	Get current Color temperature (in Kelvin)
uint32_t	TCS3472_Get_Lux (const TCS3472_t *const pCpnt)
	Get current Illuminance (in lux)
FctERR	TCS3472_handler (TCS3472_t *const pCpnt)
	Handler for TCS3472 peripheral.
FctERR	TCS3472_handler_it (TCS3472_t *const pCpnt)
	Handler for TCS3472 peripheral GPIO interrupt.
FctERR	TCS3472_handler_all (void)
	Handler for all TCS3472 peripherals.
FctERR	TCS3472_handler_it_all (void)
	Handler for all TCS3472 peripherals GPIO interrupt.

Variables
TCS3472_t	TCS3472 [I2C_TCS3472_NB]
	TCSL3472 User structure.

Detailed Description

TCS3472 Driver procedures.

Author

SMFSW

Copyright

MIT (c) 2017-2026, SMFSW

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

Macro Definition Documentation

TCS34725_CHIP_ID

#define TCS34725_CHIP_ID   0x44U

TCS34721/TCS34725 Chip ID to check against.

TCS34727_CHIP_ID

#define TCS34727_CHIP_ID   0x4DU

TCS34723/TCS34727 Chip ID to check against.

TCS3472_BLUE_COUNT

#define TCS3472_BLUE_COUNT   0.0f

Counts per uW/cm2 for Blue channel.

TCS3472_CLEAR_COUNT

#define TCS3472_CLEAR_COUNT   0.0f

Counts per uW/cm2 for Clear channel.

TCS3472_GREEN_COUNT

#define TCS3472_GREEN_COUNT   0.0f

Counts per uW/cm2 for Green channel.

TCS3472_IR_COUNT

#define TCS3472_IR_COUNT   0.0f

Counts per uW/cm2 for IR channel.

TCS3472_RED_COUNT

#define TCS3472_RED_COUNT   0.0f

Counts per uW/cm2 for Red channel.

Function Documentation

TCS3472_Get_Lux()

uint32_t TCS3472_Get_Lux ( const TCS3472_t *const pCpnt )

inline

Get current Illuminance (in lux)

Parameters

[in]

pCpnt

- Pointer to TCS3472 component

Returns

FctERR - error code

TCS3472_Get_Temp()

uint32_t TCS3472_Get_Temp ( const TCS3472_t *const pCpnt )

inline

Get current Color temperature (in Kelvin)

Parameters

[in]

pCpnt

- Pointer to TCS3472 component

Returns

FctERR - error code

TCS3472_handler()

FctERR TCS3472_handler

(

TCS3472_t *const

pCpnt

)

Handler for TCS3472 peripheral.

Weak Functions

TCS3472 handler may be user implemented to suit custom needs

Note

May be called periodically to handle TCS3472 tasks

Alternately may be called when event occurs on TCS3472 pin (or by calling TCS3472_handler_it instead)

Parameters

[in]

pCpnt

- Pointer to TCS3472 component

Returns

FctERR - error code

Here is the call graph for this function:

Here is the caller graph for this function:

TCS3472_handler_all()

FctERR TCS3472_handler_all

(

void

)

Handler for all TCS3472 peripherals.

Note

May be called periodically to handle all TCS3472 tasks

Returns

FctERR - error code

Here is the call graph for this function:

TCS3472_handler_it()

FctERR TCS3472_handler_it

(

TCS3472_t *const

pCpnt

)

Handler for TCS3472 peripheral GPIO interrupt.

Note

TCS3472_INT_GPIO_Init has to be called at init before using interrupt handler function

Weak Functions

TCS3472 GPIO interrupt handler may be user implemented to suit custom needs

Note

May be called periodically to handle TCS3472 tasks through interrupts

Parameters

[in]

pCpnt

- Pointer to TCS3472 component

Returns

FctERR - error code

Here is the call graph for this function:

Here is the caller graph for this function:

TCS3472_handler_it_all()

FctERR TCS3472_handler_it_all

(

void

)

Handler for all TCS3472 peripherals GPIO interrupt.

Note

TCS3472_INT_GPIO_Init has to be called at init before using interrupt handler function

May be called periodically to handle all TCS3472 tasks

Returns

FctERR - error code

Here is the call graph for this function:

TCS3472_Init_Sequence()

FctERR TCS3472_Init_Sequence

(

TCS3472_t *const

pCpnt

)

Initialization Sequence for TCS3472 peripheral.

Weak Functions

TCS3472 Init sequence may be user implemented if custom initialization sequence needed

Parameters

[in]

pCpnt

- Pointer to TCS3472 component

Returns

FctERR - error code

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

TCS3472

TCS3472_t TCS3472[I2C_TCS3472_NB]

extern

TCSL3472 User structure.