Diff: uLCD_4DGL.h

Revision:

1:8b656995301f

Child:

2:edae99e4abe7

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/uLCD_4DGL.h	Mon Nov 11 01:22:41 2013 +0000
@@ -0,0 +1,287 @@
+//
+// uLCD_4DGL is a class to drive 4D Systems TFT touch screens
+//
+// Copyright (C) <2010> Stephane ROCHON <stephane.rochon at free.fr>
+//
+// uLCD_4DGL is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// uLCD_4DGL is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with uLCD_4DGL.  If not, see <http://www.gnu.org/licenses/>.
+
+// @author Stephane Rochon
+
+#include "mbed.h"
+
+// Debug Verbose on terminal enabled
+#ifndef DEBUGMODE
+#define DEBUGMODE 1
+#endif
+
+// Common WAIT value in millisecond
+#define TEMPO 5
+
+// 4DGL Functions values
+#define AUTOBAUD     '\x55'
+#define CLS          '\xD7'
+#define BAUDRATE     '\x0B' //null prefix
+#define VERSION      '\x08' //null prefix
+#define BCKGDCOLOR   '\x6E'
+#define DISPCONTROL  '\x68'
+#define SETVOLUME    '\x76'
+#define CIRCLE       '\xCC'
+#define TRIANGLE     '\xC9'
+#define LINE         '\xD2'
+#define RECTANGLE    '\xCE'
+#define ELLIPSE      '\x65' //na
+#define PIXEL        '\xCB'
+#define READPIXEL    '\xCA'
+#define SCREENCOPY   '\x63'  //na?
+#define PENSIZE      '\x70'  //na
+#define SETFONT      '\x7D'
+#define TEXTMODE     '\x77'
+#define TEXTCHAR     '\xFE'
+#define GRAPHCHAR    '\x74'
+#define TEXTSTRING   '\x06'  //null prefix
+#define GRAPHSTRING  '\x53'
+#define TEXTBUTTON   '\x62'
+#define GETTOUCH     '\x6F'
+#define WAITTOUCH    '\x77'
+#define SETTOUCH     '\x75'
+
+
+// Screen answers
+#define ACK          '\x06'
+#define NAK          '\x15'
+
+// Screen states
+#define OFF          '\x00'
+#define ON           '\x01'
+
+// Graphics modes
+#define SOLID        '\x00'
+#define WIREFRAME    '\x01'
+
+// Text modes
+#define TRANSPARENT  '\x00'
+#define OPAQUE       '\x01'
+
+// Fonts Sizes
+#define FONT_5X7     '\x00'
+#define FONT_8X8     '\x01'
+#define FONT_8X12    '\x02'
+#define FONT_12X16   '\x03'
+
+// Touch Values
+#define WAIT         '\x00'
+#define PRESS        '\x01'
+#define RELEASE      '\x02'
+#define MOVE         '\x03'
+#define STATUS       '\x04'
+#define GETPOSITION  '\x05'
+
+// Data speed
+#define BAUD_110     27271
+#define BAUD_300     9999
+#define BAUD_600     4999
+#define BAUD_1200    2499
+#define BAUD_2400    1249
+#define BAUD_4800    624
+#define BAUD_9600    312
+#define BAUD_14400   207
+#define BAUD_19200   155
+#define BAUD_31250   95
+#define BAUD_38400   77
+#define BAUD_56000   53
+#define BAUD_57600   51
+#define BAUD_115200  25
+#define BAUD_128000  22
+#define BAUD_256000  11
+
+// Defined Colors
+#define WHITE 0xFFFFFF
+#define BLACK 0x000000
+#define RED   0xFF0000
+#define GREEN 0x00FF00
+#define BLUE  0x0000FF
+#define LGREY 0xBFBFBF
+#define DGREY 0x5F5F5F
+
+// Mode data
+#define BACKLIGHT    '\x00'
+#define DISPLAY      '\x01'
+#define CONTRAST     '\x02'
+#define POWER        '\x03'
+#define ORIENTATION  '\x04'
+#define TOUCH_CTRL   '\x05'
+#define IMAGE_FORMAT '\x06'
+#define PROTECT_FAT  '\x08'
+
+// change this to your specific screen (newer versions) if needed
+// Startup orientation is PORTRAIT so SIZE_X must be lesser than SIZE_Y
+#define SIZE_X       128
+#define SIZE_Y       128
+
+#define IS_LANDSCAPE 0
+#define IS_PORTRAIT  1
+
+// Screen orientation
+#define LANDSCAPE    '\x01'
+#define LANDSCAPE_R  '\x02'
+#define PORTRAIT     '\x03'
+#define PORTRAIT_R   '\x04'
+
+// Parameters
+#define ENABLE       '\x00'
+#define DISABLE      '\x01'
+#define RESET        '\x02'
+
+#define NEW          '\x00'
+#define OLD          '\x01'
+
+#define DOWN         '\x00'
+#define UP           '\x01'
+
+#define PROTECT      '\x00'
+#define UNPROTECT    '\x02'
+
+//**************************************************************************
+// \class uLCD_4DGL uLCD_4DGL.h
+// \brief This is the main class. It shoud be used like this : uLCD_4GDL myLCD(p9,p10,p11);
+/**
+Example:
+* @code
+* // Display a white circle on the screen
+* #include "mbed.h"
+* #include " uLCD_4DGL.h"
+*
+* uLCD_4GDL myLCD(p9,p10,p11);
+*
+* int main() {
+*     myLCD.circle(120, 160, 80, WHITE);
+* }
+* @endcode
+*/
+
+class uLCD_4DGL
+{
+
+public :
+
+    uLCD_4DGL(PinName tx, PinName rx, PinName rst);
+
+// General Commands *******************************************************************************
+
+    /** Clear the entire screen using the current background colour */
+    void cls();
+
+    /** Reset screen */
+    void reset();
+
+    /** Launch Autobaud for serial communication. This function is automatically called at startup */
+    void autobaud();
+    /** Set serial Baud rate (both sides : screen and mbed)
+    * @param Speed Correct BAUD value (see uLCD_4DGL.h)
+    */
+    void baudrate(int speed);
+
+    /** Set background colour to the specified value
+    * @param color in HEX RGB like 0xFF00FF
+    */
+    void background_color(int color);
+
+    /** Set screen display mode to specific values
+    * @param mode See 4DGL documentation
+    * @param value See 4DGL documentation
+    */
+    void display_control(char mode, char value);
+
+    /** Set internal speaker to specified value
+    * @param value Correct range is 8 - 127
+    */
+    void set_volume(char value);
+
+// Graphics Commands *******************************************************************************
+
+    /** 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
+    * @param x Horizontal position of the circle centre
+    * @param y Vertical position of the circle centre
+    * @param radius Radius of the circle
+    * @param color Circle color in HEX RGB like 0xFF00FF
+    */
+    void circle(int x , int y , int radius, int color);
+
+    void triangle(int, int, int, int, int, int, int);
+    void line(int, int, int, int, int);
+    void rectangle(int, int, int, int, int);
+    void ellipse(int, int, int, int, int);
+    void pixel(int, int, int);
+    int  read_pixel(int, int);
+    void screen_copy(int, int, int, int, int, int);
+    void pen_size(char);
+
+// Texts Commands
+    void set_font(char);
+    void text_mode(char);
+    void text_char(char, char, char, int);
+    void graphic_char(char, int, int, int, char, char);
+    void text_string(char *, char, char, char, int);
+    void graphic_string(char *, int, int, char, int, char, char);
+    void text_button(char *, char, int, int, int, char, int, char, char);
+
+    void locate(char, char);
+    void color(int);
+    void putc(char);
+    void puts(char *);
+
+// Touch Command
+    void touch_mode(char);
+    void get_touch(int *, int *);
+    void wait_touch(int);
+    void set_touch(int, int, int, int);
+    int  touch_status(void);
+
+// Screen Data
+    int type;
+    int revision;
+    int firmware;
+    int reserved1;
+    int reserved2;
+
+// Text data
+    char current_col;
+    char current_row;
+    int  current_color;
+    char current_font;
+    char current_orientation;
+    char max_col;
+    char max_row;
+
+protected :
+
+    Serial     _cmd;
+    DigitalOut _rst;
+
+    void freeBUFFER  (void);
+    void writeBYTE   (char);
+    int  writeCOMMAND(char *, int);
+    int  writeCOMMANDnull(char *, int);
+    int  readVERSION (char *, int);
+    void getTOUCH    (char *, int, int *,int *);
+    int  getSTATUS   (char *, int);
+    void version     (void);
+#if DEBUGMODE
+    Serial pc;
+#endif // DEBUGMODE
+};
+
+typedef unsigned char BYTE;
+
+