Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libdragonfly / group__buzzer.html @ 1371

History | View | Annotate | Download (16.4 KB)

1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3
<title>libdragonfly: Buzzer</title>
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
<link href="tabs.css" rel="stylesheet" type="text/css">
6
</head><body>
7
<!-- Generated by Doxygen 1.5.5 -->
8
<div class="navigation" id="top">
9
  <div class="tabs">
10
    <ul>
11
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13
      <li><a href="modules.html"><span>Modules</span></a></li>
14
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
15
      <li><a href="files.html"><span>Files</span></a></li>
16
    </ul>
17
  </div>
18
</div>
19
<div class="contents">
20
<h1>Buzzer</h1>Functions for controlling the buzzer. Functions for controlling the buzzer. Include <a class="el" href="buzzer_8h.html" title="Contains definitions for using the buzzer.">buzzer.h</a> to access these functions.  
21
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
22
<tr><td></td></tr>
23
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
24
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcc39015f57b2efb8810b603f188bdf15"></a><!-- doxytag: member="buzzer::C4" ref="gcc39015f57b2efb8810b603f188bdf15" args="" -->
25
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#gcc39015f57b2efb8810b603f188bdf15">C4</a>&nbsp;&nbsp;&nbsp;260</td></tr>
26

    
27
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Middle C. <br></td></tr>
28
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g879790f58417f0986370ddbcda404ed0"></a><!-- doxytag: member="buzzer::C4s" ref="g879790f58417f0986370ddbcda404ed0" args="" -->
29
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g879790f58417f0986370ddbcda404ed0">C4s</a>&nbsp;&nbsp;&nbsp;277</td></tr>
30

    
31
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">C#. <br></td></tr>
32
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3d9bb178282c3cb69740c94ba1e48fed"></a><!-- doxytag: member="buzzer::D4" ref="g3d9bb178282c3cb69740c94ba1e48fed" args="" -->
33
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g3d9bb178282c3cb69740c94ba1e48fed">D4</a>&nbsp;&nbsp;&nbsp;294</td></tr>
34

    
35
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">D. <br></td></tr>
36
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g33eb0561dd16dd44c7c23519dd22540a"></a><!-- doxytag: member="buzzer::D4s" ref="g33eb0561dd16dd44c7c23519dd22540a" args="" -->
37
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g33eb0561dd16dd44c7c23519dd22540a">D4s</a>&nbsp;&nbsp;&nbsp;311</td></tr>
38

    
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">D#. <br></td></tr>
40
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4c819074c856b4e67fad4875a92cb2e9"></a><!-- doxytag: member="buzzer::E4" ref="g4c819074c856b4e67fad4875a92cb2e9" args="" -->
41
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g4c819074c856b4e67fad4875a92cb2e9">E4</a>&nbsp;&nbsp;&nbsp;330</td></tr>
42

    
43
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">E. <br></td></tr>
44
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7fd7918aa90b0ce1dc7ca9fe7a00e9fb"></a><!-- doxytag: member="buzzer::F4" ref="g7fd7918aa90b0ce1dc7ca9fe7a00e9fb" args="" -->
45
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g7fd7918aa90b0ce1dc7ca9fe7a00e9fb">F4</a>&nbsp;&nbsp;&nbsp;349</td></tr>
46

    
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">F. <br></td></tr>
48
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g93ff98890b28a2833f1152cc95c3e628"></a><!-- doxytag: member="buzzer::F4s" ref="g93ff98890b28a2833f1152cc95c3e628" args="" -->
49
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g93ff98890b28a2833f1152cc95c3e628">F4s</a>&nbsp;&nbsp;&nbsp;370</td></tr>
50

    
51
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">F#. <br></td></tr>
52
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6f984a8b01aafc34122cc8bc0d9d5691"></a><!-- doxytag: member="buzzer::G4" ref="g6f984a8b01aafc34122cc8bc0d9d5691" args="" -->
53
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g6f984a8b01aafc34122cc8bc0d9d5691">G4</a>&nbsp;&nbsp;&nbsp;392</td></tr>
54

    
55
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">G. <br></td></tr>
56
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gaf8daa589f172256505e028dab2954b2"></a><!-- doxytag: member="buzzer::G4s" ref="gaf8daa589f172256505e028dab2954b2" args="" -->
57
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#gaf8daa589f172256505e028dab2954b2">G4s</a>&nbsp;&nbsp;&nbsp;415</td></tr>
58

    
59
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">G#. <br></td></tr>
60
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga0a03ad95ca0cb887a11e321fa1c9519"></a><!-- doxytag: member="buzzer::A4" ref="ga0a03ad95ca0cb887a11e321fa1c9519" args="" -->
61
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#ga0a03ad95ca0cb887a11e321fa1c9519">A4</a>&nbsp;&nbsp;&nbsp;440</td></tr>
62

    
63
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A. <br></td></tr>
64
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7063c01bf1877119a8aca7049e02a8cb"></a><!-- doxytag: member="buzzer::A4s" ref="g7063c01bf1877119a8aca7049e02a8cb" args="" -->
65
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g7063c01bf1877119a8aca7049e02a8cb">A4s</a>&nbsp;&nbsp;&nbsp;466</td></tr>
66

    
67
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A#. <br></td></tr>
68
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0bf59f84e29fb57d27314583365a88d6"></a><!-- doxytag: member="buzzer::B4" ref="g0bf59f84e29fb57d27314583365a88d6" args="" -->
69
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g0bf59f84e29fb57d27314583365a88d6">B4</a>&nbsp;&nbsp;&nbsp;494</td></tr>
70

    
71
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">B. <br></td></tr>
72
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3b69b61d9deb37b13911faf2cf5cf1d5"></a><!-- doxytag: member="buzzer::C5" ref="g3b69b61d9deb37b13911faf2cf5cf1d5" args="" -->
73
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g3b69b61d9deb37b13911faf2cf5cf1d5">C5</a>&nbsp;&nbsp;&nbsp;523</td></tr>
74

    
75
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">C. <br></td></tr>
76
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
77
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g0cead532fdd0c0de5fa1c1de0f6556bd">buzzer_init</a> (void)</td></tr>
78

    
79
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the buzzer.  <a href="#g0cead532fdd0c0de5fa1c1de0f6556bd"></a><br></td></tr>
80
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g9872f05325dd86a89728d47c8e9158ab">buzzer_set_val</a> (unsigned int buzz_value)</td></tr>
81

    
82
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the value the buzzer plays.  <a href="#g9872f05325dd86a89728d47c8e9158ab"></a><br></td></tr>
83
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#ga0aba85b0044cb1a44bb28c675d7c193">buzzer_set_freq</a> (unsigned int buzz_freq)</td></tr>
84

    
85
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the frequency the buzzer plays.  <a href="#ga0aba85b0044cb1a44bb28c675d7c193"></a><br></td></tr>
86
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#ga78239c1255dfea31992f435659df1d7">buzzer_chirp</a> (unsigned int ms, unsigned int buzz_freq)</td></tr>
87

    
88
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Play a frequency for a specified time.  <a href="#ga78239c1255dfea31992f435659df1d7"></a><br></td></tr>
89
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#g93d07c81691fec7a85ea85117d6eca4f">buzzer_off</a> (void)</td></tr>
90

    
91
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turn the buzzer off.  <a href="#g93d07c81691fec7a85ea85117d6eca4f"></a><br></td></tr>
92
</table>
93
<hr><a name="_details"></a><h2>Detailed Description</h2>
94
Functions for controlling the buzzer. Functions for controlling the buzzer. Include <a class="el" href="buzzer_8h.html" title="Contains definitions for using the buzzer.">buzzer.h</a> to access these functions. 
95
<p>
96
<hr><h2>Function Documentation</h2>
97
<a class="anchor" name="ga78239c1255dfea31992f435659df1d7"></a><!-- doxytag: member="buzzer.c::buzzer_chirp" ref="ga78239c1255dfea31992f435659df1d7" args="(unsigned int ms, unsigned int buzz_freq)" -->
98
<div class="memitem">
99
<div class="memproto">
100
      <table class="memname">
101
        <tr>
102
          <td class="memname">void buzzer_chirp           </td>
103
          <td>(</td>
104
          <td class="paramtype">unsigned int&nbsp;</td>
105
          <td class="paramname"> <em>ms</em>, </td>
106
        </tr>
107
        <tr>
108
          <td class="paramkey"></td>
109
          <td></td>
110
          <td class="paramtype">unsigned int&nbsp;</td>
111
          <td class="paramname"> <em>buzz_freq</em></td><td>&nbsp;</td>
112
        </tr>
113
        <tr>
114
          <td></td>
115
          <td>)</td>
116
          <td></td><td></td><td width="100%"></td>
117
        </tr>
118
      </table>
119
</div>
120
<div class="memdoc">
121

    
122
<p>
123
Play a frequency for a specified time. 
124
<p>
125
Plays the specified frequency for the specified amount of time. This function blocks execution until the time is completed. buzzer_init must be called before this function can be used.<p>
126
<dl compact><dt><b>Parameters:</b></dt><dd>
127
  <table border="0" cellspacing="2" cellpadding="0">
128
    <tr><td valign="top"></td><td valign="top"><em>ms</em>&nbsp;</td><td>the time in milliseconds to play the frequency </td></tr>
129
    <tr><td valign="top"></td><td valign="top"><em>buzz_freq</em>&nbsp;</td><td>the frequency to play</td></tr>
130
  </table>
131
</dl>
132
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__buzzer.html#g0cead532fdd0c0de5fa1c1de0f6556bd" title="Initialize the buzzer.">buzzer_init</a>, <a class="el" href="group__buzzer.html#ga0aba85b0044cb1a44bb28c675d7c193" title="Set the frequency the buzzer plays.">buzzer_set_freq</a> </dd></dl>
133

    
134
<p>References <a class="el" href="buzzer_8c-source.html#l00127">buzzer_off()</a>, <a class="el" href="buzzer_8c-source.html#l00089">buzzer_set_freq()</a>, and <a class="el" href="time_8c-source.html#l00104">delay_ms()</a>.</p>
135

    
136
</div>
137
</div><p>
138
<a class="anchor" name="g0cead532fdd0c0de5fa1c1de0f6556bd"></a><!-- doxytag: member="buzzer.c::buzzer_init" ref="g0cead532fdd0c0de5fa1c1de0f6556bd" args="(void)" -->
139
<div class="memitem">
140
<div class="memproto">
141
      <table class="memname">
142
        <tr>
143
          <td class="memname">void buzzer_init           </td>
144
          <td>(</td>
145
          <td class="paramtype">void&nbsp;</td>
146
          <td class="paramname">          </td>
147
          <td>&nbsp;)&nbsp;</td>
148
          <td width="100%"></td>
149
        </tr>
150
      </table>
151
</div>
152
<div class="memdoc">
153

    
154
<p>
155
Initialize the buzzer. 
156
<p>
157
Initializes the buzzer. Must be called before any other buzzer function may be used. 
158
<p>Referenced by <a class="el" href="dragonfly__lib_8c-source.html#l00068">dragonfly_init()</a>.</p>
159

    
160
</div>
161
</div><p>
162
<a class="anchor" name="g93d07c81691fec7a85ea85117d6eca4f"></a><!-- doxytag: member="buzzer.c::buzzer_off" ref="g93d07c81691fec7a85ea85117d6eca4f" args="(void)" -->
163
<div class="memitem">
164
<div class="memproto">
165
      <table class="memname">
166
        <tr>
167
          <td class="memname">void buzzer_off           </td>
168
          <td>(</td>
169
          <td class="paramname">          </td>
170
          <td>&nbsp;)&nbsp;</td>
171
          <td width="100%"></td>
172
        </tr>
173
      </table>
174
</div>
175
<div class="memdoc">
176

    
177
<p>
178
Turn the buzzer off. 
179
<p>
180
Turns off the buzzer by disabling the timer0 clock.<p>
181
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__buzzer.html#g0cead532fdd0c0de5fa1c1de0f6556bd" title="Initialize the buzzer.">buzzer_init</a> </dd></dl>
182

    
183
<p>Referenced by <a class="el" href="buzzer_8c-source.html#l00115">buzzer_chirp()</a>.</p>
184

    
185
</div>
186
</div><p>
187
<a class="anchor" name="ga0aba85b0044cb1a44bb28c675d7c193"></a><!-- doxytag: member="buzzer.c::buzzer_set_freq" ref="ga0aba85b0044cb1a44bb28c675d7c193" args="(unsigned int buzz_freq)" -->
188
<div class="memitem">
189
<div class="memproto">
190
      <table class="memname">
191
        <tr>
192
          <td class="memname">void buzzer_set_freq           </td>
193
          <td>(</td>
194
          <td class="paramtype">unsigned int&nbsp;</td>
195
          <td class="paramname"> <em>buzz_freq</em>          </td>
196
          <td>&nbsp;)&nbsp;</td>
197
          <td width="100%"></td>
198
        </tr>
199
      </table>
200
</div>
201
<div class="memdoc">
202

    
203
<p>
204
Set the frequency the buzzer plays. 
205
<p>
206
Sets the buzzer frequency. Usage of constants such as C4 is highly recommended as input to this function. buzzer_init must be called before this function may be used.<p>
207
<dl compact><dt><b>Parameters:</b></dt><dd>
208
  <table border="0" cellspacing="2" cellpadding="0">
209
    <tr><td valign="top"></td><td valign="top"><em>buzz_freq</em>&nbsp;</td><td>the frequency to set the buzzer to</td></tr>
210
  </table>
211
</dl>
212
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__buzzer.html#g0cead532fdd0c0de5fa1c1de0f6556bd" title="Initialize the buzzer.">buzzer_init</a>, <a class="el" href="group__buzzer.html#g9872f05325dd86a89728d47c8e9158ab" title="Set the value the buzzer plays.">buzzer_set_val</a>, <a class="el" href="group__buzzer.html#g93d07c81691fec7a85ea85117d6eca4f" title="Turn the buzzer off.">buzzer_off</a> </dd></dl>
213

    
214
<p>References <a class="el" href="buzzer_8c-source.html#l00072">buzzer_set_val()</a>.</p>
215

    
216
<p>Referenced by <a class="el" href="buzzer_8c-source.html#l00115">buzzer_chirp()</a>.</p>
217

    
218
</div>
219
</div><p>
220
<a class="anchor" name="g9872f05325dd86a89728d47c8e9158ab"></a><!-- doxytag: member="buzzer.c::buzzer_set_val" ref="g9872f05325dd86a89728d47c8e9158ab" args="(unsigned int buzz_value)" -->
221
<div class="memitem">
222
<div class="memproto">
223
      <table class="memname">
224
        <tr>
225
          <td class="memname">void buzzer_set_val           </td>
226
          <td>(</td>
227
          <td class="paramtype">unsigned int&nbsp;</td>
228
          <td class="paramname"> <em>buzz_value</em>          </td>
229
          <td>&nbsp;)&nbsp;</td>
230
          <td width="100%"></td>
231
        </tr>
232
      </table>
233
</div>
234
<div class="memdoc">
235

    
236
<p>
237
Set the value the buzzer plays. 
238
<p>
239
Sets the value of the buzzer's pitch. Higher values are lower frequencies.<p>
240
<dl compact><dt><b>Parameters:</b></dt><dd>
241
  <table border="0" cellspacing="2" cellpadding="0">
242
    <tr><td valign="top"></td><td valign="top"><em>buzz_value</em>&nbsp;</td><td>the value to set the buzzer's frequency too, in the range 0-255</td></tr>
243
  </table>
244
</dl>
245
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__buzzer.html#g0cead532fdd0c0de5fa1c1de0f6556bd" title="Initialize the buzzer.">buzzer_init</a>, <a class="el" href="group__buzzer.html#ga0aba85b0044cb1a44bb28c675d7c193" title="Set the frequency the buzzer plays.">buzzer_set_freq</a>, <a class="el" href="group__buzzer.html#g93d07c81691fec7a85ea85117d6eca4f" title="Turn the buzzer off.">buzzer_off</a> </dd></dl>
246

    
247
<p>Referenced by <a class="el" href="buzzer_8c-source.html#l00089">buzzer_set_freq()</a>.</p>
248

    
249
</div>
250
</div><p>
251
</div>
252
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 2 23:20:08 2009 for libdragonfly by&nbsp;
253
<a href="http://www.doxygen.org/index.html">
254
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
255
</body>
256
</html>