TCS3400_ex.c File Reference

TCS3400 Driver extensions. More...

#include "TCS3400.h"

Include dependency graph for TCS3400_ex.c:

Functions
FctERR	TCS3400_Set_PON (TCS3400_t *const pCpnt, const bool en)
	Oscillator Enable / Disable.
FctERR	TCS3400_Set_AEN (TCS3400_t *const pCpnt, const bool en)
	Clear module Enable / Disable.
FctERR	TCS3400_Set_AIEN (TCS3400_t *const pCpnt, const bool en)
	Clear interrupt module Enable / Disable.
FctERR	TCS3400_Set_WEN (TCS3400_t *const pCpnt, const bool en)
	WAIT module Enable / Disable.
FctERR	TCS3400_Set_SAI (TCS3400_t *const pCpnt, const bool en)
	Sleep After Interrupt Enable / Disable.
FctERR	TCS3400_Set_Gain (TCS3400_t *const pCpnt, const TCS3400_gain gain)
	Gain configuration.
FctERR	TCS3400_Set_Integration_Time (TCS3400_t *const pCpnt, const uint16_t integ)
	Integration time configuration.
FctERR	TCS3400_Set_Wait_Time (TCS3400_t *const pCpnt, const uint16_t wait)
	Wait time configuration.
FctERR	TCS3400_Get_Channels (TCS3400_t *const pCpnt, uint16_t buf[])
	Get All channels conversions.
FctERR	TCS3400_Get_Channel (TCS3400_t *const pCpnt, uint16_t *const val, const TCS3400_chan chan)
	Get Specific channel conversion.
void	TCS3400_INT_GPIO_Init (TCS3400_t *const pCpnt, GPIO_TypeDef *const GPIOx, const uint16_t GPIO_Pin, const GPIO_PinState GPIO_Active)
	Interrupt GPIO pin init for TCS3400.
bool	TCS3400_INT_GPIO_Get (const TCS3400_t *const pCpnt)
	Interrupt GPIO pin getter for TCS3400.

Detailed Description

TCS3400 Driver extensions.

Author

SMFSW

Copyright

MIT (c) 2017-2026, SMFSW

TCS3400: Color Light-to-Digital Converter

Function Documentation

TCS3400_Get_Channel()

FctERR TCS3400_Get_Channel	(	TCS3400_t *const	pCpnt,
		uint16_t *const	val,
		const TCS3400_chan	chan )

Get Specific channel conversion.

Parameters

[in]	pCpnt	- Pointer to TCS3400 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:

TCS3400_Get_Channels()

FctERR TCS3400_Get_Channels	(	TCS3400_t *const	pCpnt,
		uint16_t	buf[] )

Get All channels conversions.

Parameters

[in]	pCpnt	- Pointer to TCS3400 component
[in,out]	buf	- pointer to conversions tab result

Returns

FctERR - error code

Here is the call graph for this function:

TCS3400_INT_GPIO_Get()

bool TCS3400_INT_GPIO_Get

(

const TCS3400_t *const

pCpnt

)

Interrupt GPIO pin getter for TCS3400.

Weak Functions

TCS3400 Interrupt GPIO pin getter may be user implemented if needed

Parameters

[in]

pCpnt

- Pointer to TCS3400 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:

TCS3400_INT_GPIO_Init()

void TCS3400_INT_GPIO_Init	(	TCS3400_t *const	pCpnt,
		GPIO_TypeDef *const	GPIOx,
		const uint16_t	GPIO_Pin,
		const GPIO_PinState	GPIO_Active )

Interrupt GPIO pin init for TCS3400.

Weak Functions

TCS3400 Interrupt GPIO pin init may be user implemented if needed

Parameters

[in]	pCpnt	- Pointer to TCS3400 component
[in]	GPIOx	- INT port
[in]	GPIO_Pin	- INT pin
[in]	GPIO_Active	INT pin active state

Here is the call graph for this function:

TCS3400_Set_AEN()

FctERR TCS3400_Set_AEN	(	TCS3400_t *const	pCpnt,
		const bool	en )

Clear module Enable / Disable.

Parameters

[in]	pCpnt	- Pointer to TCS3400 component
[in]	en	- 0 Disable, 1 Enable

Returns

FctERR - error code

Here is the call graph for this function:

TCS3400_Set_AIEN()

FctERR TCS3400_Set_AIEN	(	TCS3400_t *const	pCpnt,
		const bool	en )

Clear interrupt module Enable / Disable.

Parameters

[in]	pCpnt	- Pointer to TCS3400 component
[in]	en	- 0 Disable, 1 Enable

Returns

FctERR - error code

Here is the call graph for this function:

TCS3400_Set_Gain()

FctERR TCS3400_Set_Gain	(	TCS3400_t *const	pCpnt,
		const TCS3400_gain	gain )

Gain configuration.

Parameters

[in]	pCpnt	- Pointer to TCS3400 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:

TCS3400_Set_Integration_Time()

FctERR TCS3400_Set_Integration_Time	(	TCS3400_t *const	pCpnt,
		const uint16_t	integ )

Integration time configuration.

Parameters

[in]	pCpnt	- Pointer to TCS3400 component
[in]	integ	- Integration time value (from 3ms to 712ms)

Returns

FctERR - error code

Here is the call graph for this function:

Here is the caller graph for this function:

TCS3400_Set_PON()

FctERR TCS3400_Set_PON	(	TCS3400_t *const	pCpnt,
		const bool	en )

Oscillator Enable / Disable.

Parameters

[in]	pCpnt	- Pointer to TCS3400 component
[in]	en	- 0 Disable, 1 Enable

Returns

FctERR - error code

Here is the call graph for this function:

TCS3400_Set_SAI()

FctERR TCS3400_Set_SAI	(	TCS3400_t *const	pCpnt,
		const bool	en )

Sleep After Interrupt Enable / Disable.

Parameters

[in]	pCpnt	- Pointer to TCS3400 component
[in]	en	- 0 Disable, 1 Enable

Returns

FctERR - error code

Here is the call graph for this function:

TCS3400_Set_Wait_Time()

FctERR TCS3400_Set_Wait_Time	(	TCS3400_t *const	pCpnt,
		const uint16_t	wait )

Wait time configuration.

Parameters

[in]	pCpnt	- Pointer to TCS3400 component
[in]	wait	- Wait time value (from 3ms to 8540ms)

Returns

FctERR - error code

Here is the call graph for this function:

Here is the caller graph for this function:

TCS3400_Set_WEN()

FctERR TCS3400_Set_WEN	(	TCS3400_t *const	pCpnt,
		const bool	en )

WAIT module Enable / Disable.

Parameters

[in]	pCpnt	- Pointer to TCS3400 component
[in]	en	- 0 Disable, 1 Enable

Returns

FctERR - error code

Here is the call graph for this function: