Code petit robot

Dependencies:   X_NUCLEO_COMMON X_NUCLEO_IHM01A1 mbed

Embed: (wiki syntax)

« Back to documentation index

LightSensor Class Reference

LightSensor Class Reference

An abstract class for ambient light sensors. More...

#include <LightSensor.h>

Inherits GenericSensor.

Inherited by VL6180X.

Public Member Functions

virtual int GetLight (uint32_t *piData)=0
 Get current light [lux].
virtual int Init ()=0
 Initialization of sensor.
virtual int ReadID ()=0
 Get ID of sensor.

Detailed Description

An abstract class for ambient light sensors.

Definition at line 49 of file LightSensor.h.


Member Function Documentation

virtual int GetLight ( uint32_t *  piData ) [pure virtual]

Get current light [lux].

Parameters:
[out]piDataPointer to where to store light to
Returns:
0 in case of success, an error code otherwise

Implemented in VL6180X.

virtual int Init (  ) [pure virtual, inherited]

Initialization of sensor.

Parameters:
[out]ptrPointer to device specific initalization structure
Returns:
0 in case of success, an error code otherwise

Implemented in VL6180X.

virtual int ReadID (  ) [pure virtual, inherited]

Get ID of sensor.

Parameters:
[out]idPointer to where to store the ID to
Returns:
0 in case of success, an error code otherwise