Initial push of basic Inkplate10 functionalities

Author: JosipKuci

src/Inkplate.cpp

@@ -19,340 +19,79 @@
 
 #include "Inkplate.h"
 
-#if defined(ARDUINO_INKPLATECOLOR) || defined(ARDUINO_INKPLATE2) || defined(ARDUINO_INKPLATE4) ||                      \
-    defined(ARDUINO_INKPLATE7)
-Inkplate::Inkplate() : Adafruit_GFX(E_INK_WIDTH, E_INK_HEIGHT), Graphics(E_INK_WIDTH, E_INK_HEIGHT)
-#else
-
-Inkplate::Inkplate(uint8_t _mode) : Adafruit_GFX(E_INK_WIDTH, E_INK_HEIGHT), Graphics(E_INK_WIDTH, E_INK_HEIGHT)
-#endif
-{
-#if !defined(ARDUINO_INKPLATECOLOR) && !defined(ARDUINO_INKPLATE2) && !defined(ARDUINO_INKPLATE4) &&                   \
-    !defined(ARDUINO_INKPLATE7)
-    setDisplayMode(_mode);
-#endif
-}
-
-/**
- * @brief       clearDisplay function clears memory buffer for display
- *
- * @note        This does not clear the actual display, only the memory buffer, you need to call
- * display() function after this to clear the display
- */
-void Inkplate::clearDisplay()
-{
-#if defined(ARDUINO_INKPLATECOLOR)
-    memset(DMemory4Bit, WHITE << 4 | WHITE, E_INK_WIDTH * E_INK_HEIGHT / 2);
-#elif defined(ARDUINO_INKPLATE2)
-    memset(DMemory4Bit, 0xFF, E_INK_WIDTH * E_INK_HEIGHT / 4);
-#elif defined(ARDUINO_INKPLATE4)
-    memset(DMemory4Bit, 0xFF, (E_INK_WIDTH * E_INK_HEIGHT / 8));
-    memset(DMemory4Bit + (E_INK_WIDTH * E_INK_HEIGHT / 8), 0x00, (E_INK_WIDTH * E_INK_HEIGHT / 8));
-#elif defined(ARDUINO_INKPLATE7)
-    memset(DMemory4Bit, 0x33, (E_INK_WIDTH * E_INK_HEIGHT / 2));
-#else
-    // Clear 1 bit per pixel display buffer
-    if (getDisplayMode() == 0)
-        memset(_partial, 0, E_INK_WIDTH * E_INK_HEIGHT / 8);
-
-    // Clear 3 bit per pixel display buffer
-    if (getDisplayMode() == 1)
-        memset(DMemory4Bit, 255, E_INK_WIDTH * E_INK_HEIGHT / 2);
-#endif
-}
-
-#if !defined(ARDUINO_INKPLATECOLOR) && !defined(ARDUINO_INKPLATE2) && !defined(ARDUINO_INKPLATE4) &&                   \
-    !defined(ARDUINO_INKPLATE7)
-
-/**
- * @brief       display function update display with new data from buffer
- *
- * @param       bool leaveOn
- *              if set to 1, it will disable turning supply for eink after
- *              display update in order to save some time needed for power supply
- *              to save some time at next display update or increase refreshing speed
- */
-void Inkplate::display(bool leaveOn)
+//--------------------------USER FUNCTIONS--------------------------------------------
+Inkplate::Inkplate(uint8_t mode) : Adafruit_GFX(E_INK_WIDTH, E_INK_HEIGHT), Graphics(E_INK_WIDTH, E_INK_HEIGHT)
 {
-    if (getDisplayMode() == 0)
-        display1b(leaveOn);
-    else if (getDisplayMode() == 1)
-        display3b(leaveOn);
+    _mode=mode;
 }
 
-/**
- * @brief       preloadScreen function copy data from partial to data buffer
- */
-void Inkplate::preloadScreen()
+void Inkplate::begin()
 {
-    memcpy(DMemoryNew, _partial, E_INK_WIDTH * E_INK_HEIGHT / 8);
-}
 
-/**
- * @brief       einkOn turns on supply for epaper display (TPS65186) [+15 VDC,
- * -15VDC, +22VDC, -20VDC, +3.3VDC, VCOM]
- *
- * @note        its important to use this order when turning epaper on.
- *              using wrong order can irreparably damage epaper
- *
- * @return      1 if succesfully turned on, 0 if failed
- */
-int Inkplate::einkOn()
-{
-    if (getPanelState() == 1)
-        return 1;
-    WAKEUP_SET;
-    delay(5);
+    // Check if the initializaton of the library already done.
+    // In the case of already initialized library, return form the begin() funtion to
+    // avoiid any memory leaks, multiple initializaton of the peripherals etc.
+    if (_beginDone == 1)
+        return;
 
-#ifdef ARDUINO_INKPLATE6PLUSV2
-    if (pwrMode != INKPLATE_USB_PWR_ONLY)
-    {
-        // Enable all rails
-        Wire.beginTransmission(0x48);
-        Wire.write(0x01);
-        Wire.write(B00100000);
-        Wire.endTransmission();
-    }
-#else
-    // Enable all rails
-    Wire.beginTransmission(0x48);
-    Wire.write(0x01);
-    Wire.write(B00100000);
-    Wire.endTransmission();
-#endif
+    Wire.begin();
 
-    // Modify power up sequence.
-    Wire.beginTransmission(0x48);
-    Wire.write(0x09);
-    Wire.write(B11100100);
-    Wire.endTransmission();
+    // Init low level driver for EPD.
+    initDriver(this);
 
-    // Modify power down sequence  (VEE and VNEG are swapped)
-    Wire.beginTransmission(0x48);
-    Wire.write(0x0b);
-    Wire.write(B00011011);
-    Wire.endTransmission();
+    //Forward the display mode to the EPD driver
+    selectDisplayMode(_mode);
 
-    pinsAsOutputs();
-    LE_CLEAR;
-#if !defined(ARDUINO_ESP32_DEV) && !defined(ARDUINO_INKPLATE6V2) && !defined(ARDUINO_INKPLATE6FLICK)
-    CL_CLEAR;
-#endif
-    SPH_SET;
-    GMOD_SET;
-    SPV_SET;
-    CKV_CLEAR;
-    OE_CLEAR;
-    PWRUP_SET;
-    setPanelState(1);
+    // Clean frame buffers.
+    clearDisplay();
 
-    unsigned long timer = millis();
-    do
-    {
-        delay(1);
-    } while ((readPowerGood() != PWR_GOOD_OK) && (millis() - timer) < 250);
-    if ((millis() - timer) >= 250)
-    {
-        einkOff();
-        return 0;
-    }
+    // Block multiple inits.
+    _beginDone = 1;
 
-    VCOM_SET;
-    OE_SET;
-
-    return 1;
 }
-
-/**
- * @brief       einkOff turns off epaper power supply and put all digital IO
- * pins in high Z state
- */
-void Inkplate::einkOff()
+void Inkplate::writePixel(int16_t x, int16_t y, uint16_t color)
 {
-    if (getPanelState() == 0)
+    int16_t x0 = x;
+    int16_t y0 = y;
+    if (x0 > width() - 1 || y0 > height() - 1 || x0 < 0 || y0 < 0)
         return;
-    VCOM_CLEAR;
-    OE_CLEAR;
-    GMOD_CLEAR;
-#if !defined(ARDUINO_ESP32_DEV) && !defined(ARDUINO_INKPLATE6V2) && !defined(ARDUINO_INKPLATE6FLICK)
-    GPIO.out &= ~(DATA | LE | CL);
-#else
-    LE_CLEAR;
-#endif
-    CKV_CLEAR;
-    SPH_CLEAR;
-    SPV_CLEAR;
-    PWRUP_CLEAR;
 
-    unsigned long timer = millis();
-    do
+    switch (rotation)
     {
-        delay(1);
-    } while ((readPowerGood() != 0) && (millis() - timer) < 250);
-
-    // Do not disable WAKEUP if older Inkplate6Plus is used.
-#ifndef ARDUINO_INKPLATE6PLUS
-#ifdef ARDUINO_INKPLATE6PLUSV2
-    if (pwrMode != INKPLATE_USB_PWR_ONLY)
-        WAKEUP_CLEAR;
-#else
-    WAKEUP_CLEAR; // Disable 3V3 Switch for ePaper.
-    Wire.beginTransmission(0x48);
-    Wire.write(0x01);
-    Wire.write(B00000000);
-    Wire.endTransmission();
-#endif
-#endif
-
-    pinsZstate();
-
-    setPanelState(0);
-}
-
-/**
- * @brief       readPowerGood reads ok status for each rail
- *
- * @return      power good status register
- */
-uint8_t Inkplate::readPowerGood()
-{
-    Wire.beginTransmission(0x48);
-    Wire.write(0x0F);
-    Wire.endTransmission();
-
-    Wire.requestFrom(0x48, 1);
-    return Wire.read();
-}
-
-// LOW LEVEL FUNCTIONS
-
-/**
- * @brief       vscan_start starts writing new frame and skips first two lines
- * that are invisible on screen
- */
-void Inkplate::vscan_start()
-{
-    CKV_SET;
-    delayMicroseconds(7);
-    SPV_CLEAR;
-    delayMicroseconds(10);
-    CKV_CLEAR;
-    delayMicroseconds(0);
-    CKV_SET;
-    delayMicroseconds(8);
-    SPV_SET;
-    delayMicroseconds(10);
-    CKV_CLEAR;
-    delayMicroseconds(0);
-    CKV_SET;
-    delayMicroseconds(18);
-    CKV_CLEAR;
-    delayMicroseconds(0);
-    CKV_SET;
-    delayMicroseconds(18);
-    CKV_CLEAR;
-    delayMicroseconds(0);
-    CKV_SET;
-}
-
-/**
- * @brief       hscan_start starts writing data into current row
- *
- * @param       uint32_t _d
- *              data to be written into current row
- */
-void Inkplate::hscan_start(uint32_t _d)
-{
-#if !defined(ARDUINO_ESP32_DEV) && !defined(ARDUINO_INKPLATE6V2)
-    SPH_CLEAR;
-    GPIO.out_w1ts = (_d) | CL;
-    GPIO.out_w1tc = DATA | CL;
-    SPH_SET;
-    CKV_SET;
-#endif
-}
-
-/**
- * @brief       vscan_end ends current row and prints data to screen
- */
-void Inkplate::vscan_end()
-{
-    CKV_CLEAR;
-    LE_SET;
-    LE_CLEAR;
-    delayMicroseconds(0);
-}
-
-/**
- * @brief       pinsZstate sets all tps pins at high z state
- *
- * @note        this is used only when turning off epaper
- */
-void Inkplate::pinsZstate()
-{
-    pinMode(2, INPUT);
-    pinMode(32, INPUT);
-    pinMode(33, INPUT);
-    pinModeInternal(IO_INT_ADDR, ioRegsInt, OE, INPUT);
-    pinModeInternal(IO_INT_ADDR, ioRegsInt, GMOD, INPUT);
-    pinModeInternal(IO_INT_ADDR, ioRegsInt, SPV, INPUT);
-
-    // Set up the EPD Data and CL pins for I2S (only on Inkplate6).
-    pinMode(0, INPUT);
-    pinMode(4, INPUT);
-    pinMode(5, INPUT);
-    pinMode(18, INPUT);
-    pinMode(19, INPUT);
-    pinMode(23, INPUT);
-    pinMode(25, INPUT);
-    pinMode(26, INPUT);
-    pinMode(27, INPUT);
+    case 1:
+        _swap_int16_t(x0, y0);
+        x0 = height() - x0 - 1;
+        break;
+    case 2:
+        x0 = width() - x0 - 1;
+        y0 = height() - y0 - 1;
+        break;
+    case 3:
+        _swap_int16_t(x0, y0);
+        y0 = width() - y0 - 1;
+        break;
+    }
 
-#if defined(ARDUINO_ESP32_DEV) || defined(ARDUINO_INKPLATE6V2) || defined(ARDUINO_INKPLATE5V2) ||                      \
-    defined(ARDUINO_INKPLATE6FLICK)
-    // Disable clock for the EPD.
-    myI2S->conf1.tx_stop_en = 0;
-#endif
+    if (getDisplayMode() == 0)
+    {
+        int x = x0 >> 3;
+        int x_sub = x0 & 7;
+        uint8_t temp = *(_partial + ((E_INK_WIDTH >> 3) * y0) + x);
+        *(_partial + (E_INK_WIDTH / 8 * y0) + x) = (~pixelMaskLUT[x_sub] & temp) | (color ? pixelMaskLUT[x_sub] : 0);
+    }
+    else
+    {
+        color &= 7;
+        int x = x0 >> 1;
+        int x_sub = x0 & 1;
+        uint8_t temp;
+        temp = *(DMemory4Bit + (E_INK_WIDTH >> 1) * y0 + x);
+        *(DMemory4Bit + (E_INK_WIDTH >> 1) * y0 + x) = (pixelMaskGLUT[x_sub] & temp) | (x_sub ? color : color << 4);
+    }
 }
 
-/**
- * @brief       pinsAsOutputs sets all tps pins as outputs
- */
-void Inkplate::pinsAsOutputs()
+void Inkplate::drawPixel(int16_t x, int16_t y, uint16_t color)
 {
-    pinMode(2, OUTPUT);
-    pinMode(32, OUTPUT);
-    pinMode(33, OUTPUT);
-    pinModeInternal(IO_INT_ADDR, ioRegsInt, OE, OUTPUT);
-    pinModeInternal(IO_INT_ADDR, ioRegsInt, GMOD, OUTPUT);
-    pinModeInternal(IO_INT_ADDR, ioRegsInt, SPV, OUTPUT);
-
-#if defined(ARDUINO_ESP32_DEV) || defined(ARDUINO_INKPLATE6V2) || defined(ARDUINO_INKPLATE5V2) ||                      \
-    defined(ARDUINO_INKPLATE6FLICK)
-    // Set up the EPD Data and CL pins for I2S.
-    setI2S1pin(0, I2S1O_BCK_OUT_IDX, 0);
-    setI2S1pin(4, I2S1O_DATA_OUT0_IDX, 0);
-    setI2S1pin(5, I2S1O_DATA_OUT1_IDX, 0);
-    setI2S1pin(18, I2S1O_DATA_OUT2_IDX, 0);
-    setI2S1pin(19, I2S1O_DATA_OUT3_IDX, 0);
-    setI2S1pin(23, I2S1O_DATA_OUT4_IDX, 0);
-    setI2S1pin(25, I2S1O_DATA_OUT5_IDX, 0);
-    setI2S1pin(26, I2S1O_DATA_OUT6_IDX, 0);
-    setI2S1pin(27, I2S1O_DATA_OUT7_IDX, 0);
-
-    // Start sending clock to the EPD.
-    myI2S->conf1.tx_stop_en = 1;
-#else
-    pinMode(0, OUTPUT);
-    pinMode(4, OUTPUT);
-    pinMode(5, OUTPUT);
-    pinMode(18, OUTPUT);
-    pinMode(19, OUTPUT);
-    pinMode(23, OUTPUT);
-    pinMode(25, OUTPUT);
-    pinMode(26, OUTPUT);
-    pinMode(27, OUTPUT);
-#endif
+    writePixel(x,y,color);
 }
-
-#endif
+void Inkplate::setRotation(uint8_t r){}