Alphanumeric LCD Library for Arduino

Preparing to load PDF file. please wait...

0 of 0
100%
Alphanumeric LCD Library for Arduino

Transcript Of Alphanumeric LCD Library for Arduino

Alphanumeric LCD Library for Arduino
1.0.4
Generated by Doxygen 1.8.6
Tue Jan 27 2015 12:24:23

Contents

1 Alphanumeric Display Controller

1

1.1 Credits, Copyright and License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

2 Hierarchical Index

3

2.1 Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

3 Class Index

5

3.1 Class List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

4 File Index

7

4.1 File List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

5 Class Documentation

9

5.1 AlphaLCD Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

5.1.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

5.1.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

5.1.2.1 AlphaLCD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

5.1.2.2 AlphaLCD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

5.1.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

5.1.3.1 autoscroll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

5.1.3.2 begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

5.1.3.3 blink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

5.1.3.4 clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

5.1.3.5 command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

5.1.3.6 createChar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

5.1.3.7 cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

5.1.3.8 display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

5.1.3.9 home . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

5.1.3.10 init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

5.1.3.11 isAutoscroll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

5.1.3.12 isBlinking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

5.1.3.13 isCursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

5.1.3.14 isDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

iv

CONTENTS

5.1.3.15 isRightToLeft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 5.1.3.16 leftToRight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 5.1.3.17 noAutoscroll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 5.1.3.18 noBlink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 5.1.3.19 noCursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 5.1.3.20 noDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 5.1.3.21 rightToLeft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 5.1.3.22 scrollDisplayLeft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 5.1.3.23 scrollDisplayRight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 5.1.3.24 send . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 5.1.3.25 setCursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 5.1.3.26 write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 5.1.3.27 write4bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 5.1.3.28 write8bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 5.1.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 5.1.4.1 _backlight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 5.1.4.2 _clock_pin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 5.1.4.3 _currline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 5.1.4.4 _data_pin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 5.1.4.5 _displaycontrol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 5.1.4.6 _displayfunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 5.1.4.7 _displaymode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 5.1.4.8 _initialized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 5.1.4.9 _latch_pin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 5.1.4.10 _numlines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 5.1.4.11 _smart_enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

6 File Documentation

23

6.1 /Volumes/John Doe/Firmware/Arduino LIbraries/AlphaLCD/AlphaLCD.cpp File Reference . . . . . 23

6.1.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

6.2 /Volumes/John Doe/Firmware/Arduino LIbraries/AlphaLCD/AlphaLCD.h File Reference . . . . . . . 23

6.2.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

6.2.2 Macro Deļ¬nition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

6.2.2.1 LCD_1LINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

6.2.2.2 LCD_2LINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

6.2.2.3 LCD_4BITMODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

6.2.2.4 LCD_5x10DOTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

6.2.2.5 LCD_5x8DOTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

6.2.2.6 LCD_8BITMODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

6.2.2.7 LCD_BL_PIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Generated on Tue Jan 27 2015 12:24:23 for Alphanumeric LCD Library for Arduino by Doxygen

CONTENTS

v

Index

6.2.2.8 LCD_BLINKOFF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 6.2.2.9 LCD_BLINKON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 6.2.2.10 LCD_CLEARDISPLAY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 6.2.2.11 LCD_CURSORMOVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 6.2.2.12 LCD_CURSOROFF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 6.2.2.13 LCD_CURSORON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 6.2.2.14 LCD_CURSORSHIFT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 6.2.2.15 LCD_DISPLAYCONTROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 6.2.2.16 LCD_DISPLAYMOVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 6.2.2.17 LCD_DISPLAYOFF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 6.2.2.18 LCD_DISPLAYON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 6.2.2.19 LCD_EN_PIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 6.2.2.20 LCD_ENTRYLEFT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 6.2.2.21 LCD_ENTRYMODESET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 6.2.2.22 LCD_ENTRYRIGHT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 6.2.2.23 LCD_ENTRYSHIFTDECREMENT . . . . . . . . . . . . . . . . . . . . . . . . . 27 6.2.2.24 LCD_ENTRYSHIFTINCREMENT . . . . . . . . . . . . . . . . . . . . . . . . . 27 6.2.2.25 LCD_FUNCTIONSET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 6.2.2.26 LCD_MOVELEFT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 6.2.2.27 LCD_MOVERIGHT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 6.2.2.28 LCD_RETURNHOME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 6.2.2.29 LCD_RS_PIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 6.2.2.30 LCD_SETCGRAMADDR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 6.2.2.31 LCD_SETDDRAMADDR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
28

Generated on Tue Jan 27 2015 12:24:23 for Alphanumeric LCD Library for Arduino by Doxygen

Chapter 1
Alphanumeric Display Controller
This class controls the hardware LCD Alphanumeric display. The details on the usage and hardware features are described in the the Display datasheet component data sheet This library is a variant derived by the original Arduino ShiftLCD library with some improvements and more parametrization. For better readability and developers customization and usage a doxygen-based comment set has been added.
1.1 Credits, Copyright and License
Date January 2015
Version 2.0
Author Created by Enrico Miglino for Balearic Dynamics Spain Documentation revision by Maria Antonietta Ricagno Info and contacts: [email protected] - http://www.balearicdynamics.com
Note This software is licensed as open source under the GNU license.

2

Alphanumeric Display Controller

Generated on Tue Jan 27 2015 12:24:23 for Alphanumeric LCD Library for Arduino by Doxygen

Chapter 2
Hierarchical Index
2.1 Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically: Print AlphaLCD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4

Hierarchical Index

Generated on Tue Jan 27 2015 12:24:23 for Alphanumeric LCD Library for Arduino by Doxygen
Alphanumeric Lcd LibraryArduinoDescriptionCopyrightUsage