diff --git a/sites/en/docs/Sensor/ePaper_Displays/Application/work_with_esphome.md b/sites/en/docs/Sensor/ePaper_Displays/Application/work_with_esphome.md index e53aeec51448a..29a5f96386fd9 100644 --- a/sites/en/docs/Sensor/ePaper_Displays/Application/work_with_esphome.md +++ b/sites/en/docs/Sensor/ePaper_Displays/Application/work_with_esphome.md @@ -48,7 +48,7 @@ Every Seeed ePaper product on the [main hub page](/seeed_epaper_displays) that h reTerminal E1001 / E1002 / E1003 / E1004 XIAO ESP32-S3 - Basic · Advanced (peripherals) + Display · I/O & power · RTC, SD & mic EE04 driver board @@ -193,8 +193,9 @@ You can now drag the entities into a Lovelace dashboard, or — much more intere This page intentionally stops at the boilerplate. The product-specific YAML, peripheral examples, and end-to-end recipes live in each product's cookbook: -- **[reTerminal E Series — Basic ESPHome](/reterminal_e10xx_with_esphome)** — first dashboard, Wi-Fi setup, pre-built firmware ZIP for E1001/E1002/E1003/E1004. -- **[reTerminal E Series — Advanced ESPHome](/reterminal_e10xx_with_esphome_advanced)** — buttons, buzzer, battery monitoring, SHT4x sensor, deep sleep, multi-page dashboards. +- **[reTerminal E Series — ESPHome Display](/reterminal_e10xx_with_esphome)** — first dashboard, Wi-Fi setup, pre-built firmware ZIP, and ePaper drawing examples for E1001/E1002/E1003/E1004. +- **[reTerminal E Series — ESPHome I/O, Battery & Power](/reterminal_e10xx_with_esphome_advanced)** — buttons, buzzer, onboard LED, battery monitoring, SHT4x sensor, deep sleep, and multi-page dashboards. +- **[reTerminal E1001 / E1002 — ESPHome RTC, SD & Microphone](/reterminal_e10xx_with_esphome_rtc_sd_microphone)** — PCF8563 RTC time sync, microSD card power/detect pins, and onboard PDM microphone setup. - **[EE04 driver board — ESPHome](/EE04_with_esphome_advanced)** — full Home Assistant integration on the XIAO ESP32-S3 + EE04 + your choice of ePaper screen. - **[XIAO 7.5" ePaper Panel — ESPHome](/xiao_075inch_epaper_panel_esphome)** — minimal ESP32-C3 dashboard. - **[TRMNL 7.5" DIY Kit — ESPHome](/ogdiy_kit_works_with_esphome)** — using the kit hardware with ESPHome instead of the TRMNL cloud platform. @@ -217,7 +218,7 @@ When new ePaper products ship, the corresponding cookbook is added under each pr ### Battery drains faster than expected -ePaper only saves power when the rest of the SoC is also asleep. Add a `deep_sleep` block (see the Advanced cookbook for your product) and lower the `update_interval`. +ePaper only saves power when the rest of the SoC is also asleep. Add a `deep_sleep` block (see the I/O, battery, and low-power cookbook for your product) and lower the `update_interval`. For deeper troubleshooting on a specific product, check the cookbook for that hardware. diff --git a/sites/en/docs/Sensor/ePaper_Displays/reTerminal_E10xx/cookbooks/esphome.md b/sites/en/docs/Sensor/ePaper_Displays/reTerminal_E10xx/cookbooks/esphome.md index 17ca3ad256a38..ada50633e2ea2 100644 --- a/sites/en/docs/Sensor/ePaper_Displays/reTerminal_E10xx/cookbooks/esphome.md +++ b/sites/en/docs/Sensor/ePaper_Displays/reTerminal_E10xx/cookbooks/esphome.md @@ -1,13 +1,13 @@ --- -description: ESPHome cookbook for reTerminal E1001 / E1002 / E1003 / E1004 - Basic Home Assistant integration, first dashboard, Wi-Fi setup, pre-built firmware ZIP. -title: ESPHome Cookbook - Basic (reTerminal E Series) +description: ESPHome display cookbook for reTerminal E1001 / E1002 / E1003 / E1004 - Home Assistant integration, first dashboard, Wi-Fi setup, pre-built firmware ZIP, and ePaper drawing examples. +title: ESPHome Cookbook - Display Basics (reTerminal E Series) image: https://files.seeedstudio.com/wiki/reterminal_e10xx/img/44.webp slug: /reterminal_e10xx_with_esphome aliases: - /reterminal_e10xx_esphome sku: 100017057,100073581 sidebar_position: 3 -sidebar_label: ESPHome (Basic) +sidebar_label: ESPHome - Display last_update: date: 04/28/2026 author: Citric @@ -19,10 +19,10 @@ url: https://wiki.seeedstudio.com/reterminal_e10xx_with_esphome/ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# ESPHome Cookbook - Basic: reTerminal E Series +# ESPHome Cookbook - Display Basics: reTerminal E Series :::tip Read the main ESPHome guide first -This page is the **reTerminal E Series-specific ESPHome cookbook (basic)**. The shared boilerplate — picking a flashing path, the generic YAML skeleton, connecting to Home Assistant — lives in **[Work with ESPHome](/epaper_work_with_esphome)**. Skim that first if you're new to ESPHome on Seeed ePaper. For onboard-peripheral examples (buttons, buzzer, battery, SHT4x, deep sleep), see the [Advanced cookbook](/reterminal_e10xx_with_esphome_advanced). +This page is the **reTerminal E Series-specific ESPHome display cookbook**. The shared boilerplate — picking a flashing path, the generic YAML skeleton, connecting to Home Assistant — lives in **[Work with ESPHome](/epaper_work_with_esphome)**. Skim that first if you're new to ESPHome on Seeed ePaper. For buttons, buzzer, LED, battery, SHT4x, and deep sleep, see the [I/O, battery, and low-power cookbook](/reterminal_e10xx_with_esphome_advanced). For RTC, microSD card detect, and microphone setup, see the [RTC, SD card, and microphone cookbook](/reterminal_e10xx_with_esphome_rtc_sd_microphone). :::

@@ -969,7 +969,10 @@ By combining images with text and other display elements covered in previous exa ## Continue Reading -Due to space constraints, this article only covers some basic use cases and drawing examples of the device. We will cover the use of reTerminal's hardware on ESPHome in more detail in the [Advanced ESPHome Usage of reTerminal E Series ePaper Display in Home Assistant](https://wiki.seeedstudio.com/reterminal_e10xx_with_esphome_advanced)'s Wiki, which you can read on. +This article focuses on connecting the display and drawing content on the ePaper screen. Continue with these ESPHome cookbooks when you want to use the rest of the onboard hardware: + +- **[ESPHome Cookbook: Buttons, Buzzer, LED, Battery & Low Power](/reterminal_e10xx_with_esphome_advanced)** - user buttons, buzzer feedback, onboard LED, battery monitoring, SHT4x sensor, deep sleep, and multi-page dashboards. +- **[ESPHome Cookbook: RTC, SD Card & Microphone](/reterminal_e10xx_with_esphome_rtc_sd_microphone)** - PCF8563 RTC time sync, microSD card power/detect pins, and onboard PDM microphone initialization. ## FAQ @@ -991,6 +994,15 @@ In this case, you should go to Settings -> Devices & Services -> Integrations to Try unplugging and replugging it several times, or just install the driver according to the prompts. +### Q4: Why is there no serial log over USB? + +The reTerminal E Series uses a CH340K USB-to-UART bridge on UART0. Keep this logger setting in your YAML: + +```yaml +logger: + hardware_uart: UART0 +``` + ## Tech Support & Product Discussion Thank you for choosing our products! We are here to provide you with different support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs. diff --git a/sites/en/docs/Sensor/ePaper_Displays/reTerminal_E10xx/cookbooks/esphome_advanced.md b/sites/en/docs/Sensor/ePaper_Displays/reTerminal_E10xx/cookbooks/esphome_advanced.md index 2b071366bd52f..a1082c01ffda6 100644 --- a/sites/en/docs/Sensor/ePaper_Displays/reTerminal_E10xx/cookbooks/esphome_advanced.md +++ b/sites/en/docs/Sensor/ePaper_Displays/reTerminal_E10xx/cookbooks/esphome_advanced.md @@ -1,10 +1,10 @@ --- -description: ESPHome cookbook for reTerminal E1001 / E1002 / E1003 / E1004 - Advanced peripherals (buttons, buzzer, battery monitoring, SHT4x sensor, deep sleep, multi-page dashboards). -title: ESPHome Cookbook - Advanced (reTerminal E Series) +description: ESPHome cookbook for reTerminal E1001 / E1002 / E1003 / E1004 - buttons, buzzer, onboard LED, battery monitoring, SHT4x sensor, deep sleep, and multi-page dashboards. +title: 'ESPHome Cookbook: Buttons, Buzzer, LED, Battery & Low Power (reTerminal E Series)' image: https://files.seeedstudio.com/wiki/reterminal_e10xx/img/27.webp slug: /reterminal_e10xx_with_esphome_advanced sidebar_position: 4 -sidebar_label: ESPHome (Advanced) +sidebar_label: 'ESPHome - I/O, Battery & Power' last_update: date: 04/28/2026 author: Citric @@ -16,15 +16,15 @@ url: https://wiki.seeedstudio.com/reterminal_e10xx_with_esphome_advanced/ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# ESPHome Cookbook - Advanced: reTerminal E Series +# ESPHome Cookbook: Buttons, Buzzer, LED, Battery & Low Power (reTerminal E Series) :::tip Prerequisites -This page assumes you've already worked through the [Basic ESPHome cookbook for reTerminal E Series](/reterminal_e10xx_with_esphome) (device on Wi-Fi, Home Assistant integration online, first dashboard rendered). For the platform-level YAML skeleton and Home Assistant integration steps, see [Work with ESPHome](/epaper_work_with_esphome). +This page assumes you've already worked through the [ESPHome display cookbook for reTerminal E Series](/reterminal_e10xx_with_esphome) (device on Wi-Fi, Home Assistant integration online, first dashboard rendered). For the platform-level YAML skeleton and Home Assistant integration steps, see [Work with ESPHome](/epaper_work_with_esphome). For RTC, microSD card detect, and microphone setup, see [ESPHome Cookbook: RTC, SD Card & Microphone](/reterminal_e10xx_with_esphome_rtc_sd_microphone). :::

-This article explores advanced ESPHome configurations for your reTerminal E Series ePaper Display device, building upon the foundational concepts covered in our [Basic ESPHome Usage guide](https://wiki.seeedstudio.com/reterminal_e10xx_with_esphome). If you're new to ESPHome or the reTerminal E Series, we recommend starting with the basic guide before diving into these advanced applications. +This article covers the onboard I/O and power-related ESPHome configurations for your reTerminal E Series ePaper Display device, building upon the foundational concepts covered in our [ESPHome display cookbook](https://wiki.seeedstudio.com/reterminal_e10xx_with_esphome). If you're new to ESPHome or the reTerminal E Series, we recommend starting with the display guide before using these hardware examples. ## Hardware Capabilities @@ -207,11 +207,11 @@ logger: # Enable Home Assistant API api: encryption: - key: "m+rOiVDwjdvePoiG1zritvcD0Kl/a2zmsnuG+4IfWlw=" + key: "REPLACE_WITH_YOUR_API_KEY" ota: - platform: esphome - password: "710fecea969062a5775b287a54f3c0f5" + password: "REPLACE_WITH_YOUR_OTA_PASSWORD" wifi: ssid: !secret wifi_ssid @@ -220,7 +220,7 @@ wifi: # Enable fallback hotspot (captive portal) in case wifi connection fails ap: ssid: "Reterminal-E10Xx" - password: "tRc2fXaYE54Q" + password: "ChangeMe123" captive_portal: @@ -645,11 +645,11 @@ logger: # Enable Home Assistant API api: encryption: - key: "g93yP72UIyVsz9WfffaDMK+JeIQYROIFRK+VIQjkM+g=" + key: "REPLACE_WITH_YOUR_API_KEY" ota: - platform: esphome - password: "1ff187393ee444aa2e892779dc78e488" + password: "REPLACE_WITH_YOUR_OTA_PASSWORD" wifi: ssid: !secret wifi_ssid @@ -658,7 +658,7 @@ wifi: # Enable fallback hotspot (captive portal) in case wifi connection fails ap: ssid: "reTerminal-E1001" - password: "yoUkaGlJaDpC" + password: "ChangeMe123" captive_portal: @@ -967,11 +967,11 @@ logger: # Enable Home Assistant API api: encryption: - key: "g93yP72UIyVsz9WfffaDMK+JeIQYROIFRK+VIQjkM+g=" + key: "REPLACE_WITH_YOUR_API_KEY" ota: - platform: esphome - password: "1ff187393ee444aa2e892779dc78e488" + password: "REPLACE_WITH_YOUR_OTA_PASSWORD" wifi: ssid: !secret wifi_ssid @@ -980,7 +980,7 @@ wifi: # Enable fallback hotspot (captive portal) in case wifi connection fails ap: ssid: "reTerminal-E1002" - password: "yoUkaGlJaDpC" + password: "ChangeMe123" captive_portal: @@ -1316,6 +1316,15 @@ Step 4. Finally, replug the cable and upload a new program. --> In this case, your device is either offline or in deep sleep mode. Please ensure it's connected to your network or wake it up from sleep mode before attempting to upload. +### Q4: Why is there no serial log over USB? + +The reTerminal E Series uses a CH340K USB-to-UART bridge on UART0. Keep this logger setting in your YAML: + +```yaml +logger: + hardware_uart: UART0 +``` + ## Tech Support & Product Discussion Thank you for choosing our products! We are here to provide you with different support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs. diff --git a/sites/en/docs/Sensor/ePaper_Displays/reTerminal_E10xx/cookbooks/esphome_rtc_sd_microphone.md b/sites/en/docs/Sensor/ePaper_Displays/reTerminal_E10xx/cookbooks/esphome_rtc_sd_microphone.md new file mode 100644 index 0000000000000..1b40747923300 --- /dev/null +++ b/sites/en/docs/Sensor/ePaper_Displays/reTerminal_E10xx/cookbooks/esphome_rtc_sd_microphone.md @@ -0,0 +1,1087 @@ +--- +description: ESPHome cookbook for reTerminal E1001 / E1002 - standalone demos for PCF8563 RTC time sync, microSD card detection, onboard PDM microphone initialization, and a combined hardware status dashboard. +title: 'ESPHome Cookbook: RTC, SD Card & Microphone (reTerminal E Series)' +image: https://files.seeedstudio.com/wiki/reterminal_e10xx/img/27.webp +slug: /reterminal_e10xx_with_esphome_rtc_sd_microphone +sidebar_position: 5 +sidebar_label: 'ESPHome - RTC, SD & Microphone' +last_update: + date: 06/12/2026 + author: Citric +createdAt: '2026-06-12' +updatedAt: '2026-06-12' +url: https://wiki.seeedstudio.com/reterminal_e10xx_with_esphome_rtc_sd_microphone/ +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# ESPHome Cookbook: RTC, SD Card & Microphone (reTerminal E Series) + +:::tip Prerequisites +This page assumes you have already completed the [ESPHome display cookbook for reTerminal E Series](/reterminal_e10xx_with_esphome) and your device is online in Home Assistant. For buttons, buzzer, LED, battery monitoring, SHT4x, and deep sleep, see [ESPHome Cookbook: Buttons, Buzzer, LED, Battery & Low Power](/reterminal_e10xx_with_esphome_advanced). +::: + +

+ +This cookbook continues the reTerminal E Series ESPHome examples with three onboard hardware blocks that are not covered in the display and I/O cookbooks: + +- **PCF8563 RTC** - read hardware time from the onboard RTC and sync it from Home Assistant. +- **microSD card slot** - enable the SD power rail and report whether a card is inserted. +- **PDM microphone** - enable the onboard microphone power rail and initialize the PDM microphone through ESPHome. + +Each section below is organized as a small standalone ESPHome demo. You can copy one complete YAML example, replace the API and OTA placeholders, and upload it directly from ESPHome. + +:::note Model coverage +The ready-to-copy examples in this page are written for **reTerminal E1001** and **reTerminal E1002**, matching the tested ESPHome hardware examples. The onboard microphone examples apply to models that include the PDM microphone hardware; reTerminal E1004 does not include the microphone. +::: + +## Hardware Capabilities + +The following pins are used by the demos in this cookbook. + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionESPHome ComponentPin / Address
PCF8563 RTCtime.pcf8563I2C address 0x51, SDA GPIO19, SCL GPIO20
microSD card detectbinary_sensor.gpioGPIO15, active LOW
microSD power enableoutput.gpioGPIO16
PDM microphone power enableoutput.gpioGPIO38
PDM microphone clocki2s_audioGPIO42
PDM microphone datamicrophone.i2s_audioGPIO41
Shared SPI busspiCLK GPIO7, MOSI GPIO9, MISO GPIO8
+
+ +:::caution Keep your secrets private +The examples use placeholders such as `REPLACE_WITH_YOUR_API_KEY` and `REPLACE_WITH_YOUR_OTA_PASSWORD`. Do not publish your real API encryption key, OTA password, Wi-Fi password, or Home Assistant token. +::: + +## RTC Time Sync + +This demo reads time from the onboard **PCF8563 RTC** and displays it on the ePaper screen. When Home Assistant syncs time to the device, ESPHome writes that time back to the hardware RTC. + +The RTC uses the shared I2C bus: + +- SDA: `GPIO19` +- SCL: `GPIO20` +- RTC address: `0x51` + +You can use this example by replacing the placeholder values and uploading the complete YAML to your device. + + + + +```yaml +esphome: + name: reterminal-e1001-rtc-demo + friendly_name: reTerminal_E1001_RTC_Demo + on_boot: + priority: 600 + then: + - pcf8563.read_time: + +esp32: + board: esp32-s3-devkitc-1 + framework: + type: arduino + +logger: + hardware_uart: UART0 + +api: + encryption: + key: "REPLACE_WITH_YOUR_API_KEY" + +ota: + - platform: esphome + password: "REPLACE_WITH_YOUR_OTA_PASSWORD" + +wifi: + ssid: !secret wifi_ssid + password: !secret wifi_password + ap: + ssid: "E1001-RTC-Demo" + password: "ChangeMe123" + +captive_portal: + +i2c: + scl: GPIO20 + sda: GPIO19 + +spi: + clk_pin: GPIO7 + mosi_pin: GPIO9 + +time: + - platform: pcf8563 + id: rtc_time + address: 0x51 + update_interval: never + + - platform: homeassistant + on_time_sync: + then: + - pcf8563.write_time: + - component.update: epaper_display + +font: + - file: "gfonts://Inter@700" + id: font_title + size: 32 + - file: "gfonts://Inter@700" + id: font_body + size: 26 + +display: + - platform: waveshare_epaper + id: epaper_display + model: 7.50inv2 + cs_pin: GPIO10 + dc_pin: GPIO11 + reset_pin: + number: GPIO12 + inverted: false + busy_pin: + number: GPIO13 + inverted: true + update_interval: 300s + lambda: |- + it.printf(400, 40, id(font_title), TextAlign::TOP_CENTER, "RTC Time Sync Demo"); + auto now = id(rtc_time).now(); + if (now.is_valid()) { + it.strftime(400, 135, id(font_title), TextAlign::TOP_CENTER, "%Y-%m-%d", now); + it.strftime(400, 190, id(font_title), TextAlign::TOP_CENTER, "%H:%M:%S", now); + ESP_LOGD("rtc_demo", "RTC time is valid"); + } else { + it.printf(400, 150, id(font_body), TextAlign::TOP_CENTER, "RTC: waiting for sync"); + ESP_LOGW("rtc_demo", "RTC time is not valid yet"); + } +``` + + + + +```yaml +esphome: + name: reterminal-e1002-rtc-demo + friendly_name: reTerminal_E1002_RTC_Demo + on_boot: + priority: 600 + then: + - pcf8563.read_time: + +esp32: + board: esp32-s3-devkitc-1 + framework: + type: arduino + +logger: + hardware_uart: UART0 + +api: + encryption: + key: "REPLACE_WITH_YOUR_API_KEY" + +ota: + - platform: esphome + password: "REPLACE_WITH_YOUR_OTA_PASSWORD" + +wifi: + ssid: !secret wifi_ssid + password: !secret wifi_password + ap: + ssid: "E1002-RTC-Demo" + password: "ChangeMe123" + +captive_portal: + +i2c: + scl: GPIO20 + sda: GPIO19 + +spi: + clk_pin: GPIO7 + mosi_pin: GPIO9 + +time: + - platform: pcf8563 + id: rtc_time + address: 0x51 + update_interval: never + + - platform: homeassistant + on_time_sync: + then: + - pcf8563.write_time: + - component.update: epaper_display + +font: + - file: "gfonts://Inter@700" + id: font_title + size: 32 + - file: "gfonts://Inter@700" + id: font_body + size: 26 + +display: + - platform: epaper_spi + id: epaper_display + model: Seeed-reTerminal-E1002 + update_interval: 300s + lambda: |- + const auto BLACK = Color(0, 0, 0, 0); + const auto RED = Color(255, 0, 0, 0); + const auto BLUE = Color(0, 0, 255, 0); + + it.printf(400, 40, id(font_title), BLACK, TextAlign::TOP_CENTER, "RTC Time Sync Demo"); + auto now = id(rtc_time).now(); + if (now.is_valid()) { + it.strftime(400, 135, id(font_title), BLUE, TextAlign::TOP_CENTER, "%Y-%m-%d", now); + it.strftime(400, 190, id(font_title), BLUE, TextAlign::TOP_CENTER, "%H:%M:%S", now); + ESP_LOGD("rtc_demo", "RTC time is valid"); + } else { + it.printf(400, 150, id(font_body), RED, TextAlign::TOP_CENTER, "RTC: waiting for sync"); + ESP_LOGW("rtc_demo", "RTC time is not valid yet"); + } +``` + + + + +This configuration: + +- Reads the PCF8563 RTC once during boot. +- Uses Home Assistant time as the source of truth after the device connects. +- Writes the Home Assistant time back to the hardware RTC. +- Displays the current date and time on the ePaper screen. + +The following image shows the expected result on reTerminal E1002. The same demo works on both reTerminal E1001 and E1002. The main difference is the display output: E1001 shows a monochrome result, while E1002 can show a color result. + +
+ +:::tip +If the RTC time does not stay correct after a full power cycle, install or replace the CR1220 coin cell for the RTC backup holder. +::: + +## MicroSD Card Detection + +This demo reports whether a microSD card is inserted. It also turns on the SD card power rail through `GPIO16`. + +The card detect pin is active LOW, so the binary sensor uses `inverted: true`. + +You can use this example by replacing the placeholder values and uploading the complete YAML to your device. + + + + +```yaml +esphome: + name: reterminal-e1001-sd-demo + friendly_name: reTerminal_E1001_SD_Demo + on_boot: + priority: 600 + then: + - output.turn_on: bsp_sd_enable + - delay: 200ms + - component.update: epaper_display + +esp32: + board: esp32-s3-devkitc-1 + framework: + type: arduino + +logger: + hardware_uart: UART0 + +api: + encryption: + key: "REPLACE_WITH_YOUR_API_KEY" + +ota: + - platform: esphome + password: "REPLACE_WITH_YOUR_OTA_PASSWORD" + +wifi: + ssid: !secret wifi_ssid + password: !secret wifi_password + ap: + ssid: "E1001-SD-Demo" + password: "ChangeMe123" + +captive_portal: + +spi: + clk_pin: GPIO7 + mosi_pin: GPIO9 + miso_pin: GPIO8 + +output: + - platform: gpio + pin: GPIO16 + id: bsp_sd_enable + +binary_sensor: + - platform: gpio + pin: + number: GPIO15 + mode: INPUT_PULLUP + inverted: true + id: sd_card_detect + name: "SD Card Detected" + on_press: + then: + - logger.log: "SD card inserted" + - component.update: epaper_display + on_release: + then: + - logger.log: "SD card removed" + - component.update: epaper_display + +font: + - file: "gfonts://Inter@700" + id: font_title + size: 32 + - file: "gfonts://Inter@700" + id: font_body + size: 28 + +display: + - platform: waveshare_epaper + id: epaper_display + model: 7.50inv2 + cs_pin: GPIO10 + dc_pin: GPIO11 + reset_pin: + number: GPIO12 + inverted: false + busy_pin: + number: GPIO13 + inverted: true + update_interval: 300s + lambda: |- + it.printf(400, 40, id(font_title), TextAlign::TOP_CENTER, "microSD Card Detection"); + if (id(sd_card_detect).state) { + it.printf(400, 160, id(font_body), TextAlign::TOP_CENTER, "SD Card: inserted"); + } else { + it.printf(400, 160, id(font_body), TextAlign::TOP_CENTER, "SD Card: not detected"); + } + it.printf(400, 230, id(font_body), TextAlign::TOP_CENTER, "Detect pin: GPIO15"); +``` + + + + +```yaml +esphome: + name: reterminal-e1002-sd-demo + friendly_name: reTerminal_E1002_SD_Demo + on_boot: + priority: 600 + then: + - output.turn_on: bsp_sd_enable + - delay: 200ms + - component.update: epaper_display + +esp32: + board: esp32-s3-devkitc-1 + framework: + type: arduino + +logger: + hardware_uart: UART0 + +api: + encryption: + key: "REPLACE_WITH_YOUR_API_KEY" + +ota: + - platform: esphome + password: "REPLACE_WITH_YOUR_OTA_PASSWORD" + +wifi: + ssid: !secret wifi_ssid + password: !secret wifi_password + ap: + ssid: "E1002-SD-Demo" + password: "ChangeMe123" + +captive_portal: + +spi: + clk_pin: GPIO7 + mosi_pin: GPIO9 + miso_pin: GPIO8 + +output: + - platform: gpio + pin: GPIO16 + id: bsp_sd_enable + +binary_sensor: + - platform: gpio + pin: + number: GPIO15 + mode: INPUT_PULLUP + inverted: true + id: sd_card_detect + name: "SD Card Detected" + on_press: + then: + - logger.log: "SD card inserted" + - component.update: epaper_display + on_release: + then: + - logger.log: "SD card removed" + - component.update: epaper_display + +font: + - file: "gfonts://Inter@700" + id: font_title + size: 32 + - file: "gfonts://Inter@700" + id: font_body + size: 28 + +display: + - platform: epaper_spi + id: epaper_display + model: Seeed-reTerminal-E1002 + update_interval: 300s + lambda: |- + const auto BLACK = Color(0, 0, 0, 0); + const auto RED = Color(255, 0, 0, 0); + const auto GREEN = Color(0, 255, 0, 0); + + it.printf(400, 40, id(font_title), BLACK, TextAlign::TOP_CENTER, "microSD Card Detection"); + if (id(sd_card_detect).state) { + it.printf(400, 160, id(font_body), GREEN, TextAlign::TOP_CENTER, "SD Card: inserted"); + } else { + it.printf(400, 160, id(font_body), RED, TextAlign::TOP_CENTER, "SD Card: not detected"); + } + it.printf(400, 230, id(font_body), BLACK, TextAlign::TOP_CENTER, "Detect pin: GPIO15"); +``` + + + + +This configuration: + +- Enables SD card power through `GPIO16`. +- Reads the card-detect signal from `GPIO15`. +- Shows the card state on the ePaper screen. +- Exposes `SD Card Detected` to Home Assistant as a binary sensor. + +The following image shows the expected result on reTerminal E1002. The same demo works on both reTerminal E1001 and E1002. The main difference is the display output: E1001 shows a monochrome result, while E1002 can show a color result. + +
+ +:::note How ESPHome uses the microSD card +In this ESPHome cookbook, the microSD card is used as a device status signal. The demo checks whether a card is inserted, shows the result on the screen, and exposes the same state to Home Assistant. + +This is because ESPHome is mainly designed for sensors, switches, displays, and Home Assistant automation. It is not usually used as a local file manager on the device. Tasks such as opening files, creating folders, writing logs, or recording WAV audio directly to the SD card are better handled with Arduino, where your firmware controls the SD card filesystem directly. + +In a typical ESPHome setup, the SD card status can be used to: +- show whether storage is physically available; +- trigger Home Assistant automations when a card is inserted or removed; +- display hardware health information together with RTC, battery, and microphone status. + +If your goal is direct SD card file read/write, refer to the Arduino SD card cookbook instead. +::: + +## PDM Microphone Power Check + +This demo enables the onboard PDM microphone power rail and displays the microphone pin assignment on the ePaper screen. It keeps the YAML minimal so you can verify the display update first, then add the optional ESPHome I2S microphone configuration if you want to use the microphone with Home Assistant Voice Assistant. + +The microphone uses these pins: + +- Power enable: `GPIO38` +- PDM clock: `GPIO42` +- PDM data: `GPIO41` + +You can use this example by replacing the placeholder values and uploading the complete YAML to your device. + + + + +```yaml +esphome: + name: reterminal-e1001-mic-demo + friendly_name: reTerminal_E1001_Mic_Demo + on_boot: + priority: 600 + then: + - output.turn_on: mic_power_enable + - delay: 200ms + - logger.log: "PDM microphone power enabled" + - component.update: epaper_display + +esp32: + board: esp32-s3-devkitc-1 + framework: + type: arduino + +logger: + hardware_uart: UART0 + +api: + encryption: + key: "REPLACE_WITH_YOUR_API_KEY" + +ota: + - platform: esphome + password: "REPLACE_WITH_YOUR_OTA_PASSWORD" + +wifi: + ssid: !secret wifi_ssid + password: !secret wifi_password + ap: + ssid: "E1001-Mic-Demo" + password: "ChangeMe123" + +captive_portal: + +spi: + clk_pin: GPIO7 + mosi_pin: GPIO9 + +output: + - platform: gpio + pin: GPIO38 + id: mic_power_enable + +font: + - file: "gfonts://Inter@700" + id: font_title + size: 32 + - file: "gfonts://Inter@700" + id: font_body + size: 26 + +display: + - platform: waveshare_epaper + id: epaper_display + model: 7.50inv2 + cs_pin: GPIO10 + dc_pin: GPIO11 + reset_pin: + number: GPIO12 + inverted: false + busy_pin: + number: GPIO13 + inverted: true + update_interval: 300s + lambda: |- + it.printf(400, 40, id(font_title), TextAlign::TOP_CENTER, "PDM Microphone Power"); + it.printf(400, 135, id(font_body), TextAlign::TOP_CENTER, "Mic Power: ON"); + it.printf(400, 190, id(font_body), TextAlign::TOP_CENTER, "CLK GPIO42 / DATA GPIO41"); + it.printf(400, 245, id(font_body), TextAlign::TOP_CENTER, "I2S microphone: optional"); +``` + + + + +```yaml +esphome: + name: reterminal-e1002-mic-demo + friendly_name: reTerminal_E1002_Mic_Demo + on_boot: + priority: 600 + then: + - output.turn_on: mic_power_enable + - delay: 200ms + - logger.log: "PDM microphone power enabled" + - component.update: epaper_display + +esp32: + board: esp32-s3-devkitc-1 + framework: + type: arduino + +logger: + hardware_uart: UART0 + +api: + encryption: + key: "REPLACE_WITH_YOUR_API_KEY" + +ota: + - platform: esphome + password: "REPLACE_WITH_YOUR_OTA_PASSWORD" + +wifi: + ssid: !secret wifi_ssid + password: !secret wifi_password + ap: + ssid: "E1002-Mic-Demo" + password: "ChangeMe123" + +captive_portal: + +spi: + clk_pin: GPIO7 + mosi_pin: GPIO9 + +output: + - platform: gpio + pin: GPIO38 + id: mic_power_enable + +font: + - file: "gfonts://Inter@700" + id: font_title + size: 32 + - file: "gfonts://Inter@700" + id: font_body + size: 26 + +display: + - platform: epaper_spi + id: epaper_display + model: Seeed-reTerminal-E1002 + update_interval: 300s + lambda: |- + const auto BLACK = Color(0, 0, 0, 0); + const auto BLUE = Color(0, 0, 255, 0); + + it.printf(400, 40, id(font_title), BLACK, TextAlign::TOP_CENTER, "PDM Microphone Power"); + it.printf(400, 135, id(font_body), BLUE, TextAlign::TOP_CENTER, "Mic Power: ON"); + it.printf(400, 190, id(font_body), BLACK, TextAlign::TOP_CENTER, "CLK GPIO42 / DATA GPIO41"); + it.printf(400, 245, id(font_body), BLACK, TextAlign::TOP_CENTER, "I2S microphone: optional"); +``` + + + + +This configuration: + +- Enables microphone power through `GPIO38`. +- Shows the PDM clock pin `GPIO42` and data pin `GPIO41` on the ePaper screen. +- Keeps the main demo close to the RTC and microSD demos, so the display refresh can be verified before adding the audio component. + +If you want to expose the onboard PDM microphone to ESPHome, add the following optional block after confirming that the screen demo refreshes correctly: + +```yaml +i2s_audio: + i2s_lrclk_pin: GPIO42 + +microphone: + - platform: i2s_audio + id: onboard_mic + adc_type: external + pdm: true + i2s_din_pin: GPIO41 +``` + +The following image shows the expected result on reTerminal E1002. The same demo works on both reTerminal E1001 and E1002. The main difference is the display output: E1001 shows a monochrome result, while E1002 can show a color result. + +
+ +:::note +This demo only verifies microphone power control and the related pin assignment on the ePaper screen. A complete Home Assistant Assist voice pipeline requires the optional microphone block above and additional voice assistant configuration. Recording audio directly to the SD card is better handled by the Arduino microphone examples. +::: + +## Demo 4: Complete RTC, SD Card and Microphone Status Dashboard + +This demo combines the three features above into one hardware status page: + +1. RTC date and time from the PCF8563. +2. microSD card insertion status from `GPIO15`. +3. PDM microphone initialization status. + +For a better understanding, run the single-function demos first before trying this combined example. + +
+Click here to view the full code + + + + +```yaml +esphome: + name: reterminal-e1001-hardware-status + friendly_name: reTerminal_E1001_Hardware_Status + on_boot: + priority: 600 + then: + - output.turn_on: bsp_sd_enable + - output.turn_on: mic_power_enable + - delay: 200ms + - pcf8563.read_time: + - component.update: epaper_display + +esp32: + board: esp32-s3-devkitc-1 + framework: + type: arduino + +logger: + hardware_uart: UART0 + +api: + encryption: + key: "REPLACE_WITH_YOUR_API_KEY" + +ota: + - platform: esphome + password: "REPLACE_WITH_YOUR_OTA_PASSWORD" + +wifi: + ssid: !secret wifi_ssid + password: !secret wifi_password + ap: + ssid: "E1001-HW-Status" + password: "ChangeMe123" + +captive_portal: + +spi: + clk_pin: GPIO7 + mosi_pin: GPIO9 + miso_pin: GPIO8 + +i2c: + scl: GPIO20 + sda: GPIO19 + +i2s_audio: + i2s_lrclk_pin: GPIO42 + +output: + - platform: gpio + pin: GPIO16 + id: bsp_sd_enable + + - platform: gpio + pin: GPIO38 + id: mic_power_enable + +time: + - platform: pcf8563 + id: rtc_time + address: 0x51 + update_interval: never + + - platform: homeassistant + on_time_sync: + then: + - pcf8563.write_time: + - component.update: epaper_display + +microphone: + - platform: i2s_audio + id: onboard_mic + adc_type: external + pdm: true + i2s_din_pin: GPIO41 + +binary_sensor: + - platform: gpio + pin: + number: GPIO15 + mode: INPUT_PULLUP + inverted: true + id: sd_card_detect + name: "SD Card Detected" + on_press: + then: + - component.update: epaper_display + on_release: + then: + - component.update: epaper_display + +font: + - file: "gfonts://Inter@700" + id: font_small + size: 20 + - file: "gfonts://Inter@700" + id: font_medium + size: 32 + +display: + - platform: waveshare_epaper + id: epaper_display + model: 7.50inv2 + cs_pin: GPIO10 + dc_pin: GPIO11 + reset_pin: + number: GPIO12 + inverted: false + busy_pin: + number: GPIO13 + inverted: true + update_interval: 300s + lambda: |- + it.printf(400, 20, id(font_medium), TextAlign::TOP_CENTER, + "reTerminal E1001 Hardware Status"); + it.line(20, 60, 780, 60); + + auto now = id(rtc_time).now(); + if (now.is_valid()) { + it.strftime(30, 95, id(font_medium), "%Y-%m-%d %H:%M", now); + ESP_LOGD("status", "RTC time is valid"); + } else { + it.printf(30, 95, id(font_medium), "RTC: waiting for sync"); + ESP_LOGW("status", "RTC time is not valid yet"); + } + + if (id(sd_card_detect).state) { + it.printf(30, 155, id(font_medium), "SD Card: inserted"); + } else { + it.printf(30, 155, id(font_medium), "SD Card: not detected"); + } + + it.printf(30, 215, id(font_medium), "PDM Mic: initialized"); + it.printf(30, 265, id(font_small), "RTC: I2C address 0x51"); + it.printf(30, 295, id(font_small), "SD: DET GPIO15 / EN GPIO16"); + it.printf(30, 325, id(font_small), "Mic: CLK GPIO42 / DATA GPIO41 / EN GPIO38"); +``` + + + + +```yaml +esphome: + name: reterminal-e1002-hardware-status + friendly_name: reTerminal_E1002_Hardware_Status + on_boot: + priority: 600 + then: + - output.turn_on: bsp_sd_enable + - output.turn_on: mic_power_enable + - delay: 200ms + - pcf8563.read_time: + - component.update: epaper_display + +esp32: + board: esp32-s3-devkitc-1 + framework: + type: arduino + +logger: + hardware_uart: UART0 + +api: + encryption: + key: "REPLACE_WITH_YOUR_API_KEY" + +ota: + - platform: esphome + password: "REPLACE_WITH_YOUR_OTA_PASSWORD" + +wifi: + ssid: !secret wifi_ssid + password: !secret wifi_password + ap: + ssid: "E1002-HW-Status" + password: "ChangeMe123" + +captive_portal: + +spi: + clk_pin: GPIO7 + mosi_pin: GPIO9 + miso_pin: GPIO8 + +i2c: + scl: GPIO20 + sda: GPIO19 + +i2s_audio: + i2s_lrclk_pin: GPIO42 + +output: + - platform: gpio + pin: GPIO16 + id: bsp_sd_enable + + - platform: gpio + pin: GPIO38 + id: mic_power_enable + +time: + - platform: pcf8563 + id: rtc_time + address: 0x51 + update_interval: never + + - platform: homeassistant + on_time_sync: + then: + - pcf8563.write_time: + - component.update: epaper_display + +microphone: + - platform: i2s_audio + id: onboard_mic + adc_type: external + pdm: true + i2s_din_pin: GPIO41 + +binary_sensor: + - platform: gpio + pin: + number: GPIO15 + mode: INPUT_PULLUP + inverted: true + id: sd_card_detect + name: "SD Card Detected" + on_press: + then: + - component.update: epaper_display + on_release: + then: + - component.update: epaper_display + +font: + - file: "gfonts://Inter@700" + id: font_small + size: 20 + - file: "gfonts://Inter@700" + id: font_medium + size: 32 + +display: + - platform: epaper_spi + id: epaper_display + model: Seeed-reTerminal-E1002 + update_interval: 300s + lambda: |- + const auto BLACK = Color(0, 0, 0, 0); + const auto BLUE = Color(0, 0, 255, 0); + const auto GREEN = Color(0, 255, 0, 0); + const auto RED = Color(255, 0, 0, 0); + + it.printf(400, 20, id(font_medium), BLACK, TextAlign::TOP_CENTER, + "reTerminal E1002 Hardware Status"); + it.line(20, 60, 780, 60, BLACK); + + auto now = id(rtc_time).now(); + if (now.is_valid()) { + it.strftime(30, 95, id(font_medium), BLUE, "%Y-%m-%d %H:%M", now); + ESP_LOGD("status", "RTC time is valid"); + } else { + it.printf(30, 95, id(font_medium), RED, "RTC: waiting for sync"); + ESP_LOGW("status", "RTC time is not valid yet"); + } + + if (id(sd_card_detect).state) { + it.printf(30, 155, id(font_medium), GREEN, "SD Card: inserted"); + } else { + it.printf(30, 155, id(font_medium), RED, "SD Card: not detected"); + } + + it.printf(30, 215, id(font_medium), BLUE, "PDM Mic: initialized"); + it.printf(30, 265, id(font_small), BLACK, "RTC: I2C address 0x51"); + it.printf(30, 295, id(font_small), BLACK, "SD: DET GPIO15 / EN GPIO16"); + it.printf(30, 325, id(font_small), BLACK, "Mic: CLK GPIO42 / DATA GPIO41 / EN GPIO38"); +``` + + + + +
+ +When the firmware is running, the screen shows the RTC time, SD card state, and microphone initialization status on one page. + +The following image shows the expected result on reTerminal E1002. The same demo works on both reTerminal E1001 and E1002. The main difference is the display output: E1001 shows a monochrome result, while E1002 can show a color result. + +
+ +## FAQ + +### Q1: Why does the screen show "RTC: waiting for sync"? + +The device has not received valid time yet. Confirm that Wi-Fi is connected, the ESPHome API is connected to Home Assistant, and Home Assistant has the correct system time. After Home Assistant syncs time, ESPHome writes the time back to the PCF8563 RTC. + +### Q2: Why does the RTC time disappear after removing power? + +The PCF8563 needs a CR1220 coin cell to keep time when the main battery and USB power are removed. Install or replace the coin cell, boot the device again, and let Home Assistant sync the time once. + +### Q3: Why does Home Assistant always show the SD card as not detected? + +Check three things: + +- Confirm the card is fully inserted into the slot. +- Make sure `bsp_sd_enable` on `GPIO16` is turned on during boot. +- Keep `GPIO15` configured as `INPUT_PULLUP` with `inverted: true`, because the detect signal is active LOW. + +### Q4: Can ESPHome read and write files on the microSD card? + +This page only uses ESPHome to enable the SD power rail and read the card-detect pin. General file operations such as listing files, reading images, creating folders, or saving audio files are better handled by the Arduino SD card examples. + +### Q5: Can ESPHome record microphone audio directly to the SD card? + +Not with the simple YAML shown in this page. The microphone demo initializes the onboard PDM microphone hardware. If your goal is to record WAV files to the SD card, use the Arduino microphone and SD examples instead. + +### Q6: Why is there no serial log over USB? + +The reTerminal E Series uses a CH340K USB-to-UART bridge on UART0. Keep this logger setting in your YAML: + +```yaml +logger: + hardware_uart: UART0 +``` + +### Q3: Why does the screen not refresh in the RTC or microphone demo? + +If a microSD card is inserted, remove the card first and restart the device. Except for the microSD card detection demo, the other demos on this page do not need the card to be inserted. Keeping a card inserted may affect the shared SPI bus and prevent the ePaper screen from refreshing correctly. + +After removing the card, upload or restart the RTC or microphone demo again. The ePaper screen should refresh normally. + +## Resources + +- **[Wiki]** [ESPHome Cookbook: Display Basics](/reterminal_e10xx_with_esphome) +- **[Wiki]** [ESPHome Cookbook: Buttons, Buzzer, LED, Battery & Low Power](/reterminal_e10xx_with_esphome_advanced) +- **[Wiki]** [Work with ESPHome](/epaper_work_with_esphome) +- **[Wiki]** [Arduino Cookbook: Onboard Peripherals](/reterminal_e10xx_with_arduino_peripherals) +- **[Wiki]** [Arduino Cookbook: RTC, Low Power, Audio & Touch](/reterminal_e10xx_with_arduino_peripherals_2) +- **[Documentation]** [ESPHome Time Component](https://esphome.io/components/time/) +- **[Documentation]** [ESPHome I2S Audio Component](https://esphome.io/components/i2s_audio.html) + +## Tech Support & Product Discussion + +Thank you for choosing our products! We are here to provide you with different support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs. + +
+ + +
+ +
+ + +
diff --git a/sites/en/docs/Sensor/ePaper_Displays/reTerminal_E10xx/reterminal_e10xx_main_page.md b/sites/en/docs/Sensor/ePaper_Displays/reTerminal_E10xx/reterminal_e10xx_main_page.md index 25a698ad03422..0d7b0cb1b40db 100644 --- a/sites/en/docs/Sensor/ePaper_Displays/reTerminal_E10xx/reterminal_e10xx_main_page.md +++ b/sites/en/docs/Sensor/ePaper_Displays/reTerminal_E10xx/reterminal_e10xx_main_page.md @@ -364,21 +364,29 @@ Beyond SenseCraft HMI, the reTerminal E Series integrates with several industry- E1004 - ESPHome — Basic Usage - Plug the device into Home Assistant and draw simple graphics with YAML. + ESPHome — Display + Plug the device into Home Assistant and draw simple ePaper graphics with YAML. ✅ ✅ Planned via Home Assistant - ESPHome — Advanced Usage - Buttons, buzzer, battery monitoring, deep sleep, multi-page dashboards. + ESPHome — I/O, Battery & Power + Buttons, buzzer, onboard LED, battery monitoring, deep sleep, multi-page dashboards. ✅ ✅ Planned via Home Assistant + + ESPHome — RTC, SD & Microphone + PCF8563 RTC time sync, microSD card detect, and onboard PDM microphone setup. + ✅ + ✅ + Planned + No mic + Works with TRMNL Deploy E-Ink dashboards through the TRMNL platform.