Skip to content

Commit bfcb677

Browse files
authored
Merge pull request #18 from arduino-libraries/aliphys/compatibilityRevise
[AE-158] Make readme more user-friendly
2 parents 648c8d1 + 04d4dbb commit bfcb677

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ The Arduino_UnifiedStorage library provides a unified interface to access differ
66

77

88
## Examples
9-
* [**examples/SimpleStorageWriteRead**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/SimpleStorageWriteRead/SimpleStorageWriteRead.ino) - this example is concerned with reading/writing and seeking
10-
* [**examples/AdvancedUSBInternalOperations**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/AdvancedUSBInternalOperations/AdvancedUSBInternalOperations.ino) - this example is concerned with more advanced features like creating folders, traversing folder structures and moving/copying from one storage medium to another
11-
* [**examples/PortentaH7Logger**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/PortentaH7Logger/PortentaH7Logger.ino) - 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 device 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.
12-
* [**examples/BackupInternalPartitions**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/BackupInternalPartitions/BackupInternalPartitions.ino) - Another real life usecase, where this library is used to back-up all partitions on the internal storage to a USB Mass Storage device.
9+
* [**examples/SimpleStorageWriteRead**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/SimpleStorageWriteRead/SimpleStorageWriteRead.ino) - Write/read simple data from SD, USB and internal storage
10+
* [**examples/AdvancedUSBInternalOperations**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/AdvancedUSBInternalOperations/AdvancedUSBInternalOperations.ino) - Navigate file structure and demonstrate file operations between USB and internal storage
11+
* [**examples/PortentaH7Logger**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/PortentaH7Logger/PortentaH7Logger.ino) - Log analog input to the Portenta H7 with timestamp, then save to internal storage and backup to USB (if detected)
12+
* [**examples/BackupInternalPartitions**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/BackupInternalPartitions/BackupInternalPartitions.ino) - Back up all partitions on the internal storage to a USB Mass Storage device.
1313

1414
## Instructions
1515
1. Download and install this library
1616
2. Check compatibility with your platform
1717
3. To use internal storage, you need to make sure it is partitioned and formatted correctly:
1818

19-
### Formatting the Portenta H7 Internal Storage
20-
* Flash the `QSPIFormat` example that can be found in the `STM32H747_System` folder (For Portenta H7/Opta/Giga)
19+
### Formatting the Portenta H7 / Portenta Machine Control / Opta Internal Storage
20+
* Flash the `QSPIFormat` example that can be found in the `STM32H747_System` folder
2121
* Open the serial monitor and select answer with "n" when this appears "Do you want to use partition scheme 1? Y/[n]"
2222
* The sketch will warn you that the content of the QSPI flash will be erased. Answer with "Y".
2323
* When asked if you'd like to use LittleFS on the data partition, select "n". Most of the examples assume that the drive is formatted as FAT. You can use the library to format to LittleFS later.
@@ -39,9 +39,11 @@ The Arduino_UnifiedStorage library provides a unified interface to access differ
3939
* Format partitions and drives (FAT and LittleFS)
4040

4141
## Compatibility
42-
This library is compatible with STM32 and Renesas based Arduino boards. The availability of storage mediums depends on the hardware interfaces:
42+
This library has been tested with the following STM32 and Renesas based Arduino boards. The availability of storage mediums depends on the hardware interfaces:
4343
* Portenta Machine Control: USB and Internal QSPI Flash
4444
* Portenta H7 + Portenta Breakout: USB, SD, and QSPI
4545
* Portenta H7 + Vision Shield: SD and QSPI
4646
* Portenta C33 + Portenta Breakout: USB, SD, and QSPI
4747
* Portenta C33 + Vision Shield: SD and QSPI
48+
* Opta: Internal QSPI Flash and USB
49+

0 commit comments

Comments
 (0)