| User | Revision | Line number | New contents of line |
|---|
| Markus_Paar |
0:48870d877970
|
1
|
/* mbed TextLCD Library, for a 4-bit LCD based on HD44780
|
| Markus_Paar |
0:48870d877970
|
2
|
* Copyright (c) 2007-2010, sford, http://mbed.org
|
| Markus_Paar |
0:48870d877970
|
3
|
*
|
| Markus_Paar |
0:48870d877970
|
4
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
| Markus_Paar |
0:48870d877970
|
5
|
* of this software and associated documentation files (the "Software"), to deal
|
| Markus_Paar |
0:48870d877970
|
6
|
* in the Software without restriction, including without limitation the rights
|
| Markus_Paar |
0:48870d877970
|
7
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
| Markus_Paar |
0:48870d877970
|
8
|
* copies of the Software, and to permit persons to whom the Software is
|
| Markus_Paar |
0:48870d877970
|
9
|
* furnished to do so, subject to the following conditions:
|
| Markus_Paar |
0:48870d877970
|
10
|
*
|
| Markus_Paar |
0:48870d877970
|
11
|
* The above copyright notice and this permission notice shall be included in
|
| Markus_Paar |
0:48870d877970
|
12
|
* all copies or substantial portions of the Software.
|
| Markus_Paar |
0:48870d877970
|
13
|
*
|
| Markus_Paar |
0:48870d877970
|
14
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| Markus_Paar |
0:48870d877970
|
15
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| Markus_Paar |
0:48870d877970
|
16
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| Markus_Paar |
0:48870d877970
|
17
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| Markus_Paar |
0:48870d877970
|
18
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
| Markus_Paar |
0:48870d877970
|
19
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
| Markus_Paar |
0:48870d877970
|
20
|
* THE SOFTWARE.
|
| Markus_Paar |
0:48870d877970
|
21
|
*/
|
| Markus_Paar |
0:48870d877970
|
22
|
|
| Markus_Paar |
0:48870d877970
|
23
|
#ifndef MBED_TEXTLCD_H
|
| Markus_Paar |
0:48870d877970
|
24
|
#define MBED_TEXTLCD_H
|
| Markus_Paar |
0:48870d877970
|
25
|
|
| Markus_Paar |
0:48870d877970
|
26
|
#include "mbed.h"
|
| Markus_Paar |
0:48870d877970
|
27
|
|
| Markus_Paar |
0:48870d877970
|
28
|
/** A TextLCD interface for driving 4-bit HD44780-based LCDs
|
| Markus_Paar |
0:48870d877970
|
29
|
*
|
| Markus_Paar |
0:48870d877970
|
30
|
* Currently supports 16x2, 20x2 and 20x4 panels
|
| Markus_Paar |
0:48870d877970
|
31
|
*
|
| Markus_Paar |
0:48870d877970
|
32
|
* @code
|
| Markus_Paar |
0:48870d877970
|
33
|
* #include "mbed.h"
|
| Markus_Paar |
0:48870d877970
|
34
|
* #include "TextLCD.h"
|
| Markus_Paar |
0:48870d877970
|
35
|
*
|
| Markus_Paar |
0:48870d877970
|
36
|
* TextLCD lcd(p10, p12, p15, p16, p29, p30); // rs, e, d4-d7
|
| Markus_Paar |
0:48870d877970
|
37
|
*
|
| Markus_Paar |
0:48870d877970
|
38
|
* int main() {
|
| Markus_Paar |
0:48870d877970
|
39
|
* lcd.printf("Hello World!\n");
|
| Markus_Paar |
0:48870d877970
|
40
|
* }
|
| Markus_Paar |
0:48870d877970
|
41
|
* @endcode
|
| Markus_Paar |
0:48870d877970
|
42
|
*/
|
| Markus_Paar |
0:48870d877970
|
43
|
class TextLCD : public Stream {
|
| Markus_Paar |
0:48870d877970
|
44
|
public:
|
| Markus_Paar |
0:48870d877970
|
45
|
|
| Markus_Paar |
0:48870d877970
|
46
|
/** LCD panel format */
|
| Markus_Paar |
0:48870d877970
|
47
|
enum LCDType {
|
| Markus_Paar |
0:48870d877970
|
48
|
LCD16x2 /**< 16x2 LCD panel (default) */
|
| Markus_Paar |
0:48870d877970
|
49
|
, LCD16x2B /**< 16x2 LCD panel alternate addressing */
|
| Markus_Paar |
0:48870d877970
|
50
|
, LCD20x2 /**< 20x2 LCD panel */
|
| Markus_Paar |
0:48870d877970
|
51
|
, LCD20x4 /**< 20x4 LCD panel */
|
| Markus_Paar |
0:48870d877970
|
52
|
};
|
| Markus_Paar |
0:48870d877970
|
53
|
|
| Markus_Paar |
0:48870d877970
|
54
|
/** Create a TextLCD interface
|
| Markus_Paar |
0:48870d877970
|
55
|
*
|
| Markus_Paar |
0:48870d877970
|
56
|
* @param rs Instruction/data control line
|
| Markus_Paar |
0:48870d877970
|
57
|
* @param e Enable line (clock)
|
| Markus_Paar |
0:48870d877970
|
58
|
* @param d4-d7 Data lines for using as a 4-bit interface
|
| Markus_Paar |
0:48870d877970
|
59
|
* @param type Sets the panel size/addressing mode (default = LCD16x2)
|
| Markus_Paar |
0:48870d877970
|
60
|
*/
|
| Markus_Paar |
0:48870d877970
|
61
|
TextLCD(PinName rs, PinName e, PinName d4, PinName d5, PinName d6, PinName d7, LCDType type = LCD16x2);
|
| Markus_Paar |
0:48870d877970
|
62
|
|
| Markus_Paar |
0:48870d877970
|
63
|
#if DOXYGEN_ONLY
|
| Markus_Paar |
0:48870d877970
|
64
|
/** Write a character to the LCD
|
| Markus_Paar |
0:48870d877970
|
65
|
*
|
| Markus_Paar |
0:48870d877970
|
66
|
* @param c The character to write to the display
|
| Markus_Paar |
0:48870d877970
|
67
|
*/
|
| Markus_Paar |
0:48870d877970
|
68
|
int putc(int c);
|
| Markus_Paar |
0:48870d877970
|
69
|
|
| Markus_Paar |
0:48870d877970
|
70
|
/** Write a formated string to the LCD
|
| Markus_Paar |
0:48870d877970
|
71
|
*
|
| Markus_Paar |
0:48870d877970
|
72
|
* @param format A printf-style format string, followed by the
|
| Markus_Paar |
0:48870d877970
|
73
|
* variables to use in formating the string.
|
| Markus_Paar |
0:48870d877970
|
74
|
*/
|
| Markus_Paar |
0:48870d877970
|
75
|
int printf(const char* format, ...);
|
| Markus_Paar |
0:48870d877970
|
76
|
#endif
|
| Markus_Paar |
0:48870d877970
|
77
|
|
| Markus_Paar |
0:48870d877970
|
78
|
/** Locate to a screen column and row
|
| Markus_Paar |
0:48870d877970
|
79
|
*
|
| Markus_Paar |
0:48870d877970
|
80
|
* @param column The horizontal position from the left, indexed from 0
|
| Markus_Paar |
0:48870d877970
|
81
|
* @param row The vertical position from the top, indexed from 0
|
| Markus_Paar |
0:48870d877970
|
82
|
*/
|
| Markus_Paar |
0:48870d877970
|
83
|
void locate(int column, int row);
|
| Markus_Paar |
0:48870d877970
|
84
|
|
| Markus_Paar |
0:48870d877970
|
85
|
/** Clear the screen and locate to 0,0 */
|
| Markus_Paar |
0:48870d877970
|
86
|
void cls();
|
| Markus_Paar |
0:48870d877970
|
87
|
|
| Markus_Paar |
0:48870d877970
|
88
|
int rows();
|
| Markus_Paar |
0:48870d877970
|
89
|
int columns();
|
| Markus_Paar |
0:48870d877970
|
90
|
|
| Markus_Paar |
0:48870d877970
|
91
|
protected:
|
| Markus_Paar |
0:48870d877970
|
92
|
|
| Markus_Paar |
0:48870d877970
|
93
|
// Stream implementation functions
|
| Markus_Paar |
0:48870d877970
|
94
|
virtual int _putc(int value);
|
| Markus_Paar |
0:48870d877970
|
95
|
virtual int _getc();
|
| Markus_Paar |
0:48870d877970
|
96
|
|
| Markus_Paar |
0:48870d877970
|
97
|
int address(int column, int row);
|
| Markus_Paar |
0:48870d877970
|
98
|
void character(int column, int row, int c);
|
| Markus_Paar |
0:48870d877970
|
99
|
void writeByte(int value);
|
| Markus_Paar |
0:48870d877970
|
100
|
void writeCommand(int command);
|
| Markus_Paar |
0:48870d877970
|
101
|
void writeData(int data);
|
| Markus_Paar |
0:48870d877970
|
102
|
|
| Markus_Paar |
0:48870d877970
|
103
|
DigitalOut _rs, _e;
|
| Markus_Paar |
0:48870d877970
|
104
|
BusOut _d;
|
| Markus_Paar |
0:48870d877970
|
105
|
LCDType _type;
|
| Markus_Paar |
0:48870d877970
|
106
|
|
| Markus_Paar |
0:48870d877970
|
107
|
int _column;
|
| Markus_Paar |
0:48870d877970
|
108
|
int _row;
|
| Markus_Paar |
0:48870d877970
|
109
|
};
|
| Markus_Paar |
0:48870d877970
|
110
|
|
| Markus_Paar |
0:48870d877970
|
111
|
#endif
|
Markus Paar