Class for managing files stored in ESP32's PSRAM: Use the PSRAM object instead instaniating this class directly.
More...
#include <PSRAM.h>
|
| bool | begin () |
| | Initialize the PSRAM filesystem. More...
|
| |
| bool | exists (const char *filename) |
| | Check if a file exists in PSRAM. More...
|
| |
| uint64_t | freeBytes () |
| | Get free space (returns free PSRAM) More...
|
| |
| bool | mkdir (const char *dirname) |
| | Create a directory (no-op for compatibility) More...
|
| |
| FilePSRAM | open (const char *filename, uint8_t mode) |
| | Open a file in PSRAM. More...
|
| |
| bool | remove (const char *filename) |
| | Remove a file from PSRAM. More...
|
| |
| bool | rmdir (const char *dirname) |
| | Remove a directory (no-op for compatibility) More...
|
| |
| uint64_t | totalBytes () |
| | Get total space (returns available PSRAM) More...
|
| |
Class for managing files stored in ESP32's PSRAM: Use the PSRAM object instead instaniating this class directly.
This class provides an interface similar to SD.h for managing files that are stored in PSRAM memory rather than on an SD card.
◆ begin()
| bool esp32_psram::PSRAMClass::begin |
( |
| ) |
|
|
inline |
Initialize the PSRAM filesystem.
- Returns
- true if initialization was successful, false otherwise
◆ exists()
| bool esp32_psram::PSRAMClass::exists |
( |
const char * |
filename | ) |
|
|
inline |
Check if a file exists in PSRAM.
- Parameters
-
| filename | Name of the file to check |
- Returns
- true if the file exists, false otherwise
◆ freeBytes()
| uint64_t esp32_psram::PSRAMClass::freeBytes |
( |
| ) |
|
|
inline |
Get free space (returns free PSRAM)
- Returns
- Free PSRAM size in bytes
◆ mkdir()
| bool esp32_psram::PSRAMClass::mkdir |
( |
const char * |
dirname | ) |
|
|
inline |
Create a directory (no-op for compatibility)
- Parameters
-
| dirname | Name of the directory |
- Returns
- Always returns true for compatibility
◆ open()
| FilePSRAM esp32_psram::PSRAMClass::open |
( |
const char * |
filename, |
|
|
uint8_t |
mode |
|
) |
| |
|
inline |
Open a file in PSRAM.
- Parameters
-
| filename | Name of the file to open |
| mode | Mode to open the file in (FILE_READ, FILE_WRITE, etc.) |
- Returns
- A FilePSRAM object for the opened file
◆ remove()
| bool esp32_psram::PSRAMClass::remove |
( |
const char * |
filename | ) |
|
|
inline |
Remove a file from PSRAM.
- Parameters
-
| filename | Name of the file to remove |
- Returns
- true if the file was removed, false otherwise
◆ rmdir()
| bool esp32_psram::PSRAMClass::rmdir |
( |
const char * |
dirname | ) |
|
|
inline |
Remove a directory (no-op for compatibility)
- Parameters
-
| dirname | Name of the directory |
- Returns
- Always returns true for compatibility
◆ totalBytes()
| uint64_t esp32_psram::PSRAMClass::totalBytes |
( |
| ) |
|
|
inline |
Get total space (returns available PSRAM)
- Returns
- Total PSRAM size in bytes
The documentation for this class was generated from the following file:
