Skip to content

Commit 2d922fa

Browse files
author
Alrik Vidstrom
committed
Updated library name in some places
1 parent 672af73 commit 2d922fa

File tree

9 files changed

+20
-20
lines changed

9 files changed

+20
-20
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Arduino POSIXStorage Library
1+
# Arduino_POSIXStorage Library
22

3-
The Arduino POSIXStorage Library complements the POSIX storage functions already included in the Renesas core and the Arduino_USBHostMbed5 library, and makes them available to sketches.
3+
The Arduino_POSIXStorage Library complements the POSIX storage functions already included in the Renesas core and the Arduino_USBHostMbed5 library, and makes them available to sketches.
44

55
For more information about this library please read the documentation [here](./docs/).

docs/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Arduino POSIXStorage Library
1+
# Arduino_POSIXStorage Library
22

3-
The Arduino POSIXStorage Library complements the POSIX storage functions already included in the Renesas core and the Arduino_USBHostMbed5 library. It also makes them available to use in sketches.
3+
The Arduino_POSIXStorage Library complements the POSIX storage functions already included in the Renesas core and the Arduino_USBHostMbed5 library. It also makes them available to use in sketches.
44

55
The library supports and is tested on:
66
- Portenta C33 with Portenta Breakout Board (SD Card and USB Thumb Drive)
@@ -15,7 +15,7 @@ The library supports and is tested on:
1515
For detailed information on usage, see the API and Examples sections below. This is a very basic example of how to include and use the library:
1616

1717
```cpp
18-
#include "POSIXStorage.h"
18+
#include "Arduino_POSIXStorage.h"
1919

2020
void setup() {
2121
mount(DEV_SDCARD, FS_FAT, MNT_DEFAULT);
@@ -29,9 +29,9 @@ void loop() {
2929
}
3030
```
3131

32-
It is necessary to install the Arduino_USBHostMbed5 library to use POSIXStorage on Portenta H7 and Portenta Machine Control. No additional library is needed on Portenta C33.
32+
It is necessary to install the Arduino_USBHostMbed5 library to use Arduino_POSIXStorage on Portenta H7 and Portenta Machine Control. No additional library is needed on the Portenta C33.
3333

34-
The library automatically detects different types of Portenta H7 / Portenta Machine Control boards. This detection should work in the absolute majority of cases, but if you have trouble with USB on the Portenta Machine control you can try to add #define AUTOMATIC_OVERRIDE_PORTENTA_MACHINE_CONTROL just before #include "POSIXStorage.h". The automatic detection should work even with custom boards, but if you have trouble with USB on a custom board, try to add #define AUTOMATIC_OVERRIDE_PORTENTA_H7 in a similar manner.
34+
The library automatically detects different types of Portenta H7 / Portenta Machine Control boards. This detection should work in the absolute majority of cases, but if you have trouble with USB on the Portenta Machine control you can try to add #define AUTOMATIC_OVERRIDE_PORTENTA_MACHINE_CONTROL just before #include "Arduino_POSIXStorage.h". The automatic detection should work even with custom boards, but if you have trouble with USB on a custom board, try adding #define AUTOMATIC_OVERRIDE_PORTENTA_H7 in a similar manner.
3535

3636
## API
3737

examples/SD_Card_Example/SD_Card_Example.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
/*
2-
* This example shows how to mount an SD Card and write to and read from a file
2+
* This example shows how to mount an SD Card and write to and read from a file.
33
*
44
* Original author: A. Vidstrom
55
*/
66

7-
#include "POSIXStorage.h"
7+
#include "Arduino_POSIXStorage.h"
88

99
void setup() {
1010
Serial.begin(9600);

examples/USB_Hotplug_Example/USB_Hotplug_Example.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
/*
2-
* This example shows how to mount a USB thumb drive, with hotplug registration, and write to and read from a file
2+
* This example shows how to mount a USB thumb drive, with hotplug registration, and write to and read from a file.
33
*
44
* Original author: A. Vidstrom
55
*/
66

7-
#include "POSIXStorage.h"
7+
#include "Arduino_POSIXStorage.h"
88

99
volatile bool usbAttached = false;
1010

examples/USB_No_Hotplug_Example/USB_No_Hotplug_Example.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
/*
2-
* This example shows how to mount a USB thumb drive, without hotplug registration, and write to and read from a file
2+
* This example shows how to mount a USB thumb drive, without hotplug registration, and write to and read from a file.
33
*
44
* Original author: A. Vidstrom
55
*/
66

7-
#include "POSIXStorage.h"
7+
#include "Arduino_POSIXStorage.h"
88

99
void setup() {
1010
Serial.begin(9600);

library.properties

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
name=POSIXStorage
1+
name=Arduino_POSIXStorage
22
version=1.0.0
33
author=Arduino
44
maintainer=Arduino <[email protected]>
55
sentence=POSIX Storage Library for the Portenta C33, Portenta H7, and Portenta Machine Control
66
paragraph=Adds necessary functionality to use POSIX storage functions
77
category=Storage
88
url=https://arduino.cc
9-
architectures=renesas,mbed_portenta
10-
includes=POSIXStorage.h
9+
architectures=renesas_portenta,mbed_portenta
10+
includes=Arduino_POSIXStorage.h

src/POSIXStorage.cpp renamed to src/Arduino_POSIXStorage.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
*********************************************************************************************************
3-
* POSIXStorage Library
3+
* Arduino_POSIXStorage Library
44
*
55
* Copyright 2023 Arduino SA. http://arduino.cc
66
*
@@ -52,7 +52,7 @@
5252
*********************************************************************************************************
5353
*/
5454

55-
#include "POSIXStorage.h"
55+
#include "Arduino_POSIXStorage.h"
5656

5757
#include <Arduino.h>
5858

src/POSIXStorage.h renamed to src/Arduino_POSIXStorage.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
*********************************************************************************************************
3-
* POSIXStorage Library
3+
* Arduino_POSIXStorage Library
44
*
55
* Copyright 2023 Arduino SA. http://arduino.cc
66
*

tests/POSIXStorage_Test/POSIXStorage_Test.ino renamed to tests/Arduino_POSIXStorage_Test/Arduino_POSIXStorage_Test.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
*
99
*/
1010

11-
#include "POSIXStorage.h"
11+
#include "Arduino_POSIXStorage.h"
1212

1313
enum TestTypes : uint8_t
1414
{

0 commit comments

Comments
 (0)