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 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_pwm.h"
52 
73 #define BUZZ2_DEF_FREQ 5000
74  // buzz2_cfg
76 
86 #define BUZZ2_NOTE_C2 65
87 #define BUZZ2_NOTE_Db2 69
88 #define BUZZ2_NOTE_D2 73
89 #define BUZZ2_NOTE_Eb2 78
90 #define BUZZ2_NOTE_E2 82
91 #define BUZZ2_NOTE_F2 87
92 #define BUZZ2_NOTE_Gb2 93
93 #define BUZZ2_NOTE_G2 98
94 #define BUZZ2_NOTE_Ab2 104
95 #define BUZZ2_NOTE_A2 110
96 #define BUZZ2_NOTE_Bb2 117
97 #define BUZZ2_NOTE_B2 123
98 #define BUZZ2_NOTE_C3 131
99 #define BUZZ2_NOTE_Db3 139
100 #define BUZZ2_NOTE_D3 147
101 #define BUZZ2_NOTE_Eb3 156
102 #define BUZZ2_NOTE_E3 165
103 #define BUZZ2_NOTE_F3 175
104 #define BUZZ2_NOTE_Gb3 185
105 #define BUZZ2_NOTE_G3 196
106 #define BUZZ2_NOTE_Ab3 208
107 #define BUZZ2_NOTE_A3 220
108 #define BUZZ2_NOTE_AS3 233
109 #define BUZZ2_NOTE_B3 247
110 #define BUZZ2_NOTE_C4 262
111 #define BUZZ2_NOTE_Db4 277
112 #define BUZZ2_NOTE_D4 294
113 #define BUZZ2_NOTE_Eb4 311
114 #define BUZZ2_NOTE_E4 330
115 #define BUZZ2_NOTE_F4 349
116 #define BUZZ2_NOTE_Gb4 370
117 #define BUZZ2_NOTE_G4 392
118 #define BUZZ2_NOTE_Ab4 415
119 #define BUZZ2_NOTE_A4 440
120 #define BUZZ2_NOTE_Bb4 466
121 #define BUZZ2_NOTE_B4 494
122 #define BUZZ2_NOTE_C5 523
123 #define BUZZ2_NOTE_Db5 554
124 #define BUZZ2_NOTE_D5 587
125 #define BUZZ2_NOTE_Eb5 622
126 #define BUZZ2_NOTE_E5 659
127 #define BUZZ2_NOTE_F5 698
128 #define BUZZ2_NOTE_Gb5 740
129 #define BUZZ2_NOTE_G5 784
130 #define BUZZ2_NOTE_Ab5 831
131 #define BUZZ2_NOTE_A5 880
132 #define BUZZ2_NOTE_Bb5 932
133 #define BUZZ2_NOTE_B5 988
134 #define BUZZ2_NOTE_C6 1047
135 #define BUZZ2_NOTE_Db6 1109
136 #define BUZZ2_NOTE_D6 1175
137 #define BUZZ2_NOTE_Eb6 1245
138 #define BUZZ2_NOTE_E6 1319
139 #define BUZZ2_NOTE_F6 1397
140 #define BUZZ2_NOTE_Gb6 1480
141 #define BUZZ2_NOTE_G6 1568
142 #define BUZZ2_NOTE_Ab6 1661
143 #define BUZZ2_NOTE_A6 1760
144 #define BUZZ2_NOTE_Bb6 1865
145 #define BUZZ2_NOTE_B6 1976
146 #define BUZZ2_NOTE_C7 2093
147 #define BUZZ2_NOTE_Db7 2217
148 #define BUZZ2_NOTE_D7 2349
149 #define BUZZ2_NOTE_Eb7 2489
150 #define BUZZ2_NOTE_E7 2637
151 #define BUZZ2_NOTE_F7 2794
152 #define BUZZ2_NOTE_Gb7 2960
153 #define BUZZ2_NOTE_G7 3136
154 #define BUZZ2_NOTE_Ab7 3322
155 #define BUZZ2_NOTE_A7 3520
156 #define BUZZ2_NOTE_Bb7 3729
157 #define BUZZ2_NOTE_B7 3951
158 #define BUZZ2_NOTE_C8 4186
159 #define BUZZ2_NOTE_Db8 4435
160 #define BUZZ2_NOTE_D8 4699
161 #define BUZZ2_NOTE_Eb8 4978
162  // buzz2_freq
163 
178 #define BUZZ2_MAP_MIKROBUS( cfg, mikrobus ) \
179  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
180  // buzz2_map // buzz2
183 
193 typedef struct
194 {
195  // Modules
196 
197  pwm_t pwm;
199  // ctx variable
200 
201  uint32_t pwm_freq;
203 } buzz2_t;
204 
209 typedef struct
210 {
211  // Communication gpio pins
212 
213  pin_name_t pwm;
215  // Static variable
216 
217  uint32_t dev_pwm_freq;
219 } buzz2_cfg_t;
220 
225 typedef enum
226 {
227  BUZZ2_OK = 0,
228  BUZZ2_ERROR = -1
229 
231 
248 
263 err_t buzz2_init ( buzz2_t *ctx, buzz2_cfg_t *cfg );
264 
278 err_t buzz2_set_duty_cycle ( buzz2_t *ctx, float duty_cycle );
279 
290 void buzz2_play_sound ( buzz2_t *ctx, uint16_t freq, uint16_t level, uint16_t duration );
291 
303 err_t buzz2_pwm_stop ( buzz2_t *ctx );
304 
315 err_t buzz2_pwm_start ( buzz2_t *ctx );
316 
317 #ifdef __cplusplus
318 }
319 #endif
320 #endif // BUZZ2_H
321  // buzz2
323 
324 // ------------------------------------------------------------------------ END
buzz2_set_duty_cycle
err_t buzz2_set_duty_cycle(buzz2_t *ctx, float duty_cycle)
BUZZ 2 sets PWM duty cycle.
buzz2_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: buzz2.h:217
BUZZ2_ERROR
@ BUZZ2_ERROR
Definition: buzz2.h:228
buzz2_play_sound
void buzz2_play_sound(buzz2_t *ctx, uint16_t freq, uint16_t level, uint16_t duration)
Play sound function.
buzz2_t::pwm_freq
uint32_t pwm_freq
Definition: buzz2.h:201
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:194
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
@ BUZZ2_OK
Definition: buzz2.h:227
buzz2_cfg_setup
void buzz2_cfg_setup(buzz2_cfg_t *cfg)
BUZZ 2 configuration object setup function.
buzz2_t::pwm
pwm_t pwm
Definition: buzz2.h:197
buzz2_cfg_t
BUZZ 2 Click configuration object.
Definition: buzz2.h:210
buzz2_cfg_t::pwm
pin_name_t pwm
Definition: buzz2.h:213
buzz2_return_value_t
buzz2_return_value_t
BUZZ 2 Click return value data.
Definition: buzz2.h:226