mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
136 lines
11 KiB
HTML
136 lines
11 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<title>ArduinoLibs: Main Page</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<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"/>
|
|
</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">
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">ArduinoLibs</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li class="current"><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<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">
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">ArduinoLibs Documentation</div> </div>
|
|
</div>
|
|
<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>
|
|
<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>
|
|
<ul>
|
|
<li><a class="el" href="classDMD.html" title="Handle large dot matrix displays composed of LED'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's.">DMD</a> display. </li>
|
|
<li><a class="el" href="dmd_demo.html">Demo</a> that shows off various bitmap drawing features. </li>
|
|
<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>
|
|
<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'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>
|
|
<li><a class="el" href="classCharlieplex.html" title="Manage an array of LED's in a charlieplexed arrangement.">Charlieplex</a> class that manages a matrix of LED's arranged in a <a href="http://en.wikipedia.org/wiki/Charlieplexing">Charlieplexing</a> arrangement. </li>
|
|
<li><a class="el" href="blink_blink.html">Blink</a> example of using <a class="el" href="classBlinkLED.html" title="Blink a LED on a digital output pin.">BlinkLED</a>. </li>
|
|
<li><a class="el" href="blink_cylon.html">Cylon</a> example of using <a class="el" href="classChaseLEDs.html" title="Chase LED's on output pins in a defined sequence.">ChaseLEDs</a> to simulate the Cylon eye effect from Battlestar Galactica. </li>
|
|
<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>
|
|
<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>
|
|
</ul>
|
|
<h2><a class="anchor" id="main_RTC"></a>
|
|
Realtime Clock Library</h2>
|
|
<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>
|
|
<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'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>
|
|
<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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </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 Sun Jun 10 2012 10:51:56 for ArduinoLibs by 
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
|
|
</body>
|
|
</html>
|