-
Notifications
You must be signed in to change notification settings - Fork 106
/
Adafruit_RGBLCDShield.h
221 lines (199 loc) · 6.73 KB
/
Adafruit_RGBLCDShield.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
/*!
* @file Adafruit_RGBLCDShield.h
*/
#ifndef Adafruit_RGBLCDShield_h
#define Adafruit_RGBLCDShield_h
#include "Print.h"
#include <inttypes.h>
#include <utility/Adafruit_MCP23017.h>
// commands
#define LCD_CLEARDISPLAY 0x01 //!< Clear display, set cursor position to zero
#define LCD_RETURNHOME 0x02 //!< Set cursor position to zero
#define LCD_ENTRYMODESET 0x04 //!< Sets the entry mode
#define LCD_DISPLAYCONTROL \
0x08 //!< Controls the display; allows you to do stuff like turn it on and off
#define LCD_CURSORSHIFT 0x10 //!< Lets you move the cursor
#define LCD_FUNCTIONSET 0x20 //!< Used to send the function set to the display
#define LCD_SETCGRAMADDR \
0x40 //!< Used to set the CGRAM (character generator RAM)
#define LCD_SETDDRAMADDR 0x80 //!< Used to set the DDRAM (display data RAM)
// flags for display entry mode
#define LCD_ENTRYRIGHT 0x00 //!< Used to set text to flow from right to left
#define LCD_ENTRYLEFT 0x02 //!< Used to set text to flow from left to right
#define LCD_ENTRYSHIFTINCREMENT \
0x01 //!< Used to 'right justify' text from the cursor
#define LCD_ENTRYSHIFTDECREMENT \
0x00 //!< USed to 'left justify' text from the cursor
// flags for display on/off control
#define LCD_DISPLAYON 0x04 //!< Turns the display on
#define LCD_DISPLAYOFF 0x00 //!< Turns the display off
#define LCD_CURSORON 0x02 //!< Turns the cursor on
#define LCD_CURSOROFF 0x00 //!< Turns the cursor off
#define LCD_BLINKON 0x01 //!< Turns on the blinking cursor
#define LCD_BLINKOFF 0x00 //!< Turns off the blinking cursor
// flags for display/cursor shift
#define LCD_DISPLAYMOVE 0x08 //!< Flag for moving the display
#define LCD_CURSORMOVE 0x00 //!< Flag for moving the cursor
#define LCD_MOVERIGHT 0x04 //!< Flag for moving right
#define LCD_MOVELEFT 0x00 //!< Flag for moving left
// flags for function set
#define LCD_8BITMODE 0x10 //!< LCD 8 bit mode
#define LCD_4BITMODE 0x00 //!< LCD 4 bit mode
#define LCD_2LINE 0x08 //!< LCD 2 line mode
#define LCD_1LINE 0x00 //!< LCD 1 line mode
#define LCD_5x10DOTS 0x04 //!< 10 pixel high font mode
#define LCD_5x8DOTS 0x00 //!< 8 pixel high font mode
#define BUTTON_UP 0x08 //!< Up button
#define BUTTON_DOWN 0x04 //!< Down button
#define BUTTON_LEFT 0x10 //!< Left button
#define BUTTON_RIGHT 0x02 //!< Right button
#define BUTTON_SELECT 0x01 //!< Select button
#ifdef ARDUINO_ARCH_MEGAAVR
using namespace arduino; //!< MEGA AVR architecture uses the arduino namespace
#endif //!< but AVR arch does not
/*!
* @brief Base class for RGB LCD shield
*/
class Adafruit_RGBLCDShield : public Print {
public:
Adafruit_RGBLCDShield();
/*!
* @brief RGB LCD shield constructor
* @param fourbitmode Sets the mode of the display, either 4 bit or 8 bit
* @param rs The reset data line
* @param rw The read write pin
* @param enable The enable data line
* @param d0 The data line 0
* @param d1 The data line 1
* @param d2 The data line 2
* @param d3 The data line 3
* @param d4 The data line 4
* @param d5 The data line 5
* @param d6 The data line 6
* @param d7 The data line 7
*/
void init(uint8_t fourbitmode, uint8_t rs, uint8_t rw, uint8_t enable,
uint8_t d0, uint8_t d1, uint8_t d2, uint8_t d3, uint8_t d4,
uint8_t d5, uint8_t d6, uint8_t d7);
/*!
* @brief Starts I2C connection with display
* @param cols Sets the number of columns
* @param rows Sets the number of rows
* @param charsize Sets the character size
* @return Returns true if the connection was successful
*/
void begin(uint8_t cols, uint8_t rows, uint8_t charsize = LCD_5x8DOTS);
/*!
* @brief High-level command to clear the display
*/
void clear();
/*!
* @brief High-level command to set the cursor position to zero
*/
void home();
/*!
* @brief High-level command to turn the display off
*/
void noDisplay();
/*!
* @brief High-level command to turn the display on
*/
void display();
/*!
* @brief High-level command to turn off the blinking cursor off
*/
void noBlink();
/*!
* @brief High-level command to turn on the blinking cursor
*/
void blink();
/*!
* @brief High-level command to turn the underline cursor off
*/
void noCursor();
/*!
* @brief High-level command to turn the underline cursor on
*/
void cursor();
/*!
* @brief High-level command to scroll display left without changing the RAM
*/
void scrollDisplayLeft();
/*!
* @brief High-level command to scroll display right without changing the RAM
*/
void scrollDisplayRight();
/*!
* @brief High-level command to make text flow right to left
*/
void leftToRight();
/*!
* @brief High-level command to make text flow left to right
*/
void rightToLeft();
/*!
* @brief High-level command to 'right justify' text from cursor
*/
void autoscroll();
/*!
* @brief High-level command to 'left justify' text from cursor
*/
void noAutoscroll();
/*!
* @brief High-level command to set the backlight, only if the LCD backpack is
* used
* @param status Status to set the backlight
*/
void setBacklight(uint8_t status);
/*!
* @brief High-level command that creates custom characters in CGRAM
* @param location Location in cgram to fill
* @param charmap[] Character map to use
*/
void createChar(uint8_t, uint8_t[]);
/*!
* @brief High-level command that sets the location of the cursor
* @param col Column to put the cursor in
* @param row Row to put the cursor in
*/
void setCursor(uint8_t, uint8_t);
#if ARDUINO >= 100
virtual size_t write(uint8_t);
#else
/*!
* @brief Mid-level command that sends data to the display
* @param value Data to send to the display
*/
virtual void write(uint8_t);
#endif
/*!
* @brief Sends command to display
* @param value Command to send
*/
void command(uint8_t);
/*!
* @brief reads the buttons from the shield
* @return Returns what buttons have been pressed
*/
uint8_t readButtons();
private:
void send(uint8_t, uint8_t);
void write4bits(uint8_t);
void write8bits(uint8_t);
void pulseEnable();
void _digitalWrite(uint8_t, uint8_t);
void _pinMode(uint8_t, uint8_t);
uint8_t _rs_pin; // LOW: command. HIGH: character.
uint8_t _rw_pin; // LOW: write to LCD. HIGH: read from LCD.
uint8_t _enable_pin; // activated by a HIGH pulse.
uint8_t _data_pins[8];
uint8_t _button_pins[5];
uint8_t _displayfunction;
uint8_t _displaycontrol;
uint8_t _displaymode;
uint8_t _initialized;
uint8_t _numlines, _currline;
uint8_t _i2cAddr;
Adafruit_MCP23017 _i2c;
};
#endif