driver max30102 header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>

Include dependency graph for driver_max30102.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	max30102_handle_s
	max30102 handle structure definition More...
struct	max30102_info_s
	max30102 information structure definition More...

Macros
#define	DRIVER_MAX30102_LINK_INIT(HANDLE, STRUCTURE)
	initialize max30102_handle_t structure
#define	DRIVER_MAX30102_LINK_IIC_INIT(HANDLE, FUC)
	link iic_init function
#define	DRIVER_MAX30102_LINK_IIC_DEINIT(HANDLE, FUC)
	link iic_deinit function
#define	DRIVER_MAX30102_LINK_IIC_READ(HANDLE, FUC)
	link iic_read function
#define	DRIVER_MAX30102_LINK_IIC_WRITE(HANDLE, FUC)
	link iic_write function
#define	DRIVER_MAX30102_LINK_DELAY_MS(HANDLE, FUC)
	link delay_ms function
#define	DRIVER_MAX30102_LINK_DEBUG_PRINT(HANDLE, FUC)
	link debug_print function
#define	DRIVER_MAX30102_LINK_RECEIVE_CALLBACK(HANDLE, FUC)
	link receive_callback function

Typedefs
typedef struct max30102_handle_s	max30102_handle_t
	max30102 handle structure definition
typedef struct max30102_info_s	max30102_info_t
	max30102 information structure definition

Enumerations
enum	max30102_bool_t { MAX30102_BOOL_FALSE = 0x00 , MAX30102_BOOL_TRUE = 0x01 }
	max30102 bool enumeration definition More...
enum	max30102_sample_averaging_t { MAX30102_SAMPLE_AVERAGING_1 = 0x00 , MAX30102_SAMPLE_AVERAGING_2 = 0x01 , MAX30102_SAMPLE_AVERAGING_4 = 0x02 , MAX30102_SAMPLE_AVERAGING_8 = 0x03 , MAX30102_SAMPLE_AVERAGING_16 = 0x04 , MAX30102_SAMPLE_AVERAGING_32 = 0x05 }
	max30102 sample averaging enumeration definition More...
enum	max30102_mode_t { MAX30102_MODE_HEART_RATE = 0x02 , MAX30102_MODE_SPO2 = 0x03 , MAX30102_MODE_MULTI_LED = 0x07 }
	max30102 mode enumeration definition More...
enum	max30102_interrupt_status_t { MAX30102_INTERRUPT_STATUS_FIFO_FULL = 7 , MAX30102_INTERRUPT_STATUS_PPG_RDY = 6 , MAX30102_INTERRUPT_STATUS_ALC_OVF = 5 , MAX30102_INTERRUPT_STATUS_PWR_RDY = 0 , MAX30102_INTERRUPT_STATUS_DIE_TEMP_RDY = 1 }
	max30102 interrupt status enumeration definition More...
enum	max30102_interrupt_t { MAX30102_INTERRUPT_FIFO_FULL_EN = 7 , MAX30102_INTERRUPT_PPG_RDY_EN = 6 , MAX30102_INTERRUPT_ALC_OVF_EN = 5 , MAX30102_INTERRUPT_DIE_TEMP_RDY_EN = 1 }
	max30102 interrupt enumeration definition More...
enum	max30102_spo2_adc_range_t { MAX30102_SPO2_ADC_RANGE_2048 = 0 , MAX30102_SPO2_ADC_RANGE_4096 = 1 , MAX30102_SPO2_ADC_RANGE_8192 = 2 , MAX30102_SPO2_ADC_RANGE_16384 = 3 }
	max30102 spo2 adc range enumeration definition More...
enum	max30102_spo2_sample_rate_t { MAX30102_SPO2_SAMPLE_RATE_50_HZ = 0 , MAX30102_SPO2_SAMPLE_RATE_100_HZ = 1 , MAX30102_SPO2_SAMPLE_RATE_200_HZ = 2 , MAX30102_SPO2_SAMPLE_RATE_400_HZ = 3 , MAX30102_SPO2_SAMPLE_RATE_800_HZ = 4 , MAX30102_SPO2_SAMPLE_RATE_1000_HZ = 5 , MAX30102_SPO2_SAMPLE_RATE_1600_HZ = 6 , MAX30102_SPO2_SAMPLE_RATE_3200_HZ = 7 }
	max30102 spo2 sample rate enumeration definition More...
enum	max30102_adc_resolution_t { MAX30102_ADC_RESOLUTION_15_BIT = 0 , MAX30102_ADC_RESOLUTION_16_BIT = 1 , MAX30102_ADC_RESOLUTION_17_BIT = 2 , MAX30102_ADC_RESOLUTION_18_BIT = 3 }
	max30102 adc resolution enumeration definition More...
enum	max30102_led_t { MAX30102_LED_NONE = 0 , MAX30102_LED_RED = 1 , MAX30102_LED_IR = 2 }
	max30102 led enumeration definition More...
enum	max30102_slot_t { MAX30102_SLOT_1 = 0 , MAX30102_SLOT_2 = 1 , MAX30102_SLOT_3 = 2 , MAX30102_SLOT_4 = 3 }
	max30102 slot enumeration definition More...

Functions
uint8_t	max30102_info (max30102_info_t *info)
	get chip's information
uint8_t	max30102_init (max30102_handle_t *handle)
	initialize the chip
uint8_t	max30102_deinit (max30102_handle_t *handle)
	close the chip
uint8_t	max30102_read (max30102_handle_t handle, uint32_t raw_red, uint32_t raw_ir, uint8_t len)
	read the data
uint8_t	max30102_read_temperature (max30102_handle_t handle, uint16_t raw, float *temp)
	read the temperature
uint8_t	max30102_irq_handler (max30102_handle_t *handle)
	irq handler
uint8_t	max30102_get_interrupt_status (max30102_handle_t handle, max30102_interrupt_status_t status, max30102_bool_t enable)
	get the interrupt status
uint8_t	max30102_set_interrupt (max30102_handle_t *handle, max30102_interrupt_t type, max30102_bool_t enable)
	set the interrupt bool
uint8_t	max30102_get_interrupt (max30102_handle_t handle, max30102_interrupt_t type, max30102_bool_t enable)
	get the interrupt bool
uint8_t	max30102_set_fifo_write_pointer (max30102_handle_t *handle, uint8_t pointer)
	set the fifo write pointer
uint8_t	max30102_get_fifo_write_pointer (max30102_handle_t handle, uint8_t pointer)
	get the fifo write pointer
uint8_t	max30102_set_fifo_overflow_counter (max30102_handle_t *handle, uint8_t counter)
	set the fifo overflow counter
uint8_t	max30102_get_fifo_overflow_counter (max30102_handle_t handle, uint8_t counter)
	get the fifo overflow counter
uint8_t	max30102_set_fifo_read_pointer (max30102_handle_t *handle, uint8_t pointer)
	set the fifo read pointer
uint8_t	max30102_get_fifo_read_pointer (max30102_handle_t handle, uint8_t pointer)
	get the fifo read pointer
uint8_t	max30102_set_fifo_data (max30102_handle_t *handle, uint8_t data)
	set the fifo data
uint8_t	max30102_get_fifo_data (max30102_handle_t handle, uint8_t data)
	get the fifo data
uint8_t	max30102_set_fifo_sample_averaging (max30102_handle_t *handle, max30102_sample_averaging_t sample)
	set the fifo sample averaging
uint8_t	max30102_get_fifo_sample_averaging (max30102_handle_t handle, max30102_sample_averaging_t sample)
	get the fifo sample averaging
uint8_t	max30102_set_fifo_roll (max30102_handle_t *handle, max30102_bool_t enable)
	enable or disable the fifo roll
uint8_t	max30102_get_fifo_roll (max30102_handle_t handle, max30102_bool_t enable)
	get the fifo roll status
uint8_t	max30102_set_fifo_almost_full (max30102_handle_t *handle, uint8_t value)
	set the fifo almost full value
uint8_t	max30102_get_fifo_almost_full (max30102_handle_t handle, uint8_t value)
	get the fifo almost full value
uint8_t	max30102_set_shutdown (max30102_handle_t *handle, max30102_bool_t enable)
	set the shutdown
uint8_t	max30102_get_shutdown (max30102_handle_t handle, max30102_bool_t enable)
	get the shutdown
uint8_t	max30102_reset (max30102_handle_t *handle)
	reset the chip
uint8_t	max30102_set_mode (max30102_handle_t *handle, max30102_mode_t mode)
	set the mode
uint8_t	max30102_get_mode (max30102_handle_t handle, max30102_mode_t mode)
	get the mode
uint8_t	max30102_set_spo2_adc_range (max30102_handle_t *handle, max30102_spo2_adc_range_t range)
	set the spo2 adc range
uint8_t	max30102_get_spo2_adc_range (max30102_handle_t handle, max30102_spo2_adc_range_t range)
	get the spo2 adc range
uint8_t	max30102_set_spo2_sample_rate (max30102_handle_t *handle, max30102_spo2_sample_rate_t rate)
	set the spo2 sample rate
uint8_t	max30102_get_spo2_sample_rate (max30102_handle_t handle, max30102_spo2_sample_rate_t rate)
	get the spo2 sample rate
uint8_t	max30102_set_adc_resolution (max30102_handle_t *handle, max30102_adc_resolution_t resolution)
	set the adc resolution
uint8_t	max30102_get_adc_resolution (max30102_handle_t handle, max30102_adc_resolution_t resolution)
	get the adc resolution
uint8_t	max30102_set_led_red_pulse_amplitude (max30102_handle_t *handle, uint8_t amp)
	set the red led pulse amplitude
uint8_t	max30102_get_led_red_pulse_amplitude (max30102_handle_t handle, uint8_t amp)
	get the red led pulse amplitude
uint8_t	max30102_set_led_ir_pulse_amplitude (max30102_handle_t *handle, uint8_t amp)
	set the ir led pulse amplitude
uint8_t	max30102_get_led_ir_pulse_amplitude (max30102_handle_t handle, uint8_t amp)
	get the ir led pulse amplitude
uint8_t	max30102_set_slot (max30102_handle_t *handle, max30102_slot_t slot, max30102_led_t led)
	set the led slot
uint8_t	max30102_get_slot (max30102_handle_t handle, max30102_slot_t slot, max30102_led_t led)
	get the led slot
uint8_t	max30102_set_die_temperature (max30102_handle_t *handle, max30102_bool_t enable)
	enable or disable die temperature
uint8_t	max30102_get_die_temperature (max30102_handle_t handle, max30102_bool_t enable)
	get the die temperature status
uint8_t	max30102_get_id (max30102_handle_t handle, uint8_t revision_id, uint8_t *part_id)
	get the chip id
uint8_t	max30102_set_reg (max30102_handle_t handle, uint8_t reg, uint8_t buf, uint16_t len)
	set the chip register
uint8_t	max30102_get_reg (max30102_handle_t handle, uint8_t reg, uint8_t buf, uint16_t len)
	get the chip register

Detailed Description

driver max30102 header file

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version: 1.0.0

Author: Shifeng Li

Date: 2021-11-13

history

Date	Version	Author	Description
2021/11/13	1.0	Shifeng Li	first upload

Definition in file driver_max30102.h.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

history