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: max32630fthr Adafruit_FeatherOLED USBDevice
MaximSensor Class Reference
MaximSensor is Maxim Sensor base class. More...
#include <MaximSensor.h>
Inherited by MAX30001_Helper, and MAX30205.
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_algo_ver () |
| Get sensor algorithm version. | |
| virtual const char * | get_sensor_name () |
| Get sensor name. | |
| virtual unsigned char | get_sensor_id () |
| Get sensor ID. | |
| 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_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.
| 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_values Pointer to array of 256 addr_val_pairs
- Returns:
- 0 on success, negative error code on failure.
Implemented in MAX30205.
| 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] 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 in MAX30205.
Definition at line 155 of file MaximSensor.cpp.
| unsigned char get_sensor_id | ( | ) | [virtual] |
Get sensor ID.
- Returns:
- Sensor ID number.
Reimplemented in MAX30205.
Definition at line 142 of file MaximSensor.cpp.
| const char * get_sensor_name | ( | ) | [virtual] |
| const char * get_sensor_part_name | ( | ) | [virtual] |
Get sensor part name.
- Returns:
- Sensor part name string.
Reimplemented in MAX30205.
Definition at line 116 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] 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.
| 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 in MAX30205.
Definition at line 92 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] 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.
Generated on Tue Jul 12 2022 20:09:29 by
1.7.2