mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
94 lines
4.1 KiB
Plaintext
94 lines
4.1 KiB
Plaintext
/*
|
|
* Copyright (C) 2012 Southern Storm Software, Pty Ltd.
|
|
*
|
|
* 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:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included
|
|
* in all copies or substantial portions of the Software.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
/**
|
|
\file mainpage.dox
|
|
\mainpage
|
|
|
|
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>.
|
|
|
|
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>.
|
|
|
|
\section main_LCD Freetronics LCD Shield
|
|
|
|
\li LCD class to manage the extended features of the Freetronics
|
|
LCD shield.
|
|
\li Form and Field classes to build simple property sheet UI's on LCD displays.
|
|
\li \ref lcd_hello_world "Hello World" example for the Freetronics LCD shield.
|
|
\li \ref lcd_form "Form" example for LCD displays.
|
|
|
|
\section main_DMD Freetronics Large Dot Matrix Display (DMD)
|
|
|
|
\li DMD class to manage the initialize of the display.
|
|
\li Bitmap class to manage drawing to in-memory bitmaps and the DMD display.
|
|
\li \ref dmd_demo "Demo" that shows off various bitmap drawing features.
|
|
\li \ref dmd_running_figure "RunningFigure" example that demonstrates how
|
|
to draw and animate bitmaps.
|
|
|
|
\section main_BlinkLED BlinkLED Utility Library
|
|
|
|
\li BlinkLED class that simplifies the process of blinking a LED connected
|
|
to a output pin.
|
|
\li ChaseLEDs class that simplifies the process of performing a LED chase
|
|
over several output pins.
|
|
\li Charlieplex class that manages a matrix of LED's arranged in a
|
|
<a href="http://en.wikipedia.org/wiki/Charlieplexing">Charlieplexing</a>
|
|
arrangement.
|
|
\li \ref blink_blink "Blink" example of using BlinkLED.
|
|
\li \ref blink_cylon "Cylon" example of using ChaseLEDs to simulate
|
|
the Cylon eye effect from Battlestar Galactica.
|
|
\li \ref blink_startrek "StarTrek" example for lighting a starship
|
|
Enterprise model kit.
|
|
\li \ref blink_charlieplex "Charlieplex" example.
|
|
|
|
\section main_I2C I2C Utility Library
|
|
|
|
\li I2CMaster abstract class that provides an improved API for implementing an
|
|
I2C master.
|
|
\li SoftI2C 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.
|
|
|
|
\section main_RTC Realtime Clock Library
|
|
|
|
\li RTC 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
|
|
<tt>millis()</tt>.
|
|
\li DS1307RTC class that talks to the DS1307 realtime clock chip via I2C.
|
|
\li DS3232RTC class that talks to the DS3232 realtime clock chip via I2C.
|
|
\li \ref alarm_clock "Alarm Clock" example that uses the DS1307 or DS3232
|
|
realtime clock and the LCD library to implement an alarm clock.
|
|
|
|
\section main_other Other
|
|
|
|
\li Melody plays a melody on a digital output pin using <tt>tone()</tt>.
|
|
\li \ref power_save "Power saving utility functions"
|
|
|
|
*/
|