Skip to content

Commit aa22f38

Browse files
Update README.md
1 parent 90b47c6 commit aa22f38

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

README.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,42 @@ The Arduino_UnifiedStorage library provides a unified interface to access differ
44

55

66
## Examples
7-
* **examples/basic** - this example is concerned with reading/writing and seeking
8-
* **examples/advanced** - this example is concerned with more advanced features like creating folders, traversing folder sturctures and moving/copying from one storage medium to another
9-
* **examples/opta_logger** - this is more of a real life usecase, where this library is used on an Arduino Opta to log sensor data to a file on the internal storage and check if a USB Mass Storage deviece is inserted. If it is detected it will backup the information on the internal storage, only copying the bytes that are new since the last update.
10-
7+
* **examples/SimpleStorageWriteRead** - this example is concerned with reading/writing and seeking
8+
* **examples/AdvancedUSBInternalOperations** - this example is concerned with more advanced features like creating folders, traversing folder sturctures and moving/copying from one storage medium to another
9+
* **examples/PortentaH7Logger** - this is more of a real life usecase, where this library is used to log sensor data to a file on the internal storage and check if a USB Mass Storage deviece is inserted. If it is detected it will backup the information on the internal storage, only copying the bytes that are new since the last update.
10+
* **examples/BackupInternalPartitions** - Another real life usecase, where this library is used to back-up all partitions on the internal storage to a USB Mass Storage device.
11+
*
1112
## Instructions
1213
1. Download and install this library
1314
2. Check compatibility with your platform
14-
3. Make sure your drives are FAT32 formatted (for now, LittleFS support will be added later)
15-
4. To use internal storage, you need to make sure it is partitioned and formatted correctly
16-
* You can do that by flashing the `QSPIFormat` example that can be found in the `STM32H747_System` folder (For Portenta H7/Opta/Giga) or in the `Storage` folder for Portenta C33
17-
* Open the serial monitor and select answer with "Y" when this appears "Do you want to use partition scheme 1? Y/[n]"
18-
* Reboot the board
19-
15+
3. To use internal storage, you need to make sure it is partitioned and formatted correctly:
16+
17+
### Formatting the Portenta H7 Internal Storage
18+
* Flash the `QSPIFormat` example that can be found in the `STM32H747_System` folder (For Portenta H7/Opta/Giga)
19+
* Open the serial monitor and select answer with "n" when this appears "Do you want to use partition scheme 1? Y/[n]"
20+
* The sketch will warn you that the content of the QSPI flash will be erased. Answer with "Y".
21+
* When asked if you'd like to use LittleFS on the data parition, select "n". Most of the examples assume that the drive is formatted as FAT. You can use the library to format to LittleFS later.
22+
* Reboot the board
23+
24+
### Formatting the Portenta C33 Internal Storage
25+
* Flash the `QSPIFormat` example that can be found in the `Storage` folder for Portenta C33.
26+
* Open the Serial Monitor. The sketch will warn you that the content of the QSPI flash will be erased. Answer with "Y".
27+
* When asked if you'd like to use LittleFS on the data parition, select "n". Most of the examples assume that the drive is formatted as FAT. You can use the library to format to LittleFS later.
28+
* Reboot the board
2029

2130
## Features
2231
* Access files and directories on internal storage, SD cards, and USB mass storage devices.
2332
* Read and write data to files.
2433
* Create, remove, and rename files and directories.
2534
* Copy and move files and directories.
2635
* List files and subfolders in a directory.
27-
* Manipulate folders from one storage medium to another.
36+
* Manipulate files and folders from one storage medium to another
37+
* Format partitions and drives (FAT and LittleFS)
2838

2939
## Compatibility
30-
31-
This library is compatible with STM32 and Renesas based Arduino boards. The availability of storage mediums depends on the hardware interfaces.
32-
40+
This library is compatible with STM32 and Renesas based Arduino boards. The availability of storage mediums depends on the hardware interfaces:
3341
* Portenta Machine Control: USB and Internal QSPI Flash
3442
* Portenta H7 + Portenta Breakout: USB, SD, and QSPI
3543
* Portenta H7 + Vision Shield: SD and QSPI
36-
* Arduino Giga R1: USB and QSPI
37-
* Arduino Opta: USB and QSPI
3844
* Portenta C33 + Portenta Breakout: USB, SD, and QSPI
3945
* Portenta C33 + Vision Shield: SD and QSPI

0 commit comments

Comments
 (0)