Tasmota/tasmota/tasmota_xdsp_display/xdsp_17_universal.ino

/*
  xdsp_17_universal.ino -  universal display driver support for Tasmota

  Copyright (C) 2021  Gerhard Mutz and  Theo Arends

  This program 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.

  This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifdef USE_DISPLAY
#ifdef USE_UNIVERSAL_DISPLAY

#define XDSP_17                17

#include <uDisplay.h>

bool udisp_init_done = false;
uint8_t ctouch_counter;

#ifdef USE_UFILESYS
extern FS *ffsp;
#endif

#undef GT911_address
#define GT911_address 0x5D
#undef CST816S_address
#define CST816S_address 0x15

enum { GPIO_DP_RES = GPIO_SENSOR_END-1,GPIO_DP_CS,GPIO_DP_RS,GPIO_DP_WR,GPIO_DP_RD,GPIO_DPAR0,GPIO_DPAR1,GPIO_DPAR2,GPIO_DPAR3,GPIO_DPAR4,GPIO_DPAR5,GPIO_DPAR6,GPIO_DPAR7,GPIO_DPAR8,GPIO_DPAR9,GPIO_DPAR10,GPIO_DPAR11,GPIO_DPAR12,GPIO_DPAR13,GPIO_DPAR14,GPIO_DPAR15};

#ifndef USE_DISPLAY
uint8_t color_type;
uint16_t fg_color;
uint16_t bg_color;
Renderer *renderer;
#else
extern uint8_t color_type;
extern uint16_t fg_color;
extern uint16_t bg_color;
#endif

#ifndef DISPDESC_SIZE
#define DISPDESC_SIZE 1000
#endif

void Core2DisplayPower(uint8_t on);
void Core2DisplayDim(uint8_t dim);

//#define DSP_ROM_DESC

#ifndef DISP_DESC_FILE
//#define DISP_DESC_FILE "/dispdesc.txt"
#define DISP_DESC_FILE "/display.ini"
#endif // DISP_DESC_FILE

/*********************************************************************************************/
#ifdef DSP_ROM_DESC
const char DSP_SAMPLE_DESC[] PROGMEM = DSP_ROM_DESC;
#endif // DSP_ROM_DESC
/*********************************************************************************************/
Renderer *Init_uDisplay(const char *desc) {
  if (TasmotaGlobal.gpio_optiona.udisplay_driver || desc) {

    Settings->display_model = XDSP_17;

    char *fbuff = (char*)calloc(DISPDESC_SIZE, 1);
    if (!fbuff) return 0;

    char *ddesc = nullptr;
    if (desc) {
      memcpy_P(fbuff, desc, DISPDESC_SIZE - 1);
      ddesc = fbuff;
      AddLog(LOG_LEVEL_DEBUG, PSTR("DSP: Const char descriptor used"));
    }

#ifdef USE_UFILESYS
    if (ffsp  && !TasmotaGlobal.no_autoexec && !ddesc) {
      File fp;
      fp = ffsp->open(DISP_DESC_FILE, "r");
      if (fp > 0) {
        uint32_t size = fp.size();
        if (size > DISPDESC_SIZE - 50) {
          free(fbuff);
          fbuff = (char*)calloc(size + 50, 1);
          if (!fbuff) return 0;
        }
        fp.read((uint8_t*)fbuff, size);
        fp.close();
        ddesc = fbuff;
        AddLog(LOG_LEVEL_DEBUG, PSTR("DSP: File descriptor used"));
      }
    }
#endif // USE_UFILESYS

#ifdef USE_SCRIPT
    if (bitRead(Settings->rule_enabled, 0) && !ddesc) {
      uint8_t dfound = Run_Scripter(">d",-2,0);
      if (dfound == 99) {
        char *lp = glob_script_mem.section_ptr + 2;
        while (*lp != '\n') lp++;
        memcpy(fbuff, lp + 1, DISPDESC_SIZE - 1);
        ddesc = fbuff;
        AddLog(LOG_LEVEL_DEBUG, PSTR("DSP: Script descriptor used"));
      }
    }
#endif // USE_SCRIPT

#ifdef USE_RULES
    if (!bitRead(Settings->rule_enabled, 2) && !ddesc) {
      // only if rule3 is not enabled for rules
      char *cp = Settings->rules[2];
      while (*cp == ' ') cp++;
      memcpy(fbuff, cp, DISPDESC_SIZE - 1);
      if (fbuff[0] == ':' && fbuff[1] == 'H') {
        // assume display descriptor, replace space with line feed
        for (uint32_t cnt = 0; cnt < DISPDESC_SIZE; cnt++) {
          if (fbuff[cnt] == ' ') fbuff[cnt] = '\n';
        }
        ddesc = fbuff;
        AddLog(LOG_LEVEL_DEBUG, PSTR("DSP: Rule3 descriptor used"));
      }

    }
#endif // USE_RULES

#ifdef DSP_ROM_DESC
    if (!ddesc) {
      memcpy_P(fbuff, DSP_SAMPLE_DESC, sizeof(DSP_SAMPLE_DESC));
      ddesc = fbuff;
      AddLog(LOG_LEVEL_DEBUG, PSTR("DSP: Flash descriptor used"));
    }
#endif // DSP_ROM_DESC

    if (!ddesc) {
      AddLog(LOG_LEVEL_DEBUG, PSTR("DSP: No valid descriptor found"));
      if (fbuff) {
        free(fbuff);
      }
      return 0;
    }

    // Replace tasmota vars before passing to driver uDisplay.cpp
    char *cp = strstr(ddesc, "I2C");
    if (cp) {
      // I2C,3c,22,21,*
      // I2C1,3c,22,21,*
      // I2C2,3c,22,21,*
      cp += 3;
      // ,3c,22,21,*
      // 1,3c,22,21,*
      // 2,3c,22,21,*
      uint8_t wire_n = 0;
      if (*cp == '1' || *cp == '2') {
        wire_n = (*cp & 3) - 1;
        cp += 2;
      } else {
        cp++;
      }
      // 3c,22,21,-1
      uint8_t i2caddr = strtol(cp, &cp, 16);
      // ,22,21,-1
      cp++;
      // 22,21,-1
      int8_t scl = replacepin(&cp, Pin(GPIO_I2C_SCL, wire_n));
      int8_t sda = replacepin(&cp, Pin(GPIO_I2C_SDA, wire_n));
      replacepin(&cp, Pin(GPIO_OLED_RESET));

      if (wire_n == 0) {
        if (!TasmotaGlobal.i2c_enabled[0]) {
          I2cBegin(sda, scl);
        }
      }
#ifdef ESP32
      if (wire_n == 1) {
        if (!TasmotaGlobal.i2c_enabled[1]) {
          I2cBegin(sda, scl, 1);
        }
      }
#endif // ESP32
      if (I2cSetDevice(i2caddr, wire_n)) {
        char display_name[16] = { 0 };  // Loosly related to dname in uDisplay.h
        strcpy_P(display_name, PSTR("Display"));
        cp = strstr(ddesc, ":H,");
        if (cp) {
          // :H,SH1106,128,64,1,I2C,3c,22,21,*
          cp += 3;
          char *lp = strchr(cp, ',');
          if (lp) {
            uint32_t len = lp - cp +1;
            if (len < sizeof(display_name)) { 
              strlcpy(display_name, cp, len);
            }
          }
        }
        I2cSetActiveFound(i2caddr, display_name, wire_n);
      }
    }

    cp = strstr(ddesc, "SPI,");
    if (cp) {
      // 9 params nr,cs,sclk,mosi,dc,bl,reset,miso,mhz
      // SPI,1,*,*,*,*,*,*,*,80
      // SPI,3,*,*,*,*,*,*,*,40
      cp += 4;
      // 1,*,*,*,*,*,*,*,80
      uint32_t spi_type = 2;   // SPI,3 = Software SPI
      if ((*cp == '1') || (*cp == '2')) {
        spi_type = *cp - '1';  // SPI,1 = 0, SPI,2 = 1 etc
      }
      cp += 2;
      // *,*,*,*,*,*,*,80
      if (spi_type < 2) {      // SPI,1 or SPI,2
        replacepin(&cp, Pin(GPIO_SPI_CS, spi_type));
        replacepin(&cp, Pin(GPIO_SPI_CLK, spi_type));
        replacepin(&cp, Pin(GPIO_SPI_MOSI, spi_type));
        replacepin(&cp, Pin(GPIO_SPI_DC, spi_type));
        replacepin(&cp, Pin(GPIO_BACKLIGHT));
        replacepin(&cp, Pin(GPIO_OLED_RESET));
        replacepin(&cp, Pin(GPIO_SPI_MISO, spi_type));
      } else {                 // SPI,3 is software SPI
        replacepin(&cp, Pin(GPIO_SSPI_CS));
        replacepin(&cp, Pin(GPIO_SSPI_SCLK));
        replacepin(&cp, Pin(GPIO_SSPI_MOSI));
        replacepin(&cp, Pin(GPIO_SSPI_DC));
        replacepin(&cp, Pin(GPIO_BACKLIGHT));
        replacepin(&cp, Pin(GPIO_OLED_RESET));
        replacepin(&cp, Pin(GPIO_SSPI_MISO));
      }
    }

    cp = strstr(ddesc, ":UTI,");
    if (cp) {
      // :UTI,FT3267,I1,38,-1,-1
      // :UTI,FT5206,I1,38,-1,-1
      // :UTI,FT5206,I2,38,*,*
      // :UTI,FT6236,I1,38,-1,-1
      // :UTI,FT6336U,I2,38,-1,-1
      // :UTI,FT6336U,I1,38,*,*
      // :UTI,GT911,I1,5d,-1,-1
      // :UTI,XPT2046,S1,*,*,*
      // :UTI,SRES,R
      cp += 5;                    // Skip ":UTI,"
      // FT5206,I1,38,-1,-1
      cp = strchr(cp, ',');       // Skip name
      // ,I1,38,-1,-1
      cp++;
      // I1,38,-1,-1
      // S1,*,*,*
      if (*cp == 'I') {           // I = I2C
        cp += 3;                  // Skip interface type and bus
        // 38,-1,-1
        cp = strchr(cp, ',');     // Skip I2C address
        // ,-1,-1
        cp++;
        // -1,-1
        replacepin(&cp, Pin(GPIO_TS_RST));
        replacepin(&cp, Pin(GPIO_TS_IRQ));
      } else if (*cp == 'S') {    // S = SPI
        cp += 3;                  // Skip interface type and bus
        // *,*,*
        replacepin(&cp, Pin(GPIO_TS_SPI_CS));
        replacepin(&cp, Pin(GPIO_TS_RST));
        replacepin(&cp, Pin(GPIO_TS_IRQ));
      }
    }

    uint16_t xs, ys;
    // we need screen size for gt911 touch controler
    cp = strstr(ddesc, ":H,");
    if (cp) {
      cp += 3;
      cp = strchr(cp, ',');
      cp++;
      xs = strtol(cp, &cp, 10);
      cp++;
      ys = strtol(cp, &cp, 10);
    }

#ifdef CONFIG_IDF_TARGET_ESP32S3
    int8_t xp, xm, yp, ym;

    cp = strstr(ddesc, "PAR,");
    if (cp) {
      // PAR,8,41,40,39,38,42,-1,8,9,10,11,12,13,14,15,20
      // PAR,16,-1,37,36,35,48,45,47,21,14,13,12,11,10,9,3,8,16,15,7,6,5,4,20
      cp += 4;
      // 8,41,40,39,38,42,-1,8,9,10,11,12,13,14,15,20
      // 8 or 16 bus
      uint8_t mode = strtol(cp, &cp, 10);
      cp++;
      // 41,40,39,38,42,-1,8,9,10,11,12,13,14,15,20
      replacepin(&cp, Pin(GPIO_DP_RES));
      xm = replacepin(&cp, Pin(GPIO_DP_CS));
      yp = replacepin(&cp, Pin(GPIO_DP_RS));
      replacepin(&cp, Pin(GPIO_DP_WR));
      replacepin(&cp, Pin(GPIO_DP_RD));
      replacepin(&cp, Pin(GPIO_BACKLIGHT));

      ym = replacepin(&cp, Pin(GPIO_DPAR0));
      xp = replacepin(&cp, Pin(GPIO_DPAR1));

      replacepin(&cp, Pin(GPIO_DPAR2));
      replacepin(&cp, Pin(GPIO_DPAR3));
      replacepin(&cp, Pin(GPIO_DPAR4));
      replacepin(&cp, Pin(GPIO_DPAR5));
      replacepin(&cp, Pin(GPIO_DPAR6));
      replacepin(&cp, Pin(GPIO_DPAR7));

      if (mode == 16) {
        replacepin(&cp, Pin(GPIO_DPAR8));
        replacepin(&cp, Pin(GPIO_DPAR9));
        replacepin(&cp, Pin(GPIO_DPAR10));
        replacepin(&cp, Pin(GPIO_DPAR11));
        replacepin(&cp, Pin(GPIO_DPAR12));
        replacepin(&cp, Pin(GPIO_DPAR13));
        replacepin(&cp, Pin(GPIO_DPAR14));
        replacepin(&cp, Pin(GPIO_DPAR15));
      }
    }
#endif // CONFIG_IDF_TARGET_ESP32S3
/*
    File fp;
    fp = ffsp->open("/dump.txt", "w");
    fp.write((uint8_t*)ddesc, DISPDESC_SIZE);
    fp.close();
*/

    // init renderer
    if (renderer) {
      delete renderer;
      AddLog(LOG_LEVEL_DEBUG, PSTR("DSP: reinit"));
    }

    uDisplay *udisp = new uDisplay(ddesc);

    // check for touch option TI1 or TI2
#if defined (USE_CST816S) || defined(USE_FT5206) || defined(USE_GT911)
    cp = strstr(ddesc, ":TI");
    if (cp) {
      // :TI1,38,39,38
      // :TI2,38,22,21
      cp += 3;
      // 1,38,39,38
      uint8_t wire_n = (*cp & 3) - 1;
      cp += 2;
      // 38,39,38
      uint8_t i2caddr = strtol(cp, &cp, 16);
      cp++;
      // 39,38
      int8_t scl = replacepin(&cp, Pin(GPIO_I2C_SCL, wire_n));
      int8_t sda = replacepin(&cp, Pin(GPIO_I2C_SDA, wire_n));
      int8_t irq = -1;
      if (*(cp - 1) == ',') {
        irq = strtol(cp, &cp, 10);
      }
      int8_t rst = -1;
      if (*cp == ',') {
        cp++;
        rst = strtol(cp, &cp, 10);
      }

      if (wire_n == 0) {
        if (!TasmotaGlobal.i2c_enabled[0]) {
          I2cBegin(sda, scl);
        }
      }
#ifdef ESP32
      if (wire_n == 1) {
        if (!TasmotaGlobal.i2c_enabled[1]) {
          I2cBegin(sda, scl, 1, 400000);
        }
      }
#endif // ESP32
      if (I2cSetDevice(i2caddr, wire_n)) {
        if (i2caddr == GT911_address) {
          I2cSetActiveFound(i2caddr, "GT911", wire_n);
        } else if (i2caddr == CST816S_address) {
          I2cSetActiveFound(i2caddr, "CST816S", wire_n);
        } else {
          I2cSetActiveFound(i2caddr, "FT5206", wire_n);
        }
      }

      // Start digitizer
      if (i2caddr == GT911_address) {
#ifdef USE_GT911
        if (!wire_n) {
          GT911_Touch_Init(&Wire, irq, rst, xs, ys);
        }
#if defined(ESP32) && defined(USE_I2C_BUS2)
        else {
          GT911_Touch_Init(&Wire1, irq, rst, xs, ys);
        }
#endif  // ESP32
#endif  // USE_GT911
      } 
      else if (i2caddr == CST816S_address) {
#ifdef USE_CST816S
        CST816S_Touch_Init(wire_n, irq, rst);
#endif  // USE_CST816S
      } 
      else {
#ifdef USE_FT5206
        if (!wire_n) { 
          FT5206_Touch_Init(Wire);
        }
#if defined(ESP32) && defined(USE_I2C_BUS2)
        else {
          FT5206_Touch_Init(Wire1);
        }
#endif  // ESP32
#endif  // USE_FT5206
      }
    }
#endif // USE_FT5206 || GT911

#ifdef USE_XPT2046
    cp = strstr(ddesc, ":TS,");
    if (cp) {
      // :TS,16
      cp += 4;
      uint8_t touch_cs = replacepin(&cp, Pin(GPIO_XPT2046_CS));
      int8_t irqpin = -1;
      if (*(cp - 1) == ',') {
        irqpin = strtol(cp, &cp, 10);
      }
      uint8_t bus = 1;
      if (*cp == ',') {
        cp++;
        bus = strtol(cp, &cp, 10);
        if (bus < 1) bus = 1;
      }
	    XPT2046_Touch_Init(touch_cs, irqpin, bus - 1);
    }
#endif // USE_XPT2046

#ifdef CONFIG_IDF_TARGET_ESP32S3
#ifdef SIMPLE_RES_TOUCH
    cp = strstr(ddesc, ":TR,");
    if (cp) {
      cp += 4;
      Simple_ResTouch_Init(xp, xm, yp, ym);
    }
#endif
#endif

    uint8_t inirot = Settings->display_rotate;

    cp = strstr(ddesc, ":r,");
    if (cp) {
      cp+=3;
      inirot = strtol(cp, &cp, 10);
    }

    // release desc buffer
    if (fbuff) free(fbuff);

    renderer = udisp->Init();
    if (!renderer) return 0;

    fg_color = renderer->fgcol();
    bg_color = renderer->bgcol();
    color_type = renderer->color_type();

    renderer->DisplayInit(DISPLAY_INIT_MODE, Settings->display_size, inirot, Settings->display_font);
    renderer->clearDisplay();

    Settings->display_width = renderer->width();
    Settings->display_height = renderer->height();

#ifdef USE_UNIVERSAL_TOUCH
    utouch_Touch_Init();
#endif

    bool iniinv = Settings->display_options.invert;
    /*
    cp = strstr(ddesc, ":n,");
    if (cp) {
      cp+=3;
      iniinv = strtol(cp, &cp, 10);
      Settings->display_options.invert = iniinv;
    }*/
    renderer->invertDisplay(iniinv);

    ApplyDisplayDimmer();

#ifdef SHOW_SPLASH
    if (!Settings->flag5.display_no_splash) {  // SetOption135 - (Display & LVGL) force disabling default splash screen
      renderer->Splash();
    }
#endif // SHOW_SPLASH

    udisp_init_done = true;
    AddLog(LOG_LEVEL_INFO, PSTR("DSP: %s initialized"), renderer->devname());

    return renderer;
  }
  return 0;
}

/*********************************************************************************************/

int8_t replacepin(char **cp, int16_t pin) {
  // cp = 6,*,* and pin = 4 => lp = 6,*,* and cp = *,*
  // cp = *,*,* and pin = 4 => lp = 4,*,* and cp = *,*
  // cp = ,*,* and pin = 4 => lp = 4,*,* and cp = *,*
  char *lp = *cp;
  if ((*lp == '*') || (*lp == ',')) {
    char val[8];
    itoa(pin, val, 10);
    uint16_t slen = strlen(val);
    //AddLog(LOG_LEVEL_INFO, PSTR("replace pin: %d"), pin);
    uint32_t idx = 0;
    if (*lp == '*') { idx++; }
    memmove(lp + slen, lp + idx, strlen(lp));
    memmove(lp, val, slen);
  }
  int8_t res = strtol(lp, 0, 10);
  char *np = strchr(lp, ',');
  if (np) {
    *cp = np + 1;
  }
  return res;
}

/*********************************************************************************************/

#ifdef USE_DISPLAY_MODES1TO5

void UDISP_PrintLog(void) {
  // This can take over 3 seconds depending on renderer->Updateframe() speed
  //   due to not connected busy pin (configure as MISO)
  static bool printlog_mutex = false;

  if (disp_refresh) { disp_refresh--; }
  if (disp_refresh || printlog_mutex || TasmotaGlobal.restart_flag || TasmotaGlobal.ota_state_flag) {
    return;
  }
  printlog_mutex = true;
  disp_refresh = Settings->display_refresh;
  if (!disp_screen_buffer_cols) { DisplayAllocScreenBuffer(); }

  char* txt = DisplayLogBuffer('\370');
  if (txt != nullptr) {
    uint8_t last_row = Settings->display_rows -1;

//      renderer->clearDisplay();
    renderer->setTextSize(Settings->display_size);
    renderer->setCursor(0,0);
    for (byte i = 0; i < last_row; i++) {
      strlcpy(disp_screen_buffer[i], disp_screen_buffer[i +1], disp_screen_buffer_cols);
      renderer->println(disp_screen_buffer[i]);
    }
    strlcpy(disp_screen_buffer[last_row], txt, disp_screen_buffer_cols);
    DisplayFillScreen(last_row);
    renderer->println(disp_screen_buffer[last_row]);
    renderer->Updateframe();
  }
  printlog_mutex = false;
}

void UDISP_Time(void) {
  char line[12];

//  renderer->clearDisplay();
  renderer->setTextSize(Settings->display_size);
  renderer->setTextFont(Settings->display_font);
  renderer->setCursor(0, 0);
  snprintf_P(line, sizeof(line), PSTR(" %02d" D_HOUR_MINUTE_SEPARATOR "%02d" D_MINUTE_SECOND_SEPARATOR "%02d"), RtcTime.hour, RtcTime.minute, RtcTime.second);  // [ 12:34:56 ]
  renderer->println(line);
  renderer->println();
  snprintf_P(line, sizeof(line), PSTR("%02d" D_MONTH_DAY_SEPARATOR "%02d" D_YEAR_MONTH_SEPARATOR "%04d"), RtcTime.day_of_month, RtcTime.month, RtcTime.year);   // [01-02-2018]
  renderer->println(line);
  renderer->Updateframe();
}

void UDISP_Refresh(void) {  // Every second
  if (!renderer) return;
  if (Settings->display_mode) {  // Mode 0 is User text
    switch (Settings->display_mode) {
      case 1:  // Time
        UDISP_Time();
        break;
      case 2:  // Local
      case 3:  // Local
      case 4:  // Mqtt
      case 5:  // Mqtt
        UDISP_PrintLog();
        break;
    }
  }
}

#endif  // USE_DISPLAY_MODES1TO5

/*********************************************************************************************\
 * Interface
\*********************************************************************************************/

bool Xdsp17(uint32_t function) {
  bool result = false;

  if (FUNC_DISPLAY_INIT_DRIVER == function) {
    Init_uDisplay(nullptr);
  }
  else if (udisp_init_done && (XDSP_17 == Settings->display_model)) {
    switch (function) {
      case FUNC_DISPLAY_MODEL:
        result = true;
        break;

#ifdef USE_DISPLAY_MODES1TO5
      case FUNC_DISPLAY_EVERY_SECOND:
        UDISP_Refresh();
        break;
#endif  // USE_DISPLAY_MODES1TO5

    }
  }
  return result;
}

#endif  // USE_UNIVERSAL_DISPLAY
#endif  // USE_DISPLAY