Project

General

Profile

Statistics
| Revision:

root / branches / wireless / docs / libdragonfly / html / buzzer_8h.html @ 1578

History | View | Annotate | Download (10.9 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>Colony: buzzer.h File Reference</title>
4
<link href="tabs.css" rel="stylesheet" type="text/css">
5
<link href="doxygen.css" rel="stylesheet" type="text/css">
6
</head><body>
7
<!-- Generated by Doxygen 1.5.8 -->
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 class="current"><a href="files.html"><span>Files</span></a></li>
16
    </ul>
17
  </div>
18
  <div class="tabs">
19
    <ul>
20
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
21
      <li><a href="globals.html"><span>Globals</span></a></li>
22
    </ul>
23
  </div>
24
</div>
25
<div class="contents">
26
<h1>buzzer.h File Reference</h1>Contains definitions for using the buzzer.  
27
<a href="#_details">More...</a>
28
<p>
29

    
30
<p>
31
<a href="buzzer_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
32
<tr><td></td></tr>
33
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
34
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcc39015f57b2efb8810b603f188bdf15"></a><!-- doxytag: member="buzzer.h::C4" ref="gcc39015f57b2efb8810b603f188bdf15" args="" -->
35
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__buzzer.html#gcc39015f57b2efb8810b603f188bdf15">C4</a>&nbsp;&nbsp;&nbsp;260</td></tr>
36

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

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

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

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

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

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

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

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

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

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

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

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

    
85
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">C. <br></td></tr>
86
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
87
<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>
88

    
89
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the buzzer.  <a href="group__buzzer.html#g0cead532fdd0c0de5fa1c1de0f6556bd"></a><br></td></tr>
90
<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>
91

    
92
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the value the buzzer plays.  <a href="group__buzzer.html#g9872f05325dd86a89728d47c8e9158ab"></a><br></td></tr>
93
<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>
94

    
95
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the frequency the buzzer plays.  <a href="group__buzzer.html#ga0aba85b0044cb1a44bb28c675d7c193"></a><br></td></tr>
96
<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>
97

    
98
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Play a frequency for a specified time.  <a href="group__buzzer.html#ga78239c1255dfea31992f435659df1d7"></a><br></td></tr>
99
<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>
100

    
101
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turn the buzzer off.  <a href="group__buzzer.html#g93d07c81691fec7a85ea85117d6eca4f"></a><br></td></tr>
102
</table>
103
<hr><a name="_details"></a><h2>Detailed Description</h2>
104
Contains definitions for using the buzzer. 
105
<p>
106
Copyright (c) 2007 Colony Project<p>
107
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p>
108
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>
109
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<p>
110
Contains definitions for using the buzzer built into the colony robots.<p>
111
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl>
112
</div>
113
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:59 2009 for Colony by&nbsp;
114
<a href="http://www.doxygen.org/index.html">
115
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
116
</body>
117
</html>