buzz2  2.0.0.0
buzz2.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef BUZZ2_H
29 #define BUZZ2_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_pwm.h"
38 
59 #define BUZZ2_DEF_FREQ 5000
60  // buzz2_cfg
62 
72 #define BUZZ2_NOTE_C2 65
73 #define BUZZ2_NOTE_Db2 69
74 #define BUZZ2_NOTE_D2 73
75 #define BUZZ2_NOTE_Eb2 78
76 #define BUZZ2_NOTE_E2 82
77 #define BUZZ2_NOTE_F2 87
78 #define BUZZ2_NOTE_Gb2 93
79 #define BUZZ2_NOTE_G2 98
80 #define BUZZ2_NOTE_Ab2 104
81 #define BUZZ2_NOTE_A2 110
82 #define BUZZ2_NOTE_Bb2 117
83 #define BUZZ2_NOTE_B2 123
84 #define BUZZ2_NOTE_C3 131
85 #define BUZZ2_NOTE_Db3 139
86 #define BUZZ2_NOTE_D3 147
87 #define BUZZ2_NOTE_Eb3 156
88 #define BUZZ2_NOTE_E3 165
89 #define BUZZ2_NOTE_F3 175
90 #define BUZZ2_NOTE_Gb3 185
91 #define BUZZ2_NOTE_G3 196
92 #define BUZZ2_NOTE_Ab3 208
93 #define BUZZ2_NOTE_A3 220
94 #define BUZZ2_NOTE_AS3 233
95 #define BUZZ2_NOTE_B3 247
96 #define BUZZ2_NOTE_C4 262
97 #define BUZZ2_NOTE_Db4 277
98 #define BUZZ2_NOTE_D4 294
99 #define BUZZ2_NOTE_Eb4 311
100 #define BUZZ2_NOTE_E4 330
101 #define BUZZ2_NOTE_F4 349
102 #define BUZZ2_NOTE_Gb4 370
103 #define BUZZ2_NOTE_G4 392
104 #define BUZZ2_NOTE_Ab4 415
105 #define BUZZ2_NOTE_A4 440
106 #define BUZZ2_NOTE_Bb4 466
107 #define BUZZ2_NOTE_B4 494
108 #define BUZZ2_NOTE_C5 523
109 #define BUZZ2_NOTE_Db5 554
110 #define BUZZ2_NOTE_D5 587
111 #define BUZZ2_NOTE_Eb5 622
112 #define BUZZ2_NOTE_E5 659
113 #define BUZZ2_NOTE_F5 698
114 #define BUZZ2_NOTE_Gb5 740
115 #define BUZZ2_NOTE_G5 784
116 #define BUZZ2_NOTE_Ab5 831
117 #define BUZZ2_NOTE_A5 880
118 #define BUZZ2_NOTE_Bb5 932
119 #define BUZZ2_NOTE_B5 988
120 #define BUZZ2_NOTE_C6 1047
121 #define BUZZ2_NOTE_Db6 1109
122 #define BUZZ2_NOTE_D6 1175
123 #define BUZZ2_NOTE_Eb6 1245
124 #define BUZZ2_NOTE_E6 1319
125 #define BUZZ2_NOTE_F6 1397
126 #define BUZZ2_NOTE_Gb6 1480
127 #define BUZZ2_NOTE_G6 1568
128 #define BUZZ2_NOTE_Ab6 1661
129 #define BUZZ2_NOTE_A6 1760
130 #define BUZZ2_NOTE_Bb6 1865
131 #define BUZZ2_NOTE_B6 1976
132 #define BUZZ2_NOTE_C7 2093
133 #define BUZZ2_NOTE_Db7 2217
134 #define BUZZ2_NOTE_D7 2349
135 #define BUZZ2_NOTE_Eb7 2489
136 #define BUZZ2_NOTE_E7 2637
137 #define BUZZ2_NOTE_F7 2794
138 #define BUZZ2_NOTE_Gb7 2960
139 #define BUZZ2_NOTE_G7 3136
140 #define BUZZ2_NOTE_Ab7 3322
141 #define BUZZ2_NOTE_A7 3520
142 #define BUZZ2_NOTE_Bb7 3729
143 #define BUZZ2_NOTE_B7 3951
144 #define BUZZ2_NOTE_C8 4186
145 #define BUZZ2_NOTE_Db8 4435
146 #define BUZZ2_NOTE_D8 4699
147 #define BUZZ2_NOTE_Eb8 4978
148  // buzz2_freq
149 
164 #define BUZZ2_MAP_MIKROBUS( cfg, mikrobus ) \
165  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
166  // buzz2_map // buzz2
169 
179 typedef struct
180 {
181  // Modules
182 
183  pwm_t pwm;
185  // ctx variable
186 
187  uint32_t pwm_freq;
189 } buzz2_t;
190 
195 typedef struct
196 {
197  // Communication gpio pins
198 
199  pin_name_t pwm;
201  // Static variable
202 
203  uint32_t dev_pwm_freq;
205 } buzz2_cfg_t;
206 
211 typedef enum
212 {
213  BUZZ2_OK = 0,
214  BUZZ2_ERROR = -1
215 
217 
233 void buzz2_cfg_setup ( buzz2_cfg_t *cfg );
234 
249 err_t buzz2_init ( buzz2_t *ctx, buzz2_cfg_t *cfg );
250 
264 err_t buzz2_set_duty_cycle ( buzz2_t *ctx, float duty_cycle );
265 
276 void buzz2_play_sound ( buzz2_t *ctx, uint16_t freq, uint16_t level, uint16_t duration );
277 
289 err_t buzz2_pwm_stop ( buzz2_t *ctx );
290 
301 err_t buzz2_pwm_start ( buzz2_t *ctx );
302 
303 #ifdef __cplusplus
304 }
305 #endif
306 #endif // BUZZ2_H
307  // buzz2
309 
310 // ------------------------------------------------------------------------ END
buzz2_set_duty_cycle
err_t buzz2_set_duty_cycle(buzz2_t *ctx, float duty_cycle)
BUZZ 2 sets PWM duty cycle.
BUZZ2_ERROR
Definition: buzz2.h:213
buzz2_play_sound
void buzz2_play_sound(buzz2_t *ctx, uint16_t freq, uint16_t level, uint16_t duration)
Play sound function.
buzz2_pwm_stop
err_t buzz2_pwm_stop(buzz2_t *ctx)
BUZZ 2 stop PWM module.
buzz2_t
BUZZ 2 Click driver selector.
Definition: buzz2.h:178
buzz2_init
err_t buzz2_init(buzz2_t *ctx, buzz2_cfg_t *cfg)
BUZZ 2 initialization function.
buzz2_pwm_start
err_t buzz2_pwm_start(buzz2_t *ctx)
BUZZ 2 start PWM module.
BUZZ2_OK
Definition: buzz2.h:212
buzz2_cfg_setup
void buzz2_cfg_setup(buzz2_cfg_t *cfg)
BUZZ 2 configuration object setup function.
buzz2_cfg_t
BUZZ 2 Click configuration object.
Definition: buzz2.h:194
buzz2_return_value_t
buzz2_return_value_t
BUZZ 2 Click return value data.
Definition: buzz2.h:210