tcs34725 example driver function

tcs34725 example driver modules More...

Collaboration diagram for tcs34725 example driver function:

Macros
#define	TCS34725_BASIC_DEFAULT_RGBC_INTERRUPT   TCS34725_BOOL_FALSE
	tcs34725 basic example default definition
#define	TCS34725_BASIC_DEFAULT_WAIT   TCS34725_BOOL_TRUE
#define	TCS34725_BASIC_DEFAULT_RGBC   TCS34725_BOOL_TRUE
#define	TCS34725_BASIC_DEFAULT_INTEGRATION_TIME   TCS34725_INTEGRATION_TIME_50MS
#define	TCS34725_BASIC_DEFAULT_WAIT_TIME   TCS34725_WAIT_TIME_2P4MS
#define	TCS34725_BASIC_DEFAULT_CLEAR_LOW_INTERRUPT_THRESHOLD   0x0000U
#define	TCS34725_BASIC_DEFAULT_CLEAR_HIGH_INTERRUPT_THRESHOLD   0xFFFFU
#define	TCS34725_BASIC_DEFAULT_GAIN   TCS34725_GAIN_16X
#define	TCS34725_BASIC_DEFAULT_INTERRUPT_MODE   TCS34725_INTERRUPT_MODE_1_CLEAR_CHANNEL_OUT_OF_THRESHOLD
#define	TCS34725_BASIC_DEFAULT_POWER_ON   TCS34725_BOOL_TRUE
#define	TCS34725_INTERRUPT_DEFAULT_WAIT   TCS34725_BOOL_TRUE
	tcs34725 interrupt example default definition
#define	TCS34725_INTERRUPT_DEFAULT_RGBC   TCS34725_BOOL_TRUE
#define	TCS34725_INTERRUPT_DEFAULT_INTEGRATION_TIME   TCS34725_INTEGRATION_TIME_50MS
#define	TCS34725_INTERRUPT_DEFAULT_WAIT_TIME   TCS34725_WAIT_TIME_2P4MS
#define	TCS34725_INTERRUPT_DEFAULT_GAIN   TCS34725_GAIN_16X
#define	TCS34725_INTERRUPT_DEFAULT_POWER_ON   TCS34725_BOOL_TRUE

Functions
uint8_t	tcs34725_basic_init (void)
	basic example init
uint8_t	tcs34725_basic_read (uint16_t *red, uint16_t *green, uint16_t *blue, uint16_t *clear)
	basic example read
uint8_t	tcs34725_basic_deinit (void)
	basic example deinit
uint8_t	tcs34725_interrupt_init (tcs34725_interrupt_mode_t mode, uint16_t low_threshold, uint16_t high_threshold)
	interrupt example init
uint8_t	tcs34725_interrupt_read (uint16_t *red, uint16_t *green, uint16_t *blue, uint16_t *clear)
	interrupt example read
uint8_t	tcs34725_interrupt_deinit (void)
	interrupt example deinit

Detailed Description

tcs34725 example driver modules

Macro Definition Documentation

TCS34725_BASIC_DEFAULT_CLEAR_HIGH_INTERRUPT_THRESHOLD

#define TCS34725_BASIC_DEFAULT_CLEAR_HIGH_INTERRUPT_THRESHOLD   0xFFFFU

0xFFFF high interrupt threshold

Definition at line 63 of file driver_tcs34725_basic.h.

TCS34725_BASIC_DEFAULT_CLEAR_LOW_INTERRUPT_THRESHOLD

#define TCS34725_BASIC_DEFAULT_CLEAR_LOW_INTERRUPT_THRESHOLD   0x0000U

0x0000 low interrupt threshold

Definition at line 62 of file driver_tcs34725_basic.h.

TCS34725_BASIC_DEFAULT_GAIN

#define TCS34725_BASIC_DEFAULT_GAIN   TCS34725_GAIN_16X

16x gain

Definition at line 64 of file driver_tcs34725_basic.h.

TCS34725_BASIC_DEFAULT_INTEGRATION_TIME

#define TCS34725_BASIC_DEFAULT_INTEGRATION_TIME   TCS34725_INTEGRATION_TIME_50MS

50 ms integration time

Definition at line 60 of file driver_tcs34725_basic.h.

TCS34725_BASIC_DEFAULT_INTERRUPT_MODE

#define TCS34725_BASIC_DEFAULT_INTERRUPT_MODE   TCS34725_INTERRUPT_MODE_1_CLEAR_CHANNEL_OUT_OF_THRESHOLD

1 clear out of threshold

Definition at line 65 of file driver_tcs34725_basic.h.

TCS34725_BASIC_DEFAULT_POWER_ON

#define TCS34725_BASIC_DEFAULT_POWER_ON   TCS34725_BOOL_TRUE

enable power on

Definition at line 66 of file driver_tcs34725_basic.h.

TCS34725_BASIC_DEFAULT_RGBC

#define TCS34725_BASIC_DEFAULT_RGBC   TCS34725_BOOL_TRUE

enable rgbc

Definition at line 59 of file driver_tcs34725_basic.h.

TCS34725_BASIC_DEFAULT_RGBC_INTERRUPT

#define TCS34725_BASIC_DEFAULT_RGBC_INTERRUPT   TCS34725_BOOL_FALSE

tcs34725 basic example default definition

disable interrupt

Definition at line 57 of file driver_tcs34725_basic.h.

TCS34725_BASIC_DEFAULT_WAIT

#define TCS34725_BASIC_DEFAULT_WAIT   TCS34725_BOOL_TRUE

enable wait

Definition at line 58 of file driver_tcs34725_basic.h.

TCS34725_BASIC_DEFAULT_WAIT_TIME

#define TCS34725_BASIC_DEFAULT_WAIT_TIME   TCS34725_WAIT_TIME_2P4MS

2.4 ms wait time

Definition at line 61 of file driver_tcs34725_basic.h.

TCS34725_INTERRUPT_DEFAULT_GAIN

#define TCS34725_INTERRUPT_DEFAULT_GAIN   TCS34725_GAIN_16X

16x gain

Definition at line 59 of file driver_tcs34725_interrupt.h.

TCS34725_INTERRUPT_DEFAULT_INTEGRATION_TIME

#define TCS34725_INTERRUPT_DEFAULT_INTEGRATION_TIME   TCS34725_INTEGRATION_TIME_50MS

50 ms integration time

Definition at line 57 of file driver_tcs34725_interrupt.h.

TCS34725_INTERRUPT_DEFAULT_POWER_ON

#define TCS34725_INTERRUPT_DEFAULT_POWER_ON   TCS34725_BOOL_TRUE

enable power on

Definition at line 60 of file driver_tcs34725_interrupt.h.

TCS34725_INTERRUPT_DEFAULT_RGBC

#define TCS34725_INTERRUPT_DEFAULT_RGBC   TCS34725_BOOL_TRUE

enable rgbc

Definition at line 56 of file driver_tcs34725_interrupt.h.

TCS34725_INTERRUPT_DEFAULT_WAIT

#define TCS34725_INTERRUPT_DEFAULT_WAIT   TCS34725_BOOL_TRUE

tcs34725 interrupt example default definition

enable wait

Definition at line 55 of file driver_tcs34725_interrupt.h.

TCS34725_INTERRUPT_DEFAULT_WAIT_TIME

#define TCS34725_INTERRUPT_DEFAULT_WAIT_TIME   TCS34725_WAIT_TIME_2P4MS

2.4 ms wait time

Definition at line 58 of file driver_tcs34725_interrupt.h.

Function Documentation

tcs34725_basic_deinit()

uint8_t tcs34725_basic_deinit

(

void

)

basic example deinit

Returns

status code

• 0 success
• 1 deinit failed

Note

none

Definition at line 205 of file driver_tcs34725_basic.c.

Here is the call graph for this function:

tcs34725_basic_init()

uint8_t tcs34725_basic_init

(

void

)

basic example init

Returns

status code

• 0 success
• 1 init failed

Note

none

Definition at line 49 of file driver_tcs34725_basic.c.

Here is the call graph for this function:

tcs34725_basic_read()

uint8_t tcs34725_basic_read	(	uint16_t *	red,
		uint16_t *	green,
		uint16_t *	blue,
		uint16_t *	clear )

basic example read

Parameters

[out]	*red	pointer to a red color buffer
[out]	*green	pointer to a green color buffer
[out]	*blue	pointer to a blue color buffer
[out]	*clear	pointer to a clear color buffer

Returns

status code

• 0 success
• 1 read failed

Note

none

Definition at line 185 of file driver_tcs34725_basic.c.

Here is the call graph for this function:

tcs34725_interrupt_deinit()

uint8_t tcs34725_interrupt_deinit

(

void

)

interrupt example deinit

Returns

status code

• 0 success
• 1 deinit failed

Note

none

Definition at line 208 of file driver_tcs34725_interrupt.c.

Here is the call graph for this function:

tcs34725_interrupt_init()

uint8_t tcs34725_interrupt_init	(	tcs34725_interrupt_mode_t	mode,
		uint16_t	low_threshold,
		uint16_t	high_threshold )

interrupt example init

Parameters

[in]	mode	interrupt mode
[in]	low_threshold	interrupt low threshold
[in]	high_threshold	interrupt high threshold

Returns

status code

• 0 success
• 1 init failed

Note

none

Definition at line 52 of file driver_tcs34725_interrupt.c.

Here is the call graph for this function:

tcs34725_interrupt_read()

uint8_t tcs34725_interrupt_read	(	uint16_t *	red,
		uint16_t *	green,
		uint16_t *	blue,
		uint16_t *	clear )

interrupt example read

Parameters

[out]	*red	pointer to a red color buffer
[out]	*green	pointer to a green color buffer
[out]	*blue	pointer to a blue color buffer
[out]	*clear	pointer to a clear color buffer

Returns

status code

• 0 success
• 1 read failed

Note

none

Definition at line 188 of file driver_tcs34725_interrupt.c.

Here is the call graph for this function: