charles macneill / VL53L1CB

Initial release. Mbed library for VL53L1CB

Embed: (wiki syntax)

« Back to documentation index

Component Class Reference
Public Member Functions

Component Class Reference

An abstract class for Generic components. More...

#include <Component.h>

Inherited by BDCMotor, GyroSensor, HumiditySensor, LightSensor, MagneticSensor, MotionSensor, Nfc, PressureSensor, RangeSensor, StepperMotor, and TempSensor.

Public Member Functions

virtual int init (void *init)=0
 Initializing the component.
virtual int read_id (uint8_t *id)=0
 Getting the ID of the component.
virtual ~Component ()
 Destructor.

Detailed Description

An abstract class for Generic components.

Definition at line 56 of file Component.h.

Constructor & Destructor Documentation

virtual ~Component (  ) [virtual]

Destructor.

Definition at line 76 of file Component.h.

Member Function Documentation

virtual int init ( void *  init ) [pure virtual]

Initializing the component.

Parameters:
[in]initpointer to device specific initalization structure.
Return values:
0in case of success, an error code otherwise.

Implemented in VL53L1X.

virtual int read_id ( uint8_t *  id ) [pure virtual]

Getting the ID of the component.

Parameters:
[out]idpointer to an allocated variable to store the ID into.
Return values:
0in case of success, an error code otherwise.

Implemented in VL53L1X.

Generated on Tue Jul 12 2022 20:07:15 by  doxygen 1.7.2