buzz  2.0.0.0
Functions
Public function

Functions

void buzz_cfg_setup (buzz_cfg_t *cfg)
 Config Object Initialization function. More...
 
BUZZ_RETVAL buzz_init (buzz_t *ctx, buzz_cfg_t *cfg)
 Initialization function. More...
 
void buzz_play_sound (buzz_t *ctx, uint16_t freq, uint16_t level, uint16_t duration)
 Play sound function. More...
 
void buzz_set_duty_cycle (buzz_t *ctx, float duty_cycle)
 Generic sets PWM duty cycle. More...
 
void buzz_pwm_stop (buzz_t *ctx)
 Stop PWM module. More...
 
void buzz_pwm_start (buzz_t *ctx)
 Start PWM module. More...
 

Detailed Description

Function Documentation

◆ buzz_cfg_setup()

void buzz_cfg_setup ( buzz_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ buzz_init()

BUZZ_RETVAL buzz_init ( buzz_t ctx,
buzz_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ buzz_play_sound()

void buzz_play_sound ( buzz_t ctx,
uint16_t  freq,
uint16_t  level,
uint16_t  duration 
)

Play sound function.

Parameters
ctxClick object.
freqBuzz sound frequency.
levelBuzz sound level. ( min = 1, max = 1000 )
durationBuzz sound duration in miliseconds.

@description This function plays sound on buzzer.

◆ buzz_pwm_start()

void buzz_pwm_start ( buzz_t ctx)

Start PWM module.

Parameters
ctxClick object.

@description This function starts PWM module.

◆ buzz_pwm_stop()

void buzz_pwm_stop ( buzz_t ctx)

Stop PWM module.

Parameters
ctxClick object.

@description This function stops PWM module.

◆ buzz_set_duty_cycle()

void buzz_set_duty_cycle ( buzz_t ctx,
float  duty_cycle 
)

Generic sets PWM duty cycle.

Parameters
ctxClick object.
duty_cycleDuty cycle.

@description This function sets the PWM duty cycle.