LibDriver MAX30102
Loading...
Searching...
No Matches
driver_max30102.c File Reference

driver max30102 source file More...

#include "driver_max30102.h"
Include dependency graph for driver_max30102.c:

Go to the source code of this file.

Macros

#define CHIP_NAME   "Maxim Integrated MAX30102"
 chip information definition
#define MANUFACTURER_NAME   "Maxim Integrated"
#define SUPPLY_VOLTAGE_MIN   1.7f
#define SUPPLY_VOLTAGE_MAX   2.0f
#define MAX_CURRENT   20.0f
#define TEMPERATURE_MIN   -40.0f
#define TEMPERATURE_MAX   85.0f
#define DRIVER_VERSION   1000
#define MAX30102_ADDRESS   0xAE
 iic address definition
#define MAX30102_REG_INTERRUPT_STATUS_1   0x00
 chip register definition
#define MAX30102_REG_INTERRUPT_STATUS_2   0x01
#define MAX30102_REG_INTERRUPT_ENABLE_1   0x02
#define MAX30102_REG_INTERRUPT_ENABLE_2   0x03
#define MAX30102_REG_FIFO_WRITE_POINTER   0x04
#define MAX30102_REG_OVERFLOW_COUNTER   0x05
#define MAX30102_REG_FIFO_READ_POINTER   0x06
#define MAX30102_REG_FIFO_DATA_REGISTER   0x07
#define MAX30102_REG_FIFO_CONFIG   0x08
#define MAX30102_REG_MODE_CONFIG   0x09
#define MAX30102_REG_SPO2_CONFIG   0x0A
#define MAX30102_REG_LED_PULSE_1   0x0C
#define MAX30102_REG_LED_PULSE_2   0x0D
#define MAX30102_REG_MULTI_LED_MODE_CONTROL_1   0x11
#define MAX30102_REG_MULTI_LED_MODE_CONTROL_2   0x12
#define MAX30102_REG_DIE_TEMP_INTEGER   0x1F
#define MAX30102_REG_DIE_TEMP_FRACTION   0x20
#define MAX30102_REG_DIE_TEMP_CONFIG   0x21
#define MAX30102_REG_REVISION_ID   0xFE
#define MAX30102_REG_PART_ID   0xFF

Functions

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_irq_handler (max30102_handle_t *handle)
 irq handler
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_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
uint8_t max30102_info (max30102_info_t *info)
 get chip's information

Detailed Description

driver max30102 source file

Copyright (c) 2015 - present LibDriver All rights reserved

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.c.

Macro Definition Documentation

◆ CHIP_NAME

#define CHIP_NAME   "Maxim Integrated MAX30102"

chip information definition

chip name

Definition at line 42 of file driver_max30102.c.

◆ DRIVER_VERSION

#define DRIVER_VERSION   1000

driver version

Definition at line 49 of file driver_max30102.c.

◆ MANUFACTURER_NAME

#define MANUFACTURER_NAME   "Maxim Integrated"

manufacturer name

Definition at line 43 of file driver_max30102.c.

◆ MAX30102_ADDRESS

#define MAX30102_ADDRESS   0xAE

iic address definition

iic address

Definition at line 54 of file driver_max30102.c.

◆ MAX30102_REG_DIE_TEMP_CONFIG

#define MAX30102_REG_DIE_TEMP_CONFIG   0x21

die temperature config register

Definition at line 76 of file driver_max30102.c.

◆ MAX30102_REG_DIE_TEMP_FRACTION

#define MAX30102_REG_DIE_TEMP_FRACTION   0x20

die temperature fraction register

Definition at line 75 of file driver_max30102.c.

◆ MAX30102_REG_DIE_TEMP_INTEGER

#define MAX30102_REG_DIE_TEMP_INTEGER   0x1F

die temperature integer register

Definition at line 74 of file driver_max30102.c.

◆ MAX30102_REG_FIFO_CONFIG

#define MAX30102_REG_FIFO_CONFIG   0x08

fifo config register

Definition at line 67 of file driver_max30102.c.

◆ MAX30102_REG_FIFO_DATA_REGISTER

#define MAX30102_REG_FIFO_DATA_REGISTER   0x07

fifo data register

Definition at line 66 of file driver_max30102.c.

◆ MAX30102_REG_FIFO_READ_POINTER

#define MAX30102_REG_FIFO_READ_POINTER   0x06

fifo read pointer register

Definition at line 65 of file driver_max30102.c.

◆ MAX30102_REG_FIFO_WRITE_POINTER

#define MAX30102_REG_FIFO_WRITE_POINTER   0x04

fifo write pointer register

Definition at line 63 of file driver_max30102.c.

◆ MAX30102_REG_INTERRUPT_ENABLE_1

#define MAX30102_REG_INTERRUPT_ENABLE_1   0x02

interrupt enable 1 register

Definition at line 61 of file driver_max30102.c.

◆ MAX30102_REG_INTERRUPT_ENABLE_2

#define MAX30102_REG_INTERRUPT_ENABLE_2   0x03

interrupt enable 2 register

Definition at line 62 of file driver_max30102.c.

◆ MAX30102_REG_INTERRUPT_STATUS_1

#define MAX30102_REG_INTERRUPT_STATUS_1   0x00

chip register definition

interrupt status 1 register

Definition at line 59 of file driver_max30102.c.

◆ MAX30102_REG_INTERRUPT_STATUS_2

#define MAX30102_REG_INTERRUPT_STATUS_2   0x01

interrupt status 2 register

Definition at line 60 of file driver_max30102.c.

◆ MAX30102_REG_LED_PULSE_1

#define MAX30102_REG_LED_PULSE_1   0x0C

led pulse amplitude 1 register

Definition at line 70 of file driver_max30102.c.

◆ MAX30102_REG_LED_PULSE_2

#define MAX30102_REG_LED_PULSE_2   0x0D

led pulse amplitude 2 register

Definition at line 71 of file driver_max30102.c.

◆ MAX30102_REG_MODE_CONFIG

#define MAX30102_REG_MODE_CONFIG   0x09

mode config register

Definition at line 68 of file driver_max30102.c.

◆ MAX30102_REG_MULTI_LED_MODE_CONTROL_1

#define MAX30102_REG_MULTI_LED_MODE_CONTROL_1   0x11

multi led mode control 1 register

Definition at line 72 of file driver_max30102.c.

◆ MAX30102_REG_MULTI_LED_MODE_CONTROL_2

#define MAX30102_REG_MULTI_LED_MODE_CONTROL_2   0x12

multi led mode control 2 register

Definition at line 73 of file driver_max30102.c.

◆ MAX30102_REG_OVERFLOW_COUNTER

#define MAX30102_REG_OVERFLOW_COUNTER   0x05

overflow counter register

Definition at line 64 of file driver_max30102.c.

◆ MAX30102_REG_PART_ID

#define MAX30102_REG_PART_ID   0xFF

part id register

Definition at line 78 of file driver_max30102.c.

◆ MAX30102_REG_REVISION_ID

#define MAX30102_REG_REVISION_ID   0xFE

revision id register

Definition at line 77 of file driver_max30102.c.

◆ MAX30102_REG_SPO2_CONFIG

#define MAX30102_REG_SPO2_CONFIG   0x0A

spo2 config register

Definition at line 69 of file driver_max30102.c.

◆ MAX_CURRENT

#define MAX_CURRENT   20.0f

chip max current

Definition at line 46 of file driver_max30102.c.

◆ SUPPLY_VOLTAGE_MAX

#define SUPPLY_VOLTAGE_MAX   2.0f

chip max supply voltage

Definition at line 45 of file driver_max30102.c.

◆ SUPPLY_VOLTAGE_MIN

#define SUPPLY_VOLTAGE_MIN   1.7f

chip min supply voltage

Definition at line 44 of file driver_max30102.c.

◆ TEMPERATURE_MAX

#define TEMPERATURE_MAX   85.0f

chip max operating temperature

Definition at line 48 of file driver_max30102.c.

◆ TEMPERATURE_MIN

#define TEMPERATURE_MIN   -40.0f

chip min operating temperature

Definition at line 47 of file driver_max30102.c.