buzz
2.0.0.0
|
API for configuring and manipulating BUZZ Click driver. More...
Modules | |
BUZZ PWM Settings | |
Settings for configuration of BUZZ Click driver. | |
BUZZ MikroBUS Map | |
MikroBUS pin mapping of BUZZ Click driver. | |
Buzz_cfg | |
Buzz_freq | |
Buzz frequency. | |
Functions | |
void | buzz_cfg_setup (buzz_cfg_t *cfg) |
BUZZ configuration object setup function. More... | |
err_t | buzz_init (buzz_t *ctx, buzz_cfg_t *cfg) |
BUZZ initialization function. More... | |
err_t | buzz_set_duty_cycle (buzz_t *ctx, float duty_cycle) |
BUZZ sets PWM duty cycle. More... | |
err_t | buzz_pwm_stop (buzz_t *ctx) |
BUZZ stop PWM module. More... | |
err_t | buzz_pwm_start (buzz_t *ctx) |
BUZZ start PWM module. More... | |
void | buzz_play_sound (buzz_t *ctx, uint16_t freq, uint16_t level, uint16_t duration) |
BUZZ Play sound function. More... | |
API for configuring and manipulating BUZZ Click driver.
void buzz_cfg_setup | ( | buzz_cfg_t * | cfg | ) |
BUZZ configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See buzz_cfg_t object definition for detailed explanation. |
err_t buzz_init | ( | buzz_t * | ctx, |
buzz_cfg_t * | cfg | ||
) |
BUZZ initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See buzz_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See buzz_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.void buzz_play_sound | ( | buzz_t * | ctx, |
uint16_t | freq, | ||
uint16_t | level, | ||
uint16_t | duration | ||
) |
BUZZ Play sound function.
This function plays sound on buzzer.
[out] | ctx | : Click context object. See buzz_t object definition for detailed explanation. |
[in] | freq | : Buzz sound frequency. |
[in] | level | : Buzz sound level. ( min = 1, max = 1000 ) |
[in] | duration | : Buzz sound duration in miliseconds. |
err_t buzz_pwm_start | ( | buzz_t * | ctx | ) |
BUZZ start PWM module.
This function starts the PWM moudle output.
[out] | ctx | : Click context object. See buzz_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t buzz_pwm_stop | ( | buzz_t * | ctx | ) |
BUZZ stop PWM module.
This function stops the PWM moudle output.
[out] | ctx | : Click context object. See buzz_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t buzz_set_duty_cycle | ( | buzz_t * | ctx, |
float | duty_cycle | ||
) |
BUZZ sets PWM duty cycle.
This function sets the PWM duty cycle in percentages ( Range[ 0..1 ] ).
[out] | ctx | : Click context object. See buzz_t object definition for detailed explanation. |
[in] | duty_ratio | : PWM duty_ratio. |
0
- Success, -1
- Error.