LibDriver MAX30205
Loading...
Searching...
No Matches
max30205 interrupt driver function
max30205 driver function

max30205 interrupt driver modules More...

Collaboration diagram for max30205 interrupt driver function:

Enumerations

enum  max30205_interrupt_mode_t { MAX30205_INTERRUPT_MODE_COMPARATOR = 0x00 , MAX30205_INTERRUPT_MODE_INTERRUPT = 0x01 }
 max30205 interrupt mode enumeration definition More...
enum  max30205_fault_queue_t { MAX30205_FAULT_QUEUE_1 = 0x00 , MAX30205_FAULT_QUEUE_2 = 0x01 , MAX30205_FAULT_QUEUE_4 = 0x02 , MAX30205_FAULT_QUEUE_6 = 0x03 }
 max30205 fault queue enumeration definition More...
enum  max30205_pin_polarity_t { MAX30205_PIN_POLARITY_LOW = 0x00 , MAX30205_PIN_POLARITY_HIGH = 0x01 }
 max30205 pin enumeration definition More...

Functions

uint8_t max30205_set_interrupt_mode (max30205_handle_t *handle, max30205_interrupt_mode_t mode)
 set the chip interrupt mode
uint8_t max30205_get_interrupt_mode (max30205_handle_t *handle, max30205_interrupt_mode_t *mode)
 get the chip interrupt mode
uint8_t max30205_set_fault_queue (max30205_handle_t *handle, max30205_fault_queue_t fault_queue)
 set the chip fault queue
uint8_t max30205_get_fault_queue (max30205_handle_t *handle, max30205_fault_queue_t *fault_queue)
 get the chip fault queue
uint8_t max30205_set_pin_polarity (max30205_handle_t *handle, max30205_pin_polarity_t polarity)
 set the interrupt pin polarity
uint8_t max30205_get_pin_polarity (max30205_handle_t *handle, max30205_pin_polarity_t *polarity)
 get the interrupt pin polarity
uint8_t max30205_set_interrupt_low_threshold (max30205_handle_t *handle, int16_t threshold)
 set the chip interrupt low threshold
uint8_t max30205_get_interrupt_low_threshold (max30205_handle_t *handle, int16_t *threshold)
 get the chip interrupt low threshold
uint8_t max30205_set_interrupt_high_threshold (max30205_handle_t *handle, int16_t threshold)
 set the chip interrupt high threshold
uint8_t max30205_get_interrupt_high_threshold (max30205_handle_t *handle, int16_t *threshold)
 get the chip interrupt high threshold
uint8_t max30205_convert_to_register (max30205_handle_t *handle, float s, int16_t *reg)
 convert a temperature value to a register raw data
uint8_t max30205_convert_to_data (max30205_handle_t *handle, int16_t reg, float *s)
 convert a register raw data to a converted temperature data

Detailed Description

max30205 interrupt driver modules

Enumeration Type Documentation

◆ max30205_fault_queue_t

enum max30205_fault_queue_t

max30205 fault queue enumeration definition

Enumerator
MAX30205_FAULT_QUEUE_1 

fault queue 1

MAX30205_FAULT_QUEUE_2 

fault queue 2

MAX30205_FAULT_QUEUE_4 

fault queue 4

MAX30205_FAULT_QUEUE_6 

fault queue 6

Definition at line 138 of file driver_max30205.h.

◆ max30205_interrupt_mode_t

enum max30205_interrupt_mode_t

max30205 interrupt mode enumeration definition

Enumerator
MAX30205_INTERRUPT_MODE_COMPARATOR 

comparator mode

MAX30205_INTERRUPT_MODE_INTERRUPT 

interrupt mode

Definition at line 129 of file driver_max30205.h.

◆ max30205_pin_polarity_t

enum max30205_pin_polarity_t

max30205 pin enumeration definition

Enumerator
MAX30205_PIN_POLARITY_LOW 

polarity low

MAX30205_PIN_POLARITY_HIGH 

polarity high

Definition at line 149 of file driver_max30205.h.

Function Documentation

◆ max30205_convert_to_data()

uint8_t max30205_convert_to_data ( max30205_handle_t * handle,
int16_t reg,
float * s )

convert a register raw data to a converted temperature data

Parameters
[in]*handlepointer to a max30205 handle structure
[in]regregister raw data
[out]*spointer to a converted temperature value buffer
Returns
status code
  • 0 success
  • 1 convert to data failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 896 of file driver_max30205.c.

◆ max30205_convert_to_register()

uint8_t max30205_convert_to_register ( max30205_handle_t * handle,
float s,
int16_t * reg )

convert a temperature value to a register raw data

Parameters
[in]*handlepointer to a max30205 handle structure
[in]sconverted temperature value
[out]*regpointer to a register raw buffer
Returns
status code
  • 0 success
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 861 of file driver_max30205.c.

◆ max30205_get_fault_queue()

uint8_t max30205_get_fault_queue ( max30205_handle_t * handle,
max30205_fault_queue_t * fault_queue )

get the chip fault queue

Parameters
[in]*handlepointer to a max30205 handle structure
[out]*fault_queuepointer to a fault queue buffer
Returns
status code
  • 0 success
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 376 of file driver_max30205.c.

◆ max30205_get_interrupt_high_threshold()

uint8_t max30205_get_interrupt_high_threshold ( max30205_handle_t * handle,
int16_t * threshold )

get the chip interrupt high threshold

Parameters
[in]*handlepointer to a max30205 handle structure
[out]*thresholdpointer to an interrupt high threshold buffer
Returns
status code
  • 0 success
  • 1 get interrupt high threshold failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 825 of file driver_max30205.c.

◆ max30205_get_interrupt_low_threshold()

uint8_t max30205_get_interrupt_low_threshold ( max30205_handle_t * handle,
int16_t * threshold )

get the chip interrupt low threshold

Parameters
[in]*handlepointer to a max30205 handle structure
[out]*thresholdpointer to an interrupt low threshold buffer
Returns
status code
  • 0 success
  • 1 get interrupt low threshold failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 751 of file driver_max30205.c.

◆ max30205_get_interrupt_mode()

uint8_t max30205_get_interrupt_mode ( max30205_handle_t * handle,
max30205_interrupt_mode_t * mode )

get the chip interrupt mode

Parameters
[in]*handlepointer to a max30205 handle structure
[out]*modepointer to an interrupt mode buffer
Returns
status code
  • 0 success
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 315 of file driver_max30205.c.

◆ max30205_get_pin_polarity()

uint8_t max30205_get_pin_polarity ( max30205_handle_t * handle,
max30205_pin_polarity_t * polarity )

get the interrupt pin polarity

Parameters
[in]*handlepointer to a max30205 handle structure
[out]*polaritypointer to an interrupt pin polarity buffer
Returns
status code
  • 0 success
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 435 of file driver_max30205.c.

◆ max30205_set_fault_queue()

uint8_t max30205_set_fault_queue ( max30205_handle_t * handle,
max30205_fault_queue_t fault_queue )

set the chip fault queue

Parameters
[in]*handlepointer to a max30205 handle structure
[in]fault_queuefault queue
Returns
status code
  • 0 success
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 348 of file driver_max30205.c.

◆ max30205_set_interrupt_high_threshold()

uint8_t max30205_set_interrupt_high_threshold ( max30205_handle_t * handle,
int16_t threshold )

set the chip interrupt high threshold

Parameters
[in]*handlepointer to a max30205 handle structure
[in]thresholdinterrupt high threshold
Returns
status code
  • 0 success
  • 1 set interrupt high threshold failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 787 of file driver_max30205.c.

◆ max30205_set_interrupt_low_threshold()

uint8_t max30205_set_interrupt_low_threshold ( max30205_handle_t * handle,
int16_t threshold )

set the chip interrupt low threshold

Parameters
[in]*handlepointer to a max30205 handle structure
[in]thresholdinterrupt low threshold
Returns
status code
  • 0 success
  • 1 set interrupt low threshold failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 713 of file driver_max30205.c.

◆ max30205_set_interrupt_mode()

uint8_t max30205_set_interrupt_mode ( max30205_handle_t * handle,
max30205_interrupt_mode_t mode )

set the chip interrupt mode

Parameters
[in]*handlepointer to a max30205 handle structure
[in]modeinterrupt mode
Returns
status code
  • 0 success
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 282 of file driver_max30205.c.

◆ max30205_set_pin_polarity()

uint8_t max30205_set_pin_polarity ( max30205_handle_t * handle,
max30205_pin_polarity_t polarity )

set the interrupt pin polarity

Parameters
[in]*handlepointer to a max30205 handle structure
[in]polarityinterrupt pin polarity
Returns
status code
  • 0 success
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 402 of file driver_max30205.c.