mirror of
https://github.com/taigrr/arduinolibs
synced 2025-01-18 04:33:12 -08:00
Add some images to the FreetronicsLCD docs
This commit is contained in:
parent
6769df8776
commit
45becdfc0e
@ -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
|
||||
IMAGE_PATH = ../libraries/BlinkLED/examples/Cylon ../libraries/BlinkLED/examples/Cylon4 ../libraries/BlinkLED/examples/StarTrek ../libraries/FreetronicsLCD/examples/HelloWorld ../libraries/FreetronicsLCD/examples/Form
|
||||
|
||||
# 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
|
||||
|
@ -33,6 +33,8 @@ The user interface is organised as a "form" which consists of one or more
|
||||
Right buttons are used to navigate between fields, and the Up and Down
|
||||
buttons are used to modify the value of the currently-displayed field.
|
||||
|
||||
\image html FormText.png
|
||||
|
||||
We start by including the classes from the library that we will need:
|
||||
|
||||
\dontinclude FreetronicsLCD/examples/Form/Form.pde
|
||||
|
@ -29,10 +29,12 @@ 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
|
||||
basic text output and to use the enhanced shield features. We start by
|
||||
including the library and initializing it:
|
||||
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
|
||||
|
@ -39,6 +39,8 @@
|
||||
* BoolField ledField(mainForm, "Status LED", "On", "Off", true);
|
||||
* \endcode
|
||||
*
|
||||
* \image html FormBool.png
|
||||
*
|
||||
* To actually toggle the LED, the application's main loop() function
|
||||
* should contain the following code:
|
||||
*
|
||||
|
@ -41,6 +41,8 @@
|
||||
* Form mainForm(lcd);
|
||||
* TextField welcomeField(mainForm, "Form example", "v1.0");
|
||||
* \endcode
|
||||
*
|
||||
* \image html FormText.png
|
||||
*/
|
||||
Form::Form(LiquidCrystal &lcd)
|
||||
: _lcd(&lcd)
|
||||
|
@ -49,6 +49,8 @@
|
||||
* IntField speedField(mainForm, "Speed", 0, 2000, 15, 450, " rpm");
|
||||
* \endcode
|
||||
*
|
||||
* \image html FormInt.png
|
||||
*
|
||||
* Use TextField for read-only fields that report integer values but
|
||||
* which are not modifiable by the user.
|
||||
*
|
||||
|
@ -34,6 +34,8 @@
|
||||
* TextField welcomeField(mainForm, "Form example", "v1.0");
|
||||
* \endcode
|
||||
*
|
||||
* \image html FormText.png
|
||||
*
|
||||
* As well as static messages, TextField can be used to display read-only
|
||||
* information that is computed at runtime:
|
||||
*
|
||||
|
@ -48,6 +48,8 @@
|
||||
* }
|
||||
* \endcode
|
||||
*
|
||||
* \image html FormTimeRO.png
|
||||
*
|
||||
* A read-write field can be used to ask the user for the duration of an
|
||||
* application count-down timer:
|
||||
*
|
||||
@ -55,6 +57,8 @@
|
||||
* TimeField durationField(mainForm, "Timer duration", 24, TIMEFIELD_READ_WRITE);
|
||||
* \endcode
|
||||
*
|
||||
* \image html FormTimeRW.png
|
||||
*
|
||||
* \sa Field
|
||||
*/
|
||||
|
||||
|
BIN
libraries/FreetronicsLCD/examples/Form/FormBool.png
Normal file
BIN
libraries/FreetronicsLCD/examples/Form/FormBool.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 502 KiB |
BIN
libraries/FreetronicsLCD/examples/Form/FormInt.png
Normal file
BIN
libraries/FreetronicsLCD/examples/Form/FormInt.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 400 KiB |
BIN
libraries/FreetronicsLCD/examples/Form/FormText.png
Normal file
BIN
libraries/FreetronicsLCD/examples/Form/FormText.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 475 KiB |
BIN
libraries/FreetronicsLCD/examples/Form/FormTimeRO.png
Normal file
BIN
libraries/FreetronicsLCD/examples/Form/FormTimeRO.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 485 KiB |
BIN
libraries/FreetronicsLCD/examples/Form/FormTimeRW.png
Normal file
BIN
libraries/FreetronicsLCD/examples/Form/FormTimeRW.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 453 KiB |
BIN
libraries/FreetronicsLCD/examples/HelloWorld/HelloWorld.png
Normal file
BIN
libraries/FreetronicsLCD/examples/HelloWorld/HelloWorld.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 518 KiB |
Loading…
x
Reference in New Issue
Block a user