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

APDS9960 Driver procedures. More...

#include "sarmfsw.h"
#include "APDS9960.h"
#include "shared_ALS.h"
#include "shared_CLS.h"
Include dependency graph for APDS9960_proc.h:
This graph shows which files directly or indirectly include this file:

Data Structures

struct  APDS9960_t
 APDS9960 user interface struct. More...
 

Macros

#define APDS9960_CHIP_ID   0xABU
 APDS9960 Chip ID to check against.
 

Functions

FctERR APDS9960_Init_Sequence (APDS9960_t *const pCpnt)
 Initialization Sequence for APDS9960 peripheral.
 
FctERR APDS9960_handler (APDS9960_t *const pCpnt)
 Handler for APDS9960 peripheral.
 
FctERR APDS9960_handler_it (APDS9960_t *const pCpnt)
 Handler for APDS9960 peripheral GPIO interrupt.
 
FctERR APDS9960_handler_all (void)
 Handler for all APDS9960 peripherals.
 
FctERR APDS9960_handler_it_all (void)
 Handler for all APDS9960 peripherals GPIO interrupt.
 

Variables

APDS9960_t APDS9960 [I2C_APDS9960_NB]
 APDS9960 User structure.
 

Detailed Description

APDS9960 Driver procedures.

Author
SMFSW

APDS9960: Digital Proximity, Ambient Light, RGB and Gesture Sensor

Macro Definition Documentation

◆ APDS9960_CHIP_ID

#define APDS9960_CHIP_ID   0xABU

APDS9960 Chip ID to check against.

Function Documentation

◆ APDS9960_handler()

FctERR APDS9960_handler ( APDS9960_t *const pCpnt)

Handler for APDS9960 peripheral.

Weak Functions
APDS9960 handler may be user implemented to suit custom needs
Note
May be called periodically to handle APDS9960 tasks
Alternately may be called when event occurs on APDS9960 pin (or by calling APDS9960_handler_it instead)
Parameters
[in]pCpnt- Pointer to APDS9960 component
Returns
FctERR - error code
Here is the call graph for this function:
Here is the caller graph for this function:

◆ APDS9960_handler_all()

FctERR APDS9960_handler_all ( void )

Handler for all APDS9960 peripherals.

Note
May be called periodically to handle all APDS9960 tasks
Returns
FctERR - error code
Here is the call graph for this function:

◆ APDS9960_handler_it()

FctERR APDS9960_handler_it ( APDS9960_t *const pCpnt)

Handler for APDS9960 peripheral GPIO interrupt.

Weak Functions
APDS9960 GPIO interrupt handler may be user implemented to suit custom needs
Note
May be called periodically to handle APDS9960 tasks through interrupts
Parameters
[in]pCpnt- Pointer to APDS9960 component
Returns
FctERR - error code
Here is the call graph for this function:
Here is the caller graph for this function:

◆ APDS9960_handler_it_all()

FctERR APDS9960_handler_it_all ( void )

Handler for all APDS9960 peripherals GPIO interrupt.

Note
APDS9960_INT_GPIO_Init has to be called at init before using interrupt handler function
May be called periodically to handle all APDS9960 tasks
Returns
FctERR - error code
Here is the call graph for this function:

◆ APDS9960_Init_Sequence()

FctERR APDS9960_Init_Sequence ( APDS9960_t *const pCpnt)

Initialization Sequence for APDS9960 peripheral.

Weak Functions
APDS9960 Init sequence may be user implemented if custom initialization sequence needed
Parameters
[in]pCpnt- Pointer to APDS9960 component
Returns
FctERR - error code
Here is the call graph for this function:
Here is the caller graph for this function:

Variable Documentation

◆ APDS9960

APDS9960_t APDS9960[I2C_APDS9960_NB]
extern

APDS9960 User structure.