madhu sudhana / Mbed OS newTFTLCD_

1.44 tft lcd display

Dependencies:   TFT_fonts mbed-os

Fork of newTFTLCD by madhu sudhana

st7735.h@29:35482446e4ee, 2018-10-04 (annotated)

Committer:
madhusudhana
Date:
Thu Oct 04 05:11:28 2018 +0000
Revision:
29:35482446e4ee
Parent:
28:6ac2fa56f82c 
display

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ttodorov 9:58b328831d0a 1 /** \file st7735.h
ttodorov 9:58b328831d0a 2 * \brief mbed TFT LCD controller for displays with the ST7735 IC.
ttodorov 9:58b328831d0a 3 * \copyright GNU Public License, v2. or later
ttodorov 9:58b328831d0a 4 *
ttodorov 9:58b328831d0a 5 * A known display with this type of controller chip is the ITDB02-1.8SP
ttodorov 9:58b328831d0a 6 * from http://imall.iteadstudio.com
ttodorov 9:58b328831d0a 7 *
ttodorov 9:58b328831d0a 8 * This library is based on the Arduino/chipKIT UTFT library by Henning
ttodorov 9:58b328831d0a 9 * Karlsen, http://henningkarlsen.com/electronics/library.php?id=52
ttodorov 9:58b328831d0a 10 *
ttodorov 9:58b328831d0a 11 * Copyright (C)2010-2012 Henning Karlsen. All right reserved.
ttodorov 9:58b328831d0a 12 *
ttodorov 9:58b328831d0a 13 * Copyright (C)2012 Todor Todorov.
ttodorov 9:58b328831d0a 14 *
ttodorov 9:58b328831d0a 15 * This library is free software; you can redistribute it and/or
ttodorov 9:58b328831d0a 16 * modify it under the terms of the GNU Lesser General Public
ttodorov 9:58b328831d0a 17 * License as published by the Free Software Foundation; either
ttodorov 9:58b328831d0a 18 * version 2.1 of the License, or (at your option) any later version.
ttodorov 9:58b328831d0a 19 *
ttodorov 9:58b328831d0a 20 * This library is distributed in the hope that it will be useful,
ttodorov 9:58b328831d0a 21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ttodorov 9:58b328831d0a 22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ttodorov 9:58b328831d0a 23 * Lesser General Public License for more details.
ttodorov 9:58b328831d0a 24 *
ttodorov 9:58b328831d0a 25 * You should have received a copy of the GNU Lesser General Public
ttodorov 9:58b328831d0a 26 * License along with this library; if not, write to:
ttodorov 9:58b328831d0a 27 *
ttodorov 9:58b328831d0a 28 * Free Software Foundation, Inc.
ttodorov 9:58b328831d0a 29 * 51 Franklin St, 5th Floor, Boston, MA 02110-1301, USA
ttodorov 9:58b328831d0a 30 *
ttodorov 9:58b328831d0a 31 *********************************************************************/
ttodorov 9:58b328831d0a 32 #ifndef TFTLCD_ST7735_H
ttodorov 9:58b328831d0a 33 #define TFTLCD_ST7735_H
ttodorov 9:58b328831d0a 34
ttodorov 9:58b328831d0a 35 #include "lcd_base.h"
madhusudhana 29:35482446e4ee 36 #include "stdint.h"
ttodorov 9:58b328831d0a 37
ttodorov 9:58b328831d0a 38 #ifdef __cplusplus
ttodorov 9:58b328831d0a 39 extern "C" {
ttodorov 9:58b328831d0a 40 #endif
ttodorov 9:58b328831d0a 41
ttodorov 9:58b328831d0a 42 /** Represents a LCD instance.
ttodorov 9:58b328831d0a 43 *
ttodorov 9:58b328831d0a 44 * This is the utility class, through which the display can be manipulated
ttodorov 9:58b328831d0a 45 * and graphics objects can be shown to the user. A known display, which
ttodorov 9:58b328831d0a 46 * works with this library is the ITDB02-1.8SP from iTeadStudio - a RGB TFT
ttodorov 9:58b328831d0a 47 * with 128x160 pixels resolution and 262K colors, using serail interface.
ttodorov 9:58b328831d0a 48 *
ttodorov 9:58b328831d0a 49 * The display needs 5 or 6 pins to work with mbed, uses +3.3V for backlight,
ttodorov 9:58b328831d0a 50 * power and logic, thus can be interfaced directly to the mbed kit without
ttodorov 9:58b328831d0a 51 * the need of shields or level shifters as with Arduino.
ttodorov 9:58b328831d0a 52 *
ttodorov 9:58b328831d0a 53 * How to use:
ttodorov 9:58b328831d0a 54 * \code
ttodorov 9:58b328831d0a 55 * // include the library, this will also pull in the header for the provided fonts
ttodorov 9:58b328831d0a 56 * #include "st7735.h"
ttodorov 9:58b328831d0a 57 *
ttodorov 9:58b328831d0a 58 * // create the lcd instance
ttodorov 9:58b328831d0a 59 * ST7735_LCD lcd( p14, p13, p12, p11, p10 ); // control pins
ttodorov 9:58b328831d0a 60 *
ttodorov 9:58b328831d0a 61 * int main()
ttodorov 9:58b328831d0a 62 * {
ttodorov 9:58b328831d0a 63 * // initialize display - place it in standard portrait mode and set background to black and
ttodorov 9:58b328831d0a 64 * // foreground to white color.
ttodorov 9:58b328831d0a 65 * lcd.Initialize();
ttodorov 9:58b328831d0a 66 * // set current font to the smallest 8x12 pixels font.
ttodorov 9:58b328831d0a 67 * lcd.SetFont( Font8x12 );
ttodorov 9:58b328831d0a 68 * // print something on the screen
ttodorov 9:58b328831d0a 69 * lcd.Print( "Hello, World!", CENTER, 25 ); // align text to center horizontally and use starndard colors
ttodorov 9:58b328831d0a 70 *
ttodorov 9:58b328831d0a 71 * while ( 1 ) { }
ttodorov 9:58b328831d0a 72 * }
ttodorov 9:58b328831d0a 73 *
ttodorov 9:58b328831d0a 74 * \endcode
ttodorov 9:58b328831d0a 75 * \version 0.1
ttodorov 9:58b328831d0a 76 * \author Todor Todorov
ttodorov 9:58b328831d0a 77 */
ttodorov 9:58b328831d0a 78 class ST7735_LCD : public LCD
ttodorov 9:58b328831d0a 79 {
ttodorov 9:58b328831d0a 80 public:
ttodorov 9:58b328831d0a 81 /** Creates a new instance of the class.
ttodorov 9:58b328831d0a 82 *
ttodorov 9:58b328831d0a 83 * \param CS Pin for the ChipSelect signal.
ttodorov 9:58b328831d0a 84 * \param RESET Pin for the RESET line.
ttodorov 9:58b328831d0a 85 * \param RS Pin for the RS signal.
ttodorov 9:58b328831d0a 86 * \param SCL Pin for the serial clock line.
ttodorov 9:58b328831d0a 87 * \param SDA Pin for the serial data line.
ttodorov 9:58b328831d0a 88 * \param BL Pin for controlling the backlight. By default not used.
ttodorov 22:4c169297f374 89 * \param blType The backlight type, the default is to utilize the pin - if supplied - as a simple on/off switch
ttodorov 22:4c169297f374 90 * \param defaultBacklightLevel If using PWM to control backlight, this would be the default brightness in percent after LCD initialization.
ttodorov 9:58b328831d0a 91 */
ttodorov 22:4c169297f374 92 ST7735_LCD( PinName CS, PinName RESET, PinName RS, PinName SCL, PinName SDA, PinName BL = NC, backlight_t blType = Constant, float defaultBackLightLevel = 1.0 );
ttodorov 9:58b328831d0a 93
ttodorov 9:58b328831d0a 94 /** Initialize display.
ttodorov 9:58b328831d0a 95 *
ttodorov 9:58b328831d0a 96 * Wakes up the display from sleep, initializes power parameters.
ttodorov 9:58b328831d0a 97 * This function must be called first, befor any painting on the
ttodorov 9:58b328831d0a 98 * display is done, otherwise the positioning of graphical elements
ttodorov 9:58b328831d0a 99 * will not work properly and any paynt operation will not be visible
ttodorov 9:58b328831d0a 100 * or produce garbage.
ttodorov 9:58b328831d0a 101 *
ttodorov 9:58b328831d0a 102 * \param oritentation The display orientation, landscape is default.
ttodorov 12:d0978272a340 103 * \param colors The correct color depth to use for the pixel data.
ttodorov 9:58b328831d0a 104 */
ttodorov 12:d0978272a340 105 virtual void Initialize( orientation_t orientation = LANDSCAPE, colordepth_t colors = RGB16 );
ttodorov 9:58b328831d0a 106
ttodorov 9:58b328831d0a 107 /** Puts the display to sleep.
ttodorov 9:58b328831d0a 108 *
ttodorov 9:58b328831d0a 109 * When the display is in sleep mode, its power consumption is
ttodorov 9:58b328831d0a 110 * minimized. Before new pixel data can be written to the display
ttodorov 9:58b328831d0a 111 * memory, the controller needs to be brought out of sleep mode.
ttodorov 9:58b328831d0a 112 * \sa #WakeUp( void );
ttodorov 9:58b328831d0a 113 * \remarks The result of this operation might not be exactly as
ttodorov 9:58b328831d0a 114 * expected. Putting the display to sleep will cause the
ttodorov 9:58b328831d0a 115 * controller to switch to the standard color of the LCD,
ttodorov 9:58b328831d0a 116 * so depending on whether the display is normally white,
ttodorov 9:58b328831d0a 117 * or normally dark, the screen might or might not go
ttodorov 9:58b328831d0a 118 * dark. Additional power saving can be achieved, if
ttodorov 9:58b328831d0a 119 * the backlight of the used display is not hardwired on
ttodorov 9:58b328831d0a 120 * the PCB and can be controlled via the BL pin.
ttodorov 9:58b328831d0a 121 */
ttodorov 9:58b328831d0a 122 virtual void Sleep( void );
ttodorov 9:58b328831d0a 123
ttodorov 9:58b328831d0a 124 /** Wakes up the display from sleep mode.
ttodorov 9:58b328831d0a 125 *
ttodorov 9:58b328831d0a 126 * This function needs to be called before any other, when the
ttodorov 9:58b328831d0a 127 * display has been put into sleep mode by a previois call to
ttodorov 9:58b328831d0a 128 * #Sleep( void ).
ttodorov 9:58b328831d0a 129 */
ttodorov 9:58b328831d0a 130 virtual void WakeUp( void );
madhusudhana 29:35482446e4ee 131 /* Hexiwear NXP Bitmap Images
madhusudhana 29:35482446e4ee 132 * This file contains the bitmaps for the full screen (96 by 96 pixels) NXP logo
madhusudhana 29:35482446e4ee 133 * and a smaller 96 by 32 pixels NXP logo.
madhusudhana 29:35482446e4ee 134 *
madhusudhana 29:35482446e4ee 135 * Redistribution and use in source and binary forms, with or without modification,
madhusudhana 29:35482446e4ee 136 * are permitted provided that the following conditions are met:
madhusudhana 29:35482446e4ee 137 *
madhusudhana 29:35482446e4ee 138 * Redistributions of source code must retain the above copyright notice, this list
madhusudhana 29:35482446e4ee 139 * of conditions and the following disclaimer.
madhusudhana 29:35482446e4ee 140 *
madhusudhana 29:35482446e4ee 141 * Redistributions in binary form must reproduce the above copyright notice, this
madhusudhana 29:35482446e4ee 142 * list of conditions and the following disclaimer in the documentation and/or
madhusudhana 29:35482446e4ee 143 * other materials provided with the distribution.
madhusudhana 29:35482446e4ee 144 *
madhusudhana 29:35482446e4ee 145 * Neither the name of NXP, nor the names of its
madhusudhana 29:35482446e4ee 146 * contributors may be used to endorse or promote products derived from this
madhusudhana 29:35482446e4ee 147 * software without specific prior written permission.
madhusudhana 29:35482446e4ee 148 *
madhusudhana 29:35482446e4ee 149 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
madhusudhana 29:35482446e4ee 150 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
madhusudhana 29:35482446e4ee 151 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
madhusudhana 29:35482446e4ee 152 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
madhusudhana 29:35482446e4ee 153 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
madhusudhana 29:35482446e4ee 154 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
madhusudhana 29:35482446e4ee 155 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
madhusudhana 29:35482446e4ee 156 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
madhusudhana 29:35482446e4ee 157 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
madhusudhana 29:35482446e4ee 158 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
madhusudhana 29:35482446e4ee 159 *
madhusudhana 29:35482446e4ee 160 * visit: http://www.mikroe.com and http://www.nxp.com
madhusudhana 29:35482446e4ee 161 *
madhusudhana 29:35482446e4ee 162 * get support at: http://www.mikroe.com/forum and https://community.nxp.com
madhusudhana 29:35482446e4ee 163 *
madhusudhana 29:35482446e4ee 164 * Project HEXIWEAR, 2015
madhusudhana 29:35482446e4ee 165 */
madhusudhana 29:35482446e4ee 166
madhusudhana 29:35482446e4ee 167
ttodorov 9:58b328831d0a 168
madhusudhana 28:6ac2fa56f82c 169
ttodorov 9:58b328831d0a 170 protected:
ttodorov 9:58b328831d0a 171 /** Sends a command to the display.
ttodorov 9:58b328831d0a 172 *
ttodorov 9:58b328831d0a 173 * \param cmd The display command.
ttodorov 9:58b328831d0a 174 * \remarks Commands are controller-specific and this function needs to
ttodorov 9:58b328831d0a 175 * be implemented separately for each available controller.
ttodorov 9:58b328831d0a 176 */
ttodorov 9:58b328831d0a 177 virtual void WriteCmd( unsigned short cmd );
ttodorov 9:58b328831d0a 178
ttodorov 9:58b328831d0a 179 /** Sends pixel data to the display.
ttodorov 9:58b328831d0a 180 *
ttodorov 9:58b328831d0a 181 * \param data The display data.
ttodorov 9:58b328831d0a 182 * \remarks Sendin data is controller-specific and this function needs to
ttodorov 9:58b328831d0a 183 * be implemented separately for each available controller.
ttodorov 9:58b328831d0a 184 */
ttodorov 9:58b328831d0a 185 virtual void WriteData( unsigned short data );
ttodorov 9:58b328831d0a 186
ttodorov 9:58b328831d0a 187 /** Writes a single byte of pixel data to the display.
ttodorov 9:58b328831d0a 188 *
ttodorov 9:58b328831d0a 189 * \param data The data to be written.
ttodorov 9:58b328831d0a 190 * \remarks Sendin data is controller-specific and this function needs to
ttodorov 9:58b328831d0a 191 * be implemented separately for each available controller.
ttodorov 9:58b328831d0a 192 */
ttodorov 9:58b328831d0a 193 virtual void WriteByteData( unsigned char data );
ttodorov 9:58b328831d0a 194
ttodorov 9:58b328831d0a 195 /** Assigns a chunk of the display memory to receive data.
ttodorov 9:58b328831d0a 196 *
ttodorov 9:58b328831d0a 197 * When data is sent to the display after this function completes, the opertion will
ttodorov 9:58b328831d0a 198 * start from the begining of the assigned address (pixel position) and the pointer
ttodorov 9:58b328831d0a 199 * will be automatically incremented so that the next data write operation will continue
ttodorov 9:58b328831d0a 200 * with the next pixel from the memory block. If more data is written than available
ttodorov 9:58b328831d0a 201 * pixels, at the end of the block the pointer will jump back to its beginning and
ttodorov 9:58b328831d0a 202 * commence again, until the next address change command is sent to the display.
ttodorov 9:58b328831d0a 203 *
ttodorov 9:58b328831d0a 204 * \param x1 The X coordinate of the pixel at the beginning of the block.
ttodorov 9:58b328831d0a 205 * \param y1 The Y coordinate of the pixel at the beginning of the block.
ttodorov 9:58b328831d0a 206 * \param x2 The X coordinate of the pixel at the end of the block.
ttodorov 9:58b328831d0a 207 * \param y2 The Y coordinate of the pixel at the end of the block.
ttodorov 9:58b328831d0a 208 * \remarks Addressing commands are controller-specific and this function needs to be
ttodorov 9:58b328831d0a 209 * implemented separately for each available controller.
ttodorov 9:58b328831d0a 210 */
ttodorov 20:4bdca8d8dadc 211 virtual void SetXY( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2 );
ttodorov 9:58b328831d0a 212
ttodorov 10:69571adcfad5 213 /** Sets the color of the pixel at the address pointer of the controller.
ttodorov 10:69571adcfad5 214 *
ttodorov 10:69571adcfad5 215 * This function is to be provided by each implementation separately in
ttodorov 10:69571adcfad5 216 * order to account for different color depth used by the controller.
ttodorov 10:69571adcfad5 217 * \param color The color of the pixel.
ttodorov 20:4bdca8d8dadc 218 * \param mode The depth (palette) of the color.
ttodorov 10:69571adcfad5 219 */
ttodorov 20:4bdca8d8dadc 220 virtual void SetPixelColor( unsigned int color, colordepth_t mode = RGB24 );
ttodorov 10:69571adcfad5 221
ttodorov 9:58b328831d0a 222 private:
ttodorov 9:58b328831d0a 223 void serializeByte( unsigned char data );
ttodorov 9:58b328831d0a 224
ttodorov 9:58b328831d0a 225 private:
ttodorov 9:58b328831d0a 226 DigitalOut _lcd_pin_scl, _lcd_pin_sda;
ttodorov 9:58b328831d0a 227 DigitalOut* _lcd_pin_bl;
ttodorov 9:58b328831d0a 228 };
ttodorov 9:58b328831d0a 229
ttodorov 9:58b328831d0a 230 #ifdef __cplusplus
ttodorov 9:58b328831d0a 231 }
ttodorov 9:58b328831d0a 232 #endif
ttodorov 9:58b328831d0a 233
ttodorov 9:58b328831d0a 234 #endif /* TFTLCD_ST7735_H */