Update README.md to document the internal flash memory storage migration

This commit is contained in:
drjones
2026-07-06 18:57:54 -07:00
parent 7a97820ce0
commit 0325008dff

View File

@@ -2,13 +2,13 @@
This repository contains a responsive, dual-core firmware application developed for the **Waveshare ESP32-S3-LCD-1.47** development board. This repository contains a responsive, dual-core firmware application developed for the **Waveshare ESP32-S3-LCD-1.47** development board.
The application reads PNG images and compressed MP3 / uncompressed WAV audio files from a microSD card, renders the images on the onboard ST7789 LCD display, and plays matching soundbites over an external I2S audio DAC. The application reads PNG images and compressed MP3 / uncompressed WAV audio files from the internal on-board flash storage, renders the images on the onboard ST7789 LCD display, and plays matching soundbites over an external I2S audio DAC.
--- ---
## 🚀 Key Features ## 🚀 Key Features
* **WiFi Web Upload Interface:** Hosts a local WiFi network and web server so you can upload pictures and audio files directly to the microSD card from your phone or computer. * **WiFi Web Upload Interface:** Hosts a local WiFi network and web server so you can upload pictures and audio files directly to the device's internal flash storage from your phone or computer.
* **Alpha-Numeric Media Pairing:** Scans the root of the microSD card for PNG images and audio files (`.wav` or `.mp3`), sorting and matching them alphabetically (e.g., `01_image.png` pairs with `01_sound.mp3`). * **Alpha-Numeric Media Pairing:** Scans the root of the microSD card for PNG images and audio files (`.wav` or `.mp3`), sorting and matching them alphabetically (e.g., `01_image.png` pairs with `01_sound.mp3`).
* **Dual-Core Software Decoding:** Spawns a background task pinned to **Core 0** running the `ESP32-audioI2S` decoding loop. This prevents audio dropouts or stutters during heavy display updates on **Core 1**. * **Dual-Core Software Decoding:** Spawns a background task pinned to **Core 0** running the `ESP32-audioI2S` decoding loop. This prevents audio dropouts or stutters during heavy display updates on **Core 1**.
* **Interactive Multi-Click Gestures:** You can control slide progression, audio status, and volume from the board's single physical button: * **Interactive Multi-Click Gestures:** You can control slide progression, audio status, and volume from the board's single physical button:
@@ -29,7 +29,7 @@ To upload new files to your photo frame over WiFi:
* **Password:** `love1234` * **Password:** `love1234`
2. Open your browser and navigate to: **`http://192.168.4.1`** 2. Open your browser and navigate to: **`http://192.168.4.1`**
3. Choose a file (`.png`, `.mp3`, or `.wav`) and click **Upload to Frame**. 3. Choose a file (`.png`, `.mp3`, or `.wav`) and click **Upload to Frame**.
4. The file will be saved directly to the microSD card. The board will automatically re-scan the card, and the new files will be indexed and ready to play! 4. The file will be saved directly to the internal flash storage. The board will automatically re-scan, and the new files will be indexed and ready to play!
--- ---
@@ -67,18 +67,13 @@ Configure the pin connections as follows:
--- ---
## 💾 microSD Card Setup ## 💾 Internal Flash Storage Setup
1. Format a microSD card to **FAT32**. The keepsake frame uses the board's on-board flash storage to save files.
2. Place your images in the root directory: 1. The partition scheme allocates 9MB for the file system.
* **Extension:** `.png` 2. There is no need for a physical microSD card!
* **Resolution:** Sized to **172 x 320** pixels. 3. Simply connect to the board's WiFi network (`love` / `love1234`) and upload your photos and audio files directly from your web browser.
3. Place your sound files in the root directory: 4. Images are automatically cropped and converted to the correct `172 x 320` pixel resolution on your device before upload, making sure they fit perfectly inside the internal storage.
* **Extension:** `.mp3` or `.wav`
* **Format:** Compressed MP3 or uncompressed PCM WAV.
4. Ensure file names map alphabetically:
* `photo1.png` <--> `sound1.mp3`
* `photo2.png` <--> `sound2.wav`
--- ---