Project

General

Profile

Revision 241

Updated libdragonfly documentation.

View differences:

group__lcd.html
1 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3
<title>libdragonfly: LCD</title>
4 4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5 5
<link href="tabs.css" rel="stylesheet" type="text/css">
6 6
</head><body>
7
<!-- Generated by Doxygen 1.4.6 -->
7
<!-- Generated by Doxygen 1.5.3 -->
8 8
<div class="tabs">
9 9
  <ul>
10 10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 11
    <li><a href="modules.html"><span>Modules</span></a></li>
12 12
    <li><a href="files.html"><span>Files</span></a></li>
13
  </ul></div>
14
<h1>LCD</h1>Functions for the LCD Functions for writing to the LCD. All functions may be found in <a class="el" href="lcd_8h.html">lcd.h</a>.  
13
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
14
  </ul>
15
</div>
16
<h1>LCD</h1>Functions for the LCD Functions for writing to the LCD. All functions may be found in <a class="el" href="lcd_8h.html" title="Contains definitions for dealing with the LCD screen.">lcd.h</a>.  
15 17
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
16 18
<tr><td></td></tr>
17 19
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
......
36 38
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print an int to the LCD screen.  <a href="#g0150085af3123e80303a3445821acb40"></a><br></td></tr>
37 39
</table>
38 40
<hr><a name="_details"></a><h2>Detailed Description</h2>
39
Functions for the LCD Functions for writing to the LCD. All functions may be found in <a class="el" href="lcd_8h.html">lcd.h</a>. 
41
Functions for the LCD Functions for writing to the LCD. All functions may be found in <a class="el" href="lcd_8h.html" title="Contains definitions for dealing with the LCD screen.">lcd.h</a>. 
40 42
<p>
41 43
<hr><h2>Function Documentation</h2>
42
<a class="anchor" name="ge4dc23fdf26f3b8b0db253f431fe950d"></a><!-- doxytag: member="lcd.c::lcd_clear_screen" ref="ge4dc23fdf26f3b8b0db253f431fe950d" args="(void)" --><p>
43
<table class="mdTable" cellpadding="2" cellspacing="0">
44
  <tr>
45
    <td class="mdRow">
46
      <table cellpadding="0" cellspacing="0" border="0">
44
<a class="anchor" name="ge4dc23fdf26f3b8b0db253f431fe950d"></a><!-- doxytag: member="lcd.c::lcd_clear_screen" ref="ge4dc23fdf26f3b8b0db253f431fe950d" args="(void)" -->
45
<div class="memitem">
46
<div class="memproto">
47
      <table class="memname">
47 48
        <tr>
48
          <td class="md" nowrap valign="top">void lcd_clear_screen           </td>
49
          <td class="md" valign="top">(&nbsp;</td>
50
          <td class="md" nowrap valign="top">void&nbsp;</td>
51
          <td class="mdname1" valign="top" nowrap>          </td>
52
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
53
          <td class="md" nowrap></td>
49
          <td class="memname">void lcd_clear_screen           </td>
50
          <td>(</td>
51
          <td class="paramtype">void&nbsp;</td>
52
          <td class="paramname">          </td>
53
          <td>&nbsp;)&nbsp;</td>
54
          <td width="100%"></td>
54 55
        </tr>
55 56
      </table>
56
    </td>
57
  </tr>
58
</table>
59
<table cellspacing="5" cellpadding="0" border="0">
60
  <tr>
61
    <td>
62
      &nbsp;
63
    </td>
64
    <td>
57
</div>
58
<div class="memdoc">
65 59

  
66 60
<p>
67 61
Clear the LCD screen. 
68 62
<p>
69 63
Clears the LCD screen. lcd_init must be called first.<p>
70
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__lcd.html#g6842775ba83d166f02b8fef8bb63b1e6">lcd_init</a> </dd></dl>
71
    </td>
72
  </tr>
73
</table>
74
<a class="anchor" name="gac280d714190003871937d3d92af3a29"></a><!-- doxytag: member="lcd.c::lcd_gotoxy" ref="gac280d714190003871937d3d92af3a29" args="(int x, int y)" --><p>
75
<table class="mdTable" cellpadding="2" cellspacing="0">
76
  <tr>
77
    <td class="mdRow">
78
      <table cellpadding="0" cellspacing="0" border="0">
64
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__lcd.html#g6842775ba83d166f02b8fef8bb63b1e6" title="Initialize the LCD screen.">lcd_init</a> </dd></dl>
65

  
66
</div>
67
</div><p>
68
<a class="anchor" name="gac280d714190003871937d3d92af3a29"></a><!-- doxytag: member="lcd.c::lcd_gotoxy" ref="gac280d714190003871937d3d92af3a29" args="(int x, int y)" -->
69
<div class="memitem">
70
<div class="memproto">
71
      <table class="memname">
79 72
        <tr>
80
          <td class="md" nowrap valign="top">void lcd_gotoxy           </td>
81
          <td class="md" valign="top">(&nbsp;</td>
82
          <td class="md" nowrap valign="top">int&nbsp;</td>
83
          <td class="mdname" nowrap> <em>x</em>, </td>
73
          <td class="memname">void lcd_gotoxy           </td>
74
          <td>(</td>
75
          <td class="paramtype">int&nbsp;</td>
76
          <td class="paramname"> <em>x</em>, </td>
84 77
        </tr>
85 78
        <tr>
86
          <td class="md" nowrap align="right"></td>
87
          <td class="md"></td>
88
          <td class="md" nowrap>int&nbsp;</td>
89
          <td class="mdname" nowrap> <em>y</em></td>
79
          <td class="paramkey"></td>
80
          <td></td>
81
          <td class="paramtype">int&nbsp;</td>
82
          <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
90 83
        </tr>
91 84
        <tr>
92
          <td class="md"></td>
93
          <td class="md">)&nbsp;</td>
94
          <td class="md" colspan="2"></td>
85
          <td></td>
86
          <td>)</td>
87
          <td></td><td></td><td width="100%"></td>
95 88
        </tr>
96 89
      </table>
97
    </td>
98
  </tr>
99
</table>
100
<table cellspacing="5" cellpadding="0" border="0">
101
  <tr>
102
    <td>
103
      &nbsp;
104
    </td>
105
    <td>
90
</div>
91
<div class="memdoc">
106 92

  
107 93
<p>
108 94
Set the current cursor position. 
......
114 100
    <tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>The y coordinate of the new position</td></tr>
115 101
  </table>
116 102
</dl>
117
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__lcd.html#g6842775ba83d166f02b8fef8bb63b1e6">lcd_init</a> </dd></dl>
118
    </td>
119
  </tr>
120
</table>
121
<a class="anchor" name="g6842775ba83d166f02b8fef8bb63b1e6"></a><!-- doxytag: member="lcd.c::lcd_init" ref="g6842775ba83d166f02b8fef8bb63b1e6" args="(void)" --><p>
122
<table class="mdTable" cellpadding="2" cellspacing="0">
123
  <tr>
124
    <td class="mdRow">
125
      <table cellpadding="0" cellspacing="0" border="0">
103
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__lcd.html#g6842775ba83d166f02b8fef8bb63b1e6" title="Initialize the LCD screen.">lcd_init</a> </dd></dl>
104

  
105
</div>
106
</div><p>
107
<a class="anchor" name="g6842775ba83d166f02b8fef8bb63b1e6"></a><!-- doxytag: member="lcd.c::lcd_init" ref="g6842775ba83d166f02b8fef8bb63b1e6" args="(void)" -->
108
<div class="memitem">
109
<div class="memproto">
110
      <table class="memname">
126 111
        <tr>
127
          <td class="md" nowrap valign="top">void lcd_init           </td>
128
          <td class="md" valign="top">(&nbsp;</td>
129
          <td class="md" nowrap valign="top">void&nbsp;</td>
130
          <td class="mdname1" valign="top" nowrap>          </td>
131
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
132
          <td class="md" nowrap></td>
112
          <td class="memname">void lcd_init           </td>
113
          <td>(</td>
114
          <td class="paramtype">void&nbsp;</td>
115
          <td class="paramname">          </td>
116
          <td>&nbsp;)&nbsp;</td>
117
          <td width="100%"></td>
133 118
        </tr>
134 119
      </table>
135
    </td>
136
  </tr>
137
</table>
138
<table cellspacing="5" cellpadding="0" border="0">
139
  <tr>
140
    <td>
141
      &nbsp;
142
    </td>
143
    <td>
120
</div>
121
<div class="memdoc">
144 122

  
145 123
<p>
146 124
Initialize the LCD screen. 
147 125
<p>
148
Initializes the LCD. Must be called before any other LCD functions.     </td>
149
  </tr>
150
</table>
151
<a class="anchor" name="gfa7e36b95c43d603f510273ad077cbbe"></a><!-- doxytag: member="lcd.c::lcd_putc" ref="gfa7e36b95c43d603f510273ad077cbbe" args="(char c)" --><p>
152
<table class="mdTable" cellpadding="2" cellspacing="0">
153
  <tr>
154
    <td class="mdRow">
155
      <table cellpadding="0" cellspacing="0" border="0">
126
Initializes the LCD. Must be called before any other LCD functions. 
127
</div>
128
</div><p>
129
<a class="anchor" name="gfa7e36b95c43d603f510273ad077cbbe"></a><!-- doxytag: member="lcd.c::lcd_putc" ref="gfa7e36b95c43d603f510273ad077cbbe" args="(char c)" -->
130
<div class="memitem">
131
<div class="memproto">
132
      <table class="memname">
156 133
        <tr>
157
          <td class="md" nowrap valign="top">void lcd_putc           </td>
158
          <td class="md" valign="top">(&nbsp;</td>
159
          <td class="md" nowrap valign="top">char&nbsp;</td>
160
          <td class="mdname1" valign="top" nowrap> <em>c</em>          </td>
161
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
162
          <td class="md" nowrap></td>
134
          <td class="memname">void lcd_putc           </td>
135
          <td>(</td>
136
          <td class="paramtype">char&nbsp;</td>
137
          <td class="paramname"> <em>c</em>          </td>
138
          <td>&nbsp;)&nbsp;</td>
139
          <td width="100%"></td>
163 140
        </tr>
164 141
      </table>
165
    </td>
166
  </tr>
167
</table>
168
<table cellspacing="5" cellpadding="0" border="0">
169
  <tr>
170
    <td>
171
      &nbsp;
172
    </td>
173
    <td>
142
</div>
143
<div class="memdoc">
174 144

  
175 145
<p>
176 146
Print a char to the LCD screen. 
......
181 151
    <tr><td valign="top"></td><td valign="top"><em>c</em>&nbsp;</td><td>the character to print</td></tr>
182 152
  </table>
183 153
</dl>
184
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__lcd.html#g6842775ba83d166f02b8fef8bb63b1e6">lcd_init</a> </dd></dl>
185
    </td>
186
  </tr>
187
</table>
188
<a class="anchor" name="g0150085af3123e80303a3445821acb40"></a><!-- doxytag: member="lcd.c::lcd_puti" ref="g0150085af3123e80303a3445821acb40" args="(int value)" --><p>
189
<table class="mdTable" cellpadding="2" cellspacing="0">
190
  <tr>
191
    <td class="mdRow">
192
      <table cellpadding="0" cellspacing="0" border="0">
154
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__lcd.html#g6842775ba83d166f02b8fef8bb63b1e6" title="Initialize the LCD screen.">lcd_init</a> </dd></dl>
155

  
156
</div>
157
</div><p>
158
<a class="anchor" name="g0150085af3123e80303a3445821acb40"></a><!-- doxytag: member="lcd.c::lcd_puti" ref="g0150085af3123e80303a3445821acb40" args="(int value)" -->
159
<div class="memitem">
160
<div class="memproto">
161
      <table class="memname">
193 162
        <tr>
194
          <td class="md" nowrap valign="top">void lcd_puti           </td>
195
          <td class="md" valign="top">(&nbsp;</td>
196
          <td class="md" nowrap valign="top">int&nbsp;</td>
197
          <td class="mdname1" valign="top" nowrap> <em>value</em>          </td>
198
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
199
          <td class="md" nowrap></td>
163
          <td class="memname">void lcd_puti           </td>
164
          <td>(</td>
165
          <td class="paramtype">int&nbsp;</td>
166
          <td class="paramname"> <em>value</em>          </td>
167
          <td>&nbsp;)&nbsp;</td>
168
          <td width="100%"></td>
200 169
        </tr>
201 170
      </table>
202
    </td>
203
  </tr>
204
</table>
205
<table cellspacing="5" cellpadding="0" border="0">
206
  <tr>
207
    <td>
208
      &nbsp;
209
    </td>
210
    <td>
171
</div>
172
<div class="memdoc">
211 173

  
212 174
<p>
213 175
Print an int to the LCD screen. 
......
218 180
    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>the integer to print</td></tr>
219 181
  </table>
220 182
</dl>
221
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__lcd.html#g6842775ba83d166f02b8fef8bb63b1e6">lcd_init</a> </dd></dl>
222
    </td>
223
  </tr>
224
</table>
225
<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 26 17:39:31 2007 for libdragonfly by&nbsp;
183
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__lcd.html#g6842775ba83d166f02b8fef8bb63b1e6" title="Initialize the LCD screen.">lcd_init</a> </dd></dl>
184

  
185
</div>
186
</div><p>
187
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:15:40 2007 for libdragonfly by&nbsp;
226 188
<a href="http://www.doxygen.org/index.html">
227
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
189
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
228 190
</body>
229 191
</html>

Also available in: Unified diff