APDS9930_ex.c File Reference

APDS9930 Driver extensions. More...

#include "APDS9930.h"

Include dependency graph for APDS9930_ex.c:

Functions
FctERR	APDS9930_Set_PON (APDS9930_t *const pCpnt, const bool en)
	Oscillator Enable / Disable.
FctERR	APDS9930_Set_AEN (APDS9930_t *const pCpnt, const bool en)
	ALS module Enable / Disable.
FctERR	APDS9930_Set_PEN (APDS9930_t *const pCpnt, const bool en)
	Proximity module Enable / Disable.
FctERR	APDS9930_Set_AIEN (APDS9930_t *const pCpnt, const bool en)
	ALS interrupt module Enable / Disable.
FctERR	APDS9930_Set_PIEN (APDS9930_t *const pCpnt, const bool en)
	Proximity interrupt module Enable / Disable.
FctERR	APDS9930_Set_WEN (APDS9930_t *const pCpnt, const bool en)
	WAIT module Enable / Disable.
FctERR	APDS9930_Set_SAI (APDS9930_t *const pCpnt, const bool en)
	Sleep After Interrupt Enable / Disable.
FctERR	APDS9930_Set_ALS_Gain (APDS9930_t *const pCpnt, const APDS9930_als_gain_ex gain)
	ALS Gain configuration.
FctERR	APDS9930_Set_Prox_Gain (APDS9930_t *const pCpnt, const APDS9930_prox_gain gain)
	Proximity Gain configuration.
FctERR	APDS9930_Set_Prox_Drive_Strength (APDS9930_t *const pCpnt, const APDS9930_drive_strength_ex pdrive)
	Proximity Drive configuration.
FctERR	APDS9930_Set_ALS_Pesistence (APDS9930_t *const pCpnt, const APDS9930_als_it_persist persist)
	ALS Persistence configuration.
FctERR	APDS9930_Set_Prox_Pesistence (APDS9930_t *const pCpnt, const APDS9930_prox_it_persist persist)
	Proximity Persistence configuration.
FctERR	APDS9930_Set_ALS_Integration_Time (APDS9930_t *const pCpnt, const uint16_t integ)
	ALS Integration time configuration.
FctERR	APDS9930_Set_Prox_Integration_Time (APDS9930_t *const pCpnt, const uint16_t integ)
	Proximity Integration time configuration.
FctERR	APDS9930_Set_Wait_Time (APDS9930_t *const pCpnt, const uint16_t wait)
	Wait time configuration.
void	APDS9930_INT_GPIO_Init (APDS9930_t *const pCpnt, GPIO_TypeDef *const GPIOx, const uint16_t GPIO_Pin, const GPIO_PinState GPIO_Active)
	Interrupt GPIO pin init for APDS9930.
bool	APDS9930_INT_GPIO_Get (const APDS9930_t *const pCpnt)
	Interrupt GPIO pin getter for APDS9930.

Detailed Description

APDS9930 Driver extensions.

Author

SMFSW

Copyright

MIT (c) 2017-2026, SMFSW

APDS9930: Digital Proximity and Ambient Light Sensor

Function Documentation

APDS9930_INT_GPIO_Get()

bool APDS9930_INT_GPIO_Get

(

const APDS9930_t *const

pCpnt

)

Interrupt GPIO pin getter for APDS9930.

Weak Functions

APDS9930 Interrupt GPIO pin getter may be user implemented if needed

Parameters

[in]

pCpnt

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

APDS9930_INT_GPIO_Init()

void APDS9930_INT_GPIO_Init	(	APDS9930_t *const	pCpnt,
		GPIO_TypeDef *const	GPIOx,
		const uint16_t	GPIO_Pin,
		const GPIO_PinState	GPIO_Active )

Interrupt GPIO pin init for APDS9930.

Weak Functions

APDS9930 Interrupt GPIO pin init may be user implemented if needed

Parameters

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

APDS9930_Set_AEN()

FctERR APDS9930_Set_AEN	(	APDS9930_t *const	pCpnt,
		const bool	en )

ALS module Enable / Disable.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

APDS9930_Set_AIEN()

FctERR APDS9930_Set_AIEN	(	APDS9930_t *const	pCpnt,
		const bool	en )

ALS interrupt module Enable / Disable.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

APDS9930_Set_ALS_Gain()

FctERR APDS9930_Set_ALS_Gain	(	APDS9930_t *const	pCpnt,
		const APDS9930_als_gain_ex	gain )

ALS Gain configuration.

Parameters

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

APDS9930_Set_ALS_Integration_Time()

FctERR APDS9930_Set_ALS_Integration_Time	(	APDS9930_t *const	pCpnt,
		const uint16_t	integ )

ALS Integration time configuration.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

Here is the caller graph for this function:

APDS9930_Set_ALS_Pesistence()

FctERR APDS9930_Set_ALS_Pesistence	(	APDS9930_t *const	pCpnt,
		const APDS9930_als_it_persist	persist )

ALS Persistence configuration.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

APDS9930_Set_PEN()

FctERR APDS9930_Set_PEN	(	APDS9930_t *const	pCpnt,
		const bool	en )

Proximity module Enable / Disable.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

APDS9930_Set_PIEN()

FctERR APDS9930_Set_PIEN	(	APDS9930_t *const	pCpnt,
		const bool	en )

Proximity interrupt module Enable / Disable.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

APDS9930_Set_PON()

FctERR APDS9930_Set_PON	(	APDS9930_t *const	pCpnt,
		const bool	en )

Oscillator Enable / Disable.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

APDS9930_Set_Prox_Drive_Strength()

FctERR APDS9930_Set_Prox_Drive_Strength	(	APDS9930_t *const	pCpnt,
		const APDS9930_drive_strength_ex	pdrive )

Proximity Drive configuration.

Parameters

[in]	pCpnt	- Pointer to APDS9930 component
[in]	pdrive	- Proximity Drive Strength value

Returns

FctERR - error code

Here is the call graph for this function:

Here is the caller graph for this function:

APDS9930_Set_Prox_Gain()

FctERR APDS9930_Set_Prox_Gain	(	APDS9930_t *const	pCpnt,
		const APDS9930_prox_gain	gain )

Proximity Gain configuration.

Parameters

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

APDS9930_Set_Prox_Integration_Time()

FctERR APDS9930_Set_Prox_Integration_Time	(	APDS9930_t *const	pCpnt,
		const uint16_t	integ )

Proximity Integration time configuration.

Note

It is recommended that this register be programmed to a value of 0xff (1 cycle, 1023 bits). -> integ = 3

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

Here is the caller graph for this function:

APDS9930_Set_Prox_Pesistence()

FctERR APDS9930_Set_Prox_Pesistence	(	APDS9930_t *const	pCpnt,
		const APDS9930_prox_it_persist	persist )

Proximity Persistence configuration.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

APDS9930_Set_SAI()

FctERR APDS9930_Set_SAI	(	APDS9930_t *const	pCpnt,
		const bool	en )

Sleep After Interrupt Enable / Disable.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

APDS9930_Set_Wait_Time()

FctERR APDS9930_Set_Wait_Time	(	APDS9930_t *const	pCpnt,
		const uint16_t	wait )

Wait time configuration.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function:

Here is the caller graph for this function:

APDS9930_Set_WEN()

FctERR APDS9930_Set_WEN	(	APDS9930_t *const	pCpnt,
		const bool	en )

WAIT module Enable / Disable.

Parameters

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

Returns

FctERR - error code

Here is the call graph for this function: