Skip to content

Commit

Permalink
New version for library manager
Browse files Browse the repository at this point in the history
  • Loading branch information
greiman committed Apr 26, 2017
1 parent dc08d34 commit 6bb055d
Show file tree
Hide file tree
Showing 823 changed files with 20,058 additions and 10,403 deletions.
61 changes: 40 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,37 +3,56 @@ file systems on SD/SDHC flash cards.

SdFat requires Arduino 1.6x or greater.

To use SdFat, clone the repository or unzip the ZIP file and place the SdFat
folder into the libraries sub-folder in your main sketch folder.
Key changes:

For more information see the Manual installation section of this guide:
The SPI divisor has been replaced by SPISettings in the begin() call.

http://arduino.cc/en/Guide/Libraries

A number of configuration options can be set by editing SdFatConfig.h
\#define macros. See the html documentation for details
```
bool begin(uint8_t csPin = SS, SPISettings spiSettings = SPI_FULL_SPEED);
```

Read changes.txt if you have used previous releases of this library.

Please read the html documentation for this library. Start with
html/index.html and read the Main Page. Next go to the Classes tab and
read the documentation for the classes SdFat, SdBaseFile, SdFile, File,
StdioStream, ifstream, ofstream, and others.

A new class, "File", has been added to provide compatibility with the Arduino
SD.h library. To use SdFat with programs written for SD.h replace
Several macros have been defined for backward compatibility.

```
#include <SD.h>
#define SD_SCK_MHZ(maxMhz) SPISettings(1000000UL*maxMhz, MSBFIRST, SPI_MODE0)
// SPI divisor constants
/** Set SCK to max possible rate. */
#define SPI_FULL_SPEED SD_SCK_MHZ(50)
/** Set SCK rate to F_CPU/3 for Due */
#define SPI_DIV3_SPEED SD_SCK_HZ(F_CPU/3)
/** Set SCK rate to F_CPU/4. */
#define SPI_HALF_SPEED SD_SCK_HZ(F_CPU/4)
// ...
```

with these two lines:
There are two new classes, SdFatEX and SdFatSoftSpiEX.

Teensy 3.5/3.6 SDIO support has been added. Try the TeensySdioDemo example.
Many other example will work with Teensy SDIO if you use the SdFatSdio classes
and call begin with no parameters.

```
#include "SdFat.h"
SdFat SD;
SdFatSdio sd;
....
if (!sd.begin()) {
// Handle failure.
}
```
Please read changes.txt and the html documentation in the extras folder for more information.

Please report problems as issues.

A number of configuration options can be set by editing SdFatConfig.h
define macros. See the html documentation for details

Please read the html documentation for this library. Start with
html/index.html and read the Main Page. Next go to the Classes tab and
read the documentation for the classes SdFat, SdFatEX, SdBaseFile,
SdFile, File, StdioStream, ifstream, ofstream, and others.

Please continue by reading the html documentation.

Updated 19 Jul 2016
Updated 26 Apr 2017
8 changes: 0 additions & 8 deletions SdFat/examples/LowLatencyLogger/UserDataType.h

This file was deleted.

77 changes: 0 additions & 77 deletions SdFat/examples/ReadWriteSdFat/ReadWriteSdFat.ino

This file was deleted.

231 changes: 0 additions & 231 deletions SdFat/examples/ThreeCards/ThreeCards.ino

This file was deleted.

Loading

0 comments on commit 6bb055d

Please sign in to comment.