Joseph Boettcher / 4DGL-uLCD-SE_

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of 4DGL-uLCD-SE by jim hamblen

uLCD_4DGL.h@7:e39a44de229a, 2013-11-30 (annotated)

Committer:
4180_1
Date:
Sat Nov 30 02:05:15 2013 +0000
Revision:
7:e39a44de229a
Parent:
6:b759b69cbaf9
Child:
8:8100c7d2fe07
Child:
9:2cb1845d7681
ver1.5

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