Skip to content

Commit 50fb1fc

Browse files
committed
Readme improvements
1 parent 08910eb commit 50fb1fc

File tree

1 file changed

+8
-20
lines changed

1 file changed

+8
-20
lines changed

README.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
1-
2-
# 💾 Unified Storage Library
3-
4-
1+
# 💾 Unified Storage Library
52

63
[![Check Arduino](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/check-arduino.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/check-arduino.yml) [![Compile Examples](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/compile-examples.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/compile-examples.yml) [![Spell Check](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/spell-check.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/spell-check.yml) [![Sync Labels](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/sync-labels.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_UnifiedStorage/actions/workflows/sync-labels.yml)
74

8-
9-
105
The Arduino_UnifiedStorage library provides a unified interface to access different types of storage, including internal storage, SD cards, and USB mass storage devices. It simplifies the handling of files and directories across multiple storage mediums on Portenta, Opta, and some Nicla boards.
116

12-
13-
147
## Examples
158

169
* [**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
@@ -21,7 +14,7 @@ The Arduino_UnifiedStorage library provides a unified interface to access differ
2114

2215
* [**examples/Logger**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/Logger/Logger.ino) - This example demonstrates how you can log sensor data into its internal storage and detect the insertion of a USB drive. When a USB drive is connected, it selectively transfers only the new data to the USB mass storage device. Even if you remove the USB drive, the device continues to log data in its internal storage. This capability is particularly valuable for accumulating training data required for embedded machine learning applications.
2316

24-
* [**examples/InternalStoragePartitioning**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/InternalStoragePartitioning/InternalStoragePartitioning.ino) - Demonstrates how you can use the Arduino_UnifiedStorage library to create and read partitions on the Internal QSPI Storage.
17+
* [**examples/InternalStoragePartitioning**](https://github.com/arduino-libraries/Arduino_UnifiedStorage/blob/main/examples/InternalStoragePartitioning/InternalStoragePartitioning.ino) - Demonstrates how you can use the Arduino_UnifiedStorage library to create and read partitions on the Internal QSPI Storage.
2518

2619
## 👀 Instructions
2720

@@ -42,35 +35,30 @@ The Arduino_UnifiedStorage library provides a unified interface to access differ
4235
* Register callbacks whenever a USB Mass Storage device has been inserted or removed
4336
* Get verbose output of every action the library performs for seamless debugging
4437

45-
46-
4738
## Compatibility
4839

4940
This library has been tested with the following STM32 and Renesas based Arduino boards. The availability of storage mediums depends on the hardware interfaces:
5041

5142
* **Portenta Machine Control**: USB and Internal QSPI Flash
52-
* **Portenta H7 + Portenta Breakout**: USB, &sd, and QSPI
43+
* **Portenta H7 + Portenta Breakout**: USB, SD, and QSPI
5344
* **Portenta H7 + Vision Shield**: SD and QSPI
54-
* **Portenta C33 + Portenta Breakout**: USB, &sd, and QSPI
45+
* **Portenta C33 + Portenta Breakout**: USB, SD, and QSPI
5546
* **Portenta C33 + Vision Shield**: SD and QSPI
5647
* **Opta**: Internal QSPI Flash and USB
5748

58-
5949

6050
The library allows you to connect a USB drives in a couple of different ways:
6151

62-
* **Use the USB-C port on the board**: however you have to make sure you are not using the Serial functionality on the same port to avoid conflicts
63-
* **Connect to the USB-A port** on the breakout board
64-
* **Use a USB Hub**, however, we cannot guarantee compatibility with every USB Hub on the market especially the USB-C hubs with advanced features like Ethernet or HDMI.
52+
* **Use the USB-C port on the board**: Ensure Serial functionality is not in use on the same port to prevent conflicts.
53+
* **Connect to the USB-A port**: Located on the Portenta Breakout
54+
* **Use a USB Hub**: Note that while our some USB Hubs are supported, we cannot ensure compatibility with all USB Hubs. Especially for when used together with advanced features like Ethernet or HDMI, such as certain USB-C hubs.
6555

66-
Due to the extremely large selection of USB Mass Storage devices on the market, we cannot guarantee compatibility with your USB thumb drive. However, we had great results with drives from reputable brands such as Kingston, SanDisk, Samsung, etc.
56+
**Note:** Due to the extremely large selection of USB Mass Storage devices on the market, we cannot guarantee compatibility with your USB thumb drive. However, we had great results with drives from reputable brands such as Kingston, SanDisk, Samsung, etc.
6757

6858
**Note:** Due to an unforeseen compatibility issue on the Portenta Breakout Board, inserting a USB drive on the USB-A port of the breakout board may occasionally cause a reboot on Portenta C33 boards. You can work around this issue by connecting your USB Mass Storage device through a USB hub. Please note that the USB Callback functionality on the Portenta C33 boards might also be affected by this issue.
6959

7060
This limitation only affects Portenta C33 boards.
7161

7262
## 📖 Documentation
7363

74-
75-
7664
For more information about this library please read the documentation [here](./docs).

0 commit comments

Comments
 (0)