![](/media/cache/img/default_profile.jpg.50x50_q85.jpg)
1.44 tft lcd display
Dependencies: TFT_fonts mbed-os
Fork of newTFTLCD by
ssd1289.h@22:4c169297f374, 2013-01-26 (annotated)
- Committer:
- ttodorov
- Date:
- Sat Jan 26 04:36:46 2013 +0000
- Revision:
- 22:4c169297f374
- Parent:
- 20:4bdca8d8dadc
- Child:
- 24:ac6e35658037
- added PWM backlight control
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
ttodorov | 4:3ac4239f6c9c | 1 | /** \file ssd1289.h |
ttodorov | 0:881ff0b71102 | 2 | * \brief mbed TFT LCD controller for displays with the SSD1289 IC. |
ttodorov | 0:881ff0b71102 | 3 | * \copyright GNU Public License, v2. or later |
ttodorov | 0:881ff0b71102 | 4 | * |
ttodorov | 0:881ff0b71102 | 5 | * A known display with this type of controller chip is the ITDB02-3.2S |
ttodorov | 0:881ff0b71102 | 6 | * from http://imall.iteadstudio.com |
ttodorov | 0:881ff0b71102 | 7 | * |
ttodorov | 0:881ff0b71102 | 8 | * This library is based on the Arduino/chipKIT UTFT library by Henning |
ttodorov | 0:881ff0b71102 | 9 | * Karlsen, http://henningkarlsen.com/electronics/library.php?id=52 |
ttodorov | 0:881ff0b71102 | 10 | * |
ttodorov | 0:881ff0b71102 | 11 | * Copyright (C)2010-2012 Henning Karlsen. All right reserved. |
ttodorov | 5:09b6d228ceea | 12 | * |
ttodorov | 0:881ff0b71102 | 13 | * Copyright (C)2012 Todor Todorov. |
ttodorov | 0:881ff0b71102 | 14 | * |
ttodorov | 0:881ff0b71102 | 15 | * This library is free software; you can redistribute it and/or |
ttodorov | 0:881ff0b71102 | 16 | * modify it under the terms of the GNU Lesser General Public |
ttodorov | 0:881ff0b71102 | 17 | * License as published by the Free Software Foundation; either |
ttodorov | 0:881ff0b71102 | 18 | * version 2.1 of the License, or (at your option) any later version. |
ttodorov | 0:881ff0b71102 | 19 | * |
ttodorov | 0:881ff0b71102 | 20 | * This library is distributed in the hope that it will be useful, |
ttodorov | 0:881ff0b71102 | 21 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
ttodorov | 0:881ff0b71102 | 22 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
ttodorov | 0:881ff0b71102 | 23 | * Lesser General Public License for more details. |
ttodorov | 0:881ff0b71102 | 24 | * |
ttodorov | 0:881ff0b71102 | 25 | * You should have received a copy of the GNU Lesser General Public |
ttodorov | 0:881ff0b71102 | 26 | * License along with this library; if not, write to: |
ttodorov | 0:881ff0b71102 | 27 | * |
ttodorov | 0:881ff0b71102 | 28 | * Free Software Foundation, Inc. |
ttodorov | 0:881ff0b71102 | 29 | * 51 Franklin St, 5th Floor, Boston, MA 02110-1301, USA |
ttodorov | 0:881ff0b71102 | 30 | * |
ttodorov | 0:881ff0b71102 | 31 | *********************************************************************/ |
ttodorov | 3:64a5b67d5b51 | 32 | #ifndef TFTLCD_SSD1289_H |
ttodorov | 3:64a5b67d5b51 | 33 | #define TFTLCD_SSD1289_H |
ttodorov | 0:881ff0b71102 | 34 | |
ttodorov | 0:881ff0b71102 | 35 | #include "lcd_base.h" |
ttodorov | 0:881ff0b71102 | 36 | |
ttodorov | 6:059ca1648211 | 37 | #ifdef __cplusplus |
ttodorov | 6:059ca1648211 | 38 | extern "C" { |
ttodorov | 6:059ca1648211 | 39 | #endif |
ttodorov | 6:059ca1648211 | 40 | |
ttodorov | 3:64a5b67d5b51 | 41 | /** Represents a LCD instance. |
ttodorov | 3:64a5b67d5b51 | 42 | * |
ttodorov | 3:64a5b67d5b51 | 43 | * This is the utility class, through which the display can be manipulated |
ttodorov | 3:64a5b67d5b51 | 44 | * and graphics objects can be shown to the user. A known display, which |
ttodorov | 3:64a5b67d5b51 | 45 | * works with this library is the ITDB02-3.2S from iTeadStudio - a RGB TFT |
ttodorov | 3:64a5b67d5b51 | 46 | * with 240x320 pixels resolution and 65K colors, using 16-bit interface. |
ttodorov | 3:64a5b67d5b51 | 47 | * |
ttodorov | 4:3ac4239f6c9c | 48 | * The display needs 20 to 22 pins to work with mbed, so it is possibly not |
ttodorov | 3:64a5b67d5b51 | 49 | * the best of choices out there, but other than that it uses +3.3V for |
ttodorov | 3:64a5b67d5b51 | 50 | * power and logic, as well as the backlight, thus can be interfaced directly |
ttodorov | 3:64a5b67d5b51 | 51 | * to the mbed without the need of shields or level shifters as with Arduino. |
ttodorov | 3:64a5b67d5b51 | 52 | * |
ttodorov | 3:64a5b67d5b51 | 53 | * How to use: |
ttodorov | 3:64a5b67d5b51 | 54 | * \code |
ttodorov | 3:64a5b67d5b51 | 55 | * // include the library, this will also pull in the header for the provided fonts |
ttodorov | 3:64a5b67d5b51 | 56 | * #include "ssd1289.h" |
ttodorov | 3:64a5b67d5b51 | 57 | * |
ttodorov | 3:64a5b67d5b51 | 58 | * // prepare the data bus for writing commands and pixel data |
ttodorov | 3:64a5b67d5b51 | 59 | * BusOut dataBus( p30, p29, p28, p27, p26, p25, p24, p23, p22, p21, p20, p19, p18, p17, p16, p15 ); // 16 pins |
ttodorov | 3:64a5b67d5b51 | 60 | * // create the lcd instance |
ttodorov | 4:3ac4239f6c9c | 61 | * SSD1289_LCD lcd( p14, p13, p12, p11, &dataBus ); // control pins and data bus |
ttodorov | 3:64a5b67d5b51 | 62 | * |
ttodorov | 3:64a5b67d5b51 | 63 | * int main() |
ttodorov | 3:64a5b67d5b51 | 64 | * { |
ttodorov | 3:64a5b67d5b51 | 65 | * // initialize display - place it in standard portrait mode and set background to black and |
ttodorov | 3:64a5b67d5b51 | 66 | * // foreground to white color. |
ttodorov | 3:64a5b67d5b51 | 67 | * lcd.Initialize(); |
ttodorov | 3:64a5b67d5b51 | 68 | * // set current font to the smallest 8x12 pixels font. |
ttodorov | 3:64a5b67d5b51 | 69 | * lcd.SetFont( Font8x12 ); |
ttodorov | 3:64a5b67d5b51 | 70 | * // print something on the screen |
ttodorov | 3:64a5b67d5b51 | 71 | * lcd.Print( "Hello, World!", CENTER, 25 ); // align text to center horizontally and use starndard colors |
ttodorov | 3:64a5b67d5b51 | 72 | * |
ttodorov | 3:64a5b67d5b51 | 73 | * while ( 1 ) { } |
ttodorov | 3:64a5b67d5b51 | 74 | * } |
ttodorov | 3:64a5b67d5b51 | 75 | * |
ttodorov | 3:64a5b67d5b51 | 76 | * \endcode |
ttodorov | 3:64a5b67d5b51 | 77 | * \version 0.1 |
ttodorov | 3:64a5b67d5b51 | 78 | * \author Todor Todorov |
ttodorov | 3:64a5b67d5b51 | 79 | */ |
ttodorov | 4:3ac4239f6c9c | 80 | class SSD1289_LCD : public LCD |
ttodorov | 0:881ff0b71102 | 81 | { |
ttodorov | 0:881ff0b71102 | 82 | public: |
ttodorov | 0:881ff0b71102 | 83 | /** Creates a new instance of the class. |
ttodorov | 0:881ff0b71102 | 84 | * |
ttodorov | 0:881ff0b71102 | 85 | * \param CS Pin for the ChipSelect signal. |
ttodorov | 0:881ff0b71102 | 86 | * \param RESET Pin for the RESET line. |
ttodorov | 0:881ff0b71102 | 87 | * \param RS Pin for the RS signal. |
ttodorov | 0:881ff0b71102 | 88 | * \param WR Pin for the WR signal. |
ttodorov | 0:881ff0b71102 | 89 | * \param DATA_PORT Address of the data bus for transfer of commands and pixel data. |
ttodorov | 4:3ac4239f6c9c | 90 | * \param BL Pin for controlling the backlight. By default not used. |
ttodorov | 0:881ff0b71102 | 91 | * \param RD Pin for the RD signal. This line is not needed by the driver, so if you would like to |
ttodorov | 0:881ff0b71102 | 92 | * use the pin on the mbed for something else, just pull-up the respective pin on the LCD high, |
ttodorov | 0:881ff0b71102 | 93 | * and do not assign a value to this parameter when creating the controller instance. |
ttodorov | 22:4c169297f374 | 94 | * \param blType The backlight type, the default is to utilize the pin - if supplied - as a simple on/off switch |
ttodorov | 22:4c169297f374 | 95 | * \param defaultBacklightLevel If using PWM to control backlight, this would be the default brightness in percent after LCD initialization. |
ttodorov | 0:881ff0b71102 | 96 | */ |
ttodorov | 22:4c169297f374 | 97 | SSD1289_LCD( PinName CS, PinName RESET, PinName RS, PinName WR, BusOut* DATA_PORT, PinName BL = NC, PinName RD = NC, backlight_t blType = Constant, float defaultBackLightLevel = 1.0 ); |
ttodorov | 0:881ff0b71102 | 98 | |
ttodorov | 0:881ff0b71102 | 99 | /** Initialize display. |
ttodorov | 0:881ff0b71102 | 100 | * |
ttodorov | 0:881ff0b71102 | 101 | * Wakes up the display from sleep, initializes power parameters. |
ttodorov | 0:881ff0b71102 | 102 | * This function must be called first, befor any painting on the |
ttodorov | 0:881ff0b71102 | 103 | * display is done, otherwise the positioning of graphical elements |
ttodorov | 0:881ff0b71102 | 104 | * will not work properly and any paynt operation will not be visible |
ttodorov | 0:881ff0b71102 | 105 | * or produce garbage. |
ttodorov | 0:881ff0b71102 | 106 | * |
ttodorov | 0:881ff0b71102 | 107 | * \param oritentation The display orientation, landscape is default. |
ttodorov | 12:d0978272a340 | 108 | * \param colors The correct color depth to use for the pixel data. Value is disregarded. |
ttodorov | 0:881ff0b71102 | 109 | */ |
ttodorov | 12:d0978272a340 | 110 | virtual void Initialize( orientation_t orientation = LANDSCAPE, colordepth_t colors = RGB16 ); |
ttodorov | 0:881ff0b71102 | 111 | |
ttodorov | 4:3ac4239f6c9c | 112 | /** Puts the display to sleep. |
ttodorov | 4:3ac4239f6c9c | 113 | * |
ttodorov | 4:3ac4239f6c9c | 114 | * When the display is in sleep mode, its power consumption is |
ttodorov | 4:3ac4239f6c9c | 115 | * minimized. Before new pixel data can be written to the display |
ttodorov | 4:3ac4239f6c9c | 116 | * memory, the controller needs to be brought out of sleep mode. |
ttodorov | 4:3ac4239f6c9c | 117 | * \sa #WakeUp( void ); |
ttodorov | 4:3ac4239f6c9c | 118 | * \remarks The result of this operation might not be exactly as |
ttodorov | 4:3ac4239f6c9c | 119 | * expected. Putting the display to sleep will cause the |
ttodorov | 4:3ac4239f6c9c | 120 | * controller to switch to the standard color of the LCD, |
ttodorov | 4:3ac4239f6c9c | 121 | * so depending on whether the display is normally white, |
ttodorov | 4:3ac4239f6c9c | 122 | * or normally dark, the screen might or might not go |
ttodorov | 4:3ac4239f6c9c | 123 | * dark. Additional power saving can be achieved, if |
ttodorov | 4:3ac4239f6c9c | 124 | * the backlight of the used display is not hardwired on |
ttodorov | 4:3ac4239f6c9c | 125 | * the PCB and can be controlled via the BL pin. |
ttodorov | 4:3ac4239f6c9c | 126 | */ |
ttodorov | 4:3ac4239f6c9c | 127 | virtual void Sleep( void ); |
ttodorov | 4:3ac4239f6c9c | 128 | |
ttodorov | 4:3ac4239f6c9c | 129 | /** Wakes up the display from sleep mode. |
ttodorov | 4:3ac4239f6c9c | 130 | * |
ttodorov | 4:3ac4239f6c9c | 131 | * This function needs to be called before any other, when the |
ttodorov | 4:3ac4239f6c9c | 132 | * display has been put into sleep mode by a previois call to |
ttodorov | 4:3ac4239f6c9c | 133 | * #Sleep( void ). |
ttodorov | 4:3ac4239f6c9c | 134 | */ |
ttodorov | 4:3ac4239f6c9c | 135 | virtual void WakeUp( void ); |
ttodorov | 4:3ac4239f6c9c | 136 | |
ttodorov | 0:881ff0b71102 | 137 | protected: |
ttodorov | 4:3ac4239f6c9c | 138 | /** Sends a command to the display. |
ttodorov | 4:3ac4239f6c9c | 139 | * |
ttodorov | 4:3ac4239f6c9c | 140 | * \param cmd The display command. |
ttodorov | 4:3ac4239f6c9c | 141 | * \remarks Commands are controller-specific and this function needs to |
ttodorov | 4:3ac4239f6c9c | 142 | * be implemented separately for each available controller. |
ttodorov | 4:3ac4239f6c9c | 143 | */ |
ttodorov | 2:81ed304b7e9b | 144 | virtual void WriteCmd( unsigned short cmd ); |
ttodorov | 4:3ac4239f6c9c | 145 | |
ttodorov | 4:3ac4239f6c9c | 146 | /** Sends pixel data to the display. |
ttodorov | 4:3ac4239f6c9c | 147 | * |
ttodorov | 4:3ac4239f6c9c | 148 | * \param data The display data. |
ttodorov | 4:3ac4239f6c9c | 149 | * \remarks Sendin data is controller-specific and this function needs to |
ttodorov | 4:3ac4239f6c9c | 150 | * be implemented separately for each available controller. |
ttodorov | 4:3ac4239f6c9c | 151 | */ |
ttodorov | 2:81ed304b7e9b | 152 | virtual void WriteData( unsigned short data ); |
ttodorov | 4:3ac4239f6c9c | 153 | |
ttodorov | 4:3ac4239f6c9c | 154 | /** Assigns a chunk of the display memory to receive data. |
ttodorov | 4:3ac4239f6c9c | 155 | * |
ttodorov | 4:3ac4239f6c9c | 156 | * When data is sent to the display after this function completes, the opertion will |
ttodorov | 4:3ac4239f6c9c | 157 | * start from the begining of the assigned address (pixel position) and the pointer |
ttodorov | 4:3ac4239f6c9c | 158 | * will be automatically incremented so that the next data write operation will continue |
ttodorov | 4:3ac4239f6c9c | 159 | * with the next pixel from the memory block. If more data is written than available |
ttodorov | 4:3ac4239f6c9c | 160 | * pixels, at the end of the block the pointer will jump back to its beginning and |
ttodorov | 4:3ac4239f6c9c | 161 | * commence again, until the next address change command is sent to the display. |
ttodorov | 4:3ac4239f6c9c | 162 | * |
ttodorov | 4:3ac4239f6c9c | 163 | * \param x1 The X coordinate of the pixel at the beginning of the block. |
ttodorov | 4:3ac4239f6c9c | 164 | * \param y1 The Y coordinate of the pixel at the beginning of the block. |
ttodorov | 4:3ac4239f6c9c | 165 | * \param x2 The X coordinate of the pixel at the end of the block. |
ttodorov | 4:3ac4239f6c9c | 166 | * \param y2 The Y coordinate of the pixel at the end of the block. |
ttodorov | 4:3ac4239f6c9c | 167 | * \remarks Addressing commands are controller-specific and this function needs to be |
ttodorov | 4:3ac4239f6c9c | 168 | * implemented separately for each available controller. |
ttodorov | 4:3ac4239f6c9c | 169 | */ |
ttodorov | 20:4bdca8d8dadc | 170 | virtual void SetXY( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2 ); |
ttodorov | 0:881ff0b71102 | 171 | |
ttodorov | 10:69571adcfad5 | 172 | /** Sets the color of the pixel at the address pointer of the controller. |
ttodorov | 10:69571adcfad5 | 173 | * |
ttodorov | 10:69571adcfad5 | 174 | * This function is to be provided by each implementation separately in |
ttodorov | 10:69571adcfad5 | 175 | * order to account for different color depth used by the controller. |
ttodorov | 10:69571adcfad5 | 176 | * \param color The color of the pixel. |
ttodorov | 20:4bdca8d8dadc | 177 | * \param mode The depth (palette) of the color. |
ttodorov | 10:69571adcfad5 | 178 | */ |
ttodorov | 20:4bdca8d8dadc | 179 | virtual void SetPixelColor( unsigned int color, colordepth_t mode = RGB24 ); |
ttodorov | 10:69571adcfad5 | 180 | |
ttodorov | 0:881ff0b71102 | 181 | private: |
ttodorov | 4:3ac4239f6c9c | 182 | DigitalOut _lcd_pin_wr; |
ttodorov | 4:3ac4239f6c9c | 183 | BusOut* _lcd_port; |
ttodorov | 4:3ac4239f6c9c | 184 | DigitalOut* _lcd_pin_bl; |
ttodorov | 0:881ff0b71102 | 185 | DigitalOut* _lcd_pin_rd; |
ttodorov | 0:881ff0b71102 | 186 | }; |
ttodorov | 0:881ff0b71102 | 187 | |
ttodorov | 6:059ca1648211 | 188 | #ifdef __cplusplus |
ttodorov | 6:059ca1648211 | 189 | } |
ttodorov | 6:059ca1648211 | 190 | #endif |
ttodorov | 6:059ca1648211 | 191 | |
ttodorov | 3:64a5b67d5b51 | 192 | #endif /* TFTLCD_SSD1289_H */ |