Stage-1 Students SoCEM / Mbed OS ReferredCoursework2016

Version of the IKS01A1 library for this coursework

Dependencies:   X_NUCLEO_COMMON

Fork of X_NUCLEO_IKS01A1 by ST

Embed: (wiki syntax)

« Back to documentation index

HumiditySensor Class Reference
Public Member Functions

HumiditySensor Class Reference

An abstract class for Humidity sensors. More...

#include <HumiditySensor.h>

Inherits GenericSensor.

Inherited by HTS221.

Public Member Functions

virtual int GetHumidity (float *pfData)=0
 Get current humidity [%].
virtual int Init (void *ptr)=0
 Initialization of sensor.
virtual int ReadID (uint8_t *id)=0
 Get ID of sensor.

Detailed Description

An abstract class for Humidity sensors.

Definition at line 49 of file HumiditySensor.h.

Member Function Documentation

virtual int GetHumidity ( float *  pfData ) [pure virtual]

Get current humidity [%].

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

Implemented in HTS221.

virtual int Init ( void *  ptr ) [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 HTS221, LIS3MDL, LPS25H, LSM6DS0, and LSM6DS3.

virtual int ReadID ( uint8_t *  id ) [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

Implemented in HTS221, LIS3MDL, LPS25H, LSM6DS0, and LSM6DS3.

Generated on Wed Jul 13 2022 04:19:45 by  doxygen 1.7.2