Line Health / VL6180

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

ALS functions
Modules | Functions

ALS functions

ALS functions. More...

Modules

 Misc functions
 

Misc functions.


 Interrupts management functions
 

Interrupts management functions.


Functions

int AlsWaitDeviceReady (int MaxLoop)
 Wait for device to be ready for new als operation or max pollign loop (time out)
int AlsSetSystemMode (uint8_t mode)
 Set ALS system mode and start/stop measure.
virtual int GetLux (uint32_t *piData)
 Get a single light (in Lux) measure result.
int AlsStartContinuousMode ()
 Start the ALS (light) measure in continous mode.
int AlsStartSingleShot ()
 Start the ALS (light) measure in single shot mode.

Detailed Description

ALS functions.

Function Documentation

int AlsSetSystemMode ( uint8_t  mode ) [inherited]

Set ALS system mode and start/stop measure.

Warning:
When used outside after single shot polling,
User must ensure the device state is ready before issuing a new command (using VL6180x_AlsWaitDeviceReady()).
Non respect of this, can cause loss of interrupt or device hanging.
Parameters:
modeA combination of working mode (MODE_SINGLESHOT or MODE_CONTINUOUS) and start condition (MODE_START_STOP)
Returns:
0 on success

Definition at line 930 of file vl6180x_class.h.

int AlsStartContinuousMode (  ) [inherited]

Start the ALS (light) measure in continous mode.

Function Description
Start the ALS (light) measure in continous mode
Returns:
0 On success

Definition at line 1118 of file vl6180x_class.h.

int AlsStartSingleShot (  ) [inherited]

Start the ALS (light) measure in single shot mode.

Function Description
Start the ALS (light) measure in single shot mode
Returns:
0 On success

Definition at line 1130 of file vl6180x_class.h.

int AlsWaitDeviceReady ( int  MaxLoop ) [inherited]

Wait for device to be ready for new als operation or max pollign loop (time out)

Parameters:
MaxLoopMax Number of i2c polling loop see msec_2_i2cloop
Returns:
0 on success. <0 when VL6180x_ErrCode_t::TIME_OUT if timed out

Definition at line 915 of file vl6180x_class.h.

virtual int GetLux ( uint32_t *  piData ) [virtual, inherited]

Get a single light (in Lux) measure result.

Function Description
It can be called after having initialized a component. It start a single light measure in polling mode and wait until the measure is finisched. The function block until the measure is finished, it can blocks indefinitely in case the measure never ends for any reason

Definition at line 1094 of file vl6180x_class.h.

Generated on Wed Jul 13 2022 22:31:06 by  doxygen 1.7.2