Merge pull request #9838 from SeanTheITGuy/heltec_wireless_paper

Heltec wireless paper
adafruit · Nov 27, 2024 · a236fd6 · a236fd6
2 parents 464ccb5 + 3251fad
commit a236fd6
Show file tree

Hide file tree

Showing 5 changed files with 274 additions and 0 deletions.
diff --git a/ports/espressif/boards/heltec_wireless_paper/board.c b/ports/espressif/boards/heltec_wireless_paper/board.c
@@ -0,0 +1,151 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2020 Scott Shawcroft for Adafruit Industries
+//
+// SPDX-License-Identifier: MIT
+
+#include "supervisor/board.h"
+#include "mpconfigboard.h"
+#include "shared-bindings/busio/SPI.h"
+#include "shared-bindings/fourwire/FourWire.h"
+#include "shared-bindings/microcontroller/Pin.h"
+#include "shared-module/displayio/__init__.h"
+#include "shared-module/displayio/mipi_constants.h"
+#include "shared-bindings/board/__init__.h"
+#include "shared-bindings/digitalio/DigitalInOut.h"
+
+const uint8_t display_start_sequence[] = {
+    0x04, 0x80, 0xc8,   // power on
+    0x00, 0x01, 0x1f,   // panel setting
+    0x50, 0x01, 0x97,   // CDI setting
+
+    // common voltage
+    0x20, 0x2a,
+    0x00, 0x0A, 0x00, 0x00, 0x00, 0x01,
+    0x60, 0x14, 0x14, 0x00, 0x00, 0x01,
+    0x00, 0x14, 0x00, 0x00, 0x00, 0x01,
+    0x00, 0x13, 0x0A, 0x01, 0x00, 0x01,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    // White to White
+    0x21, 0x2a,
+    0x40, 0x0A, 0x00, 0x00, 0x00, 0x01,
+    0x90, 0x14, 0x14, 0x00, 0x00, 0x01,
+    0x10, 0x14, 0x0A, 0x00, 0x00, 0x01,
+    0xA0, 0x13, 0x01, 0x00, 0x00, 0x01,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    // Black to White
+    0x22, 0x2a,
+    0x40, 0x0A, 0x00, 0x00, 0x00, 0x01,
+    0x90, 0x14, 0x14, 0x00, 0x00, 0x01,
+    0x00, 0x14, 0x0A, 0x00, 0x00, 0x01,
+    0x99, 0x0B, 0x04, 0x04, 0x01, 0x01,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    // White to Black
+    0x23, 0x2a,
+    0x40, 0x0A, 0x00, 0x00, 0x00, 0x01,
+    0x90, 0x14, 0x14, 0x00, 0x00, 0x01,
+    0x00, 0x14, 0x0A, 0x00, 0x00, 0x01,
+    0x99, 0x0C, 0x01, 0x03, 0x04, 0x01,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    // Black to Black
+    0x24, 0x2a,
+    0x80, 0x0A, 0x00, 0x00, 0x00, 0x01,
+    0x90, 0x14, 0x14, 0x00, 0x00, 0x01,
+    0x20, 0x14, 0x0A, 0x00, 0x00, 0x01,
+    0x50, 0x13, 0x01, 0x00, 0x00, 0x01,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+};
+
+const uint8_t display_stop_sequence[] = {
+    0x50, 0x01, 0xf7,
+    0x07, 0x01, 0xa5,
+};
+
+const uint8_t refresh_sequence[] = {
+    0x12,
+};
+
+void board_init(void) {
+
+    // Set vext on (active low) to enable EPD
+    digitalio_digitalinout_obj_t vext_pin_obj;
+    vext_pin_obj.base.type = &digitalio_digitalinout_type;
+    common_hal_digitalio_digitalinout_construct(&vext_pin_obj, &pin_GPIO45);
+    common_hal_digitalio_digitalinout_switch_to_output(&vext_pin_obj, false, DRIVE_MODE_PUSH_PULL);
+    common_hal_digitalio_digitalinout_never_reset(&vext_pin_obj);
+
+    // Set up the SPI object used to control the display
+    fourwire_fourwire_obj_t *bus = &allocate_display_bus()->fourwire_bus;
+    busio_spi_obj_t *spi = &bus->inline_bus;
+    common_hal_busio_spi_construct(spi, &pin_GPIO3, &pin_GPIO2, NULL, false);
+    common_hal_busio_spi_never_reset(spi);
+
+    // Set up the DisplayIO pin object
+    bus->base.type = &fourwire_fourwire_type;
+    common_hal_fourwire_fourwire_construct(bus,
+        spi,
+        &pin_GPIO5, // EPD_DC Command or data
+        &pin_GPIO4, // EPD_CS Chip select
+        &pin_GPIO6, // EPD_RST Reset
+        1000000, // Baudrate
+        0, // Polarity
+        0); // Phase
+
+// Set up the DisplayIO epaper object
+    epaperdisplay_epaperdisplay_obj_t *display = &allocate_display()->epaper_display;
+    display->base.type = &epaperdisplay_epaperdisplay_type;
+    common_hal_epaperdisplay_epaperdisplay_construct(
+        display,
+        bus,
+        display_start_sequence, sizeof(display_start_sequence),
+        0, // start up time
+        display_stop_sequence, sizeof(display_stop_sequence),
+        250, // width
+        122, // height
+        128, // ram_width
+        296, // ram_height
+        0, // colstart
+        0, // rowstart
+        270, // rotation
+        NO_COMMAND, // set_column_window_command
+        NO_COMMAND, // set_row_window_command
+        NO_COMMAND, // set_current_column_command
+        NO_COMMAND, // set_current_row_command
+        0x13, // write_black_ram_command
+        false, // black_bits_inverted
+        0x10, // write_color_ram_command
+        false, // color_bits_inverted
+        0x000000, // highlight_color
+        refresh_sequence, sizeof(refresh_sequence), // refresh_display_command
+        1.0, // refresh_time
+        &pin_GPIO7, // busy_pin
+        false, // busy_state
+        2.0, // seconds_per_frame
+        false, // always_toggle_chip_select
+        false, // grayscale
+        false, // acep
+        false, // two_byte_sequence_length
+        false); // address_little_endian
+}
+
+void board_deinit(void) {
+    epaperdisplay_epaperdisplay_obj_t *display = &displays[0].epaper_display;
+    if (display->base.type == &epaperdisplay_epaperdisplay_type) {
+        while (common_hal_epaperdisplay_epaperdisplay_get_busy(display)) {
+            RUN_BACKGROUND_TASKS;
+        }
+    }
+    common_hal_displayio_release_displays();
+}
+
+// Use the MP_WEAK supervisor/shared/board.c versions of routines not defined here.
diff --git a/ports/espressif/boards/heltec_wireless_paper/mpconfigboard.h b/ports/espressif/boards/heltec_wireless_paper/mpconfigboard.h
@@ -0,0 +1,28 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2019 Scott Shawcroft for Adafruit Industries
+//
+// SPDX-License-Identifier: MIT
+
+#pragma once
+
+// Micropython setup
+
+#define MICROPY_HW_BOARD_NAME       "Heltec Wireless Paper"
+#define MICROPY_HW_MCU_NAME         "ESP32S3"
+
+#define CIRCUITPY_BOOT_BUTTON (&pin_GPIO0)
+
+#define CIRCUITPY_BOARD_SPI         (2)
+#define CIRCUITPY_BOARD_SPI_PIN     { \
+        {.clock = &pin_GPIO3, .mosi = &pin_GPIO2, .miso = NULL}, \
+        {.clock = &pin_GPIO9, .mosi = &pin_GPIO11, .miso = &pin_GPIO11}, \
+}
+
+// UART definition for UART connected to the CP210x
+#define DEFAULT_UART_BUS_RX         (&pin_GPIO44)
+#define DEFAULT_UART_BUS_TX         (&pin_GPIO43)
+
+// Serial over UART
+#define CIRCUITPY_CONSOLE_UART_RX               DEFAULT_UART_BUS_RX
+#define CIRCUITPY_CONSOLE_UART_TX               DEFAULT_UART_BUS_TX
diff --git a/ports/espressif/boards/heltec_wireless_paper/mpconfigboard.mk b/ports/espressif/boards/heltec_wireless_paper/mpconfigboard.mk
@@ -0,0 +1,25 @@
+# Product URL: https://heltec.org/project/wifi-lora-32-v3/
+# Schematic: https://resource.heltec.cn/download/WiFi_LoRa32_V3/HTIT-WB32LA(F)_V3_Schematic_Diagram.pdf
+# Datasheet: https://resource.heltec.cn/download/WiFi_LoRa32_V3/HTIT-WB32LA_V3(Rev1.1).pdf
+# Pinout: https://resource.heltec.cn/download/WiFi_LoRa32_V3/HTIT-WB32LA(F)_V3.png
+
+CIRCUITPY_CREATOR_ID = 0x148E173C
+CIRCUITPY_CREATION_ID = 0x00530002
+
+USB_PRODUCT = "Heltec-Wireless-Paper"
+USB_MANUFACTURER = "Heltec"
+
+IDF_TARGET = esp32s3
+
+# This board doesn't have USB by default, it
+# instead uses a CP2102 USB-to-Serial chip
+CIRCUITPY_USB_DEVICE = 0
+CIRCUITPY_ESP_USB_SERIAL_JTAG = 0
+
+CIRCUITPY_ESP_FLASH_MODE = qio
+CIRCUITPY_ESP_FLASH_FREQ = 80m
+CIRCUITPY_ESP_FLASH_SIZE = 8MB
+
+CIRCUITPY_ESPCAMERA = 0
+
+CIRCUITPY_DISPLAYIO = 1
diff --git a/ports/espressif/boards/heltec_wireless_paper/pins.c b/ports/espressif/boards/heltec_wireless_paper/pins.c
@@ -0,0 +1,55 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2020 Scott Shawcroft for Adafruit Industries
+//
+// SPDX-License-Identifier: MIT
+
+#include "shared-bindings/board/__init__.h"
+#include "shared-module/displayio/__init__.h"
+
+static const mp_rom_map_elem_t board_module_globals_table[] = {
+    CIRCUITPYTHON_BOARD_DICT_STANDARD_ITEMS
+
+    // Sole programmable button
+    { MP_ROM_QSTR(MP_QSTR_BUTTON0), MP_ROM_PTR(&pin_GPIO0) },
+
+    // LED
+    { MP_ROM_QSTR(MP_QSTR_LED0), MP_ROM_PTR(&pin_GPIO18) },
+
+    // ADC (When ADC_CTRL is low, VBAT is connected to ADC_IN with 10K/10K voltage divider)
+    { MP_ROM_QSTR(MP_QSTR_ADC_CTRL), MP_ROM_PTR(&pin_GPIO19) },
+    { MP_ROM_QSTR(MP_QSTR_ADC_IN), MP_ROM_PTR(&pin_GPIO20) },
+    { MP_ROM_QSTR(MP_QSTR_BATTERY), MP_ROM_PTR(&pin_GPIO20) },
+
+    // VEXT powers epd and lora antenna boost when low
+    { MP_ROM_QSTR(MP_QSTR_VEXT_CTRL), MP_ROM_PTR(&pin_GPIO45) },
+
+    // UART that's connected to CP210x over USB
+    { MP_ROM_QSTR(MP_QSTR_DEBUG_TX), MP_ROM_PTR(&pin_GPIO43) },
+    { MP_ROM_QSTR(MP_QSTR_DEBUG_RX), MP_ROM_PTR(&pin_GPIO44) },
+
+    // LORA SPI, Reset, and More
+    { MP_ROM_QSTR(MP_QSTR_LORA_CS), MP_ROM_PTR(&pin_GPIO8) },
+    { MP_ROM_QSTR(MP_QSTR_LORA_SCK), MP_ROM_PTR(&pin_GPIO9) },
+    { MP_ROM_QSTR(MP_QSTR_LORA_MOSI), MP_ROM_PTR(&pin_GPIO10) },
+    { MP_ROM_QSTR(MP_QSTR_LORA_MISO), MP_ROM_PTR(&pin_GPIO11) },
+    { MP_ROM_QSTR(MP_QSTR_LORA_RESET), MP_ROM_PTR(&pin_GPIO12) },
+    { MP_ROM_QSTR(MP_QSTR_LORA_BUSY), MP_ROM_PTR(&pin_GPIO13) },
+    { MP_ROM_QSTR(MP_QSTR_LORA_DIO1), MP_ROM_PTR(&pin_GPIO14) },
+
+    // eInk Display
+    { MP_ROM_QSTR(MP_QSTR_EPD_MOSI), MP_ROM_PTR(&pin_GPIO2) },
+    { MP_ROM_QSTR(MP_QSTR_EPD_SCK), MP_ROM_PTR(&pin_GPIO3) },
+    { MP_ROM_QSTR(MP_QSTR_EPD_CS), MP_ROM_PTR(&pin_GPIO4) },
+    { MP_ROM_QSTR(MP_QSTR_EPD_DC), MP_ROM_PTR(&pin_GPIO5) },
+    { MP_ROM_QSTR(MP_QSTR_EPD_RES), MP_ROM_PTR(&pin_GPIO6) },
+    { MP_ROM_QSTR(MP_QSTR_EPD_BUSY), MP_ROM_PTR(&pin_GPIO7) },
+
+    // objects
+    { MP_ROM_QSTR(MP_QSTR_UART), MP_ROM_PTR(&board_uart_obj) },
+    { MP_ROM_QSTR(MP_QSTR_SPI), MP_ROM_PTR(&board_spi_obj) },
+    { MP_ROM_QSTR(MP_QSTR_DISPLAY), MP_ROM_PTR(&displays[0].epaper_display)},
+
+};
+
+MP_DEFINE_CONST_DICT(board_module_globals, board_module_globals_table);
diff --git a/ports/espressif/boards/heltec_wireless_paper/sdkconfig b/ports/espressif/boards/heltec_wireless_paper/sdkconfig
@@ -0,0 +1,15 @@
+#
+# Espressif IoT Development Framework Configuration
+#
+#
+# Component config
+#
+#
+# LWIP
+#
+CONFIG_ESP_PHY_ENABLE_USB=n
+# end of LWIP
+
+# end of Component config
+
+# end of Espressif IoT Development Framework Configuration