eeg 2.0.0.0
Modules | Functions
EEG Click Driver

API for configuring and manipulating EEG Click driver. More...

Modules

 EEG MikroBUS Map
 MikroBUS pin mapping of EEG Click driver.
 

Functions

void eeg_cfg_setup (eeg_cfg_t *cfg)
 EEG configuration object setup function. More...
 
err_t eeg_init (eeg_t *ctx, eeg_cfg_t *cfg)
 EEG initialization function. More...
 
err_t eeg_read_an_pin_value (eeg_t *ctx, uint16_t *data_out)
 EEG read AN pin value function. More...
 
err_t eeg_read_an_pin_voltage (eeg_t *ctx, float *data_out)
 EEG read AN pin voltage level function. More...
 

Detailed Description

API for configuring and manipulating EEG Click driver.

Function Documentation

◆ eeg_cfg_setup()

void eeg_cfg_setup ( eeg_cfg_t cfg)

EEG configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See eeg_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ eeg_init()

err_t eeg_init ( eeg_t ctx,
eeg_cfg_t cfg 
)

EEG initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters
[out]ctx: Click context object. See eeg_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See eeg_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ eeg_read_an_pin_value()

err_t eeg_read_an_pin_value ( eeg_t ctx,
uint16_t *  data_out 
)

EEG read AN pin value function.

This function reads results of AD conversion of the AN pin.

Parameters
[in]ctx: Click context object. See eeg_t object definition for detailed explanation.
[out]data_out: Output ADC result.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ eeg_read_an_pin_voltage()

err_t eeg_read_an_pin_voltage ( eeg_t ctx,
float *  data_out 
)

EEG read AN pin voltage level function.

This function reads results of AD conversion of the AN pin and converts them to proportional voltage level.

Parameters
[in]ctx: Click context object. See eeg_t object definition for detailed explanation.
[out]data_out: Output voltage level of the analog pin [V].
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
The conversion to voltage depends on the entered configuration of the ADC (resolution, reference voltage).