APDS9960_ex.c File Reference

APDS9960 Driver extensions. More...

#include "APDS9960.h"

Include dependency graph for APDS9960_ex.c:

Functions
FctERR	APDS9960_Set_PON (APDS9960_t *const pCpnt, const bool en)
	Oscillator Enable / Disable.
FctERR	APDS9960_Set_AEN (APDS9960_t *const pCpnt, const bool en)
	ALS module Enable / Disable.
FctERR	APDS9960_Set_PEN (APDS9960_t *const pCpnt, const bool en)
	Proximity module Enable / Disable.
FctERR	APDS9960_Set_AIEN (APDS9960_t *const pCpnt, const bool en)
	ALS interrupt module Enable / Disable.
FctERR	APDS9960_Set_PIEN (APDS9960_t *const pCpnt, const bool en)
	Proximity interrupt module Enable / Disable.
FctERR	APDS9960_Set_WEN (APDS9960_t *const pCpnt, const bool en)
	WAIT module Enable / Disable.
FctERR	APDS9960_Set_GEN (APDS9960_t *const pCpnt, const bool en)
	Gesture module Enable / Disable.
FctERR	APDS9960_Set_ALS_Pesistence (APDS9960_t *const pCpnt, const APDS9960_als_it_persist persist)
	ALS Persistence configuration.
FctERR	APDS9960_Set_Prox_Pesistence (APDS9960_t *const pCpnt, const APDS9960_prox_it_persist persist)
	Proximity Persistence configuration.
FctERR	APDS9960_Set_Prox_Pulse_Length (APDS9960_t *const pCpnt, const APDS9960_pulse_length length)
	Proximity Pulse Length configuration.
FctERR	APDS9960_Set_Prox_Pulse_Count (APDS9960_t *const pCpnt, const uint8_t cnt)
	Proximity Pulse Count configuration.
FctERR	APDS9960_Set_ALS_Gain (APDS9960_t *const pCpnt, const APDS9960_als_gain gain)
	ALS Gain configuration.
FctERR	APDS9960_Set_Prox_Gain (APDS9960_t *const pCpnt, const APDS9960_prox_gain gain)
	Proximity Gain configuration.
FctERR	APDS9960_Set_Prox_Drive_Strength (APDS9960_t *const pCpnt, const APDS9960_drive_strength ldrive)
	Proximity Drive configuration.
FctERR	APDS9960_Set_ADC_Integration_Time (APDS9960_t *const pCpnt, const uint16_t integ)
	ADC Integration time configuration.
FctERR	APDS9960_Set_Wait_Time (APDS9960_t *const pCpnt, const uint16_t wait)
	Wait time configuration.
void	APDS9960_INT_GPIO_Init (APDS9960_t *const pCpnt, GPIO_TypeDef *const GPIOx, const uint16_t GPIO_Pin, const GPIO_PinState GPIO_Active)
	Interrupt GPIO pin init for APDS9960.
bool	APDS9960_INT_GPIO_Get (const APDS9960_t *const pCpnt)
	Interrupt GPIO pin getter for APDS9960.

Detailed Description

APDS9960 Driver extensions.

Author

SMFSW

Copyright

MIT (c) 2017-2026, SMFSW

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

Function Documentation

APDS9960_INT_GPIO_Get()

bool APDS9960_INT_GPIO_Get

(

const APDS9960_t *const

pCpnt

)

Interrupt GPIO pin getter for APDS9960.

Weak Functions

APDS9960 Interrupt GPIO pin getter may be user implemented if needed

Parameters

[in]

pCpnt

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

APDS9960_INT_GPIO_Init()

void APDS9960_INT_GPIO_Init	(	APDS9960_t *const	pCpnt,
		GPIO_TypeDef *const	GPIOx,
		const uint16_t	GPIO_Pin,
		const GPIO_PinState	GPIO_Active )

Interrupt GPIO pin init for APDS9960.

Weak Functions

APDS9960 Interrupt GPIO pin init may be user implemented if needed

Parameters

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

APDS9960_Set_ADC_Integration_Time()

FctERR APDS9960_Set_ADC_Integration_Time	(	APDS9960_t *const	pCpnt,
		const uint16_t	integ )

ADC Integration time configuration.

Parameters

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

APDS9960_Set_AEN()

FctERR APDS9960_Set_AEN	(	APDS9960_t *const	pCpnt,
		const bool	en )

ALS module Enable / Disable.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

APDS9960_Set_AIEN()

FctERR APDS9960_Set_AIEN	(	APDS9960_t *const	pCpnt,
		const bool	en )

ALS interrupt module Enable / Disable.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

APDS9960_Set_ALS_Gain()

FctERR APDS9960_Set_ALS_Gain	(	APDS9960_t *const	pCpnt,
		const APDS9960_als_gain	gain )

ALS Gain configuration.

Parameters

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

APDS9960_Set_ALS_Pesistence()

FctERR APDS9960_Set_ALS_Pesistence	(	APDS9960_t *const	pCpnt,
		const APDS9960_als_it_persist	persist )

ALS Persistence configuration.

Parameters

[in]	pCpnt	- Pointer to APDS9960 component
[in]	persist	- Persistence value

Returns

FctERR - error code

Here is the call graph for this function:

APDS9960_Set_GEN()

FctERR APDS9960_Set_GEN	(	APDS9960_t *const	pCpnt,
		const bool	en )

Gesture module Enable / Disable.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

APDS9960_Set_PEN()

FctERR APDS9960_Set_PEN	(	APDS9960_t *const	pCpnt,
		const bool	en )

Proximity module Enable / Disable.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

APDS9960_Set_PIEN()

FctERR APDS9960_Set_PIEN	(	APDS9960_t *const	pCpnt,
		const bool	en )

Proximity interrupt module Enable / Disable.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

APDS9960_Set_PON()

FctERR APDS9960_Set_PON	(	APDS9960_t *const	pCpnt,
		const bool	en )

Oscillator Enable / Disable.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

APDS9960_Set_Prox_Drive_Strength()

FctERR APDS9960_Set_Prox_Drive_Strength	(	APDS9960_t *const	pCpnt,
		const APDS9960_drive_strength	ldrive )

Proximity Drive configuration.

Parameters

[in]	pCpnt	- Pointer to APDS9960 component
[in]	ldrive	- Proximity LED Drive Strength value

Returns

FctERR - error code

Here is the call graph for this function:

Here is the caller graph for this function:

APDS9960_Set_Prox_Gain()

FctERR APDS9960_Set_Prox_Gain	(	APDS9960_t *const	pCpnt,
		const APDS9960_prox_gain	gain )

Proximity Gain configuration.

Parameters

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

APDS9960_Set_Prox_Pesistence()

FctERR APDS9960_Set_Prox_Pesistence	(	APDS9960_t *const	pCpnt,
		const APDS9960_prox_it_persist	persist )

Proximity Persistence configuration.

Parameters

[in]	pCpnt	- Pointer to APDS9960 component
[in]	persist	- Persistence value

Returns

FctERR - error code

Here is the call graph for this function:

APDS9960_Set_Prox_Pulse_Count()

FctERR APDS9960_Set_Prox_Pulse_Count	(	APDS9960_t *const	pCpnt,
		const uint8_t	cnt )

Proximity Pulse Count configuration.

Parameters

[in]	pCpnt	- Pointer to APDS9960 component
[in]	cnt	- Proximity pulse count

Returns

FctERR - error code

Here is the call graph for this function:

APDS9960_Set_Prox_Pulse_Length()

FctERR APDS9960_Set_Prox_Pulse_Length	(	APDS9960_t *const	pCpnt,
		const APDS9960_pulse_length	length )

Proximity Pulse Length configuration.

Parameters

[in]	pCpnt	- Pointer to APDS9960 component
[in]	length	- Proximity pulse length

Returns

FctERR - error code

Here is the call graph for this function:

APDS9960_Set_Wait_Time()

FctERR APDS9960_Set_Wait_Time	(	APDS9960_t *const	pCpnt,
		const uint16_t	wait )

Wait time configuration.

Parameters

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

APDS9960_Set_WEN()

FctERR APDS9960_Set_WEN	(	APDS9960_t *const	pCpnt,
		const bool	en )

WAIT module Enable / Disable.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function: