FT81x.h

Go to the documentation of this file.

 
#pragma once
 
#include <Arduino.h>
#include <SPI.h>
 
#if (defined(__arm__) && defined(TEENSYDUINO))
#define FT81x_USE_TEENSY_DMA 1
#include "platforms/teensy/DmaSpi.h"
#endif
 
#define FT81x_COLOR_RGB(r, g, b) (((uint32_t)(r) << 16) | ((uint32_t)(g) << 8) | (uint32_t)(b))  
 
#define FT81x_ROTATE_LANDSCAPE                   0  
#define FT81x_ROTATE_LANDSCAPE_INVERTED          1  
#define FT81x_ROTATE_PORTRAIT                    2  
#define FT81x_ROTATE_PORTRAIT_INVERTED           3  
#define FT81x_ROTATE_LANDSCAPE_MIRRORED          4  
#define FT81x_ROTATE_LANDSCAPE_INVERTED_MIRRORED 5  
#define FT81x_ROTATE_PORTRAIT_MIRRORED           6  
#define FT81x_ROTATE_PORTRAIT_INVERTED_MIRRORED  7  
 
#if defined(ARDUINO_ARCH_ARC32)
#define FT81x_SPI_CLOCK_SPEED 16000000  
#elif defined(ARDUINO_ARCH_SAM)
#define FT81x_SPI_CLOCK_SPEED 24000000  
#elif defined(__MK20DX128__) || defined(__MK20DX256__) || defined(__MK64FX512__) || defined(__MK66FX1M0__) || defined(__IMXRT1062__)
#define FT81x_SPI_CLOCK_SPEED 24000000  
#elif defined(ESP8266) || defined(ESP32)
#define FT81x_SPI_CLOCK_SPEED 24000000  
#else
#define FT81x_SPI_CLOCK_SPEED 8000000  
#endif
 
#ifndef FT81x_SPI_SETTINGS
#define FT81x_SPI_SETTINGS SPISettings(FT81x_SPI_CLOCK_SPEED, MSBFIRST, SPI_MODE0)  
#endif
 
#define FT81x_CMD_ACTIVE    0x000000  
#define FT81x_CMD_STANDBY   0x410000  
#define FT81x_CMD_SLEEP     0x420000  
#define FT81x_CMD_PWRDOWN   0x430000  
#define FT81x_CMD_CLKEXT    0x440000  
#define FT81x_CMD_CLKINT    0x480000  
#define FT81x_CMD_CLKSEL    0x610000  
#define FT81x_CMD_RST_PULSE 0x680000  
#define FT81x_CMD_PINDRIVE  0x700000  
 
#define FT81x_REG_ID               0x302000  
#define FT81x_REG_FRAMES           0x302004  
#define FT81x_REG_CLOCK            0x302008  
#define FT81x_REG_FREQUENCY        0x30200C  
#define FT81x_REG_RENDERMODE       0x302010  
#define FT81x_REG_SNAPY            0x302014  
#define FT81x_REG_SNAPSHOT         0x302018  
#define FT81x_REG_SNAPFORMAT       0x30201C  
#define FT81x_REG_CPURESET         0x302020  
#define FT81x_REG_TAP_CRC          0x302024  
#define FT81x_REG_TAP_MASK         0x302028  
#define FT81x_REG_HCYCLE           0x30202C  
#define FT81x_REG_HOFFSET          0x302030  
#define FT81x_REG_HSIZE            0x302034  
#define FT81x_REG_HSYNC0           0x302038  
#define FT81x_REG_HSYNC1           0x30203C  
#define FT81x_REG_VCYCLE           0x302040  
#define FT81x_REG_VOFFSET          0x302044  
#define FT81x_REG_VSIZE            0x302048  
#define FT81x_REG_VSYNC0           0x30204C  
#define FT81x_REG_VSYNC1           0x302050  
#define FT81x_REG_DLSWAP           0x302054  
#define FT81x_REG_ROTATE           0x302058  
#define FT81x_REG_OUTBITS          0x30205C  
#define FT81x_REG_DITHER           0x302060  
#define FT81x_REG_SWIZZLE          0x302064  
#define FT81x_REG_CSPREAD          0x302068  
#define FT81x_REG_PCLK_POL         0x30206C  
#define FT81x_REG_PCLK             0x302070  
#define FT81x_REG_TAG_X            0x302074  
#define FT81x_REG_TAG_Y            0x302078  
#define FT81x_REG_TAG              0x30207C  
#define FT81x_REG_VOL_PB           0x302080  
#define FT81x_REG_VOL_SOUND        0x302084  
#define FT81x_REG_SOUND            0x302088  
#define FT81x_REG_PLAY             0x30208C  
#define FT81x_REG_GPIO_DIR         0x302090  
#define FT81x_REG_GPIO             0x302094  
#define FT81x_REG_GPIOX_DIR        0x302098  
#define FT81x_REG_GPIOX            0x30209C  
#define FT81x_REG_INT_FLAGS        0x3020A8  
#define FT81x_REG_INT_EN           0x3020AC  
#define FT81x_REG_INT_MASK         0x3020B0  
#define FT81x_REG_PLAYBACK_START   0x3020B4  
#define FT81x_REG_PLAYBACK_LENGTH  0x3020B8  
#define FT81x_REG_PLAYBACK_READPTR 0x3020BC  
#define FT81x_REG_PLAYBACK_FREQ    0x3020C0  
#define FT81x_REG_PLAYBACK_FORMAT  0x3020C4  
#define FT81x_REG_PLAYBACK_LOOP    0x3020C8  
#define FT81x_REG_PLAYBACK_PLAY    0x3020CC  
#define FT81x_REG_PWM_HZ           0x3020D0  
#define FT81x_REG_PWM_DUTY         0x3020D4  
#define FT81x_REG_MACRO_0          0x3020D8  
#define FT81x_REG_MACRO_1          0x3020DC  
#define FT81x_REG_CMD_READ         0x3020F8  
#define FT81x_REG_CMD_WRITE        0x3020FC  
#define FT81x_REG_CMD_DL           0x302100  
#define FT81x_REG_BIST_EN          0x302174  
#define FT81x_REG_TRIM             0x302180  
#define FT81x_REG_ANA_COMP         0x302184  
#define FT81x_REG_SPI_WIDTH        0x302188  
#define FT81x_REG_DATESTAMP        0x302564  
#define FT81x_REG_CMDB_SPACE       0x302574  
#define FT81x_REG_CMDB_WRITE       0x302578  
#define FT81x_REG_MEDIAFIFO_READ   0x309014  
#define FT81x_REG_MEDIAFIFO_WRITE  0x309018  
 
#define FT81x_RAM_G         0x000000  
#define FT81x_ROM_FONT      0x1E0000  
#define FT81x_ROM_FONT_ADDR 0x2FFFFC  
#define FT81x_RAM_DL        0x300000  
#define FT81x_RAM_REG       0x302000  
#define FT81x_RAM_CMD       0x308000  
 
#define FT81x_DLSWAP_LINE  0x1  
#define FT81x_DLSWAP_FRAME 0x2  
 
#define FT81x_BITMAP_LAYOUT_ARGB1555 0x1  
#define FT81x_BITMAP_LAYOUT_ARGB4    0x6  
#define FT81x_BITMAP_LAYOUT_RGB565   0x7  
 
#define FT81x_BITMAP_SIZE_NEAREST  0x0  
#define FT81x_BITMAP_SIZE_BILINEAR 0x1  
 
#define FT81x_OPT_3D        0x0000  
#define FT81x_OPT_FLAT      0x0100  
#define FT81x_OPT_SIGNED    0x0100  
#define FT81x_OPT_CENTERX   0x0200  
#define FT81x_OPT_CENTERY   0x0400  
#define FT81x_OPT_CENTER    0x0600  
#define FT81x_OPT_RIGHTX    0x0800  
#define FT81x_OPT_NOBACK    0x1000  
#define FT81x_OPT_NOTICKS   0x2000  
#define FT81x_OPT_NOHM      0x4000  
#define FT81x_OPT_NOPOINTER 0x4000  
#define FT81x_OPT_NOSECS    0x8000  
#define FT81x_OPT_NOHANDS   0xC000  
 
#define FT81x_AUDIO_FORMAT_LINEAR 0x0  
#define FT81x_AUDIO_FORMAT_ULAW   0x1  
#define FT81x_AUDIO_FORMAT_ADPCM  0x2  
 
#define FT81x_SOUND_SILENCE       0x00  
#define FT81x_SOUND_SQUARE_WAVE   0x01  
#define FT81x_SOUND_SINE_WAVE     0x02  
#define FT81x_SOUND_SAWTOOTH_WAVE 0x03  
#define FT81x_SOUND_TRIANGLE_WAVE 0x04  
#define FT81x_SOUND_BEEPING       0x05  
#define FT81x_SOUND_ALARM         0x06  
#define FT81x_SOUND_WARBLE        0x07  
#define FT81x_SOUND_CAROUSEL      0x08  
#define FT81x_SOUND_1_SHORT_PIP   0x10  
#define FT81x_SOUND_2_SHORT_PIPS  0x11  
#define FT81x_SOUND_3_SHORT_PIPS  0x12  
#define FT81x_SOUND_4_SHORT_PIPS  0x13  
#define FT81x_SOUND_5_SHORT_PIPS  0x14  
#define FT81x_SOUND_6_SHORT_PIPS  0x15  
#define FT81x_SOUND_7_SHORT_PIPS  0x16  
#define FT81x_SOUND_8_SHORT_PIPS  0x17  
#define FT81x_SOUND_9_SHORT_PIPS  0x18  
#define FT81x_SOUND_10_SHORT_PIPS 0x19  
#define FT81x_SOUND_11_SHORT_PIPS 0x1A  
#define FT81x_SOUND_12_SHORT_PIPS 0x1B  
#define FT81x_SOUND_13_SHORT_PIPS 0x1C  
#define FT81x_SOUND_14_SHORT_PIPS 0x1D  
#define FT81x_SOUND_15_SHORT_PIPS 0x1E  
#define FT81x_SOUND_16_SHORT_PIPS 0x1F  
#define FT81x_SOUND_DTMF_HASH     0x23  
#define FT81x_SOUND_DTMF_STAR     0x2C  
#define FT81x_SOUND_DTMF_0        0x30  
#define FT81x_SOUND_DTMF_1        0x31  
#define FT81x_SOUND_DTMF_2        0x32  
#define FT81x_SOUND_DTMF_3        0x33  
#define FT81x_SOUND_DTMF_4        0x34  
#define FT81x_SOUND_DTMF_5        0x35  
#define FT81x_SOUND_DTMF_6        0x36  
#define FT81x_SOUND_DTMF_7        0x37  
#define FT81x_SOUND_DTMF_8        0x38  
#define FT81x_SOUND_DTMF_9        0x39  
#define FT81x_SOUND_HARP          0x40  
#define FT81x_SOUND_XYLOPHONE     0x41  
#define FT81x_SOUND_TUBA          0x42  
#define FT81x_SOUND_GLOCKENSPIEL  0x43  
#define FT81x_SOUND_ORGAN         0x44  
#define FT81x_SOUND_TRUMPET       0x45  
#define FT81x_SOUND_PIANO         0x46  
#define FT81x_SOUND_CHIMES        0x47  
#define FT81x_SOUND_MUSIC_BOX     0x48  
#define FT81x_SOUND_BELL          0x49  
#define FT81x_SOUND_CLICK         0x50  
#define FT81x_SOUND_SWITCH        0x51  
#define FT81x_SOUND_COWBELL       0x52  
#define FT81x_SOUND_NOTCH         0x53  
#define FT81x_SOUND_HIHAT         0x54  
#define FT81x_SOUND_KICKDRUM      0x55  
#define FT81x_SOUND_POP           0x56  
#define FT81x_SOUND_CLACK         0x57  
#define FT81x_SOUND_CHACK         0x58  
#define FT81x_SOUND_MUTE          0x60  
#define FT81x_SOUND_UNMUTE        0x61  
 
#define ST7701_SWRESET   0x01  
#define ST7701_RDDPM     0x0A  
#define ST7701_RDDCOLMOD 0x0C  
#define ST7701_RDDIM     0x0D  
#define ST7701_RDDSM     0x0E  
#define ST7701_RDDSDR    0x0F  
#define ST7701_SLPIN     0x10  
#define ST7701_SLPOUT    0x11  
#define ST7701_PTLON     0x12  
#define ST7701_NORON     0x13  
#define ST7701_INVOFF    0x20  
#define ST7701_INVON     0x21  
#define ST7701_DISPOFF   0x28  
#define ST7701_DISPON    0x29  
#define ST7701_TEON      0x35  
#define ST7701_MADCTL    0x36  
#define ST7701_COLMOD    0x3A  
#define ST7701_WRDISBV   0x51  
#define ST7701_SDIR      0xC7  
#define ST7701_RDID1     0xDA  
#define ST7701_RDID2     0xDB  
#define ST7701_RDID3     0xDC  
 
#define ST7701_CND2BKxSEL 0xFF  
 
#define ST7701_BK0_PVGAMCTRL 0xB0  
#define ST7701_BK0_NVGAMCTRL 0xB1  
#define ST7701_BK0_LNESET    0xC0  
#define ST7701_BK0_PORCTRL   0xC1  
#define ST7701_BK0_INVSEL    0xC2  
#define ST7701_BK0_RGBCTRL   0xC3  
#define ST7701_BK0_PARCTRL   0xC5  
#define ST7701_BK0_SDIR      0xC7  
 
#define ST7701_BK1_VRHS    0xB0  
#define ST7701_BK1_VCOM    0xB1  
#define ST7701_BK1_VGHSS   0xB2  
#define ST7701_BK1_TESTCMD 0xB3  
#define ST7701_BK1_VGLS    0xB5  
#define ST7701_BK1_PWCTLR1 0xB7  
#define ST7701_BK1_PWCTLR2 0xB8  
#define ST7701_BK1_SPD1    0xC1  
#define ST7701_BK1_SPD2    0xC2  
 
#define ST7701_CMD2BKxSEL_NONE 0x00  
#define ST7701_CMD2BK0SEL      0x10  
#define ST7701_CMD2BK1SEL      0x11  
 
 
class FT81x {
   public:
    FT81x(int8_t cs1, int8_t cs2, int8_t dc) : cs1(cs1), cs2(cs2), dc(dc) {}
 
    void begin();
 
    void sendCommand(const uint32_t cmd);
 
    uint8_t read8(const uint32_t address);
 
    uint16_t read16(const uint32_t address);
 
    uint32_t read32(const uint32_t address);
 
    void write8(const uint32_t address, const uint8_t data);
 
    void write16(const uint32_t address, const uint16_t data);
 
    void write32(const uint32_t address, const uint32_t data);
 
    void clear(const uint32_t color);
 
    void drawCircle(const int16_t x, const int16_t y, const uint8_t size, const uint32_t color);
 
    void drawRect(const int16_t x, const int16_t y, const uint16_t width, const uint16_t height, const uint8_t cornerRadius, const uint32_t color);
 
    // KTOME function for triangles
    void drawTri(const int16_t x1, const int16_t y1, const int16_t x2, const int16_t y2, const int16_t x3, const int16_t y3, const uint32_t color, const uint32_t bgcolor);
 
    void drawLine(const int16_t x1, const int16_t y1, const int16_t x2, const int16_t y2, const uint8_t width, const uint32_t color);
 
    void beginLineStrip(const uint8_t width, const uint32_t color);
 
    void addVertex(const int16_t x, const int16_t y);
 
    void endLineStrip();
 
    void drawLetter(const int16_t x, const int16_t y, const uint8_t font, const uint32_t color, const uint8_t letter);
 
    void drawText(const int16_t x, const int16_t y, const uint8_t font, const uint32_t color, const uint16_t options, const char text[]);
 
    void drawBitmap(const uint32_t offset, const uint16_t x, const uint16_t y, const uint16_t width, const uint16_t height, const uint8_t scale, const uint8_t rot);
 
    void overlayBitmap(const uint32_t offset, const uint16_t x, const uint16_t y, const uint16_t width, const uint16_t height, const uint8_t scale, const uint8_t rot);
 
    void drawSpinner(const int16_t x, const int16_t y, const uint16_t style, const uint16_t scale, const uint32_t color);
 
    void drawButton(const int16_t x, const int16_t y, const int16_t width, const int16_t height, const uint8_t font, const uint32_t textColor, const uint32_t buttonColor, const uint16_t options, const char text[]);
 
    void drawClock(const int16_t x, const int16_t y, const int16_t radius, const uint32_t handsColor, const uint32_t backgroundColor, const uint16_t options, const uint16_t hours, const uint16_t minutes, const uint16_t seconds);
 
    void drawGauge(const int16_t x, const int16_t y, const int16_t radius, const uint32_t handsColor, const uint32_t backgroundColor, const uint16_t options, const uint8_t major, const uint8_t minor, const uint16_t value, const uint16_t range);
 
    void drawGradient(const int16_t x1, const int16_t y1, const uint32_t color1, const int16_t x2, const int16_t y2, const uint32_t color2);
 
    void drawScrollbar(const int16_t x, const int16_t y, const int16_t width, const int16_t height, const uint32_t foregroundColor, const uint32_t backgroundColor, const uint16_t options, const uint16_t value, const uint16_t size, const uint16_t range);
 
    void drawProgressbar(const int16_t x, const int16_t y, const int16_t width, const int16_t height, const uint32_t foregroundColor, const uint32_t backgroundColor, const uint16_t options, const uint16_t value, const uint16_t range);
 
    void beginDisplayList();
 
    void swapScreen();
 
    void waitForCommandBuffer();
 
    void setRotation(const uint8_t rotation);
 
    void writeGRAM(const uint32_t offset, const uint32_t size, const uint8_t data[], const bool useProgmem = true);
 
    void loadImage(const uint32_t offset, const uint32_t size, const uint8_t data[], const bool useProgmem = true);
 
    void playAudio(const uint32_t offset, const uint32_t size, const uint16_t sampleRate, const uint8_t format, const bool loop);
 
    bool isSoundPlaying();
 
    void setAudioVolume(const uint8_t volume);
 
    void setSound(const uint8_t effect, const uint8_t pitch);
 
    void playSound();
 
    void stopSound();
 
    uint8_t queryDisplay(const uint8_t cmd);
 
   protected:
    int8_t cs1;                    
    int8_t cs2;                    
    int8_t dc;                     
    uint16_t cmdWriteAddress = 0;  
 
#ifdef FT81x_USE_TEENSY_DMA
    uint8_t dmaBuffer[8] = {0};
    volatile uint8_t dmaBufferOut[8] = {0};
 
    DmaSpi::Transfer trx;
    DmaSpi::Transfer trx2;
#endif
 
    void initFT81x();
 
    void initDisplay();
 
    void sendCommandToDisplay(const uint8_t cmd, const uint8_t numParams, const uint8_t *params);
 
    void cmd(const uint32_t cmd);
 
    void startCmd(const uint32_t cmd);
 
    void intermediateCmd(const uint32_t cmd);
 
    void endCmd(const uint32_t cmd);
 
    void increaseCmdWriteAddress(uint16_t delta);
 
    void updateCmdWriteAddress();
 
    void sendText(const char text[]);
 
    uint8_t initBitmapHandleForFont(uint8_t font);
 
#if defined(__AVR__)
 
    uint8_t fetchFromProgmem(const uint8_t data[], const uint32_t i);
#endif
 
#ifdef FT81x_USE_TEENSY_DMA
    void waitForDMAReady();
    void transferDMABuffer(const uint8_t size);
#endif
 
   private:
};