MCUFRIEND_kbv.h

00001 /*
00002  * MCUFRIEND_kbv class inherits from Adafruit_GFX class and the Arduino Print class.
00003  * Any use of MCUFRIEND_kbv class and examples is dependent on Adafruit and Arduino licenses
00004  * The license texts are in the accompanying license.txt file
00005  */
00006 
00007 #ifndef MCUFRIEND_KBV_H_
00008 #define MCUFRIEND_KBV_H_   299
00009 
00010 //#define USE_SERIAL
00011 
00012 #if ARDUINO < 101
00013 #define USE_GFX_KBV
00014 #include "ADA_GFX_kbv.h"
00015 #else
00016 #include "Adafruit_GFX.h"
00017 #endif
00018 
00019 class MCUFRIEND_kbv : public Adafruit_GFX {
00020 
00021     public:
00022 //  MCUFRIEND_kbv(int CS=A3, int RS=A2, int WR=A1, int RD=A0, int RST=A4); //shield wiring
00023     MCUFRIEND_kbv(int CS=0, int RS=0, int WR=0, int RD=0, int _RST=0);  //dummy arguments 
00024     void     reset(void);                                       // you only need the constructor
00025     void     begin(uint16_t ID = 0x9341);                       // you only need the constructor
00026     virtual void     drawPixel(int16_t x, int16_t y, uint16_t color);  // and these three
00027     void     WriteCmdData(uint16_t cmd, uint16_t dat);                 // ?public methods !!!
00028     void     pushCommand(uint16_t cmd, uint8_t * block, int8_t N);
00029     uint16_t color565(uint8_t r, uint8_t g, uint8_t b) { return ((r & 0xF8) << 8) | ((g & 0xFC) << 3) | ((b & 0xF8) >> 3); }
00030     uint16_t readID(void);
00031     virtual void     fillRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);
00032     virtual void     drawFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color) { fillRect(x, y, 1, h, color); }
00033     virtual void     drawFastHLine(int16_t x, int16_t y, int16_t w, uint16_t color) { fillRect(x, y, w, 1, color); }
00034     virtual void     fillScreen(uint16_t color)                                     { fillRect(0, 0, _width, _height, color); }
00035     virtual void     setRotation(uint8_t r);
00036     virtual void     invertDisplay(boolean i);
00037 
00038     uint16_t readReg(uint16_t reg, int8_t index=0);
00039     int16_t  readGRAM(int16_t x, int16_t y, uint16_t *block, int16_t w, int16_t h);
00040     uint16_t readPixel(int16_t x, int16_t y) { uint16_t color; readGRAM(x, y, &color, 1, 1); return color; }
00041     void     setAddrWindow(int16_t x, int16_t y, int16_t x1, int16_t y1);
00042     void     pushColors(uint16_t *block, int16_t n, bool first);
00043     void     pushColors(uint8_t *block, int16_t n, bool first);
00044     void     pushColors(const uint8_t *block, int16_t n, bool first, bool bigend = false);
00045     void     vertScroll(int16_t top, int16_t scrollines, int16_t offset);
00046 
00047     protected:
00048     uint32_t readReg32(uint16_t reg);
00049     uint32_t readReg40(uint16_t reg);
00050     uint16_t  _lcd_xor, _lcd_capable;
00051 
00052     private:
00053     uint16_t _lcd_ID, _lcd_rev, _lcd_madctl, _lcd_drivOut, _MC, _MP, _MW, _SC, _EC, _SP, _EP;
00054 };
00055 
00056 // New color definitions.  thanks to Bodmer
00057 #define TFT_BLACK       0x0000      /*   0,   0,   0 */
00058 #define TFT_NAVY        0x000F      /*   0,   0, 128 */
00059 #define TFT_DARKGREEN   0x03E0      /*   0, 128,   0 */
00060 #define TFT_DARKCYAN    0x03EF      /*   0, 128, 128 */
00061 #define TFT_MAROON      0x7800      /* 128,   0,   0 */
00062 #define TFT_PURPLE      0x780F      /* 128,   0, 128 */
00063 #define TFT_OLIVE       0x7BE0      /* 128, 128,   0 */
00064 #define TFT_LIGHTGREY   0xC618      /* 192, 192, 192 */
00065 #define TFT_DARKGREY    0x7BEF      /* 128, 128, 128 */
00066 #define TFT_BLUE        0x001F      /*   0,   0, 255 */
00067 #define TFT_GREEN       0x07E0      /*   0, 255,   0 */
00068 #define TFT_CYAN        0x07FF      /*   0, 255, 255 */
00069 #define TFT_RED         0xF800      /* 255,   0,   0 */
00070 #define TFT_MAGENTA     0xF81F      /* 255,   0, 255 */
00071 #define TFT_YELLOW      0xFFE0      /* 255, 255,   0 */
00072 #define TFT_WHITE       0xFFFF      /* 255, 255, 255 */
00073 #define TFT_ORANGE      0xFDA0      /* 255, 180,   0 */
00074 #define TFT_GREENYELLOW 0xB7E0      /* 180, 255,   0 */
00075 #define TFT_PINK        0xFC9F
00076 
00077 #endif