WaveShare PhotoPainter support

[terhorst]

Component name

epaper_spi

Link to component documentation on our website

https://esphome.io/components/display/epaper_spi/

Describe the enhancement

There is already generic support for Spectra E6-based screens, however it did not work out of the box for me on the Waveshare PhotoPainter. Adapting some of the code from the OEM firmware enabled it to work correctly. The necessary parts of the configuration are pasted below.

# Board: Generic ESP32-S3 Board (Generic)
# Definition: definitions/boards/generic-esp32s3/manifest.yaml

esphome:
  name: photopainter
  friendly_name: photopainter
  on_boot:
    # this init sequence is copied from https://github.com/waveshareteam/ESP32-S3-PhotoPainter
    - priority: 600
      then:
        - lambda: |-
            // The PhotoPainter schematic connects EPD_VCC to AXP2101 ALDO3.
            // Program it to 3.3 V and make sure that rail is enabled before the
            // first display update -- the Waveshare demo assumes this setup.
            auto read_reg = [](uint8_t reg, uint8_t &value) {
              return id(pmic_i2c).write_readv(0x34, &reg, 1, &value, 1);
            };
            auto write_reg = [](uint8_t reg, uint8_t value) {
              uint8_t data[2] = {reg, value};
              return id(pmic_i2c).write(0x34, data, sizeof(data));
            };

            uint8_t dcdc1_voltage = 0;
            uint8_t aldo3_voltage = 0;
            uint8_t aldo4_voltage = 0;
            uint8_t ldo_enable = 0;
            if (read_reg(0x82, dcdc1_voltage) != esphome::i2c::ERROR_OK ||
                read_reg(0x94, aldo3_voltage) != esphome::i2c::ERROR_OK ||
                read_reg(0x95, aldo4_voltage) != esphome::i2c::ERROR_OK ||
                read_reg(0x90, ldo_enable) != esphome::i2c::ERROR_OK) {
              ESP_LOGE("axp2101", "Could not read AXP2101; EPD power was not configured");
              return;
            }

            ESP_LOGI("axp2101", "Before setup: DCDC1=0x%02X ALDO3=0x%02X ALDO4=0x%02X LDO_ENABLE=0x%02X",
                     dcdc1_voltage, aldo3_voltage, aldo4_voltage, ldo_enable);
            // Match axp_cmd_init() in Waveshare's firmware. DCDC1 uses
            // 1500 mV + (18 * 100 mV) = 3300 mV.
            dcdc1_voltage = 0x12;
            // ALDO3: 500 mV + (28 * 100 mV) = 3300 mV.
            aldo3_voltage = (aldo3_voltage & 0xE0) | 0x1C;
            // ALDO4 uses the same encoding as ALDO3.
            aldo4_voltage = (aldo4_voltage & 0xE0) | 0x1C;
            if (write_reg(0x82, dcdc1_voltage) != esphome::i2c::ERROR_OK ||
                write_reg(0x94, aldo3_voltage) != esphome::i2c::ERROR_OK ||
                write_reg(0x95, aldo4_voltage) != esphome::i2c::ERROR_OK ||
                write_reg(0x90, ldo_enable | 0x04) != esphome::i2c::ERROR_OK) {
              ESP_LOGE("axp2101", "Failed to apply Waveshare's 3.3 V power setup");
              return;
            }
            ESP_LOGI("axp2101", "Waveshare DCDC1/ALDO3/ALDO4 3.3 V setup applied");
        - delay: 8s
        - lambda: |-
            auto read_reg = [](uint8_t reg, uint8_t &value) {
              return id(pmic_i2c).write_readv(0x34, &reg, 1, &value, 1);
            };
            uint8_t chip_id = 0;
            uint8_t dcdc1_voltage = 0;
            uint8_t aldo3_voltage = 0;
            uint8_t aldo4_voltage = 0;
            uint8_t ldo_enable = 0;
            if (read_reg(0x03, chip_id) == esphome::i2c::ERROR_OK &&
                read_reg(0x82, dcdc1_voltage) == esphome::i2c::ERROR_OK &&
                read_reg(0x94, aldo3_voltage) == esphome::i2c::ERROR_OK &&
                read_reg(0x95, aldo4_voltage) == esphome::i2c::ERROR_OK &&
                read_reg(0x90, ldo_enable) == esphome::i2c::ERROR_OK) {
              ESP_LOGI("axp2101", "Readback: CHIP_ID=0x%02X DCDC1=0x%02X ALDO3=0x%02X ALDO4=0x%02X LDO_ENABLE=0x%02X enabled=%s",
                       chip_id, dcdc1_voltage, aldo3_voltage, aldo4_voltage, ldo_enable,
                       (ldo_enable & 0x04) ? "YES" : "NO");
            } else {
              ESP_LOGE("axp2101", "Delayed AXP2101 readback failed");
            }

external_components:
  - source:
      type: local
      path: components
    components: [epaper_spi, spi]

esp32:
  variant: esp32s3
  flash_size: 16MB
  framework:
    type: esp-idf

psram:
  mode: octal
  speed: 80MHz

i2c:
  - id: pmic_i2c
    sda: GPIO47
    scl: GPIO48
    # PhotoPainter bus is shared by the PMIC and several other peripherals. 
    # avoid probing every possible address when the PMIC is recovering from a
    # power transition
    frequency: 100kHz
    scan: false

spi:
  - clk_pin: GPIO10
    mosi_pin: GPIO11
    interface: spi3
    id: spi_1

display:
  - platform: epaper_spi
    spi_id: spi_1
    model: 7.3IN-SPECTRA-E6
    cs_pin: GPIO9
    dc_pin: GPIO8
    reset_pin: GPIO12
    reset_duration: 20ms
    busy_pin:
      number: GPIO13
      inverted: true
      mode:
        input: true
        pullup: true
    data_rate: 10MHz
    dimensions:
      height: 480
      width: 800
    id: display_epaper_spi_1
    update_interval: never

Use cases

Users of WaveShare PhotoPainter.

Anything else?

No response

[github-actions[bot]]

🏷️ I've automatically added the component: epaper_spi label to help categorize this feature request.

[DanielO]

I have this board also and got it working with a small patch:

diff --git a/esphome/components/epaper_spi/epaper_spi_spectra_e6.cpp b/esphome/components/epaper_spi/epaper_spi_spectra_e6.cpp
index f47d37d..856489d 100644
--- a/esphome/components/epaper_spi/epaper_spi_spectra_e6.cpp
+++ b/esphome/components/epaper_spi/epaper_spi_spectra_e6.cpp
@@ -21,8 +21,9 @@ uint8_t EPaperSpectraE6::color_to_native(Color color) {
 }

 void EPaperSpectraE6::power_on() {
-  ESP_LOGV(TAG, "Power on");
+  ESP_LOGV(TAG, "Power on (with hack)");
   this->command(0x04);
+  this->cmd_data(0x06, {0x6f, 0x1f, 0x17, 0x49});
 }

 void EPaperSpectraE6::power_off() {

My config file is:

esphome:
  name: hapanel
  friendly_name: HAPanel

esp32:
  variant: esp32s3
  flash_size: 16MB
  flash_mode: qio
  framework:
    type: esp-idf
    advanced:
      disable_debug_stubs: false  # Keep OpenOCD debug stubs
      disable_ocd_aware: false  # Keep OCD-aware panic handlers

psram:
  mode: octal
  speed: 80MHz

logger:
  level: VERBOSE
  logs:
    epaper_spi: VERBOSE
    display: VERBOSE

api:
  encryption:
    key: !secret api_key

ota:
  - platform: esphome

wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password
  ap:
    ssid: HAPanel Fallback Hotspot
    password: !secret fallback_psk

captive_portal:

spi:
  - id: spi_1
    clk_pin: GPIO10
# Used by PSRAM in octal mode
#    miso_pin: 37
    mosi_pin: GPIO11

display:
  - platform: epaper_spi
    spi_id: spi_1
    model: spectra-e6
    dimensions:
      width: 800
      height: 480
    cs_pin: GPIO9
    dc_pin: GPIO8
    busy_pin:
      number: GPIO13
      inverted: true
    reset_pin:
      number:  GPIO12
    show_test_card: true
    update_interval: 30sec

i2c:
  - id: i2c_1
    scl: GPIO48
    sda: GPIO47
    scan: true

audio_dac:
  - platform: es8311
    id: audio_dac_es8311_1
    i2c_id: i2c_1

audio_adc:
  - platform: es7210
    id: audio_adc_es7210_1

time:
  - platform: pcf85063
    id: time_pcf85063_1

sensor:
  - platform: shtcx
    id: sensor_shtcx_1
    humidity:
      name: Humidity
      id: sensor_shtcx_1_humidity
    temperature:
      name: Temperature
      id: sensor_shtcx_1_temperature

i2s_audio:
  - id: i2s_audio_1
    i2s_lrclk_pin: GPIO16

speaker:
  - platform: i2s_audio
    id: speaker_i2s_audio_1
    dac_type: external
    i2s_audio_id: i2s_audio_1
    i2s_dout_pin: GPIO18

microphone:
  - platform: i2s_audio
    id: microphone_i2s_audio_1
    adc_type: external
    i2s_din_pin: GPIO17

I haven't tested the I2S stuff yet, the RTC & SHTC seem to work fine though.

[DanielO]

Turns out I need your code also, or maybe instead - I think I had previously run the demo code which must have set the PMIC correctly so it looked like it worked until I power cycled.