ambientlight_ltr329.h File Reference

Functions for interacting with the LTR329 ambient light sensor. More...

#include "sensor_common.h"

Go to the source code of this file.

Enumerations
enum	MblMwAlsLtr329Gain {   MBL_MW_ALS_LTR329_GAIN_1X = 0 , MBL_MW_ALS_LTR329_GAIN_2X , MBL_MW_ALS_LTR329_GAIN_4X , MBL_MW_ALS_LTR329_GAIN_8X ,   MBL_MW_ALS_LTR329_GAIN_48X , MBL_MW_ALS_LTR329_GAIN_96X }
	Controls the range and resolution of illuminance values. More...
enum	MblMwAlsLtr329IntegrationTime {   MBL_MW_ALS_LTR329_TIME_100ms = 0 , MBL_MW_ALS_LTR329_TIME_50ms , MBL_MW_ALS_LTR329_TIME_200ms , MBL_MW_ALS_LTR329_TIME_400ms ,   MBL_MW_ALS_LTR329_TIME_150ms , MBL_MW_ALS_LTR329_TIME_250ms , MBL_MW_ALS_LTR329_TIME_300ms , MBL_MW_ALS_LTR329_TIME_350ms }
	Measurement time for each cycle. More...
enum	MblMwAlsLtr329MeasurementRate {   MBL_MW_ALS_LTR329_RATE_50ms = 0 , MBL_MW_ALS_LTR329_RATE_100ms , MBL_MW_ALS_LTR329_RATE_200ms , MBL_MW_ALS_LTR329_RATE_500ms ,   MBL_MW_ALS_LTR329_RATE_1000ms , MBL_MW_ALS_LTR329_RATE_2000ms }
	How frequently to update the illuminance data. More...

Functions
METAWEAR_API MblMwDataSignal *	mbl_mw_als_ltr329_get_illuminance_data_signal (const MblMwMetaWearBoard *board)
	Retrieves the data signal representing LTR329 illuminance data This signal represents the luminance in lux. More...
METAWEAR_API void	mbl_mw_als_ltr329_set_gain (MblMwMetaWearBoard *board, MblMwAlsLtr329Gain gain)
	Sets the sensor gain There are altogether six gain settings (1X, 2X, 4X, 8X, 48X and 96X) available for user to configure See MblMwAlsLtr329Gain for allowed values. More...
METAWEAR_API void	mbl_mw_als_ltr329_set_integration_time (MblMwMetaWearBoard *board, MblMwAlsLtr329IntegrationTime integration_time)
	Sets the sensor integration time Measurement time for each full light measurement (ALS) cycle - 100ms (default) to 350 ms See MblMwAlsLtr329IntegrationTime for allowed values. More...
METAWEAR_API void	mbl_mw_als_ltr329_set_measurement_rate (MblMwMetaWearBoard *board, MblMwAlsLtr329MeasurementRate measurement_rate)
	Sets the sensor measurement rate Frequency of light measurement - 50ms (default) to 2000 ms See MblMwAlsLtr329MeasurementRate for allowed values. More...
METAWEAR_API void	mbl_mw_als_ltr329_write_config (const MblMwMetaWearBoard *board)
	Writes the configuration to the LTR329 sensor Applies the INTEGRATION TIME, MEASUREMENT RATE, and GAIN values set in set_*(). More...
METAWEAR_API void	mbl_mw_als_ltr329_start (const MblMwMetaWearBoard *board)
	Starts illuminance sampling. More...
METAWEAR_API void	mbl_mw_als_ltr329_stop (const MblMwMetaWearBoard *board)
	Stops illuminance sampling. More...

Detailed Description

Functions for interacting with the LTR329 ambient light sensor.

Copyright

MbientLab License

This sensor is only available on MetaWear RPro boards.

Enumeration Type Documentation

MblMwAlsLtr329Gain

enum MblMwAlsLtr329Gain

Controls the range and resolution of illuminance values.

Enumerator
MBL_MW_ALS_LTR329_GAIN_1X	Illuminance range between [1, 64k] lux (default)
MBL_MW_ALS_LTR329_GAIN_2X	Illuminance range between [0.5, 32k] lux.
MBL_MW_ALS_LTR329_GAIN_4X	Illuminance range between [0.25, 16k] lux.
MBL_MW_ALS_LTR329_GAIN_8X	Illuminance range between [0.125, 8k] lux.
MBL_MW_ALS_LTR329_GAIN_48X	Illuminance range between [0.02, 1.3k] lux.
MBL_MW_ALS_LTR329_GAIN_96X	Illuminance range between [0.01, 600] lux.

MblMwAlsLtr329IntegrationTime

enum MblMwAlsLtr329IntegrationTime

Measurement time for each cycle.

Enumerator
MBL_MW_ALS_LTR329_TIME_100ms	Default setting.

MblMwAlsLtr329MeasurementRate

enum MblMwAlsLtr329MeasurementRate

How frequently to update the illuminance data.

Enumerator
MBL_MW_ALS_LTR329_RATE_500ms	Default setting.

Function Documentation

mbl_mw_als_ltr329_get_illuminance_data_signal()

METAWEAR_API MblMwDataSignal* mbl_mw_als_ltr329_get_illuminance_data_signal

(

const MblMwMetaWearBoard *

board

)

Retrieves the data signal representing LTR329 illuminance data This signal represents the luminance in lux.

Parameters

board

Pointer to the board to retrieve the signal from

Returns

Pointer to the board's LTR329 illuminance data signal UINT32 is return signal data type

mbl_mw_als_ltr329_set_gain()

METAWEAR_API void mbl_mw_als_ltr329_set_gain	(	MblMwMetaWearBoard *	board,
		MblMwAlsLtr329Gain	gain
	)

Sets the sensor gain There are altogether six gain settings (1X, 2X, 4X, 8X, 48X and 96X) available for user to configure See MblMwAlsLtr329Gain for allowed values.

Parameters

board	Pointer to the board to modify
gain	Sensor gain value to set

mbl_mw_als_ltr329_set_integration_time()

METAWEAR_API void mbl_mw_als_ltr329_set_integration_time	(	MblMwMetaWearBoard *	board,
		MblMwAlsLtr329IntegrationTime	integration_time
	)

Sets the sensor integration time Measurement time for each full light measurement (ALS) cycle - 100ms (default) to 350 ms See MblMwAlsLtr329IntegrationTime for allowed values.

Parameters

board	Pointer to the board to modify
integration_time	Integration time value to set

mbl_mw_als_ltr329_set_measurement_rate()

METAWEAR_API void mbl_mw_als_ltr329_set_measurement_rate	(	MblMwMetaWearBoard *	board,
		MblMwAlsLtr329MeasurementRate	measurement_rate
	)

Sets the sensor measurement rate Frequency of light measurement - 50ms (default) to 2000 ms See MblMwAlsLtr329MeasurementRate for allowed values.

Parameters

board	Pointer to the board to modify
measurement_rate	Measurement rate value to set

mbl_mw_als_ltr329_start()

METAWEAR_API void mbl_mw_als_ltr329_start

(

const MblMwMetaWearBoard *

board

)

Starts illuminance sampling.

Parameters

board

Pointer to the board to send the command to

mbl_mw_als_ltr329_stop()

METAWEAR_API void mbl_mw_als_ltr329_stop

(

const MblMwMetaWearBoard *

board

)

Stops illuminance sampling.

Parameters

board

Pointer to the board to send the command to

mbl_mw_als_ltr329_write_config()

METAWEAR_API void mbl_mw_als_ltr329_write_config

(

const MblMwMetaWearBoard *

board

)

Writes the configuration to the LTR329 sensor Applies the INTEGRATION TIME, MEASUREMENT RATE, and GAIN values set in set_*().

Parameters

board

Pointer to the board to send the command to