This is a port of Henning Kralsen's UTFT library for Arduino/chipKIT to mbed, refactored to make full use of C++ inheritance and access control, in order to reduce work when implementing new drivers and at the same time make the code more readable and easier to maintain. As of now supported are SSD1289 (16-bit interface), HX8340-B (serial interface) and ST7735 (serial interface). Drivers for other controllers will be added as time and resources to acquire the displays to test the code permit.

Dependents:   test SDCard capstone_display capstone_display_2 ... more

TFTLCD Library

NOTE (2013-03-25) Tested with both mbed LPC1768 and Freedom KL25Z. -todor

A TFT LCD driver library, which at the moment provides support for the following display controllers: HX8340-B (serial interface), SSD1289 (16-bit interface), ST7735-R (serial interface), ILI9325/ILI9328 (16-bit interface).

As I am acquiring and testing out new displays, I decided to combine all ported drivers into one library as with the original work done by Henning. However I also had as a goal to make the code maintenance and readability easier/better, so the code has been heavily refactored to make full use of C++ facilities as inheritance and access control. I extracted the common pieces of code into a base class, which every driver inherits and only the controller-specific side is provided in the actual driver - things like initialization, addressing, data transfer, etc.

Another nice extension is that the display's backlight can now be controlled through the driver. Either a simple on/off method of control could be selected, or the brightness can be set through use of PWM (the latter placing some restrictions on which pins can be used for this, as mbed offers hardware PWM on only 6 pins).

I also plan to add support for touch screens as part of the library. The goal is to grow this piece of software into a lightweight graphics widgets library, which can be used to construct control screens with buttons or menus in a speedy and intuitive way.



  • Fixed the sleep/wake-up functions of the ILI9328 driver.


  • Added driver for ILI9328 (works with ILI9325) controller, 16-bit data bus. Screen rotation works as usual with the TFTLCD library, but for now only RGB565 color depth is working and you can use both 65K and 262K color space with this driver. But for some reason the sleep function is not behaving as expected; I am working on this.
  • This is only on my to-do list for now - haven't really had the time yet - but I am going to refactor the library a bit to allow use of GPIO ports for data transfers instead of DigitalOut: faster and cleaner that way. For those who are using it already in a working design and cannot repurpose the pins anymore, the current way it's working will still be available; I am hoping not to tear up the public interfaces of the library (... too much). Anyway, since I am at it, I will also try to add support for multiple bus interfaces to drivers that support it (i.e. both 8bit and 16bit use of ILI932x or SSD1289). Thought this might be a good place to give you guys the heads-up.


  • Replaced all existing fonts from the UTFT library with the free Terminus font. Two different sizes are provided: 8x12 pixels and 16x28 pixels. I found the old fonts not so good looking and then they supported only the ASCII codes in the range 30 (space) to 126 (the tilde ). The 7segment font didn't even implement anything else than the numbers from 0 to 9 - so it was unusable for anything (one couldn't even display the time or date as it lacked the colon [:] or the period [.] or the slash [/] or the space [ ] characters). So I completely revamped the fonts and added Terminus as the new default with its 2 sizes. Further more I added in both sizes most of the characters up to ASCII code 255. For any code not in there, the space character is substituted. In the case, when you already have provided your own fonts, please have a look at the API changes in the files <terminus.h> and <terminus.cpp>: I promise you whatever time you spent designing your own font, it is not wasted; you merely need to add a second array, which describes which ASCII codes are available in your font, and their byte offset in the original character bitmap array; and a struct to tie all parts together and describe the character size. I am sorry for breaking the old API, but you will like the change and new options it brings you. Now you can insert any char above 127 up to code 255 (if available, of course) with its hex representation, e.g displaying the current temperature would look something like 85\xB0 F or 26\xB0 C (the space in between degree and F or C is needed because both F and C are used in hex numbers, so \xB0F is interpreted as ASCII code 2831 instead of ASCII code 176, followed by the temperature scale denomination; if you insist on avoiding the space, you could write 85\xB0\x46 which will be displayed correctly as 85°F). You can either look up the ASCII code you need on Google or Bing, or just look at what's available - how it looks and its hex value - in the comments in <terminus.cpp>.
  • Added PWM backlight control. If you intend to use this, please make sure that control pin is either one of p21, p22, p23, p24, p25, or p26, as only they support hardware PWM. Please be aware that the mbed pins do not have much juice behind them, so if your display's backlight requires a lot of current, you are better off interfacing through as small signal transistor or a MOSFET. For the rest please consult the updated Doxygen documentation. NOTE The addition of PWM-controlled backlight will not break your existing code, the new options have default values, which initialize the used driver to behave as prior to PWM. Only if you want to use the new feature, some changes need to be made. The PWM is configured to be 120Hz (period of 8.33 milliseconds), in order to avoid noticeable flicker in the backlight. If in your opinion this value is too fine, then you can reduce the frequency in the LCD constructor in <lcd_base.cpp> by increasing the period value. My recommendation is to avoid frequencies lower than 60Hz.


  • Internal-only changes in the way drivers transmit colors - done to simplify the bitmap drawing routines; client API remains unchanged.


  • Added the driver for the ST7735 display controller.
  • Added the RGB18 color mode: choose between 16-bit (65K distinct colors) and 18-bit (262K distinct colors) color space [supported by all drivers]. NOTE This feature requires the image drawing functions to be changed, in order to account for differences between configured display color depth and the color depth of the image. Please review the API docs, in particular the new type bitmap_t and the DrawBitmap functions.
  • Changed display rotation to be achieved through the correspondent settings in the respective controller registers: no more software translation between width and height in different display orientations.
  • Extended the orientation options: PORTRAIT (top line to 12 o'clock/upright) and LANDSCAPE (top line to 9 o'clock) positions are the old options, PORTRAIT_REV (top line to 6 o'clock/upside-down) and LANDSCAPE_REV (top line to 3 o'clock) are the new orientations.


  • Finish implementing PWM-controlled backlight (current-sink configuration).
  • Add a driver for the HX8352-A controller (ITDB02-3.2WD 16:9 240x400 pixel resolution display).

How to Use

The code is documented, so please review the API docs. There is a simple example to get you started...

Sun Dec 02 05:44:52 2012 +0000
- renamed SSD1289 implementation; - refactored base class functions and removed redundant addressing; - added sleep and wake functions; - added HX8340B serial implementation; - fixed test case

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ttodorov 0:881ff0b71102 1 /*
ttodorov 0:881ff0b71102 2 * Copyright (C)2010-2012 Henning Karlsen. All right reserved.
ttodorov 0:881ff0b71102 3 * Copyright (C)2012 Todor Todorov.
ttodorov 0:881ff0b71102 4 *
ttodorov 0:881ff0b71102 5 * This library is free software; you can redistribute it and/or
ttodorov 0:881ff0b71102 6 * modify it under the terms of the GNU Lesser General Public
ttodorov 0:881ff0b71102 7 * License as published by the Free Software Foundation; either
ttodorov 0:881ff0b71102 8 * version 2.1 of the License, or (at your option) any later version.
ttodorov 0:881ff0b71102 9 *
ttodorov 0:881ff0b71102 10 * This library is distributed in the hope that it will be useful,
ttodorov 0:881ff0b71102 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ttodorov 0:881ff0b71102 13 * Lesser General Public License for more details.
ttodorov 0:881ff0b71102 14 *
ttodorov 0:881ff0b71102 15 * You should have received a copy of the GNU Lesser General Public
ttodorov 0:881ff0b71102 16 * License along with this library; if not, write to:
ttodorov 0:881ff0b71102 17 *
ttodorov 0:881ff0b71102 18 * Free Software Foundation, Inc.
ttodorov 0:881ff0b71102 19 * 51 Franklin St, 5th Floor, Boston, MA 02110-1301, USA
ttodorov 0:881ff0b71102 20 *
ttodorov 0:881ff0b71102 21 *********************************************************************/
ttodorov 3:64a5b67d5b51 22 #include "ssd1289.h"
ttodorov 3:64a5b67d5b51 23 #include "helpers.h"
ttodorov 0:881ff0b71102 24
ttodorov 4:3ac4239f6c9c 25 SSD1289_LCD::SSD1289_LCD( PinName CS, PinName RESET, PinName RS, PinName WR, BusOut* DATA_PORT, PinName BL, PinName RD )
ttodorov 4:3ac4239f6c9c 26 : LCD( 240, 320, CS, RS, RESET ), _lcd_pin_wr( WR )
ttodorov 0:881ff0b71102 27 {
ttodorov 0:881ff0b71102 28 _lcd_port = DATA_PORT;
ttodorov 4:3ac4239f6c9c 29 if ( BL != NC ) _lcd_pin_bl = new DigitalOut( BL );
ttodorov 4:3ac4239f6c9c 30 else _lcd_pin_bl = 0;
ttodorov 4:3ac4239f6c9c 31 if ( RD != NC ) _lcd_pin_rd = new DigitalOut( RD );
ttodorov 4:3ac4239f6c9c 32 else _lcd_pin_rd = 0;
ttodorov 0:881ff0b71102 33 }
ttodorov 0:881ff0b71102 34
ttodorov 4:3ac4239f6c9c 35 void SSD1289_LCD::Initialize( orientation_t orientation )
ttodorov 0:881ff0b71102 36 {
ttodorov 0:881ff0b71102 37 _orientation = orientation;
ttodorov 0:881ff0b71102 38
ttodorov 0:881ff0b71102 39 _lcd_pin_reset = HIGH;
ttodorov 0:881ff0b71102 40 wait_ms( 5 );
ttodorov 0:881ff0b71102 41 _lcd_pin_reset = LOW;
ttodorov 0:881ff0b71102 42 wait_ms( 15 );
ttodorov 0:881ff0b71102 43 _lcd_pin_reset = HIGH;
ttodorov 0:881ff0b71102 44 _lcd_pin_cs = HIGH;
ttodorov 4:3ac4239f6c9c 45 if ( _lcd_pin_bl != 0 )
ttodorov 4:3ac4239f6c9c 46 *_lcd_pin_bl = HIGH;
ttodorov 0:881ff0b71102 47 if ( _lcd_pin_rd != 0 )
ttodorov 0:881ff0b71102 48 *_lcd_pin_rd = HIGH;
ttodorov 0:881ff0b71102 49 _lcd_pin_wr = HIGH;
ttodorov 0:881ff0b71102 50 wait_ms( 15 );
ttodorov 0:881ff0b71102 51
ttodorov 4:3ac4239f6c9c 52 Activate();
ttodorov 2:81ed304b7e9b 53 WriteCmdData( 0x00, 0x0001 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 54 WriteCmdData( 0x03, 0xA8A4 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 55 WriteCmdData( 0x0C, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 56 WriteCmdData( 0x0D, 0x080C ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 57 WriteCmdData( 0x0E, 0x2B00 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 58 WriteCmdData( 0x1E, 0x00B7 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 59 WriteCmdData( 0x01, 0x2B3F ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 60 WriteCmdData( 0x02, 0x0600 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 61 WriteCmdData( 0x10, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 62 WriteCmdData( 0x11, 0x6070 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 63 WriteCmdData( 0x05, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 64 WriteCmdData( 0x06, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 65 WriteCmdData( 0x16, 0xEF1C ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 66 WriteCmdData( 0x17, 0x0003 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 67 WriteCmdData( 0x07, 0x0233 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 68 WriteCmdData( 0x0B, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 69 WriteCmdData( 0x0F, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 70 WriteCmdData( 0x41, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 71 WriteCmdData( 0x42, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 72 WriteCmdData( 0x48, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 73 WriteCmdData( 0x49, 0x013F ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 74 WriteCmdData( 0x4A, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 75 WriteCmdData( 0x4B, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 76 WriteCmdData( 0x44, 0xEF00 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 77 WriteCmdData( 0x45, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 78 WriteCmdData( 0x46, 0x013F ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 79 WriteCmdData( 0x30, 0x0707 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 80 WriteCmdData( 0x31, 0x0204 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 81 WriteCmdData( 0x32, 0x0204 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 82 WriteCmdData( 0x33, 0x0502 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 83 WriteCmdData( 0x34, 0x0507 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 84 WriteCmdData( 0x35, 0x0204 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 85 WriteCmdData( 0x36, 0x0204 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 86 WriteCmdData( 0x37, 0x0502 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 87 WriteCmdData( 0x3A, 0x0302 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 88 WriteCmdData( 0x3B, 0x0302 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 89 WriteCmdData( 0x23, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 90 WriteCmdData( 0x24, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 91 WriteCmdData( 0x25, 0x8000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 92 WriteCmdData( 0x4f, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 93 WriteCmdData( 0x4e, 0x0000 ); wait_ms( 1 );
ttodorov 2:81ed304b7e9b 94 WriteCmd( 0x22 );
ttodorov 4:3ac4239f6c9c 95 Deactivate();
ttodorov 0:881ff0b71102 96 }
ttodorov 0:881ff0b71102 97
ttodorov 4:3ac4239f6c9c 98 void SSD1289_LCD::Sleep( void )
ttodorov 0:881ff0b71102 99 {
ttodorov 4:3ac4239f6c9c 100 // TODO: figure out if the SSD1289 controller has sleep and wakeup commands
ttodorov 4:3ac4239f6c9c 101 if ( _lcd_pin_bl != 0 )
ttodorov 4:3ac4239f6c9c 102 *_lcd_pin_bl = LOW;
ttodorov 0:881ff0b71102 103 }
ttodorov 0:881ff0b71102 104
ttodorov 4:3ac4239f6c9c 105 void SSD1289_LCD::WakeUp( void )
ttodorov 4:3ac4239f6c9c 106 {
ttodorov 4:3ac4239f6c9c 107 // TODO: figure out if the SSD1289 controller has sleep and wakeup commands
ttodorov 4:3ac4239f6c9c 108 if ( _lcd_pin_bl != 0 )
ttodorov 4:3ac4239f6c9c 109 *_lcd_pin_bl = HIGH;
ttodorov 4:3ac4239f6c9c 110 }
ttodorov 4:3ac4239f6c9c 111
ttodorov 4:3ac4239f6c9c 112 void SSD1289_LCD::WriteCmd( unsigned short cmd )
ttodorov 4:3ac4239f6c9c 113 {
ttodorov 4:3ac4239f6c9c 114 _lcd_pin_rs = LOW;
ttodorov 4:3ac4239f6c9c 115 _lcd_port->write( cmd );
ttodorov 4:3ac4239f6c9c 116 pulseLow( _lcd_pin_wr );
ttodorov 4:3ac4239f6c9c 117 }
ttodorov 4:3ac4239f6c9c 118
ttodorov 4:3ac4239f6c9c 119 void SSD1289_LCD::WriteData( unsigned short data )
ttodorov 0:881ff0b71102 120 {
ttodorov 0:881ff0b71102 121 _lcd_pin_rs = HIGH;
ttodorov 0:881ff0b71102 122 _lcd_port->write( data );
ttodorov 0:881ff0b71102 123 pulseLow( _lcd_pin_wr );
ttodorov 0:881ff0b71102 124 }
ttodorov 0:881ff0b71102 125
ttodorov 4:3ac4239f6c9c 126 void SSD1289_LCD::SetXY( uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2 )
ttodorov 0:881ff0b71102 127 {
ttodorov 0:881ff0b71102 128 if ( _orientation == LANDSCAPE )
ttodorov 0:881ff0b71102 129 {
ttodorov 0:881ff0b71102 130 swap( uint16_t, x1, y1 )
ttodorov 0:881ff0b71102 131 swap( uint16_t, x2, y2 )
ttodorov 0:881ff0b71102 132 y1 = _disp_height - y1;
ttodorov 0:881ff0b71102 133 y2 = _disp_height - y2;
ttodorov 0:881ff0b71102 134 swap( uint16_t, y1, y2 )
ttodorov 0:881ff0b71102 135 }
ttodorov 0:881ff0b71102 136
ttodorov 2:81ed304b7e9b 137 WriteCmdData( 0x44, ( x2 << 8 ) + x1 );
ttodorov 2:81ed304b7e9b 138 WriteCmdData( 0x45, y1 );
ttodorov 2:81ed304b7e9b 139 WriteCmdData( 0x46, y2 );
ttodorov 2:81ed304b7e9b 140 WriteCmdData( 0x4e, x1 );
ttodorov 2:81ed304b7e9b 141 WriteCmdData( 0x4f, y1 );
ttodorov 2:81ed304b7e9b 142 WriteCmd( 0x22 );
ttodorov 0:881ff0b71102 143 }