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

Add heltec_vision_master_e213 board.
10 months ago · a7dcd112ac
11 changed files with 444 additions and 23 deletions
--- a/boards/heltec_vision_master_e213.json
+++ b/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"
+}
--- a/src/helpers/RefCountedDigitalPin.h
+++ b/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);
    }
  }
 };
--- a/src/helpers/ui/E213Display.cpp
+++ b/src/helpers/ui/E213Display.cpp
@ -2,20 +2,58 @@

 #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;
 }
@ -23,15 +61,23 @@ bool E213Display::begin() {
 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,21 +92,23 @@ 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) {
@ -68,19 +116,19 @@ void E213Display::setColor(Color c) {
 }

 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();
 }
--- a/src/helpers/ui/E213Display.h
+++ b/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 @@ public:
  void endFrame() override;

 private:
+  BaseDisplay* detectEInk();
  void powerOn();
  void powerOff();
 };
--- a/variants/heltec_vision_master_e213/HeltecE213Board.cpp
+++ b/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";
+  }
+
--- a/variants/heltec_vision_master_e213/HeltecE213Board.h
+++ b/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 ;
+
+};
--- a/variants/heltec_vision_master_e213/pins_arduino.h
+++ b/variants/heltec_vision_master_e213/pins_arduino.h
@ -0,0 +1,61 @@
+#ifndef Pins_Arduino_h
+#define Pins_Arduino_h
+
+#include <stdint.h>
+
+static const uint8_t LED_BUILTIN = 45; // LED is not populated on earliest board variant
+#define BUILTIN_LED LED_BUILTIN        // Backward compatibility
+#define LED_BUILTIN LED_BUILTIN
+
+static const uint8_t TX = 43;
+static const uint8_t RX = 44;
+
+static const uint8_t SDA = 39;
+static const uint8_t SCL = 38;
+
+static const uint8_t SS = 8;
+static const uint8_t MOSI = 10;
+static const uint8_t MISO = 11;
+static const uint8_t SCK = 9;
+
+static const uint8_t A0 = 1;
+static const uint8_t A1 = 2;
+static const uint8_t A2 = 3;
+static const uint8_t A3 = 4;
+static const uint8_t A4 = 5;
+static const uint8_t A5 = 6;
+static const uint8_t A6 = 7;
+static const uint8_t A7 = 8;
+static const uint8_t A8 = 9;
+static const uint8_t A9 = 10;
+static const uint8_t A10 = 11;
+static const uint8_t A11 = 12;
+static const uint8_t A12 = 13;
+static const uint8_t A13 = 14;
+static const uint8_t A14 = 15;
+static const uint8_t A15 = 16;
+static const uint8_t A16 = 17;
+static const uint8_t A17 = 18;
+static const uint8_t A18 = 19;
+static const uint8_t A19 = 20;
+
+static const uint8_t T1 = 1;
+static const uint8_t T2 = 2;
+static const uint8_t T3 = 3;
+static const uint8_t T4 = 4;
+static const uint8_t T5 = 5;
+static const uint8_t T6 = 6;
+static const uint8_t T7 = 7;
+static const uint8_t T8 = 8;
+static const uint8_t T9 = 9;
+static const uint8_t T10 = 10;
+static const uint8_t T11 = 11;
+static const uint8_t T12 = 12;
+static const uint8_t T13 = 13;
+static const uint8_t T14 = 14;
+
+static const uint8_t RST_LoRa = 12;
+static const uint8_t BUSY_LoRa = 13;
+static const uint8_t DIO1 = 14;
+
+#endif /* Pins_Arduino_h */
--- a/variants/heltec_vision_master_e213/platformio.ini
+++ b/variants/heltec_vision_master_e213/platformio.ini
@ -0,0 +1,84 @@
+[Heltec_Vision_Master_E213_base]
+extends = esp32_base
+board = heltec_vision_master_e213
+build_flags =
+  ${esp32_base.build_flags}
+  -I variants/heltec_vision_master_e213
+  -D HELTEC_VISION_MASTER_E213
+  -D RADIO_CLASS=CustomSX1262
+  -D WRAPPER_CLASS=CustomSX1262Wrapper
+  -D LORA_TX_POWER=22
+  -D P_LORA_TX_LED=45
+  -D PIN_USER_BTN=0
+  -D PIN_VEXT_EN=18
+  -D PIN_VEXT_EN_ACTIVE=HIGH
+  -D PIN_VBAT_READ=7
+  -D PIN_ADC_CTRL=46
+  -D SX126X_DIO2_AS_RF_SWITCH=true
+  -D SX126X_DIO3_TCXO_VOLTAGE=1.8
+  -D SX126X_CURRENT_LIMIT=140
+  -D SX126X_RX_BOOSTED_GAIN=1
+  -D PIN_BOARD_SDA=39
+  -D PIN_BOARD_SCL=38
+  -D DISP_CS=5
+  -D DISP_BUSY=1
+  -D DISP_DC=2
+  -D DISP_RST=3
+  -D DISP_SCLK=4
+  -D DISP_MOSI=6
+  -D Vision_Master_E213
+build_src_filter = ${esp32_base.build_src_filter}
+  +<../variants/heltec_vision_master_e213>    
+lib_deps =
+  ${esp32_base.lib_deps}
+  https://github.com/Quency-D/heltec-eink-modules/archive/563dd41fd850a1bc3039b8723da4f3a20fe1c800.zip
+
+[env:Heltec_Vision_Master_E213_radio_ble]
+extends = Heltec_Vision_Master_E213_base
+build_flags =
+  ${Heltec_Vision_Master_E213_base.build_flags}
+  -D MAX_CONTACTS=100
+  -D MAX_GROUP_CHANNELS=8
+  -D DISPLAY_CLASS=E213Display
+  -D BLE_PIN_CODE=123456   ; dynamic, random PIN
+  -D BLE_DEBUG_LOGGING=1
+  -D OFFLINE_QUEUE_SIZE=256
+build_src_filter = ${Heltec_Vision_Master_E213_base.build_src_filter}
+  +<helpers/ui/E213Display.cpp>
+  +<helpers/esp32/*.cpp>
+  +<../examples/companion_radio>
+lib_deps =
+  ${Heltec_Vision_Master_E213_base.lib_deps}
+  densaugeo/base64 @ ~1.4.0
+
+[env:Heltec_Vision_Master_E213_repeater]
+extends = Heltec_Vision_Master_E213_base
+build_flags =
+  ${Heltec_Vision_Master_E213_base.build_flags}
+  -D DISPLAY_CLASS=E213Display
+  -D ADVERT_NAME='"Heltec E213 Repeater"'
+  -D ADVERT_LAT=0.0
+  -D ADVERT_LON=0.0
+build_src_filter = ${Heltec_Vision_Master_E213_base.build_src_filter}
+  +<helpers/ui/E213Display.cpp>
+  +<../examples/simple_repeater>
+lib_deps =
+  ${Heltec_Vision_Master_E213_base.lib_deps}
+  ${esp32_ota.lib_deps}
+
+[env:Heltec_Vision_Master_E213_room_server]
+extends = Heltec_Vision_Master_E213_base
+build_flags =
+  ${Heltec_Vision_Master_E213_base.build_flags}
+  -D DISPLAY_CLASS=E213Display
+  -D ADVERT_NAME='"Heltec E213 Room"'
+  -D ADVERT_LAT=0.0
+  -D ADVERT_LON=0.0
+  -D ADMIN_PASSWORD='"password"'
+  -D ROOM_PASSWORD='"hello"'
+build_src_filter = ${Heltec_Vision_Master_E213_base.build_src_filter}
+  +<helpers/ui/E213Display.cpp>
+  +<../examples/simple_room_server>
+lib_deps =
+  ${Heltec_Vision_Master_E213_base.lib_deps}
+  ${esp32_ota.lib_deps}
--- a/variants/heltec_vision_master_e213/target.cpp
+++ b/variants/heltec_vision_master_e213/target.cpp
@ -0,0 +1,53 @@
+#include "target.h"
+#include <Arduino.h>
+
+HeltecE213Board board;
+
+#if defined(P_LORA_SCLK)
+  static SPIClass spi(FSPI);
+  RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY, spi);
+#else
+  RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY);
+#endif
+
+WRAPPER_CLASS radio_driver(radio, board);
+
+ESP32RTCClock fallback_clock;
+AutoDiscoverRTCClock rtc_clock(fallback_clock);
+
+SensorManager sensors;
+
+#ifdef DISPLAY_CLASS
+DISPLAY_CLASS display;
+#endif
+
+bool radio_init() {
+  fallback_clock.begin();
+  rtc_clock.begin(Wire);
+
+#if defined(P_LORA_SCLK)
+  return radio.std_init(&spi);
+#else
+  return radio.std_init();
+#endif
+}
+
+uint32_t radio_get_rng_seed() {
+  return radio.random(0x7FFFFFFF);
+}
+
+void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr) {
+  radio.setFrequency(freq);
+  radio.setSpreadingFactor(sf);
+  radio.setBandwidth(bw);
+  radio.setCodingRate(cr);
+}
+
+void radio_set_tx_power(uint8_t dbm) {
+  radio.setOutputPower(dbm);
+}
+
+mesh::LocalIdentity radio_new_identity() {
+  RadioNoiseListener rng(radio);
+  return mesh::LocalIdentity(&rng); // create new random identity
+}
--- a/variants/heltec_vision_master_e213/target.h
+++ b/variants/heltec_vision_master_e213/target.h
@ -0,0 +1,27 @@
+#pragma once
+
+#define RADIOLIB_STATIC_ONLY 1
+#include <RadioLib.h>
+#include <helpers/radiolib/RadioLibWrappers.h>
+#include <HeltecE213Board.h>
+#include <helpers/radiolib/CustomSX1262Wrapper.h>
+#include <helpers/AutoDiscoverRTCClock.h>
+#include <helpers/SensorManager.h>
+#ifdef DISPLAY_CLASS
+#include <helpers/ui/E213Display.h>
+#endif
+
+extern HeltecE213Board board;
+extern WRAPPER_CLASS radio_driver;
+extern AutoDiscoverRTCClock rtc_clock;
+extern SensorManager sensors;
+
+#ifdef DISPLAY_CLASS
+extern DISPLAY_CLASS display;
+#endif
+
+bool radio_init();
+uint32_t radio_get_rng_seed();
+void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr);
+void radio_set_tx_power(uint8_t dbm);
+mesh::LocalIdentity radio_new_identity();
--- a/variants/heltec_wireless_paper/platformio.ini
+++ b/variants/heltec_wireless_paper/platformio.ini
@ -31,7 +31,7 @@ build_src_filter = ${esp32_base.build_src_filter}
  +<../variants/heltec_wireless_paper>    
 lib_deps =
  ${esp32_base.lib_deps}
-  todd-herbert/heltec-eink-modules @ 4.5.0
+  https://github.com/todd-herbert/heltec-eink-modules/archive/9207eb6ab2b96f66298e0488740218c17b006af7.zip

 [env:Heltec_Wireless_Paper_companion_radio_ble]
 extends = Heltec_Wireless_Paper_base