Merge pull request #608 from Quency-D/dev-heltec_e213

Add heltec_vision_master_e213 board.

Author: ripplebiz

boards/heltec_vision_master_e213.json

@@ -0,0 +1,44 @@
+{
+  "build": {
+    "arduino": {
+      "ldscript": "esp32s3_out.ld",
+      "partitions": "default_16MB.csv",
+      "memory_type": "qio_opi"
+    },
+    "core": "esp32",
+    "extra_flags": [
+      "-DBOARD_HAS_PSRAM",
+      "-DARDUINO_USB_MODE=0",
+      "-DARDUINO_USB_CDC_ON_BOOT=1",
+      "-DARDUINO_RUNNING_CORE=1",
+      "-DARDUINO_EVENT_RUNNING_CORE=1"
+    ],
+    "f_cpu": "240000000L",
+    "f_flash": "80000000L",
+    "flash_mode": "qio",
+    "psram_type": "opi",
+    "hwids": [
+      ["0x303A", "0x1001"],
+      ["0x303A", "0x0002"]
+    ],
+    "mcu": "esp32s3",
+    "variant": "heltec_vision_master_e213"
+  },
+  "connectivity": ["wifi", "bluetooth", "lora"],
+  "debug": {
+    "openocd_target": "esp32s3.cfg"
+  },
+  "frameworks": ["arduino", "espidf"],
+  "name": "Heltec Vision Master E213",
+  "upload": {
+    "flash_size": "16MB",
+    "maximum_ram_size": 8388608,
+    "maximum_size": 16777216,
+    "use_1200bps_touch": true,
+    "wait_for_upload_port": true,
+    "require_upload_port": true,
+    "speed": 921600
+  },
+  "url": "https://heltec.org/project/vision-master-e213/",
+  "vendor": "Heltec"
+}

src/helpers/RefCountedDigitalPin.h

@@ -5,25 +5,25 @@
 class RefCountedDigitalPin {
   uint8_t _pin;
   int8_t _claims = 0;
-
+  uint8_t _active = 0;
 public:
-  RefCountedDigitalPin(uint8_t pin): _pin(pin) { }
+  RefCountedDigitalPin(uint8_t pin,uint8_t active=HIGH): _pin(pin), _active(active) { }
 
   void begin() {
     pinMode(_pin, OUTPUT);
-    digitalWrite(_pin, LOW);  // initial state
+    digitalWrite(_pin, !_active);  // initial state
   }
 
   void claim() {
     _claims++;
     if (_claims > 0) {
-      digitalWrite(_pin, HIGH);
+      digitalWrite(_pin, _active);
     }
   }
   void release() {
     _claims--;
     if (_claims == 0) {
-      digitalWrite(_pin, LOW);
+      digitalWrite(_pin, !_active);
     }
   }
 };

src/helpers/ui/E213Display.cpp

@@ -2,36 +2,82 @@
 
 #include "../../MeshCore.h"
 
+BaseDisplay* E213Display::detectEInk()
+{
+    // Test 1: Logic of BUSY pin
+
+    // Determines controller IC manufacturer
+    // Fitipower: busy when LOW
+    // Solomon Systech: busy when HIGH
+
+    // Force display BUSY by holding reset pin active
+    pinMode(DISP_RST, OUTPUT);
+    digitalWrite(DISP_RST, LOW);
+
+    delay(10);
+
+    // Read whether pin is HIGH or LOW while busy
+    pinMode(DISP_BUSY, INPUT);
+    bool busyLogic = digitalRead(DISP_BUSY);
+
+    // Test complete. Release pin
+    pinMode(DISP_RST, INPUT);
+
+    if (busyLogic == LOW) {
+#ifdef VISION_MASTER_E213
+      return new EInkDisplay_VisionMasterE213 ;
+#else
+      return new EInkDisplay_WirelessPaperV1_1 ;
+#endif
+    } else {// busy HIGH
+#ifdef VISION_MASTER_E213
+      return new EInkDisplay_VisionMasterE213V1_1 ;
+#else
+      return new EInkDisplay_WirelessPaperV1_1_1 ;
+#endif
+    }
+}
+
 bool E213Display::begin() {
   if (_init) return true;
 
   powerOn();
-  display.begin();
-
+  if(display==NULL) {
+    display = detectEInk();
+  }
+  display->begin();
   // Set to landscape mode rotated 180 degrees
-  display.setRotation(3);
+  display->setRotation(3);
 
   _init = true;
   _isOn = true;
 
   clear();
-  display.fastmodeOn(); // Enable fast mode for quicker (partial) updates
+  display->fastmodeOn(); // Enable fast mode for quicker (partial) updates
 
   return true;
 }
 
 void E213Display::powerOn() {
 #ifdef PIN_VEXT_EN
   pinMode(PIN_VEXT_EN, OUTPUT);
+#ifdef PIN_VEXT_EN_ACTIVE
+  digitalWrite(PIN_VEXT_EN, PIN_VEXT_EN_ACTIVE); 
+#else
   digitalWrite(PIN_VEXT_EN, LOW); // Active low
+#endif
   delay(50);                      // Allow power to stabilize
 #endif
 }
 
 void E213Display::powerOff() {
 #ifdef PIN_VEXT_EN
+#ifdef PIN_VEXT_EN_ACTIVE
+  digitalWrite(PIN_VEXT_EN, !PIN_VEXT_EN_ACTIVE); 
+#else
   digitalWrite(PIN_VEXT_EN, HIGH); // Turn off power
 #endif
+#endif
 }
 
 void E213Display::turnOn() {
@@ -46,41 +92,43 @@ void E213Display::turnOff() {
 }
 
 void E213Display::clear() {
-  display.clear();
+  display->clear();
+
 }
 
 void E213Display::startFrame(Color bkg) {
   // Fill screen with white first to ensure clean background
-  display.fillRect(0, 0, width(), height(), WHITE);
+  display->fillRect(0, 0, width(), height(), WHITE);
+
   if (bkg == LIGHT) {
     // Fill with black if light background requested (inverted for e-ink)
-    display.fillRect(0, 0, width(), height(), BLACK);
+    display->fillRect(0, 0, width(), height(), BLACK);
   }
 }
 
 void E213Display::setTextSize(int sz) {
   // The library handles text size internally
-  display.setTextSize(sz);
+    display->setTextSize(sz);
 }
 
 void E213Display::setColor(Color c) {
   // implemented in individual display methods
 }
 
 void E213Display::setCursor(int x, int y) {
-  display.setCursor(x, y);
+    display->setCursor(x, y);
 }
 
 void E213Display::print(const char *str) {
-  display.print(str);
+    display->print(str);
 }
 
 void E213Display::fillRect(int x, int y, int w, int h) {
-  display.fillRect(x, y, w, h, BLACK);
+    display->fillRect(x, y, w, h, BLACK);
 }
 
 void E213Display::drawRect(int x, int y, int w, int h) {
-  display.drawRect(x, y, w, h, BLACK);
+    display->drawRect(x, y, w, h, BLACK);
 }
 
 void E213Display::drawXbm(int x, int y, const uint8_t *bits, int w, int h) {
@@ -98,7 +146,7 @@ void E213Display::drawXbm(int x, int y, const uint8_t *bits, int w, int h) {
 
       // If the bit is set, draw the pixel
       if (bitSet) {
-        display.drawPixel(x + bx, y + by, BLACK);
+          display->drawPixel(x + bx, y + by, BLACK);
       }
     }
   }
@@ -107,10 +155,10 @@ void E213Display::drawXbm(int x, int y, const uint8_t *bits, int w, int h) {
 uint16_t E213Display::getTextWidth(const char *str) {
   int16_t x1, y1;
   uint16_t w, h;
-  display.getTextBounds(str, 0, 0, &x1, &y1, &w, &h);
+  display->getTextBounds(str, 0, 0, &x1, &y1, &w, &h);
   return w;
 }
 
 void E213Display::endFrame() {
-  display.update();
+    display->update();
 }

src/helpers/ui/E213Display.h

@@ -8,13 +8,17 @@
 
 // Display driver for E213 e-ink display
 class E213Display : public DisplayDriver {
-  EInkDisplay_VisionMasterE213 display;
+  BaseDisplay* display=NULL;
   bool _init = false;
   bool _isOn = false;
 
 public:
   E213Display() : DisplayDriver(250, 122) {}
-
+  ~E213Display(){
+    if(display!=NULL) {
+      delete display;
+    }
+  }
   bool begin();
   bool isOn() override { return _isOn; }
   void turnOn() override;
@@ -32,6 +36,7 @@ class E213Display : public DisplayDriver {
   void endFrame() override;
 
 private:
+  BaseDisplay* detectEInk();
   void powerOn();
   void powerOff();
 };

variants/heltec_vision_master_e213/HeltecE213Board.cpp

@@ -0,0 +1,69 @@
+#include "HeltecE213Board.h"
+
+void HeltecE213Board::begin() {
+    ESP32Board::begin();
+
+    pinMode(PIN_ADC_CTRL, OUTPUT);
+    digitalWrite(PIN_ADC_CTRL, LOW); // Initially inactive
+
+    periph_power.begin();
+
+    esp_reset_reason_t reason = esp_reset_reason();
+    if (reason == ESP_RST_DEEPSLEEP) {
+      long wakeup_source = esp_sleep_get_ext1_wakeup_status();
+      if (wakeup_source & (1 << P_LORA_DIO_1)) {  // received a LoRa packet (while in deep sleep)
+        startup_reason = BD_STARTUP_RX_PACKET;
+      }
+
+      rtc_gpio_hold_dis((gpio_num_t)P_LORA_NSS);
+      rtc_gpio_deinit((gpio_num_t)P_LORA_DIO_1);
+    }
+  }
+
+  void HeltecE213Board::enterDeepSleep(uint32_t secs, int pin_wake_btn) {
+    esp_sleep_pd_config(ESP_PD_DOMAIN_RTC_PERIPH, ESP_PD_OPTION_ON);
+
+    // Make sure the DIO1 and NSS GPIOs are hold on required levels during deep sleep 
+    rtc_gpio_set_direction((gpio_num_t)P_LORA_DIO_1, RTC_GPIO_MODE_INPUT_ONLY);
+    rtc_gpio_pulldown_en((gpio_num_t)P_LORA_DIO_1);
+
+    rtc_gpio_hold_en((gpio_num_t)P_LORA_NSS);
+
+    if (pin_wake_btn < 0) {
+      esp_sleep_enable_ext1_wakeup( (1L << P_LORA_DIO_1), ESP_EXT1_WAKEUP_ANY_HIGH);  // wake up on: recv LoRa packet
+    } else {
+      esp_sleep_enable_ext1_wakeup( (1L << P_LORA_DIO_1) | (1L << pin_wake_btn), ESP_EXT1_WAKEUP_ANY_HIGH);  // wake up on: recv LoRa packet OR wake btn
+    }
+
+    if (secs > 0) {
+      esp_sleep_enable_timer_wakeup(secs * 1000000);
+    }
+
+    // Finally set ESP32 into sleep
+    esp_deep_sleep_start();   // CPU halts here and never returns!
+  }
+
+  void HeltecE213Board::powerOff()  {
+    // TODO: re-enable this when there is a definite wake-up source pin:
+    //  enterDeepSleep(0);
+  }
+
+  uint16_t HeltecE213Board::getBattMilliVolts()  {
+    analogReadResolution(10);
+    digitalWrite(PIN_ADC_CTRL, HIGH);
+
+    uint32_t raw = 0;
+    for (int i = 0; i < 8; i++) {
+      raw += analogRead(PIN_VBAT_READ);
+    }
+    raw = raw / 8;
+
+    digitalWrite(PIN_ADC_CTRL, LOW);
+
+    return (5.42 * (3.3 / 1024.0) * raw) * 1000;
+  }
+
+  const char* HeltecE213Board::getManufacturerName() const {
+    return "Heltec E213";
+  }
+

variants/heltec_vision_master_e213/HeltecE213Board.h

@@ -0,0 +1,30 @@
+#pragma once
+
+#include <Arduino.h>
+#include <helpers/RefCountedDigitalPin.h>
+#include <helpers/ESP32Board.h>
+#include <driver/rtc_io.h>
+
+// LoRa radio module pins for heltec_vision_master_e213 
+#define  P_LORA_DIO_1   14
+#define  P_LORA_NSS      8
+#define  P_LORA_RESET   12
+#define  P_LORA_BUSY    13
+#define  P_LORA_SCLK     9
+#define  P_LORA_MISO    11
+#define  P_LORA_MOSI    10
+
+class HeltecE213Board : public ESP32Board {
+
+public:
+  RefCountedDigitalPin periph_power;
+
+  HeltecE213Board() : periph_power(PIN_VEXT_EN,PIN_VEXT_EN_ACTIVE) { }
+
+  void begin();
+  void enterDeepSleep(uint32_t secs, int pin_wake_btn = -1);
+  void powerOff() override;
+  uint16_t getBattMilliVolts() override;
+  const char* getManufacturerName() const override ;
+
+};