Maxim Integrated / Mbed OS MAXREFDES220_HEART_RATE_MONITOR

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.

Dependencies:   USBDevice max32630fthr

Fork of MAXREFDES220# by Maxim Integrated

Embed: (wiki syntax)

« Back to documentation index

MaximSensor Class Reference
Public Member Functions

MaximSensor Class Reference

MaximSensor is Maxim Sensor base class. More...

#include <MaximSensor.h>

Public Member Functions

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 sensor_enable (int enable)
 Enables Maxim Sensor.
virtual int agc_enable (int agc_enable)
 Enables AGC.
virtual const char * get_sensor_part_name ()
 Get sensor part name.
virtual const char * get_sensor_name ()
 Get sensor name.
virtual int dump_registers (addr_val_pair *reg_values)=0
 Dump Maxim Sensor registers.

Detailed Description

MaximSensor is Maxim Sensor base class.

MaximSensor includes base functions for to create new sensor classes. All sensor classes should implement this class.

Definition at line 51 of file MaximSensor.h.

Member Function Documentation

int agc_enable ( int  agc_enable ) [virtual]

Enables AGC.

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

Parameters:
[in]agc_enableAny value to enable, 0 to disable.
Returns:
0 on success, negative error code on failure.

Definition at line 71 of file MaximSensor.cpp.

virtual int dump_registers ( addr_val_pair *  reg_values ) [pure virtual]

Dump Maxim Sensor registers.

Print all Maxim Sensor register addresses and containing values.

Parameters:
[in]reg_valuesPointer to array of 256 addr_val_pairs
Returns:
0 on success, negative error code on failure.
int get_part_info ( uint8_t *  part_id,
uint8_t *  rev_id 
) [virtual]

Get Maxim Sensor part and revision info.

Reads Maxim Sensor part and revision info from device.

Parameters:
[in]regBeginning address of a register to be read.
[out]dataBuffer space to save result value.
[in]lenNumber of consecutive bytes to be read.
Returns:
0 on success, negative error code on failure.

Definition at line 44 of file MaximSensor.cpp.

const char * get_sensor_name (  ) [virtual]

Get sensor name.

Returns:
Sensor name string.

Definition at line 96 of file MaximSensor.cpp.

const char * get_sensor_part_name (  ) [virtual]

Get sensor part name.

Returns:
Sensor part name string.

Definition at line 81 of file MaximSensor.cpp.

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

Reads from register.

Reads specific Maxim Sensor register via SPI bus.

Parameters:
[in]regBeginning address of a register to be read.
[out]dataBuffer space to save result value.
[in]lenNumber of consecutive bytes to be read.
Returns:
0 on success, negative error code on failure.

Definition at line 15 of file MaximSensor.cpp.

int sensor_enable ( int  enable ) [virtual]

Enables Maxim Sensor.

Enable IRQ, enable LEDs, enable AGC

Parameters:
[in]enableAny value to enable, 0 to disable.
Returns:
0 on success, negative error code on failure.

Definition at line 57 of file MaximSensor.cpp.

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

Writes data to Maxim Sensor register.

Writes data to specific Maxim Sensor register via SPI bus.

Parameters:
[in]regAddress of a register to be wrote.
[in]dataData to write on register.
Returns:
0 on success, negative error code on failure.

Definition at line 29 of file MaximSensor.cpp.

Generated on Mon Jul 18 2022 23:37:28 by  doxygen 1.7.2