Maxim Integrated / MAX30208

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   LP_Receiver_Wakeup

Embed: (wiki syntax)

« Back to documentation index

MAX30208 Class Reference
Public Types | Public Member Functions | Protected Member Functions

MAX30208 Class Reference

Library for the MAX30208. More...

#include <MAX30208.h>

Public Types

enum  Registers_e
 

MAX30208 Register Addresses.

More...

Public Member Functions

 MAX30208 (I2C &i2c, uint8_t slaveAddress)
 Constructor using reference to I2C object.
 ~MAX30208 (void)
 Destructor.
int32_t writeInterruptRegister (Configuration_InterruptEnable config)
 Write Interrupt Register.
int32_t readInterruptRegister (Configuration_InterruptEnable &config)
 Read Interrupt Register Configuration.
int32_t readStatus (uint16_t &value)
 Read Status Register.
int32_t readWritePointer (uint16_t &value)
 Read FIFO Write Pointer Value.
int32_t readReadPointer (uint16_t &value)
 Read FIFO Read Pointer Value.
int32_t writeReadPointer (uint8_t config)
 Write FIFO Read Pointer Value.
int32_t readOverflow (uint16_t &value)
 Read FIFO Overflow Register.
int32_t readDataCounter (uint16_t &value)
 Read Data Counter Register.
int32_t readData (uint16_t &value)
 Read FIFO Data at FIFO Read Pointer.
int32_t takeDataMeasurment ()
 Take a new temperature reading.
int32_t readFIFOConfig1 (uint16_t &value)
 Read FIFO Config1 Register.
int32_t writeFIFOConfig1 (uint8_t config)
 Write FIFO Config1 register.
int32_t readFIFOConfig2 (Configuration_FIFOConfig2 &config)
 Read FIFO Config2 register.
int32_t writeFIFOConfig2 (Configuration_FIFOConfig2 config)
 Read FIFO Config2 register.
int32_t resetDevice ()
 Reset Device to factory default.
int32_t readAlarmHigh (uint16_t &temp)
 Read High Temperature Alarm Value.
int32_t writeAlarmHigh (uint16_t temp)
 Write High Temperature Alarm Value.
int32_t readAlarmLow (uint16_t &value)
 Read Low Temperature Alarm Value.
int32_t writeAlarmLow (uint16_t temp)
 Write Low Temperature Alarm Value.
int32_t readGPIOSetup (Configuration_GPIOSetup &config)
 Read GPIO Setup register.
int32_t writeGPIOSetup (Configuration_GPIOSetup config)
 Write GPIO Setup register.
int32_t readGPIOControl (Configuration_GPIOControl &config)
 Read GPIO Control register.
int32_t writeGPIOControl (Configuration_GPIOControl config)
 Write GPIO Control register.
float toCelsius (uint16_t rawTemp)
 Convert Raw Sensor Data to degrees Celisus.
float toFahrenheit (float temperatureC)
 Convert Celsius Temperature to Fahrenheit.

Protected Member Functions

int32_t writeRegister (Registers_e reg, uint16_t value, int bytesWritten)
 Write register of device at slave address.
int32_t readRegister (Registers_e reg, uint16_t &value, int bytesRead)
 Read register of device at slave address.

Detailed Description

Library for the MAX30208. 

 #include "mbed.h"
 #include "max32630fthr.h"
 #include "MAX30208.h"
 
 MAX32630FTHR pegasus(MAX32630FTHR::VIO_3V3);

 //Get I2C instance
 I2C i2cBus(I2C1_SDA, I2C1_SCL);

 //Get temp sensor instance
 MAX30208 BodyTempSensor(i2cBus, 0x50); //Constructor takes 7-bit slave adress. 0x50 is default slave address for MAX30208 Ev-Kit

 int main(void) 
 {
     //use sensor
 }

Definition at line 66 of file MAX30208.h.

Member Enumeration Documentation

enum Registers_e

MAX30208 Register Addresses.

Definition at line 71 of file MAX30208.h.

Constructor & Destructor Documentation

MAX30208 ( I2C &  i2c,
uint8_t  slaveAddress 
)

Constructor using reference to I2C object.

Parameters:
i2c- Reference to I2C object
slaveAddress- 7-bit I2C address

Definition at line 43 of file MAX30208.cpp.

~MAX30208 ( void   )

Destructor.

Definition at line 51 of file MAX30208.cpp.

Member Function Documentation

int32_t readAlarmHigh ( uint16_t &  temp )

Read High Temperature Alarm Value.

Parameters:
[out]temp- High Temperature Alarm Value
Returns:
0 on success, non-zero on failure

Definition at line 143 of file MAX30208.cpp.

int32_t readAlarmLow ( uint16_t &  value )

Read Low Temperature Alarm Value.

Parameters:
[out]temp- Low Temperature Alarm Value
Returns:
0 on success, non-zero on failure

Definition at line 153 of file MAX30208.cpp.

int32_t readData ( uint16_t &  value )

Read FIFO Data at FIFO Read Pointer.

Parameters:
[out]value- Temperature value from FIFO data register on succesful read
Returns:
0 on success, non-zero on failure

Definition at line 102 of file MAX30208.cpp.

int32_t readDataCounter ( uint16_t &  value )

Read Data Counter Register.

Parameters:
[out]value- Data Count register value on succesful read
Returns:
0 on success, non-zero on failure

Definition at line 97 of file MAX30208.cpp.

int32_t readFIFOConfig1 ( uint16_t &  value )

Read FIFO Config1 Register.

Parameters:
[out]value- FIFO Config1 value on succesful read
Returns:
0 on success, non-zero on failure

Definition at line 112 of file MAX30208.cpp.

int32_t readFIFOConfig2 ( Configuration_FIFOConfig2 &  config )

Read FIFO Config2 register.

Parameters:
[out]config- Reference to Configuration type, config.all is updated upon succesful register read
Returns:
0 on success, non-zero on failure

Definition at line 122 of file MAX30208.cpp.

int32_t readGPIOControl ( Configuration_GPIOControl &  config )

Read GPIO Control register.

Parameters:
config- Reference to Configuration type, config.all is updated upon succesful register read
Returns:
0 on success, non-zero on failure

Definition at line 179 of file MAX30208.cpp.

int32_t readGPIOSetup ( Configuration_GPIOSetup &  config )

Read GPIO Setup register.

Parameters:
config- Reference to Configuration type, config.all is updated upon succesful register read
Returns:
0 on success, non-zero on failure

Definition at line 163 of file MAX30208.cpp.

int32_t readInterruptRegister ( Configuration_InterruptEnable &  config )

Read Interrupt Register Configuration.

Parameters:
config- Reference to Configuration type, config.all is updated upon succesful register read
Returns:
0 on success, non-zero on failure

Definition at line 61 of file MAX30208.cpp.

int32_t readOverflow ( uint16_t &  value )

Read FIFO Overflow Register.

Parameters:
[out]value- Overflow Counter value on succesful read
Returns:
0 on success, non-zero on failure

Definition at line 92 of file MAX30208.cpp.

int32_t readReadPointer ( uint16_t &  value )

Read FIFO Read Pointer Value.

Parameters:
[out]value- FIFO Read Pointer value on succesful read
Returns:
0 on success, non-zero on failure

Definition at line 82 of file MAX30208.cpp.

int32_t readRegister ( Registers_e  reg,
uint16_t &  value,
int  bytesRead 
) [protected]

Read register of device at slave address.

Parameters:
reg- Register address
[out]value- Read data on successful read
bytesRead- Number of bytes to read
Returns:
0 on success, non-zero on failure

Definition at line 222 of file MAX30208.cpp.

int32_t readStatus ( uint16_t &  value )

Read Status Register.

Parameters:
[out]value- Status Register Value on succesful read
Returns:
0 on success, non-zero on failure

Definition at line 72 of file MAX30208.cpp.

int32_t readWritePointer ( uint16_t &  value )

Read FIFO Write Pointer Value.

Parameters:
[out]value- FIFO Write Pointer value on succesful read
Returns:
0 on success, non-zero on failure

Definition at line 77 of file MAX30208.cpp.

int32_t resetDevice (  )

Reset Device to factory default.

Returns:
0 on success, non-zero on failure

Definition at line 138 of file MAX30208.cpp.

int32_t takeDataMeasurment (  )

Take a new temperature reading.

Returns:
0 on success, non-zero on failure

Definition at line 107 of file MAX30208.cpp.

float toCelsius ( uint16_t  rawTemp )

Convert Raw Sensor Data to degrees Celisus.

Parameters:
rawTemp- 16 bit raw temperature data
Returns:
Returns the converted Celsius Temperature

Definition at line 195 of file MAX30208.cpp.

float toFahrenheit ( float  temperatureC )

Convert Celsius Temperature to Fahrenheit.

Parameters:
temperatureC- Temperature in degrees Celsius that will be converted
Returns:
Returns the converted Fahrenheit temperature

Definition at line 202 of file MAX30208.cpp.

int32_t writeAlarmHigh ( uint16_t  temp )

Write High Temperature Alarm Value.

Parameters:
temp- 16-bit High Temperature Value to Write
Returns:
0 on success, non-zero on failure

Definition at line 148 of file MAX30208.cpp.

int32_t writeAlarmLow ( uint16_t  temp )

Write Low Temperature Alarm Value.

Parameters:
temp- 16-bit Low Temperature Value to Write
Returns:
0 on success, non-zero on failure

Definition at line 158 of file MAX30208.cpp.

int32_t writeFIFOConfig1 ( uint8_t  config )

Write FIFO Config1 register.

Parameters:
config- FIFO Config1 register data to write
Returns:
0 on success, non-zero on failure

Definition at line 117 of file MAX30208.cpp.

int32_t writeFIFOConfig2 ( Configuration_FIFOConfig2  config )

Read FIFO Config2 register.

Parameters:
config- Reference to Configuration type, config.all is written upon succesful register write
Returns:
0 on success, non-zero on failure

Definition at line 133 of file MAX30208.cpp.

int32_t writeGPIOControl ( Configuration_GPIOControl  config )

Write GPIO Control register.

Parameters:
config- Reference to Configuration type, config.all is written to register upon succesful register write
Returns:
0 on success, non-zero on failure

Definition at line 190 of file MAX30208.cpp.

int32_t writeGPIOSetup ( Configuration_GPIOSetup  config )

Write GPIO Setup register.

Parameters:
config- Reference to Configuration type, config.all is written to register upon succesful register write
Returns:
0 on success, non-zero on failure

Definition at line 174 of file MAX30208.cpp.

int32_t writeInterruptRegister ( Configuration_InterruptEnable  config )

Write Interrupt Register.

Parameters:
config- Reference to Configuration type, config.all is written upon succesful register write
Returns:
0 on success, non-zero on failure

Definition at line 56 of file MAX30208.cpp.

int32_t writeReadPointer ( uint8_t  config )

Write FIFO Read Pointer Value.

Parameters:
config- New FIFO Read Pointer value on succesful write
Returns:
0 on success, non-zero on failure

Definition at line 87 of file MAX30208.cpp.

int32_t writeRegister ( Registers_e  reg,
uint16_t  value,
int  bytesWritten 
) [protected]

Write register of device at slave address.

Parameters:
reg- char array that contains address of register and write value
value- Data written to register on sucessful write
bytesWritten- Number of bytes to write
Returns:
0 on success, non-zero on failure

Definition at line 209 of file MAX30208.cpp.

Generated on Sat Jul 23 2022 23:38:39 by  doxygen 1.7.2