LibDriver TCS34725
Loading...
Searching...
No Matches
tcs34725 interrupt driver function
tcs34725 driver function

tcs34725 interrupt driver modules More...

Collaboration diagram for tcs34725 interrupt driver function:

Enumerations

enum  tcs34725_interrupt_mode_t {
  TCS34725_INTERRUPT_MODE_EVERY_RGBC_CYCLE = 0x00 , TCS34725_INTERRUPT_MODE_1_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x01 , TCS34725_INTERRUPT_MODE_2_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x02 , TCS34725_INTERRUPT_MODE_3_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x03 ,
  TCS34725_INTERRUPT_MODE_5_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x04 , TCS34725_INTERRUPT_MODE_10_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x05 , TCS34725_INTERRUPT_MODE_15_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x06 , TCS34725_INTERRUPT_MODE_20_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x07 ,
  TCS34725_INTERRUPT_MODE_25_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x08 , TCS34725_INTERRUPT_MODE_30_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x09 , TCS34725_INTERRUPT_MODE_35_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x0A , TCS34725_INTERRUPT_MODE_40_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x0B ,
  TCS34725_INTERRUPT_MODE_45_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x0C , TCS34725_INTERRUPT_MODE_50_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x0D , TCS34725_INTERRUPT_MODE_55_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x0E , TCS34725_INTERRUPT_MODE_60_CLEAR_CHANNEL_OUT_OF_THRESHOLD = 0x0F
}
 tcs34725 interrupt mode enumeration definition More...

Functions

uint8_t tcs34725_set_rgbc_interrupt (tcs34725_handle_t *handle, tcs34725_bool_t enable)
 enable or disable the rgbc interrupt
uint8_t tcs34725_get_rgbc_interrupt (tcs34725_handle_t *handle, tcs34725_bool_t *enable)
 get the rgbc interrupt
uint8_t tcs34725_set_interrupt_mode (tcs34725_handle_t *handle, tcs34725_interrupt_mode_t mode)
 set the interrupt mode
uint8_t tcs34725_get_interrupt_mode (tcs34725_handle_t *handle, tcs34725_interrupt_mode_t *mode)
 get the interrupt mode
uint8_t tcs34725_set_rgbc_clear_low_interrupt_threshold (tcs34725_handle_t *handle, uint16_t threshold)
 set the rgbc clear low interrupt threshold
uint8_t tcs34725_get_rgbc_clear_low_interrupt_threshold (tcs34725_handle_t *handle, uint16_t *threshold)
 get the rgbc clear low interrupt threshold
uint8_t tcs34725_set_rgbc_clear_high_interrupt_threshold (tcs34725_handle_t *handle, uint16_t threshold)
 set the rgbc clear high interrupt threshold
uint8_t tcs34725_get_rgbc_clear_high_interrupt_threshold (tcs34725_handle_t *handle, uint16_t *threshold)
 get the rgbc clear high interrupt threshold

Detailed Description

tcs34725 interrupt driver modules

Enumeration Type Documentation

◆ tcs34725_interrupt_mode_t

enum tcs34725_interrupt_mode_t

tcs34725 interrupt mode enumeration definition

Enumerator
TCS34725_INTERRUPT_MODE_EVERY_RGBC_CYCLE 

every rgbc cycle interrupt

TCS34725_INTERRUPT_MODE_1_CLEAR_CHANNEL_OUT_OF_THRESHOLD 

1 cycle out of threshold interrupt

TCS34725_INTERRUPT_MODE_2_CLEAR_CHANNEL_OUT_OF_THRESHOLD 

2 cycle out of threshold interrupt

TCS34725_INTERRUPT_MODE_3_CLEAR_CHANNEL_OUT_OF_THRESHOLD 

3 cycle out of threshold interrupt

TCS34725_INTERRUPT_MODE_5_CLEAR_CHANNEL_OUT_OF_THRESHOLD 

5 cycle out of threshold interrupt

TCS34725_INTERRUPT_MODE_10_CLEAR_CHANNEL_OUT_OF_THRESHOLD 

10 cycle out of threshold interrupt

TCS34725_INTERRUPT_MODE_15_CLEAR_CHANNEL_OUT_OF_THRESHOLD 

15 cycle out of threshold interrupt

TCS34725_INTERRUPT_MODE_20_CLEAR_CHANNEL_OUT_OF_THRESHOLD 

20 cycle out of threshold interrupt

TCS34725_INTERRUPT_MODE_25_CLEAR_CHANNEL_OUT_OF_THRESHOLD 

25 cycle out of threshold interrupt

TCS34725_INTERRUPT_MODE_30_CLEAR_CHANNEL_OUT_OF_THRESHOLD 

30 cycle out of threshold interrupt

TCS34725_INTERRUPT_MODE_35_CLEAR_CHANNEL_OUT_OF_THRESHOLD 

35 cycle out of threshold interrupt

TCS34725_INTERRUPT_MODE_40_CLEAR_CHANNEL_OUT_OF_THRESHOLD 

40 cycle out of threshold interrupt

TCS34725_INTERRUPT_MODE_45_CLEAR_CHANNEL_OUT_OF_THRESHOLD 

45 cycle out of threshold interrupt

TCS34725_INTERRUPT_MODE_50_CLEAR_CHANNEL_OUT_OF_THRESHOLD 

50 cycle out of threshold interrupt

TCS34725_INTERRUPT_MODE_55_CLEAR_CHANNEL_OUT_OF_THRESHOLD 

55 cycle out of threshold interrupt

TCS34725_INTERRUPT_MODE_60_CLEAR_CHANNEL_OUT_OF_THRESHOLD 

60 cycle out of threshold interrupt

Definition at line 118 of file driver_tcs34725.h.

Function Documentation

◆ tcs34725_get_interrupt_mode()

uint8_t tcs34725_get_interrupt_mode ( tcs34725_handle_t * handle,
tcs34725_interrupt_mode_t * mode )

get the interrupt mode

Parameters
[in]*handlepointer to a tcs34725 handle structure
[out]*modepointer to an interrupt mode buffer
Returns
status code
  • 0 success
  • 1 get interrupt mode failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 779 of file driver_tcs34725.c.

◆ tcs34725_get_rgbc_clear_high_interrupt_threshold()

uint8_t tcs34725_get_rgbc_clear_high_interrupt_threshold ( tcs34725_handle_t * handle,
uint16_t * threshold )

get the rgbc clear high interrupt threshold

Parameters
[in]*handlepointer to a tcs34725 handle structure
[out]*thresholdpointer to a high interrupt threshold buffer
Returns
status code
  • 0 success
  • 1 get rgbc clear high interrupt threshold failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 698 of file driver_tcs34725.c.

◆ tcs34725_get_rgbc_clear_low_interrupt_threshold()

uint8_t tcs34725_get_rgbc_clear_low_interrupt_threshold ( tcs34725_handle_t * handle,
uint16_t * threshold )

get the rgbc clear low interrupt threshold

Parameters
[in]*handlepointer to a tcs34725 handle structure
[out]*thresholdpointer to a low interrupt threshold buffer
Returns
status code
  • 0 success
  • 1 get rgbc clear low interrupt threshold failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 623 of file driver_tcs34725.c.

◆ tcs34725_get_rgbc_interrupt()

uint8_t tcs34725_get_rgbc_interrupt ( tcs34725_handle_t * handle,
tcs34725_bool_t * enable )

get the rgbc interrupt

Parameters
[in]*handlepointer to a tcs34725 handle structure
[out]*enablepointer to a bool value buffer
Returns
status code
  • 0 success
  • 1 get rgbc interrupt failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 137 of file driver_tcs34725.c.

◆ tcs34725_set_interrupt_mode()

uint8_t tcs34725_set_interrupt_mode ( tcs34725_handle_t * handle,
tcs34725_interrupt_mode_t mode )

set the interrupt mode

Parameters
[in]*handlepointer to a tcs34725 handle structure
[in]modeinterrupt mode
Returns
status code
  • 0 success
  • 1 set interrupt mode failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 735 of file driver_tcs34725.c.

◆ tcs34725_set_rgbc_clear_high_interrupt_threshold()

uint8_t tcs34725_set_rgbc_clear_high_interrupt_threshold ( tcs34725_handle_t * handle,
uint16_t threshold )

set the rgbc clear high interrupt threshold

Parameters
[in]*handlepointer to a tcs34725 handle structure
[in]thresholdhigh interrupt threshold
Returns
status code
  • 0 success
  • 1 set rgbc clear high interrupt threshold failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 660 of file driver_tcs34725.c.

◆ tcs34725_set_rgbc_clear_low_interrupt_threshold()

uint8_t tcs34725_set_rgbc_clear_low_interrupt_threshold ( tcs34725_handle_t * handle,
uint16_t threshold )

set the rgbc clear low interrupt threshold

Parameters
[in]*handlepointer to a tcs34725 handle structure
[in]thresholdlow interrupt threshold
Returns
status code
  • 0 success
  • 1 set rgbc clear low interrupt threshold failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 585 of file driver_tcs34725.c.

◆ tcs34725_set_rgbc_interrupt()

uint8_t tcs34725_set_rgbc_interrupt ( tcs34725_handle_t * handle,
tcs34725_bool_t enable )

enable or disable the rgbc interrupt

Parameters
[in]*handlepointer to a tcs34725 handle structure
[in]enablebool value
Returns
status code
  • 0 success
  • 1 set rgbc interrupt failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 93 of file driver_tcs34725.c.