LCD display
Fork of LCDLib by
TextLCD.h@20:5ab883d81a20, 2015-10-15 (annotated)
- Committer:
- madmonkeyman82
- Date:
- Thu Oct 15 15:59:36 2015 +0000
- Revision:
- 20:5ab883d81a20
- Parent:
- 15:dc4f024fd1aa
LCD
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
rlanghbv | 4:264d9b06bf60 | 1 | /* mbed TextLCD Library,4-bit 16x2 LCD for KS0066U |
rlanghbv | 6:c80d81c3be4d | 2 | * Copyright (c) 2015 Rune Langøy |
rlanghbv | 4:264d9b06bf60 | 3 | * |
rlanghbv | 4:264d9b06bf60 | 4 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
rlanghbv | 4:264d9b06bf60 | 5 | * of this software and associated documentation files (the "Software"), to deal |
rlanghbv | 4:264d9b06bf60 | 6 | * in the Software without restriction, including without limitation the rights |
rlanghbv | 4:264d9b06bf60 | 7 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
rlanghbv | 4:264d9b06bf60 | 8 | * copies of the Software, and to permit persons to whom the Software is |
rlanghbv | 4:264d9b06bf60 | 9 | * furnished to do so, subject to the following conditions: |
rlanghbv | 1:8902f6be12a5 | 10 | * |
rlanghbv | 4:264d9b06bf60 | 11 | * The above copyright notice and this permission notice shall be included in |
rlanghbv | 4:264d9b06bf60 | 12 | * all copies or substantial portions of the Software. |
rlanghbv | 4:264d9b06bf60 | 13 | * |
rlanghbv | 4:264d9b06bf60 | 14 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
rlanghbv | 4:264d9b06bf60 | 15 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
rlanghbv | 4:264d9b06bf60 | 16 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
rlanghbv | 4:264d9b06bf60 | 17 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
rlanghbv | 4:264d9b06bf60 | 18 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
rlanghbv | 4:264d9b06bf60 | 19 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
rlanghbv | 4:264d9b06bf60 | 20 | * THE SOFTWARE. |
rlanghbv | 4:264d9b06bf60 | 21 | */ |
rlanghbv | 1:8902f6be12a5 | 22 | #ifndef LCD_H_ |
rlanghbv | 1:8902f6be12a5 | 23 | #define LCD_H_ |
rlanghbv | 4:264d9b06bf60 | 24 | |
rlanghbv | 6:c80d81c3be4d | 25 | /** A TextLCD interface for driving 4-bit 16x2 KS0066U LCD |
rlanghbv | 4:264d9b06bf60 | 26 | * |
rlanghbv | 14:393116a59d2f | 27 | * Simple example: |
rlanghbv | 4:264d9b06bf60 | 28 | * @code |
rlanghbv | 4:264d9b06bf60 | 29 | * #include "mbed.h" |
rlanghbv | 4:264d9b06bf60 | 30 | * #include "TextLCD.h" |
rlanghbv | 6:c80d81c3be4d | 31 | * |
rlanghbv | 4:264d9b06bf60 | 32 | * TextLCD lcd(D11,D10,D9,D5,D4,D3,D2); |
rlanghbv | 4:264d9b06bf60 | 33 | * int main() |
rlanghbv | 4:264d9b06bf60 | 34 | * { |
rlanghbv | 4:264d9b06bf60 | 35 | * lcd.gotoxy(1,1); |
rlanghbv | 4:264d9b06bf60 | 36 | * lcd.printf("Hello"); |
rlanghbv | 4:264d9b06bf60 | 37 | * |
rlanghbv | 4:264d9b06bf60 | 38 | * lcd.gotoxy(1,2); |
rlanghbv | 12:296a9b15ecd1 | 39 | * lcd.printf(" World"); |
rlanghbv | 4:264d9b06bf60 | 40 | * |
rlanghbv | 4:264d9b06bf60 | 41 | * while(1) { |
rlanghbv | 4:264d9b06bf60 | 42 | * wait_ms(300); |
rlanghbv | 4:264d9b06bf60 | 43 | * } |
rlanghbv | 4:264d9b06bf60 | 44 | * } |
rlanghbv | 4:264d9b06bf60 | 45 | * @endcode |
rlanghbv | 4:264d9b06bf60 | 46 | */ |
rlanghbv | 6:c80d81c3be4d | 47 | class TextLCD : public Stream |
rlanghbv | 1:8902f6be12a5 | 48 | { |
rlanghbv | 1:8902f6be12a5 | 49 | public: |
rlanghbv | 1:8902f6be12a5 | 50 | |
rlanghbv | 4:264d9b06bf60 | 51 | |
rlanghbv | 6:c80d81c3be4d | 52 | /** Create a TextLCD interface and initiated 16x2 char mode |
rlanghbv | 6:c80d81c3be4d | 53 | * |
rlanghbv | 6:c80d81c3be4d | 54 | * @param rs Instruction/data control line |
rlanghbv | 6:c80d81c3be4d | 55 | * @param rw Read/Write (is forced to '1') |
rlanghbv | 6:c80d81c3be4d | 56 | * @param e Enable line (clock) |
rlanghbv | 6:c80d81c3be4d | 57 | * @param d4-d7 Data lines for using as a 4-bit interface |
rlanghbv | 9:9529e943259c | 58 | * @param name I/O stream name (Optional) |
rlanghbv | 11:0af18f5aa473 | 59 | * Stream example: |
rlanghbv | 9:9529e943259c | 60 | * @code |
rlanghbv | 9:9529e943259c | 61 | * #include "mbed.h" |
rlanghbv | 9:9529e943259c | 62 | * #include "TextLCD.h" |
rlanghbv | 9:9529e943259c | 63 | * |
rlanghbv | 14:393116a59d2f | 64 | * TextLCD lcd(D11,D10,D9,D5,D4,D3,D2,"lcdOut"); |
rlanghbv | 9:9529e943259c | 65 | * int main() |
rlanghbv | 9:9529e943259c | 66 | * { |
rlanghbv | 9:9529e943259c | 67 | * freopen("/lcdOut", "w", stdout); |
rlanghbv | 9:9529e943259c | 68 | * printf("Hello World"); |
rlanghbv | 9:9529e943259c | 69 | * while(1) { |
rlanghbv | 9:9529e943259c | 70 | * wait_ms(300); |
rlanghbv | 9:9529e943259c | 71 | * } |
rlanghbv | 9:9529e943259c | 72 | * } |
rlanghbv | 11:0af18f5aa473 | 73 | * @endcode |
rlanghbv | 6:c80d81c3be4d | 74 | */ |
rlanghbv | 6:c80d81c3be4d | 75 | TextLCD(PinName rs,PinName rw, PinName e, PinName d4, PinName d5, |
rlanghbv | 15:dc4f024fd1aa | 76 | PinName d6, PinName d7,const char* name=NULL) ; |
rlanghbv | 6:c80d81c3be4d | 77 | |
rlanghbv | 6:c80d81c3be4d | 78 | /** Writes the low nible of data to the LCD-module |
rlanghbv | 6:c80d81c3be4d | 79 | * |
rlanghbv | 6:c80d81c3be4d | 80 | * @param data Writes the low-nible to the LCD data pins D4 to D7 |
rlanghbv | 6:c80d81c3be4d | 81 | */ |
rlanghbv | 6:c80d81c3be4d | 82 | void writeLcdBitD4toD7(char data); |
rlanghbv | 6:c80d81c3be4d | 83 | |
rlanghbv | 6:c80d81c3be4d | 84 | /** Writes a Command to the LCD-module |
rlanghbv | 4:264d9b06bf60 | 85 | * |
rlanghbv | 6:c80d81c3be4d | 86 | * @param cmd command to be sendt to the LCD-Controller |
rlanghbv | 4:264d9b06bf60 | 87 | */ |
madmonkeyman82 | 20:5ab883d81a20 | 88 | void lcdCommand(unsigned char cmd); |
rlanghbv | 6:c80d81c3be4d | 89 | |
rlanghbv | 6:c80d81c3be4d | 90 | |
rlanghbv | 6:c80d81c3be4d | 91 | /** Writes charecters to the LCD display |
rlanghbv | 6:c80d81c3be4d | 92 | * |
rlanghbv | 6:c80d81c3be4d | 93 | * @param data char to be sendt to the LCD-Controller |
rlanghbv | 6:c80d81c3be4d | 94 | */ |
rlanghbv | 6:c80d81c3be4d | 95 | void lcdData(unsigned char data); |
rlanghbv | 6:c80d81c3be4d | 96 | |
rlanghbv | 4:264d9b06bf60 | 97 | /** moves text cursor to a screen column and row |
rlanghbv | 4:264d9b06bf60 | 98 | * |
rlanghbv | 4:264d9b06bf60 | 99 | * @param column The horizontal position from the left, indexed from 0 |
rlanghbv | 4:264d9b06bf60 | 100 | * @param row The vertical position from the top, indexed from 0 |
rlanghbv | 4:264d9b06bf60 | 101 | */ |
rlanghbv | 4:264d9b06bf60 | 102 | void gotoxy(int , int ); |
rlanghbv | 6:c80d81c3be4d | 103 | #if DOXYGEN_ONLY |
rlanghbv | 6:c80d81c3be4d | 104 | /** Write a character to the LCD |
rlanghbv | 6:c80d81c3be4d | 105 | * |
rlanghbv | 6:c80d81c3be4d | 106 | * @param c The character to write to the display |
rlanghbv | 6:c80d81c3be4d | 107 | */ |
rlanghbv | 6:c80d81c3be4d | 108 | int putc(int c); |
rlanghbv | 6:c80d81c3be4d | 109 | |
rlanghbv | 6:c80d81c3be4d | 110 | /** Write a formatted string to the LCD |
rlanghbv | 6:c80d81c3be4d | 111 | * |
rlanghbv | 6:c80d81c3be4d | 112 | * @param format A printf-style format string, followed by the |
rlanghbv | 6:c80d81c3be4d | 113 | * variables to use in formatting the string. |
rlanghbv | 6:c80d81c3be4d | 114 | */ |
rlanghbv | 6:c80d81c3be4d | 115 | int printf(const char* format, ...); |
rlanghbv | 6:c80d81c3be4d | 116 | #endif |
rlanghbv | 4:264d9b06bf60 | 117 | protected: |
rlanghbv | 4:264d9b06bf60 | 118 | // EN = 1 for L-to-H / |
rlanghbv | 4:264d9b06bf60 | 119 | // EN = 0 for H-to-L |
rlanghbv | 4:264d9b06bf60 | 120 | // Causes the LCD-module to read the data on the data input pins |
rlanghbv | 4:264d9b06bf60 | 121 | void pulseEn(); |
rlanghbv | 1:8902f6be12a5 | 122 | //Enable 4 bit mode From KS0066U Documentation |
rlanghbv | 1:8902f6be12a5 | 123 | void init_4BitMode2LinesDisplayOn(); |
rlanghbv | 6:c80d81c3be4d | 124 | |
rlanghbv | 1:8902f6be12a5 | 125 | // Stream implementation functions |
rlanghbv | 1:8902f6be12a5 | 126 | virtual int _putc(int value); |
rlanghbv | 1:8902f6be12a5 | 127 | virtual int _getc(); |
rlanghbv | 6:c80d81c3be4d | 128 | |
rlanghbv | 3:d2f70de20dbe | 129 | DigitalOut LCD_RS,LCD_RW,LCD_EN; |
rlanghbv | 8:b12188ddd403 | 130 | BusOut LCD_D4to7; |
rlanghbv | 1:8902f6be12a5 | 131 | }; |
rlanghbv | 1:8902f6be12a5 | 132 | |
rlanghbv | 1:8902f6be12a5 | 133 | #endif /* LCD_H_ */ |