charles macneill / VL53L1CB

Initial release. Mbed library for VL53L1CB

Embed: (wiki syntax)

« Back to documentation index

TempSensor Class Reference
Public Member Functions

TempSensor Class Reference

An abstract class for Temperature sensors. More...

#include <TempSensor.h>

Inherits Component.

Public Member Functions

virtual int get_temperature (float *pf_data)=0
 Get current temperature in degrees Celsius [°C].
virtual int get_fahrenheit (float *pf_data)
 Get current temperature in degrees Fahrenheit [°F].
virtual ~TempSensor ()
 Destructor.
virtual int init (void *init)=0
 Initializing the component.
virtual int read_id (uint8_t *id)=0
 Getting the ID of the component.

Detailed Description

An abstract class for Temperature sensors.

Definition at line 56 of file TempSensor.h.

Constructor & Destructor Documentation

virtual ~TempSensor (  ) [virtual]

Destructor.

Definition at line 88 of file TempSensor.h.

Member Function Documentation

virtual int get_fahrenheit ( float *  pf_data ) [virtual]

Get current temperature in degrees Fahrenheit [°F].

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

Definition at line 71 of file TempSensor.h.

virtual int get_temperature ( float *  pf_data ) [pure virtual]

Get current temperature in degrees Celsius [°C].

Parameters:
[out]pf_dataPointer to where to store temperature to
Returns:
0 in case of success, an error code otherwise
virtual int init ( void *  init ) [pure virtual, inherited]

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, inherited]

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