driver max30105 header file More...

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

Include dependency graph for driver_max30105.h:

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

Data Structures
struct	max30105_handle_s
	max30105 handle structure definition More...
struct	max30105_info_s
	max30105 information structure definition More...

Macros
#define	DRIVER_MAX30105_LINK_INIT(HANDLE, STRUCTURE)
	initialize max30105_handle_t structure
#define	DRIVER_MAX30105_LINK_IIC_INIT(HANDLE, FUC)
	link iic_init function
#define	DRIVER_MAX30105_LINK_IIC_DEINIT(HANDLE, FUC)
	link iic_deinit function
#define	DRIVER_MAX30105_LINK_IIC_READ(HANDLE, FUC)
	link iic_read function
#define	DRIVER_MAX30105_LINK_IIC_WRITE(HANDLE, FUC)
	link iic_write function
#define	DRIVER_MAX30105_LINK_DELAY_MS(HANDLE, FUC)
	link delay_ms function
#define	DRIVER_MAX30105_LINK_DEBUG_PRINT(HANDLE, FUC)
	link debug_print function
#define	DRIVER_MAX30105_LINK_RECEIVE_CALLBACK(HANDLE, FUC)
	link receive_callback function

Typedefs
typedef struct max30105_handle_s	max30105_handle_t
	max30105 handle structure definition
typedef struct max30105_info_s	max30105_info_t
	max30105 information structure definition

Enumerations
enum	max30105_bool_t { MAX30105_BOOL_FALSE = 0x00 , MAX30105_BOOL_TRUE = 0x01 }
	max30105 bool enumeration definition More...
enum	max30105_sample_averaging_t { MAX30105_SAMPLE_AVERAGING_1 = 0x00 , MAX30105_SAMPLE_AVERAGING_2 = 0x01 , MAX30105_SAMPLE_AVERAGING_4 = 0x02 , MAX30105_SAMPLE_AVERAGING_8 = 0x03 , MAX30105_SAMPLE_AVERAGING_16 = 0x04 , MAX30105_SAMPLE_AVERAGING_32 = 0x05 }
	max30105 sample averaging enumeration definition More...
enum	max30105_mode_t { MAX30105_MODE_RED = 0x02 , MAX30105_MODE_RED_IR = 0x03 , MAX30105_MODE_GREEN_RED_IR = 0x07 }
	max30105 mode enumeration definition More...
enum	max30105_interrupt_status_t { MAX30105_INTERRUPT_STATUS_FIFO_FULL = 7 , MAX30105_INTERRUPT_STATUS_DATA_RDY = 6 , MAX30105_INTERRUPT_STATUS_ALC_OVF = 5 , MAX30105_INTERRUPT_STATUS_PROX_INT = 4 , MAX30105_INTERRUPT_STATUS_PWR_RDY = 0 , MAX30105_INTERRUPT_STATUS_DIE_TEMP_RDY = 1 }
	max30105 interrupt status enumeration definition More...
enum	max30105_interrupt_t { MAX30105_INTERRUPT_FIFO_FULL_EN = 7 , MAX30105_INTERRUPT_DATA_RDY_EN = 6 , MAX30105_INTERRUPT_ALC_OVF_EN = 5 , MAX30105_INTERRUPT_PROX_INT_EN = 4 , MAX30105_INTERRUPT_DIE_TEMP_RDY_EN = 1 }
	max30105 interrupt enumeration definition More...
enum	max30105_particle_sensing_adc_range_t { MAX30105_PARTICLE_SENSING_ADC_RANGE_2048 = 0 , MAX30105_PARTICLE_SENSING_ADC_RANGE_4096 = 1 , MAX30105_PARTICLE_SENSING_ADC_RANGE_8192 = 2 , MAX30105_PARTICLE_SENSING_ADC_RANGE_16384 = 3 }
	max30105 particle sensing adc range enumeration definition More...
enum	max30105_particle_sensing_sample_rate_t { MAX30105_PARTICLE_SENSING_SAMPLE_RATE_50_HZ = 0 , MAX30105_PARTICLE_SENSING_SAMPLE_RATE_100_HZ = 1 , MAX30105_PARTICLE_SENSING_SAMPLE_RATE_200_HZ = 2 , MAX30105_PARTICLE_SENSING_SAMPLE_RATE_400_HZ = 3 , MAX30105_PARTICLE_SENSING_SAMPLE_RATE_800_HZ = 4 , MAX30105_PARTICLE_SENSING_SAMPLE_RATE_1000_HZ = 5 , MAX30105_PARTICLE_SENSING_SAMPLE_RATE_1600_HZ = 6 , MAX30105_PARTICLE_SENSING_SAMPLE_RATE_3200_HZ = 7 }
	max30105 particle sensing sample rate enumeration definition More...
enum	max30105_adc_resolution_t { MAX30105_ADC_RESOLUTION_15_BIT = 0 , MAX30105_ADC_RESOLUTION_16_BIT = 1 , MAX30105_ADC_RESOLUTION_17_BIT = 2 , MAX30105_ADC_RESOLUTION_18_BIT = 3 }
	max30105 adc resolution enumeration definition More...
enum	max30105_led_t { MAX30105_LED_NONE = 0 , MAX30105_LED_RED_LED1_PA = 1 , MAX30105_LED_IR_LED2_PA = 2 , MAX30105_LED_GREEN_LED3_PA = 3 , MAX30105_LED_RED_PILOT_PA = 5 , MAX30105_LED_IR_PILOT_PA = 6 , MAX30105_LED_GREEN_PILOT_PA = 7 }
	max30105 led enumeration definition More...
enum	max30105_slot_t { MAX30105_SLOT_1 = 0 , MAX30105_SLOT_2 = 1 , MAX30105_SLOT_3 = 2 , MAX30105_SLOT_4 = 3 }
	max30105 slot enumeration definition More...

Functions
uint8_t	max30105_info (max30105_info_t *info)
	get chip's information
uint8_t	max30105_irq_handler (max30105_handle_t *handle)
	irq handler
uint8_t	max30105_init (max30105_handle_t *handle)
	initialize the chip
uint8_t	max30105_deinit (max30105_handle_t *handle)
	close the chip
uint8_t	max30105_read (max30105_handle_t handle, uint32_t raw_red, uint32_t raw_ir, uint32_t raw_green, uint8_t *len)
	read the data
uint8_t	max30105_read_temperature (max30105_handle_t handle, uint16_t raw, float *temp)
	read the temperature
uint8_t	max30105_get_interrupt_status (max30105_handle_t handle, max30105_interrupt_status_t status, max30105_bool_t enable)
	get the interrupt status
uint8_t	max30105_set_interrupt (max30105_handle_t *handle, max30105_interrupt_t type, max30105_bool_t enable)
	set the interrupt bool
uint8_t	max30105_get_interrupt (max30105_handle_t handle, max30105_interrupt_t type, max30105_bool_t enable)
	get the interrupt bool
uint8_t	max30105_set_fifo_write_pointer (max30105_handle_t *handle, uint8_t pointer)
	set the fifo write pointer
uint8_t	max30105_get_fifo_write_pointer (max30105_handle_t handle, uint8_t pointer)
	get the fifo write pointer
uint8_t	max30105_set_fifo_overflow_counter (max30105_handle_t *handle, uint8_t counter)
	set the fifo overflow counter
uint8_t	max30105_get_fifo_overflow_counter (max30105_handle_t handle, uint8_t counter)
	get the fifo overflow counter
uint8_t	max30105_set_fifo_read_pointer (max30105_handle_t *handle, uint8_t pointer)
	set the fifo read pointer
uint8_t	max30105_get_fifo_read_pointer (max30105_handle_t handle, uint8_t pointer)
	get the fifo read pointer
uint8_t	max30105_set_fifo_data (max30105_handle_t *handle, uint8_t data)
	set the fifo data
uint8_t	max30105_get_fifo_data (max30105_handle_t handle, uint8_t data)
	get the fifo data
uint8_t	max30105_set_fifo_sample_averaging (max30105_handle_t *handle, max30105_sample_averaging_t sample)
	set the fifo sample averaging
uint8_t	max30105_get_fifo_sample_averaging (max30105_handle_t handle, max30105_sample_averaging_t sample)
	get the fifo sample averaging
uint8_t	max30105_set_fifo_roll (max30105_handle_t *handle, max30105_bool_t enable)
	enable or disable the fifo roll
uint8_t	max30105_get_fifo_roll (max30105_handle_t handle, max30105_bool_t enable)
	get the fifo roll status
uint8_t	max30105_set_fifo_almost_full (max30105_handle_t *handle, uint8_t value)
	set the fifo almost full value
uint8_t	max30105_get_fifo_almost_full (max30105_handle_t handle, uint8_t value)
	get the fifo almost full value
uint8_t	max30105_set_shutdown (max30105_handle_t *handle, max30105_bool_t enable)
	set the shutdown
uint8_t	max30105_get_shutdown (max30105_handle_t handle, max30105_bool_t enable)
	get the shutdown
uint8_t	max30105_reset (max30105_handle_t *handle)
	reset the chip
uint8_t	max30105_set_mode (max30105_handle_t *handle, max30105_mode_t mode)
	set the mode
uint8_t	max30105_get_mode (max30105_handle_t handle, max30105_mode_t mode)
	get the mode
uint8_t	max30105_set_particle_sensing_adc_range (max30105_handle_t *handle, max30105_particle_sensing_adc_range_t range)
	set the particle sensing adc range
uint8_t	max30105_get_particle_sensing_adc_range (max30105_handle_t handle, max30105_particle_sensing_adc_range_t range)
	get the particle sensing adc range
uint8_t	max30105_set_particle_sensing_sample_rate (max30105_handle_t *handle, max30105_particle_sensing_sample_rate_t rate)
	set the particle sensing sample rate
uint8_t	max30105_get_particle_sensing_sample_rate (max30105_handle_t handle, max30105_particle_sensing_sample_rate_t rate)
	get the particle sensing sample rate
uint8_t	max30105_set_adc_resolution (max30105_handle_t *handle, max30105_adc_resolution_t resolution)
	set the adc resolution
uint8_t	max30105_get_adc_resolution (max30105_handle_t handle, max30105_adc_resolution_t resolution)
	get the adc resolution
uint8_t	max30105_set_led_red_pulse_amplitude (max30105_handle_t *handle, uint8_t amp)
	set the red led pulse amplitude
uint8_t	max30105_get_led_red_pulse_amplitude (max30105_handle_t handle, uint8_t amp)
	get the red led pulse amplitude
uint8_t	max30105_set_led_ir_pulse_amplitude (max30105_handle_t *handle, uint8_t amp)
	set the ir led pulse amplitude
uint8_t	max30105_get_led_ir_pulse_amplitude (max30105_handle_t handle, uint8_t amp)
	get the ir led pulse amplitude
uint8_t	max30105_set_led_green_pulse_amplitude (max30105_handle_t *handle, uint8_t amp)
	set the green led pulse amplitude
uint8_t	max30105_get_led_green_pulse_amplitude (max30105_handle_t handle, uint8_t amp)
	get the green led pulse amplitude
uint8_t	max30105_set_led_proximity_pulse_amplitude (max30105_handle_t *handle, uint8_t amp)
	set the proximity led pulse amplitude
uint8_t	max30105_get_led_proximity_pulse_amplitude (max30105_handle_t handle, uint8_t amp)
	get the proximity led pulse amplitude
uint8_t	max30105_set_slot (max30105_handle_t *handle, max30105_slot_t slot, max30105_led_t led)
	set the led slot
uint8_t	max30105_get_slot (max30105_handle_t handle, max30105_slot_t slot, max30105_led_t led)
	get the led slot
uint8_t	max30105_set_die_temperature (max30105_handle_t *handle, max30105_bool_t enable)
	enable or disable die temperature
uint8_t	max30105_get_die_temperature (max30105_handle_t handle, max30105_bool_t enable)
	get the die temperature status
uint8_t	max30105_set_proximity_interrupt_threshold (max30105_handle_t *handle, uint8_t threshold)
	set the proximity interrupt threshold
uint8_t	max30105_get_proximity_interrupt_threshold (max30105_handle_t handle, uint8_t threshold)
	get the proximity interrupt threshold
uint8_t	max30105_proximity_threshold_convert_to_register (max30105_handle_t handle, uint32_t adc, uint8_t reg)
	convert the proximity threshold to the register raw data
uint8_t	max30105_proximity_threshold_convert_to_data (max30105_handle_t handle, uint8_t reg, uint32_t adc)
	convert the register raw data to the proximity threshold
uint8_t	max30105_get_id (max30105_handle_t handle, uint8_t revision_id, uint8_t *part_id)
	get the chip id
uint8_t	max30105_set_reg (max30105_handle_t handle, uint8_t reg, uint8_t buf, uint16_t len)
	set the chip register
uint8_t	max30105_get_reg (max30105_handle_t handle, uint8_t reg, uint8_t buf, uint16_t len)
	get the chip register

Detailed Description

driver max30105 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: 2022-01-01

history

Date	Version	Author	Description
2022/01/01	1.0	Shifeng Li	first upload

Definition in file driver_max30105.h.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

history