max30009.h File Reference

Header file for extended sensor API of MAX30009 sensor. More...

#include <zephyr/drivers/sensor.h>

Go to the source code of this file.

Enumerations
enum	max30009_sensor_channel { SENSOR_CHAN_BIOZ_I = SENSOR_CHAN_PRIV_START , SENSOR_CHAN_BIOZ_Q }
	MAX30009-specific sensor channels. More...
enum	sensor_trigger_max30009 {   SENSOR_TRIG_MAX30009_DC_LOFF_NL = SENSOR_TRIG_PRIV_START , SENSOR_TRIG_MAX30009_DC_LOFF_NH , SENSOR_TRIG_MAX30009_DC_LOFF_PL , SENSOR_TRIG_MAX30009_DC_LOFF_PH ,   SENSOR_TRIG_MAX30009_DRV_OOR , SENSOR_TRIG_MAX30009_BIOZ_UNDR , SENSOR_TRIG_MAX30009_BIOZ_OVER , SENSOR_TRIG_MAX30009_LON }
	MAX30009-specific sensor triggers. More...
enum	sensor_attribute_max30009 {   SENSOR_ATTR_MAX30009_DRV_MODE = SENSOR_ATTR_PRIV_START , SENSOR_ATTR_MAX30009_IDRV_RGE , SENSOR_ATTR_MAX30009_VDRV_MAG , SENSOR_ATTR_MAX30009_GAIN ,   SENSOR_ATTR_MAX30009_AHPF , SENSOR_ATTR_MAX30009_DHPF , SENSOR_ATTR_MAX30009_DLPF , SENSOR_ATTR_MAX30009_AMP_RGE ,   SENSOR_ATTR_MAX30009_AMP_BW , SENSOR_ATTR_MAX30009_CMP , SENSOR_ATTR_MAX30009_ADC_OSR , SENSOR_ATTR_MAX30009_DAC_OSR ,   SENSOR_ATTR_MAX30009_HIGH_THRESHOLD , SENSOR_ATTR_MAX30009_LOW_THRESHOLD , SENSOR_ATTR_MAX30009_I_EN , SENSOR_ATTR_MAX30009_Q_EN ,   SENSOR_ATTR_MAX30009_BG_EN }
	MAX30009-specific sensor attributes. More...

Detailed Description

Header file for extended sensor API of MAX30009 sensor.

Enumeration Type Documentation

max30009_sensor_channel

enum max30009_sensor_channel

MAX30009-specific sensor channels.

These channels extend the standard sensor_channel enum to expose the MAX30009 BioZ in-phase and quadrature data.

Enumerator
SENSOR_CHAN_BIOZ_I	BioZ in-phase (I) channel.
SENSOR_CHAN_BIOZ_Q	BioZ quadrature (Q) channel.

sensor_attribute_max30009

enum sensor_attribute_max30009

MAX30009-specific sensor attributes.

These attributes extend the standard sensor_attribute enum to support MAX30009-specific BioZ configuration options.

Enumerator
SENSOR_ATTR_MAX30009_DRV_MODE	BioZ transmit drive mode (BIOZ_DRV_MODE).
SENSOR_ATTR_MAX30009_IDRV_RGE	BioZ internal current-range resistor (BIOZ_IDRV_RGE).
SENSOR_ATTR_MAX30009_VDRV_MAG	BioZ voltage-drive magnitude (BIOZ_VDRV_MAG).
SENSOR_ATTR_MAX30009_GAIN	BioZ receive-channel gain (BIOZ_GAIN).
SENSOR_ATTR_MAX30009_AHPF	BioZ analog high-pass filter selection (BIOZ_AHPF).
SENSOR_ATTR_MAX30009_DHPF	BioZ digital high-pass filter cutoff (BIOZ_DHPF).
SENSOR_ATTR_MAX30009_DLPF	BioZ digital low-pass filter cutoff (BIOZ_DLPF).
SENSOR_ATTR_MAX30009_AMP_RGE	BioZ amplifier range (BIOZ_AMP_RGE).
SENSOR_ATTR_MAX30009_AMP_BW	BioZ amplifier bandwidth (BIOZ_AMP_BW).
SENSOR_ATTR_MAX30009_CMP	BioZ threshold comparator channel (BIOZ_CMP).
SENSOR_ATTR_MAX30009_ADC_OSR	BioZ ADC oversampling ratio, natural units 8..1024 (BIOZ_ADC_OSR).
SENSOR_ATTR_MAX30009_DAC_OSR	BioZ DAC oversampling ratio, natural units 32..256 (BIOZ_DAC_OSR).
SENSOR_ATTR_MAX30009_HIGH_THRESHOLD	BioZ high threshold (BIOZ_HIGH_THRESHOLD).
SENSOR_ATTR_MAX30009_LOW_THRESHOLD	BioZ low threshold (BIOZ_LOW_THRESHOLD).
SENSOR_ATTR_MAX30009_I_EN	Enable BioZ in-phase (I) channel (BIOZ_I_EN).
SENSOR_ATTR_MAX30009_Q_EN	Enable BioZ quadrature (Q) channel (BIOZ_Q_EN).
SENSOR_ATTR_MAX30009_BG_EN	Enable BioZ bandgap bias (BIOZ_BG_EN).

sensor_trigger_max30009

enum sensor_trigger_max30009

MAX30009-specific sensor triggers.

These triggers extend the standard sensor_trigger_type enum to support the MAX30009 DC lead-off and range status events.

Enumerator
SENSOR_TRIG_MAX30009_DC_LOFF_NL	DC lead-off: BIOZN (BIN) voltage is below the low threshold.
SENSOR_TRIG_MAX30009_DC_LOFF_NH	DC lead-off: BIOZN (BIN) voltage is above the high threshold.
SENSOR_TRIG_MAX30009_DC_LOFF_PL	DC lead-off: BIOZP (BIP) voltage is below the low threshold.
SENSOR_TRIG_MAX30009_DC_LOFF_PH	DC lead-off: BIOZP (BIP) voltage is above the high threshold.
SENSOR_TRIG_MAX30009_DRV_OOR	BioZ current generator out of range (DRVN peaks out of compliance, leads off).
SENSOR_TRIG_MAX30009_BIOZ_UNDR	BioZ under range: absolute BioZ ADC reading is below the BioZ low threshold.
SENSOR_TRIG_MAX30009_BIOZ_OVER	BioZ over range: absolute BioZ ADC reading exceeds the BioZ high threshold.
SENSOR_TRIG_MAX30009_LON	DC leads-on detected: a BioZ lead-on condition is present.