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.

Changes

2013-07-21

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

2013-06-15

  • 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.

2013-01-25

  • 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.

2012-12-21

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

2012-12-12

  • 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.
  • Added more pre-defined colors: available now are COLOR_BLACK, COLOR_WHITE, COLOR_RED, COLOR_GREEN, COLOR_BLUE, COLOR_CYAN, COLOR_MAGENTA and COLOR_YELLOW.

TODO

  • 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...

Committer:
ttodorov
Date:
Tue Dec 11 03:18:43 2012 +0000
Revision:
10:69571adcfad5
Parent:
9:58b328831d0a
Child:
11:aeceefc5f9f2
- preliminary support for using 18-bit colors

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ttodorov 0:881ff0b71102 1 /** \file lcd_base.h
ttodorov 0:881ff0b71102 2 * \brief Base class for all LCD controller implementations.
ttodorov 0:881ff0b71102 3 * \copyright GNU Public License, v2. or later
ttodorov 0:881ff0b71102 4 *
ttodorov 0:881ff0b71102 5 * Generic object painting and screen control.
ttodorov 0:881ff0b71102 6 *
ttodorov 0:881ff0b71102 7 * This library is based on the Arduino/chipKIT UTFT library by Henning
ttodorov 0:881ff0b71102 8 * Karlsen, http://henningkarlsen.com/electronics/library.php?id=52
ttodorov 0:881ff0b71102 9 *
ttodorov 0:881ff0b71102 10 * Copyright (C)2010-2012 Henning Karlsen. All right reserved.
ttodorov 5:09b6d228ceea 11 *
ttodorov 0:881ff0b71102 12 * Copyright (C)2012 Todor Todorov.
ttodorov 0:881ff0b71102 13 *
ttodorov 0:881ff0b71102 14 * This library is free software; you can redistribute it and/or
ttodorov 0:881ff0b71102 15 * modify it under the terms of the GNU Lesser General Public
ttodorov 0:881ff0b71102 16 * License as published by the Free Software Foundation; either
ttodorov 0:881ff0b71102 17 * version 2.1 of the License, or (at your option) any later version.
ttodorov 0:881ff0b71102 18 *
ttodorov 0:881ff0b71102 19 * This library is distributed in the hope that it will be useful,
ttodorov 0:881ff0b71102 20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ttodorov 0:881ff0b71102 21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ttodorov 0:881ff0b71102 22 * Lesser General Public License for more details.
ttodorov 0:881ff0b71102 23 *
ttodorov 0:881ff0b71102 24 * You should have received a copy of the GNU Lesser General Public
ttodorov 0:881ff0b71102 25 * License along with this library; if not, write to:
ttodorov 0:881ff0b71102 26 *
ttodorov 0:881ff0b71102 27 * Free Software Foundation, Inc.
ttodorov 0:881ff0b71102 28 * 51 Franklin St, 5th Floor, Boston, MA 02110-1301, USA
ttodorov 0:881ff0b71102 29 *
ttodorov 0:881ff0b71102 30 *********************************************************************/
ttodorov 3:64a5b67d5b51 31 #ifndef TFTLCD_BASE_H
ttodorov 3:64a5b67d5b51 32 #define TFTLCD_BASE_H
ttodorov 0:881ff0b71102 33
ttodorov 0:881ff0b71102 34 #include "mbed.h"
ttodorov 0:881ff0b71102 35 #include "fonts.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 0:881ff0b71102 41 /** \def RGB(r,g,b)
ttodorov 0:881ff0b71102 42 * \brief Creates a RGB-565 color value.
ttodorov 0:881ff0b71102 43 *
ttodorov 0:881ff0b71102 44 * Displays which use 16 bits to assign colors to a specific pixel, use
ttodorov 0:881ff0b71102 45 * 5 bits for the red component, 6 bits for the green component and 5
ttodorov 0:881ff0b71102 46 * bits for the blue component. This macro converts the 3 full-size
ttodorov 0:881ff0b71102 47 * RGB bytes into one 16-bit RGB-565 value.
ttodorov 0:881ff0b71102 48 */
ttodorov 0:881ff0b71102 49 #define RGB( r, g, b ) ( ( ( ( r ) & 248 ) | ( ( g ) >> 5 ) ) << 8 ) | ( ( ( ( g ) & 28 ) << 3 ) | ( ( b ) >> 3 ) )
ttodorov 0:881ff0b71102 50 /** \def COLOR_BLACK
ttodorov 0:881ff0b71102 51 * \brief Shorthand for RGB( 0, 0, 0 ).
ttodorov 0:881ff0b71102 52 */
ttodorov 0:881ff0b71102 53 #define COLOR_BLACK RGB( 0x00, 0x00, 0x00 )
ttodorov 0:881ff0b71102 54 /** \def COLOR_WHITE
ttodorov 0:881ff0b71102 55 * \brief Shorthand for RGB( 255, 255, 255 ).
ttodorov 0:881ff0b71102 56 */
ttodorov 0:881ff0b71102 57 #define COLOR_WHITE RGB( 0xFF, 0xFF, 0xFF )
ttodorov 0:881ff0b71102 58 /** \def COLOR_RED
ttodorov 0:881ff0b71102 59 * \brief Shorthand for RGB( 255, 0, 0 ).
ttodorov 0:881ff0b71102 60 */
ttodorov 0:881ff0b71102 61 #define COLOR_RED RGB( 0xFF, 0x00, 0x00 )
ttodorov 0:881ff0b71102 62 /** \def COLOR_GREEN
ttodorov 0:881ff0b71102 63 * \brief Shorthand for RGB( 0, 255, 0 ).
ttodorov 0:881ff0b71102 64 */
ttodorov 0:881ff0b71102 65 #define COLOR_GREEN RGB( 0x00, 0xFF, 0x00 )
ttodorov 0:881ff0b71102 66 /** \def COLOR_BLUE
ttodorov 0:881ff0b71102 67 * \brief Shorthand for RGB( 0, 0, 255 ).
ttodorov 0:881ff0b71102 68 */
ttodorov 0:881ff0b71102 69 #define COLOR_BLUE RGB( 0x00, 0x00, 0xFF )
ttodorov 0:881ff0b71102 70
ttodorov 10:69571adcfad5 71 /** \enum Orientation_enum
ttodorov 0:881ff0b71102 72 * \brief Display orientation.
ttodorov 0:881ff0b71102 73 */
ttodorov 10:69571adcfad5 74 enum Orientation_enum
ttodorov 0:881ff0b71102 75 {
ttodorov 0:881ff0b71102 76 PORTRAIT = 0, /**< Display height is bigger than its width. */
ttodorov 0:881ff0b71102 77 LANDSCAPE = 1, /**< Display width is bigger than its height. */
ttodorov 10:69571adcfad5 78 };
ttodorov 10:69571adcfad5 79 /** \typedef orientation_t
ttodorov 10:69571adcfad5 80 * \brief Convenience shortcut for display orientation.
ttodorov 10:69571adcfad5 81 */
ttodorov 10:69571adcfad5 82 typedef enum Orientation_enum orientation_t;
ttodorov 0:881ff0b71102 83
ttodorov 10:69571adcfad5 84 /** \enum ColorDepth_enum
ttodorov 10:69571adcfad5 85 * \brief Color depth
ttodorov 10:69571adcfad5 86 */
ttodorov 10:69571adcfad5 87 enum ColorDepth_enum
ttodorov 10:69571adcfad5 88 {
ttodorov 10:69571adcfad5 89 RGB16, /**< 16-bit colors, pixels can have 65K distinct color values */
ttodorov 10:69571adcfad5 90 RGB18, /**< 18-bit colors, pixels can have 262K distinct color values */
ttodorov 10:69571adcfad5 91 };
ttodorov 10:69571adcfad5 92 /** \typedef colordepth_t
ttodorov 10:69571adcfad5 93 * \brief Convenience shortcut for display color depth.
ttodorov 10:69571adcfad5 94 */
ttodorov 10:69571adcfad5 95 typedef enum ColorDepth_enum colordepth_t;
ttodorov 10:69571adcfad5 96
ttodorov 10:69571adcfad5 97 /** \enum Alignment_enum
ttodorov 0:881ff0b71102 98 * \brief Horizontal text alignment on the line.
ttodorov 0:881ff0b71102 99 */
ttodorov 10:69571adcfad5 100 enum Alignment_enum
ttodorov 0:881ff0b71102 101 {
ttodorov 0:881ff0b71102 102 LEFT = 0, /**< Left-oriented, naturally gravitate closer to the left edge of the screen. */
ttodorov 0:881ff0b71102 103 CENTER = 9998, /**< Center-oriented, try to fit in the middle of the available space with equal free space to the left and right of the text. */
ttodorov 0:881ff0b71102 104 RIGHT = 9999, /**< Right-oriented, naturally gravitate closer to the right edge of the screen, leaving any remaining free space to the left of the text. */
ttodorov 10:69571adcfad5 105 };
ttodorov 10:69571adcfad5 106 /** \typedef align_t
ttodorov 10:69571adcfad5 107 * \brief Convenience shortcut for text alignment.
ttodorov 10:69571adcfad5 108 */
ttodorov 10:69571adcfad5 109 typedef enum Alignment_enum align_t;
ttodorov 0:881ff0b71102 110
ttodorov 10:69571adcfad5 111 /** \struct Font_struct
ttodorov 0:881ff0b71102 112 * \brief Describes fonts and their properties.
ttodorov 0:881ff0b71102 113 * \sa Comments in fonts.h
ttodorov 0:881ff0b71102 114 */
ttodorov 10:69571adcfad5 115 struct Font_struct
ttodorov 0:881ff0b71102 116 {
ttodorov 0:881ff0b71102 117 const char* font; /**< A pointer to the first byte in the font. */
ttodorov 0:881ff0b71102 118 unsigned char width; /**< The width of each character, in pixels. */
ttodorov 0:881ff0b71102 119 unsigned char height; /**< Height of each character, in pixels. */
ttodorov 0:881ff0b71102 120 unsigned char offset; /**< Offset of the first character in the font. */
ttodorov 0:881ff0b71102 121 unsigned char numchars; /**< Count of the available characters in the font. */
ttodorov 10:69571adcfad5 122 };
ttodorov 10:69571adcfad5 123 /** \typedef font_metrics_t
ttodorov 10:69571adcfad5 124 * \brief Convenience shortcut for fonts properties.
ttodorov 10:69571adcfad5 125 */
ttodorov 10:69571adcfad5 126 typedef struct Font_struct font_metrics_t;
ttodorov 0:881ff0b71102 127
ttodorov 0:881ff0b71102 128 /** Base class for LCD implementations.
ttodorov 0:881ff0b71102 129 *
ttodorov 0:881ff0b71102 130 * All separate LCD controller implementations have to subclass this one.
ttodorov 0:881ff0b71102 131 *
ttodorov 0:881ff0b71102 132 * \version 0.1
ttodorov 0:881ff0b71102 133 * \author Todor Todorov
ttodorov 0:881ff0b71102 134 */
ttodorov 0:881ff0b71102 135 class LCD
ttodorov 0:881ff0b71102 136 {
ttodorov 0:881ff0b71102 137 public:
ttodorov 0:881ff0b71102 138
ttodorov 0:881ff0b71102 139 /** Initialize display.
ttodorov 0:881ff0b71102 140 *
ttodorov 0:881ff0b71102 141 * Wakes up the display from sleep, initializes power parameters.
ttodorov 0:881ff0b71102 142 * This function must be called first, befor any painting on the
ttodorov 0:881ff0b71102 143 * display is done, otherwise the positioning of graphical elements
ttodorov 0:881ff0b71102 144 * will not work properly and any paynt operation will not be visible
ttodorov 0:881ff0b71102 145 * or produce garbage.
ttodorov 0:881ff0b71102 146 *
ttodorov 0:881ff0b71102 147 * This function is controller-specific and needs to be implemented
ttodorov 4:3ac4239f6c9c 148 * separately for each available display.
ttodorov 0:881ff0b71102 149 * \param oritentation The display orientation, landscape is default.
ttodorov 0:881ff0b71102 150 */
ttodorov 0:881ff0b71102 151 virtual void Initialize( orientation_t orientation ) = 0;
ttodorov 0:881ff0b71102 152
ttodorov 4:3ac4239f6c9c 153 /** Puts the display to sleep.
ttodorov 4:3ac4239f6c9c 154 *
ttodorov 4:3ac4239f6c9c 155 * When the display is in sleep mode, its power consumption is
ttodorov 4:3ac4239f6c9c 156 * minimized. Before new pixel data can be written to the display
ttodorov 4:3ac4239f6c9c 157 * memory, the controller needs to be brought out of sleep mode.
ttodorov 4:3ac4239f6c9c 158 * \sa #WakeUp( void );
ttodorov 4:3ac4239f6c9c 159 * \remarks The result of this operation might not be exactly as
ttodorov 4:3ac4239f6c9c 160 * expected. Putting the display to sleep will cause the
ttodorov 4:3ac4239f6c9c 161 * controller to switch to the standard color of the LCD,
ttodorov 4:3ac4239f6c9c 162 * so depending on whether the display is normally white,
ttodorov 4:3ac4239f6c9c 163 * or normally dark, the screen might or might not go
ttodorov 4:3ac4239f6c9c 164 * dark. Additional power saving can be achieved, if
ttodorov 4:3ac4239f6c9c 165 * the backlight of the used display is not hardwired on
ttodorov 4:3ac4239f6c9c 166 * the PCB and can be controlled via the BL pin.
ttodorov 4:3ac4239f6c9c 167 * \remarks This function is controller-specific and needs to be
ttodorov 4:3ac4239f6c9c 168 * implemented separately for each available display.
ttodorov 4:3ac4239f6c9c 169 */
ttodorov 4:3ac4239f6c9c 170 virtual void Sleep( void ) = 0;
ttodorov 4:3ac4239f6c9c 171
ttodorov 4:3ac4239f6c9c 172 /** Wakes up the display from sleep mode.
ttodorov 4:3ac4239f6c9c 173 *
ttodorov 4:3ac4239f6c9c 174 * This function needs to be called before any other, when the
ttodorov 4:3ac4239f6c9c 175 * display has been put into sleep mode by a previois call to
ttodorov 4:3ac4239f6c9c 176 * #Sleep( void ).
ttodorov 4:3ac4239f6c9c 177 * \remarks This function is controller-specific and needs to be
ttodorov 4:3ac4239f6c9c 178 * implemented separately for each available display.
ttodorov 4:3ac4239f6c9c 179 */
ttodorov 4:3ac4239f6c9c 180 virtual void WakeUp( void ) = 0;
ttodorov 4:3ac4239f6c9c 181
ttodorov 0:881ff0b71102 182 /** Set the foreground color for painting.
ttodorov 0:881ff0b71102 183 *
ttodorov 0:881ff0b71102 184 * This is the default foreground color to be used in painting operations.
ttodorov 0:881ff0b71102 185 * If a specific output function allows for a different color to be specified
ttodorov 0:881ff0b71102 186 * in place, the new setting will be used for that single operation only and
ttodorov 0:881ff0b71102 187 * will not change this value.
ttodorov 0:881ff0b71102 188 *
ttodorov 9:58b328831d0a 189 * \param color The color to be used. The value must be in RGB-565 format.
ttodorov 0:881ff0b71102 190 * \sa #RGB(r,g,b)
ttodorov 0:881ff0b71102 191 */
ttodorov 9:58b328831d0a 192 virtual void SetForeground( unsigned short color = COLOR_WHITE );
ttodorov 0:881ff0b71102 193
ttodorov 0:881ff0b71102 194 /** Set the background color for painting.
ttodorov 0:881ff0b71102 195 *
ttodorov 0:881ff0b71102 196 * This is the default color to be used for "empty" pixels while painting.
ttodorov 0:881ff0b71102 197 * If a particular function allows for a different value to be specified
ttodorov 0:881ff0b71102 198 * when the function is called, the new value will be used only for this
ttodorov 0:881ff0b71102 199 * single call and will not change this setting.
ttodorov 0:881ff0b71102 200 *
ttodorov 9:58b328831d0a 201 * \param color The background color as RGB-565 value.
ttodorov 0:881ff0b71102 202 * \sa #RGB(r,g,b)
ttodorov 0:881ff0b71102 203 */
ttodorov 9:58b328831d0a 204 virtual void SetBackground( unsigned short color = COLOR_BLACK );
ttodorov 0:881ff0b71102 205
ttodorov 0:881ff0b71102 206 /** Sets the font to be used for painting of text on the screen.
ttodorov 0:881ff0b71102 207 * \param font A pointer to the font data.
ttodorov 0:881ff0b71102 208 * \sa Comments in file fonts.h
ttodorov 0:881ff0b71102 209 */
ttodorov 0:881ff0b71102 210 virtual void SetFont( const char* font );
ttodorov 0:881ff0b71102 211
ttodorov 0:881ff0b71102 212 /** Gets the display width.
ttodorov 0:881ff0b71102 213 * \return Display width in pixels.
ttodorov 0:881ff0b71102 214 */
ttodorov 0:881ff0b71102 215 unsigned short GetWidth( void );
ttodorov 0:881ff0b71102 216
ttodorov 0:881ff0b71102 217 /** Gets the display height.
ttodorov 0:881ff0b71102 218 * \return Display height in pixels.
ttodorov 0:881ff0b71102 219 */
ttodorov 0:881ff0b71102 220 unsigned short GetHeight( void );
ttodorov 0:881ff0b71102 221
ttodorov 0:881ff0b71102 222 /** Fills the whole screen with a single color.
ttodorov 9:58b328831d0a 223 * \param color The color to be used. The value must be in RGB-565 format.
ttodorov 9:58b328831d0a 224 * \remarks The special values -1 and -2 signify the preset background and foreground colors, respectively.
ttodorov 9:58b328831d0a 225 * The backround color is the default.
ttodorov 0:881ff0b71102 226 */
ttodorov 0:881ff0b71102 227 virtual void FillScreen( int color = -1 );
ttodorov 0:881ff0b71102 228
ttodorov 0:881ff0b71102 229 /** Clears the screen.
ttodorov 0:881ff0b71102 230 *
ttodorov 0:881ff0b71102 231 * This is the same as calling #FillScreen() or #FillScreen( -1 ) to use the background color.
ttodorov 0:881ff0b71102 232 */
ttodorov 0:881ff0b71102 233 virtual void ClearScreen( void );
ttodorov 0:881ff0b71102 234
ttodorov 0:881ff0b71102 235 /** Draws a pixel at the specified location.
ttodorov 0:881ff0b71102 236 *
ttodorov 0:881ff0b71102 237 * By default the function will use the preset foreground color, but the background
ttodorov 0:881ff0b71102 238 * or a custom color could be used as well.
ttodorov 0:881ff0b71102 239 *
ttodorov 0:881ff0b71102 240 * \param x The horizontal offset of the pixel from the upper left corner of the screen.
ttodorov 0:881ff0b71102 241 * \param y The vertical offset of the pixel from the upper left corner of the screen.
ttodorov 9:58b328831d0a 242 * \param color The color to be used. Must be in RGB-565 format, or -1 for background and -2 for foreground color.
ttodorov 0:881ff0b71102 243 */
ttodorov 0:881ff0b71102 244 virtual void DrawPixel( unsigned short x, unsigned short y, int color = -2 );
ttodorov 0:881ff0b71102 245
ttodorov 0:881ff0b71102 246 /** Draws a line.
ttodorov 0:881ff0b71102 247 *
ttodorov 0:881ff0b71102 248 * \param x1 Horizontal offset of the beginning point of the line.
ttodorov 0:881ff0b71102 249 * \param y1 Vertical offset of the beginning point of the line.
ttodorov 0:881ff0b71102 250 * \param x2 Horizontal offset of the end point of the line.
ttodorov 0:881ff0b71102 251 * \param y2 Verical offset of the end point of the line.
ttodorov 9:58b328831d0a 252 * \param color The color to use for painting, in RGB-565 format, or -1 for background, or -2 for foreground.
ttodorov 0:881ff0b71102 253 */
ttodorov 0:881ff0b71102 254 virtual void DrawLine( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2, int color = -2 );
ttodorov 0:881ff0b71102 255
ttodorov 0:881ff0b71102 256 /** Paints a rectangle.
ttodorov 0:881ff0b71102 257 *
ttodorov 0:881ff0b71102 258 * \param x1 The horizontal offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 259 * \param y1 The vertical offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 260 * \param x2 The horizontal offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 261 * \param y2 The vertical offset of the end point of the same of the rectangle's diagonals.
ttodorov 9:58b328831d0a 262 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color in RGB-565 format.
ttodorov 0:881ff0b71102 263 */
ttodorov 0:881ff0b71102 264 virtual void DrawRect( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2, int color = -2 );
ttodorov 0:881ff0b71102 265
ttodorov 0:881ff0b71102 266 /** Paints a rectangle and fills it with the paint color.
ttodorov 0:881ff0b71102 267 *
ttodorov 0:881ff0b71102 268 * \param x1 The horizontal offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 269 * \param y1 The vertical offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 270 * \param x2 The horizontal offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 271 * \param y2 The vertical offset of the end point of the same of the rectangle's diagonals.
ttodorov 9:58b328831d0a 272 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color in RGB-565 format.
ttodorov 0:881ff0b71102 273 */
ttodorov 0:881ff0b71102 274 virtual void DrawRoundRect( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2, int color = -2 );
ttodorov 0:881ff0b71102 275
ttodorov 0:881ff0b71102 276 /** Paints a rectangle with rounded corners.
ttodorov 0:881ff0b71102 277 *
ttodorov 0:881ff0b71102 278 * \param x1 The horizontal offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 279 * \param y1 The vertical offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 280 * \param x2 The horizontal offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 281 * \param y2 The vertical offset of the end point of the same of the rectangle's diagonals.
ttodorov 9:58b328831d0a 282 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color in RGB-565 format.
ttodorov 0:881ff0b71102 283 */
ttodorov 0:881ff0b71102 284 virtual void FillRect( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2, int color = -2 );
ttodorov 0:881ff0b71102 285
ttodorov 0:881ff0b71102 286 /** Paints a rectangle with rounded corners and fills it with the paint color.
ttodorov 0:881ff0b71102 287 *
ttodorov 0:881ff0b71102 288 * \param x1 The horizontal offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 289 * \param y1 The vertical offset of the beginning point of one of the rectangle's diagonals.
ttodorov 0:881ff0b71102 290 * \param x2 The horizontal offset of the end point of the same of the rectangle's diagonals.
ttodorov 0:881ff0b71102 291 * \param y2 The vertical offset of the end point of the same of the rectangle's diagonals.
ttodorov 9:58b328831d0a 292 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color in RGB-565 format.
ttodorov 0:881ff0b71102 293 */
ttodorov 0:881ff0b71102 294 virtual void FillRoundRect( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2, int color = -2 );
ttodorov 0:881ff0b71102 295
ttodorov 0:881ff0b71102 296 /** Paints a circle.
ttodorov 0:881ff0b71102 297 *
ttodorov 0:881ff0b71102 298 * \param x The offset of the circle's center from the left edge of the screen.
ttodorov 0:881ff0b71102 299 * \param y The offset of the circle's center from the top edge of the screen.
ttodorov 0:881ff0b71102 300 * \param radius The circle's radius.
ttodorov 9:58b328831d0a 301 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color in RGB-565 format.
ttodorov 0:881ff0b71102 302 */
ttodorov 0:881ff0b71102 303 virtual void DrawCircle( unsigned short x, unsigned short y, unsigned short radius, int color = -2 );
ttodorov 0:881ff0b71102 304
ttodorov 0:881ff0b71102 305 /** Paints a circle and fills it with the paint color.
ttodorov 0:881ff0b71102 306 *
ttodorov 0:881ff0b71102 307 * \param x The offset of the circle's center from the left edge of the screen.
ttodorov 0:881ff0b71102 308 * \param y The offset of the circle's center from the top edge of the screen.
ttodorov 0:881ff0b71102 309 * \param radius The circle's radius.
ttodorov 9:58b328831d0a 310 * \param color The color to use for painting. -1 indicated background, -2 foreground, or custom color in RGB-565 format.
ttodorov 0:881ff0b71102 311 */
ttodorov 0:881ff0b71102 312 virtual void FillCircle( unsigned short x, unsigned short y, unsigned short radius, int color = -2 );
ttodorov 0:881ff0b71102 313
ttodorov 0:881ff0b71102 314 /** Print a text on the screen.
ttodorov 0:881ff0b71102 315 *
ttodorov 0:881ff0b71102 316 * \param str The text.
ttodorov 0:881ff0b71102 317 * \param x The horizontal offset form the left edge of the screen. The special values LEFT, CENTER,
ttodorov 0:881ff0b71102 318 * or RIGHT can be used instead of pixel offset to indicate the text's horizontal alignment.
ttodorov 0:881ff0b71102 319 * \param y The vertical offset of the text from the top of the screen.
ttodorov 0:881ff0b71102 320 * \param fgColor The foreground to use for painting the text; -1 indicates background color, -2 the foreground setting, or custom color.
ttodorov 0:881ff0b71102 321 * \param bgColor The color to use for painting the empty pixels; -1 indicates the background color, -2 the foreground setting, or custom color.
ttodorov 0:881ff0b71102 322 * \param deg If different than 0, the text will be rotated at an angle this many degrees around its starting point. Default is not to ratate.
ttodorov 0:881ff0b71102 323 */
ttodorov 0:881ff0b71102 324 virtual void Print( const char *str, unsigned short x, unsigned short y, int fgColor = -2, int bgColor = -1, unsigned short deg = 0 );
ttodorov 0:881ff0b71102 325
ttodorov 0:881ff0b71102 326 /** Draw an image on the screen.
ttodorov 0:881ff0b71102 327 *
ttodorov 0:881ff0b71102 328 * The pixels of the picture must be in the RGB-565 format. The data can be provided
ttodorov 0:881ff0b71102 329 * as an array in a source or a header file. To convert an image file to the appropriate
ttodorov 0:881ff0b71102 330 * format, a special utility must be utilized. One such tool is provided by Henning Karlsen,
ttodorov 0:881ff0b71102 331 * the author of the UTFT display liberary and can be downloaded for free from his web site:
ttodorov 0:881ff0b71102 332 * http://henningkarlsen.com/electronics/library.php?id=52
ttodorov 0:881ff0b71102 333 *
ttodorov 0:881ff0b71102 334 * \param x Horizontal offset of the first pixel of the image.
ttodorov 0:881ff0b71102 335 * \param y Vertical offset of the first pixel of the image
ttodorov 0:881ff0b71102 336 * \param sx Width of the image.
ttodorov 0:881ff0b71102 337 * \param sy Height of the image.
ttodorov 7:5c418fc1879f 338 * \param imgPixelData Image pixel array.
ttodorov 0:881ff0b71102 339 * \param scale A value of 1 will produce an image with its original size, while a different value will scale the image.
ttodorov 0:881ff0b71102 340 */
ttodorov 7:5c418fc1879f 341 virtual void DrawBitmap( unsigned short x, unsigned short y, unsigned short sx, unsigned short sy, const unsigned short* imgPixelData, unsigned char scale = 1 );
ttodorov 0:881ff0b71102 342
ttodorov 0:881ff0b71102 343 /** Draw an image on the screen.
ttodorov 0:881ff0b71102 344 *
ttodorov 0:881ff0b71102 345 * The pixels of the picture must be in the RGB-565 format. The data can be provided
ttodorov 0:881ff0b71102 346 * as an array in a source or a header file. To convert an image file to the appropriate
ttodorov 0:881ff0b71102 347 * format, a special utility must be utilized. One such tool is provided by Henning Karlsen,
ttodorov 0:881ff0b71102 348 * the author of the UTFT display liberary and can be downloaded for free from his web site:
ttodorov 0:881ff0b71102 349 * http://henningkarlsen.com/electronics/library.php?id=52
ttodorov 0:881ff0b71102 350 *
ttodorov 0:881ff0b71102 351 * \param x Horizontal offset of the first pixel of the image.
ttodorov 0:881ff0b71102 352 * \param y Vertical offset of the first pixel of the image
ttodorov 0:881ff0b71102 353 * \param sx Width of the image.
ttodorov 0:881ff0b71102 354 * \param sy Height of the image.
ttodorov 7:5c418fc1879f 355 * \param imgPixelData Image pixel array.
ttodorov 0:881ff0b71102 356 * \param deg Angle to rotate the image before painting on screen, in degrees.
ttodorov 0:881ff0b71102 357 * \param rox
ttodorov 0:881ff0b71102 358 * \param roy
ttodorov 0:881ff0b71102 359 */
ttodorov 7:5c418fc1879f 360 virtual void DrawBitmap( unsigned short x, unsigned short y, unsigned short sx, unsigned short sy, const unsigned short* imgPixelData, unsigned short deg, unsigned short rox, unsigned short roy );
ttodorov 0:881ff0b71102 361
ttodorov 0:881ff0b71102 362 protected:
ttodorov 0:881ff0b71102 363 /** Creates an instance of the class.
ttodorov 0:881ff0b71102 364 *
ttodorov 0:881ff0b71102 365 * \param width Width of the display in pixels.
ttodorov 0:881ff0b71102 366 * \param height Height of the display in pixels.
ttodorov 0:881ff0b71102 367 * \param CS Pin connected to the CS input of the display.
ttodorov 0:881ff0b71102 368 * \param RS Pin connected to the RS input of the display.
ttodorov 4:3ac4239f6c9c 369 * \param RESET Pin connected to the RESET input of the display.
ttodorov 0:881ff0b71102 370 */
ttodorov 4:3ac4239f6c9c 371 LCD( unsigned short width, unsigned short height ,PinName CS, PinName RS, PinName RESET );
ttodorov 4:3ac4239f6c9c 372
ttodorov 4:3ac4239f6c9c 373 /** Activates the display for command/data transfer.
ttodorov 4:3ac4239f6c9c 374 *
ttodorov 4:3ac4239f6c9c 375 * Usually achieved by pulling the CS pin of the display low.
ttodorov 4:3ac4239f6c9c 376 */
ttodorov 4:3ac4239f6c9c 377 virtual void Activate( void );
ttodorov 4:3ac4239f6c9c 378
ttodorov 4:3ac4239f6c9c 379 /** Deactivates the display after data has been transmitted.
ttodorov 4:3ac4239f6c9c 380 *
ttodorov 4:3ac4239f6c9c 381 * Usually achieved by pulling the CS pin of the display high.
ttodorov 4:3ac4239f6c9c 382 */
ttodorov 4:3ac4239f6c9c 383 virtual void Deactivate( void );
ttodorov 0:881ff0b71102 384
ttodorov 0:881ff0b71102 385 /** Sends a command to the display.
ttodorov 0:881ff0b71102 386 *
ttodorov 0:881ff0b71102 387 * \param cmd The display command.
ttodorov 0:881ff0b71102 388 * \remarks Commands are controller-specific and this function needs to
ttodorov 0:881ff0b71102 389 * be implemented separately for each available controller.
ttodorov 0:881ff0b71102 390 */
ttodorov 2:81ed304b7e9b 391 virtual void WriteCmd( unsigned short cmd ) = 0;
ttodorov 0:881ff0b71102 392
ttodorov 0:881ff0b71102 393 /** Sends pixel data to the display.
ttodorov 0:881ff0b71102 394 *
ttodorov 0:881ff0b71102 395 * \param data The display data.
ttodorov 0:881ff0b71102 396 * \remarks Sendin data is controller-specific and this function needs to
ttodorov 0:881ff0b71102 397 * be implemented separately for each available controller.
ttodorov 0:881ff0b71102 398 */
ttodorov 2:81ed304b7e9b 399 virtual void WriteData( unsigned short data ) = 0;
ttodorov 0:881ff0b71102 400
ttodorov 0:881ff0b71102 401 /** Sends both command and data to the display controller.
ttodorov 0:881ff0b71102 402 *
ttodorov 0:881ff0b71102 403 * This is a helper utility function which combines the 2 functions above
ttodorov 0:881ff0b71102 404 * into one single convenience step.
ttodorov 0:881ff0b71102 405 *
ttodorov 0:881ff0b71102 406 * \param cmd The display command.
ttodorov 0:881ff0b71102 407 * \param data The display pixel data.
ttodorov 0:881ff0b71102 408 */
ttodorov 2:81ed304b7e9b 409 virtual void WriteCmdData( unsigned short cmd, unsigned short data );
ttodorov 0:881ff0b71102 410
ttodorov 0:881ff0b71102 411 /** Assigns a chunk of the display memory to receive data.
ttodorov 0:881ff0b71102 412 *
ttodorov 0:881ff0b71102 413 * When data is sent to the display after this function completes, the opertion will
ttodorov 0:881ff0b71102 414 * start from the begining of the assigned address (pixel position) and the pointer
ttodorov 0:881ff0b71102 415 * will be automatically incremented so that the next data write operation will continue
ttodorov 0:881ff0b71102 416 * with the next pixel from the memory block. If more data is written than available
ttodorov 0:881ff0b71102 417 * pixels, at the end of the block the pointer will jump back to its beginning and
ttodorov 0:881ff0b71102 418 * commence again, until the next address change command is sent to the display.
ttodorov 0:881ff0b71102 419 *
ttodorov 0:881ff0b71102 420 * \param x1 The X coordinate of the pixel at the beginning of the block.
ttodorov 0:881ff0b71102 421 * \param y1 The Y coordinate of the pixel at the beginning of the block.
ttodorov 0:881ff0b71102 422 * \param x2 The X coordinate of the pixel at the end of the block.
ttodorov 0:881ff0b71102 423 * \param y2 The Y coordinate of the pixel at the end of the block.
ttodorov 0:881ff0b71102 424 * \remarks Addressing commands are controller-specific and this function needs to be
ttodorov 0:881ff0b71102 425 * implemented separately for each available controller.
ttodorov 0:881ff0b71102 426 */
ttodorov 2:81ed304b7e9b 427 virtual void SetXY( uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2 ) = 0;
ttodorov 0:881ff0b71102 428
ttodorov 0:881ff0b71102 429 /** Resets the memory address for the next display write operation to the screen origins (0,0).
ttodorov 0:881ff0b71102 430 */
ttodorov 2:81ed304b7e9b 431 virtual void ClearXY( void );
ttodorov 2:81ed304b7e9b 432
ttodorov 10:69571adcfad5 433 /** Sets the color of the pixel at the address pointer of the controller.
ttodorov 10:69571adcfad5 434 *
ttodorov 10:69571adcfad5 435 * This function is to be provided by each implementation separately in
ttodorov 10:69571adcfad5 436 * order to account for different color depth used by the controller.
ttodorov 10:69571adcfad5 437 * \param color The color of the pixel.
ttodorov 10:69571adcfad5 438 */
ttodorov 10:69571adcfad5 439 virtual void SetPixelColor( unsigned short color ) = 0;
ttodorov 10:69571adcfad5 440
ttodorov 2:81ed304b7e9b 441 /** Draws a horizontal line.
ttodorov 2:81ed304b7e9b 442 *
ttodorov 2:81ed304b7e9b 443 * This is a utility function to draw horizontal-only lines
ttodorov 2:81ed304b7e9b 444 * for reduced code complexity and faster execution.
ttodorov 2:81ed304b7e9b 445 *
ttodorov 2:81ed304b7e9b 446 * \param x X coordinate of the starting point of the line.
ttodorov 2:81ed304b7e9b 447 * \param y Y coordinate of the starting point of the line.
ttodorov 2:81ed304b7e9b 448 * \param len Length of the line.
ttodorov 2:81ed304b7e9b 449 * \param color The color to use to draw the line. By default the global foreground color is used ( -2 ),
ttodorov 9:58b328831d0a 450 * -1 switches to the default background color, or any other RGB-565 color can be used.
ttodorov 2:81ed304b7e9b 451 */
ttodorov 2:81ed304b7e9b 452 virtual void DrawHLine( unsigned short x, unsigned short y, unsigned short len, int color = -2 );
ttodorov 0:881ff0b71102 453
ttodorov 2:81ed304b7e9b 454 /** Draws a vertical line.
ttodorov 2:81ed304b7e9b 455 *
ttodorov 2:81ed304b7e9b 456 * This is a utility function to draw vertical-only lines
ttodorov 2:81ed304b7e9b 457 * for reduced code complexity and faster execution.
ttodorov 2:81ed304b7e9b 458 *
ttodorov 2:81ed304b7e9b 459 * \param x X coordinate of the starting point of the line.
ttodorov 2:81ed304b7e9b 460 * \param y Y coordinate of the starting point of the line.
ttodorov 2:81ed304b7e9b 461 * \param len Height of the line.
ttodorov 2:81ed304b7e9b 462 * \param color The color to use to draw the line. By default the global foreground color is used ( -2 ),
ttodorov 9:58b328831d0a 463 * -1 switches to the default background color, or any other RGB-565 color can be used.
ttodorov 2:81ed304b7e9b 464 */
ttodorov 2:81ed304b7e9b 465 virtual void DrawVLine( unsigned short x, unsigned short y, unsigned short len, int color = -2 );
ttodorov 2:81ed304b7e9b 466
ttodorov 2:81ed304b7e9b 467 /** Prints a character at the given position and using the given color.
ttodorov 2:81ed304b7e9b 468 *
ttodorov 2:81ed304b7e9b 469 * \param c The character.
ttodorov 2:81ed304b7e9b 470 * \param x X coordinate of the character position.
ttodorov 2:81ed304b7e9b 471 * \param y Y coordinate of the character position.
ttodorov 2:81ed304b7e9b 472 * \param fgColor Foreground color for drawing. By default the global foreground color is used ( -2 ),
ttodorov 9:58b328831d0a 473 * -1 switches to the default background color, or any other RGB-565 color can be used.
ttodorov 2:81ed304b7e9b 474 * \param bgColor Background color for drawing. By default the global background color is used ( -1 ),
ttodorov 9:58b328831d0a 475 * -2 switches to the default foreground color, or any other RGB-565 color can be used.
ttodorov 2:81ed304b7e9b 476 */
ttodorov 2:81ed304b7e9b 477 virtual void PrintChar( char c, unsigned short x, unsigned short y, int fgColor = -2, int bgColor = -1 );
ttodorov 2:81ed304b7e9b 478
ttodorov 2:81ed304b7e9b 479 /** Prints a character at the given position and using the given color and with the given rotation.
ttodorov 2:81ed304b7e9b 480 *
ttodorov 2:81ed304b7e9b 481 * \param c The character.
ttodorov 2:81ed304b7e9b 482 * \param x X coordinate of the character position.
ttodorov 2:81ed304b7e9b 483 * \param y Y coordinate of the character position.
ttodorov 2:81ed304b7e9b 484 * \param pos Position of the character in the string from which it originates (used to rotate a whole string).
ttodorov 2:81ed304b7e9b 485 * \param fgColor Foreground color for drawing. By default the global foreground color is used ( -2 ),
ttodorov 9:58b328831d0a 486 * -1 switches to the default background color, or any other RGB-565 color can be used.
ttodorov 2:81ed304b7e9b 487 * \param bgColor Background color for drawing. By default the global background color is used ( -1 ),
ttodorov 9:58b328831d0a 488 * -2 switches to the default foreground color, or any other RGB-565 color can be used.
ttodorov 2:81ed304b7e9b 489 * \param deg The angle at which to rotate.
ttodorov 2:81ed304b7e9b 490 */
ttodorov 2:81ed304b7e9b 491 virtual void RotateChar( char c, unsigned short x, unsigned short y, int pos, int fgColor = -2, int bgColor = -1, unsigned short deg = 0 );
ttodorov 0:881ff0b71102 492
ttodorov 0:881ff0b71102 493 protected:
ttodorov 4:3ac4239f6c9c 494 unsigned short _disp_width, _disp_height;
ttodorov 4:3ac4239f6c9c 495 DigitalOut _lcd_pin_cs, _lcd_pin_rs, _lcd_pin_reset;
ttodorov 4:3ac4239f6c9c 496 orientation_t _orientation;
ttodorov 9:58b328831d0a 497 unsigned short _foreground, _background;
ttodorov 4:3ac4239f6c9c 498 font_metrics_t _font;
ttodorov 0:881ff0b71102 499 };
ttodorov 0:881ff0b71102 500
ttodorov 6:059ca1648211 501 #ifdef __cplusplus
ttodorov 6:059ca1648211 502 }
ttodorov 6:059ca1648211 503 #endif
ttodorov 6:059ca1648211 504
ttodorov 3:64a5b67d5b51 505 #endif /* TFTLCD_BASE_H */