mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
Rename FreetronicsLCD to just LCD
This commit is contained in:
@@ -610,7 +610,7 @@ WARN_LOGFILE =
|
||||
# directories like "/usr/src/myproject". Separate the files or directories
|
||||
# with spaces.
|
||||
|
||||
INPUT = ../libraries/FreetronicsLCD ../libraries/BlinkLED ../libraries/I2C ../libraries/RTC ../libraries/Melody ../libraries/PowerSave .
|
||||
INPUT = ../libraries/LCD ../libraries/BlinkLED ../libraries/I2C ../libraries/RTC ../libraries/Melody ../libraries/PowerSave .
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
|
||||
@@ -688,7 +688,7 @@ EXAMPLE_RECURSIVE = NO
|
||||
# directories that contain image that are included in the documentation (see
|
||||
# the \image command).
|
||||
|
||||
IMAGE_PATH = ../libraries/BlinkLED/examples/Cylon ../libraries/BlinkLED/examples/Cylon4 ../libraries/BlinkLED/examples/StarTrek ../libraries/FreetronicsLCD/examples/HelloWorld ../libraries/FreetronicsLCD/examples/Form ../libraries/RTC/examples/AlarmClock
|
||||
IMAGE_PATH = ../libraries/BlinkLED/examples/Cylon ../libraries/BlinkLED/examples/Cylon4 ../libraries/BlinkLED/examples/StarTrek ../libraries/LCD/examples/HelloWorld ../libraries/LCD/examples/Form ../libraries/RTC/examples/AlarmClock
|
||||
|
||||
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
||||
# invoke to filter for each input file. Doxygen will invoke the filter program
|
||||
|
||||
@@ -27,7 +27,7 @@
|
||||
\section clock_features Features
|
||||
|
||||
The alarm clock described on this page is a large example application that
|
||||
uses many of the classes in the provided libraries: FreetronicsLCD, Form,
|
||||
uses many of the classes in the provided libraries: LCD, Form,
|
||||
Field, SoftI2C, DS1307RTC, Melody and \ref power_save "PowerSave".
|
||||
The clock has the following features:
|
||||
|
||||
|
||||
@@ -37,14 +37,14 @@ buttons are used to modify the value of the currently-displayed field.
|
||||
|
||||
We start by including the classes from the library that we will need:
|
||||
|
||||
\dontinclude FreetronicsLCD/examples/Form/Form.pde
|
||||
\skip FreetronicsLCD.h
|
||||
\dontinclude LCD/examples/Form/Form.pde
|
||||
\skip LCD.h
|
||||
\until BoolField.h
|
||||
|
||||
Next, we initialize the LCD display, create the main form, and populate
|
||||
it with fields:
|
||||
|
||||
\dontinclude FreetronicsLCD/examples/Form/Form.pde
|
||||
\dontinclude LCD/examples/Form/Form.pde
|
||||
\skip lcd;
|
||||
\until lcd;
|
||||
\skip mainForm
|
||||
@@ -77,7 +77,7 @@ duration between 0 and 24 hours.
|
||||
Now that we have defined our form, we need to initialize the program and
|
||||
show it for the first time:
|
||||
|
||||
\dontinclude FreetronicsLCD/examples/Form/Form.pde
|
||||
\dontinclude LCD/examples/Form/Form.pde
|
||||
\skip STATUS_LED
|
||||
\until }
|
||||
|
||||
@@ -86,10 +86,10 @@ given time. To switch to another form, call Form::hide() on the old
|
||||
form and Form::show() on the new form.
|
||||
|
||||
All that remains is to define our application's \c loop function which
|
||||
retrieves button events from FreetronicsLCD::getButton() and dispatches them
|
||||
retrieves button events from LCD::getButton() and dispatches them
|
||||
to the form:
|
||||
|
||||
\dontinclude FreetronicsLCD/examples/Form/Form.pde
|
||||
\dontinclude LCD/examples/Form/Form.pde
|
||||
\skip loop()
|
||||
\until }
|
||||
\until }
|
||||
@@ -97,5 +97,5 @@ to the form:
|
||||
|
||||
The full source code for the example follows:
|
||||
|
||||
\include FreetronicsLCD/examples/Form/Form.pde
|
||||
\include LCD/examples/Form/Form.pde
|
||||
*/
|
||||
|
||||
@@ -24,20 +24,20 @@
|
||||
\file lcd-helloworld.dox
|
||||
\page lcd_hello_world Hello World for Freetronics LCD
|
||||
|
||||
The FreetronicsLCD class provides an enhanced version of the standard
|
||||
The LCD class provides an enhanced version of the standard
|
||||
Arduino <a href="http://arduino.cc/en/Reference/LiquidCrystal">LiquidCrystal</a>
|
||||
library that supports the additional features of the
|
||||
<a href="http://www.freetronics.com/pages/16x2-lcd-shield-quickstart-guide">Freetronics LCD</a> shield;
|
||||
namely the back light and the Up, Down, Left, Right, and Select buttons.
|
||||
This tutorial explains how to use the FreetronicsLCD class to perform
|
||||
This tutorial explains how to use the LCD class to perform
|
||||
basic text output and to use the enhanced shield features.
|
||||
|
||||
\image html HelloWorld.png
|
||||
|
||||
We start by including the library and initializing it:
|
||||
|
||||
\dontinclude FreetronicsLCD/examples/HelloWorld/HelloWorld.pde
|
||||
\skip FreetronicsLCD.h
|
||||
\dontinclude LCD/examples/HelloWorld/HelloWorld.pde
|
||||
\skip LCD.h
|
||||
\until lcd
|
||||
|
||||
Unlike the LiquidCrystal library we don't normally need to specify the pin
|
||||
@@ -47,39 +47,39 @@ with the USBDroid and the D9 pin is reassigned as described on
|
||||
would look something like this instead:
|
||||
|
||||
\code
|
||||
FreetronicsLCD lcd(A1);
|
||||
LCD lcd(A1);
|
||||
\endcode
|
||||
|
||||
The next step is to enable the screen saver and print some text
|
||||
in the \c setup function:
|
||||
|
||||
\dontinclude FreetronicsLCD/examples/HelloWorld/HelloWorld.pde
|
||||
\dontinclude LCD/examples/HelloWorld/HelloWorld.pde
|
||||
\skip setup()
|
||||
\until }
|
||||
|
||||
The screen saver is a built-in feature of the FreetronicsLCD class that
|
||||
The screen saver is a built-in feature of the LCD class that
|
||||
turns off the display and the back light after a specific timeout
|
||||
(the default is 10 seconds). Pressing any of the keys on the shield
|
||||
or calling FreetronicsLCD::display() will wake up the screen again.
|
||||
or calling LCD::display() will wake up the screen again.
|
||||
|
||||
In the program's \c loop function we print the number of seconds
|
||||
since startup to the second line of the LCD display:
|
||||
|
||||
\dontinclude FreetronicsLCD/examples/HelloWorld/HelloWorld.pde
|
||||
\dontinclude LCD/examples/HelloWorld/HelloWorld.pde
|
||||
\skip loop()
|
||||
\until millis()
|
||||
|
||||
We then print the name of the button that is currently pressed:
|
||||
|
||||
\dontinclude FreetronicsLCD/examples/HelloWorld/HelloWorld.pde
|
||||
\dontinclude LCD/examples/HelloWorld/HelloWorld.pde
|
||||
\skip setCursor(8, 1)
|
||||
\until }
|
||||
|
||||
The FreetronicsLCD::getButton() function returns the key that has
|
||||
The LCD::getButton() function returns the key that has
|
||||
been pressed or released, or LCD_BUTTON_NONE if no key has been
|
||||
pressed or released this time through the loop.
|
||||
|
||||
The full source code for the example follows:
|
||||
|
||||
\include FreetronicsLCD/examples/HelloWorld/HelloWorld.pde
|
||||
\include LCD/examples/HelloWorld/HelloWorld.pde
|
||||
*/
|
||||
|
||||
@@ -27,9 +27,9 @@
|
||||
Utility libraries for enhanced use of standard Arduino main boards
|
||||
and shields.
|
||||
|
||||
\section main_FreeTronics Freetronics LCD Shield
|
||||
\section main_LCD Freetronics LCD Shield
|
||||
|
||||
\li FreetronicsLCD class to manage the extended features of the Freetronics
|
||||
\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.
|
||||
@@ -67,7 +67,7 @@ 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 \ref alarm_clock "Alarm Clock" example that uses the DS1307
|
||||
realtime clock and the FreetronicsLCD library to implement an alarm clock.
|
||||
realtime clock and the LCD library to implement an alarm clock.
|
||||
|
||||
\section main_other Other
|
||||
|
||||
|
||||
Reference in New Issue
Block a user