emg 2.0.0.0
Modules | Functions
EMG Click Driver

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

Modules

 EMG MikroBUS Map
 MikroBUS pin mapping of EMG Click driver.
 

Functions

void emg_cfg_setup (emg_cfg_t *cfg)
 EMG configuration object setup function. More...
 
err_t emg_init (emg_t *ctx, emg_cfg_t *cfg)
 EMG initialization function. More...
 
err_t emg_read_an_pin_value (emg_t *ctx, uint16_t *data_out)
 EMG read AN pin value function. More...
 
err_t emg_read_an_pin_voltage (emg_t *ctx, float *data_out)
 EMG read AN pin voltage level function. More...
 

Detailed Description

API for configuring and manipulating EMG Click driver.

Function Documentation

◆ emg_cfg_setup()

void emg_cfg_setup ( emg_cfg_t cfg)

EMG configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ emg_init()

err_t emg_init ( emg_t ctx,
emg_cfg_t cfg 
)

EMG initialization function.

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

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

◆ emg_read_an_pin_value()

err_t emg_read_an_pin_value ( emg_t ctx,
uint16_t *  data_out 
)

EMG read AN pin value function.

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

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

◆ emg_read_an_pin_voltage()

err_t emg_read_an_pin_voltage ( emg_t ctx,
float *  data_out 
)

EMG 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 emg_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).