Johnathan Chin / 4DGL-uLCD-SE

LCD object

Dependents:   Lab5

Fork of 4DGL-uLCD-SE by jim hamblen

uLCD_4DGL.h@9:df8988c8d7d1, 2017-11-08 (annotated)

Committer:
jchin32
Date:
Wed Nov 08 20:22:53 2017 +0000
Revision:
9:df8988c8d7d1
Parent:
7:e39a44de229a 
included header guards

Who changed what in which revision?

UserRevisionLine numberNew contents of line
4180_1 1:8b656995301f 1 //
4180_1 1:8b656995301f 2 // uLCD_4DGL is a class to drive 4D Systems TFT touch screens
4180_1 1:8b656995301f 3 //
4180_1 7:e39a44de229a 4 // Fork of 4DGL library for 4D Systems LCD displays
4180_1 1:8b656995301f 5 // Copyright (C) <2010> Stephane ROCHON <stephane.rochon at free.fr>
4180_1 7:e39a44de229a 6 // Modifed for Goldelox processor <2013> Jim Hamblen
4180_1 1:8b656995301f 7 //
4180_1 1:8b656995301f 8 // uLCD_4DGL is free software: you can redistribute it and/or modify
4180_1 1:8b656995301f 9 // it under the terms of the GNU General Public License as published by
4180_1 1:8b656995301f 10 // the Free Software Foundation, either version 3 of the License, or
4180_1 1:8b656995301f 11 // (at your option) any later version.
4180_1 1:8b656995301f 12 //
4180_1 1:8b656995301f 13 // uLCD_4DGL is distributed in the hope that it will be useful,
4180_1 1:8b656995301f 14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
4180_1 1:8b656995301f 15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4180_1 1:8b656995301f 16 // GNU General Public License for more details.
4180_1 1:8b656995301f 17 //
4180_1 1:8b656995301f 18 // You should have received a copy of the GNU General Public License
4180_1 1:8b656995301f 19 // along with uLCD_4DGL. If not, see <http://www.gnu.org/licenses/>.
4180_1 1:8b656995301f 20
4180_1 1:8b656995301f 21 // @author Stephane Rochon
4180_1 1:8b656995301f 22
jchin32 9:df8988c8d7d1 23 #ifndef ULCD_4DGL_H
jchin32 9:df8988c8d7d1 24 #define ULCD_4DGL_H
jchin32 9:df8988c8d7d1 25
4180_1 1:8b656995301f 26 #include "mbed.h"
4180_1 1:8b656995301f 27
4180_1 7:e39a44de229a 28 // Debug Verbose off - SGE commands echoed to USB serial for debugmode=1
4180_1 1:8b656995301f 29 #ifndef DEBUGMODE
4180_1 2:edae99e4abe7 30 #define DEBUGMODE 0
4180_1 1:8b656995301f 31 #endif
4180_1 1:8b656995301f 32
4180_1 7:e39a44de229a 33 // Common WAIT value in milliseconds between commands
4180_1 7:e39a44de229a 34 #define TEMPO 0
4180_1 1:8b656995301f 35
4180_1 7:e39a44de229a 36 // 4DGL SGE Function values for Goldelox Processor
4180_1 1:8b656995301f 37 #define CLS '\xD7'
4180_1 1:8b656995301f 38 #define BAUDRATE '\x0B' //null prefix
4180_1 1:8b656995301f 39 #define VERSION '\x08' //null prefix
4180_1 1:8b656995301f 40 #define BCKGDCOLOR '\x6E'
4180_1 2:edae99e4abe7 41 #define TXTBCKGDCOLOR '\x7E'
4180_1 1:8b656995301f 42 #define DISPCONTROL '\x68'
4180_1 1:8b656995301f 43 #define SETVOLUME '\x76'
4180_1 7:e39a44de229a 44 #define CIRCLE '\xCD'
4180_1 7:e39a44de229a 45 #define FCIRCLE '\xCC'
4180_1 1:8b656995301f 46 #define TRIANGLE '\xC9'
4180_1 1:8b656995301f 47 #define LINE '\xD2'
4180_1 7:e39a44de229a 48 #define FRECTANGLE '\xCE'
4180_1 7:e39a44de229a 49 #define RECTANGLE '\xCF'
4180_1 1:8b656995301f 50 #define ELLIPSE '\x65' //na
4180_1 1:8b656995301f 51 #define PIXEL '\xCB'
4180_1 1:8b656995301f 52 #define READPIXEL '\xCA'
4180_1 1:8b656995301f 53 #define SCREENCOPY '\x63' //na?
4180_1 2:edae99e4abe7 54 #define PENSIZE '\xD8'
4180_1 1:8b656995301f 55 #define SETFONT '\x7D'
4180_1 1:8b656995301f 56 #define TEXTMODE '\x77'
4180_1 5:8936798c19a3 57 #define TEXTBOLD '\x76'
4180_1 5:8936798c19a3 58 #define TEXTITALIC '\x75'
4180_1 5:8936798c19a3 59 #define TEXTINVERSE '\x74'
4180_1 7:e39a44de229a 60 #define TEXTUNDERLINE '\x73'
4180_1 2:edae99e4abe7 61 #define TEXTWIDTH '\x7C'
4180_1 2:edae99e4abe7 62 #define TEXTHEIGHT '\x7B'
4180_1 1:8b656995301f 63 #define TEXTCHAR '\xFE'
4180_1 1:8b656995301f 64 #define TEXTSTRING '\x06' //null prefix
4180_1 7:e39a44de229a 65 #define MOVECURSOR '\xE4'
4180_1 3:9ba47197d94f 66 #define BLITCOM '\x0A'
4180_1 2:edae99e4abe7 67 #define PUTCHAR '\xFE'
4180_1 7:e39a44de229a 68 #define DISPPOWER '\x66'
4180_1 7:e39a44de229a 69 //media commands for uSD card
4180_1 6:b759b69cbaf9 70 #define MINIT '\xB1'
4180_1 6:b759b69cbaf9 71 #define SBADDRESS '\xB9'
4180_1 6:b759b69cbaf9 72 #define SSADDRESS '\xB8'
4180_1 6:b759b69cbaf9 73 #define READBYTE '\xB7'
4180_1 6:b759b69cbaf9 74 #define READWORD '\xB6'
4180_1 6:b759b69cbaf9 75 #define WRITEBYTE '\xB5'
4180_1 6:b759b69cbaf9 76 #define WRITEWORD '\xB4'
4180_1 6:b759b69cbaf9 77 #define FLUSHMEDIA '\xB2'
4180_1 6:b759b69cbaf9 78 #define DISPLAYIMAGE '\xB3'
4180_1 6:b759b69cbaf9 79 #define DISPLAYVIDEO '\xBB'
4180_1 6:b759b69cbaf9 80 #define DISPLAYFRAME '\xBA'
4180_1 6:b759b69cbaf9 81
4180_1 6:b759b69cbaf9 82
4180_1 1:8b656995301f 83
4180_1 1:8b656995301f 84 // Screen answers
4180_1 1:8b656995301f 85 #define ACK '\x06'
4180_1 1:8b656995301f 86 #define NAK '\x15'
4180_1 1:8b656995301f 87
4180_1 6:b759b69cbaf9 88
4180_1 6:b759b69cbaf9 89
4180_1 1:8b656995301f 90 // Screen states
4180_1 1:8b656995301f 91 #define OFF '\x00'
4180_1 1:8b656995301f 92 #define ON '\x01'
4180_1 1:8b656995301f 93
4180_1 1:8b656995301f 94 // Graphics modes
4180_1 1:8b656995301f 95 #define SOLID '\x00'
4180_1 1:8b656995301f 96 #define WIREFRAME '\x01'
4180_1 1:8b656995301f 97
4180_1 1:8b656995301f 98 // Text modes
4180_1 1:8b656995301f 99 #define TRANSPARENT '\x00'
4180_1 1:8b656995301f 100 #define OPAQUE '\x01'
4180_1 1:8b656995301f 101
4180_1 1:8b656995301f 102 // Fonts Sizes
4180_1 2:edae99e4abe7 103 #define FONT_7X8 '\x00' //only builtin font
4180_1 2:edae99e4abe7 104 #define FONT_5X7 '\x04'
4180_1 1:8b656995301f 105 #define FONT_8X8 '\x01'
4180_1 1:8b656995301f 106 #define FONT_8X12 '\x02'
4180_1 1:8b656995301f 107 #define FONT_12X16 '\x03'
4180_1 7:e39a44de229a 108 #define MEDIAFONT '\x07'
4180_1 1:8b656995301f 109
4180_1 1:8b656995301f 110
4180_1 1:8b656995301f 111 // Data speed
4180_1 1:8b656995301f 112 #define BAUD_110 27271
4180_1 1:8b656995301f 113 #define BAUD_300 9999
4180_1 1:8b656995301f 114 #define BAUD_600 4999
4180_1 1:8b656995301f 115 #define BAUD_1200 2499
4180_1 1:8b656995301f 116 #define BAUD_2400 1249
4180_1 1:8b656995301f 117 #define BAUD_4800 624
4180_1 1:8b656995301f 118 #define BAUD_9600 312
4180_1 1:8b656995301f 119 #define BAUD_14400 207
4180_1 1:8b656995301f 120 #define BAUD_19200 155
4180_1 1:8b656995301f 121 #define BAUD_31250 95
4180_1 1:8b656995301f 122 #define BAUD_38400 77
4180_1 1:8b656995301f 123 #define BAUD_56000 53
4180_1 1:8b656995301f 124 #define BAUD_57600 51
4180_1 1:8b656995301f 125 #define BAUD_115200 25
4180_1 1:8b656995301f 126 #define BAUD_128000 22
4180_1 1:8b656995301f 127 #define BAUD_256000 11
4180_1 5:8936798c19a3 128 #define BAUD_300000 10
4180_1 5:8936798c19a3 129 #define BAUD_375000 8
4180_1 5:8936798c19a3 130 #define BAUD_500000 6
4180_1 5:8936798c19a3 131 #define BAUD_600000 4
4180_1 7:e39a44de229a 132 #define BAUD_750000 3
4180_1 7:e39a44de229a 133 #define BAUD_1000000 2
4180_1 7:e39a44de229a 134 #define BAUD_1500000 1
4180_1 7:e39a44de229a 135 #define BAUD_3000000 0
4180_1 1:8b656995301f 136
4180_1 1:8b656995301f 137 // Defined Colors
4180_1 1:8b656995301f 138 #define WHITE 0xFFFFFF
4180_1 1:8b656995301f 139 #define BLACK 0x000000
4180_1 1:8b656995301f 140 #define RED 0xFF0000
4180_1 1:8b656995301f 141 #define GREEN 0x00FF00
4180_1 1:8b656995301f 142 #define BLUE 0x0000FF
4180_1 1:8b656995301f 143 #define LGREY 0xBFBFBF
4180_1 1:8b656995301f 144 #define DGREY 0x5F5F5F
4180_1 1:8b656995301f 145
4180_1 1:8b656995301f 146 // Mode data
4180_1 1:8b656995301f 147 #define BACKLIGHT '\x00'
4180_1 1:8b656995301f 148 #define DISPLAY '\x01'
4180_1 1:8b656995301f 149 #define CONTRAST '\x02'
4180_1 1:8b656995301f 150 #define POWER '\x03'
4180_1 1:8b656995301f 151 #define ORIENTATION '\x04'
4180_1 1:8b656995301f 152 #define TOUCH_CTRL '\x05'
4180_1 1:8b656995301f 153 #define IMAGE_FORMAT '\x06'
4180_1 1:8b656995301f 154 #define PROTECT_FAT '\x08'
4180_1 1:8b656995301f 155
4180_1 1:8b656995301f 156 // change this to your specific screen (newer versions) if needed
4180_1 1:8b656995301f 157 // Startup orientation is PORTRAIT so SIZE_X must be lesser than SIZE_Y
4180_1 7:e39a44de229a 158 //uLCD144-G2 is a 128 by 128 pixel display
4180_1 1:8b656995301f 159 #define SIZE_X 128
4180_1 1:8b656995301f 160 #define SIZE_Y 128
4180_1 1:8b656995301f 161
4180_1 1:8b656995301f 162 #define IS_LANDSCAPE 0
4180_1 1:8b656995301f 163 #define IS_PORTRAIT 1
4180_1 1:8b656995301f 164
4180_1 1:8b656995301f 165 // Screen orientation
4180_1 7:e39a44de229a 166 #define LANDSCAPE '\x00'
4180_1 7:e39a44de229a 167 #define LANDSCAPE_R '\x01'
4180_1 7:e39a44de229a 168 #define PORTRAIT '\x02'
4180_1 7:e39a44de229a 169 #define PORTRAIT_R '\x03'
4180_1 1:8b656995301f 170
4180_1 1:8b656995301f 171 // Parameters
4180_1 1:8b656995301f 172 #define ENABLE '\x00'
4180_1 1:8b656995301f 173 #define DISABLE '\x01'
4180_1 1:8b656995301f 174 #define RESET '\x02'
4180_1 1:8b656995301f 175
4180_1 1:8b656995301f 176 #define NEW '\x00'
4180_1 1:8b656995301f 177 #define OLD '\x01'
4180_1 1:8b656995301f 178
4180_1 1:8b656995301f 179 #define DOWN '\x00'
4180_1 1:8b656995301f 180 #define UP '\x01'
4180_1 1:8b656995301f 181
4180_1 1:8b656995301f 182 #define PROTECT '\x00'
4180_1 1:8b656995301f 183 #define UNPROTECT '\x02'
4180_1 1:8b656995301f 184
4180_1 1:8b656995301f 185 //**************************************************************************
4180_1 1:8b656995301f 186 // \class uLCD_4DGL uLCD_4DGL.h
4180_1 1:8b656995301f 187 // \brief This is the main class. It shoud be used like this : uLCD_4GDL myLCD(p9,p10,p11);
4180_1 1:8b656995301f 188 /**
4180_1 1:8b656995301f 189 Example:
4180_1 1:8b656995301f 190 * @code
4180_1 1:8b656995301f 191 * // Display a white circle on the screen
4180_1 1:8b656995301f 192 * #include "mbed.h"
4180_1 1:8b656995301f 193 * #include " uLCD_4DGL.h"
4180_1 1:8b656995301f 194 *
4180_1 1:8b656995301f 195 * uLCD_4GDL myLCD(p9,p10,p11);
4180_1 1:8b656995301f 196 *
4180_1 1:8b656995301f 197 * int main() {
4180_1 1:8b656995301f 198 * myLCD.circle(120, 160, 80, WHITE);
4180_1 1:8b656995301f 199 * }
4180_1 1:8b656995301f 200 * @endcode
4180_1 1:8b656995301f 201 */
4180_1 1:8b656995301f 202
4180_1 2:edae99e4abe7 203 class uLCD_4DGL : public Stream
4180_1 1:8b656995301f 204 {
4180_1 1:8b656995301f 205
4180_1 1:8b656995301f 206 public :
4180_1 1:8b656995301f 207
4180_1 1:8b656995301f 208 uLCD_4DGL(PinName tx, PinName rx, PinName rst);
4180_1 1:8b656995301f 209
4180_1 1:8b656995301f 210 // General Commands *******************************************************************************
4180_1 1:8b656995301f 211
4180_1 1:8b656995301f 212 /** Clear the entire screen using the current background colour */
4180_1 1:8b656995301f 213 void cls();
4180_1 1:8b656995301f 214
4180_1 1:8b656995301f 215 /** Reset screen */
4180_1 1:8b656995301f 216 void reset();
4180_1 1:8b656995301f 217
4180_1 7:e39a44de229a 218
4180_1 1:8b656995301f 219 /** Set serial Baud rate (both sides : screen and mbed)
4180_1 1:8b656995301f 220 * @param Speed Correct BAUD value (see uLCD_4DGL.h)
4180_1 1:8b656995301f 221 */
4180_1 1:8b656995301f 222 void baudrate(int speed);
4180_1 1:8b656995301f 223
4180_1 1:8b656995301f 224 /** Set background colour to the specified value
4180_1 1:8b656995301f 225 * @param color in HEX RGB like 0xFF00FF
4180_1 1:8b656995301f 226 */
4180_1 1:8b656995301f 227 void background_color(int color);
4180_1 1:8b656995301f 228
4180_1 1:8b656995301f 229 /** Set screen display mode to specific values
4180_1 1:8b656995301f 230 * @param mode See 4DGL documentation
4180_1 1:8b656995301f 231 * @param value See 4DGL documentation
4180_1 1:8b656995301f 232 */
4180_1 2:edae99e4abe7 233 void textbackground_color(int color);
4180_1 2:edae99e4abe7 234
4180_1 2:edae99e4abe7 235 /** Set screen display mode to specific values
4180_1 2:edae99e4abe7 236 * @param mode See 4DGL documentation
4180_1 2:edae99e4abe7 237 * @param value See 4DGL documentation
4180_1 2:edae99e4abe7 238 */
4180_1 7:e39a44de229a 239 void display_control(char mode);
4180_1 7:e39a44de229a 240 void display_power(char mode);
4180_1 1:8b656995301f 241 /** Set internal speaker to specified value
4180_1 1:8b656995301f 242 * @param value Correct range is 8 - 127
4180_1 1:8b656995301f 243 */
4180_1 1:8b656995301f 244 void set_volume(char value);
4180_1 1:8b656995301f 245
4180_1 1:8b656995301f 246 // Graphics Commands *******************************************************************************
4180_1 1:8b656995301f 247
4180_1 1:8b656995301f 248 /** Draw a circle centered at x,y with a radius and a colour. It uses Pen Size stored value to draw a solid or wireframe circle
4180_1 1:8b656995301f 249 * @param x Horizontal position of the circle centre
4180_1 1:8b656995301f 250 * @param y Vertical position of the circle centre
4180_1 1:8b656995301f 251 * @param radius Radius of the circle
4180_1 1:8b656995301f 252 * @param color Circle color in HEX RGB like 0xFF00FF
4180_1 1:8b656995301f 253 */
4180_1 1:8b656995301f 254 void circle(int x , int y , int radius, int color);
4180_1 7:e39a44de229a 255 void filled_circle(int x , int y , int radius, int color);
4180_1 1:8b656995301f 256 void triangle(int, int, int, int, int, int, int);
4180_1 1:8b656995301f 257 void line(int, int, int, int, int);
4180_1 1:8b656995301f 258 void rectangle(int, int, int, int, int);
4180_1 7:e39a44de229a 259 void filled_rectangle(int, int, int, int, int);
4180_1 1:8b656995301f 260 void pixel(int, int, int);
4180_1 1:8b656995301f 261 int read_pixel(int, int);
4180_1 1:8b656995301f 262 void pen_size(char);
4180_1 3:9ba47197d94f 263 void BLIT(int x, int y, int w, int h, int *colors);
4180_1 1:8b656995301f 264
4180_1 7:e39a44de229a 265 // Text Commands
4180_1 1:8b656995301f 266 void set_font(char);
4180_1 7:e39a44de229a 267 void set_font_size(char width, char height);
4180_1 1:8b656995301f 268 void text_mode(char);
4180_1 5:8936798c19a3 269 void text_bold(char);
4180_1 5:8936798c19a3 270 void text_italic(char);
4180_1 5:8936798c19a3 271 void text_inverse(char);
4180_1 7:e39a44de229a 272 void text_underline(char);
4180_1 2:edae99e4abe7 273 void text_width(char);
4180_1 2:edae99e4abe7 274 void text_height(char);
4180_1 1:8b656995301f 275 void text_char(char, char, char, int);
4180_1 1:8b656995301f 276 void text_string(char *, char, char, char, int);
4180_1 1:8b656995301f 277 void locate(char, char);
4180_1 1:8b656995301f 278 void color(int);
4180_1 1:8b656995301f 279 void putc(char);
4180_1 1:8b656995301f 280 void puts(char *);
4180_1 1:8b656995301f 281
4180_1 6:b759b69cbaf9 282 //Media Commands
4180_1 6:b759b69cbaf9 283 int media_init();
4180_1 6:b759b69cbaf9 284 void set_byte_address(int, int);
4180_1 6:b759b69cbaf9 285 void set_sector_address(int, int);
4180_1 6:b759b69cbaf9 286 char read_byte();
4180_1 6:b759b69cbaf9 287 int read_word();
4180_1 6:b759b69cbaf9 288 void write_byte(int);
4180_1 6:b759b69cbaf9 289 void write_word(int);
4180_1 6:b759b69cbaf9 290 void flush_media();
4180_1 6:b759b69cbaf9 291 void display_image(int, int);
4180_1 6:b759b69cbaf9 292 void display_video(int, int);
4180_1 7:e39a44de229a 293 void display_frame(int, int, int);
4180_1 1:8b656995301f 294
4180_1 1:8b656995301f 295 // Screen Data
4180_1 1:8b656995301f 296 int type;
4180_1 1:8b656995301f 297 int revision;
4180_1 1:8b656995301f 298 int firmware;
4180_1 1:8b656995301f 299 int reserved1;
4180_1 1:8b656995301f 300 int reserved2;
4180_1 1:8b656995301f 301
4180_1 1:8b656995301f 302 // Text data
4180_1 1:8b656995301f 303 char current_col;
4180_1 1:8b656995301f 304 char current_row;
4180_1 1:8b656995301f 305 int current_color;
4180_1 1:8b656995301f 306 char current_font;
4180_1 1:8b656995301f 307 char current_orientation;
4180_1 1:8b656995301f 308 char max_col;
4180_1 1:8b656995301f 309 char max_row;
4180_1 2:edae99e4abe7 310 int current_w, current_h;
4180_1 2:edae99e4abe7 311 int current_fx, current_fy;
4180_1 2:edae99e4abe7 312 int current_wf, current_hf;
4180_1 5:8936798c19a3 313
4180_1 1:8b656995301f 314
4180_1 1:8b656995301f 315 protected :
4180_1 1:8b656995301f 316
4180_1 1:8b656995301f 317 Serial _cmd;
4180_1 1:8b656995301f 318 DigitalOut _rst;
4180_1 2:edae99e4abe7 319 //used by printf
4180_1 2:edae99e4abe7 320 virtual int _putc(int c) {
4180_1 2:edae99e4abe7 321 putc(c);
4180_1 2:edae99e4abe7 322 return 0;
4180_1 2:edae99e4abe7 323 };
4180_1 2:edae99e4abe7 324 virtual int _getc() {
4180_1 7:e39a44de229a 325 return -1;
4180_1 2:edae99e4abe7 326 }
4180_1 2:edae99e4abe7 327
4180_1 1:8b656995301f 328 void freeBUFFER (void);
4180_1 1:8b656995301f 329 void writeBYTE (char);
4180_1 4:74df7fc26fef 330 void writeBYTEfast (char);
4180_1 1:8b656995301f 331 int writeCOMMAND(char *, int);
4180_1 1:8b656995301f 332 int writeCOMMANDnull(char *, int);
4180_1 1:8b656995301f 333 int readVERSION (char *, int);
4180_1 1:8b656995301f 334 int getSTATUS (char *, int);
4180_1 7:e39a44de229a 335 int version (void);
4180_1 1:8b656995301f 336 #if DEBUGMODE
4180_1 1:8b656995301f 337 Serial pc;
4180_1 1:8b656995301f 338 #endif // DEBUGMODE
4180_1 1:8b656995301f 339 };
4180_1 1:8b656995301f 340
4180_1 1:8b656995301f 341 typedef unsigned char BYTE;
4180_1 1:8b656995301f 342
jchin32 9:df8988c8d7d1 343 #endif
4180_1 1:8b656995301f 344
4180_1 2:edae99e4abe7 345
4180_1 4:74df7fc26fef 346
4180_1 5:8936798c19a3 347
4180_1 5:8936798c19a3 348
4180_1 6:b759b69cbaf9 349
4180_1 7:e39a44de229a 350