taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2013-09-29 09:34:55 +10:00
parent 17f4fb4873
commit 8b7f9606ee
409 changed files with 21357 additions and 18181 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
index.html
View File

@@ -2,29 +2,37 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>ArduinoLibs: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ArduinoLibs</div>
<div id="projectname">ArduinoLibs
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
@@ -32,7 +40,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
@@ -50,24 +58,38 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">ArduinoLibs Documentation</div> </div>
</div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This distribution contains a bunch of libraries and example applications that I have made for Arduino, covering a variety of tasks from blinking LED's to LCD's and RTC-based alarm clocks. They are distributed under the terms of the MIT license, with the source code available from <a href="https://github.com/rweather/arduinolibs">github</a>.</p>
<p>For more information on these libraries, to report bugs, or to suggest improvements, please contact the author Rhys Weatherley via <a href="mailto:rhys.weatherley@gmail.com">email</a>.</p>
<h2><a class="anchor" id="main_LCD"></a>
LCD Shield</h2>
<div class="textblock"><p>This distribution contains a bunch of libraries and example applications that I have made for Arduino, covering a variety of tasks from blinking LED's to <a class="el" href="classLCD.html" title="Enhanced library for Freetronics 16x2 LCD shields.">LCD</a>'s and RTC-based alarm clocks. They are distributed under the terms of the MIT license, with the source code available from <a href="https://github.com/rweather/arduinolibs">github</a>.</p>
<p>For more information on these libraries, to report bugs, or to suggest improvements, please contact the author Rhys Weatherley via <a href="#" onclick="location.href='mai'+'lto:'+'rhy'+'s.'+'wea'+'th'+'erl'+'ey'+'@gm'+'ai'+'l.c'+'om'; return false;">email</a>.</p>
<h1><a class="anchor" id="main_LCD"></a>
LCD Shield</h1>
<ul>
<li><a class="el" href="classLCD.html" title="Enhanced library for Freetronics 16x2 LCD shields.">LCD</a> class to manage the extended features of the Freetronics and DFRobot <a class="el" href="classLCD.html" title="Enhanced library for Freetronics 16x2 LCD shields.">LCD</a> shields. </li>
<li><a class="el" href="classForm.html" title="Manager for a form containing data input/output fields.">Form</a> and <a class="el" href="classField.html" title="Manages a single data input/output field within a Form.">Field</a> classes to build simple property sheet UI's on <a class="el" href="classLCD.html" title="Enhanced library for Freetronics 16x2 LCD shields.">LCD</a> displays. </li>
<li><a class="el" href="lcd_hello_world.html">Hello World</a> example for the Freetronics <a class="el" href="classLCD.html" title="Enhanced library for Freetronics 16x2 LCD shields.">LCD</a> shield. </li>
<li><a class="el" href="lcd_form.html">Form</a> example for <a class="el" href="classLCD.html" title="Enhanced library for Freetronics 16x2 LCD shields.">LCD</a> displays.</li>
</ul>
<h2><a class="anchor" id="main_DMD"></a>
Freetronics Large Dot Matrix Display (DMD)</h2>
<h1><a class="anchor" id="main_DMD"></a>
Freetronics Large Dot Matrix Display (DMD)</h1>
<ul>
<li><a class="el" href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s.">DMD</a> class to manage the initialize of the display. </li>
<li><a class="el" href="classBitmap.html" title="Represents a monochrome bitmap within main memory.">Bitmap</a> class to manage drawing to in-memory bitmaps and the <a class="el" href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s.">DMD</a> display. </li>
@@ -75,8 +97,8 @@ Freetronics Large Dot Matrix Display (DMD)</h2>
<li><a class="el" href="dmd_running_figure.html">RunningFigure</a> example that demonstrates how to draw and animate bitmaps. </li>
<li><a class="el" href="ir_snake.html">Snake</a> game that combines the dot matrix display with <a class="el" href="classIRreceiver.html" title="Manages the reception of RC-5 commands from an infrared remote control.">IRreceiver</a> to make a simple video game.</li>
</ul>
<h2><a class="anchor" id="main_BlinkLED"></a>
BlinkLED Utility Library</h2>
<h1><a class="anchor" id="main_BlinkLED"></a>
BlinkLED Utility Library</h1>
<ul>
<li><a class="el" href="classBlinkLED.html" title="Blink a LED on a digital output pin.">BlinkLED</a> class that simplifies the process of blinking a LED connected to a output pin. </li>
<li><a class="el" href="classChaseLEDs.html" title="Chase LED&#39;s on output pins in a defined sequence.">ChaseLEDs</a> class that simplifies the process of performing a LED chase over several output pins. </li>
@@ -86,51 +108,40 @@ BlinkLED Utility Library</h2>
<li><a class="el" href="blink_startrek.html">StarTrek</a> example for lighting a starship Enterprise model kit. </li>
<li><a class="el" href="blink_charlieplex.html">Charlieplex</a> example.</li>
</ul>
<h2><a class="anchor" id="main_I2C"></a>
I2C Utility Library</h2>
<h1><a class="anchor" id="main_I2C"></a>
I2C Utility Library</h1>
<ul>
<li><a class="el" href="classI2CMaster.html" title="Abstract base class for I2C master implementations.">I2CMaster</a> abstract class that provides an improved API for implementing an I2C master. </li>
<li><a class="el" href="classSoftI2C.html" title="Bit-banged implementation of an I2C master.">SoftI2C</a> class that implements the master side of the I2C protocol in software on any arbitrary pair of pins for DATA and CLOCK. This class supports both 7-bit and 10-bit I2C addresses. </li>
<li><a class="el" href="classEEPROM24.html" title="Reading and writing EEPROM&#39;s from the 24LCXX family.">EEPROM24</a> class for reading and writing 24LCXX family EEPROM's.</li>
</ul>
<h2><a class="anchor" id="main_RTC"></a>
Realtime Clock Library</h2>
<h1><a class="anchor" id="main_RTC"></a>
Realtime Clock Library</h1>
<ul>
<li><a class="el" href="classRTC.html" title="Base class for realtime clock handlers.">RTC</a> class that acts as a base for all realtime clock implementations, including support for configuring alarms and storing clock settings. The default implementation simulates the time and date based on the value of <code>millis()</code>. </li>
<li><a class="el" href="classDS1307RTC.html" title="Communicates with a DS1307 realtime clock chip via I2C.">DS1307RTC</a> class that talks to the DS1307 realtime clock chip via I2C. </li>
<li><a class="el" href="classDS3232RTC.html" title="Communicates with a DS3232 realtime clock chip via I2C.">DS3232RTC</a> class that talks to the DS3232 realtime clock chip via I2C. </li>
<li><a class="el" href="alarm_clock.html">Alarm Clock</a> example that uses the DS1307 or DS3232 realtime clock and the <a class="el" href="classLCD.html" title="Enhanced library for Freetronics 16x2 LCD shields.">LCD</a> library to implement an alarm clock.</li>
</ul>
<h2><a class="anchor" id="main_IR"></a>
Infrared Control Library</h2>
<h1><a class="anchor" id="main_IR"></a>
Infrared Control Library</h1>
<ul>
<li><a class="el" href="classIRreceiver.html" title="Manages the reception of RC-5 commands from an infrared remote control.">IRreceiver</a> class that receives incoming RC-5 commands from an infrared remote control. </li>
<li><a class="el" href="ir_dumpir.html">DumpIR</a> example that dumps all incoming RC-5 commands. </li>
<li><a class="el" href="ir_snake.html">Snake</a> game that combines <a class="el" href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s.">DMD</a> with an infrared remote control to make a simple video game.</li>
</ul>
<h2><a class="anchor" id="main_other"></a>
Other</h2>
<h1><a class="anchor" id="main_other"></a>
Other</h1>
<ul>
<li><a class="el" href="classMelody.html" title="Plays a melody on a digital output pin using tone().">Melody</a> plays a melody on a digital output pin using <code>tone()</code>. </li>
<li><a class="el" href="group__power__save.html">Power saving utility functions</a> </li>
</ul>
</div></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Jun 18 2012 11:02:51 for ArduinoLibs by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 29 2013 09:30:46 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>