buzzer  2.1.0.0
Data Structures | Macros | Enumerations | Functions
buzzer.h File Reference

This file contains API for Buzzer Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_pwm.h"

Go to the source code of this file.

Data Structures

struct  buzzer_t
 Buzzer Click context object. More...
 
struct  buzzer_cfg_t
 Buzzer Click configuration object. More...
 

Macros

#define BUZZER_DEF_FREQ   6000
 Buzzer default PWM frequency. More...
 
#define BUZZER_NOTE_C2   65
 Buzzer note frequency. More...
 
#define BUZZER_NOTE_Db2   69
 
#define BUZZER_NOTE_D2   73
 
#define BUZZER_NOTE_Eb2   78
 
#define BUZZER_NOTE_E2   82
 
#define BUZZER_NOTE_F2   87
 
#define BUZZER_NOTE_Gb2   93
 
#define BUZZER_NOTE_G2   98
 
#define BUZZER_NOTE_Ab2   104
 
#define BUZZER_NOTE_A2   110
 
#define BUZZER_NOTE_Bb2   117
 
#define BUZZER_NOTE_B2   123
 
#define BUZZER_NOTE_C3   131
 
#define BUZZER_NOTE_Db3   139
 
#define BUZZER_NOTE_D3   147
 
#define BUZZER_NOTE_Eb3   156
 
#define BUZZER_NOTE_E3   165
 
#define BUZZER_NOTE_F3   175
 
#define BUZZER_NOTE_Gb3   185
 
#define BUZZER_NOTE_G3   196
 
#define BUZZER_NOTE_Ab3   208
 
#define BUZZER_NOTE_A3   220
 
#define BUZZER_NOTE_AS3   233
 
#define BUZZER_NOTE_B3   247
 
#define BUZZER_NOTE_C4   262
 
#define BUZZER_NOTE_Db4   277
 
#define BUZZER_NOTE_D4   294
 
#define BUZZER_NOTE_Eb4   311
 
#define BUZZER_NOTE_E4   330
 
#define BUZZER_NOTE_F4   349
 
#define BUZZER_NOTE_Gb4   370
 
#define BUZZER_NOTE_G4   392
 
#define BUZZER_NOTE_Ab4   415
 
#define BUZZER_NOTE_A4   440
 
#define BUZZER_NOTE_Bb4   466
 
#define BUZZER_NOTE_B4   494
 
#define BUZZER_NOTE_C5   523
 
#define BUZZER_NOTE_Db5   554
 
#define BUZZER_NOTE_D5   587
 
#define BUZZER_NOTE_Eb5   622
 
#define BUZZER_NOTE_E5   659
 
#define BUZZER_NOTE_F5   698
 
#define BUZZER_NOTE_Gb5   740
 
#define BUZZER_NOTE_G5   784
 
#define BUZZER_NOTE_Ab5   831
 
#define BUZZER_NOTE_A5   880
 
#define BUZZER_NOTE_Bb5   932
 
#define BUZZER_NOTE_B5   988
 
#define BUZZER_NOTE_C6   1047
 
#define BUZZER_NOTE_Db6   1109
 
#define BUZZER_NOTE_D6   1175
 
#define BUZZER_NOTE_Eb6   1245
 
#define BUZZER_NOTE_E6   1319
 
#define BUZZER_NOTE_F6   1397
 
#define BUZZER_NOTE_Gb6   1480
 
#define BUZZER_NOTE_G6   1568
 
#define BUZZER_NOTE_Ab6   1661
 
#define BUZZER_NOTE_A6   1760
 
#define BUZZER_NOTE_Bb6   1865
 
#define BUZZER_NOTE_B6   1976
 
#define BUZZER_NOTE_C7   2093
 
#define BUZZER_NOTE_Db7   2217
 
#define BUZZER_NOTE_D7   2349
 
#define BUZZER_NOTE_Eb7   2489
 
#define BUZZER_NOTE_E7   2637
 
#define BUZZER_NOTE_F7   2794
 
#define BUZZER_NOTE_Gb7   2960
 
#define BUZZER_NOTE_G7   3136
 
#define BUZZER_NOTE_Ab7   3322
 
#define BUZZER_NOTE_A7   3520
 
#define BUZZER_NOTE_Bb7   3729
 
#define BUZZER_NOTE_B7   3951
 
#define BUZZER_NOTE_C8   4186
 
#define BUZZER_NOTE_Db8   4435
 
#define BUZZER_NOTE_D8   4699
 
#define BUZZER_NOTE_Eb8   4978
 
#define BUZZER_NOTE_LEN_WHOLE   1000
 Buzzer note duration lenght. More...
 
#define BUZZER_NOTE_LEN_HALF   ( BUZZER_NOTE_LEN_WHOLE / 2 )
 
#define BUZZER_NOTE_LEN_QUARTER   ( BUZZER_NOTE_LEN_WHOLE / 4 )
 
#define BUZZER_NOTE_LEN_EIGHTH   ( BUZZER_NOTE_LEN_WHOLE / 8 )
 
#define BUZZER_NOTE_LEN_SIXTEENTH   ( BUZZER_NOTE_LEN_WHOLE / 16 )
 
#define BUZZER_VOLUME_MIN   1
 Buzzer volume settings. More...
 
#define BUZZER_VOLUME_MAX   100
 
#define BUZZER_MAP_MIKROBUS(cfg, mikrobus)    cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM );
 MikroBUS pin mapping. More...
 

Enumerations

enum  buzzer_return_value_t { BUZZER_OK = 0, BUZZER_ERROR = -1 }
 Buzzer Click return value data. More...
 

Functions

void buzzer_cfg_setup (buzzer_cfg_t *cfg)
 Buzzer configuration object setup function. More...
 
err_t buzzer_init (buzzer_t *ctx, buzzer_cfg_t *cfg)
 Buzzer initialization function. More...
 
err_t buzzer_set_duty_cycle (buzzer_t *ctx, float duty_cycle)
 Buzzer sets PWM duty cycle. More...
 
err_t buzzer_pwm_stop (buzzer_t *ctx)
 Buzzer stop PWM module. More...
 
err_t buzzer_pwm_start (buzzer_t *ctx)
 Buzzer start PWM module. More...
 
err_t buzzer_play_sound (buzzer_t *ctx, uint16_t freq, uint8_t level, uint16_t duration)
 Buzzer play sound function. More...
 

Detailed Description

This file contains API for Buzzer Click Driver.

Enumeration Type Documentation

◆ buzzer_return_value_t

Buzzer Click return value data.

Predefined enum values for driver return values.

Enumerator
BUZZER_OK 
BUZZER_ERROR