Library for the MAX30205
The MAX30205 temperature sensor accurately measures temperature and provide an overtemperature alarm/interrupt/shutdown output. More...

#include <MAX30205.h>

Inherits MaximSensor.

Data Structures
union	Configuration_u
	MAX30205 Configuration register bitfields. More...
Public Types
enum	Registers_e
	MAX30205 Register Addresses. More...
Public Member Functions
	MAX30205 (I2C *i2c, uint8_t slaveAddress)
	Constructor using reference to I2C object.
	~MAX30205 (void)
	Destructor.
int32_t	readTemperature (uint16_t &value)
	Read the temperature from the device into a 16 bit value.
int32_t	readConfiguration (Configuration_u &config)
	Read the configuration register.
int32_t	writeConfiguration (const Configuration_u config)
	Write the configuration register with given configuration.
int32_t	readTHYST (uint16_t &value)
	Read the THYST value from a specified device instance.
int32_t	writeTHYST (const uint16_t value)
	Write the THYST to a device instance.
int32_t	readTOS (uint16_t &value)
	Read the TOS value from device.
int32_t	writeTOS (const uint16_t value)
	Write the TOS register.
float	toCelsius (uint32_t rawTemp)
	Convert a raw temperature value into a float.
float	toFahrenheit (float temperatureC)
	Convert the passed in temperature in C to Fahrenheit.
int32_t	writeRegister (Registers_e reg, uint16_t value)
	Write register of device at slave address.
int32_t	readRegister (Registers_e reg, uint16_t &value)
	Read register of device at slave address.
virtual int	dump_registers (addr_val_pair *reg_values)
	Dump Maxim Sensor registers.
unsigned char	get_sensor_id ()
	Get sensor ID.
const char *	get_sensor_part_name ()
	Get sensor part name.
const char *	get_sensor_algo_ver ()
	Get sensor algorithm version.
virtual int	sensor_enable (int enable)
	Enables Maxim Sensor.
virtual int	readRegister (uint8_t reg, uint8_t *data, int len)
	Reads from register.
virtual int	writeRegister (uint8_t reg, const uint8_t data)
	Writes data to Maxim Sensor register.
virtual int	get_part_info (uint8_t part_id, uint8_t rev_id)
	Get Maxim Sensor part and revision info.
virtual int	agc_enable (int agc_enable)
	Enables AGC.
virtual const char *	get_sensor_name ()
	Get sensor name.

Detailed Description

Library for the MAX30205
The MAX30205 temperature sensor accurately measures temperature and provide an overtemperature alarm/interrupt/shutdown output.

This device converts the temperature measurements to digital form using a high-resolution, sigma-delta, analog-to-digital converter (ADC). Accuracy meets clinical thermometry specification of the ASTM E1112 when soldered on the final PCB. Communication is through an I2C-compatible 2-wire serial interface.

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

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

 //Get temp sensor instance
 MAX30205 bodyTempSensor(i2cBus, 0x4D); //Constructor takes 7-bit slave adrs

 int main(void) 
 {
     //use sensor
 }

Definition at line 70 of file MAX30205.h.

Member Enumeration Documentation

enum Registers_e

MAX30205 Register Addresses.

Definition at line 75 of file MAX30205.h.

Constructor & Destructor Documentation

MAX30205	(	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 39 of file MAX30205.cpp.

~MAX30205 ( void )

Destructor.

Definition at line 48 of file MAX30205.cpp.

Member Function Documentation

int agc_enable ( int agc_enable ) [virtual, inherited]

Enables AGC.

Enable Maxim Sensor automatic gain controller. AGC automatically adjusts sampling rates and LED currents to save energy.

Parameters:

[in] agc_enable Any value to enable, 0 to disable.

Returns:: 0 on success, negative error code on failure.

Definition at line 106 of file MaximSensor.cpp.

int dump_registers ( addr_val_pair * reg_values ) [virtual]

Dump Maxim Sensor registers.

Fill out register values into list

Returns:: 0 on success, negative error code on failure.

Implements MaximSensor.

Definition at line 174 of file MAX30205.cpp.

int get_part_info	(	uint8_t *	part_id,
		uint8_t *	rev_id
	)		`[virtual, inherited]`

Get Maxim Sensor part and revision info.

Reads Maxim Sensor part and revision info from device.

Parameters:

[in]	reg	Beginning address of a register to be read.
[out]	data	Buffer space to save result value.
[in]	len	Number of consecutive bytes to be read.

Returns:: 0 on success, negative error code on failure.

Definition at line 79 of file MaximSensor.cpp.

const char * get_sensor_algo_ver ( ) [virtual]

Get sensor algorithm version.

Get sensor name.

Returns:: Sensor algorithm version string.; Sensor name string.

Reimplemented from MaximSensor.

Definition at line 192 of file MAX30205.cpp.

unsigned char get_sensor_id ( ) [virtual]

Get sensor ID.

Returns:: Sensor ID number.

Reimplemented from MaximSensor.

Definition at line 221 of file MAX30205.cpp.

const char * get_sensor_name ( ) [virtual, inherited]

Get sensor name.

Returns:: Sensor name string.

Definition at line 131 of file MaximSensor.cpp.

const char * get_sensor_part_name ( ) [virtual]

Get sensor part name.

Returns:: Sensor part name string.

Reimplemented from MaximSensor.

Definition at line 187 of file MAX30205.cpp.

int32_t readConfiguration ( Configuration_u & config )

Read the configuration register.

Parameters:

config - Reference to Configuration type

Returns:: 0 on success, non-zero on failure

Definition at line 64 of file MAX30205.cpp.

int32_t readRegister	(	Registers_e	reg,
		uint16_t &	value
	)

Read register of device at slave address.

Parameters:

	reg	- Register address
[out]	value	- Read data on success

Returns:: 0 on success, non-zero on failure

Definition at line 154 of file MAX30205.cpp.

int readRegister	(	uint8_t	reg,
		uint8_t *	data,
		int	len
	)		`[virtual, inherited]`

Reads from register.

Reads specific Maxim Sensor register via SPI bus.

Parameters:

[in]	reg	Beginning address of a register to be read.
[out]	data	Buffer space to save result value.
[in]	len	Number of consecutive bytes to be read.

Returns:: 0 on success, negative error code on failure.

Definition at line 50 of file MaximSensor.cpp.

int32_t readTemperature ( uint16_t & value )

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

Parameters:

[out] value - Raw temperature data on success

Returns:: 0 on success, non-zero on failure

Definition at line 57 of file MAX30205.cpp.

int32_t readTHYST ( uint16_t & value )

Read the THYST value from a specified device instance.

Parameters:

[out] value - THYST register value on success

Returns:: 0 on success, non-zero on failure

Definition at line 89 of file MAX30205.cpp.

int32_t readTOS ( uint16_t & value )

Read the TOS value from device.

Parameters:

[out] value - TOS register value on success

Returns:: 0 on success, non-zero on failure

Definition at line 103 of file MAX30205.cpp.

int sensor_enable ( int enable ) [virtual]

Enables Maxim Sensor.

Enable IRQ, enable LEDs, enable AGC

Parameters:

[in] enable Any value to enable, 0 to disable.

Returns:: 0 on success, negative error code on failure.

Reimplemented from MaximSensor.

Definition at line 198 of file MAX30205.cpp.

float toCelsius ( uint32_t rawTemp )

Convert a raw temperature value into a float.

Parameters:

rawTemp - raw temperature value to convert

Returns:: the convereted value in degrees C

Definition at line 117 of file MAX30205.cpp.

float toFahrenheit ( float temperatureC )

Convert the passed in temperature in C to Fahrenheit.

Parameters:

temperatureC Temperature in C to convert

Returns:: Returns the converted Fahrenheit value

Definition at line 132 of file MAX30205.cpp.

int32_t writeConfiguration ( const Configuration_u config )

Write the configuration register with given configuration.

Parameters:

config - Configuration to write

Returns:: 0 on success, non-zero on failure

Definition at line 80 of file MAX30205.cpp.

int32_t writeRegister	(	Registers_e	reg,
		uint16_t	value
	)

Write register of device at slave address.

Parameters:

reg	- Register address
value	- Value to write

Returns:: 0 on success, non-zero on failure

Definition at line 139 of file MAX30205.cpp.

int writeRegister	(	uint8_t	reg,
		const uint8_t	data
	)		`[virtual, inherited]`

Writes data to Maxim Sensor register.

Writes data to specific Maxim Sensor register via SPI bus.

Parameters:

[in]	reg	Address of a register to be wrote.
[in]	data	Data to write on register.

Returns:: 0 on success, negative error code on failure.

Definition at line 64 of file MaximSensor.cpp.

int32_t writeTHYST ( const uint16_t value )

Write the THYST to a device instance.

Parameters:

value - 16-bit value to write

Returns:: 0 on success, non-zero on failure

Definition at line 96 of file MAX30205.cpp.

int32_t writeTOS ( const uint16_t value )

Write the TOS register.

Parameters:

value - 16-bit value to write

Returns:: 0 on success, non-zero on failure

Definition at line 110 of file MAX30205.cpp.

Type:	Program
Mbed OS support:	Mbed OS
Created:	10 Apr 2019
Imports:	351
Forks:	0
Commits:	5
Dependents:	0
Dependencies:	3
Followers:	114

Important changes to repositories hosted on mbed.com

MAX30205 Class Reference

Data Structures

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Important changes to repositories hosted on mbed.com

MAX30205 Class Reference

Data Structures

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning