vumeter 2.0.0.0
|
API for configuring and manipulating VU Meter Click driver. More...
Modules | |
VU Meter Settings | |
Settings of VU Meter Click driver. | |
VU Meter MikroBUS Map | |
MikroBUS pin mapping of VU Meter Click driver. | |
Functions | |
void | vumeter_cfg_setup (vumeter_cfg_t *cfg) |
VU Meter configuration object setup function. More... | |
err_t | vumeter_init (vumeter_t *ctx, vumeter_cfg_t *cfg) |
VU Meter initialization function. More... | |
err_t | vumeter_read_an_pin_value (vumeter_t *ctx, uint16_t *data_out) |
VU Meter read AN pin value function. More... | |
err_t | vumeter_read_an_pin_voltage (vumeter_t *ctx, float *data_out) |
VU Meter read AN pin voltage level function. More... | |
err_t | vumeter_set_gain_level (vumeter_t *ctx, uint8_t gain_lvl) |
VU Meter set gain level function. More... | |
float | vumeter_calculate_vu_level (vumeter_t *ctx, uint16_t sample_rate_ms) |
VU Meter calculate VU level function. More... | |
API for configuring and manipulating VU Meter Click driver.
float vumeter_calculate_vu_level | ( | vumeter_t * | ctx, |
uint16_t | sample_rate_ms | ||
) |
VU Meter calculate VU level function.
This function calculates VU level from the analog voltage input.
[in] | ctx | : Click context object. See vumeter_t object definition for detailed explanation. |
[in] | sample_rate_ms | : Time in miliseconds for ADC samples ( ADC samples 10 times per milisecond ). |
See #err_t definition for detailed explanation.
void vumeter_cfg_setup | ( | vumeter_cfg_t * | cfg | ) |
VU Meter configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See vumeter_cfg_t object definition for detailed explanation. |
err_t vumeter_init | ( | vumeter_t * | ctx, |
vumeter_cfg_t * | cfg | ||
) |
VU Meter initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See vumeter_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See vumeter_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t vumeter_read_an_pin_value | ( | vumeter_t * | ctx, |
uint16_t * | data_out | ||
) |
VU Meter read AN pin value function.
This function reads results of AD conversion of the AN pin.
[in] | ctx | : Click context object. See vumeter_t object definition for detailed explanation. |
[out] | data_out | : Output ADC result. |
0
- Success, -1
- Error.err_t vumeter_read_an_pin_voltage | ( | vumeter_t * | ctx, |
float * | data_out | ||
) |
VU Meter read AN pin voltage level function.
This function reads results of AD conversion of the AN pin and converts them to proportional voltage level.
[in] | ctx | : Click context object. See vumeter_t object definition for detailed explanation. |
[out] | data_out | : Output voltage level of the analog pin [V]. |
0
- Success, -1
- Error.err_t vumeter_set_gain_level | ( | vumeter_t * | ctx, |
uint8_t | gain_lvl | ||
) |
VU Meter set gain level function.
This function sets the input signal gain level (the microphone sensitivity).
[in] | ctx | : Click context object. See vumeter_t object definition for detailed explanation. |
[in] | gain_lvl | : Gain level [0x00-0xFF]. |
0
- Success, -1
- Error.