Project

General

Profile

Statistics
| Revision:

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

History | View | Annotate | Download (15.6 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.3 -->
8
<div class="tabs">
9
  <ul>
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11
    <li><a href="modules.html"><span>Modules</span></a></li>
12
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13
    <li><a href="files.html"><span>Files</span></a></li>
14
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
15
  </ul>
16
</div>
17
<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.  
18
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
19
<tr><td></td></tr>
20
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
21
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcc39015f57b2efb8810b603f188bdf15"></a><!-- doxytag: member="buzzer::C4" ref="gcc39015f57b2efb8810b603f188bdf15" args="" -->
22
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#gcc39015f57b2efb8810b603f188bdf15">C4</a>&nbsp;&nbsp;&nbsp;260</td></tr>
23

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

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

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

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

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

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

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

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

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

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

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

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

    
72
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">C. <br></td></tr>
73
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
74
<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>
75

    
76
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the buzzer.  <a href="#g0cead532fdd0c0de5fa1c1de0f6556bd"></a><br></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#g9872f05325dd86a89728d47c8e9158ab">buzzer_set_val</a> (unsigned int buzz_value)</td></tr>
78

    
79
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the value the buzzer plays.  <a href="#g9872f05325dd86a89728d47c8e9158ab"></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#ga0aba85b0044cb1a44bb28c675d7c193">buzzer_set_freq</a> (unsigned int buzz_freq)</td></tr>
81

    
82
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the frequency the buzzer plays.  <a href="#ga0aba85b0044cb1a44bb28c675d7c193"></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#ga78239c1255dfea31992f435659df1d7">buzzer_chirp</a> (unsigned int ms, unsigned int buzz_freq)</td></tr>
84

    
85
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Play a frequency for a specified time.  <a href="#ga78239c1255dfea31992f435659df1d7"></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#g93d07c81691fec7a85ea85117d6eca4f">buzzer_off</a> (void)</td></tr>
87

    
88
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turn the buzzer off.  <a href="#g93d07c81691fec7a85ea85117d6eca4f"></a><br></td></tr>
89
</table>
90
<hr><a name="_details"></a><h2>Detailed Description</h2>
91
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. 
92
<p>
93
<hr><h2>Function Documentation</h2>
94
<a class="anchor" name="ga78239c1255dfea31992f435659df1d7"></a><!-- doxytag: member="buzzer.c::buzzer_chirp" ref="ga78239c1255dfea31992f435659df1d7" args="(unsigned int ms, unsigned int buzz_freq)" -->
95
<div class="memitem">
96
<div class="memproto">
97
      <table class="memname">
98
        <tr>
99
          <td class="memname">void buzzer_chirp           </td>
100
          <td>(</td>
101
          <td class="paramtype">unsigned int&nbsp;</td>
102
          <td class="paramname"> <em>ms</em>, </td>
103
        </tr>
104
        <tr>
105
          <td class="paramkey"></td>
106
          <td></td>
107
          <td class="paramtype">unsigned int&nbsp;</td>
108
          <td class="paramname"> <em>buzz_freq</em></td><td>&nbsp;</td>
109
        </tr>
110
        <tr>
111
          <td></td>
112
          <td>)</td>
113
          <td></td><td></td><td width="100%"></td>
114
        </tr>
115
      </table>
116
</div>
117
<div class="memdoc">
118

    
119
<p>
120
Play a frequency for a specified time. 
121
<p>
122
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>
123
<dl compact><dt><b>Parameters:</b></dt><dd>
124
  <table border="0" cellspacing="2" cellpadding="0">
125
    <tr><td valign="top"></td><td valign="top"><em>ms</em>&nbsp;</td><td>the time in milliseconds to play the frequency </td></tr>
126
    <tr><td valign="top"></td><td valign="top"><em>buzz_freq</em>&nbsp;</td><td>the frequency to play</td></tr>
127
  </table>
128
</dl>
129
<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>
130

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

    
149
<p>
150
Initialize the buzzer. 
151
<p>
152
Initializes the buzzer. Must be called before any other buzzer function may be used. 
153
</div>
154
</div><p>
155
<a class="anchor" name="g93d07c81691fec7a85ea85117d6eca4f"></a><!-- doxytag: member="buzzer.c::buzzer_off" ref="g93d07c81691fec7a85ea85117d6eca4f" args="(void)" -->
156
<div class="memitem">
157
<div class="memproto">
158
      <table class="memname">
159
        <tr>
160
          <td class="memname">void buzzer_off           </td>
161
          <td>(</td>
162
          <td class="paramname">          </td>
163
          <td>&nbsp;)&nbsp;</td>
164
          <td width="100%"></td>
165
        </tr>
166
      </table>
167
</div>
168
<div class="memdoc">
169

    
170
<p>
171
Turn the buzzer off. 
172
<p>
173
Turns off the buzzer by disabling the timer0 clock.<p>
174
<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>
175

    
176
</div>
177
</div><p>
178
<a class="anchor" name="ga0aba85b0044cb1a44bb28c675d7c193"></a><!-- doxytag: member="buzzer.c::buzzer_set_freq" ref="ga0aba85b0044cb1a44bb28c675d7c193" args="(unsigned int buzz_freq)" -->
179
<div class="memitem">
180
<div class="memproto">
181
      <table class="memname">
182
        <tr>
183
          <td class="memname">void buzzer_set_freq           </td>
184
          <td>(</td>
185
          <td class="paramtype">unsigned int&nbsp;</td>
186
          <td class="paramname"> <em>buzz_freq</em>          </td>
187
          <td>&nbsp;)&nbsp;</td>
188
          <td width="100%"></td>
189
        </tr>
190
      </table>
191
</div>
192
<div class="memdoc">
193

    
194
<p>
195
Set the frequency the buzzer plays. 
196
<p>
197
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>
198
<dl compact><dt><b>Parameters:</b></dt><dd>
199
  <table border="0" cellspacing="2" cellpadding="0">
200
    <tr><td valign="top"></td><td valign="top"><em>buzz_freq</em>&nbsp;</td><td>the frequency to set the buzzer to</td></tr>
201
  </table>
202
</dl>
203
<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>
204

    
205
</div>
206
</div><p>
207
<a class="anchor" name="g9872f05325dd86a89728d47c8e9158ab"></a><!-- doxytag: member="buzzer.c::buzzer_set_val" ref="g9872f05325dd86a89728d47c8e9158ab" args="(unsigned int buzz_value)" -->
208
<div class="memitem">
209
<div class="memproto">
210
      <table class="memname">
211
        <tr>
212
          <td class="memname">void buzzer_set_val           </td>
213
          <td>(</td>
214
          <td class="paramtype">unsigned int&nbsp;</td>
215
          <td class="paramname"> <em>buzz_value</em>          </td>
216
          <td>&nbsp;)&nbsp;</td>
217
          <td width="100%"></td>
218
        </tr>
219
      </table>
220
</div>
221
<div class="memdoc">
222

    
223
<p>
224
Set the value the buzzer plays. 
225
<p>
226
Sets the value of the buzzer's pitch. Higher values are lower frequencies.<p>
227
<dl compact><dt><b>Parameters:</b></dt><dd>
228
  <table border="0" cellspacing="2" cellpadding="0">
229
    <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>
230
  </table>
231
</dl>
232
<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>
233

    
234
</div>
235
</div><p>
236
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Nov 5 19:59:43 2008 for libdragonfly by&nbsp;
237
<a href="http://www.doxygen.org/index.html">
238
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
239
</body>
240
</html>