Project

General

Profile

Revision 862

Added by Kevin Woo over 15 years ago

Updated analog.c and analog.h documentation and regenerated the docs. No need to remake the library as its just comments.

View differences:

group__dio.html
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.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>
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>
16 18
</div>
19
<div class="contents">
17 20
<h1>Digital Input / Output</h1>Controls digital input and output.  
18 21
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
19 22
<tr><td></td></tr>
......
308 311
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if button1 has been pressed, 0 otherwise</dd></dl>
309 312
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__dio.html#gedac5cd2a11710ab4294de2ae4efe989" title="Check if button1 is pressed.">button1_read</a>, <a class="el" href="group__dio.html#g63755dc896b16e09d5223cada174d87b" title="Wait until button1 is pressed.">button1_wait</a> </dd></dl>
310 313

  
314
<p>References <a class="el" href="dio_8c-source.html#l00238">button1_read()</a>.</p>
315

  
311 316
</div>
312 317
</div><p>
313 318
<a class="anchor" name="gedac5cd2a11710ab4294de2ae4efe989"></a><!-- doxytag: member="dio.h::button1_read" ref="gedac5cd2a11710ab4294de2ae4efe989" args="(void)" -->
......
333 338
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if button1 is pressed, 0 otherwise</dd></dl>
334 339
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__dio.html#g63755dc896b16e09d5223cada174d87b" title="Wait until button1 is pressed.">button1_wait</a>, <a class="el" href="group__dio.html#g1f8648caa59384d58fc157d8933f4be5" title="Check if button1 is clicked.">button1_click</a> </dd></dl>
335 340

  
341
<p>Referenced by <a class="el" href="dio_8c-source.html#l00265">button1_click()</a>, and <a class="el" href="dio_8c-source.html#l00251">button1_wait()</a>.</p>
342

  
336 343
</div>
337 344
</div><p>
338 345
<a class="anchor" name="g63755dc896b16e09d5223cada174d87b"></a><!-- doxytag: member="dio.h::button1_wait" ref="g63755dc896b16e09d5223cada174d87b" args="(void)" -->
......
357 364
Delays execution until button1 is pressed.<p>
358 365
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__dio.html#gedac5cd2a11710ab4294de2ae4efe989" title="Check if button1 is pressed.">button1_read</a>, <a class="el" href="group__dio.html#g1f8648caa59384d58fc157d8933f4be5" title="Check if button1 is clicked.">button1_click</a> </dd></dl>
359 366

  
367
<p>References <a class="el" href="dio_8c-source.html#l00238">button1_read()</a>, and <a class="el" href="time_8c-source.html#l00104">delay_ms()</a>.</p>
368

  
360 369
</div>
361 370
</div><p>
362 371
<a class="anchor" name="g4147c347b473bd41c0a0f02af4dd39f2"></a><!-- doxytag: member="dio.h::button2_click" ref="g4147c347b473bd41c0a0f02af4dd39f2" args="(void)" -->
......
382 391
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if button2 has been pressed, 0 otherwise</dd></dl>
383 392
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__dio.html#g65e4c13e999fdfa9da3394d0175f17aa" title="Check if button2 is pressed.">button2_read</a>, <a class="el" href="group__dio.html#g4971f4473e759bcff2e2758e75bcdbe8" title="Wait until button2 is pressed.">button2_wait</a> </dd></dl>
384 393

  
394
<p>References <a class="el" href="dio_8c-source.html#l00281">button2_read()</a>.</p>
395

  
385 396
</div>
386 397
</div><p>
387 398
<a class="anchor" name="g65e4c13e999fdfa9da3394d0175f17aa"></a><!-- doxytag: member="dio.h::button2_read" ref="g65e4c13e999fdfa9da3394d0175f17aa" args="(void)" -->
......
407 418
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if button2 is pressed, 0 otherwise</dd></dl>
408 419
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__dio.html#g4971f4473e759bcff2e2758e75bcdbe8" title="Wait until button2 is pressed.">button2_wait</a>, <a class="el" href="group__dio.html#g4147c347b473bd41c0a0f02af4dd39f2" title="Check if button2 is clicked.">button2_click</a> </dd></dl>
409 420

  
421
<p>Referenced by <a class="el" href="dio_8c-source.html#l00308">button2_click()</a>, and <a class="el" href="dio_8c-source.html#l00294">button2_wait()</a>.</p>
422

  
410 423
</div>
411 424
</div><p>
412 425
<a class="anchor" name="g4971f4473e759bcff2e2758e75bcdbe8"></a><!-- doxytag: member="dio.h::button2_wait" ref="g4971f4473e759bcff2e2758e75bcdbe8" args="(void)" -->
......
431 444
Delays execution until button2 is pressed.<p>
432 445
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__dio.html#g65e4c13e999fdfa9da3394d0175f17aa" title="Check if button2 is pressed.">button2_read</a>, <a class="el" href="group__dio.html#g4147c347b473bd41c0a0f02af4dd39f2" title="Check if button2 is clicked.">button2_click</a> </dd></dl>
433 446

  
447
<p>References <a class="el" href="dio_8c-source.html#l00281">button2_read()</a>, and <a class="el" href="time_8c-source.html#l00104">delay_ms()</a>.</p>
448

  
434 449
</div>
435 450
</div><p>
436 451
<a class="anchor" name="g6202143ed6d0f809095c21bfac32acdd"></a><!-- doxytag: member="dio.h::digital_input" ref="g6202143ed6d0f809095c21bfac32acdd" args="(int)" -->
......
460 475
</dl>
461 476
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 or 0, depending on the value of the portpin. </dd></dl>
462 477

  
478
<p>References <a class="el" href="dio_8h-source.html#l00056">_PORT_A</a>, <a class="el" href="dio_8h-source.html#l00058">_PORT_B</a>, <a class="el" href="dio_8h-source.html#l00060">_PORT_C</a>, <a class="el" href="dio_8h-source.html#l00062">_PORT_D</a>, <a class="el" href="dio_8h-source.html#l00064">_PORT_E</a>, <a class="el" href="dio_8h-source.html#l00066">_PORT_F</a>, and <a class="el" href="dio_8h-source.html#l00068">_PORT_G</a>.</p>
479

  
463 480
</div>
464 481
</div><p>
465 482
<a class="anchor" name="g67967857dcc26aeea8cdd0a53a9e138d"></a><!-- doxytag: member="dio.h::digital_output" ref="g67967857dcc26aeea8cdd0a53a9e138d" args="(int bit, int val)" -->
......
498 515
  </table>
499 516
</dl>
500 517

  
518
<p>References <a class="el" href="dio_8h-source.html#l00056">_PORT_A</a>, <a class="el" href="dio_8h-source.html#l00058">_PORT_B</a>, <a class="el" href="dio_8h-source.html#l00060">_PORT_C</a>, <a class="el" href="dio_8h-source.html#l00062">_PORT_D</a>, <a class="el" href="dio_8h-source.html#l00064">_PORT_E</a>, <a class="el" href="dio_8h-source.html#l00066">_PORT_F</a>, and <a class="el" href="dio_8h-source.html#l00068">_PORT_G</a>.</p>
519

  
520
<p>Referenced by <a class="el" href="bom_8c-source.html#l00218">bom_leds_off()</a>, <a class="el" href="bom_8c-source.html#l00195">bom_leds_on()</a>, and <a class="el" href="rangefinder_8c-source.html#l00119">range_init()</a>.</p>
521

  
501 522
</div>
502 523
</div><p>
503 524
<a class="anchor" name="g6bcadb9200f988ae733a51aa70467978"></a><!-- doxytag: member="dio.h::digital_pull_up" ref="g6bcadb9200f988ae733a51aa70467978" args="(int)" -->
......
526 547
  </table>
527 548
</dl>
528 549

  
550
<p>References <a class="el" href="dio_8h-source.html#l00056">_PORT_A</a>, <a class="el" href="dio_8h-source.html#l00058">_PORT_B</a>, <a class="el" href="dio_8h-source.html#l00060">_PORT_C</a>, <a class="el" href="dio_8h-source.html#l00062">_PORT_D</a>, <a class="el" href="dio_8h-source.html#l00064">_PORT_E</a>, <a class="el" href="dio_8h-source.html#l00066">_PORT_F</a>, and <a class="el" href="dio_8h-source.html#l00068">_PORT_G</a>.</p>
551

  
529 552
</div>
530 553
</div><p>
531
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 6 20:27:38 2008 for libdragonfly by&nbsp;
554
</div>
555
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 26 13:39:28 2008 for libdragonfly by&nbsp;
532 556
<a href="http://www.doxygen.org/index.html">
533
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
557
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
534 558
</body>
535 559
</html>

Also available in: Unified diff