Ambient light sensor#

Ambient light sensor driver abstraction designed for Thunderboard.

Functions#

sl_status_t
sl_sensor_lux_init(void)
sl_status_t
sl_sensor_lux_get(float *lux)

Macros#

#define
SENSOR_LUX_SAMPLING_FUNCTION SAMPLING_UNSPECIFIED

Function Documentation#

sl_sensor_lux_init#

sl_status_t sl_sensor_lux_init (void)
Parameters
N/A

Initialize ambient light sensor.

Note

  • With certain boards (e.g. 4184B), using this initialization function enables other sensors, because they're on the same enable pin. Please take that into account when using this function.

Returns

  • Status of the operation.


Definition at line 49 of file common/sensor_lux/sl_sensor_lux.h

sl_sensor_lux_deinit#

void sl_sensor_lux_deinit (void)
Parameters
N/A

Deinitialize ambient light sensor.

Warnings

  • With certain boards (e.g. 4184B), using this deinitialization function disables other sensors, because they're on the same enable pin. Please use with caution.


Definition at line 58 of file common/sensor_lux/sl_sensor_lux.h

sl_sensor_lux_get#

sl_status_t sl_sensor_lux_get (float *lux)
Parameters
[out]lux

Ambient light illuminance (in lux).

Getter for ambient light sensor measurement data. Returns

  • Status of the operation.


Definition at line 65 of file common/sensor_lux/sl_sensor_lux.h

Macro Definition Documentation#

SENSOR_LUX_POSITIVE_TOLERANCE#

#define SENSOR_LUX_POSITIVE_TOLERANCE
Value:
0

Definition at line 46 of file common/sensor_lux/config/sl_sensor_lux_config.h

SENSOR_LUX_NEGATIVE_TOLERANCE#

#define SENSOR_LUX_NEGATIVE_TOLERANCE
Value:
0

Definition at line 52 of file common/sensor_lux/config/sl_sensor_lux_config.h

SENSOR_LUX_SAMPLING_FUNCTION#

#define SENSOR_LUX_SAMPLING_FUNCTION
Value:
SAMPLING_UNSPECIFIED

Definition at line 66 of file common/sensor_lux/config/sl_sensor_lux_config.h

SENSOR_LUX_MEASUREMENT_PERIOD#

#define SENSOR_LUX_MEASUREMENT_PERIOD
Value:
0

Definition at line 72 of file common/sensor_lux/config/sl_sensor_lux_config.h

SENSOR_LUX_UPDATE_INTERVAL#

#define SENSOR_LUX_UPDATE_INTERVAL
Value:
0

Definition at line 78 of file common/sensor_lux/config/sl_sensor_lux_config.h