Creating a project about VL6180XA1 for TT_Mxx
LightSensor Class Reference
An abstract class for ambient light sensors. More...
#include <LightSensor.h>
Inherits ComponentObject.
Public Member Functions | |
virtual int | GetLight (uint32_t *piData)=0 |
Get current light [lux]. | |
virtual int | Init ()=0 |
Initializing the component. | |
virtual int | ReadID ()=0 |
Getting the ID of the component. |
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] piData Pointer to where to store light to
- Returns:
- 0 in case of success, an error code otherwise
virtual int Init | ( | ) | [pure virtual, inherited] |
Initializing the component.
- Parameters:
-
[in] init pointer to device specific initalization structure.
- Return values:
-
0 in case of success, an error code otherwise.
virtual int ReadID | ( | ) | [pure virtual, inherited] |
Getting the ID of the component.
- Parameters:
-
[out] id pointer to an allocated variable to store the ID into.
- Return values:
-
0 in case of success, an error code otherwise.
Generated on Tue Jul 12 2022 21:49:24 by 1.7.2