SparkFun_Bio_Sensor_Hub_Library.h File Reference

Go to the source code of this file.

Classes
struct	bioData
struct	version
struct	sensorAttr
class	SparkFun_Bio_Sensor_Hub

Enumerations
enum	READ_STATUS_BYTE_VALUE {   SUCCESS = 0x00 , ERR_UNAVAIL_CMD , ERR_UNAVAIL_FUNC , ERR_DATA_FORMAT ,   ERR_INPUT_VALUE , ERR_TRY_AGAIN , ERR_BTLDR_GENERAL = 0x80 , ERR_BTLDR_CHECKSUM ,   ERR_BTLDR_AUTH , ERR_BTLDR_INVALID_APP , ERR_UNKNOWN = 0xFF }
enum	FAMILY_REGISTER_BYTES {   HUB_STATUS = 0x00 , SET_DEVICE_MODE , READ_DEVICE_MODE , OUTPUT_MODE = 0x10 ,   READ_OUTPUT_MODE , READ_DATA_OUTPUT , READ_DATA_INPUT , WRITE_INPUT ,   WRITE_REGISTER = 0x40 , READ_REGISTER , READ_ATTRIBUTES_AFE , DUMP_REGISTERS ,   ENABLE_SENSOR , READ_SENSOR_MODE , CHANGE_ALGORITHM_CONFIG = 0x50 , READ_ALGORITHM_CONFIG ,   ENABLE_ALGORITHM , BOOTLOADER_FLASH = 0x80 , BOOTLOADER_INFO , IDENTITY = 0xFF }
enum	DEVICE_MODE_WRITE_BYTES { EXIT_BOOTLOADER = 0x00 , RESET = 0x02 , ENTER_BOOTLOADER = 0x08 }
enum	OUTPUT_MODE_WRITE_BYTE {   PAUSE = 0x00 , SENSOR_DATA , ALGO_DATA , SENSOR_AND_ALGORITHM ,   PAUSE_TWO , SENSOR_COUNTER_BYTE , ALGO_COUNTER_BYTE , SENSOR_ALGO_COUNTER }
enum	FIFO_OUTPUT_INDEX_BYTE { NUM_SAMPLES , READ_DATA }
enum	FIFO_EXTERNAL_INDEX_BYTE {   SAMPLE_SIZE , READ_INPUT_DATA , READ_SENSOR_DATA , READ_NUM_SAMPLES_INPUT ,   READ_NUM_SAMPLES_SENSOR }
enum	WRITE_REGISTER_INDEX_BYTE { WRITE_MAX30101 = 0x03 , WRITE_ACCELEROMETER }
enum	READ_REGISTER_INDEX_BYTE { READ_MAX30101 = 0x03 , READ_ACCELEROMETER }
enum	GET_AFE_INDEX_BYTE { RETRIEVE_AFE_MAX30101 = 0x03 , RETRIEVE_AFE_ACCELEROMETER }
enum	DUMP_REGISTER_INDEX_BYTE { DUMP_REGISTER_MAX30101 = 0x03 , DUMP_REGISTER_ACCELEROMETER }
enum	SENSOR_ENABLE_INDEX_BYTE { ENABLE_MAX30101 = 0x03 , ENABLE_ACCELEROMETER }
enum	READ_SENSOR_ENABLE_INDEX_BYTE { READ_ENABLE_MAX30101 = 0x03 , READ_ENABLE_ACCELEROMETER }
enum	ALGORITHM_CONFIG_INDEX_BYTE {   SET_TARG_PERC = 0x00 , SET_STEP_SIZE = 0x00 , SET_SENSITIVITY = 0x00 , SET_AVG_SAMPLES = 0x00 ,   SET_PULSE_OX_COEF = 0x02 }
enum	ALGO_AGC_WRITE_BYTE {   AGC_GAIN_ID = 0x00 , AGC_STEP_SIZE_ID , AGC_SENSITIVITY_ID , AGC_NUM_SAMP_ID ,   MAXIMFAST_COEF_ID = 0x0B }
enum	READ_ALGORITHM_INDEX_BYTE {   READ_AGC_PERCENTAGE = 0x00 , READ_AGC_STEP_SIZE = 0x00 , READ_AGC_SENSITIVITY = 0x00 , READ_AGC_NUM_SAMPLES = 0x00 ,   READ_MAX_FAST_COEF = 0x02 }
enum	READ_AGC_ALGO_WRITE_BYTE {   READ_AGC_PERC_ID = 0x00 , READ_AGC_STEP_SIZE_ID , READ_AGC_SENSITIVITY_ID , READ_AGC_NUM_SAMPLES_ID ,   READ_MAX_FAST_COEF_ID = 0x0B }
enum	ALGORITHM_MODE_ENABLE_INDEX_BYTE { ENABLE_AGC_ALGO = 0x00 , ENABLE_WHRM_ALGO = 0x02 }
enum	BOOTLOADER_FLASH_INDEX_BYTE {   SET_INIT_VECTOR_BYTES = 0x00 , SET_AUTH_BYTES , SET_NUM_PAGES , ERASE_FLASH ,   SEND_PAGE_VALUE }
enum	BOOTLOADER_INFO_INDEX_BYTE { BOOTLOADER_VERS = 0x00 , PAGE_SIZE }
enum	IDENTITY_INDEX_BYTES { READ_MCU_TYPE = 0x00 , READ_SENSOR_HUB_VERS = 0x03 , READ_ALGO_VERS = 0x07 }

Variables
const uint8_t	BIO_ADDRESS = 0x55

Enumeration Type Documentation

ALGO_AGC_WRITE_BYTE

enum ALGO_AGC_WRITE_BYTE

Enumerator
AGC_GAIN_ID
AGC_STEP_SIZE_ID
AGC_SENSITIVITY_ID
AGC_NUM_SAMP_ID
MAXIMFAST_COEF_ID

ALGORITHM_CONFIG_INDEX_BYTE

enum ALGORITHM_CONFIG_INDEX_BYTE

Enumerator
SET_TARG_PERC
SET_STEP_SIZE
SET_SENSITIVITY
SET_AVG_SAMPLES
SET_PULSE_OX_COEF

ALGORITHM_MODE_ENABLE_INDEX_BYTE

enum ALGORITHM_MODE_ENABLE_INDEX_BYTE

Enumerator
ENABLE_AGC_ALGO
ENABLE_WHRM_ALGO

BOOTLOADER_FLASH_INDEX_BYTE

enum BOOTLOADER_FLASH_INDEX_BYTE

Enumerator
SET_INIT_VECTOR_BYTES
SET_AUTH_BYTES
SET_NUM_PAGES
ERASE_FLASH
SEND_PAGE_VALUE

BOOTLOADER_INFO_INDEX_BYTE

enum BOOTLOADER_INFO_INDEX_BYTE

Enumerator
BOOTLOADER_VERS
PAGE_SIZE

DEVICE_MODE_WRITE_BYTES

enum DEVICE_MODE_WRITE_BYTES

Enumerator
EXIT_BOOTLOADER
RESET
ENTER_BOOTLOADER

DUMP_REGISTER_INDEX_BYTE

enum DUMP_REGISTER_INDEX_BYTE

Enumerator
DUMP_REGISTER_MAX30101
DUMP_REGISTER_ACCELEROMETER

FAMILY_REGISTER_BYTES

enum FAMILY_REGISTER_BYTES

Enumerator
HUB_STATUS
SET_DEVICE_MODE
READ_DEVICE_MODE
OUTPUT_MODE
READ_OUTPUT_MODE
READ_DATA_OUTPUT
READ_DATA_INPUT
WRITE_INPUT
WRITE_REGISTER
READ_REGISTER
READ_ATTRIBUTES_AFE
DUMP_REGISTERS
ENABLE_SENSOR
READ_SENSOR_MODE
CHANGE_ALGORITHM_CONFIG
READ_ALGORITHM_CONFIG
ENABLE_ALGORITHM
BOOTLOADER_FLASH
BOOTLOADER_INFO
IDENTITY

FIFO_EXTERNAL_INDEX_BYTE

enum FIFO_EXTERNAL_INDEX_BYTE

Enumerator
SAMPLE_SIZE
READ_INPUT_DATA
READ_SENSOR_DATA
READ_NUM_SAMPLES_INPUT
READ_NUM_SAMPLES_SENSOR

FIFO_OUTPUT_INDEX_BYTE

enum FIFO_OUTPUT_INDEX_BYTE

Enumerator
NUM_SAMPLES
READ_DATA

GET_AFE_INDEX_BYTE

enum GET_AFE_INDEX_BYTE

Enumerator
RETRIEVE_AFE_MAX30101
RETRIEVE_AFE_ACCELEROMETER

IDENTITY_INDEX_BYTES

enum IDENTITY_INDEX_BYTES

Enumerator
READ_MCU_TYPE
READ_SENSOR_HUB_VERS
READ_ALGO_VERS

OUTPUT_MODE_WRITE_BYTE

enum OUTPUT_MODE_WRITE_BYTE

Enumerator
PAUSE
SENSOR_DATA
ALGO_DATA
SENSOR_AND_ALGORITHM
PAUSE_TWO
SENSOR_COUNTER_BYTE
ALGO_COUNTER_BYTE
SENSOR_ALGO_COUNTER

READ_AGC_ALGO_WRITE_BYTE

enum READ_AGC_ALGO_WRITE_BYTE

Enumerator
READ_AGC_PERC_ID
READ_AGC_STEP_SIZE_ID
READ_AGC_SENSITIVITY_ID
READ_AGC_NUM_SAMPLES_ID
READ_MAX_FAST_COEF_ID

READ_ALGORITHM_INDEX_BYTE

enum READ_ALGORITHM_INDEX_BYTE

Enumerator
READ_AGC_PERCENTAGE
READ_AGC_STEP_SIZE
READ_AGC_SENSITIVITY
READ_AGC_NUM_SAMPLES
READ_MAX_FAST_COEF

READ_REGISTER_INDEX_BYTE

enum READ_REGISTER_INDEX_BYTE

Enumerator
READ_MAX30101
READ_ACCELEROMETER

READ_SENSOR_ENABLE_INDEX_BYTE

enum READ_SENSOR_ENABLE_INDEX_BYTE

Enumerator
READ_ENABLE_MAX30101
READ_ENABLE_ACCELEROMETER

READ_STATUS_BYTE_VALUE

enum READ_STATUS_BYTE_VALUE

Enumerator
SUCCESS
ERR_UNAVAIL_CMD
ERR_UNAVAIL_FUNC
ERR_DATA_FORMAT
ERR_INPUT_VALUE
ERR_TRY_AGAIN
ERR_BTLDR_GENERAL
ERR_BTLDR_CHECKSUM
ERR_BTLDR_AUTH
ERR_BTLDR_INVALID_APP
ERR_UNKNOWN

SENSOR_ENABLE_INDEX_BYTE

enum SENSOR_ENABLE_INDEX_BYTE

Enumerator
ENABLE_MAX30101
ENABLE_ACCELEROMETER

WRITE_REGISTER_INDEX_BYTE

enum WRITE_REGISTER_INDEX_BYTE

Enumerator
WRITE_MAX30101
WRITE_ACCELEROMETER

Variable Documentation

BIO_ADDRESS

const uint8_t BIO_ADDRESS = 0x55