Jerry Bradshaw / Mbed OS HSP_RPC_GUI_3_0_1

Firmware enhancements for HSP_RPC_GUI 3.0.1

Dependencies:   USBDevice

Fork of HSP_RPC_GUI by Maxim Integrated

Embed: (wiki syntax)

« Back to documentation index

MAX30205 Class Reference
Public Types | Public Member Functions

MAX30205 Class Reference

Driver for the MAX30205 on the HSP Platform. More...

#include <MAX30205.h>

Public Types

enum  Registers
 

< MAX30205 Register Addresses

More...
typedef enum MAX30205::Registers Registers_t
 < MAX30205 Register Addresses

Public Member Functions

 MAX30205 (PinName sda, PinName scl, int slaveAddress)
 Constructor using I2C PinNames.
 MAX30205 (I2C *i2c, int slaveAddress)
 Constructor using pointer to I2C object.
 ~MAX30205 (void)
 Destructor.
int reg_write (char reg, char value)
 Write a register into device at slave address.
int reg_read (char reg, char *value)
 Detect the second instance of the MAX30205.
int reg_write16 (char reg, uint16_t value)
 Write a 16-bit value into device at slave address.
int reg_read16 (char reg, uint16_t *value)
 Read a 16-bit value from a device at a slave address.
int readTemperature (uint16_t *value)
 Read the temperature from the device into a 16 bit value.
int reg_THYST_Read (uint16_t *value)
 Read the THYST value from a specified device instance.
int reg_THYST_Write (uint16_t value)
 Write the THYST to a device instance.
float toCelsius (unsigned int rawTemp)
 Convert a raw temperature value into a float.
float toFahrenheit (float temperatureC)
 Convert the passed in temperature in C to Fahrenheit.

Detailed Description

Driver for the MAX30205 on the HSP Platform.

Definition at line 42 of file MAX30205.h.

Member Typedef Documentation

typedef enum MAX30205::Registers Registers_t

< MAX30205 Register Addresses

Member Enumeration Documentation

enum Registers

< MAX30205 Register Addresses

Definition at line 45 of file MAX30205.h.

Constructor & Destructor Documentation

MAX30205 ( PinName  sda,
PinName  scl,
int  slaveAddress 
)

Constructor using I2C PinNames.

Parameters:
sdaPinname for sda
sclPinname for scl

Definition at line 36 of file MAX30205.cpp.

MAX30205 ( I2C *  i2c,
int  slaveAddress 
)

Constructor using pointer to I2C object.

Parameters:
*i2cPointer to I2C object

Definition at line 44 of file MAX30205.cpp.

~MAX30205 ( void   )

Destructor.

Definition at line 51 of file MAX30205.cpp.

Member Function Documentation

int readTemperature ( uint16_t *  value )

Read the temperature from the device into a 16 bit value.

Parameters:
valuepointer to a 16 bit short

Definition at line 115 of file MAX30205.cpp.

int reg_read ( char  reg,
char *  value 
)

Detect the second instance of the MAX30205.

Parameters:
regregister address
value8-bit value to writes

Definition at line 82 of file MAX30205.cpp.

int reg_read16 ( char  reg,
uint16_t *  value 
)

Read a 16-bit value from a device at a slave address.

Parameters:
regregister address
valuepointer to store read value

Definition at line 98 of file MAX30205.cpp.

int reg_THYST_Read ( uint16_t *  value )

Read the THYST value from a specified device instance.

Parameters:
value16-bit pointer of value to read into

Definition at line 139 of file MAX30205.cpp.

int reg_THYST_Write ( uint16_t  value )

Write the THYST to a device instance.

Parameters:
value16-bit value to write

Definition at line 144 of file MAX30205.cpp.

int reg_write ( char  reg,
char  value 
)

Write a register into device at slave address.

Parameters:
regregister address
valuevalue to write

Definition at line 58 of file MAX30205.cpp.

int reg_write16 ( char  reg,
uint16_t  value 
)

Write a 16-bit value into device at slave address.

Parameters:
regregister address
value16-bit value to write

Definition at line 69 of file MAX30205.cpp.

float toCelsius ( unsigned int  rawTemp )

Convert a raw temperature value into a float.

Parameters:
rawTempraw temperature value to convert
Returns:
the convereted value in degrees C

Definition at line 124 of file MAX30205.cpp.

float toFahrenheit ( float  temperatureC )

Convert the passed in temperature in C to Fahrenheit.

Parameters:
temperatureCTemperature in C to convert
Returns:
Returns the converted Fahrenheit value

Definition at line 134 of file MAX30205.cpp.

Generated on Tue Jul 12 2022 22:52:24 by  doxygen 1.7.2