Skip to content

Commit 8ff32cd

Browse files
Revise README.md and API.md for M5Stack Core S3 to reflect the latest updates
and improvements in the API and documentation. Ensure that all new features and changes Revise Version reflecting SD and LCD support.
1 parent 224c124 commit 8ff32cd

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

bsp/m5stack_core_s3/API.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -243,13 +243,17 @@ bsp_spiffs_unmount();
243243

244244
### SD Card Initialization / Deinitialization
245245

246-
The BSP offers a flexible API for working with SD cards. In addition to the default mount and unmount functions, you can also use a configuration structure or access preconfigured `host` and `slot` structures.
246+
The SD Card and LCD share an SPI bus.
247+
https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/sdspi_share.html
248+
The SD Card is mounted during the bsp_display_start() process and occurs during the bsp_display_mount() function if the SDCARD capability is set using BSP_CAPS_SDCARD macro. Do not use the the default mount API "bsp_sdcard_mount()"
249+
The BSP offers a flexible API for working with SD cards. File operations and unmount functions remain unchanged.
250+
You can also use a configuration structure or access preconfigured `host` and `slot` structures.
247251

248252
Mount with Default Configuration
249253

250254
```
251255
/* Mount microSD card to the virtual file system */
252-
bsp_sdcard_mount();
256+
** Mounting occurs automatically during bsp_display_start() process **
253257
254258
/* ... perform file operations ... */
255259

bsp/m5stack_core_s3/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
| --- | --- | --- | --- | -- |
55
> [!WARNING]
66
> The SD card is not working simultaneously with the LCD screen. We are working on a fix.
7+
> **** SD Card IS working in this fork ***
78
89
## Overview
910

bsp/m5stack_core_s3/idf_component.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
version: "3.0.2"
1+
version: "3.1.0"
22
description: Board Support Package (BSP) for M5Stack CoreS3
33
url: https://github.com/espressif/esp-bsp/tree/master/bsp/m5stack_core_s3
44

0 commit comments

Comments
 (0)