diff --git a/SPI_Transactions.txt b/SPI_Transactions.txt new file mode 100644 index 00000000..f9bef025 --- /dev/null +++ b/SPI_Transactions.txt @@ -0,0 +1,23 @@ +To enable support for SPI transactions, edit SfFatCinfig.h and modify these +defines. + +//------------------------------------------------------------------------------ +/** + * Set ENABLE_SPI_TRANSACTION nonzero to enable the SPI transaction feature + * of the standard Arduino SPI library. You must include SPI.h in your + * sketches when ENABLE_SPI_TRANSACTION is nonzero. + */ +#define ENABLE_SPI_TRANSACTION 0 +//------------------------------------------------------------------------------ +/** + * Set ENABLE_SPI_YIELD nonzero to enable release of the SPI bus during + * SD card busy waits. + * + * This will allow interrupt routines to access the SPI bus if + * ENABLE_SPI_TRANSACTION is nonzero. + * + * Setting ENABLE_SPI_YIELD will introduce some extra overhead and will + * slightly slow transfer rates. A few older SD cards may fail when + * ENABLE_SPI_YIELD is nonzero. + */ +#define ENABLE_SPI_YIELD 0 \ No newline at end of file diff --git a/SdFat/Sd2Card.cpp b/SdFat/Sd2Card.cpp index c49dbe4a..0768d45c 100644 --- a/SdFat/Sd2Card.cpp +++ b/SdFat/Sd2Card.cpp @@ -19,6 +19,9 @@ */ #include #include +#if !USE_SOFTWARE_SPI && ENABLE_SPI_TRANSACTION +#include +#endif // !USE_SOFTWARE_SPI && defined(SPI_HAS_TRANSACTION) // debug trace macro #define SD_TRACE(m, b) // #define SD_TRACE(m, b) Serial.print(m);Serial.println(b); @@ -264,13 +267,26 @@ uint32_t Sd2Card::cardSize() { } } //------------------------------------------------------------------------------ +void Sd2Card::spiYield() { +#if ENABLE_SPI_YIELD && !USE_SOFTWARE_SPI && defined(SPI_HAS_TRANSACTION) + chipSelectHigh(); + chipSelectLow(); +#endif // ENABLE_SPI_YIELD && !USE_SOFTWARE_SPI && defined(SPI_HAS_TRANSACTION) +} +//------------------------------------------------------------------------------ void Sd2Card::chipSelectHigh() { digitalWrite(m_chipSelectPin, HIGH); // insure MISO goes high impedance m_spi.send(0XFF); +#if !USE_SOFTWARE_SPI && defined(SPI_HAS_TRANSACTION) + SPI.endTransaction(); +#endif // !USE_SOFTWARE_SPI && defined(SPI_HAS_TRANSACTION) } //------------------------------------------------------------------------------ void Sd2Card::chipSelectLow() { +#if !USE_SOFTWARE_SPI && defined(SPI_HAS_TRANSACTION) + SPI.beginTransaction(SPISettings()); +#endif // !USE_SOFTWARE_SPI && defined(SPI_HAS_TRANSACTION) m_spi.init(m_sckDivisor); digitalWrite(m_chipSelectPin, LOW); } @@ -396,6 +412,7 @@ bool Sd2Card::readData(uint8_t* dst, size_t count) { error(SD_CARD_ERROR_READ_TIMEOUT); goto fail; } + spiYield(); } if (m_status != DATA_START_BLOCK) { error(SD_CARD_ERROR_READ); @@ -419,6 +436,26 @@ bool Sd2Card::readData(uint8_t* dst, size_t count) { m_spi.receive(); m_spi.receive(); #endif // USE_SD_CRC + chipSelectHigh(); + return true; + + fail: + chipSelectHigh(); + return false; +} +//------------------------------------------------------------------------------ +/** Read OCR register. + * + * \param[out] ocr Value of OCR register. + * \return true for success else false. + */ +bool Sd2Card::readOCR(uint32_t* ocr) { + uint8_t *p = reinterpret_cast(ocr); + if (cardCommand(CMD58, 0)) { + error(SD_CARD_ERROR_CMD58); + goto fail; + } + for (uint8_t i = 0; i < 4; i++) p[3-i] = m_spi.receive(); chipSelectHigh(); return true; @@ -490,6 +527,7 @@ bool Sd2Card::waitNotBusy(uint16_t timeoutMillis) { uint16_t t0 = millis(); while (m_spi.receive() != 0XFF) { if (((uint16_t)millis() - t0) >= timeoutMillis) goto fail; + spiYield(); } return true; @@ -563,7 +601,6 @@ bool Sd2Card::writeData(uint8_t token, const uint8_t* src) { #else // USE_SD_CRC uint16_t crc = 0XFFFF; #endif // USE_SD_CRC - m_spi.send(token); m_spi.send(src, 512); m_spi.send(crc >> 8); diff --git a/SdFat/Sd2Card.h b/SdFat/Sd2Card.h index d6a5adde..7cf74b9d 100644 --- a/SdFat/Sd2Card.h +++ b/SdFat/Sd2Card.h @@ -158,6 +158,7 @@ class Sd2Card { return readRegister(CMD9, csd); } bool readData(uint8_t *dst); + bool readOCR(uint32_t* ocr); bool readStart(uint32_t blockNumber); bool readStop(); /** Return SCK divisor. @@ -186,6 +187,7 @@ class Sd2Card { bool readRegister(uint8_t cmd, void* buf); void chipSelectHigh(); void chipSelectLow(); + void spiYield(); void type(uint8_t value) {m_type = value;} bool waitNotBusy(uint16_t timeoutMillis); bool writeData(uint8_t token, const uint8_t* src); diff --git a/SdFat/SdBaseFile.cpp b/SdFat/SdBaseFile.cpp index 232d3b6b..714630d0 100644 --- a/SdFat/SdBaseFile.cpp +++ b/SdFat/SdBaseFile.cpp @@ -566,7 +566,7 @@ bool SdBaseFile::mkdir(SdBaseFile* parent, const uint8_t dname[11]) { * successfully opened and is not read only, its length shall be truncated to 0. * * WARNING: A given file must not be opened by more than one SdBaseFile object - * of file corruption may occur. + * or file corruption may occur. * * \note Directory files must be opened read only. Write and truncation is * not allowed for directory files. diff --git a/SdFat/SdBaseFile.h b/SdFat/SdBaseFile.h index da2b9d5e..74bcaec4 100644 --- a/SdFat/SdBaseFile.h +++ b/SdFat/SdBaseFile.h @@ -197,6 +197,7 @@ class SdBaseFile { static void printFatDate(Print* pr, uint16_t fatDate); static void printFatTime(uint16_t fatTime); static void printFatTime(Print* pr, uint16_t fatTime); + int printField(float value, char term, uint8_t prec = 2); int printField(int16_t value, char term); int printField(uint16_t value, char term); int printField(int32_t value, char term); diff --git a/SdFat/SdBaseFilePrint.cpp b/SdFat/SdBaseFilePrint.cpp index e48b3eb9..fbf5f5fe 100644 --- a/SdFat/SdBaseFilePrint.cpp +++ b/SdFat/SdBaseFilePrint.cpp @@ -49,7 +49,6 @@ void SdBaseFile::ls(uint8_t flags) { * \param[in] indent Amount of space before file name. Used for recursive * list to indicate subdirectory level. */ -//------------------------------------------------------------------------------ void SdBaseFile::ls(Print* pr, uint8_t flags, uint8_t indent) { if (!isDir()) { pr->println(F("bad dir")); @@ -207,17 +206,40 @@ static int printFieldT(SdBaseFile* file, char sign, Type value, char term) { *--str = '\r'; } } +#ifdef OLD_FMT do { Type m = value; value /= 10; *--str = '0' + m - 10*value; } while (value); +#else // OLD_FMT + str = fmtDec(value, str); +#endif // OLD_FMT if (sign) { *--str = sign; } return file->write(str, &buf[sizeof(buf)] - str); } //------------------------------------------------------------------------------ +/** Print a number followed by a field terminator. + * \param[in] value The number to be printed. + * \param[in] term The field terminator. Use '\\n' for CR LF. + * \param[in] prec Number of digits after decimal point. + * \return The number of bytes written or -1 if an error occurs. + */ +int SdBaseFile::printField(float value, char term, uint8_t prec) { + char buf[24]; + char* str = &buf[sizeof(buf)]; + if (term) { + *--str = term; + if (term == '\n') { + *--str = '\r'; + } + } + str = fmtFloat(value, str, prec); + return write(str, buf + sizeof(buf) - str); +} +//------------------------------------------------------------------------------ /** Print a number followed by a field terminator. * \param[in] value The number to be printed. * \param[in] term The field terminator. Use '\\n' for CR LF. @@ -314,6 +336,13 @@ size_t SdBaseFile::printName() { return printName(SdFat::stdOut()); } //------------------------------------------------------------------------------ +/** Print a file's size. + * + * \param[in] pr Print stream for output. + * + * \return The value one, true, is returned for success and + * the value zero, false, is returned for failure. + */ size_t SdBaseFile::printFileSize(Print* pr) { char buf[10]; char *ptr = fmtDec(fileSize(), buf + sizeof(buf)); diff --git a/SdFat/SdFat.cpp b/SdFat/SdFat.cpp index b2dacfed..30c54c1c 100644 --- a/SdFat/SdFat.cpp +++ b/SdFat/SdFat.cpp @@ -148,7 +148,7 @@ void SdFat::ls(const char* path, uint8_t flags) { //------------------------------------------------------------------------------ /** List the directory contents of the volume working directory. * - * \param[in] pr Print stream for list. + * \param[in] pr Print stream for the list. * * \param[in] flags The inclusive OR of * @@ -162,6 +162,20 @@ void SdFat::ls(Print* pr, uint8_t flags) { m_vwd.ls(pr, flags); } //------------------------------------------------------------------------------ +/** List the directory contents of the volume working directory to stdOut. + * + * \param[in] pr Print stream for the list. + * + * \param[in] path directory to list. + * + * \param[in] flags The inclusive OR of + * + * LS_DATE - %Print file modification date + * + * LS_SIZE - %Print file size. + * + * LS_R - Recursive list of subdirectories. + */ void SdFat::ls(Print* pr, const char* path, uint8_t flags) { SdBaseFile dir(path, O_READ); dir.ls(pr, flags); diff --git a/SdFat/SdFat.h b/SdFat/SdFat.h index ccfc7f1b..535f6d9b 100644 --- a/SdFat/SdFat.h +++ b/SdFat/SdFat.h @@ -28,7 +28,7 @@ #define DBG_FAIL_MACRO // Serial.print(__FILE__);Serial.println(__LINE__) //------------------------------------------------------------------------------ /** SdFat version YYYYMMDD */ -#define SD_FAT_VERSION 20140806 +#define SD_FAT_VERSION 20141111 //------------------------------------------------------------------------------ /** error if old IDE */ #if !defined(ARDUINO) || ARDUINO < 100 @@ -37,6 +37,7 @@ //------------------------------------------------------------------------------ #include #include +#include #include #include //------------------------------------------------------------------------------ @@ -89,6 +90,18 @@ class SdFat { static void setStdOut(Print* stream) {m_stdOut = stream;} /** \return Print stream for messages. */ static Print* stdOut() {return m_stdOut;} + //---------------------------------------------------------------------------- + /** open a file + * + * \param[in] path location of file to be opened. + * \param[in] mode open mode flags. + * \return a File object. + */ + File open(const char *path, uint8_t mode = FILE_READ) { + File tmpFile; + tmpFile.open(&m_vwd, path, mode); + return tmpFile; + } private: Sd2Card m_card; diff --git a/SdFat/SdFatConfig.h b/SdFat/SdFatConfig.h index e344daa8..376eb5a0 100644 --- a/SdFat/SdFatConfig.h +++ b/SdFat/SdFatConfig.h @@ -24,34 +24,17 @@ #ifndef SdFatConfig_h #define SdFatConfig_h #include +#ifdef __AVR__ +#include +#endif // __AVR__ //------------------------------------------------------------------------------ /** - * Set USE_SEPARATE_FAT_CACHE nonzero to use a second 512 byte cache - * for FAT table entries. Improves performance for large writes that - * are not a multiple of 512 bytes. - */ -#ifdef __arm__ -#define USE_SEPARATE_FAT_CACHE 1 -#else // __arm__ -#define USE_SEPARATE_FAT_CACHE 0 -#endif // __arm__ -//------------------------------------------------------------------------------ -/** - * Set USE_MULTI_BLOCK_SD_IO nonzero to use multi-block SD read/write. - * - * Don't use mult-block read/write on small AVR boards. - */ -#if defined(RAMEND) && RAMEND < 3000 -#define USE_MULTI_BLOCK_SD_IO 0 -#else -#define USE_MULTI_BLOCK_SD_IO 1 -#endif -//------------------------------------------------------------------------------ -/** - * Force use of Arduino Standard SPI library if USE_ARDUINO_SPI_LIBRARY - * is nonzero. + * Set SD_FILE_USES_STREAM nonzero to use Stream instead of Print for SdFile. + * Using Stream will use more flash and may cause compatibility problems + * with code written for older versions of SdFat. */ -#define USE_ARDUINO_SPI_LIBRARY 0 +#define SD_FILE_USES_STREAM 0 + //------------------------------------------------------------------------------ /** * To enable SD card CRC checking set USE_SD_CRC nonzero. @@ -93,6 +76,82 @@ */ #define USE_SERIAL_FOR_STD_OUT 0 //------------------------------------------------------------------------------ +/** + * Set FAT12_SUPPORT nonzero to enable use if FAT12 volumes. + * FAT12 has not been well tested and requires additional flash. + */ +#define FAT12_SUPPORT 0 +//------------------------------------------------------------------------------ +/** + * Set ENABLE_SPI_TRANSACTION nonzero to enable the SPI transaction feature + * of the standard Arduino SPI library. You must include SPI.h in your + * sketches when ENABLE_SPI_TRANSACTION is nonzero. + */ +#define ENABLE_SPI_TRANSACTION 0 +//------------------------------------------------------------------------------ +/** + * Set ENABLE_SPI_YIELD nonzero to enable release of the SPI bus during + * SD card busy waits. + * + * This will allow interrupt routines to access the SPI bus if + * ENABLE_SPI_TRANSACTION is nonzero. + * + * Setting ENABLE_SPI_YIELD will introduce some extra overhead and will + * slightly slow transfer rates. A few older SD cards may fail when + * ENABLE_SPI_YIELD is nonzero. + */ +#define ENABLE_SPI_YIELD 0 +//------------------------------------------------------------------------------ +/** + * Set USE_ARDUINO_SPI_LIBRARY nonzero to force use of Arduino Standard + * SPI library. This will override native and software SPI for all boards. + */ +#define USE_ARDUINO_SPI_LIBRARY 0 +//------------------------------------------------------------------------------ +/** + * Set AVR_SOFT_SPI nonzero to use software SPI on all AVR Arduinos. + */ +#define AVR_SOFT_SPI 0 +//------------------------------------------------------------------------------ +/** + * Set DUE_SOFT_SPI nonzero to use software SPI on Due Arduinos. + */ +#define DUE_SOFT_SPI 0 +//------------------------------------------------------------------------------ + +/** + * Set LEONARDO_SOFT_SPI nonzero to use software SPI on Leonardo Arduinos. + * LEONARDO_SOFT_SPI allows an unmodified 328 Shield to be used + * on Leonardo Arduinos. + */ +#define LEONARDO_SOFT_SPI 0 +//------------------------------------------------------------------------------ +/** + * Set MEGA_SOFT_SPI nonzero to use software SPI on Mega Arduinos. + * MEGA_SOFT_SPI allows an unmodified 328 Shield to be used + * on Mega Arduinos. + */ +#define MEGA_SOFT_SPI 0 +//------------------------------------------------------------------------------ +/** + * Set TEENSY3_SOFT_SPI nonzero to use software SPI on Teensy 3.x boards. + */ +#define TEENSY3_SOFT_SPI 0 +//------------------------------------------------------------------------------ +/** + * Define software SPI pins. Default allows Uno shields to be used on other + * boards. + */ +// define software SPI pins +/** Default Software SPI chip select pin */ +uint8_t const SOFT_SPI_CS_PIN = 10; +/** Software SPI Master Out Slave In pin */ +uint8_t const SOFT_SPI_MOSI_PIN = 11; +/** Software SPI Master In Slave Out pin */ +uint8_t const SOFT_SPI_MISO_PIN = 12; +/** Software SPI Clock pin */ +uint8_t const SOFT_SPI_SCK_PIN = 13; +//------------------------------------------------------------------------------ /** * Call flush for endl if ENDL_CALLS_FLUSH is nonzero * @@ -112,12 +171,6 @@ */ #define ENDL_CALLS_FLUSH 0 //------------------------------------------------------------------------------ -/** - * Allow FAT12 volumes if FAT12_SUPPORT is nonzero. - * FAT12 has not been well tested. - */ -#define FAT12_SUPPORT 0 -//------------------------------------------------------------------------------ /** * SPI SCK divisor for SD initialization commands. * or greater @@ -129,36 +182,24 @@ const uint8_t SPI_SCK_INIT_DIVISOR = 128; #endif //------------------------------------------------------------------------------ /** - * Define MEGA_SOFT_SPI nonzero to use software SPI on Mega Arduinos. - * Default pins used are SS 10, MOSI 11, MISO 12, and SCK 13. - * Edit Software Spi pins to change pin numbers. - * - * MEGA_SOFT_SPI allows an unmodified 328 Shield to be used - * on Mega Arduinos. + * Set USE_SEPARATE_FAT_CACHE nonzero to use a second 512 byte cache + * for FAT table entries. Improves performance for large writes that + * are not a multiple of 512 bytes. */ -#define MEGA_SOFT_SPI 0 +#ifdef __arm__ +#define USE_SEPARATE_FAT_CACHE 1 +#else // __arm__ +#define USE_SEPARATE_FAT_CACHE 0 +#endif // __arm__ //------------------------------------------------------------------------------ /** - * Define LEONARDO_SOFT_SPI nonzero to use software SPI on Leonardo Arduinos. - * Default pins used are SS 10, MOSI 11, MISO 12, and SCK 13. - * Edit Software Spi pins to change pin numbers. + * Set USE_MULTI_BLOCK_SD_IO nonzero to use multi-block SD read/write. * - * LEONARDO_SOFT_SPI allows an unmodified 328 Shield to be used - * on Leonardo Arduinos. - */ -#define LEONARDO_SOFT_SPI 0 -//------------------------------------------------------------------------------ -/** - * Set USE_SOFTWARE_SPI nonzero to always use software SPI on AVR. + * Don't use mult-block read/write on small AVR boards. */ -#define USE_SOFTWARE_SPI 0 -// define software SPI pins so Mega can use unmodified 168/328 shields -/** Default Software SPI chip select pin */ -uint8_t const SOFT_SPI_CS_PIN = 10; -/** Software SPI Master Out Slave In pin */ -uint8_t const SOFT_SPI_MOSI_PIN = 11; -/** Software SPI Master In Slave Out pin */ -uint8_t const SOFT_SPI_MISO_PIN = 12; -/** Software SPI Clock pin */ -uint8_t const SOFT_SPI_SCK_PIN = 13; +#if defined(RAMEND) && RAMEND < 3000 +#define USE_MULTI_BLOCK_SD_IO 0 +#else // RAMEND +#define USE_MULTI_BLOCK_SD_IO 1 +#endif // RAMEND #endif // SdFatConfig_h diff --git a/SdFat/SdFatmainpage.h b/SdFat/SdFatmainpage.h index 993e7629..cbad2907 100644 --- a/SdFat/SdFatmainpage.h +++ b/SdFat/SdFatmainpage.h @@ -33,15 +33,22 @@ nonzero in SdFatConfig.h. The %SdFat library only supports short 8.3 names. -The main classes in %SdFat are SdFat, SdFile, StdioStream, \ref fstream, -\ref ifstream, and \ref ofstream. +The main classes in %SdFat are SdFat, SdBaseFile, SdFile, File, StdioStream, +\ref fstream, \ref ifstream, and \ref ofstream. -The SdFat class maintains a volume working directories, a current working -directory, and simplifies initialization of other classes. +The SdFat class maintains a FAT volume, a current working directory, +and simplifies initialization of other classes. -The SdFile class provides binary file access functions such as open(), read(), -remove(), write(), close() and sync(). This class supports access to the root -directory and subdirectories. +The SdBaseFile class provides basic file access functions such as open(), +binary read(), binary write(), close(), remove(), and sync(). SdBaseFile +is the smallest file class. + +The SdFile class has all the SdBaseFile class functions plus the Arduino +Print class functions. + +The File class has all the SdBaseFile functions plus the functions in +the Arduino SD.h File class. This provides compatibility with the +Arduino SD.h library. The StdioStream class implements functions similar to Linux/Unix standard buffered input/output. @@ -49,9 +56,9 @@ buffered input/output. The \ref fstream class implements C++ iostreams for both reading and writing text files. -The \ref ifstream class implements the C++ iostreams for reading text files. +The \ref ifstream class implements C++ iostreams for reading text files. -The \ref ofstream class implements the C++ iostreams for writing text files. +The \ref ofstream class implements C++ iostreams for writing text files. The classes \ref ibufstream and \ref obufstream format and parse character strings in memory buffers. @@ -59,21 +66,46 @@ The classes \ref ibufstream and \ref obufstream format and parse character the classes ArduinoInStream and ArduinoOutStream provide iostream functions for Serial, LiquidCrystal, and other devices. -The SdVolume class supports FAT16 and FAT32 partitions. Most applications -will not need to call SdVolume member function. - -The Sd2Card class supports access to standard SD cards and SDHC cards. Most -applications will not need to call Sd2Card functions. The Sd2Card class can -be used for raw access to the SD card. - A number of example are provided in the %SdFat/examples folder. These were developed to test %SdFat and illustrate its use. -%SdFat was developed for high speed data recording. %SdFat was used to -implement an audio record/play class, WaveRP, for the Adafruit Wave Shield. -This application uses special Sd2Card calls to write to contiguous files in -raw mode. These functions reduce write latency so that audio can be -recorded with the small amount of RAM in the Arduino. +\section Install Installation + +You must manually install SdFat by copying the SdFat folder from the download +package to the Arduino libraries folder in you sketch book. + +See the Manual installation section of this guide. + +http://arduino.cc/en/Guide/Libraries + +\section SDconfig SdFat Configuration + +Several configuration options may be changed by editing the SdFatConfig.h +file in the SdFat folder. + +Set SD_FILE_USES_STREAM nonzero to use Stream instead of Print for SdFile. +Using Stream will use more flash. + +To enable SD card CRC checking set USE_SD_CRC nonzero. + +To use multiple SD cards set USE_MULTIPLE_CARDS nonzero. + +Set FAT12_SUPPORT nonzero to enable use of FAT12 volumes. +FAT12 has not been well tested and requires additional flash. + +Set USE_ARDUINO_SPI_LIBRARY nonzero to force use of Arduino Standard +SPI library. This will override native and software SPI for all boards. + +Use of software SPI can be enabled for selected boards by setting the symbols +AVR_SOFT_SPI, DUE_SOFT_SPI, LEONARDO_SOFT_SPI, MEGA_SOFT_SPI, +and TEENSY3_SOFT_SPI. + +Set ENABLE_SPI_TRANSACTION nonzero to enable the SPI transaction feature +of the standard Arduino SPI library. You must include SPI.h in your +sketches when ENABLE_SPI_TRANSACTION is nonzero. + +Set ENABLE_SPI_YIELD nonzero to enable release of the SPI bus during +SD card busy waits. \section SDcard SD\SDHC Cards @@ -118,10 +150,6 @@ If you wish to report bugs or have comments, send email to fat16lib@sbcglobal.ne \section SdFatClass SdFat Usage %SdFat uses a slightly restricted form of short names. -Only printable ASCII characters are supported. No characters with code point -values greater than 127 are allowed. Space is not allowed even though space -was allowed in the API of early versions of DOS. - Short names are limited to 8 characters followed by an optional period (.) and extension of up to 3 characters. The characters may be any combination of letters and digits. The following special characters are also allowed: @@ -131,89 +159,106 @@ of letters and digits. The following special characters are also allowed: Short names are always converted to upper case and their original case value is lost. -\par An application which writes to a file using print(), println() or \link SdFile::write write() \endlink must call \link SdFile::sync() sync() \endlink at the appropriate time to force data and directory information to be written to the SD Card. Data and directory information are also written to the SD card when \link SdFile::close() close() \endlink is called. -\par Applications must use care calling \link SdFile::sync() sync() \endlink since 2048 bytes of I/O is required to update file and directory information. This includes writing the current data block, reading the block that contains the directory entry for update, writing the directory block back and reading back the current data block. -It is possible to open a file with two or more instances of SdFile. A file may -be corrupted if data is written to the file by more than one instance of SdFile. +It is possible to open a file with two or more instances of a file object. +A file may be corrupted if data is written to the file by more than one +instance of a file object. \section HowTo How to format SD Cards as FAT Volumes +The best way to restore an SD card's format on a PC or Mac is to use +SDFormatter which can be downloaded from: + +http://www.sdcard.org/downloads + +A formatter sketch, SdFormatter.ino, is included in the +%SdFat/examples/SdFormatter directory. This sketch attempts to +emulate SD Association's SDFormatter. + +SDFormatter aligns flash erase boundaries with file +system structures which reduces write latency and file system overhead. + +The PC/Mac SDFormatter does not have an option for FAT type so it may format +very small cards as FAT12. Use the SdFat formatter to force FAT16 +formatting of small cards. + +Do not format the SD card with an OS utility, OS utilities do not format SD +cards in conformance with the SD standard. + You should use a freshly formatted SD card for best performance. FAT file systems become slower if many files have been created and deleted. This is because the directory entry for a deleted file is marked as deleted, but is not deleted. When a new file is created, these entries must be scanned -before creating the file, a flaw in the FAT design. Also files can become +before creating the file. Also files can become fragmented which causes reads and writes to be slower. -A formatter sketch, SdFormatter.pde, is included in the -%SdFat/examples/SdFormatter directory. This sketch attempts to -emulate SD Association's SDFormatter. +\section ExampleFilder Examples -The best way to restore an SD card's format on a PC is to use SDFormatter -which can be downloaded from: +A number of examples are provided in the SdFat/examples folder. +See the html documentation for a list. -http://www.sdcard.org/consumers/formatter/ +To access these examples from the Arduino development environment +go to: %File -> Examples -> %SdFat -> \ -SDFormatter aligns flash erase boundaries with file -system structures which reduces write latency and file system overhead. +Compile, upload to your Arduino and click on Serial Monitor to run +the example. + +Here is a list: + +AnalogBinLogger - Fast AVR ADC logger - see the AnalogBinLoggerExtras folder. + +bench - A read/write benchmark. + +cin_cout - Demo of ArduinoInStream and ArduinoOutStream. + +dataLogger - A simple modifiable data logger. -SDFormatter does not have an option for FAT type so it may format -small cards as FAT12. +directoryFunctions - Demo of chdir(), ls(), mkdir(), and rmdir(). -After the MBR is restored by SDFormatter you may need to reformat small -cards that have been formatted FAT12 to force the volume type to be FAT16. +fgets - Demo of the fgets read line/string function. -If you reformat the SD card with an OS utility, choose a cluster size that -will result in: +formating - Print a table with various formatting options. -4084 < CountOfClusters && CountOfClusters < 65525 +getline - Example of getline from section 27.7.1.3 of the C++ standard. -The volume will then be FAT16. +LowLatencyLogger - A modifiable data logger for higher data rates. -If you are formatting an SD card on OS X or Linux, be sure to use the first -partition. Format this partition with a cluster count in above range for FAT16. -SDHC cards should be formatted FAT32 with a cluster size of 32 KB. +OpenNext - Open all files in the root dir and print their filename. -Microsoft operating systems support removable media formatted with a -Master Boot Record, MBR, or formatted as a super floppy with a FAT Boot Sector -in block zero. +PrintBenchmark - A simple benchmark for printing to a text file. -Microsoft operating systems expect MBR formatted removable media -to have only one partition. The first partition should be used. +QuickStart - A sketch to quickly test your SD card and SD shield/module. -Microsoft operating systems do not support partitioning SD flash cards. -If you erase an SD card with a program like KillDisk, Most versions of -Windows will format the card as a super floppy. +RawWrite - A test of raw write functions for contiguous files. -\section References References +readCSV - Read a comma-separated value file using iostream extractors. -The Arduino site: +ReadWriteSdFat - SdFat version of Arduino SD ReadWrite example. -http://www.arduino.cc/ +rename - A demo of SdFat::rename(old, new) and SdFile::rename(dirFile, newPath). -For more information about FAT file systems see: +SdFormatter - This sketch will format an SD or SDHC card. -http://www.microsoft.com/whdc/system/platform/firmware/fatgen.mspx +SdInfo - Initialize an SD card and analyze its structure for trouble shooting. -For information about using SD cards as SPI devices see: +StdioBench - Demo and test of stdio style stream. -http://www.sdcard.org/developers/tech/sdcard/pls/Simplified_Physical_Layer_Spec.pdf +StreamParseInt - Simple demo of parseInt() Stream member function. -The ATmega328 datasheet: +StressTest - Create and write files until the SD is full. -http://www.atmel.com/dyn/resources/prod_documents/doc8161.pdf - +Timestamp - Sets file create, modify, and access timestamps. +TwoCards - Example using two SD cards. */ diff --git a/SdFat/SdFile.h b/SdFat/SdFile.h index 954686a8..8a2dd045 100644 --- a/SdFat/SdFile.h +++ b/SdFat/SdFile.h @@ -21,31 +21,237 @@ * \file * \brief SdFile class */ -#include #ifndef SdFile_h #define SdFile_h +#include +#include //------------------------------------------------------------------------------ /** * \class SdFile - * \brief SdBaseFile with Print. + * \brief SdBaseFile with Arduino Stream. */ +#if SD_FILE_USES_STREAM +class SdFile : public SdBaseFile, public Stream { +#else // SD_FILE_USES_STREAM class SdFile : public SdBaseFile, public Print { +#endif // SD_FILE_USES_STREAM public: SdFile() {} SdFile(const char* name, uint8_t oflag); #if DESTRUCTOR_CLOSES_FILE ~SdFile() {} #endif // DESTRUCTOR_CLOSES_FILE + /** \return number of bytes available from the current position to EOF + * or INT_MAX if more than INT_MAX bytes are available. + */ + int available() { + uint32_t n = SdBaseFile::available(); + return n > INT_MAX ? INT_MAX : n; + } + /** Ensure that any bytes written to the file are saved to the SD card. */ + void flush() {SdBaseFile::sync();} + /** Return the next available byte without consuming it. + * + * \return The byte if no error and not at eof else -1; + */ + int peek() {return SdBaseFile::peek();} + /** Read the next byte from a file. + * + * \return For success return the next byte in the file as an int. + * If an error occurs or end of file is reached return -1. + */ + int read() {return SdBaseFile::read();} + /** Read data from a file starting at the current position. + * + * \param[out] buf Pointer to the location that will receive the data. + * + * \param[in] nbyte Maximum number of bytes to read. + * + * \return For success read() returns the number of bytes read. + * A value less than \a nbyte, including zero, will be returned + * if end of file is reached. + * If an error occurs, read() returns -1. Possible errors include + * read() called before a file has been opened, corrupt file system + * or an I/O error occurred. + */ + int read(void* buf, size_t nbyte) {return SdBaseFile::read(buf, nbyte);} /** \return value of writeError */ bool getWriteError() {return SdBaseFile::getWriteError();} /** Set writeError to zero */ void clearWriteError() {SdBaseFile::clearWriteError();} size_t write(uint8_t b); + int write(const char* str); + /** Write data to an open file. + * + * \note Data is moved to the cache but may not be written to the + * storage device until sync() is called. + * + * \param[in] buf Pointer to the location of the data to be written. + * + * \param[in] nbyte Number of bytes to write. + * + * \return For success write() returns the number of bytes written, always + * \a nbyte. If an error occurs, write() returns -1. Possible errors + * include write() is called before a file has been opened, write is called + * for a read-only file, device is full, a corrupt file system or an + * I/O error. + */ int write(const void* buf, size_t nbyte); + /** Write data to an open file. Form required by Print. + * + * \note Data is moved to the cache but may not be written to the + * storage device until sync() is called. + * + * \param[in] buf Pointer to the location of the data to be written. + * + * \param[in] size Number of bytes to write. + * + * \return For success write() returns the number of bytes written, always + * \a nbyte. If an error occurs, write() returns -1. Possible errors + * include write() is called before a file has been opened, write is called + * for a read-only file, device is full, a corrupt file system or an + * I/O error. + */ size_t write(const uint8_t *buf, size_t size) { return SdBaseFile::write(buf, size);} void write_P(PGM_P str); void writeln_P(PGM_P str); }; +//------------------------------------------------------------------------------ +/** Arduino SD.h style flag for open for read. */ +#define FILE_READ O_READ +/** Arduino SD.h style flag for open at EOF for read/write with create. */ +#define FILE_WRITE (O_RDWR | O_CREAT | O_AT_END) +/** + * \class File + * \brief Arduino SD.h style File API + */ +class File : public SdBaseFile, public Stream { + public: + /** The parenthesis operator. + * + * \return true if a file is open. + */ + operator bool() {return isOpen();} + /** \return number of bytes available from the current position to EOF + * or INT_MAX if more than INT_MAX bytes are available. + */ + int available() { + uint32_t n = SdBaseFile::available(); + return n > INT_MAX ? INT_MAX : n; + } + /** Set writeError to zero */ + void clearWriteError() {SdBaseFile::clearWriteError();} + /** Ensure that any bytes written to the file are saved to the SD card. */ + void flush() {sync();} + /** \return value of writeError */ + bool getWriteError() {return SdBaseFile::getWriteError();} + /** This function reports if the current file is a directory or not. + * \return true if the file is a directory. + */ + bool isDirectory() {return isDir();} + /** \return a pointer to the file's name. */ + char* name() { + m_name[0] = 0; + getFilename(m_name); + return m_name; + } + /** Return the next available byte without consuming it. + * + * \return The byte if no error and not at eof else -1; + */ + int peek() {return SdBaseFile::peek();} + /** \return the current file position. */ + uint32_t position() {return curPosition();} + /** Opens the next file or folder in a directory. + * + * \param[in] mode open mode flags. + * \return a File object. + */ + File openNextFile(uint8_t mode = O_READ) { + File tmpFile; + tmpFile.openNext(this, mode); + return tmpFile; + } + /** Read the next byte from a file. + * + * \return For success return the next byte in the file as an int. + * If an error occurs or end of file is reached return -1. + */ + int read() {return SdBaseFile::read();} + /** Read data from a file starting at the current position. + * + * \param[out] buf Pointer to the location that will receive the data. + * + * \param[in] nbyte Maximum number of bytes to read. + * + * \return For success read() returns the number of bytes read. + * A value less than \a nbyte, including zero, will be returned + * if end of file is reached. + * If an error occurs, read() returns -1. Possible errors include + * read() called before a file has been opened, corrupt file system + * or an I/O error occurred. + */ + int read(void* buf, size_t nbyte) {return SdBaseFile::read(buf, nbyte);} + /** Rewind a file if it is a directory */ + void rewindDirectory() { + if (isDir()) rewind(); + } + /** + * Seek to a new position in the file, which must be between + * 0 and the size of the file (inclusive). + * + * \param[in] pos the new file position. + * \return true for success else false. + */ + bool seek(uint32_t pos) {return seekSet(pos);} + /** \return the file's size. */ + uint32_t size() {return fileSize();} + /** Write a byte to a file. Required by the Arduino Print class. + * \param[in] b the byte to be written. + * Use getWriteError to check for errors. + * \return 1 for success and 0 for failure. + */ + size_t write(uint8_t b) { + return SdBaseFile::write(&b, 1) == 1 ? 1 : 0; + } + /** Write data to an open file. + * + * \note Data is moved to the cache but may not be written to the + * storage device until sync() is called. + * + * \param[in] buf Pointer to the location of the data to be written. + * + * \param[in] nbyte Number of bytes to write. + * + * \return For success write() returns the number of bytes written, always + * \a nbyte. If an error occurs, write() returns -1. Possible errors + * include write() is called before a file has been opened, write is called + * for a read-only file, device is full, a corrupt file system or an + * I/O error. + */ + int write(const void* buf, size_t nbyte); + /** Write data to an open file. Form required by Print. + * + * \note Data is moved to the cache but may not be written to the + * storage device until sync() is called. + * + * \param[in] buf Pointer to the location of the data to be written. + * + * \param[in] size Number of bytes to write. + * + * \return For success write() returns the number of bytes written, always + * \a nbyte. If an error occurs, write() returns -1. Possible errors + * include write() is called before a file has been opened, write is called + * for a read-only file, device is full, a corrupt file system or an + * I/O error. + */ + size_t write(const uint8_t *buf, size_t size) { + return SdBaseFile::write(buf, size); + } + + private: + char m_name[13]; +}; #endif // SdFile_h diff --git a/SdFat/SdSpi.h b/SdFat/SdSpi.h index b34611ce..61c4f954 100644 --- a/SdFat/SdSpi.h +++ b/SdFat/SdSpi.h @@ -29,38 +29,56 @@ #if !USE_ARDUINO_SPI_LIBRARY // AVR Arduinos #ifdef __AVR__ -#if USE_SOFTWARE_SPI -#define USE_AVR_SOFTWARE_SPI 1 +#if AVR_SOFT_SPI +#define USE_SOFTWARE_SPI 1 #elif LEONARDO_SOFT_SPI && defined(__AVR_ATmega32U4__) && !defined(CORE_TEENSY) -#define USE_AVR_SOFTWARE_SPI 1 -#elif MEGA_SOFT_SPI&&(defined(__AVR_ATmega1280__)||defined(__AVR_ATmega2560__)) -#define USE_AVR_SOFTWARE_SPI 1 +#define USE_SOFTWARE_SPI 1 +#elif MEGA_SOFT_SPI && (defined(__AVR_ATmega1280__)\ + ||defined(__AVR_ATmega2560__)) +#define USE_SOFTWARE_SPI 1 #else // USE_SOFTWARE_SPI -#define USE_AVR_S0FTWARE_SPI 0 #define USE_NATIVE_AVR_SPI 1 #endif // USE_SOFTWARE_SPI #endif // __AVR__ // Due #if defined(__arm__) && !defined(CORE_TEENSY) +#if DUE_SOFT_SPI +#define USE_SOFTWARE_SPI 1 +#else // DUE_SOFT_SPI /** Nonzero - use native SAM3X SPI */ #define USE_NATIVE_SAM3X_SPI 1 -#else // USE_NATIVE_SAM3X_SPI -/** Zero - don't use native SAM3X SPI */ -#define USE_NATIVE_SAM3X_SPI 0 -#endif // USE_NATIVE_SAM3X_SPI +#endif // DUE_SOFT_SPI +#endif // defined(__arm__) && !defined(CORE_TEENSY) // Teensy 3.0 #if defined(__arm__) && defined(CORE_TEENSY) +#if TEENSY3_SOFT_SPI +#define USE_SOFTWARE_SPI 1 +#else // TEENSY3_SOFT_SPI /** Nonzero - use native MK20DX128 SPI */ -#define USE_NATIVE_MK20DX128_SPI 1 -#else // USE_NATIVE_MK20DX128_SPI -/** Zero - don't use native MK20DX128 SPI */ -#define USE_NATIVE_MK20DX128_SPI 0 -#endif // USE_NATIVE_MK20DX128_SPI -#endif // USE_ARDUINO_SPI_LIBRARY +#define USE_NATIVE_TEENSY3_SPI 1 +#endif // TEENSY3_SOFT_SPI +#endif // defined(__arm__) && defined(CORE_TEENSY) +#endif // !USE_ARDUINO_SPI_LIBRARY + +#ifndef USE_SOFTWARE_SPI +#define USE_SOFTWARE_SPI 0 +#endif // USE_SOFTWARE_SPI + +#ifndef USE_NATIVE_AVR_SPI +#define USE_NATIVE_AVR_SPI 0 +#endif + +#ifndef USE_NATIVE_SAM3X_SPI +#define USE_NATIVE_SAM3X_SPI 0 +#endif // USE_NATIVE_SAM3X_SPI + +#ifndef USE_NATIVE_TEENSY3_SPI +#define USE_NATIVE_TEENSY3_SPI 0 +#endif // USE_NATIVE_TEENSY3_SPI //------------------------------------------------------------------------------ // define default chip select pin // -#if !USE_AVR_SOFTWARE_SPI +#if !USE_SOFTWARE_SPI /** The default chip select pin for the SD card is SS. */ uint8_t const SD_CHIP_SELECT_PIN = SS; #else // USE_AVR_SOFTWARE_SPI diff --git a/SdFat/SdSpiAVR.cpp b/SdFat/SdSpiAVR.cpp index 893b9288..d6b82ffb 100644 --- a/SdFat/SdSpiAVR.cpp +++ b/SdFat/SdSpiAVR.cpp @@ -16,11 +16,12 @@ * You should have received a copy of the GNU General Public License * along with the Arduino SdSpi Library. If not, see * . - */#include + */ +#include #if USE_NATIVE_AVR_SPI //------------------------------------------------------------------------------ void SdSpi::begin() { - // set SS high - may be chip select for another SPI device + // set SS high - may be chip select for another SPI device digitalWrite(SS, HIGH); // SS must be in output mode even it is not chip select @@ -32,8 +33,8 @@ void SdSpi::begin() { //------------------------------------------------------------------------------ void SdSpi::init(uint8_t sckDivisor) { uint8_t r = 0; - - for (uint8_t b = 2; sckDivisor > b && r < 6; b <<= 1, r++); + + for (uint8_t b = 2; sckDivisor > b && r < 6; b <<= 1, r++) {} // See avr processor documentation SPCR = (1 << SPE) | (1 << MSTR) | (r >> 1); SPSR = r & 1 || r == 6 ? 0 : 1 << SPI2X; @@ -42,7 +43,7 @@ void SdSpi::init(uint8_t sckDivisor) { //------------------------------------------------------------------------------ uint8_t SdSpi::receive() { SPDR = 0XFF; - while (!(SPSR & (1 << SPIF))); + while (!(SPSR & (1 << SPIF))) {} return SPDR; } //------------------------------------------------------------------------------ @@ -50,19 +51,19 @@ uint8_t SdSpi::receive(uint8_t* buf, size_t n) { if (n-- == 0) return 0; SPDR = 0XFF; for (size_t i = 0; i < n; i++) { - while (!(SPSR & (1 << SPIF))); + while (!(SPSR & (1 << SPIF))) {} uint8_t b = SPDR; SPDR = 0XFF; buf[i] = b; } - while (!(SPSR & (1 << SPIF))); + while (!(SPSR & (1 << SPIF))) {} buf[n] = SPDR; return 0; } //------------------------------------------------------------------------------ void SdSpi::send(uint8_t data) { SPDR = data; - while (!(SPSR & (1 << SPIF))); + while (!(SPSR & (1 << SPIF))) {} } //------------------------------------------------------------------------------ void SdSpi::send(const uint8_t* buf , size_t n) { @@ -72,55 +73,14 @@ void SdSpi::send(const uint8_t* buf , size_t n) { uint8_t b = buf[1]; size_t i = 2; while (1) { - while (!(SPSR & (1 << SPIF))); + while (!(SPSR & (1 << SPIF))) {} SPDR = b; if (i == n) break; b = buf[i++]; } } - while (!(SPSR & (1 << SPIF))); + while (!(SPSR & (1 << SPIF))) {} } #endif // !USE_AVR_NATIVE_SPI_INLINE #endif // USE_NATIVE_AVR_SPI -//============================================================================== -#if USE_AVR_SOFTWARE_SPI -#include -static -SoftSPI softSpiBus; -//------------------------------------------------------------------------------ -/** - * initialize SPI pins - */ -void SdSpi::begin() { - softSpiBus.begin(); -} -//------------------------------------------------------------------------------ -/** - * Initialize hardware SPI - dummy for soft SPI - */ -void SdSpi::init(uint8_t sckDivisor) {} -//------------------------------------------------------------------------------ -/** Soft SPI receive byte */ -uint8_t SdSpi::receive() { - return softSpiBus.receive(); -} -//------------------------------------------------------------------------------ -/** Soft SPI read data */ -uint8_t SdSpi::receive(uint8_t* buf, size_t n) { - for (size_t i = 0; i < n; i++) { - buf[i] = receive(); - } - return 0; -} -//------------------------------------------------------------------------------ -/** Soft SPI send byte */ -void SdSpi::send(uint8_t data) { - softSpiBus.send(data); -} -//------------------------------------------------------------------------------ -void SdSpi::send(const uint8_t* buf , size_t n) { - for (size_t i = 0; i < n; i++) { - send(buf[i]); - } -} -#endif // USE_AVR_SOFTWARE_SPI + diff --git a/SdFat/SdSpiSoft.cpp b/SdFat/SdSpiSoft.cpp new file mode 100644 index 00000000..9d1e5786 --- /dev/null +++ b/SdFat/SdSpiSoft.cpp @@ -0,0 +1,61 @@ +/* Arduino SdSpi Library + * Copyright (C) 2013 by William Greiman + * + * This file is part of the Arduino SdSpi Library + * + * This Library is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This Library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with the Arduino SdSpi Library. If not, see + * . + */ +#include +#if USE_SOFTWARE_SPI +#include +static +SoftSPI softSpiBus; +//------------------------------------------------------------------------------ +/** + * initialize SPI pins + */ +void SdSpi::begin() { + softSpiBus.begin(); +} +//------------------------------------------------------------------------------ +/** + * Initialize hardware SPI - dummy for soft SPI + */ +void SdSpi::init(uint8_t sckDivisor) {} +//------------------------------------------------------------------------------ +/** Soft SPI receive byte */ +uint8_t SdSpi::receive() { + return softSpiBus.receive(); +} +//------------------------------------------------------------------------------ +/** Soft SPI read data */ +uint8_t SdSpi::receive(uint8_t* buf, size_t n) { + for (size_t i = 0; i < n; i++) { + buf[i] = receive(); + } + return 0; +} +//------------------------------------------------------------------------------ +/** Soft SPI send byte */ +void SdSpi::send(uint8_t data) { + softSpiBus.send(data); +} +//------------------------------------------------------------------------------ +void SdSpi::send(const uint8_t* buf , size_t n) { + for (size_t i = 0; i < n; i++) { + send(buf[i]); + } +} +#endif // USE_SOFTWARE_SPI \ No newline at end of file diff --git a/SdFat/SdSpiMK20DX128.cpp b/SdFat/SdSpiTeensy3.cpp similarity index 99% rename from SdFat/SdSpiMK20DX128.cpp rename to SdFat/SdSpiTeensy3.cpp index 006ccd35..9c938ea5 100644 --- a/SdFat/SdSpiMK20DX128.cpp +++ b/SdFat/SdSpiTeensy3.cpp @@ -18,7 +18,7 @@ * . */ #include -#if USE_NATIVE_MK20DX128_SPI +#if USE_NATIVE_TEENSY3_SPI // Teensy 3.0 functions #include // use 16-bit frame if SPI_USE_8BIT_FRAME is zero @@ -220,4 +220,4 @@ void SdSpi::send(const uint8_t* buf , size_t n) { } #endif // SPI_USE_8BIT_FRAME } -#endif // USE_NATIVE_MK20DX128_SPI +#endif // USE_NATIVE_TEENSY3_SPI diff --git a/SdFat/StdioStream.cpp b/SdFat/StdioStream.cpp index c80500c7..41bf0f0b 100644 --- a/SdFat/StdioStream.cpp +++ b/SdFat/StdioStream.cpp @@ -17,10 +17,6 @@ * along with the Arduino RamDisk Library. If not, see * . */ - /** - * \file - * StdioStream implementation - */ #include #include #include diff --git a/SdFat/StdioStream.h b/SdFat/StdioStream.h index c6a81df4..59609000 100644 --- a/SdFat/StdioStream.h +++ b/SdFat/StdioStream.h @@ -21,7 +21,7 @@ #define StdioStream_h /** * \file - * StdioStream class + * \brief StdioStream class */ #include #include diff --git a/SdFat/examples/#attic/TestMkdirRmdir/TestMkdirRmdir.ino b/SdFat/examples/#attic/TestMkdir/TestMkdir.ino similarity index 100% rename from SdFat/examples/#attic/TestMkdirRmdir/TestMkdirRmdir.ino rename to SdFat/examples/#attic/TestMkdir/TestMkdir.ino diff --git a/SdFat/examples/#attic/TestRmdir/TestRmdir.ino b/SdFat/examples/#attic/TestRmdir/TestRmdir.ino new file mode 100644 index 00000000..11d2be60 --- /dev/null +++ b/SdFat/examples/#attic/TestRmdir/TestRmdir.ino @@ -0,0 +1,97 @@ +/* + * This sketch will remove the files and directories + * created by the SdFatMakeDir.pde sketch. + * + * Performance is erratic due to the large number + * of flash erase operations caused by many random + * writes to file structures. + */ +#include +#include + +const uint8_t SD_CHIP_SELECT = SS; + +SdFat sd; + +// store error strings in flash to save RAM +#define error(s) sd.errorHalt_P(PSTR(s)) + +/* + * remove all files in dir. + */ +void deleteFiles(SdBaseFile* dir) { + char name[13]; + SdFile file; + + // open and delete files + for (uint16_t n = 0; ; n++){ + sprintf(name, "%u.TXT", n); + + // open start time + uint32_t t0 = millis(); + + // assume done if open fails + if (!file.open(dir, name, O_WRITE)) return; + + // open end time and remove start time + uint32_t t1 = millis(); + if (!file.remove()) error("file.remove failed"); + + // remove end time + uint32_t t2 = millis(); + + PgmPrint("RM "); + Serial.print(n); + Serial.write(' '); + + // open time + Serial.print(t1 - t0); + Serial.write(' '); + + // remove time + Serial.println(t2 - t1); + } +} + +void setup() { + Serial.begin(9600); + while (!Serial) {} // wait for Leonardo + PgmPrintln("Type any character to start"); + while (Serial.read() <= 0) {} + delay(200); // Catch Due reset problem + + // initialize the SD card at SPI_FULL_SPEED for best performance. + // try SPI_HALF_SPEED if bus errors occur. + if (!sd.begin(SD_CHIP_SELECT, SPI_FULL_SPEED)) sd.initErrorHalt(); + + + // delete files in root if FAT32 + if (sd.vol()->fatType() == 32) { + PgmPrintln("Remove files in root"); + deleteFiles(sd.vwd()); + } + + // open SUB1 and delete files + SdFile sub1; + if (!sub1.open("SUB1", O_READ)) error("open SUB1 failed"); + PgmPrintln("Remove files in SUB1"); + deleteFiles(&sub1); + + // open SUB2 and delete files + SdFile sub2; + if (!sub2.open(&sub1, "SUB2", O_READ)) error("open SUB2 failed"); + PgmPrintln("Remove files in SUB2"); + deleteFiles(&sub2); + + // remove SUB2 + if (!sub2.rmDir()) error("sub2.rmDir failed"); + PgmPrintln("SUB2 removed"); + + // remove SUB1 + if (!sub1.rmDir()) error("sub1.rmDir failed"); + PgmPrintln("SUB1 removed"); + + PgmPrintln("Done"); +} + +void loop() { } diff --git a/SdFat/examples/PrintBenchmark/PrintBenchmark.ino b/SdFat/examples/PrintBenchmark/PrintBenchmark.ino index 66613f5c..61f88aa7 100644 --- a/SdFat/examples/PrintBenchmark/PrintBenchmark.ino +++ b/SdFat/examples/PrintBenchmark/PrintBenchmark.ino @@ -50,15 +50,19 @@ void loop() { cout << pstr("Type is FAT") << int(sd.vol()->fatType()) << endl; - // open or create file - truncate existing file. - if (!file.open("BENCH.TXT", O_CREAT | O_TRUNC | O_RDWR)) { - error("open failed"); - } cout << pstr("Starting print test. Please wait.\n\n"); // do write test - for (int test = 0; test < 3; test++) { - + for (int test = 0; test < 6; test++) { + char fileName[13] = "BENCH0.TXT"; + fileName[5] = '0' + test; + // open or create file - truncate existing file. + if (!file.open(fileName, O_CREAT | O_TRUNC | O_RDWR)) { + error("open failed"); + } + maxLatency = 0; + minLatency = 999999; + totalLatency = 0; switch(test) { case 0: cout << pstr("Test of println(uint16_t)\n"); @@ -69,13 +73,21 @@ void loop() { break; case 2: - cout << pstr("Test of println(double)\n"); + cout << pstr("Test of println(uint32_t)\n"); break; + + case 3: + cout << pstr("Test of printField(uint32_t, char)\n"); + break; + case 4: + cout << pstr("Test of println(float)\n"); + break; + + case 5: + cout << pstr("Test of printField(float, char)\n"); + break; } - file.truncate(0); - maxLatency = 0; - minLatency = 999999; - totalLatency = 0; + uint32_t t = millis(); for (uint16_t i = 0; i < N_PRINT; i++) { uint32_t m = micros(); @@ -90,10 +102,21 @@ void loop() { break; case 2: - file.println((double)0.01*i); + file.println(12345678UL + i); + break; + + case 3: + file.printField(12345678UL + i, '\n'); + break; + + case 4: + file.println((float)0.01*i); + break; + + case 5: + file.printField((float)0.01*i, '\n'); break; } - if (file.writeError) { error("write failed"); } @@ -102,7 +125,7 @@ void loop() { if (minLatency > m) minLatency = m; totalLatency += m; } - file.sync(); + file.close(); t = millis() - t; double s = file.fileSize(); cout << pstr("Time ") << 0.001*t << pstr(" sec\n"); @@ -113,7 +136,5 @@ void loop() { cout << pstr(" usec, Avg Latency: "); cout << totalLatency/N_PRINT << pstr(" usec\n\n"); } - file.close(); cout << pstr("Done!\n\n"); } - diff --git a/SdFat/examples/QuickStart/QuickStart.ino b/SdFat/examples/QuickStart/QuickStart.ino index 8a045b93..c57f1941 100644 --- a/SdFat/examples/QuickStart/QuickStart.ino +++ b/SdFat/examples/QuickStart/QuickStart.ino @@ -37,7 +37,7 @@ void cardOrSpeed() { void reformatMsg() { cout << pstr("Try reformatting the card. For best results use\n"); cout << pstr("the SdFormatter sketch in SdFat/examples or download\n"); - cout << pstr("and use SDFormatter from www.sdcard.org/consumer.\n"); + cout << pstr("and use SDFormatter from www.sdcard.org/downloads.\n"); } void setup() { diff --git a/SdFat/examples/SdInfo/SdInfo.ino b/SdFat/examples/SdInfo/SdInfo.ino index 52fda4f9..2b933dc4 100644 --- a/SdFat/examples/SdInfo/SdInfo.ino +++ b/SdFat/examples/SdInfo/SdInfo.ino @@ -101,6 +101,13 @@ uint8_t partDmp() { sdErrorMsg("read MBR failed"); return false; } + for (uint8_t ip = 1; ip < 5; ip++) { + part_t *pt = &p->mbr.part[ip - 1]; + if ((pt->boot & 0X7F) != 0 || pt->firstSector > cardSize) { + cout << pstr("\nNo MBR. Assuming Super Floppy format.\n"); + return true; + } + } cout << pstr("\nSD Partition Table\n"); cout << pstr("part,boot,type,start,length\n"); for (uint8_t ip = 1; ip < 5; ip++) { @@ -188,6 +195,12 @@ void loop() { } if (!cidDmp()) return; if (!csdDmp()) return; + uint32_t ocr; + if (!card.readOCR(&ocr)) { + sdErrorMsg("\nreadOCR failed"); + return; + } + cout << pstr("OCR: ") << hex << ocr << dec << endl; if (!partDmp()) return; if (!vol.init(&card)) { sdErrorMsg("\nvol.init failed"); diff --git a/SdFat/examples/StdioBench/StdioBench.ino b/SdFat/examples/StdioBench/StdioBench.ino index 82ba24bb..907691ed 100644 --- a/SdFat/examples/StdioBench/StdioBench.ino +++ b/SdFat/examples/StdioBench/StdioBench.ino @@ -1,6 +1,5 @@ - +// Benchmark comparing SdFile and StdioStream. #include -#include // Define PRINT_FIELD nonzero to use printField. #define PRINT_FIELD 0 diff --git a/SdFat/examples/StreamParseInt/StreamParseInt.ino b/SdFat/examples/StreamParseInt/StreamParseInt.ino new file mode 100644 index 00000000..e09777fc --- /dev/null +++ b/SdFat/examples/StreamParseInt/StreamParseInt.ino @@ -0,0 +1,34 @@ +// Simple demo of the Stream parsInt() member function. +#include + +// SD card chip select pin - Modify the value of csPin for your SD module. +const uint8_t csPin = 10; + +SdFat SD; +File file; +//------------------------------------------------------------------------------ +void setup() { + Serial.begin(9600); + + // Initialize the SD. + if (!SD.begin(csPin)) { + Serial.println(F("begin error")); + return; + } + // Create and open the file. Use flag to truncate an existing file. + if (!file.open("stream.txt", O_RDWR|O_CREAT|O_TRUNC)) { + Serial.println(F("open error")); + return; + } + // Write a test number to the file. + file.println("12345"); + + // Rewind the file and read the number with parseInt(). + file.rewind(); + int i = file.parseInt(); + Serial.print(F("parseInt: ")); + Serial.println(i); + file.close(); +} + +void loop() {} diff --git a/SdFat/examples/cin_cout/cin_cout.ino b/SdFat/examples/cin_cout/cin_cout.ino index 1cc752c5..ef2ea2bd 100644 --- a/SdFat/examples/cin_cout/cin_cout.ino +++ b/SdFat/examples/cin_cout/cin_cout.ino @@ -6,7 +6,7 @@ // create serial output stream ArduinoOutStream cout(Serial); -// input buffer for line +// input line buffer char cinBuf[40]; // create serial input stream diff --git a/SdFat/ostream.h b/SdFat/ostream.h index 039d65db..8591b40c 100644 --- a/SdFat/ostream.h +++ b/SdFat/ostream.h @@ -175,7 +175,7 @@ class ostream : public virtual ios { * \return the stream */ ostream &operator<< (long arg) { // NOLINT - putNum(arg); + putNum((int32_t)arg); return *this; } /** Output unsigned long @@ -183,7 +183,7 @@ class ostream : public virtual ios { * \return the stream */ ostream &operator<< (unsigned long arg) { // NOLINT - putNum(arg); + putNum((uint32_t)arg); return *this; } /** Output pointer diff --git a/SdFat/utility/DigitalPin.h b/SdFat/utility/DigitalPin.h index a2d2faee..92bfd2f8 100644 --- a/SdFat/utility/DigitalPin.h +++ b/SdFat/utility/DigitalPin.h @@ -27,6 +27,62 @@ */ #ifndef DigitalPin_h #define DigitalPin_h +#include +#ifdef __arm__ +#ifdef CORE_TEENSY +//------------------------------------------------------------------------------ +/** read pin value + * @param[in] pin Arduino pin number + * @return value read + */ +static inline __attribute__((always_inline)) +bool fastDigitalRead(uint8_t pin) { + return *portInputRegister(pin); +} +//------------------------------------------------------------------------------ +/** Set pin value + * @param[in] pin Arduino pin number + * @param[in] level value to write + */ +static inline __attribute__((always_inline)) +void fastDigitalWrite(uint8_t pin, bool value) { + if (value) { + *portSetRegister(pin) = 1; + } else { + *portClearRegister(pin) = 1; + } +} +#else // CORE_TEENSY +//------------------------------------------------------------------------------ +/** read pin value + * @param[in] pin Arduino pin number + * @return value read + */ +static inline __attribute__((always_inline)) +bool fastDigitalRead(uint8_t pin){ + return g_APinDescription[pin].pPort->PIO_PDSR & g_APinDescription[pin].ulPin; +} +//------------------------------------------------------------------------------ +/** Set pin value + * @param[in] pin Arduino pin number + * @param[in] level value to write + */ +static inline __attribute__((always_inline)) +void fastDigitalWrite(uint8_t pin, bool value){ + if(value) { + g_APinDescription[pin].pPort->PIO_SODR = g_APinDescription[pin].ulPin; + } else { + g_APinDescription[pin].pPort->PIO_CODR = g_APinDescription[pin].ulPin; + } +} +#endif // CORE_TEENSY +//------------------------------------------------------------------------------ +inline void fastDigitalToggle(uint8_t pin) { + fastDigitalWrite(pin, !fastDigitalRead(pin)); + } +//------------------------------------------------------------------------------ +inline void fastPinMode(uint8_t pin, bool mode) {pinMode(pin, mode);} +#else // __arm__ #include #include //------------------------------------------------------------------------------ @@ -152,6 +208,8 @@ static const pin_map_t pinMap[] = { || defined(__AVR_ATmega32__)\ || defined(__AVR_ATmega324__)\ || defined(__AVR_ATmega16__) + +#ifdef defined(VARIANT_MIGHTY) // Mighty Layout static const pin_map_t pinMap[] = { {&DDRB, &PINB, &PORTB, 0}, // B0 0 @@ -187,6 +245,81 @@ static const pin_map_t pinMap[] = { {&DDRA, &PINA, &PORTA, 6}, // A6 30 {&DDRA, &PINA, &PORTA, 7} // A7 31 }; +#elif defined(VARIANT_BOBUINO) +// Bobuino Layout +static const pin_map_t pinMap[] = { + {&DDRD, &PIND, &PORTD, 0}, // D0 0 + {&DDRD, &PIND, &PORTD, 1}, // D1 1 + {&DDRD, &PIND, &PORTD, 2}, // D2 2 + {&DDRD, &PIND, &PORTD, 3}, // D3 3 + {&DDRB, &PINB, &PORTB, 0}, // B0 4 + {&DDRB, &PINB, &PORTB, 1}, // B1 5 + {&DDRB, &PINB, &PORTB, 2}, // B2 6 + {&DDRB, &PINB, &PORTB, 3}, // B3 7 + {&DDRD, &PIND, &PORTD, 5}, // D5 8 + {&DDRD, &PIND, &PORTD, 6}, // D6 9 + {&DDRB, &PINB, &PORTB, 4}, // B4 10 + {&DDRB, &PINB, &PORTB, 5}, // B5 11 + {&DDRB, &PINB, &PORTB, 6}, // B6 12 + {&DDRB, &PINB, &PORTB, 7}, // B7 13 + {&DDRA, &PINA, &PORTA, 7}, // A7 14 + {&DDRA, &PINA, &PORTA, 6}, // A6 15 + {&DDRA, &PINA, &PORTA, 5}, // A5 16 + {&DDRA, &PINA, &PORTA, 4}, // A4 17 + {&DDRA, &PINA, &PORTA, 3}, // A3 18 + {&DDRA, &PINA, &PORTA, 2}, // A2 19 + {&DDRA, &PINA, &PORTA, 1}, // A1 20 + {&DDRA, &PINA, &PORTA, 0}, // A0 21 + {&DDRC, &PINC, &PORTC, 0}, // C0 22 + {&DDRC, &PINC, &PORTC, 1}, // C1 23 + {&DDRC, &PINC, &PORTC, 2}, // C2 24 + {&DDRC, &PINC, &PORTC, 3}, // C3 25 + {&DDRC, &PINC, &PORTC, 4}, // C4 26 + {&DDRC, &PINC, &PORTC, 5}, // C5 27 + {&DDRC, &PINC, &PORTC, 6}, // C6 28 + {&DDRC, &PINC, &PORTC, 7}, // C7 29 + {&DDRD, &PIND, &PORTD, 4}, // D4 30 + {&DDRD, &PIND, &PORTD, 7} // D7 31 +}; +#elif defined(VARIANT_STANDARD) +// Standard Layout +static const pin_map_t pinMap[] = { + {&DDRB, &PINB, &PORTB, 0}, // B0 0 + {&DDRB, &PINB, &PORTB, 1}, // B1 1 + {&DDRB, &PINB, &PORTB, 2}, // B2 2 + {&DDRB, &PINB, &PORTB, 3}, // B3 3 + {&DDRB, &PINB, &PORTB, 4}, // B4 4 + {&DDRB, &PINB, &PORTB, 5}, // B5 5 + {&DDRB, &PINB, &PORTB, 6}, // B6 6 + {&DDRB, &PINB, &PORTB, 7}, // B7 7 + {&DDRD, &PIND, &PORTD, 0}, // D0 8 + {&DDRD, &PIND, &PORTD, 1}, // D1 9 + {&DDRD, &PIND, &PORTD, 2}, // D2 10 + {&DDRD, &PIND, &PORTD, 3}, // D3 11 + {&DDRD, &PIND, &PORTD, 4}, // D4 12 + {&DDRD, &PIND, &PORTD, 5}, // D5 13 + {&DDRD, &PIND, &PORTD, 6}, // D6 14 + {&DDRD, &PIND, &PORTD, 7}, // D7 15 + {&DDRC, &PINC, &PORTC, 0}, // C0 16 + {&DDRC, &PINC, &PORTC, 1}, // C1 17 + {&DDRC, &PINC, &PORTC, 2}, // C2 18 + {&DDRC, &PINC, &PORTC, 3}, // C3 19 + {&DDRC, &PINC, &PORTC, 4}, // C4 20 + {&DDRC, &PINC, &PORTC, 5}, // C5 21 + {&DDRC, &PINC, &PORTC, 6}, // C6 22 + {&DDRC, &PINC, &PORTC, 7}, // C7 23 + {&DDRA, &PINA, &PORTA, 7}, // A7 24 + {&DDRA, &PINA, &PORTA, 6}, // A6 25 + {&DDRA, &PINA, &PORTA, 5}, // A5 26 + {&DDRA, &PINA, &PORTA, 4}, // A4 27 + {&DDRA, &PINA, &PORTA, 3}, // A3 28 + {&DDRA, &PINA, &PORTA, 2}, // A2 29 + {&DDRA, &PINA, &PORTA, 1}, // A1 30 + {&DDRA, &PINA, &PORTA, 0} // A0 31 +}; +#else // VARIANT_MIGHTY +#error Undefined variant 1284, 644, 324, 64, 32 +#endif // VARIANT_MIGHTY //------------------------------------------------------------------------------ #elif defined(__AVR_ATmega32U4__) #ifdef CORE_TEENSY @@ -310,6 +443,7 @@ static const pin_map_t pinMap[] = { #else // CPU type #error unknown CPU type #endif // CPU type +//------------------------------------------------------------------------------ /** count of pins */ static const uint8_t digitalPinCount = sizeof(pinMap)/sizeof(pin_map_t); //============================================================================== @@ -398,6 +532,8 @@ void fastPinMode(uint8_t pin, bool mode) { badPinCheck(pin); fastBitWriteSafe(pinMap[pin].ddr, pinMap[pin].bit, mode); } + +#endif // __arm__ //------------------------------------------------------------------------------ /** set pin configuration * @param[in] pin Arduino pin number @@ -413,7 +549,7 @@ void fastPinConfig(uint8_t pin, bool mode, bool level) { //============================================================================== /** * @class DigitalPin - * @brief Fast AVR digital port I/O + * @brief Fast digital port I/O */ template class DigitalPin { diff --git a/SdFat/utility/SoftSPI.h b/SdFat/utility/SoftSPI.h index 29c1a3bb..036fad66 100644 --- a/SdFat/utility/SoftSPI.h +++ b/SdFat/utility/SoftSPI.h @@ -49,8 +49,8 @@ const bool SCK_MODE = true; template class SoftSPI { public: - //----------------------------------------------------------------------------- - /** Initialize SoftSPI pins. */ + //---------------------------------------------------------------------------- + /** Initialize SoftSPI pins. */ void begin() { fastPinConfig(MisoPin, MISO_MODE, MISO_LEVEL); fastPinConfig(MosiPin, MOSI_MODE, !MODE_CPHA(Mode)); @@ -106,6 +106,7 @@ class SoftSPI { transferBit(0, &rxData, txData); return rxData; } + private: //---------------------------------------------------------------------------- inline __attribute__((always_inline)) @@ -117,7 +118,8 @@ class SoftSPI { if (MODE_CPHA(Mode)) { fastDigitalWrite(SckPin, !MODE_CPOL(Mode)); } - nop;nop; + nop; + nop; fastDigitalWrite(SckPin, MODE_CPHA(Mode) ? MODE_CPOL(Mode) : !MODE_CPOL(Mode)); if (fastDigitalRead(MisoPin)) *data |= 1 << bit; @@ -134,7 +136,8 @@ class SoftSPI { fastDigitalWrite(MosiPin, data & (1 << bit)); fastDigitalWrite(SckPin, MODE_CPHA(Mode) ? MODE_CPOL(Mode) : !MODE_CPOL(Mode)); - nop;nop; + nop; + nop; if (!MODE_CPHA(Mode)) { fastDigitalWrite(SckPin, MODE_CPOL(Mode)); } @@ -156,4 +159,4 @@ class SoftSPI { //---------------------------------------------------------------------------- }; #endif // SoftSPI_h -/** @} */ \ No newline at end of file +/** @} */ diff --git a/SoftwareSPI.txt b/SoftwareSPI.txt index b7b200df..71e8b65a 100644 --- a/SoftwareSPI.txt +++ b/SoftwareSPI.txt @@ -1,8 +1,49 @@ -Features have been added to support an unmodified Adafruit GPS Shield -or Datalogging Shield on an Arduino Mega or Leonardo. +Software SPI is now supported on AVR, Due, and Teensy 3.x boards. -Define MEGA_SOFT_SPI to be non-zero in SdFatConfig.h to use software SPI -on Mega Arduinos. Pins used are SS 10, MOSI 11, MISO 12, and SCK 13. +Edit these variables in SdFatConfig.h to enable Software SPI. + +//------------------------------------------------------------------------------ +/** + * Define AVR_SOF_SPI nonzero to use software SPI on all AVR Arduinos. + */ +#define AVR_SOFT_SPI 0 +//------------------------------------------------------------------------------ +/** + * Define DUE_SOFT_SPI nonzero to use software SPI on Due Arduinos. + */ +#define DUE_SOFT_SPI 0 +//------------------------------------------------------------------------------ + +/** + * Define LEONARDO_SOFT_SPI nonzero to use software SPI on Leonardo Arduinos. + * LEONARDO_SOFT_SPI allows an unmodified 328 Shield to be used + * on Leonardo Arduinos. + */ +#define LEONARDO_SOFT_SPI 0 +//------------------------------------------------------------------------------ +/** + * Define MEGA_SOFT_SPI nonzero to use software SPI on Mega Arduinos. + * MEGA_SOFT_SPI allows an unmodified 328 Shield to be used + * on Mega Arduinos. + */ +#define MEGA_SOFT_SPI 0 +//------------------------------------------------------------------------------ +/** + * Set TEENSY3_SOFT_SPI nonzero to use software SPI on Teensy 3.x boards. + */ +#define TEENSY3_SOFT_SPI 0 +//------------------------------------------------------------------------------ +/** + * Define software SPI pins. Default allows Uno shields to be used on other + * boards. + */ +// define software SPI pins +/** Default Software SPI chip select pin */ +uint8_t const SOFT_SPI_CS_PIN = 10; +/** Software SPI Master Out Slave In pin */ +uint8_t const SOFT_SPI_MOSI_PIN = 11; +/** Software SPI Master In Slave Out pin */ +uint8_t const SOFT_SPI_MISO_PIN = 12; +/** Software SPI Clock pin */ +uint8_t const SOFT_SPI_SCK_PIN = 13; -For Leonardo define LEONARDO_SOFT_SPI non-zero. -Hardware SPI will still be used on 328 Arduinos. diff --git a/changes.txt b/changes.txt index 671d08c2..0285461c 100644 --- a/changes.txt +++ b/changes.txt @@ -1,3 +1,27 @@ +25 Oct 2014 + +Added File class for compatibility with the Arduino SD.h library + +Added StreamParseInt example. + +23 Oct 2014 + +Added Read SD OCR register. + +SdInfo example now prints OCR register. + +05 Sep 2014 + +Faster SdBaseFile::printField(); + +Added SdBaseFile::printField(float value, char term, uint8_t prec); + +24 Aug 2014 + +Added support for Software SPI on Due and Teensy 3.1 + +Added support for SPI transactions. + 05 Aug 2014 New examples. diff --git a/html/_arduino_stream_8h.html b/html/_arduino_stream_8h.html index ed730d3f..f77db2af 100644 --- a/html/_arduino_stream_8h.html +++ b/html/_arduino_stream_8h.html @@ -3,7 +3,7 @@ - + SdFat: Arduino/libraries/SdFat/ArduinoStream.h File Reference @@ -25,11 +25,10 @@ - + - + + +
+
+ + + + +
#define SD_FILE_USES_STREAM   0
+
+

Set SD_FILE_USES_STREAM nonzero to use Stream instead of Print for SdFile. Using Stream will use more flash and may cause compatibility problems with code written for older versions of SdFat.

+ +
+
+ +
+
+ + + + +
#define TEENSY3_SOFT_SPI   0
+
+

Set TEENSY3_SOFT_SPI nonzero to use software SPI on Teensy 3.x boards.

@@ -196,7 +283,7 @@
-

Force use of Arduino Standard SPI library if USE_ARDUINO_SPI_LIBRARY is nonzero.

+

Set USE_ARDUINO_SPI_LIBRARY nonzero to force use of Arduino Standard SPI library. This will override native and software SPI for all boards.

@@ -271,19 +358,6 @@

If USE_SERIAL_FOR_STD_OUT is zero, a small non-interrupt driven class is used to output messages to serial port zero. This allows an alternate Serial library like SerialPort to be used with SdFat.

You can redirect stdOut with SdFat::setStdOut(Print* stream) and get the current stream with SdFat::stdOut().

- - - -
-
- - - - -
#define USE_SOFTWARE_SPI   0
-
-

Set USE_SOFTWARE_SPI nonzero to always use software SPI on AVR.

-

Variable Documentation

@@ -296,7 +370,7 @@

Variable Documentation

-

Default Software SPI chip select pin

+

Define software SPI pins. Default allows Uno shields to be used on other boards.Default Software SPI chip select pin

@@ -355,9 +429,9 @@

Variable Documentation

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/_sd_fat_config_8h__dep__incl.png b/html/_sd_fat_config_8h__dep__incl.png index 3546c216..dfe5981b 100644 Binary files a/html/_sd_fat_config_8h__dep__incl.png and b/html/_sd_fat_config_8h__dep__incl.png differ diff --git a/html/_sd_fat_error_print_8cpp.html b/html/_sd_fat_error_print_8cpp.html deleted file mode 100644 index cabc280c..00000000 --- a/html/_sd_fat_error_print_8cpp.html +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - -SdFat: Arduino/libraries/SdFat/SdFatErrorPrint.cpp File Reference - - - - - - -
-
- - - - - - -
-
SdFat -
-
-
- - - - - -
-
-
-Functions
-
-
SdFatErrorPrint.cpp File Reference
-
-
-
#include <SdFat.h>
-
-Include dependency graph for SdFatErrorPrint.cpp:
-
-
- - -
-
- - - - - -

-Functions

static void pstrPrint (PGM_P str)
 
static void pstrPrintln (PGM_P str)
 
-

Function Documentation

- -
-
- - - - - -
- - - - - - - - -
static void pstrPrint (PGM_P str)
- 		-static
-
- -
-
- -
-
- - - - - -
- - - - - - - - -
static void pstrPrintln (PGM_P str)
- 		-static
-
- -
-
-
- -
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   -doxygen - 1.8.6 -
- - diff --git a/html/_sd_fat_error_print_8cpp__incl.png b/html/_sd_fat_error_print_8cpp__incl.png deleted file mode 100644 index abb8d554..00000000 Binary files a/html/_sd_fat_error_print_8cpp__incl.png and /dev/null differ diff --git a/html/_sd_fat_util_8cpp.html b/html/_sd_fat_util_8cpp.html deleted file mode 100644 index ce9eb399..00000000 --- a/html/_sd_fat_util_8cpp.html +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - -SdFat: Arduino/libraries/SdFat/SdFatUtil.cpp File Reference - - - - - - -
-
- - - - - - -
-
SdFat -
-
-
- - - - - -
-
-
-Variables
-
-
SdFatUtil.cpp File Reference
-
-
-
#include <stdlib.h>
-#include <SdFat.h>
-#include <SdFatUtil.h>
-
-Include dependency graph for SdFatUtil.cpp:
-
-
- - -
-
- - - - - -

-Variables

char * __brkval
 
char __bss_end
 
-

Variable Documentation

- -
-
- - - - -
char* __brkval
-
- -
-
- -
-
- - - - -
char __bss_end
-
- -
-
-
- -
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   -doxygen - 1.8.6 -
- - diff --git a/html/_sd_fat_util_8cpp__incl.png b/html/_sd_fat_util_8cpp__incl.png deleted file mode 100644 index 1d9fe62a..00000000 Binary files a/html/_sd_fat_util_8cpp__incl.png and /dev/null differ diff --git a/html/_sd_fat_util_8h.html b/html/_sd_fat_util_8h.html index 8baedf6d..00192953 100644 --- a/html/_sd_fat_util_8h.html +++ b/html/_sd_fat_util_8h.html @@ -3,7 +3,7 @@ - + SdFat: Arduino/libraries/SdFat/SdFatUtil.h File Reference @@ -25,11 +25,10 @@ - +
-Namespaces | Macros | Functions
@@ -57,27 +55,15 @@

Useful utility functions. More...

-
#include <SdFat.h>
+
#include <SdFat.h>
Include dependency graph for SdFatUtil.h:
- -
-
-This graph shows which files directly or indirectly include this file:
-
-
- - +
- - - -

-Namespaces

 SdFatUtil
 
@@ -87,15 +73,15 @@

Macros

#define PgmPrint(x)   SerialPrint_P(PSTR(x))
- + - + - + - + - +

Functions

int SdFatUtil::FreeRam ()
int SdFatUtil::FreeRam ()
 
void SdFatUtil::print_P (Print *pr, PGM_P str)
void SdFatUtil::print_P (Print *pr, PGM_P str)
 
void SdFatUtil::println_P (Print *pr, PGM_P str)
void SdFatUtil::println_P (Print *pr, PGM_P str)
 
void SdFatUtil::SerialPrint_P (PGM_P str)
void SdFatUtil::SerialPrint_P (PGM_P str)
 
void SdFatUtil::SerialPrintln_P (PGM_P str)
void SdFatUtil::SerialPrintln_P (PGM_P str)
 

Detailed Description

@@ -138,9 +124,9 @@
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/_sd_fat_util_8h__dep__incl.png b/html/_sd_fat_util_8h__dep__incl.png deleted file mode 100644 index 946a91b4..00000000 Binary files a/html/_sd_fat_util_8h__dep__incl.png and /dev/null differ diff --git a/html/_sd_fat_util_8h__incl.png b/html/_sd_fat_util_8h__incl.png index f1573384..2cddf1f6 100644 Binary files a/html/_sd_fat_util_8h__incl.png and b/html/_sd_fat_util_8h__incl.png differ diff --git a/html/_sd_fatmainpage_8h.html b/html/_sd_fatmainpage_8h.html deleted file mode 100644 index 010931b4..00000000 --- a/html/_sd_fatmainpage_8h.html +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - -SdFat: Arduino/libraries/SdFat/SdFatmainpage.h File Reference - - - - - - -
-
- - - - - - -
-
SdFat -
-
-
- - - - - -
-
-
-
SdFatmainpage.h File Reference
-
-
-
- -
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   -doxygen - 1.8.6 -
- - diff --git a/html/_sd_file_8cpp.html b/html/_sd_file_8cpp.html deleted file mode 100644 index 945c7952..00000000 --- a/html/_sd_file_8cpp.html +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - -SdFat: Arduino/libraries/SdFat/SdFile.cpp File Reference - - - - - - -
-
- - - - - - -
-
SdFat -
-
-
- - - - - -
-
-
-
SdFile.cpp File Reference
-
-
-
#include <SdFile.h>
-
-Include dependency graph for SdFile.cpp:
-
-
- - -
-
- -
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   -doxygen - 1.8.6 -
- - diff --git a/html/_sd_file_8cpp__incl.png b/html/_sd_file_8cpp__incl.png deleted file mode 100644 index 98c343bf..00000000 Binary files a/html/_sd_file_8cpp__incl.png and /dev/null differ diff --git a/html/_sd_file_8h.html b/html/_sd_file_8h.html index 0b48392a..1a95e0c9 100644 --- a/html/_sd_file_8h.html +++ b/html/_sd_file_8h.html @@ -3,7 +3,7 @@ - + SdFat: Arduino/libraries/SdFat/SdFile.h File Reference @@ -25,11 +25,10 @@
- +
-Classes
+Classes | +Macros
SdFile.h File Reference
-

SdFile class. +

SdFile class. More...

-
#include <SdBaseFile.h>
+
#include <limits.h>
+#include <SdBaseFile.h>
Include dependency graph for SdFile.h:
- +
This graph shows which files directly or indirectly include this file:
- +
+ + + - + +

Classes

class  File
 Arduino SD.h style File API. More...
 
class  SdFile
 SdBaseFile with Print. More...
 SdBaseFile with Arduino Stream. More...
 
+ + + + +

+Macros

#define FILE_READ   O_READ
 
#define FILE_WRITE   (O_RDWR | O_CREAT | O_AT_END)
 

Detailed Description

-

SdFile class.

-
+

SdFile class.

+

Macro Definition Documentation

+ +
+
+ + + + +
#define FILE_READ   O_READ
+
+

Arduino SD.h style flag for open for read.

+ +
+
+ +
+
+ + + + +
#define FILE_WRITE   (O_RDWR | O_CREAT | O_AT_END)
+
+

Arduino SD.h style flag for open at EOF for read/write with create.

+ +
+
+
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/_sd_file_8h__dep__incl.png b/html/_sd_file_8h__dep__incl.png index edf47f2e..a8e863f9 100644 Binary files a/html/_sd_file_8h__dep__incl.png and b/html/_sd_file_8h__dep__incl.png differ diff --git a/html/_sd_file_8h__incl.png b/html/_sd_file_8h__incl.png index a8ce42d6..410d1a6f 100644 Binary files a/html/_sd_file_8h__incl.png and b/html/_sd_file_8h__incl.png differ diff --git a/html/_sd_spi_8h.html b/html/_sd_spi_8h.html index d8bd311d..ec62a17a 100644 --- a/html/_sd_spi_8h.html +++ b/html/_sd_spi_8h.html @@ -3,7 +3,7 @@ - + SdFat: Arduino/libraries/SdFat/SdSpi.h File Reference @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/_sd_spi_8h__dep__incl.png b/html/_sd_spi_8h__dep__incl.png index 1ee96f01..384d6000 100644 Binary files a/html/_sd_spi_8h__dep__incl.png and b/html/_sd_spi_8h__dep__incl.png differ diff --git a/html/_sd_spi_a_v_r_8cpp.html b/html/_sd_spi_a_v_r_8cpp.html deleted file mode 100644 index 02f885c0..00000000 --- a/html/_sd_spi_a_v_r_8cpp.html +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - -SdFat: Arduino/libraries/SdFat/SdSpiAVR.cpp File Reference - - - - - - -
-
- - - - - - -
-
SdFat -
-
-
- - - - - -
-
-
-
SdSpiAVR.cpp File Reference
-
-
-
#include <SdSpi.h>
-
-Include dependency graph for SdSpiAVR.cpp:
-
-
- - -
-
- -
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   -doxygen - 1.8.6 -
- - diff --git a/html/_sd_spi_a_v_r_8cpp__incl.png b/html/_sd_spi_a_v_r_8cpp__incl.png deleted file mode 100644 index 2985f2ce..00000000 Binary files a/html/_sd_spi_a_v_r_8cpp__incl.png and /dev/null differ diff --git a/html/_sd_spi_arduino_8cpp.html b/html/_sd_spi_arduino_8cpp.html deleted file mode 100644 index e710a3d5..00000000 --- a/html/_sd_spi_arduino_8cpp.html +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - -SdFat: Arduino/libraries/SdFat/SdSpiArduino.cpp File Reference - - - - - - -
-
- - - - - - -
-
SdFat -
-
-
- - - - - -
-
-
-
SdSpiArduino.cpp File Reference
-
-
-
#include <SdSpi.h>
-
-Include dependency graph for SdSpiArduino.cpp:
-
-
- - -
-
- -
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   -doxygen - 1.8.6 -
- - diff --git a/html/_sd_spi_arduino_8cpp__incl.png b/html/_sd_spi_arduino_8cpp__incl.png deleted file mode 100644 index 089e1e7a..00000000 Binary files a/html/_sd_spi_arduino_8cpp__incl.png and /dev/null differ diff --git a/html/_sd_spi_m_k20_d_x128_8cpp.html b/html/_sd_spi_m_k20_d_x128_8cpp.html deleted file mode 100644 index 864f6eef..00000000 --- a/html/_sd_spi_m_k20_d_x128_8cpp.html +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - -SdFat: Arduino/libraries/SdFat/SdSpiMK20DX128.cpp File Reference - - - - - - -
-
- - - - - - -
-
SdFat -
-
-
- - - - - -
-
-
-
SdSpiMK20DX128.cpp File Reference
-
-
-
#include <SdSpi.h>
-
-Include dependency graph for SdSpiMK20DX128.cpp:
-
-
- - -
-
- -
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   -doxygen - 1.8.6 -
- - diff --git a/html/_sd_spi_m_k20_d_x128_8cpp__incl.png b/html/_sd_spi_m_k20_d_x128_8cpp__incl.png deleted file mode 100644 index 880369d9..00000000 Binary files a/html/_sd_spi_m_k20_d_x128_8cpp__incl.png and /dev/null differ diff --git a/html/_sd_spi_s_a_m3_x_8cpp.html b/html/_sd_spi_s_a_m3_x_8cpp.html deleted file mode 100644 index 7560272f..00000000 --- a/html/_sd_spi_s_a_m3_x_8cpp.html +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - -SdFat: Arduino/libraries/SdFat/SdSpiSAM3X.cpp File Reference - - - - - - -
-
- - - - - - -
-
SdFat -
-
-
- - - - - -
-
-
-
SdSpiSAM3X.cpp File Reference
-
-
-
#include <SdSpi.h>
-
-Include dependency graph for SdSpiSAM3X.cpp:
-
-
- - -
-
- -
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   -doxygen - 1.8.6 -
- - diff --git a/html/_sd_spi_s_a_m3_x_8cpp__incl.png b/html/_sd_spi_s_a_m3_x_8cpp__incl.png deleted file mode 100644 index cfbc026f..00000000 Binary files a/html/_sd_spi_s_a_m3_x_8cpp__incl.png and /dev/null differ diff --git a/html/_sd_stream_8cpp.html b/html/_sd_stream_8cpp.html deleted file mode 100644 index cbf32267..00000000 --- a/html/_sd_stream_8cpp.html +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - -SdFat: Arduino/libraries/SdFat/SdStream.cpp File Reference - - - - - - -
-
- - - - - - -
-
SdFat -
-
-
- - - - - -
-
-
-
SdStream.cpp File Reference
-
-
-
#include <SdFat.h>
-
-Include dependency graph for SdStream.cpp:
-
-
- - -
-
- -
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   -doxygen - 1.8.6 -
- - diff --git a/html/_sd_stream_8cpp__incl.png b/html/_sd_stream_8cpp__incl.png deleted file mode 100644 index 4de78af7..00000000 Binary files a/html/_sd_stream_8cpp__incl.png and /dev/null differ diff --git a/html/_sd_stream_8h.html b/html/_sd_stream_8h.html index cd3e55b8..0164f2ef 100644 --- a/html/_sd_stream_8h.html +++ b/html/_sd_stream_8h.html @@ -3,7 +3,7 @@ - + SdFat: Arduino/libraries/SdFat/SdStream.h File Reference @@ -25,11 +25,10 @@ - + - + - +
-
#include <limits.h>
-#include <Arduino.h>
-#include <SdFat.h>
-#include <SdBaseFile.h>
-#include <stdio.h>
+ +

StdioStream class. +More...

+
#include <limits.h>
+#include <Arduino.h>
+#include <SdFat.h>
+#include <SdBaseFile.h>
+#include <stdio.h>
Include dependency graph for StdioStream.h:
- +
This graph shows which files directly or indirectly include this file:
- +
- +

Classes

class  StdioStream
 StdioStream implements a minimal stdio stream. More...
 StdioStream implements a minimal stdio stream. More...
 

@@ -101,7 +103,7 @@

 

Detailed Description

-

StdioStream class

+

StdioStream class.

Macro Definition Documentation

@@ -198,9 +200,9 @@

Variable Documentation

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/_stdio_stream_8h__dep__incl.png b/html/_stdio_stream_8h__dep__incl.png index 7ac0598c..ff83845b 100644 Binary files a/html/_stdio_stream_8h__dep__incl.png and b/html/_stdio_stream_8h__dep__incl.png differ diff --git a/html/_stdio_stream_8h__incl.png b/html/_stdio_stream_8h__incl.png index dfe26e68..183820d6 100644 Binary files a/html/_stdio_stream_8h__incl.png and b/html/_stdio_stream_8h__incl.png differ diff --git a/html/annotated.html b/html/annotated.html index aefb7dde..3d31fabf 100644 --- a/html/annotated.html +++ b/html/annotated.html @@ -3,7 +3,7 @@ - + SdFat: Class List @@ -25,11 +25,10 @@
- + - + - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_arduino_in_stream.html b/html/class_arduino_in_stream.html index 587597c7..406ad2f7 100644 --- a/html/class_arduino_in_stream.html +++ b/html/class_arduino_in_stream.html @@ -3,7 +3,7 @@ - + SdFat: ArduinoInStream Class Reference @@ -25,11 +25,10 @@
- +

enumerated type for the direction of relative seeks

- - -
Enumerator
beg  +
Enumerator
beg 

seek relative to the beginning of the stream

cur  +
cur 

seek relative to the current stream position

end  +
end 

seek relative to the end of the stream

@@ -462,8 +461,7 @@

Constructor & Destructor Documentation

-

Constructor

-
Parameters
+

Constructor

Parameters
@@ -625,8 +623,7 @@

Member Function Documentation

[in]hwshardware stream
[in]bufbuffer for input line
-

Set fill character

-
Parameters
+

Set fill character

Parameters
[in]cnew fill character
@@ -681,8 +678,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flag
@@ -990,8 +986,7 @@

Member Function Documentation

-

Initialize an ibufstream

-
Parameters
+

Initialize an ibufstream

Parameters
[in]strpointer to string to be parsed Warning: The string will not be copied so must stay in scope.
@@ -1069,8 +1064,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1101,8 +1095,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1133,8 +1126,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1165,8 +1157,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -1197,8 +1188,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -1229,8 +1219,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -1261,8 +1250,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -1293,8 +1281,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -1325,8 +1312,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -1357,8 +1343,7 @@

Member Function Documentation

-

Extract a value of type bool.

-
Parameters
+

Extract a value of type bool.

Parameters
[out]arglocation to store the value.
@@ -1389,8 +1374,7 @@

Member Function Documentation

-

Extract a value of type short.

-
Parameters
+

Extract a value of type short.

Parameters
[out]arglocation to store the value.
@@ -1421,8 +1405,7 @@

Member Function Documentation

-

Extract a value of type unsigned short.

-
Parameters
+

Extract a value of type unsigned short.

Parameters
[out]arglocation to store the value.
@@ -1453,8 +1436,7 @@

Member Function Documentation

-

Extract a value of type int.

-
Parameters
+

Extract a value of type int.

Parameters
[out]arglocation to store the value.
@@ -1485,8 +1467,7 @@

Member Function Documentation

-

Extract a value of type unsigned int.

-
Parameters
+

Extract a value of type unsigned int.

Parameters
[out]arglocation to store the value.
@@ -1517,8 +1498,7 @@

Member Function Documentation

-

Extract a value of type long.

-
Parameters
+

Extract a value of type long.

Parameters
[out]arglocation to store the value.
@@ -1549,8 +1529,7 @@

Member Function Documentation

-

Extract a value of type unsigned long.

-
Parameters
+

Extract a value of type unsigned long.

Parameters
[out]arglocation to store the value.
@@ -1581,8 +1560,7 @@

Member Function Documentation

-

Extract a value of type double.

-
Parameters
+

Extract a value of type double.

Parameters
[out]arglocation to store the value.
@@ -1613,8 +1591,7 @@

Member Function Documentation

-

Extract a value of type float.

-
Parameters
+

Extract a value of type float.

Parameters
[out]arglocation to store the value.
@@ -1645,8 +1622,7 @@

Member Function Documentation

-

Extract a value of type void*.

-
Parameters
+

Extract a value of type void*.

Parameters
[out]arglocation to store the value.
@@ -1726,8 +1702,7 @@

Member Function Documentation

-

set precision

-
Parameters
+

set precision

Parameters
[in]nnew precision
@@ -1806,8 +1781,7 @@

Member Function Documentation

-

Set the stream position

-
Parameters
+

Set the stream position

Parameters
[in]posThe absolute position in which to move the read pointer.
@@ -1891,8 +1865,7 @@

Member Function Documentation

-

Internal - do not use.

-
Parameters
+

Internal - do not use.

Parameters
@@ -1924,8 +1897,7 @@

Member Function Documentation

[in]off
[in]way
-

Internal - do not use.

-
Parameters
+

Internal - do not use.

Parameters
[in]pos
@@ -1956,8 +1928,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flags to be or'ed in
@@ -1998,8 +1969,7 @@

Member Function Documentation

-

modify format flags

-
Parameters
+

modify format flags

Parameters
@@ -2110,8 +2080,7 @@

Member Function Documentation

[in]maskflags to be removed
[in]flflags to be set after mask bits have been cleared
-

clear format flags

-
Parameters
+

clear format flags

Parameters
[in]flflags to be cleared
@@ -2166,8 +2135,7 @@

Member Function Documentation

-

set width

-
Parameters
+

set width

Parameters
[in]nnew width
@@ -2688,9 +2656,9 @@

Member Data Documentation

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_arduino_out_stream-members.html b/html/class_arduino_out_stream-members.html index ae3e3fdf..607de1d4 100644 --- a/html/class_arduino_out_stream-members.html +++ b/html/class_arduino_out_stream-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@
- +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_arduino_out_stream.html b/html/class_arduino_out_stream.html index c15d5498..4a4f9944 100644 --- a/html/class_arduino_out_stream.html +++ b/html/class_arduino_out_stream.html @@ -3,7 +3,7 @@ - + SdFat: ArduinoOutStream Class Reference @@ -25,11 +25,10 @@ - +

enumerated type for the direction of relative seeks

- - -
Enumerator
beg  +
Enumerator
beg 

seek relative to the beginning of the stream

cur  +
cur 

seek relative to the current stream position

end  +
end 

seek relative to the end of the stream

@@ -589,8 +588,7 @@

Member Function Documentation

-

Set fill character

-
Parameters
+

Set fill character

Parameters
[in]cnew fill character
@@ -645,8 +643,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flag
@@ -700,8 +697,7 @@

Member Function Documentation

-

Flushes the buffer associated with this stream. The flush function calls the sync function of the associated file.

-
Returns
A reference to the ostream object.
+

Flushes the buffer associated with this stream. The flush function calls the sync function of the associated file.

Returns
A reference to the ostream object.
@@ -798,8 +794,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -830,8 +825,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -862,8 +856,7 @@

Member Function Documentation

-

Output bool

-
Parameters
+

Output bool

Parameters
[in]argvalue to output
@@ -894,8 +887,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -926,8 +918,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -958,8 +949,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -990,8 +980,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1022,8 +1011,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1054,8 +1042,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1086,8 +1073,7 @@

Member Function Documentation

-

Output double

-
Parameters
+

Output double

Parameters
[in]argvalue to output
@@ -1118,8 +1104,7 @@

Member Function Documentation

-

Output float

-
Parameters
+

Output float

Parameters
[in]argvalue to output
@@ -1150,8 +1135,7 @@

Member Function Documentation

-

Output signed short

-
Parameters
+

Output signed short

Parameters
[in]argvalue to output
@@ -1182,8 +1166,7 @@

Member Function Documentation

-

Output unsigned short

-
Parameters
+

Output unsigned short

Parameters
[in]argvalue to output
@@ -1214,8 +1197,7 @@

Member Function Documentation

-

Output signed int

-
Parameters
+

Output signed int

Parameters
[in]argvalue to output
@@ -1246,8 +1228,7 @@

Member Function Documentation

-

Output unsigned int

-
Parameters
+

Output unsigned int

Parameters
[in]argvalue to output
@@ -1278,8 +1259,7 @@

Member Function Documentation

-

Output signed long

-
Parameters
+

Output signed long

Parameters
[in]argvalue to output
@@ -1310,8 +1290,7 @@

Member Function Documentation

-

Output unsigned long

-
Parameters
+

Output unsigned long

Parameters
[in]argvalue to output
@@ -1342,8 +1321,7 @@

Member Function Documentation

-

Output pointer

-
Parameters
+

Output pointer

Parameters
[in]argvalue to output
@@ -1374,8 +1352,7 @@

Member Function Documentation

-

Output a string from flash using the pstr() macro

-
Parameters
+

Output a string from flash using the pstr() macro

Parameters
[in]argpgm struct pointing to string
@@ -1406,8 +1383,7 @@

Member Function Documentation

-

Output a string from flash using the Arduino F() macro.

-
Parameters
+

Output a string from flash using the Arduino F() macro.

Parameters
[in]argpointing to flash string
@@ -1462,8 +1438,7 @@

Member Function Documentation

-

set precision

-
Parameters
+

set precision

Parameters
[in]nnew precision
@@ -1551,8 +1526,7 @@

Member Function Documentation

-

Set the stream position

-
Parameters
+

Set the stream position

Parameters
[in]posThe absolute position in which to move the write pointer.
@@ -1626,8 +1600,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flags to be or'ed in
@@ -1668,8 +1641,7 @@

Member Function Documentation

-

modify format flags

-
Parameters
+

modify format flags

Parameters
@@ -1756,8 +1728,7 @@

Member Function Documentation

[in]maskflags to be removed
[in]flflags to be set after mask bits have been cleared
-

clear format flags

-
Parameters
+

clear format flags

Parameters
[in]flflags to be cleared
@@ -1812,8 +1783,7 @@

Member Function Documentation

-

set width

-
Parameters
+

set width

Parameters
[in]nnew width
@@ -2334,9 +2304,9 @@

Member Data Documentation

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_file-members.html b/html/class_file-members.html new file mode 100644 index 00000000..7d62537f --- /dev/null +++ b/html/class_file-members.html @@ -0,0 +1,141 @@ + + + + + + +SdFat: Member List + + + + + + +
+
+ + + + + + +
+
SdFat +
+
+
+ + + + +
+
+
+
File Member List
+
+
+ +

This is the complete list of members for File, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
available()Fileinline
clearWriteError()Fileinline
close()SdBaseFile
contiguousRange(uint32_t *bgnBlock, uint32_t *endBlock)SdBaseFile
createContiguous(SdBaseFile *dirFile, const char *path, uint32_t size)SdBaseFile
curCluster() const SdBaseFileinline
curPosition() const SdBaseFileinline
cwd()SdBaseFileinlinestatic
dateTimeCallback(void(*dateTime)(uint16_t *date, uint16_t *time))SdBaseFileinlinestatic
dateTimeCallbackCancel()SdBaseFileinlinestatic
dirEntry(dir_t *dir)SdBaseFile
dirName(const dir_t &dir, char *name)SdBaseFilestatic
exists(const char *name)SdBaseFile
fgets(char *str, int16_t num, char *delim=0)SdBaseFile
fileSize() const SdBaseFileinline
firstCluster() const SdBaseFileinline
flush()Fileinline
getFilename(char *name)SdBaseFile
getpos(FatPos_t *pos)SdBaseFile
getWriteError()Fileinline
isDir() const SdBaseFileinline
isDirectory()Fileinline
isFile() const SdBaseFileinline
isOpen() const SdBaseFileinline
isRoot() const SdBaseFileinline
isSubDir() const SdBaseFileinline
ls(Print *pr, uint8_t flags=0, uint8_t indent=0)SdBaseFile
ls(uint8_t flags=0)SdBaseFile
mkdir(SdBaseFile *dir, const char *path, bool pFlag=true)SdBaseFile
name()Fileinline
open(SdBaseFile *dirFile, uint16_t index, uint8_t oflag)SdBaseFile
open(SdBaseFile *dirFile, const char *path, uint8_t oflag)SdBaseFile
open(const char *path, uint8_t oflag=O_READ)SdBaseFile
openNext(SdBaseFile *dirFile, uint8_t oflag)SdBaseFile
openNextFile(uint8_t mode=O_READ)Fileinline
openRoot(SdVolume *vol)SdBaseFile
operator bool()Fileinline
peek()Fileinline
position()Fileinline
printCreateDateTime(Print *pr)SdBaseFile
printFatDate(uint16_t fatDate)SdBaseFilestatic
printFatDate(Print *pr, uint16_t fatDate)SdBaseFilestatic
printFatTime(uint16_t fatTime)SdBaseFilestatic
printFatTime(Print *pr, uint16_t fatTime)SdBaseFilestatic
printField(float value, char term, uint8_t prec=2)SdBaseFile
printField(int16_t value, char term)SdBaseFile
printField(uint16_t value, char term)SdBaseFile
printField(int32_t value, char term)SdBaseFile
printField(uint32_t value, char term)SdBaseFile
printFileSize(Print *pr)SdBaseFile
printModifyDateTime(Print *pr)SdBaseFile
printName()SdBaseFile
printName(Print *pr)SdBaseFile
read()Fileinline
read(void *buf, size_t nbyte)Fileinline
readDir(dir_t *dir)SdBaseFile
remove(SdBaseFile *dirFile, const char *path)SdBaseFilestatic
remove()SdBaseFile
rename(SdBaseFile *dirFile, const char *newPath)SdBaseFile
rewind()SdBaseFileinline
rewindDirectory()Fileinline
rmdir()SdBaseFile
rmRfStar()SdBaseFile
SdBaseFile()SdBaseFileinline
SdBaseFile(const char *path, uint8_t oflag)SdBaseFile
seek(uint32_t pos)Fileinline
seekCur(int32_t offset)SdBaseFileinline
seekEnd(int32_t offset=0)SdBaseFileinline
seekSet(uint32_t pos)SdBaseFile
setpos(FatPos_t *pos)SdBaseFile
size()Fileinline
sync()SdBaseFile
timestamp(SdBaseFile *file)SdBaseFile
timestamp(uint8_t flag, uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second)SdBaseFile
truncate(uint32_t size)SdBaseFile
type() const SdBaseFileinline
volume() const SdBaseFileinline
write(uint8_t b)Fileinline
write(const void *buf, size_t nbyte)File
write(const uint8_t *buf, size_t size)Fileinline
writeErrorSdBaseFile
+ +
+Generated on Sat Oct 25 2014 07:56:22 for SdFat by   +doxygen + 1.8.8 +
+ + diff --git a/html/class_file.html b/html/class_file.html new file mode 100644 index 00000000..a3705ba3 --- /dev/null +++ b/html/class_file.html @@ -0,0 +1,2906 @@ + + + + + + +SdFat: File Class Reference + + + + + + +
+
+ + + + + + +
+
SdFat +
+
+
+ + + + +
+
+
+Public Member Functions | +Static Public Member Functions | +Public Attributes | +List of all members
+
+
File Class Reference
+
+
+ +

Arduino SD.h style File API. + More...

+ +

#include <SdFile.h>

+
+Inheritance diagram for File:
+
+
Inheritance graph
+ + +
[legend]
+
+Collaboration diagram for File:
+
+
Collaboration graph
+ + +
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

int available ()
 
void clearWriteError ()
 
bool close ()
 
bool contiguousRange (uint32_t *bgnBlock, uint32_t *endBlock)
 
bool createContiguous (SdBaseFile *dirFile, const char *path, uint32_t size)
 
uint32_t curCluster () const
 
uint32_t curPosition () const
 
bool dirEntry (dir_t *dir)
 
bool exists (const char *name)
 
int16_t fgets (char *str, int16_t num, char *delim=0)
 
uint32_t fileSize () const
 
uint32_t firstCluster () const
 
void flush ()
 
bool getFilename (char *name)
 
void getpos (FatPos_t *pos)
 
bool getWriteError ()
 
bool isDir () const
 
bool isDirectory ()
 
bool isFile () const
 
bool isOpen () const
 
bool isRoot () const
 
bool isSubDir () const
 
void ls (Print *pr, uint8_t flags=0, uint8_t indent=0)
 
void ls (uint8_t flags=0)
 
bool mkdir (SdBaseFile *dir, const char *path, bool pFlag=true)
 
char * name ()
 
bool open (SdBaseFile *dirFile, uint16_t index, uint8_t oflag)
 
bool open (SdBaseFile *dirFile, const char *path, uint8_t oflag)
 
bool open (const char *path, uint8_t oflag=O_READ)
 
bool openNext (SdBaseFile *dirFile, uint8_t oflag)
 
File openNextFile (uint8_t mode=O_READ)
 
bool openRoot (SdVolume *vol)
 
 operator bool ()
 
int peek ()
 
uint32_t position ()
 
bool printCreateDateTime (Print *pr)
 
int printField (float value, char term, uint8_t prec=2)
 
int printField (int16_t value, char term)
 
int printField (uint16_t value, char term)
 
int printField (int32_t value, char term)
 
int printField (uint32_t value, char term)
 
size_t printFileSize (Print *pr)
 
bool printModifyDateTime (Print *pr)
 
size_t printName ()
 
size_t printName (Print *pr)
 
int read ()
 
int read (void *buf, size_t nbyte)
 
int8_t readDir (dir_t *dir)
 
bool remove ()
 
bool rename (SdBaseFile *dirFile, const char *newPath)
 
void rewind ()
 
void rewindDirectory ()
 
bool rmdir ()
 
bool rmRfStar ()
 
bool seek (uint32_t pos)
 
bool seekCur (int32_t offset)
 
bool seekEnd (int32_t offset=0)
 
bool seekSet (uint32_t pos)
 
void setpos (FatPos_t *pos)
 
uint32_t size ()
 
bool sync ()
 
bool timestamp (SdBaseFile *file)
 
bool timestamp (uint8_t flag, uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second)
 
bool truncate (uint32_t size)
 
uint8_t type () const
 
SdVolume * volume () const
 
size_t write (uint8_t b)
 
int write (const void *buf, size_t nbyte)
 
size_t write (const uint8_t *buf, size_t size)
 
+ + + + + + + + + + + + + + + + + + + +

+Static Public Member Functions

static SdBaseFile * cwd ()
 
static void dateTimeCallback (void(*dateTime)(uint16_t *date, uint16_t *time))
 
static void dateTimeCallbackCancel ()
 
static void dirName (const dir_t &dir, char *name)
 
static void printFatDate (uint16_t fatDate)
 
static void printFatDate (Print *pr, uint16_t fatDate)
 
static void printFatTime (uint16_t fatTime)
 
static void printFatTime (Print *pr, uint16_t fatTime)
 
static bool remove (SdBaseFile *dirFile, const char *path)
 
+ + + +

+Public Attributes

bool writeError
 
+

Detailed Description

+

Arduino SD.h style File API.

+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
int File::available ()
+ 		+inline
+
+
Returns
number of bytes available from the current position to EOF or INT_MAX if more than INT_MAX bytes are available.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void File::clearWriteError ()
+ 		+inline
+
+

Set writeError to zero

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool SdBaseFile::close ()
+ 		+inherited
+
+

Close a file and force cached data and directory information to be written to the storage device.

+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include no file is open or an I/O error.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool SdBaseFile::contiguousRange (uint32_t * bgnBlock,
uint32_t * endBlock 
)
+ 		+inherited
+
+

Check for contiguous file and return its raw block range.

+
Parameters
+ + + +
[out]bgnBlockthe first block address for the file.
[out]endBlockthe last block address for the file.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include file is not contiguous, file has zero length or an I/O error occurred.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool SdBaseFile::createContiguous (SdBaseFile * dirFile,
const char * path,
uint32_t size 
)
+ 		+inherited
+
+

Create and open a new contiguous file of a specified size.

+
Note
This function only supports short DOS 8.3 names. See open() for more information.
+
Parameters
+ + + + +
[in]dirFileThe directory where the file will be created.
[in]pathA path with a valid DOS 8.3 file name.
[in]sizeThe desired file size.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include path contains an invalid DOS 8.3 file name, the FAT volume has not been initialized, a file is already open, the file already exists, the root directory is full or an I/O error.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
uint32_t SdBaseFile::curCluster () const
+ 		+inlineinherited
+
+
Returns
The current cluster number for a file or directory.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
uint32_t SdBaseFile::curPosition () const
+ 		+inlineinherited
+
+
Returns
The current position for a file or directory.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
static SdBaseFile* SdBaseFile::cwd ()
+ 		+inlinestaticinherited
+
+
Returns
Current working directory
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
static void SdBaseFile::dateTimeCallback (void(*)(uint16_t *date, uint16_t *time) dateTime)
+ 		+inlinestaticinherited
+
+

Set the date/time callback function

+
Parameters
+ + +
[in]dateTimeThe user's call back function. The callback function is of the form:
+
+
+
void dateTime(uint16_t* date, uint16_t* time) {
+
uint16_t year;
+
uint8_t month, day, hour, minute, second;
+
+
// User gets date and time from GPS or real-time clock here
+
+
// return date using FAT_DATE macro to format fields
+
*date = FAT_DATE(year, month, day);
+
+
// return time using FAT_TIME macro to format fields
+
*time = FAT_TIME(hour, minute, second);
+
}
+

Sets the function that is called when a file is created or when a file's directory entry is modified by sync(). All timestamps, access, creation, and modify, are set when a file is created. sync() maintains the last access date and last modify date/time.

+

See the timestamp() function.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
static void SdBaseFile::dateTimeCallbackCancel ()
+ 		+inlinestaticinherited
+
+

Cancel the date/time callback function.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool SdBaseFile::dirEntry (dir_t * dir)
+ 		+inherited
+
+

Return a file's directory entry.

+
Parameters
+ + +
[out]dirLocation for return of the file's directory entry.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void SdBaseFile::dirName (const dir_t & dir,
char * name 
)
+ 		+staticinherited
+
+

Format the name field of dir into the 13 byte array name in standard 8.3 short name format.

+
Parameters
+ + + +
[in]dirThe directory structure containing the name.
[out]nameA 13 byte char array for the formatted name.
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool SdBaseFile::exists (const char * name)
+ 		+inherited
+
+

Test for the existence of a file in a directory

+
Parameters
+ + +
[in]nameName of the file to be tested for.
+
+
+

The calling instance must be an open directory file.

+

dirFile.exists("TOFIND.TXT") searches for "TOFIND.TXT" in the directory dirFile.

+
Returns
true if the file exists else false.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
int16_t SdBaseFile::fgets (char * str,
int16_t num,
char * delim = 0 
)
+ 		+inherited
+
+

Get a string from a file.

+

fgets() reads bytes from a file into the array pointed to by str, until num - 1 bytes are read, or a delimiter is read and transferred to str, or end-of-file is encountered. The string is then terminated with a null byte.

+

fgets() deletes CR, '\r', from the string. This insures only a '\n' terminates the string for Windows text files which use CRLF for newline.

+
Parameters
+ + + + +
[out]strPointer to the array where the string is stored.
[in]numMaximum number of characters to be read (including the final null byte). Usually the length of the array str is used.
[in]delimOptional set of delimiters. The default is "\n".
+
+
+
Returns
For success fgets() returns the length of the string in str. If no data is read, fgets() returns zero for EOF or -1 if an error occurred.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
uint32_t SdBaseFile::fileSize () const
+ 		+inlineinherited
+
+
Returns
The total number of bytes in a file or directory.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
uint32_t SdBaseFile::firstCluster () const
+ 		+inlineinherited
+
+
Returns
The first cluster number for a file or directory.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void File::flush ()
+ 		+inline
+
+

Ensure that any bytes written to the file are saved to the SD card.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool SdBaseFile::getFilename (char * name)
+ 		+inherited
+
+

Get a file's name

+
Parameters
+ + +
[out]nameAn array of 13 characters for the file's name.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void SdBaseFile::getpos (FatPos_t * pos)
+ 		+inherited
+
+

get position for streams

Parameters
+ + +
[out]posstruct to receive position
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool File::getWriteError ()
+ 		+inline
+
+
Returns
value of writeError
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool SdBaseFile::isDir () const
+ 		+inlineinherited
+
+
Returns
True if this is a directory else false.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool File::isDirectory ()
+ 		+inline
+
+

This function reports if the current file is a directory or not.

Returns
true if the file is a directory.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool SdBaseFile::isFile () const
+ 		+inlineinherited
+
+
Returns
True if this is a normal file else false.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool SdBaseFile::isOpen () const
+ 		+inlineinherited
+
+
Returns
True if this is an open file/directory else false.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool SdBaseFile::isRoot () const
+ 		+inlineinherited
+
+
Returns
True if this is the root directory.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool SdBaseFile::isSubDir () const
+ 		+inlineinherited
+
+
Returns
True if this is a subdirectory else false.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
void SdBaseFile::ls (Print * pr,
uint8_t flags = 0,
uint8_t indent = 0 
)
+ 		+inherited
+
+

List directory contents.

+
Parameters
+ + + +
[in]prPrint stream for list.
[in]flagsThe inclusive OR of
+
+
+

LS_DATE - Print file modification date

+

LS_SIZE - Print file size.

+

LS_R - Recursive list of subdirectories.

+
Parameters
+ + +
[in]indentAmount of space before file name. Used for recursive list to indicate subdirectory level.
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void SdBaseFile::ls (uint8_t flags = 0)
+ 		+inherited
+
+

List directory contents to stdOut.

+
Parameters
+ + +
[in]flagsThe inclusive OR of
+
+
+

LS_DATE - Print file modification date

+

LS_SIZE - Print file size.

+

LS_R - Recursive list of subdirectories.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool SdBaseFile::mkdir (SdBaseFile * parent,
const char * path,
bool pFlag = true 
)
+ 		+inherited
+
+

Make a new directory.

+
Parameters
+ + + + +
[in]parentAn open SdFat instance for the directory that will contain the new directory.
[in]pathA path with a valid 8.3 DOS name for the new directory.
[in]pFlagCreate missing parent directories if true.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include this file is already open, parent is not a directory, path is invalid or already exists in parent.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
char* File::name ()
+ 		+inline
+
+
Returns
a pointer to the file's name.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool SdBaseFile::open (SdBaseFile * dirFile,
uint16_t index,
uint8_t oflag 
)
+ 		+inherited
+
+

Open a file by index.

+
Parameters
+ + + + +
[in]dirFileAn open SdFat instance for the directory.
[in]indexThe index of the directory entry for the file to be opened. The value for index is (directory file position)/32.
[in]oflagValues for oflag are constructed by a bitwise-inclusive OR of flags O_READ, O_WRITE, O_TRUNC, and O_SYNC.
+
+
+

See open() by path for definition of flags.

Returns
true for success or false for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool SdBaseFile::open (SdBaseFile * dirFile,
const char * path,
uint8_t oflag 
)
+ 		+inherited
+
+

Open a file or directory by name.

+
Parameters
+ + + + +
[in]dirFileAn open SdFat instance for the directory containing the file to be opened.
[in]pathA path with a valid 8.3 DOS name for a file to be opened.
[in]oflagValues for oflag are constructed by a bitwise-inclusive OR of flags from the following list
+
+
+

O_READ - Open for reading.

+

O_RDONLY - Same as O_READ.

+

O_WRITE - Open for writing.

+

O_WRONLY - Same as O_WRITE.

+

O_RDWR - Open for reading and writing.

+

O_APPEND - If set, the file offset shall be set to the end of the file prior to each write.

+

O_AT_END - Set the initial position at the end of the file.

+

O_CREAT - If the file exists, this flag has no effect except as noted under O_EXCL below. Otherwise, the file shall be created

+

O_EXCL - If O_CREAT and O_EXCL are set, open() shall fail if the file exists.

+

O_SYNC - Call sync() after each write. This flag should not be used with write(uint8_t), write_P(PGM_P), writeln_P(PGM_P), or the Arduino Print class. These functions do character at a time writes so sync() will be called after each byte.

+

O_TRUNC - If the file exists and is a regular file, and the file is successfully opened and is not read only, its length shall be truncated to 0.

+

WARNING: A given file must not be opened by more than one SdBaseFile object or file corruption may occur.

+
Note
Directory files must be opened read only. Write and truncation is not allowed for directory files.
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include this file is already open, dirFile is not a directory, path is invalid, the file does not exist or can't be opened in the access mode specified by oflag.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool SdBaseFile::open (const char * path,
uint8_t oflag = O_READ 
)
+ 		+inherited
+
+

Open a file in the current working directory.

+
Parameters
+ + + +
[in]pathA path with a valid 8.3 DOS name for a file to be opened.
[in]oflagValues for oflag are constructed by a bitwise-inclusive OR of open flags. see SdBaseFile::open(SdBaseFile*, const char*, uint8_t).
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool SdBaseFile::openNext (SdBaseFile * dirFile,
uint8_t oflag 
)
+ 		+inherited
+
+

Open the next file or subdirectory in a directory.

+
Parameters
+ + + +
[in]dirFileAn open SdFat instance for the directory containing the file to be opened.
[in]oflagValues for oflag are constructed by a bitwise-inclusive OR of flags O_READ, O_WRITE, O_TRUNC, and O_SYNC.
+
+
+

See open() by path for definition of flags.

Returns
true for success or false for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
File File::openNextFile (uint8_t mode = O_READ)
+ 		+inline
+
+

Opens the next file or folder in a directory.

+
Parameters
+ + +
[in]modeopen mode flags.
+
+
+
Returns
a File object.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool SdBaseFile::openRoot (SdVolume * vol)
+ 		+inherited
+
+

Open a volume's root directory.

+
Parameters
+ + +
[in]volThe FAT volume containing the root directory to be opened.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include the file is already open, the FAT volume has not been initialized or it a FAT12 volume.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
File::operator bool ()
+ 		+inline
+
+

The parenthesis operator.

+
Returns
true if a file is open.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int File::peek ()
+ 		+inline
+
+

Return the next available byte without consuming it.

+
Returns
The byte if no error and not at eof else -1;
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
uint32_t File::position ()
+ 		+inline
+
+
Returns
the current file position.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool SdBaseFile::printCreateDateTime (Print * pr)
+ 		+inherited
+
+

Print a file's creation date and time

+
Parameters
+ + +
[in]prPrint stream for output.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void SdBaseFile::printFatDate (uint16_t fatDate)
+ 		+staticinherited
+
+

Print a directory date field to stdOut.

+

Format is yyyy-mm-dd.

+
Parameters
+ + +
[in]fatDateThe date field from a directory entry.
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void SdBaseFile::printFatDate (Print * pr,
uint16_t fatDate 
)
+ 		+staticinherited
+
+

Print a directory date field.

+

Format is yyyy-mm-dd.

+
Parameters
+ + + +
[in]prPrint stream for output.
[in]fatDateThe date field from a directory entry.
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void SdBaseFile::printFatTime (uint16_t fatTime)
+ 		+staticinherited
+
+

Print a directory time field to stdOut.

+

Format is hh:mm:ss.

+
Parameters
+ + +
[in]fatTimeThe time field from a directory entry.
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void SdBaseFile::printFatTime (Print * pr,
uint16_t fatTime 
)
+ 		+staticinherited
+
+

Print a directory time field.

+

Format is hh:mm:ss.

+
Parameters
+ + + +
[in]prPrint stream for output.
[in]fatTimeThe time field from a directory entry.
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
int SdBaseFile::printField (float value,
char term,
uint8_t prec = 2 
)
+ 		+inherited
+
+

Print a number followed by a field terminator.

Parameters
+ + + + +
[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
[in]precNumber of digits after decimal point.
+
+
+
Returns
The number of bytes written or -1 if an error occurs.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int SdBaseFile::printField (int16_t value,
char term 
)
+ 		+inherited
+
+

Print a number followed by a field terminator.

Parameters
+ + + +
[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
+
+
+
Returns
The number of bytes written or -1 if an error occurs.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int SdBaseFile::printField (uint16_t value,
char term 
)
+ 		+inherited
+
+

Print a number followed by a field terminator.

Parameters
+ + + +
[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
+
+
+
Returns
The number of bytes written or -1 if an error occurs.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int SdBaseFile::printField (int32_t value,
char term 
)
+ 		+inherited
+
+

Print a number followed by a field terminator.

Parameters
+ + + +
[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
+
+
+
Returns
The number of bytes written or -1 if an error occurs.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int SdBaseFile::printField (uint32_t value,
char term 
)
+ 		+inherited
+
+

Print a number followed by a field terminator.

Parameters
+ + + +
[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
+
+
+
Returns
The number of bytes written or -1 if an error occurs.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
size_t SdBaseFile::printFileSize (Print * pr)
+ 		+inherited
+
+

Print a file's size.

+
Parameters
+ + +
[in]prPrint stream for output.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool SdBaseFile::printModifyDateTime (Print * pr)
+ 		+inherited
+
+

Print a file's modify date and time

+
Parameters
+ + +
[in]prPrint stream for output.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
size_t SdBaseFile::printName ()
+ 		+inherited
+
+

Print a file's name to stdOut

+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
size_t SdBaseFile::printName (Print * pr)
+ 		+inherited
+
+

Print a file's name

+
Parameters
+ + +
[in]prPrint stream for output.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int File::read ()
+ 		+inline
+
+

Read the next byte from a file.

+
Returns
For success return the next byte in the file as an int. If an error occurs or end of file is reached return -1.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int File::read (void * buf,
size_t nbyte 
)
+ 		+inline
+
+

Read data from a file starting at the current position.

+
Parameters
+ + + +
[out]bufPointer to the location that will receive the data.
[in]nbyteMaximum number of bytes to read.
+
+
+
Returns
For success read() returns the number of bytes read. A value less than nbyte, including zero, will be returned if end of file is reached. If an error occurs, read() returns -1. Possible errors include read() called before a file has been opened, corrupt file system or an I/O error occurred.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int8_t SdBaseFile::readDir (dir_t * dir)
+ 		+inherited
+
+

Read the next directory entry from a directory file.

+
Parameters
+ + +
[out]dirThe dir_t struct that will receive the data.
+
+
+
Returns
For success readDir() returns the number of bytes read. A value of zero will be returned if end of file is reached. If an error occurs, readDir() returns -1. Possible errors include readDir() called before a directory has been opened, this is not a directory file or an I/O error occurred.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool SdBaseFile::remove (SdBaseFile * dirFile,
const char * path 
)
+ 		+staticinherited
+
+

Remove a file.

+

The directory entry and all data for the file are deleted.

+
Parameters
+ + + +
[in]dirFileThe directory that contains the file.
[in]pathPath for the file to be removed.
+
+
+
Note
This function should not be used to delete the 8.3 version of a file that has a long name. For example if a file has the long name "New Text Document.txt" you should not delete the 8.3 name "NEWTEX~1.TXT".
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include the file is a directory, is read only, dirFile is not a directory, path is not found or an I/O error occurred.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool SdBaseFile::remove ()
+ 		+inherited
+
+

Remove a file.

+

The directory entry and all data for the file are deleted.

+
Note
This function should not be used to delete the 8.3 version of a file that has a long name. For example if a file has the long name "New Text Document.txt" you should not delete the 8.3 name "NEWTEX~1.TXT".
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include the file read-only, is a directory, or an I/O error occurred.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool SdBaseFile::rename (SdBaseFile * dirFile,
const char * newPath 
)
+ 		+inherited
+
+

Rename a file or subdirectory.

+
Parameters
+ + + +
[in]dirFileDirectory for the new path.
[in]newPathNew path name for the file/directory.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include dirFile is not open or is not a directory file, newPath is invalid or already exists, or an I/O error occurs.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void SdBaseFile::rewind ()
+ 		+inlineinherited
+
+

Set the file's current position to zero.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void File::rewindDirectory ()
+ 		+inline
+
+

Rewind a file if it is a directory

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool SdBaseFile::rmdir ()
+ 		+inherited
+
+

Remove a directory file.

+

The directory file will be removed only if it is empty and is not the root directory. rmdir() follows DOS and Windows and ignores the read-only attribute for the directory.

+
Note
This function should not be used to delete the 8.3 version of a directory that has a long name. For example if a directory has the long name "New folder" you should not delete the 8.3 name "NEWFOL~1".
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include the file is not a directory, is the root directory, is not empty, or an I/O error occurred.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool SdBaseFile::rmRfStar ()
+ 		+inherited
+
+

Recursively delete a directory and all contained files.

+

This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.

+

Warning - This will remove all contents of the directory including subdirectories. The directory will then be removed if it is not root. The read-only attribute for files will be ignored.

+
Note
This function should not be used to delete the 8.3 version of a directory that has a long name. See remove() and rmdir().
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool File::seek (uint32_t pos)
+ 		+inline
+
+

Seek to a new position in the file, which must be between 0 and the size of the file (inclusive).

+
Parameters
+ + +
[in]posthe new file position.
+
+
+
Returns
true for success else false.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool SdBaseFile::seekCur (int32_t offset)
+ 		+inlineinherited
+
+

Set the files position to current position + pos. See seekSet().

Parameters
+ + +
[in]offsetThe new position in bytes from the current position.
+
+
+
Returns
true for success or false for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool SdBaseFile::seekEnd (int32_t offset = 0)
+ 		+inlineinherited
+
+

Set the files position to end-of-file + offset. See seekSet().

Parameters
+ + +
[in]offsetThe new position in bytes from end-of-file.
+
+
+
Returns
true for success or false for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool SdBaseFile::seekSet (uint32_t pos)
+ 		+inherited
+
+

Sets a file's position.

+
Parameters
+ + +
[in]posThe new position in bytes from the beginning of the file.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void SdBaseFile::setpos (FatPos_t * pos)
+ 		+inherited
+
+

set position for streams

Parameters
+ + +
[out]posstruct with value for new position
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
uint32_t File::size ()
+ 		+inline
+
+
Returns
the file's size.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool SdBaseFile::sync ()
+ 		+inherited
+
+

The sync() call causes all modified data and directory fields to be written to the storage device.

+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include a call to sync() before a file has been opened or an I/O error.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool SdBaseFile::timestamp (SdBaseFile * file)
+ 		+inherited
+
+

Copy a file's timestamps

+
Parameters
+ + +
[in]fileFile to copy timestamps from.
+
+
+
Note
Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
bool SdBaseFile::timestamp (uint8_t flags,
uint16_t year,
uint8_t month,
uint8_t day,
uint8_t hour,
uint8_t minute,
uint8_t second 
)
+ 		+inherited
+
+

Set a file's timestamps in its directory entry.

+
Parameters
+ + +
[in]flagsValues for flags are constructed by a bitwise-inclusive OR of flags from the following list
+
+
+

T_ACCESS - Set the file's last access date.

+

T_CREATE - Set the file's creation date and time.

+

T_WRITE - Set the file's last write/modification date and time.

+
Parameters
+ + + + + + + +
[in]yearValid range 1980 - 2107 inclusive.
[in]monthValid range 1 - 12 inclusive.
[in]dayValid range 1 - 31 inclusive.
[in]hourValid range 0 - 23 inclusive.
[in]minuteValid range 0 - 59 inclusive.
[in]secondValid range 0 - 59 inclusive
+
+
+
Note
It is possible to set an invalid date since there is no check for the number of days in a month.
+
+Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool SdBaseFile::truncate (uint32_t length)
+ 		+inherited
+
+

Truncate a file to a specified length. The current file position will be maintained if it is less than or equal to length otherwise it will be set to end of file.

+
Parameters
+ + +
[in]lengthThe desired length for the file.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include file is read only, file is a directory, length is greater than the current file size or an I/O error occurs.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
uint8_t SdBaseFile::type () const
+ 		+inlineinherited
+
+

Type of file. You should use isFile() or isDir() instead of type() if possible.

+
Returns
The file or directory type.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
SdVolume* SdBaseFile::volume () const
+ 		+inlineinherited
+
+
Returns
SdVolume that contains this file.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
size_t File::write (uint8_t b)
+ 		+inline
+
+

Write a byte to a file. Required by the Arduino Print class.

Parameters
+ + +
[in]bthe byte to be written. Use getWriteError to check for errors.
+
+
+
Returns
1 for success and 0 for failure.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
int File::write (const void * buf,
size_t nbyte 
)
+
+

Write data to an open file.

+
Note
Data is moved to the cache but may not be written to the storage device until sync() is called.
+
Parameters
+ + + +
[in]bufPointer to the location of the data to be written.
[in]nbyteNumber of bytes to write.
+
+
+
Returns
For success write() returns the number of bytes written, always nbyte. If an error occurs, write() returns -1. Possible errors include write() is called before a file has been opened, write is called for a read-only file, device is full, a corrupt file system or an I/O error.
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
size_t File::write (const uint8_t * buf,
size_t size 
)
+ 		+inline
+
+

Write data to an open file. Form required by Print.

+
Note
Data is moved to the cache but may not be written to the storage device until sync() is called.
+
Parameters
+ + + +
[in]bufPointer to the location of the data to be written.
[in]sizeNumber of bytes to write.
+
+
+
Returns
For success write() returns the number of bytes written, always nbyte. If an error occurs, write() returns -1. Possible errors include write() is called before a file has been opened, write is called for a read-only file, device is full, a corrupt file system or an I/O error.
+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
bool SdBaseFile::writeError
+ 		+inherited
+
+

writeError is set to true if an error occurs during a write(). Set writeError to false before calling print() and/or write() and check for true after calls to print() and/or write().

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated on Sat Oct 25 2014 07:56:22 for SdFat by   +doxygen + 1.8.8 +
+ + diff --git a/html/class_file__coll__graph.png b/html/class_file__coll__graph.png new file mode 100644 index 00000000..5fb4ad03 Binary files /dev/null and b/html/class_file__coll__graph.png differ diff --git a/html/class_file__inherit__graph.png b/html/class_file__inherit__graph.png new file mode 100644 index 00000000..5fb4ad03 Binary files /dev/null and b/html/class_file__inherit__graph.png differ diff --git a/html/class_minimum_serial-members.html b/html/class_minimum_serial-members.html index d3b33b27..36ebf6d1 100644 --- a/html/class_minimum_serial-members.html +++ b/html/class_minimum_serial-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_minimum_serial.html b/html/class_minimum_serial.html index 4c3b08b0..0e6721c1 100644 --- a/html/class_minimum_serial.html +++ b/html/class_minimum_serial.html @@ -3,7 +3,7 @@ - + SdFat: MinimumSerial Class Reference @@ -25,11 +25,10 @@ - +
-

Set baud rate for serial port zero and enable in non interrupt mode. Do not call this function if you use another serial library.

-
Parameters
+

Set baud rate for serial port zero and enable in non interrupt mode. Do not call this function if you use another serial library.

Parameters
[in]baudrate
@@ -117,8 +115,7 @@
-

Unbuffered read

-
Returns
-1 if no character is available or an available character.
+

Unbuffered read

Returns
-1 if no character is available or an available character.
@@ -147,15 +144,15 @@
The documentation for this class was generated from the following files:
    -
  • Arduino/libraries/SdFat/MinimumSerial.h
    • -
  • Arduino/libraries/SdFat/MinimumSerial.cpp
    • +
  • Arduino/libraries/SdFat/MinimumSerial.h
    • +
  • Arduino/libraries/SdFat/MinimumSerial.cpp
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_sd2_card-members.html b/html/class_sd2_card-members.html index 69e4dfb2..41bc3356 100644 --- a/html/class_sd2_card-members.html +++ b/html/class_sd2_card-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_sd2_card.html b/html/class_sd2_card.html index 954ea437..f610066c 100644 --- a/html/class_sd2_card.html +++ b/html/class_sd2_card.html @@ -3,7 +3,7 @@ - + SdFat: Sd2Card Class Reference @@ -25,11 +25,10 @@ - +
-

Set SD error code.

-
Parameters
+

Set SD error code.

Parameters
[in]codevalue for error code.
@@ -496,6 +496,30 @@

Member Function Documentation

Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
+
+ + +
+
+ + + + + + + + +
bool Sd2Card::readOCR (uint32_t * ocr)
+
+

Read OCR register.

+
Parameters
+ + +
[out]ocrValue of OCR register.
+
+
+
Returns
true for success else false.
+
@@ -585,8 +609,7 @@

Member Function Documentation

-

Return the card type: SD V1, SD V2 or SDHC

-
Returns
0 - SD V1, 1 - SD V2, or 3 - SDHC.
+

Return the card type: SD V1, SD V2 or SDHC

Returns
0 - SD V1, 1 - SD V2, or 3 - SDHC.
@@ -638,8 +661,7 @@

Member Function Documentation

-

Write one data block in a multiple block write sequence

-
Parameters
+

Write one data block in a multiple block write sequence

Parameters
[in]srcPointer to the location of the data to be written.
@@ -704,14 +726,14 @@

Member Function Documentation

The documentation for this class was generated from the following files:
  • Arduino/libraries/SdFat/Sd2Card.h
    • -
  • Arduino/libraries/SdFat/Sd2Card.cpp
    • +
  • Arduino/libraries/SdFat/Sd2Card.cpp
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_sd_base_file-members.html b/html/class_sd_base_file-members.html index 8df254bc..1b81aa3f 100644 --- a/html/class_sd_base_file-members.html +++ b/html/class_sd_base_file-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_sd_base_file.html b/html/class_sd_base_file.html index 7d090d8c..127d4923 100644 --- a/html/class_sd_base_file.html +++ b/html/class_sd_base_file.html @@ -3,7 +3,7 @@ - + SdFat: SdBaseFile Class Reference @@ -25,11 +25,10 @@ - +
-

Base class for SdFile with Print and C++ streams. +

Base class for SdFile with Print and C++ streams. More...

#include <SdBaseFile.h>

@@ -63,7 +62,7 @@
Inheritance graph
- +
[legend]
+ + @@ -215,11 +216,12 @@

@@ -128,6 +127,8 @@

 
bool printCreateDateTime (Print *pr)
 
int printField (float value, char term, uint8_t prec=2)
 
int printField (int16_t value, char term)
 
int printField (uint16_t value, char term)
- +

Friends

class SdFat
+class SdFat
 

Detailed Description

-

Base class for SdFile with Print and C++ streams.

+

Base class for SdFile with Print and C++ streams.

Constructor & Destructor Documentation

@@ -785,8 +787,7 @@

Member Function Documentation

-

get position for streams

-
Parameters
+

get position for streams

Parameters
[out]posstruct to receive position
@@ -1094,8 +1095,7 @@

Member Function Documentation

-

See open() by path for definition of flags.

-
Returns
true for success or false for failure.
+

See open() by path for definition of flags.

Returns
true for success or false for failure.
@@ -1148,7 +1148,7 @@

Member Function Documentation

O_EXCL - If O_CREAT and O_EXCL are set, open() shall fail if the file exists.

O_SYNC - Call sync() after each write. This flag should not be used with write(uint8_t), write_P(PGM_P), writeln_P(PGM_P), or the Arduino Print class. These functions do character at a time writes so sync() will be called after each byte.

O_TRUNC - If the file exists and is a regular file, and the file is successfully opened and is not read only, its length shall be truncated to 0.

-

WARNING: A given file must not be opened by more than one SdBaseFile object of file corruption may occur.

+

WARNING: A given file must not be opened by more than one SdBaseFile object or file corruption may occur.

Note
Directory files must be opened read only. Write and truncation is not allowed for directory files.
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include this file is already open, dirFile is not a directory, path is invalid, the file does not exist or can't be opened in the access mode specified by oflag.
@@ -1220,8 +1220,7 @@

Member Function Documentation

-

See open() by path for definition of flags.

-
Returns
true for success or false for failure.
+

See open() by path for definition of flags.

Returns
true for success or false for failure.
@@ -1438,6 +1437,47 @@

Member Function Documentation

+ + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int SdBaseFile::printField (float value,
char term,
uint8_t prec = 2 
)
+
+

Print a number followed by a field terminator.

Parameters
+ + + + +
[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
[in]precNumber of digits after decimal point.
+
+
+
Returns
The number of bytes written or -1 if an error occurs.
+
@@ -1463,8 +1503,7 @@

Member Function Documentation

-

Print a number followed by a field terminator.

-
Parameters
+

Print a number followed by a field terminator.

Parameters
@@ -1498,8 +1537,7 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
-

Print a number followed by a field terminator.

-
Parameters
+

Print a number followed by a field terminator.

Parameters
@@ -1533,8 +1571,7 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
-

Print a number followed by a field terminator.

-
Parameters
+

Print a number followed by a field terminator.

Parameters
@@ -1568,8 +1605,7 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
-

Print a number followed by a field terminator.

-
Parameters
+

Print a number followed by a field terminator.

Parameters
@@ -1593,6 +1629,14 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
+

Print a file's size.

+
Parameters
+ + +
[in]prPrint stream for output.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
@@ -1920,8 +1964,7 @@

Member Function Documentation

-

Set the files position to current position + pos. See seekSet().

-
Parameters
+

Set the files position to current position + pos. See seekSet().

Parameters
[in]offsetThe new position in bytes from the current position.
@@ -1952,8 +1995,7 @@

Member Function Documentation

-

Set the files position to end-of-file + offset. See seekSet().

-
Parameters
+

Set the files position to end-of-file + offset. See seekSet().

Parameters
[in]offsetThe new position in bytes from end-of-file.
@@ -2000,8 +2042,7 @@

Member Function Documentation

-

set position for streams

-
Parameters
+

set position for streams

Parameters
[out]posstruct with value for new position
@@ -2043,7 +2084,7 @@

Member Function Documentation

Copy a file's timestamps

Parameters
- +
[in]fileFile to copy timestamps from.
[in]fileFile to copy timestamps from.
@@ -2240,27 +2281,6 @@

Member Function Documentation

Returns
For success write() returns the number of bytes written, always nbyte. If an error occurs, write() returns -1. Possible errors include write() is called before a file has been opened, write is called for a read-only file, device is full, a corrupt file system or an I/O error.
-
- -

Friends And Related Function Documentation

- -
-
- - - - - -
- - - - -
friend class SdFat
- 		-friend
-
-

Member Data Documentation

@@ -2279,15 +2299,15 @@

Member Data Documentation

The documentation for this class was generated from the following files:
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_sd_base_file__inherit__graph.png b/html/class_sd_base_file__inherit__graph.png index 9ede4985..c0fca686 100644 Binary files a/html/class_sd_base_file__inherit__graph.png and b/html/class_sd_base_file__inherit__graph.png differ diff --git a/html/class_sd_fat-members.html b/html/class_sd_fat-members.html index 2f19e005..763a2ae7 100644 --- a/html/class_sd_fat-members.html +++ b/html/class_sd_fat-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_sd_fat.html b/html/class_sd_fat.html index c367f0b9..a9bb96e2 100644 --- a/html/class_sd_fat.html +++ b/html/class_sd_fat.html @@ -3,7 +3,7 @@ - + SdFat: SdFat Class Reference @@ -25,11 +25,10 @@ - +

Member Function Documentation

@@ -658,7 +633,7 @@

Member Function Documentation

List the directory contents of the volume working directory.

Parameters
- +
[in]prPrint stream for list.
[in]prPrint stream for the list.
[in]flagsThe inclusive OR of
@@ -698,6 +673,18 @@

Member Function Documentation

+

List the directory contents of the volume working directory to stdOut.

+
Parameters
+ + + + +
[in]prPrint stream for the list.
[in]pathdirectory to list.
[in]flagsThe inclusive OR of
+
+
+

LS_DATE - Print file modification date

+

LS_SIZE - Print file size.

+

LS_R - Recursive list of subdirectories.

@@ -734,6 +721,49 @@

Member Function Documentation

Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
+ + + +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
File SdFat::open (const char * path,
uint8_t mode = FILE_READ 
)
+ 		+inline
+
+

open a file

+
Parameters
+ + + +
[in]pathlocation of file to be opened.
[in]modeopen mode flags.
+
+
+
Returns
a File object.
+
@@ -843,8 +873,7 @@

Member Function Documentation

-

Set stdOut Print stream for messages.

-
Parameters
+

Set stdOut Print stream for messages.

Parameters
[in]streamThe new Print stream.
@@ -962,15 +991,15 @@

Member Function Documentation

The documentation for this class was generated from the following files:
  • Arduino/libraries/SdFat/SdFat.h
    • -
  • Arduino/libraries/SdFat/SdFat.cpp
    • -
  • Arduino/libraries/SdFat/SdFatErrorPrint.cpp
    • +
  • Arduino/libraries/SdFat/SdFat.cpp
    • +
  • Arduino/libraries/SdFat/SdFatErrorPrint.cpp
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_sd_file-members.html b/html/class_sd_file-members.html index cc5acb87..ed9e9682 100644 --- a/html/class_sd_file-members.html +++ b/html/class_sd_file-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_sd_file.html b/html/class_sd_file.html index 5323d213..32ba1ed3 100644 --- a/html/class_sd_file.html +++ b/html/class_sd_file.html @@ -3,7 +3,7 @@ - + SdFat: SdFile Class Reference @@ -25,11 +25,10 @@ - +
-

SdBaseFile with Print. +

SdBaseFile with Arduino Stream. More...

#include <SdFile.h>

@@ -74,8 +73,8 @@ - - + + @@ -98,6 +97,8 @@ + + @@ -130,10 +131,12 @@ - - + + + + @@ -150,10 +153,10 @@ - - - - + + + + @@ -166,8 +169,6 @@ - - @@ -230,31 +231,8 @@

Public Member Functions

uint32_t available ()
 
int available ()
 
void clearWriteError ()
 
bool close ()
 
uint32_t firstCluster () const
 
void flush ()
 
bool getFilename (char *name)
 
void getpos (FatPos_t *pos)
 
bool openRoot (SdVolume *vol)
 
int peek ()
 
int peek ()
 
bool printCreateDateTime (Print *pr)
 
int printField (float value, char term, uint8_t prec=2)
 
int printField (int16_t value, char term)
 
int printField (uint16_t value, char term)
 
size_t printName (Print *pr)
 
int16_t read ()
 
int read (void *buf, size_t nbyte)
 
int read ()
 
int read (void *buf, size_t nbyte)
 
int8_t readDir (dir_t *dir)
 
bool remove ()
 
bool rmRfStar ()
 
 SdFile ()
 
 SdFile (const char *name, uint8_t oflag)
 
bool seekCur (int32_t offset)
 

Detailed Description

-

SdBaseFile with Print.

+

SdBaseFile with Arduino Stream.

Constructor & Destructor Documentation

- -
-
- - - - - -
- - - - - - - -
SdFile::SdFile ()
- 		-inline
-
- -
-
@@ -290,7 +268,7 @@

Member Function Documentation

- +
@@ -298,7 +276,7 @@

Member Function Documentation

+inline
- + @@ -306,11 +284,11 @@

Member Function Documentation

uint32_t SdBaseFile::available int SdFile::available ( )
-inlineinherited
-
Returns
number of bytes available from yhe current position to EOF
+
Returns
number of bytes available from the current position to EOF or INT_MAX if more than INT_MAX bytes are available.
@@ -804,6 +782,30 @@

Member Function Documentation

Returns
The first cluster number for a file or directory.
+
+
+ +
+
+ + + + + +
+ + + + + + + +
void SdFile::flush ()
+ 		+inline
+
+

Ensure that any bytes written to the file are saved to the SD card.

+
@@ -859,8 +861,7 @@

Member Function Documentation

-

get position for streams

-
Parameters
+

get position for streams

Parameters
[out]posstruct to receive position
@@ -1200,8 +1201,7 @@

Member Function Documentation

-

See open() by path for definition of flags.

-
Returns
true for success or false for failure.
+

See open() by path for definition of flags.

Returns
true for success or false for failure.
@@ -1262,7 +1262,7 @@

Member Function Documentation

O_EXCL - If O_CREAT and O_EXCL are set, open() shall fail if the file exists.

O_SYNC - Call sync() after each write. This flag should not be used with write(uint8_t), write_P(PGM_P), writeln_P(PGM_P), or the Arduino Print class. These functions do character at a time writes so sync() will be called after each byte.

O_TRUNC - If the file exists and is a regular file, and the file is successfully opened and is not read only, its length shall be truncated to 0.

-

WARNING: A given file must not be opened by more than one SdBaseFile object of file corruption may occur.

+

WARNING: A given file must not be opened by more than one SdBaseFile object or file corruption may occur.

Note
Directory files must be opened read only. Write and truncation is not allowed for directory files.
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include this file is already open, dirFile is not a directory, path is invalid, the file does not exist or can't be opened in the access mode specified by oflag.
@@ -1350,8 +1350,7 @@

Member Function Documentation

-

See open() by path for definition of flags.

-
Returns
true for success or false for failure.
+

See open() by path for definition of flags.

Returns
true for success or false for failure.
@@ -1387,7 +1386,7 @@

Member Function Documentation

- +
@@ -1395,7 +1394,7 @@

Member Function Documentation

+inline
- + @@ -1403,7 +1402,7 @@

Member Function Documentation

int SdBaseFile::peek int SdFile::peek ( )
-inherited
@@ -1592,6 +1591,55 @@

Member Function Documentation

+
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
int SdBaseFile::printField (float value,
char term,
uint8_t prec = 2 
)
+ 		+inherited
+
+

Print a number followed by a field terminator.

Parameters
+ + + + +
[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
[in]precNumber of digits after decimal point.
+
+
+
Returns
The number of bytes written or -1 if an error occurs.
+
@@ -1625,8 +1673,7 @@

Member Function Documentation

-

Print a number followed by a field terminator.

-
Parameters
+

Print a number followed by a field terminator.

Parameters
@@ -1668,8 +1715,7 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
-

Print a number followed by a field terminator.

-
Parameters
+

Print a number followed by a field terminator.

Parameters
@@ -1711,8 +1757,7 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
-

Print a number followed by a field terminator.

-
Parameters
+

Print a number followed by a field terminator.

Parameters
@@ -1754,8 +1799,7 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
-

Print a number followed by a field terminator.

-
Parameters
+

Print a number followed by a field terminator.

Parameters
@@ -1787,6 +1831,14 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
+

Print a file's size.

+
Parameters
+ + +
[in]prPrint stream for output.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
@@ -1879,7 +1931,7 @@

Member Function Documentation

- +
@@ -1887,7 +1939,7 @@

Member Function Documentation

+inline
- + @@ -1895,16 +1947,16 @@

Member Function Documentation

int16_t SdBaseFile::read int SdFile::read ( )
-inherited

Read the next byte from a file.

-
Returns
For success read returns the next byte in the file as an int. If an error occurs or end of file is reached -1 is returned.
+
Returns
For success return the next byte in the file as an int. If an error occurs or end of file is reached return -1.
- +
@@ -1912,7 +1964,7 @@

Member Function Documentation

+inline
- + @@ -1931,7 +1983,7 @@

Member Function Documentation

int SdBaseFile::read int SdFile::read ( void *  buf,
-inherited
@@ -1943,7 +1995,7 @@

Member Function Documentation

-
Returns
For success read() returns the number of bytes read. A value less than nbyte, including zero, will be returned if end of file is reached. If an error occurs, read() returns -1. Possible errors include read() called before a file has been opened, corrupt file system or an I/O error occurred.
+
Returns
For success read() returns the number of bytes read. A value less than nbyte, including zero, will be returned if end of file is reached. If an error occurs, read() returns -1. Possible errors include read() called before a file has been opened, corrupt file system or an I/O error occurred.
@@ -2194,8 +2246,7 @@

Member Function Documentation

-

Set the files position to current position + pos. See seekSet().

-
Parameters
+

Set the files position to current position + pos. See seekSet().

Parameters
[in]offsetThe new position in bytes from the current position.
@@ -2226,8 +2277,7 @@

Member Function Documentation

-

Set the files position to end-of-file + offset. See seekSet().

-
Parameters
+

Set the files position to end-of-file + offset. See seekSet().

Parameters
[in]offsetThe new position in bytes from end-of-file.
@@ -2290,8 +2340,7 @@

Member Function Documentation

-

set position for streams

-
Parameters
+

set position for streams

Parameters
[out]posstruct with value for new position
@@ -2349,7 +2398,7 @@

Member Function Documentation

Copy a file's timestamps

Parameters
- +
[in]fileFile to copy timestamps from.
[in]fileFile to copy timestamps from.
@@ -2541,8 +2590,7 @@

Member Function Documentation

-

Write a byte to a file. Required by the Arduino Print class.

-
Parameters
+

Write a byte to a file. Required by the Arduino Print class.

Parameters
[in]bthe byte to be written. Use getWriteError to check for errors.
@@ -2565,8 +2613,7 @@

Member Function Documentation

-

Write a string to a file. Used by the Arduino Print class.

-
Parameters
+

Write a string to a file. Used by the Arduino Print class.

Parameters
[in]strPointer to the string. Use getWriteError to check for errors.
@@ -2643,6 +2690,16 @@

Member Function Documentation

+

Write data to an open file. Form required by Print.

+
Note
Data is moved to the cache but may not be written to the storage device until sync() is called.
+
Parameters
+ + + +
[in]bufPointer to the location of the data to be written.
[in]sizeNumber of bytes to write.
+
+
+
Returns
For success write() returns the number of bytes written, always nbyte. If an error occurs, write() returns -1. Possible errors include write() is called before a file has been opened, write is called for a read-only file, device is full, a corrupt file system or an I/O error.
@@ -2659,8 +2716,7 @@

Member Function Documentation

-

Write a PROGMEM string to a file.

-
Parameters
+

Write a PROGMEM string to a file.

Parameters
[in]strPointer to the PROGMEM string. Use getWriteError to check for errors.
@@ -2682,8 +2738,7 @@

Member Function Documentation

-

Write a PROGMEM string followed by CR/LF to a file.

-
Parameters
+

Write a PROGMEM string followed by CR/LF to a file.

Parameters
[in]strPointer to the PROGMEM string. Use getWriteError to check for errors.
@@ -2716,14 +2771,14 @@

Member Data Documentation

The documentation for this class was generated from the following files:
  • Arduino/libraries/SdFat/SdFile.h
    • -
  • Arduino/libraries/SdFat/SdFile.cpp
    • +
  • Arduino/libraries/SdFat/SdFile.cpp
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_sd_spi-members.html b/html/class_sd_spi-members.html index 13ce5ba0..3e338787 100644 --- a/html/class_sd_spi-members.html +++ b/html/class_sd_spi-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_sd_spi.html b/html/class_sd_spi.html index d9fed664..02c99982 100644 --- a/html/class_sd_spi.html +++ b/html/class_sd_spi.html @@ -3,7 +3,7 @@ - + SdFat: SdSpi Class Reference @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_sd_stream_base-members.html b/html/class_sd_stream_base-members.html index 5c447959..95184c9b 100644 --- a/html/class_sd_stream_base-members.html +++ b/html/class_sd_stream_base-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_sd_stream_base.html b/html/class_sd_stream_base.html index 86c3995d..ccf9b233 100644 --- a/html/class_sd_stream_base.html +++ b/html/class_sd_stream_base.html @@ -3,7 +3,7 @@ - + SdFat: SdStreamBase Class Reference @@ -25,11 +25,10 @@ - +

enumerated type for the direction of relative seeks

- - -
Enumerator
beg  +
Enumerator
beg 

seek relative to the beginning of the stream

cur  +
cur 

seek relative to the current stream position

end  +
end 

seek relative to the end of the stream

@@ -1139,8 +1140,7 @@

Member Function Documentation

-

Set fill character

-
Parameters
+

Set fill character

Parameters
[in]cnew fill character
@@ -1219,8 +1219,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flag
@@ -1307,8 +1306,7 @@

Member Function Documentation

-

get position for streams

-
Parameters
+

get position for streams

Parameters
[out]posstruct to receive position
@@ -1672,8 +1670,7 @@

Member Function Documentation

-

See open() by path for definition of flags.

-
Returns
true for success or false for failure.
+

See open() by path for definition of flags.

Returns
true for success or false for failure.
@@ -1734,7 +1731,7 @@

Member Function Documentation

O_EXCL - If O_CREAT and O_EXCL are set, open() shall fail if the file exists.

O_SYNC - Call sync() after each write. This flag should not be used with write(uint8_t), write_P(PGM_P), writeln_P(PGM_P), or the Arduino Print class. These functions do character at a time writes so sync() will be called after each byte.

O_TRUNC - If the file exists and is a regular file, and the file is successfully opened and is not read only, its length shall be truncated to 0.

-

WARNING: A given file must not be opened by more than one SdBaseFile object of file corruption may occur.

+

WARNING: A given file must not be opened by more than one SdBaseFile object or file corruption may occur.

Note
Directory files must be opened read only. Write and truncation is not allowed for directory files.
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include this file is already open, dirFile is not a directory, path is invalid, the file does not exist or can't be opened in the access mode specified by oflag.
@@ -1822,8 +1819,7 @@

Member Function Documentation

-

See open() by path for definition of flags.

-
Returns
true for success or false for failure.
+

See open() by path for definition of flags.

Returns
true for success or false for failure.
@@ -1977,8 +1973,7 @@

Member Function Documentation

-

set precision

-
Parameters
+

set precision

Parameters
[in]nnew precision
@@ -2168,6 +2163,55 @@

Member Function Documentation

+
+ + +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
int SdBaseFile::printField (float value,
char term,
uint8_t prec = 2 
)
+ 		+inherited
+
+

Print a number followed by a field terminator.

Parameters
+ + + + +
[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
[in]precNumber of digits after decimal point.
+
+
+
Returns
The number of bytes written or -1 if an error occurs.
+
@@ -2201,8 +2245,7 @@

Member Function Documentation

-

Print a number followed by a field terminator.

-
Parameters
+

Print a number followed by a field terminator.

Parameters
@@ -2244,8 +2287,7 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
-

Print a number followed by a field terminator.

-
Parameters
+

Print a number followed by a field terminator.

Parameters
@@ -2287,8 +2329,7 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
-

Print a number followed by a field terminator.

-
Parameters
+

Print a number followed by a field terminator.

Parameters
@@ -2330,8 +2371,7 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
-

Print a number followed by a field terminator.

-
Parameters
+

Print a number followed by a field terminator.

Parameters
@@ -2363,6 +2403,14 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]termThe field terminator. Use '\n' for CR LF.
+

Print a file's size.

+
Parameters
+ + +
[in]prPrint stream for output.
+
+
+
Returns
The value one, true, is returned for success and the value zero, false, is returned for failure.
@@ -2794,8 +2842,7 @@

Member Function Documentation

-

Set the files position to current position + pos. See seekSet().

-
Parameters
+

Set the files position to current position + pos. See seekSet().

Parameters
[in]offsetThe new position in bytes from the current position.
@@ -2826,8 +2873,7 @@

Member Function Documentation

-

Set the files position to end-of-file + offset. See seekSet().

-
Parameters
+

Set the files position to end-of-file + offset. See seekSet().

Parameters
[in]offsetThe new position in bytes from end-of-file.
@@ -2890,8 +2936,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flags to be or'ed in
@@ -2932,8 +2977,7 @@

Member Function Documentation

-

modify format flags

-
Parameters
+

modify format flags

Parameters
@@ -2965,8 +3009,7 @@

Member Function Documentation

[in]maskflags to be removed
[in]flflags to be set after mask bits have been cleared
-

set position for streams

-
Parameters
+

set position for streams

Parameters
[out]posstruct with value for new position
@@ -3055,7 +3098,7 @@

Member Function Documentation

Copy a file's timestamps

Parameters
- +
[in]fileFile to copy timestamps from.
[in]fileFile to copy timestamps from.
@@ -3231,8 +3274,7 @@

Member Function Documentation

-

clear format flags

-
Parameters
+

clear format flags

Parameters
[in]flflags to be cleared
@@ -3311,8 +3353,7 @@

Member Function Documentation

-

set width

-
Parameters
+

set width

Parameters
[in]nnew width
@@ -3898,9 +3939,9 @@

Member Data Documentation

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_sd_volume-members.html b/html/class_sd_volume-members.html index 2f7ebd5c..381df607 100644 --- a/html/class_sd_volume-members.html +++ b/html/class_sd_volume-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_sd_volume.html b/html/class_sd_volume.html index 57bd2c17..3dbc6906 100644 --- a/html/class_sd_volume.html +++ b/html/class_sd_volume.html @@ -3,7 +3,7 @@ - + SdFat: SdVolume Class Reference @@ -25,11 +25,10 @@ - +
-

Clear the cache and returns a pointer to the cache. Used by the WaveRP recorder to do raw write to the SD card. Not for normal apps.

-
Returns
A pointer to the cache buffer or zero if an error occurs.
+

Clear the cache and returns a pointer to the cache. Used by the WaveRP recorder to do raw write to the SD card. Not for normal apps.

Returns
A pointer to the cache buffer or zero if an error occurs.
@@ -539,42 +538,20 @@

Member Function Documentation

-

Sd2Card object for this volume

-
Returns
pointer to Sd2Card object.
- -
- -

Friends And Related Function Documentation

- -
-
- - - - - -
- - - - -
friend class SdBaseFile
- 		-friend
-
+

Sd2Card object for this volume

Returns
pointer to Sd2Card object.
The documentation for this class was generated from the following files:
  • Arduino/libraries/SdFat/SdVolume.h
    • -
  • Arduino/libraries/SdFat/SdVolume.cpp
    • +
  • Arduino/libraries/SdFat/SdVolume.cpp
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_stdio_stream-members.html b/html/class_stdio_stream-members.html index b7ca1827..0b61c703 100644 --- a/html/class_stdio_stream-members.html +++ b/html/class_stdio_stream-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/class_stdio_stream.html b/html/class_stdio_stream.html index bd26e5a3..88583893 100644 --- a/html/class_stdio_stream.html +++ b/html/class_stdio_stream.html @@ -3,7 +3,7 @@ - + SdFat: StdioStream Class Reference @@ -25,11 +25,10 @@ - +
-

Test the stream's end-of-file indicator.

-
Returns
non-zero if and only if the end-of-file indicator is set.
+

Test the stream's end-of-file indicator.

Returns
non-zero if and only if the end-of-file indicator is set.
@@ -424,8 +422,7 @@

Member Function Documentation

-

Test the stream's error indicator.

-
Returns
return non-zero if and only if the error indicator is set.
+

Test the stream's error indicator.

Returns
return non-zero if and only if the error indicator is set.
@@ -682,8 +679,7 @@

Member Function Documentation

Binary input.

-

Reads an array of up to count elements, each one with a size of size bytes.

-
Parameters
+

Reads an array of up to count elements, each one with a size of size bytes.

Parameters
@@ -780,8 +776,7 @@

Member Function Documentation

[out]ptrpointer to area of at least (size*count) bytes where the data will be stored.
[in]sizethe size, in bytes, of each element to be read.

Binary output.

-

Writes an array of up to count elements, each one with a size of size bytes.

-
Parameters
+

Writes an array of up to count elements, each one with a size of size bytes.

Parameters
@@ -840,8 +835,7 @@

Member Function Documentation

[in]ptrpointer to (size*count) bytes of data to be written.
[in]sizethe size, in bytes, of each element to be written.
-

Write a character.

-
Parameters
+

Write a character.

Parameters
[in]cthe character to write.
@@ -1048,8 +1042,7 @@

Member Function Documentation

-

Print a char as a number.

-
Parameters
+

Print a char as a number.

Parameters
[in]nnumber to be printed.
@@ -1072,8 +1065,7 @@

Member Function Documentation

-

print a signed 8-bit integer

-
Parameters
+

print a signed 8-bit integer

Parameters
[in]nnumber to be printed.
@@ -1104,8 +1096,7 @@

Member Function Documentation

-

Print an unsigned 8-bit number.

-
Parameters
+

Print an unsigned 8-bit number.

Parameters
[in]nnumber to be print.
@@ -1128,8 +1119,7 @@

Member Function Documentation

-

Print a int16_t

-
Parameters
+

Print a int16_t

Parameters
[in]nnumber to be printed.
@@ -1152,8 +1142,7 @@

Member Function Documentation

-

print a uint16_t.

-
Parameters
+

print a uint16_t.

Parameters
[in]nnumber to be printed.
@@ -1176,8 +1165,7 @@

Member Function Documentation

-

Print a signed 32-bit integer.

-
Parameters
+

Print a signed 32-bit integer.

Parameters
[in]nnumber to be printed.
@@ -1200,8 +1188,7 @@

Member Function Documentation

-

Write an unsigned 32-bit number.

-
Parameters
+

Write an unsigned 32-bit number.

Parameters
[in]nnumber to be printed.
@@ -1242,8 +1229,7 @@

Member Function Documentation

-

Print a double.

-
Parameters
+

Print a double.

Parameters
@@ -1277,8 +1263,7 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]precNumber of digits after decimal point.
-

Print a float.

-
Parameters
+

Print a float.

Parameters
@@ -1326,8 +1311,7 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]precNumber of digits after decimal point.
-

Print a number followed by a field terminator.

-
Parameters
+

Print a number followed by a field terminator.

Parameters
@@ -1376,8 +1360,7 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]termThe field terminator.
-

Print a number followed by a field terminator.

-
Parameters
+

Print a number followed by a field terminator.

Parameters
@@ -1422,8 +1405,7 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]termThe field terminator.
-

Print a number followed by a field terminator.

-
Parameters
+

Print a number followed by a field terminator.

Parameters
@@ -1447,8 +1429,7 @@

Member Function Documentation

[in]valueThe number to be printed.
[in]termThe field terminator.
-

Print HEX

-
Parameters
+

Print HEX

Parameters
[in]nnumber to be printed as HEX.
@@ -1479,8 +1460,7 @@

Member Function Documentation

-

Print HEX with CRLF

-
Parameters
+

Print HEX with CRLF

Parameters
[in]nnumber to be printed as HEX.
@@ -1739,14 +1719,14 @@

Member Function Documentation

The documentation for this class was generated from the following files:
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classes.html b/html/classes.html index 541a20fe..262d8042 100644 --- a/html/classes.html +++ b/html/classes.html @@ -3,7 +3,7 @@ - + SdFat: Class Index @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classfstream-members.html b/html/classfstream-members.html index a3812296..f43269e2 100644 --- a/html/classfstream-members.html +++ b/html/classfstream-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classfstream.html b/html/classfstream.html index 2b21134d..e6b1de9d 100644 --- a/html/classfstream.html +++ b/html/classfstream.html @@ -3,7 +3,7 @@ - + SdFat: fstream Class Reference @@ -25,11 +25,10 @@ - +

enumerated type for the direction of relative seeks

- - -
Enumerator
beg  +
Enumerator
beg 

seek relative to the beginning of the stream

cur  +
cur 

seek relative to the current stream position

end  +
end 

seek relative to the end of the stream

@@ -617,29 +616,6 @@

Member Enumeration Documentation

Constructor & Destructor Documentation

- -
-
- - - - - -
- - - - - - - -
fstream::fstream ()
- 		-inline
-
- -
-
@@ -728,8 +704,7 @@

Member Function Documentation

-

Clear state and writeError

-
Parameters
+

Clear state and writeError

Parameters
[in]statenew state for stream
@@ -857,8 +832,7 @@

Member Function Documentation

-

Set fill character

-
Parameters
+

Set fill character

Parameters
[in]cnew fill character
@@ -913,8 +887,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flag
@@ -968,8 +941,7 @@

Member Function Documentation

-

Flushes the buffer associated with this stream. The flush function calls the sync function of the associated file.

-
Returns
A reference to the ostream object.
+

Flushes the buffer associated with this stream. The flush function calls the sync function of the associated file.

Returns
A reference to the ostream object.
@@ -1281,8 +1253,7 @@

Member Function Documentation

-

Open a fstream

-
Parameters
+

Open a fstream

Parameters
@@ -1368,8 +1339,7 @@

Member Function Documentation

[in]pathfile to open
[in]modeopen mode
-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1400,8 +1370,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1432,8 +1401,7 @@

Member Function Documentation

-

Output bool

-
Parameters
+

Output bool

Parameters
[in]argvalue to output
@@ -1464,8 +1432,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -1496,8 +1463,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -1528,8 +1494,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -1560,8 +1525,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1592,8 +1556,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1624,8 +1587,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1656,8 +1618,7 @@

Member Function Documentation

-

Output double

-
Parameters
+

Output double

Parameters
[in]argvalue to output
@@ -1688,8 +1649,7 @@

Member Function Documentation

-

Output float

-
Parameters
+

Output float

Parameters
[in]argvalue to output
@@ -1720,8 +1680,7 @@

Member Function Documentation

-

Output signed short

-
Parameters
+

Output signed short

Parameters
[in]argvalue to output
@@ -1752,8 +1711,7 @@

Member Function Documentation

-

Output unsigned short

-
Parameters
+

Output unsigned short

Parameters
[in]argvalue to output
@@ -1784,8 +1742,7 @@

Member Function Documentation

-

Output signed int

-
Parameters
+

Output signed int

Parameters
[in]argvalue to output
@@ -1816,8 +1773,7 @@

Member Function Documentation

-

Output unsigned int

-
Parameters
+

Output unsigned int

Parameters
[in]argvalue to output
@@ -1848,8 +1804,7 @@

Member Function Documentation

-

Output signed long

-
Parameters
+

Output signed long

Parameters
[in]argvalue to output
@@ -1880,8 +1835,7 @@

Member Function Documentation

-

Output unsigned long

-
Parameters
+

Output unsigned long

Parameters
[in]argvalue to output
@@ -1912,8 +1866,7 @@

Member Function Documentation

-

Output pointer

-
Parameters
+

Output pointer

Parameters
[in]argvalue to output
@@ -1944,8 +1897,7 @@

Member Function Documentation

-

Output a string from flash using the pstr() macro

-
Parameters
+

Output a string from flash using the pstr() macro

Parameters
[in]argpgm struct pointing to string
@@ -1976,8 +1928,7 @@

Member Function Documentation

-

Output a string from flash using the Arduino F() macro.

-
Parameters
+

Output a string from flash using the Arduino F() macro.

Parameters
[in]argpointing to flash string
@@ -2008,8 +1959,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -2040,8 +1990,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -2072,8 +2021,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -2104,8 +2052,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -2136,8 +2083,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -2168,8 +2114,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -2200,8 +2145,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -2232,8 +2176,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -2264,8 +2207,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -2296,8 +2238,7 @@

Member Function Documentation

-

Extract a value of type bool.

-
Parameters
+

Extract a value of type bool.

Parameters
[out]arglocation to store the value.
@@ -2328,8 +2269,7 @@

Member Function Documentation

-

Extract a value of type short.

-
Parameters
+

Extract a value of type short.

Parameters
[out]arglocation to store the value.
@@ -2360,8 +2300,7 @@

Member Function Documentation

-

Extract a value of type unsigned short.

-
Parameters
+

Extract a value of type unsigned short.

Parameters
[out]arglocation to store the value.
@@ -2392,8 +2331,7 @@

Member Function Documentation

-

Extract a value of type int.

-
Parameters
+

Extract a value of type int.

Parameters
[out]arglocation to store the value.
@@ -2424,8 +2362,7 @@

Member Function Documentation

-

Extract a value of type unsigned int.

-
Parameters
+

Extract a value of type unsigned int.

Parameters
[out]arglocation to store the value.
@@ -2456,8 +2393,7 @@

Member Function Documentation

-

Extract a value of type long.

-
Parameters
+

Extract a value of type long.

Parameters
[out]arglocation to store the value.
@@ -2488,8 +2424,7 @@

Member Function Documentation

-

Extract a value of type unsigned long.

-
Parameters
+

Extract a value of type unsigned long.

Parameters
[out]arglocation to store the value.
@@ -2520,8 +2455,7 @@

Member Function Documentation

-

Extract a value of type double.

-
Parameters
+

Extract a value of type double.

Parameters
[out]arglocation to store the value.
@@ -2552,8 +2486,7 @@

Member Function Documentation

-

Extract a value of type float.

-
Parameters
+

Extract a value of type float.

Parameters
[out]arglocation to store the value.
@@ -2584,8 +2517,7 @@

Member Function Documentation

-

Extract a value of type void*.

-
Parameters
+

Extract a value of type void*.

Parameters
[out]arglocation to store the value.
@@ -2665,8 +2597,7 @@

Member Function Documentation

-

set precision

-
Parameters
+

set precision

Parameters
[in]nnew precision
@@ -2754,8 +2685,7 @@

Member Function Documentation

-

Set the stream position

-
Parameters
+

Set the stream position

Parameters
[in]posThe absolute position in which to move the read pointer.
@@ -2829,8 +2759,7 @@

Member Function Documentation

-

Set the stream position

-
Parameters
+

Set the stream position

Parameters
[in]posThe absolute position in which to move the write pointer.
@@ -2904,8 +2833,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flags to be or'ed in
@@ -2946,8 +2874,7 @@

Member Function Documentation

-

modify format flags

-
Parameters
+

modify format flags

Parameters
@@ -3082,8 +3009,7 @@

Member Function Documentation

[in]maskflags to be removed
[in]flflags to be set after mask bits have been cleared
-

clear format flags

-
Parameters
+

clear format flags

Parameters
[in]flflags to be cleared
@@ -3138,8 +3064,7 @@

Member Function Documentation

-

set width

-
Parameters
+

set width

Parameters
[in]nnew width
@@ -3660,9 +3585,9 @@

Member Data Documentation

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classibufstream-members.html b/html/classibufstream-members.html index f664e6f5..251e7e17 100644 --- a/html/classibufstream-members.html +++ b/html/classibufstream-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classibufstream.html b/html/classibufstream.html index ce0607c3..8a58ebe0 100644 --- a/html/classibufstream.html +++ b/html/classibufstream.html @@ -3,7 +3,7 @@ - + SdFat: ibufstream Class Reference @@ -25,11 +25,10 @@ - +

enumerated type for the direction of relative seeks

- - -
Enumerator
beg  +
Enumerator
beg 

seek relative to the beginning of the stream

cur  +
cur 

seek relative to the current stream position

end  +
end 

seek relative to the end of the stream

@@ -466,8 +465,7 @@

Constructor & Destructor Documentation

-

Constructor

-
Parameters
+

Constructor

Parameters
[in]strpointer to string to be parsed Warning: The string will not be copied so must stay in scope.
@@ -627,8 +625,7 @@

Member Function Documentation

-

Set fill character

-
Parameters
+

Set fill character

Parameters
[in]cnew fill character
@@ -683,8 +680,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flag
@@ -992,8 +988,7 @@

Member Function Documentation

-

Initialize an ibufstream

-
Parameters
+

Initialize an ibufstream

Parameters
[in]strpointer to string to be parsed Warning: The string will not be copied so must stay in scope.
@@ -1071,8 +1066,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1103,8 +1097,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1135,8 +1128,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1167,8 +1159,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -1199,8 +1190,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -1231,8 +1221,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -1263,8 +1252,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -1295,8 +1283,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -1327,8 +1314,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -1359,8 +1345,7 @@

Member Function Documentation

-

Extract a value of type bool.

-
Parameters
+

Extract a value of type bool.

Parameters
[out]arglocation to store the value.
@@ -1391,8 +1376,7 @@

Member Function Documentation

-

Extract a value of type short.

-
Parameters
+

Extract a value of type short.

Parameters
[out]arglocation to store the value.
@@ -1423,8 +1407,7 @@

Member Function Documentation

-

Extract a value of type unsigned short.

-
Parameters
+

Extract a value of type unsigned short.

Parameters
[out]arglocation to store the value.
@@ -1455,8 +1438,7 @@

Member Function Documentation

-

Extract a value of type int.

-
Parameters
+

Extract a value of type int.

Parameters
[out]arglocation to store the value.
@@ -1487,8 +1469,7 @@

Member Function Documentation

-

Extract a value of type unsigned int.

-
Parameters
+

Extract a value of type unsigned int.

Parameters
[out]arglocation to store the value.
@@ -1519,8 +1500,7 @@

Member Function Documentation

-

Extract a value of type long.

-
Parameters
+

Extract a value of type long.

Parameters
[out]arglocation to store the value.
@@ -1551,8 +1531,7 @@

Member Function Documentation

-

Extract a value of type unsigned long.

-
Parameters
+

Extract a value of type unsigned long.

Parameters
[out]arglocation to store the value.
@@ -1583,8 +1562,7 @@

Member Function Documentation

-

Extract a value of type double.

-
Parameters
+

Extract a value of type double.

Parameters
[out]arglocation to store the value.
@@ -1615,8 +1593,7 @@

Member Function Documentation

-

Extract a value of type float.

-
Parameters
+

Extract a value of type float.

Parameters
[out]arglocation to store the value.
@@ -1647,8 +1624,7 @@

Member Function Documentation

-

Extract a value of type void*.

-
Parameters
+

Extract a value of type void*.

Parameters
[out]arglocation to store the value.
@@ -1728,8 +1704,7 @@

Member Function Documentation

-

set precision

-
Parameters
+

set precision

Parameters
[in]nnew precision
@@ -1784,8 +1759,7 @@

Member Function Documentation

-

Set the stream position

-
Parameters
+

Set the stream position

Parameters
[in]posThe absolute position in which to move the read pointer.
@@ -1859,8 +1833,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flags to be or'ed in
@@ -1901,8 +1874,7 @@

Member Function Documentation

-

modify format flags

-
Parameters
+

modify format flags

Parameters
@@ -2013,8 +1985,7 @@

Member Function Documentation

[in]maskflags to be removed
[in]flflags to be set after mask bits have been cleared
-

clear format flags

-
Parameters
+

clear format flags

Parameters
[in]flflags to be cleared
@@ -2069,8 +2040,7 @@

Member Function Documentation

-

set width

-
Parameters
+

set width

Parameters
[in]nnew width
@@ -2591,9 +2561,9 @@

Member Data Documentation

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classifstream-members.html b/html/classifstream-members.html index 4df8efdd..72c74052 100644 --- a/html/classifstream-members.html +++ b/html/classifstream-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classifstream.html b/html/classifstream.html index 97ac364b..537698fd 100644 --- a/html/classifstream.html +++ b/html/classifstream.html @@ -3,7 +3,7 @@ - + SdFat: ifstream Class Reference @@ -25,11 +25,10 @@ - +

enumerated type for the direction of relative seeks

- - -
Enumerator
beg  +
Enumerator
beg 

seek relative to the beginning of the stream

cur  +
cur 

seek relative to the current stream position

end  +
end 

seek relative to the end of the stream

@@ -567,29 +566,6 @@

Member Enumeration Documentation

Constructor & Destructor Documentation

- -
-
- - - - - -
- - - - - - - -
ifstream::ifstream ()
- 		-inline
-
- -
-
@@ -621,8 +597,7 @@

Constructor & Destructor Documentation

-

Constructor with open

-
Parameters
+

Constructor with open

Parameters
@@ -807,8 +782,7 @@

Member Function Documentation

[in]pathfile to open
[in]modeopen mode
-

Set fill character

-
Parameters
+

Set fill character

Parameters
[in]cnew fill character
@@ -863,8 +837,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flag
@@ -1206,8 +1179,7 @@

Member Function Documentation

-

Open an ifstream

-
Parameters
+

Open an ifstream

Parameters
@@ -1287,8 +1259,7 @@

Member Function Documentation

[in]pathfile to open
[in]modeopen mode
-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1319,8 +1290,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1351,8 +1321,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1383,8 +1352,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -1415,8 +1383,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -1447,8 +1414,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -1479,8 +1445,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -1511,8 +1476,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -1543,8 +1507,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -1575,8 +1538,7 @@

Member Function Documentation

-

Extract a value of type bool.

-
Parameters
+

Extract a value of type bool.

Parameters
[out]arglocation to store the value.
@@ -1607,8 +1569,7 @@

Member Function Documentation

-

Extract a value of type short.

-
Parameters
+

Extract a value of type short.

Parameters
[out]arglocation to store the value.
@@ -1639,8 +1600,7 @@

Member Function Documentation

-

Extract a value of type unsigned short.

-
Parameters
+

Extract a value of type unsigned short.

Parameters
[out]arglocation to store the value.
@@ -1671,8 +1631,7 @@

Member Function Documentation

-

Extract a value of type int.

-
Parameters
+

Extract a value of type int.

Parameters
[out]arglocation to store the value.
@@ -1703,8 +1662,7 @@

Member Function Documentation

-

Extract a value of type unsigned int.

-
Parameters
+

Extract a value of type unsigned int.

Parameters
[out]arglocation to store the value.
@@ -1735,8 +1693,7 @@

Member Function Documentation

-

Extract a value of type long.

-
Parameters
+

Extract a value of type long.

Parameters
[out]arglocation to store the value.
@@ -1767,8 +1724,7 @@

Member Function Documentation

-

Extract a value of type unsigned long.

-
Parameters
+

Extract a value of type unsigned long.

Parameters
[out]arglocation to store the value.
@@ -1799,8 +1755,7 @@

Member Function Documentation

-

Extract a value of type double.

-
Parameters
+

Extract a value of type double.

Parameters
[out]arglocation to store the value.
@@ -1831,8 +1786,7 @@

Member Function Documentation

-

Extract a value of type float.

-
Parameters
+

Extract a value of type float.

Parameters
[out]arglocation to store the value.
@@ -1863,8 +1817,7 @@

Member Function Documentation

-

Extract a value of type void*.

-
Parameters
+

Extract a value of type void*.

Parameters
[out]arglocation to store the value.
@@ -1944,8 +1897,7 @@

Member Function Documentation

-

set precision

-
Parameters
+

set precision

Parameters
[in]nnew precision
@@ -2000,8 +1952,7 @@

Member Function Documentation

-

Set the stream position

-
Parameters
+

Set the stream position

Parameters
[in]posThe absolute position in which to move the read pointer.
@@ -2075,8 +2026,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flags to be or'ed in
@@ -2117,8 +2067,7 @@

Member Function Documentation

-

modify format flags

-
Parameters
+

modify format flags

Parameters
@@ -2229,8 +2178,7 @@

Member Function Documentation

[in]maskflags to be removed
[in]flflags to be set after mask bits have been cleared
-

clear format flags

-
Parameters
+

clear format flags

Parameters
[in]flflags to be cleared
@@ -2285,8 +2233,7 @@

Member Function Documentation

-

set width

-
Parameters
+

set width

Parameters
[in]nnew width
@@ -2807,9 +2754,9 @@

Member Data Documentation

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classios-members.html b/html/classios-members.html index 8723ab1d..67a96125 100644 --- a/html/classios-members.html +++ b/html/classios-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@
- +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classios.html b/html/classios.html index 852bd94c..89517dc5 100644 --- a/html/classios.html +++ b/html/classios.html @@ -3,7 +3,7 @@ - + SdFat: ios Class Reference @@ -25,11 +25,10 @@ - +

enumerated type for the direction of relative seeks

- - -
Enumerator
beg  +
Enumerator
beg 

seek relative to the beginning of the stream

cur  +
cur 

seek relative to the current stream position

end  +
end 

seek relative to the end of the stream

@@ -532,8 +531,7 @@

Member Function Documentation

-

Set fill character

-
Parameters
+

Set fill character

Parameters
[in]cnew fill character
@@ -588,8 +586,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flag
@@ -740,8 +737,7 @@

Member Function Documentation

-

set precision

-
Parameters
+

set precision

Parameters
[in]nnew precision
@@ -796,8 +792,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flags to be or'ed in
@@ -838,8 +833,7 @@

Member Function Documentation

-

modify format flags

-
Parameters
+

modify format flags

Parameters
@@ -902,8 +896,7 @@

Member Function Documentation

[in]maskflags to be removed
[in]flflags to be set after mask bits have been cleared
-

clear format flags

-
Parameters
+

clear format flags

Parameters
[in]flflags to be cleared
@@ -958,8 +951,7 @@

Member Function Documentation

-

set width

-
Parameters
+

set width

Parameters
[in]nnew width
@@ -1480,9 +1472,9 @@

Member Data Documentation

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classios__base-members.html b/html/classios__base-members.html index 0360b60a..66e7b713 100644 --- a/html/classios__base-members.html +++ b/html/classios__base-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classios__base.html b/html/classios__base.html index 2a8d482d..87e913ae 100644 --- a/html/classios__base.html +++ b/html/classios__base.html @@ -3,7 +3,7 @@ - + SdFat: ios_base Class Reference @@ -25,11 +25,10 @@ - +

enumerated type for the direction of relative seeks

- - -
Enumerator
beg  +
Enumerator
beg 

seek relative to the beginning of the stream

cur  +
cur 

seek relative to the current stream position

end  +
end 

seek relative to the end of the stream

-
- -

Constructor & Destructor Documentation

- -
-
- - - - - -
- - - - - - - -
ios_base::ios_base ()
- 		-inline
-
-

Member Function Documentation

@@ -345,8 +318,7 @@

Member Function Documentation

-

Set fill character

-
Parameters
+

Set fill character

Parameters
[in]cnew fill character
@@ -401,8 +373,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flag
@@ -481,8 +452,7 @@

Member Function Documentation

-

set precision

-
Parameters
+

set precision

Parameters
[in]nnew precision
@@ -513,8 +483,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flags to be or'ed in
@@ -555,8 +524,7 @@

Member Function Documentation

-

modify format flags

-
Parameters
+

modify format flags

Parameters
@@ -588,8 +556,7 @@

Member Function Documentation

[in]maskflags to be removed
[in]flflags to be set after mask bits have been cleared
-

clear format flags

-
Parameters
+

clear format flags

Parameters
[in]flflags to be cleared
@@ -644,8 +611,7 @@

Member Function Documentation

-

set width

-
Parameters
+

set width

Parameters
[in]nnew width
@@ -1166,9 +1132,9 @@

Member Data Documentation

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classiostream-members.html b/html/classiostream-members.html index 87a2955d..63b46481 100644 --- a/html/classiostream-members.html +++ b/html/classiostream-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classiostream.html b/html/classiostream.html index 542d04c7..14f4fdab 100644 --- a/html/classiostream.html +++ b/html/classiostream.html @@ -3,7 +3,7 @@ - + SdFat: iostream Class Reference @@ -25,11 +25,10 @@ - +

enumerated type for the direction of relative seeks

- - -
Enumerator
beg  +
Enumerator
beg 

seek relative to the beginning of the stream

cur  +
cur 

seek relative to the current stream position

end  +
end 

seek relative to the end of the stream

@@ -615,8 +614,7 @@

Member Function Documentation

-

Set fill character

-
Parameters
+

Set fill character

Parameters
[in]cnew fill character
@@ -671,8 +669,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flag
@@ -726,8 +723,7 @@

Member Function Documentation

-

Flushes the buffer associated with this stream. The flush function calls the sync function of the associated file.

-
Returns
A reference to the ostream object.
+

Flushes the buffer associated with this stream. The flush function calls the sync function of the associated file.

Returns
A reference to the ostream object.
@@ -1053,8 +1049,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1085,8 +1080,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1117,8 +1111,7 @@

Member Function Documentation

-

Output bool

-
Parameters
+

Output bool

Parameters
[in]argvalue to output
@@ -1149,8 +1142,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -1181,8 +1173,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -1213,8 +1204,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -1245,8 +1235,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1277,8 +1266,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1309,8 +1297,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1341,8 +1328,7 @@

Member Function Documentation

-

Output double

-
Parameters
+

Output double

Parameters
[in]argvalue to output
@@ -1373,8 +1359,7 @@

Member Function Documentation

-

Output float

-
Parameters
+

Output float

Parameters
[in]argvalue to output
@@ -1405,8 +1390,7 @@

Member Function Documentation

-

Output signed short

-
Parameters
+

Output signed short

Parameters
[in]argvalue to output
@@ -1437,8 +1421,7 @@

Member Function Documentation

-

Output unsigned short

-
Parameters
+

Output unsigned short

Parameters
[in]argvalue to output
@@ -1469,8 +1452,7 @@

Member Function Documentation

-

Output signed int

-
Parameters
+

Output signed int

Parameters
[in]argvalue to output
@@ -1501,8 +1483,7 @@

Member Function Documentation

-

Output unsigned int

-
Parameters
+

Output unsigned int

Parameters
[in]argvalue to output
@@ -1533,8 +1514,7 @@

Member Function Documentation

-

Output signed long

-
Parameters
+

Output signed long

Parameters
[in]argvalue to output
@@ -1565,8 +1545,7 @@

Member Function Documentation

-

Output unsigned long

-
Parameters
+

Output unsigned long

Parameters
[in]argvalue to output
@@ -1597,8 +1576,7 @@

Member Function Documentation

-

Output pointer

-
Parameters
+

Output pointer

Parameters
[in]argvalue to output
@@ -1629,8 +1607,7 @@

Member Function Documentation

-

Output a string from flash using the pstr() macro

-
Parameters
+

Output a string from flash using the pstr() macro

Parameters
[in]argpgm struct pointing to string
@@ -1661,8 +1638,7 @@

Member Function Documentation

-

Output a string from flash using the Arduino F() macro.

-
Parameters
+

Output a string from flash using the Arduino F() macro.

Parameters
[in]argpointing to flash string
@@ -1693,8 +1669,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1725,8 +1700,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1757,8 +1731,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1789,8 +1762,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -1821,8 +1793,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -1853,8 +1824,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -1885,8 +1855,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -1917,8 +1886,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -1949,8 +1917,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -1981,8 +1948,7 @@

Member Function Documentation

-

Extract a value of type bool.

-
Parameters
+

Extract a value of type bool.

Parameters
[out]arglocation to store the value.
@@ -2013,8 +1979,7 @@

Member Function Documentation

-

Extract a value of type short.

-
Parameters
+

Extract a value of type short.

Parameters
[out]arglocation to store the value.
@@ -2045,8 +2010,7 @@

Member Function Documentation

-

Extract a value of type unsigned short.

-
Parameters
+

Extract a value of type unsigned short.

Parameters
[out]arglocation to store the value.
@@ -2077,8 +2041,7 @@

Member Function Documentation

-

Extract a value of type int.

-
Parameters
+

Extract a value of type int.

Parameters
[out]arglocation to store the value.
@@ -2109,8 +2072,7 @@

Member Function Documentation

-

Extract a value of type unsigned int.

-
Parameters
+

Extract a value of type unsigned int.

Parameters
[out]arglocation to store the value.
@@ -2141,8 +2103,7 @@

Member Function Documentation

-

Extract a value of type long.

-
Parameters
+

Extract a value of type long.

Parameters
[out]arglocation to store the value.
@@ -2173,8 +2134,7 @@

Member Function Documentation

-

Extract a value of type unsigned long.

-
Parameters
+

Extract a value of type unsigned long.

Parameters
[out]arglocation to store the value.
@@ -2205,8 +2165,7 @@

Member Function Documentation

-

Extract a value of type double.

-
Parameters
+

Extract a value of type double.

Parameters
[out]arglocation to store the value.
@@ -2237,8 +2196,7 @@

Member Function Documentation

-

Extract a value of type float.

-
Parameters
+

Extract a value of type float.

Parameters
[out]arglocation to store the value.
@@ -2269,8 +2227,7 @@

Member Function Documentation

-

Extract a value of type void*.

-
Parameters
+

Extract a value of type void*.

Parameters
[out]arglocation to store the value.
@@ -2350,8 +2307,7 @@

Member Function Documentation

-

set precision

-
Parameters
+

set precision

Parameters
[in]nnew precision
@@ -2439,8 +2395,7 @@

Member Function Documentation

-

Set the stream position

-
Parameters
+

Set the stream position

Parameters
[in]posThe absolute position in which to move the read pointer.
@@ -2514,8 +2469,7 @@

Member Function Documentation

-

Set the stream position

-
Parameters
+

Set the stream position

Parameters
[in]posThe absolute position in which to move the write pointer.
@@ -2589,8 +2543,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flags to be or'ed in
@@ -2631,8 +2584,7 @@

Member Function Documentation

-

modify format flags

-
Parameters
+

modify format flags

Parameters
@@ -2767,8 +2719,7 @@

Member Function Documentation

[in]maskflags to be removed
[in]flflags to be set after mask bits have been cleared
-

clear format flags

-
Parameters
+

clear format flags

Parameters
[in]flflags to be cleared
@@ -2823,8 +2774,7 @@

Member Function Documentation

-

set width

-
Parameters
+

set width

Parameters
[in]nnew width
@@ -3345,9 +3295,9 @@

Member Data Documentation

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classistream-members.html b/html/classistream-members.html index 7f5b7f72..a78482c4 100644 --- a/html/classistream-members.html +++ b/html/classistream-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classistream.html b/html/classistream.html index 03b88e3c..6048cc0f 100644 --- a/html/classistream.html +++ b/html/classistream.html @@ -3,7 +3,7 @@ - + SdFat: istream Class Reference @@ -25,11 +25,10 @@ - +

enumerated type for the direction of relative seeks

- - -
Enumerator
beg  +
Enumerator
beg 

seek relative to the beginning of the stream

cur  +
cur 

seek relative to the current stream position

end  +
end 

seek relative to the end of the stream

-
- -

Constructor & Destructor Documentation

- -
-
- - - - - -
- - - - - - - -
istream::istream ()
- 		-inline
-
-

Member Function Documentation

@@ -591,8 +564,7 @@

Member Function Documentation

-

Set fill character

-
Parameters
+

Set fill character

Parameters
[in]cnew fill character
@@ -647,8 +619,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flag
@@ -964,8 +935,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -996,8 +966,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1028,8 +997,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1060,8 +1028,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -1092,8 +1059,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -1124,8 +1090,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -1156,8 +1121,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -1188,8 +1152,7 @@

Member Function Documentation

-

Extract a character string

-
Parameters
+

Extract a character string

Parameters
[out]strlocation to store the string.
@@ -1220,8 +1183,7 @@

Member Function Documentation

-

Extract a character

-
Parameters
+

Extract a character

Parameters
[out]chlocation to store the character.
@@ -1252,8 +1214,7 @@

Member Function Documentation

-

Extract a value of type bool.

-
Parameters
+

Extract a value of type bool.

Parameters
[out]arglocation to store the value.
@@ -1284,8 +1245,7 @@

Member Function Documentation

-

Extract a value of type short.

-
Parameters
+

Extract a value of type short.

Parameters
[out]arglocation to store the value.
@@ -1316,8 +1276,7 @@

Member Function Documentation

-

Extract a value of type unsigned short.

-
Parameters
+

Extract a value of type unsigned short.

Parameters
[out]arglocation to store the value.
@@ -1348,8 +1307,7 @@

Member Function Documentation

-

Extract a value of type int.

-
Parameters
+

Extract a value of type int.

Parameters
[out]arglocation to store the value.
@@ -1380,8 +1338,7 @@

Member Function Documentation

-

Extract a value of type unsigned int.

-
Parameters
+

Extract a value of type unsigned int.

Parameters
[out]arglocation to store the value.
@@ -1412,8 +1369,7 @@

Member Function Documentation

-

Extract a value of type long.

-
Parameters
+

Extract a value of type long.

Parameters
[out]arglocation to store the value.
@@ -1444,8 +1400,7 @@

Member Function Documentation

-

Extract a value of type unsigned long.

-
Parameters
+

Extract a value of type unsigned long.

Parameters
[out]arglocation to store the value.
@@ -1476,8 +1431,7 @@

Member Function Documentation

-

Extract a value of type double.

-
Parameters
+

Extract a value of type double.

Parameters
[out]arglocation to store the value.
@@ -1508,8 +1462,7 @@

Member Function Documentation

-

Extract a value of type float.

-
Parameters
+

Extract a value of type float.

Parameters
[out]arglocation to store the value.
@@ -1540,8 +1493,7 @@

Member Function Documentation

-

Extract a value of type void*.

-
Parameters
+

Extract a value of type void*.

Parameters
[out]arglocation to store the value.
@@ -1613,8 +1565,7 @@

Member Function Documentation

-

set precision

-
Parameters
+

set precision

Parameters
[in]nnew precision
@@ -1669,8 +1620,7 @@

Member Function Documentation

-

Set the stream position

-
Parameters
+

Set the stream position

Parameters
[in]posThe absolute position in which to move the read pointer.
@@ -1744,8 +1694,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flags to be or'ed in
@@ -1786,8 +1735,7 @@

Member Function Documentation

-

modify format flags

-
Parameters
+

modify format flags

Parameters
@@ -1890,8 +1838,7 @@

Member Function Documentation

[in]maskflags to be removed
[in]flflags to be set after mask bits have been cleared
-

clear format flags

-
Parameters
+

clear format flags

Parameters
[in]flflags to be cleared
@@ -1946,8 +1893,7 @@

Member Function Documentation

-

set width

-
Parameters
+

set width

Parameters
[in]nnew width
@@ -2464,14 +2410,14 @@

Member Data Documentation

The documentation for this class was generated from the following files:
  • Arduino/libraries/SdFat/istream.h
    • -
  • Arduino/libraries/SdFat/istream.cpp
    • +
  • Arduino/libraries/SdFat/istream.cpp
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classobufstream-members.html b/html/classobufstream-members.html index 4a629477..6462445a 100644 --- a/html/classobufstream-members.html +++ b/html/classobufstream-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classobufstream.html b/html/classobufstream.html index ff5f2014..62edbbdc 100644 --- a/html/classobufstream.html +++ b/html/classobufstream.html @@ -3,7 +3,7 @@ - + SdFat: obufstream Class Reference @@ -25,11 +25,10 @@ - +

enumerated type for the direction of relative seeks

- - -
Enumerator
beg  +
Enumerator
beg 

seek relative to the beginning of the stream

cur  +
cur 

seek relative to the current stream position

end  +
end 

seek relative to the end of the stream

@@ -470,8 +469,7 @@

Constructor & Destructor Documentation

-

Constructor

-
Parameters
+

Constructor

Parameters
@@ -656,8 +654,7 @@

Member Function Documentation

[in]bufbuffer for formatted string
[in]sizebuffer size
-

Set fill character

-
Parameters
+

Set fill character

Parameters
[in]cnew fill character
@@ -712,8 +709,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flag
@@ -767,8 +763,7 @@

Member Function Documentation

-

Flushes the buffer associated with this stream. The flush function calls the sync function of the associated file.

-
Returns
A reference to the ostream object.
+

Flushes the buffer associated with this stream. The flush function calls the sync function of the associated file.

Returns
A reference to the ostream object.
@@ -827,8 +822,7 @@

Member Function Documentation

-

Initialize an obufstream

-
Parameters
+

Initialize an obufstream

Parameters
@@ -931,8 +925,7 @@

Member Function Documentation

[in]bufbuffer for formatted string
[in]sizebuffer size
-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -963,8 +956,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -995,8 +987,7 @@

Member Function Documentation

-

Output bool

-
Parameters
+

Output bool

Parameters
[in]argvalue to output
@@ -1027,8 +1018,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -1059,8 +1049,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -1091,8 +1080,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -1123,8 +1111,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1155,8 +1142,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1187,8 +1173,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1219,8 +1204,7 @@

Member Function Documentation

-

Output double

-
Parameters
+

Output double

Parameters
[in]argvalue to output
@@ -1251,8 +1235,7 @@

Member Function Documentation

-

Output float

-
Parameters
+

Output float

Parameters
[in]argvalue to output
@@ -1283,8 +1266,7 @@

Member Function Documentation

-

Output signed short

-
Parameters
+

Output signed short

Parameters
[in]argvalue to output
@@ -1315,8 +1297,7 @@

Member Function Documentation

-

Output unsigned short

-
Parameters
+

Output unsigned short

Parameters
[in]argvalue to output
@@ -1347,8 +1328,7 @@

Member Function Documentation

-

Output signed int

-
Parameters
+

Output signed int

Parameters
[in]argvalue to output
@@ -1379,8 +1359,7 @@

Member Function Documentation

-

Output unsigned int

-
Parameters
+

Output unsigned int

Parameters
[in]argvalue to output
@@ -1411,8 +1390,7 @@

Member Function Documentation

-

Output signed long

-
Parameters
+

Output signed long

Parameters
[in]argvalue to output
@@ -1443,8 +1421,7 @@

Member Function Documentation

-

Output unsigned long

-
Parameters
+

Output unsigned long

Parameters
[in]argvalue to output
@@ -1475,8 +1452,7 @@

Member Function Documentation

-

Output pointer

-
Parameters
+

Output pointer

Parameters
[in]argvalue to output
@@ -1507,8 +1483,7 @@

Member Function Documentation

-

Output a string from flash using the pstr() macro

-
Parameters
+

Output a string from flash using the pstr() macro

Parameters
[in]argpgm struct pointing to string
@@ -1539,8 +1514,7 @@

Member Function Documentation

-

Output a string from flash using the Arduino F() macro.

-
Parameters
+

Output a string from flash using the Arduino F() macro.

Parameters
[in]argpointing to flash string
@@ -1595,8 +1569,7 @@

Member Function Documentation

-

set precision

-
Parameters
+

set precision

Parameters
[in]nnew precision
@@ -1684,8 +1657,7 @@

Member Function Documentation

-

Set the stream position

-
Parameters
+

Set the stream position

Parameters
[in]posThe absolute position in which to move the write pointer.
@@ -1759,8 +1731,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flags to be or'ed in
@@ -1801,8 +1772,7 @@

Member Function Documentation

-

modify format flags

-
Parameters
+

modify format flags

Parameters
@@ -1889,8 +1859,7 @@

Member Function Documentation

[in]maskflags to be removed
[in]flflags to be set after mask bits have been cleared
-

clear format flags

-
Parameters
+

clear format flags

Parameters
[in]flflags to be cleared
@@ -1945,8 +1914,7 @@

Member Function Documentation

-

set width

-
Parameters
+

set width

Parameters
[in]nnew width
@@ -2467,9 +2435,9 @@

Member Data Documentation

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classofstream-members.html b/html/classofstream-members.html index d15fdfd4..8d468325 100644 --- a/html/classofstream-members.html +++ b/html/classofstream-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classofstream.html b/html/classofstream.html index 75bf0d74..bf535837 100644 --- a/html/classofstream.html +++ b/html/classofstream.html @@ -3,7 +3,7 @@ - + SdFat: ofstream Class Reference @@ -25,11 +25,10 @@ - +

enumerated type for the direction of relative seeks

- - -
Enumerator
beg  +
Enumerator
beg 

seek relative to the beginning of the stream

cur  +
cur 

seek relative to the current stream position

end  +
end 

seek relative to the end of the stream

@@ -557,29 +556,6 @@

Member Enumeration Documentation

Constructor & Destructor Documentation

- -
-
- - - - - -
- - - - - - - -
ofstream::ofstream ()
- 		-inline
-
- -
-
@@ -611,8 +587,7 @@

Constructor & Destructor Documentation

-

Constructor with open

-
Parameters
+

Constructor with open

Parameters
@@ -668,8 +643,7 @@

Member Function Documentation

[in]pathfile to open
[in]modeopen mode
-

Clear state and writeError

-
Parameters
+

Clear state and writeError

Parameters
[in]statenew state for stream
@@ -797,8 +771,7 @@

Member Function Documentation

-

Set fill character

-
Parameters
+

Set fill character

Parameters
[in]cnew fill character
@@ -853,8 +826,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flag
@@ -908,8 +880,7 @@

Member Function Documentation

-

Flushes the buffer associated with this stream. The flush function calls the sync function of the associated file.

-
Returns
A reference to the ostream object.
+

Flushes the buffer associated with this stream. The flush function calls the sync function of the associated file.

Returns
A reference to the ostream object.
@@ -992,8 +963,7 @@

Member Function Documentation

-

Open an ofstream

-
Parameters
+

Open an ofstream

Parameters
@@ -1073,8 +1043,7 @@

Member Function Documentation

[in]pathfile to open
[in]modeopen mode
-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1105,8 +1074,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -1137,8 +1105,7 @@

Member Function Documentation

-

Output bool

-
Parameters
+

Output bool

Parameters
[in]argvalue to output
@@ -1169,8 +1136,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -1201,8 +1167,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -1233,8 +1198,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -1265,8 +1229,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1297,8 +1260,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1329,8 +1291,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1361,8 +1322,7 @@

Member Function Documentation

-

Output double

-
Parameters
+

Output double

Parameters
[in]argvalue to output
@@ -1393,8 +1353,7 @@

Member Function Documentation

-

Output float

-
Parameters
+

Output float

Parameters
[in]argvalue to output
@@ -1425,8 +1384,7 @@

Member Function Documentation

-

Output signed short

-
Parameters
+

Output signed short

Parameters
[in]argvalue to output
@@ -1457,8 +1415,7 @@

Member Function Documentation

-

Output unsigned short

-
Parameters
+

Output unsigned short

Parameters
[in]argvalue to output
@@ -1489,8 +1446,7 @@

Member Function Documentation

-

Output signed int

-
Parameters
+

Output signed int

Parameters
[in]argvalue to output
@@ -1521,8 +1477,7 @@

Member Function Documentation

-

Output unsigned int

-
Parameters
+

Output unsigned int

Parameters
[in]argvalue to output
@@ -1553,8 +1508,7 @@

Member Function Documentation

-

Output signed long

-
Parameters
+

Output signed long

Parameters
[in]argvalue to output
@@ -1585,8 +1539,7 @@

Member Function Documentation

-

Output unsigned long

-
Parameters
+

Output unsigned long

Parameters
[in]argvalue to output
@@ -1617,8 +1570,7 @@

Member Function Documentation

-

Output pointer

-
Parameters
+

Output pointer

Parameters
[in]argvalue to output
@@ -1649,8 +1601,7 @@

Member Function Documentation

-

Output a string from flash using the pstr() macro

-
Parameters
+

Output a string from flash using the pstr() macro

Parameters
[in]argpgm struct pointing to string
@@ -1681,8 +1632,7 @@

Member Function Documentation

-

Output a string from flash using the Arduino F() macro.

-
Parameters
+

Output a string from flash using the Arduino F() macro.

Parameters
[in]argpointing to flash string
@@ -1737,8 +1687,7 @@

Member Function Documentation

-

set precision

-
Parameters
+

set precision

Parameters
[in]nnew precision
@@ -1826,8 +1775,7 @@

Member Function Documentation

-

Set the stream position

-
Parameters
+

Set the stream position

Parameters
[in]posThe absolute position in which to move the write pointer.
@@ -1901,8 +1849,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flags to be or'ed in
@@ -1943,8 +1890,7 @@

Member Function Documentation

-

modify format flags

-
Parameters
+

modify format flags

Parameters
@@ -2031,8 +1977,7 @@

Member Function Documentation

[in]maskflags to be removed
[in]flflags to be set after mask bits have been cleared
-

clear format flags

-
Parameters
+

clear format flags

Parameters
[in]flflags to be cleared
@@ -2087,8 +2032,7 @@

Member Function Documentation

-

set width

-
Parameters
+

set width

Parameters
[in]nnew width
@@ -2609,9 +2553,9 @@

Member Data Documentation

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classostream-members.html b/html/classostream-members.html index e8d297e9..1a46ae3e 100644 --- a/html/classostream-members.html +++ b/html/classostream-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/classostream.html b/html/classostream.html index c10fcccf..132f5f31 100644 --- a/html/classostream.html +++ b/html/classostream.html @@ -3,7 +3,7 @@ - + SdFat: ostream Class Reference @@ -25,11 +25,10 @@ - +

enumerated type for the direction of relative seeks

- - -
Enumerator
beg  +
Enumerator
beg 

seek relative to the beginning of the stream

cur  +
cur 

seek relative to the current stream position

end  +
end 

seek relative to the end of the stream

-
- -

Constructor & Destructor Documentation

- -
-
- - - - - -
- - - - - - - -
ostream::ostream ()
- 		-inline
-
-

Member Function Documentation

@@ -581,8 +554,7 @@

Member Function Documentation

-

Set fill character

-
Parameters
+

Set fill character

Parameters
[in]cnew fill character
@@ -637,8 +609,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flag
@@ -692,8 +663,7 @@

Member Function Documentation

-

Flushes the buffer associated with this stream. The flush function calls the sync function of the associated file.

-
Returns
A reference to the ostream object.
+

Flushes the buffer associated with this stream. The flush function calls the sync function of the associated file.

Returns
A reference to the ostream object.
@@ -790,8 +760,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -822,8 +791,7 @@

Member Function Documentation

-

call manipulator

-
Parameters
+

call manipulator

Parameters
[in]pffunction to call
@@ -854,8 +822,7 @@

Member Function Documentation

-

Output bool

-
Parameters
+

Output bool

Parameters
[in]argvalue to output
@@ -886,8 +853,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -918,8 +884,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -950,8 +915,7 @@

Member Function Documentation

-

Output string

-
Parameters
+

Output string

Parameters
[in]argstring to output
@@ -982,8 +946,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1014,8 +977,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1046,8 +1008,7 @@

Member Function Documentation

-

Output character

-
Parameters
+

Output character

Parameters
[in]argcharacter to output
@@ -1078,8 +1039,7 @@

Member Function Documentation

-

Output double

-
Parameters
+

Output double

Parameters
[in]argvalue to output
@@ -1110,8 +1070,7 @@

Member Function Documentation

-

Output float

-
Parameters
+

Output float

Parameters
[in]argvalue to output
@@ -1142,8 +1101,7 @@

Member Function Documentation

-

Output signed short

-
Parameters
+

Output signed short

Parameters
[in]argvalue to output
@@ -1174,8 +1132,7 @@

Member Function Documentation

-

Output unsigned short

-
Parameters
+

Output unsigned short

Parameters
[in]argvalue to output
@@ -1206,8 +1163,7 @@

Member Function Documentation

-

Output signed int

-
Parameters
+

Output signed int

Parameters
[in]argvalue to output
@@ -1238,8 +1194,7 @@

Member Function Documentation

-

Output unsigned int

-
Parameters
+

Output unsigned int

Parameters
[in]argvalue to output
@@ -1270,8 +1225,7 @@

Member Function Documentation

-

Output signed long

-
Parameters
+

Output signed long

Parameters
[in]argvalue to output
@@ -1302,8 +1256,7 @@

Member Function Documentation

-

Output unsigned long

-
Parameters
+

Output unsigned long

Parameters
[in]argvalue to output
@@ -1334,8 +1287,7 @@

Member Function Documentation

-

Output pointer

-
Parameters
+

Output pointer

Parameters
[in]argvalue to output
@@ -1366,8 +1318,7 @@

Member Function Documentation

-

Output a string from flash using the pstr() macro

-
Parameters
+

Output a string from flash using the pstr() macro

Parameters
[in]argpgm struct pointing to string
@@ -1398,8 +1349,7 @@

Member Function Documentation

-

Output a string from flash using the Arduino F() macro.

-
Parameters
+

Output a string from flash using the Arduino F() macro.

Parameters
[in]argpointing to flash string
@@ -1454,8 +1404,7 @@

Member Function Documentation

-

set precision

-
Parameters
+

set precision

Parameters
[in]nnew precision
@@ -1543,8 +1492,7 @@

Member Function Documentation

-

Set the stream position

-
Parameters
+

Set the stream position

Parameters
[in]posThe absolute position in which to move the write pointer.
@@ -1618,8 +1566,7 @@

Member Function Documentation

-

set format flags

-
Parameters
+

set format flags

Parameters
[in]flnew flags to be or'ed in
@@ -1660,8 +1607,7 @@

Member Function Documentation

-

modify format flags

-
Parameters
+

modify format flags

Parameters
@@ -1748,8 +1694,7 @@

Member Function Documentation

[in]maskflags to be removed
[in]flflags to be set after mask bits have been cleared
-

clear format flags

-
Parameters
+

clear format flags

Parameters
[in]flflags to be cleared
@@ -1804,8 +1749,7 @@

Member Function Documentation

-

set width

-
Parameters
+

set width

Parameters
[in]nnew width
@@ -2322,14 +2266,14 @@

Member Data Documentation

The documentation for this class was generated from the following files:
  • Arduino/libraries/SdFat/ostream.h
    • -
  • Arduino/libraries/SdFat/ostream.cpp
    • +
  • Arduino/libraries/SdFat/ostream.cpp
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/dir_1281b15c327061056ab3b326e90c50cf.html b/html/dir_1281b15c327061056ab3b326e90c50cf.html index 4141a92c..456eefb8 100644 --- a/html/dir_1281b15c327061056ab3b326e90c50cf.html +++ b/html/dir_1281b15c327061056ab3b326e90c50cf.html @@ -3,7 +3,7 @@ - + SdFat: Arduino/libraries/SdFat Directory Reference @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/dir_481cc946b8a81b8d9363a4aad6201160.html b/html/dir_481cc946b8a81b8d9363a4aad6201160.html index 03a2b5a5..6ee4dbb6 100644 --- a/html/dir_481cc946b8a81b8d9363a4aad6201160.html +++ b/html/dir_481cc946b8a81b8d9363a4aad6201160.html @@ -3,7 +3,7 @@ - + SdFat: Arduino/libraries Directory Reference @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/dir_a991eec27578c865874ede3d8ec657c2.html b/html/dir_a991eec27578c865874ede3d8ec657c2.html index 8a8061da..07781ae9 100644 --- a/html/dir_a991eec27578c865874ede3d8ec657c2.html +++ b/html/dir_a991eec27578c865874ede3d8ec657c2.html @@ -3,7 +3,7 @@ - + SdFat: Arduino Directory Reference @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/doxygen.css b/html/doxygen.css index f0f36f89..02e8b015 100644 --- a/html/doxygen.css +++ b/html/doxygen.css @@ -1,4 +1,4 @@ -/* The standard CSS for doxygen 1.8.6 */ +/* The standard CSS for doxygen 1.8.8 */ body, table, div, p, dl { font: 400 14px/22px Roboto,sans-serif; @@ -670,12 +670,12 @@ span.mlabel { /* @end */ -/* these are for tree view when not used as main index */ +/* these are for tree view inside a (index) page */ div.directory { margin: 10px 0px; - border-top: 1px solid #A8B8D9; - border-bottom: 1px solid #A8B8D9; + border-top: 1px solid #9CAFD4; + border-bottom: 1px solid #9CAFD4; width: 100%; } @@ -734,6 +734,80 @@ div.directory { color: #3D578C; } +.arrow { + color: #9CAFD4; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + font-size: 80%; + display: inline-block; + width: 16px; + height: 22px; +} + +.icon { + font-family: Arial, Helvetica; + font-weight: bold; + font-size: 12px; + height: 14px; + width: 16px; + display: inline-block; + background-color: #728DC1; + color: white; + text-align: center; + border-radius: 4px; + margin-left: 2px; + margin-right: 2px; +} + +.icona { + width: 24px; + height: 22px; + display: inline-block; +} + +.iconfopen { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('ftv2folderopen.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.iconfclosed { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('ftv2folderclosed.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.icondoc { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('ftv2doc.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +table.directory { + font: 400 14px Roboto,sans-serif; +} + +/* @end */ + div.dynheader { margin-top: 8px; -webkit-touch-callout: none; diff --git a/html/dynsections.js b/html/dynsections.js index ed092c7f..85e18369 100644 --- a/html/dynsections.js +++ b/html/dynsections.js @@ -24,19 +24,20 @@ function updateStripes() $('table.directory tr'). removeClass('even').filter(':visible:even').addClass('even'); } + function toggleLevel(level) { - $('table.directory tr').each(function(){ + $('table.directory tr').each(function() { var l = this.id.split('_').length-1; var i = $('#img'+this.id.substring(3)); var a = $('#arr'+this.id.substring(3)); if (l - + SdFat: File List @@ -25,11 +25,10 @@ - +
-
Here is a list of all files with brief descriptions:
+
Here is a list of all documented files with brief descriptions:
[detail level 1234]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
\-Arduino
 \-libraries
  \-SdFat
   o*ArduinoStream.hArduinoInStream and ArduinoOutStream classes
   o*bufstream.hibufstream and obufstream classes
   o*ios.hios_base and ios classes
   o*iostream.hiostream class
   o*istream.cpp
   o*istream.histream class
   o*MinimumSerial.cpp
   o*MinimumSerial.h
   o*ostream.cpp
   o*ostream.hostream class
   o*Sd2Card.cpp
   o*Sd2Card.hSd2Card class for V2 SD/SDHC cards
   o*SdBaseFile.cpp
   o*SdBaseFile.hSdBaseFile class
   o*SdBaseFilePrint.cpp
   o*SdFat.cpp
   o*SdFat.hSdFat class
   o*SdFatConfig.hConfiguration definitions
   o*SdFatErrorPrint.cpp
   o*SdFatmainpage.h
   o*SdFatUtil.cpp
   o*SdFatUtil.hUseful utility functions
   o*SdFile.cpp
   o*SdFile.hSdFile class
   o*SdSpi.hSdSpi class for V2 SD/SDHC cards
   o*SdSpiArduino.cpp
   o*SdSpiAVR.cpp
   o*SdSpiMK20DX128.cpp
   o*SdSpiSAM3X.cpp
   o*SdStream.cpp
   o*SdStream.hfstream, ifstream, and ofstream classes
   o*SdVolume.cpp
   o*SdVolume.hSdVolume class
   o*StdioStream.cpp
   \*StdioStream.h
 ▼ Arduino
 ▼ libraries
 ▼ SdFat
 ArduinoStream.hArduinoInStream and ArduinoOutStream classes
 bufstream.hibufstream and obufstream classes
 ios.hios_base and ios classes
 iostream.hiostream class
 istream.histream class
 ostream.hostream class
 Sd2Card.hSd2Card class for V2 SD/SDHC cards
 SdBaseFile.hSdBaseFile class
 SdFat.hSdFat class
 SdFatConfig.hConfiguration definitions
 SdFatUtil.hUseful utility functions
 SdFile.hSdFile class
 SdSpi.hSdSpi class for V2 SD/SDHC cards
 SdStream.hfstream, ifstream, and ofstream classes
 SdVolume.hSdVolume class
 StdioStream.hStdioStream class
-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/ftv2cl.png b/html/ftv2cl.png deleted file mode 100644 index 132f6577..00000000 Binary files a/html/ftv2cl.png and /dev/null differ diff --git a/html/ftv2mo.png b/html/ftv2mo.png deleted file mode 100644 index 4bfb80f7..00000000 Binary files a/html/ftv2mo.png and /dev/null differ diff --git a/html/ftv2ns.png b/html/ftv2ns.png deleted file mode 100644 index 72e3d71c..00000000 Binary files a/html/ftv2ns.png and /dev/null differ diff --git a/html/functions.html b/html/functions.html index 8165418d..7099dbcb 100644 --- a/html/functions.html +++ b/html/functions.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@
- +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- a -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_b.html b/html/functions_b.html index c3751719..d067823f 100644 --- a/html/functions_b.html +++ b/html/functions_b.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- b -

  • bad() @@ -117,9 +116,9 @@

    - b -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_c.html b/html/functions_c.html index e328ee92..0cd21f09 100644 --- a/html/functions_c.html +++ b/html/functions_c.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- c -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_d.html b/html/functions_d.html index 927b6e60..21b3ed59 100644 --- a/html/functions_d.html +++ b/html/functions_d.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- d -

  • data @@ -111,9 +110,9 @@

    - d -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_e.html b/html/functions_e.html index 0378cf17..96753999 100644 --- a/html/functions_e.html +++ b/html/functions_e.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- e -

  • end @@ -124,9 +123,9 @@

    - e -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_enum.html b/html/functions_enum.html index 7473702a..269b4e84 100644 --- a/html/functions_enum.html +++ b/html/functions_enum.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Enumerations @@ -25,11 +25,10 @@ - + @@ -62,9 +60,9 @@
-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_eval.html b/html/functions_eval.html index 0d961fd9..76be4082 100644 --- a/html/functions_eval.html +++ b/html/functions_eval.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Enumerator @@ -25,11 +25,10 @@ - + @@ -68,9 +66,9 @@
-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_f.html b/html/functions_f.html index 65450345..09dac143 100644 --- a/html/functions_f.html +++ b/html/functions_f.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- f -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func.html b/html/functions_func.html index 267b954c..c761ead7 100644 --- a/html/functions_func.html +++ b/html/functions_func.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_b.html b/html/functions_func_b.html index 6ad90fe2..e8afb286 100644 --- a/html/functions_func_b.html +++ b/html/functions_func_b.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_c.html b/html/functions_func_c.html index 1b14cb80..0481b4b2 100644 --- a/html/functions_func_c.html +++ b/html/functions_func_c.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_d.html b/html/functions_func_d.html index f9abca0a..920fefac 100644 --- a/html/functions_func_d.html +++ b/html/functions_func_d.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_e.html b/html/functions_func_e.html index 72808490..8f4acd49 100644 --- a/html/functions_func_e.html +++ b/html/functions_func_e.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_f.html b/html/functions_func_f.html index 52ed9273..9cb22c48 100644 --- a/html/functions_func_f.html +++ b/html/functions_func_f.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_g.html b/html/functions_func_g.html index 11d4c3af..03260e2d 100644 --- a/html/functions_func_g.html +++ b/html/functions_func_g.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_i.html b/html/functions_func_i.html index 9d1afee1..fa8c2a9a 100644 --- a/html/functions_func_i.html +++ b/html/functions_func_i.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_l.html b/html/functions_func_l.html index 552ab05f..c6631fd7 100644 --- a/html/functions_func_l.html +++ b/html/functions_func_l.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_m.html b/html/functions_func_m.html index 1d0b18fa..09277451 100644 --- a/html/functions_func_m.html +++ b/html/functions_func_m.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_rela.html b/html/functions_func_n.html similarity index 52% rename from html/functions_rela.html rename to html/functions_func_n.html index 0842b9b9..76706f64 100644 --- a/html/functions_rela.html +++ b/html/functions_func_n.html @@ -3,8 +3,8 @@ - -SdFat: Class Members - Related Functions + +SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
- 
-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_o.html b/html/functions_func_o.html index c00289c9..1849b734 100644 --- a/html/functions_func_o.html +++ b/html/functions_func_o.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_p.html b/html/functions_func_p.html index 02613ce8..9a26c39a 100644 --- a/html/functions_func_p.html +++ b/html/functions_func_p.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_r.html b/html/functions_func_r.html index 4c7e57b5..a273679a 100644 --- a/html/functions_func_r.html +++ b/html/functions_func_r.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_s.html b/html/functions_func_s.html index f6836be9..71f287ef 100644 --- a/html/functions_func_s.html +++ b/html/functions_func_s.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_t.html b/html/functions_func_t.html index 0def55a2..5ec05309 100644 --- a/html/functions_func_t.html +++ b/html/functions_func_t.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_u.html b/html/functions_func_u.html index 348fdd5d..53b9fea6 100644 --- a/html/functions_func_u.html +++ b/html/functions_func_u.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_v.html b/html/functions_func_v.html index 29727f6f..8d4ccbc1 100644 --- a/html/functions_func_v.html +++ b/html/functions_func_v.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_func_w.html b/html/functions_func_w.html index 5f8309fe..49ef68da 100644 --- a/html/functions_func_w.html +++ b/html/functions_func_w.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Functions @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_g.html b/html/functions_g.html index 0dbd9565..998e0079 100644 --- a/html/functions_g.html +++ b/html/functions_g.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- g -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_h.html b/html/functions_h.html index 0b68b7cb..c59e55d5 100644 --- a/html/functions_h.html +++ b/html/functions_h.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- h -

  • hex @@ -87,9 +86,9 @@

    - h -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_i.html b/html/functions_i.html index 4cf22b7a..95bff742 100644 --- a/html/functions_i.html +++ b/html/functions_i.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- i -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_l.html b/html/functions_l.html index 69f035c2..de79b66e 100644 --- a/html/functions_l.html +++ b/html/functions_l.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- l -

  • left @@ -94,9 +93,9 @@

    - l -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_m.html b/html/functions_m.html index ea7bba18..20324bfe 100644 --- a/html/functions_m.html +++ b/html/functions_m.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- m -

  • mbr @@ -91,9 +90,9 @@

    - m -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_n.html b/html/functions_n.html new file mode 100644 index 00000000..4e25c58f --- /dev/null +++ b/html/functions_n.html @@ -0,0 +1,94 @@ + + + + + + +SdFat: Class Members + + + + + + +
+
+ + + + + + +
+
SdFat +
+
+
+ + + + + + +
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- n -

    +
  • name() +: File +
    • +
+
+ +
+Generated on Sat Oct 25 2014 07:56:23 for SdFat by   +doxygen + 1.8.8 +
+ + diff --git a/html/functions_o.html b/html/functions_o.html index b5af1507..045bb815 100644 --- a/html/functions_o.html +++ b/html/functions_o.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- o -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_p.html b/html/functions_p.html index 211f27d7..15d50c2c 100644 --- a/html/functions_p.html +++ b/html/functions_p.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- p -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_r.html b/html/functions_r.html index e9d6d2b4..ee333b6e 100644 --- a/html/functions_r.html +++ b/html/functions_r.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- r -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_s.html b/html/functions_s.html index 7f440ffd..a7fdd85e 100644 --- a/html/functions_s.html +++ b/html/functions_s.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- s -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_t.html b/html/functions_t.html index 5bd5457e..ef444d57 100644 --- a/html/functions_t.html +++ b/html/functions_t.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- t -

  • tellg() @@ -104,9 +103,9 @@

    - t -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_type.html b/html/functions_type.html index 0a1fd563..ee55554f 100644 --- a/html/functions_type.html +++ b/html/functions_type.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Typedefs @@ -25,11 +25,10 @@ - + @@ -77,9 +75,9 @@
-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_u.html b/html/functions_u.html index 3862d1ed..4579ed2d 100644 --- a/html/functions_u.html +++ b/html/functions_u.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- u -

  • ungetc() @@ -93,9 +92,9 @@

    - u -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_v.html b/html/functions_v.html index f77d3325..17db8a30 100644 --- a/html/functions_v.html +++ b/html/functions_v.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- v -

  • vol() @@ -93,9 +92,9 @@

    - v -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_vars.html b/html/functions_vars.html index c2c05db6..9038711f 100644 --- a/html/functions_vars.html +++ b/html/functions_vars.html @@ -3,7 +3,7 @@ - + SdFat: Class Members - Variables @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/functions_w.html b/html/functions_w.html index 263d2ec2..1aa1246b 100644 --- a/html/functions_w.html +++ b/html/functions_w.html @@ -3,7 +3,7 @@ - + SdFat: Class Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all class members with links to the classes they belong to:
+
Here is a list of all documented class members with links to the class documentation for each member:

- w -

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/globals.html b/html/globals.html index 880a818b..26d541a2 100644 --- a/html/globals.html +++ b/html/globals.html @@ -3,7 +3,7 @@ - + SdFat: File Members @@ -25,11 +25,10 @@ - +
-
Here is a list of all file members with links to the files they belong to:
+
Here is a list of all documented file members with links to the documentation:
-

- _ -

-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/globals_defs.html b/html/globals_defs.html index ea9c36e1..63a850c2 100644 --- a/html/globals_defs.html +++ b/html/globals_defs.html @@ -3,7 +3,7 @@ - + SdFat: File Members @@ -25,11 +25,10 @@ - + @@ -66,9 +66,9 @@
  -

- c -

-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/globals_func.html b/html/globals_func.html index c30b4152..84147753 100644 --- a/html/globals_func.html +++ b/html/globals_func.html @@ -3,7 +3,7 @@ - + SdFat: File Members @@ -25,11 +25,10 @@ - + -
-  - -

- b -

-Generated on Tue Aug 5 2014 09:13:29 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/globals_vars.html b/html/globals_vars.html index fd4b987a..0ea0e26e 100644 --- a/html/globals_vars.html +++ b/html/globals_vars.html @@ -3,7 +3,7 @@ - + SdFat: File Members @@ -25,11 +25,10 @@ - + - +

This page explains how to interpret the graphs that are generated by doxygen.

-

Consider the following example:

-
/*! Invisible class because of truncation */
-
class Invisible { };
-
-
/*! Truncated class, inheritance relation is hidden */
-
class Truncated : public Invisible { };
-
-
/* Class not documented with doxygen comments */
-
class Undocumented { };
-
-
/*! Class that is inherited using public inheritance */
-
class PublicBase : public Truncated { };
-
-
/*! A template class */
-
template<class T> class Templ { };
-
-
/*! Class that is inherited using protected inheritance */
-
class ProtectedBase { };
-
-
/*! Class that is inherited using private inheritance */
-
class PrivateBase { };
-
-
/*! Class that is used by the Inherited class */
-
class Used { };
-
-
/*! Super class that inherits a number of other classes */
-
class Inherited : public PublicBase,
-
protected ProtectedBase,
-
private PrivateBase,
-
public Undocumented,
-
public Templ<int>
-
{
-
private:
-
Used *m_usedClass;
-
};
+

Consider the following example:

1 /*! Invisible class because of truncation */
+
2 class Invisible { };
+
3 
+
4 /*! Truncated class, inheritance relation is hidden */
+
5 class Truncated : public Invisible { };
+
6 
+
7 /* Class not documented with doxygen comments */
+
8 class Undocumented { };
+
9 
+
10 /*! Class that is inherited using public inheritance */
+
11 class PublicBase : public Truncated { };
+
12 
+
13 /*! A template class */
+
14 template<class T> class Templ { };
+
15 
+
16 /*! Class that is inherited using protected inheritance */
+
17 class ProtectedBase { };
+
18 
+
19 /*! Class that is inherited using private inheritance */
+
20 class PrivateBase { };
+
21 
+
22 /*! Class that is used by the Inherited class */
+
23 class Used { };
+
24 
+
25 /*! Super class that inherits a number of other classes */
+
26 class Inherited : public PublicBase,
+
27  protected ProtectedBase,
+
28  private PrivateBase,
+
29  public Undocumented,
+
30  public Templ<int>
+
31 {
+
32  private:
+
33  Used *m_usedClass;
+
34 };

This will result in the following graph:

@@ -107,9 +105,9 @@
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/hierarchy.html b/html/hierarchy.html index 8f128438..bb033a74 100644 --- a/html/hierarchy.html +++ b/html/hierarchy.html @@ -3,7 +3,7 @@ - + SdFat: Class Hierarchy @@ -25,11 +25,10 @@
- +
[detail level 12345]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
oCcache_tCache for an SD data block
oCFatPos_tInternal type for istream do not use in user apps
oCios_baseBase class for all streams
|\CiosError and state information for all streams
| oCistreamInput Stream
| |oCibufstreamParse a char string
| ||\CArduinoInStreamInput stream for Arduino Stream objects
| |oCifstreamSD file input stream
| |\CiostreamInput/Output stream
| | \CfstreamSD file input/output stream
| oCostreamOutput Stream
| |oCArduinoOutStreamOutput stream for Arduino Print objects
| |oCiostreamInput/Output stream
| |oCobufstreamFormat a char string
| |\CofstreamSD card output stream
| \CSdStreamBaseBase class for SD streams
|  oCfstreamSD file input/output stream
|  oCifstreamSD file input stream
|  \CofstreamSD card output stream
oCpgmType for string in flash
oCPrint
|oCMinimumSerialMini serial class for the SdFat library
|\CSdFileSdBaseFile with Print
oCSd2CardRaw access to SD and SDHC flash memory cards
oCSdBaseFileBase class for SdFile with Print and C++ streams
|oCSdFileSdBaseFile with Print
|oCSdStreamBaseBase class for SD streams
|\CStdioStreamStdioStream implements a minimal stdio stream
oCSdFatIntegration class for the SdFat library
oCSdSpiSPI class for access to SD and SDHC flash memory cards
oCSdVolumeAccess FAT16 and FAT32 volumes on SD and SDHC cards
oCsetfillType for setfill manipulator
oCsetprecisionType for setprecision manipulator
\CsetwType for setw manipulator
 Ccache_tCache for an SD data block
 CFatPos_tInternal type for istream do not use in user apps
 ▼Cios_baseBase class for all streams
 ▼CiosError and state information for all streams
 ▼CistreamInput Stream
 ▼CibufstreamParse a char string
 CArduinoInStreamInput stream for Arduino Stream objects
 CifstreamSD file input stream
 ▼CiostreamInput/Output stream
 CfstreamSD file input/output stream
 ▼CostreamOutput Stream
 CArduinoOutStreamOutput stream for Arduino Print objects
 CiostreamInput/Output stream
 CobufstreamFormat a char string
 CofstreamSD card output stream
 ▼CSdStreamBaseBase class for SD streams
 CfstreamSD file input/output stream
 CifstreamSD file input stream
 CofstreamSD card output stream
 CpgmType for string in flash
 ▼CPrint
 CMinimumSerialMini serial class for the SdFat library
 CSdFileSdBaseFile with Arduino Stream
 CSd2CardRaw access to SD and SDHC flash memory cards
 ▼CSdBaseFileBase class for SdFile with Print and C++ streams
 CFileArduino SD.h style File API
 CSdFileSdBaseFile with Arduino Stream
 CSdStreamBaseBase class for SD streams
 CStdioStreamStdioStream implements a minimal stdio stream
 CSdFatIntegration class for the SdFat library
 CSdSpiSPI class for access to SD and SDHC flash memory cards
 CSdVolumeAccess FAT16 and FAT32 volumes on SD and SDHC cards
 CsetfillType for setfill manipulator
 CsetprecisionType for setprecision manipulator
 CsetwType for setw manipulator
 ▼CStream
 CFileArduino SD.h style File API
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/index.html b/html/index.html index 83aa17d1..1d025db8 100644 --- a/html/index.html +++ b/html/index.html @@ -3,7 +3,7 @@ - + SdFat: Arduino SdFat Library @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/inherit_graph_2.png b/html/inherit_graph_2.png index b50aad92..085b72f5 100644 Binary files a/html/inherit_graph_2.png and b/html/inherit_graph_2.png differ diff --git a/html/inherit_graph_3.png b/html/inherit_graph_3.png index 248216e9..b50aad92 100644 Binary files a/html/inherit_graph_3.png and b/html/inherit_graph_3.png differ diff --git a/html/inherit_graph_4.png b/html/inherit_graph_4.png index 54debb30..248216e9 100644 Binary files a/html/inherit_graph_4.png and b/html/inherit_graph_4.png differ diff --git a/html/inherits.html b/html/inherits.html index 91f98d66..ca43e74e 100644 --- a/html/inherits.html +++ b/html/inherits.html @@ -3,7 +3,7 @@ - + SdFat: Class Hierarchy @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/ios_8h.html b/html/ios_8h.html index c6c3cb86..f5252b82 100644 --- a/html/ios_8h.html +++ b/html/ios_8h.html @@ -3,7 +3,7 @@ - + SdFat: Arduino/libraries/SdFat/ios.h File Reference @@ -25,11 +25,10 @@ - + - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/structsetprecision.html b/html/structsetprecision.html index 38ef0ae6..58d902ac 100644 --- a/html/structsetprecision.html +++ b/html/structsetprecision.html @@ -3,7 +3,7 @@ - + SdFat: setprecision Struct Reference @@ -25,11 +25,10 @@ - +
-

constructor

-
Parameters
+

constructor

Parameters
[in]argnew precision
@@ -121,9 +119,9 @@

Member Data Documentation

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/structsetw-members.html b/html/structsetw-members.html index 5595dc1b..54f8ead4 100644 --- a/html/structsetw-members.html +++ b/html/structsetw-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/structsetw.html b/html/structsetw.html index dcf31097..c1c4b688 100644 --- a/html/structsetw.html +++ b/html/structsetw.html @@ -3,7 +3,7 @@ - + SdFat: setw Struct Reference @@ -25,11 +25,10 @@ - +
-

constructor

-
Parameters
+

constructor

Parameters
[in]argnew width
@@ -121,9 +119,9 @@

Member Data Documentation

-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:23 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/unioncache__t-members.html b/html/unioncache__t-members.html index 912ccb07..366d7c95 100644 --- a/html/unioncache__t-members.html +++ b/html/unioncache__t-members.html @@ -3,7 +3,7 @@ - + SdFat: Member List @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/html/unioncache__t.html b/html/unioncache__t.html index be65475a..2279668c 100644 --- a/html/unioncache__t.html +++ b/html/unioncache__t.html @@ -3,7 +3,7 @@ - + SdFat: cache_t Union Reference @@ -25,11 +25,10 @@ - +
-Generated on Tue Aug 5 2014 09:13:28 for SdFat by   +Generated on Sat Oct 25 2014 07:56:22 for SdFat by   doxygen - 1.8.6 + 1.8.8
diff --git a/readme.txt b/readme.txt index dc9a0703..98620c6a 100644 --- a/readme.txt +++ b/readme.txt @@ -1,68 +1,46 @@ -Please check the changes.txt file! - -For those who don't like too much documentation read QuickStart.txt. - The Arduino SdFat library provides read/write access to FAT16/FAT32 file systems on SD/SDHC flash cards. SdFat requires Arduino 1.05 or greater. To use SdFat, unzip the download file and place the SdFat folder -into the libraries subfolder in your main sketch folder. You may -need to create the libraries folder. Restart the Arduino IDE if -it was open. See the Arduino site for more details om installing libraries. - -The default chip select for the SD card is the hardware SS pin. On a -168/328 Arduino this is pin 10 and on a Mega this is pin 53. If you are -using another pin for chip select you will need call SdFat::begin(chipSelectPin) -or SdFat::begin(chipSelectPin, sckRateID) with second parameter set to the -SPI rate ID. - -If you have a shield like the SparkFun shield that uses pin 8 for chip -select you would change the line: - sd.begin(); -to - sd.begin(8); -or - sd.begin(8, SPI_HALF_SPEED); -to use a slower SPI clock. - -If the example uses - sd.init(); -change it to: - sd.begin(8, SPI_FULL_SPEED); +into the libraries sub-folder in your main sketch folder. +For more information see the Manual installation section of this guide: -A number of configuration options can be set by editing SdFatConfig.h -#define macros. Options include: +http://arduino.cc/en/Guide/Libraries -USE_SD_CRC - enable or disable SD card crc checking. +A number of configuration options can be set by editing SdFatConfig.h +#define macros. See the html documentation for details -USE_MULTIPLE_CARDS - enable or disable use of multiple SD card sockets. +If you wish to report bugs or have comments, send email to +fat16lib@sbcglobal.net -USE_SERIAL_FOR_STD_OUT - use Serial for the default stdOut. +Read changes.txt if you have used previous releases of this library. -ENDL_CALLS_FLUSH - enable a flush() call after endl. +Read troubleshooting.txt for common hardware problems. -SPI_SCK_INIT_DIVISOR - set the SPI rate for card initialization. +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. -LEONARDO_SOFT_SPI - use software SPI on Leonardo Arduinos. +Support has been added for Software SPI on AVR, Due, and Teensy 3.1 boards. -MEGA_SOFT_SPI - use software SPI on Mega Arduinos. +SPI transactions are supported. See SoftwareSPI.txt and SPI_Transactions.txt +for more information. -USE_SOFTWARE_SPI - always use software SPI. +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 -If you wish to report bugs or have comments, send email to -fat16lib@sbcglobal.net +#include -Read changes.txt if you have used previous releases of this library. +with these two lines: -Read troubleshooting.txt for common hardware problems. +#include +SdFat SD; -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, SdFile, ifstream, ofstream. The SdFile class implements binary files similar to Linux's system calls. @@ -98,7 +76,7 @@ level shifter. SdFat sets the SPI bus frequency to 8 MHz which results in signal rise times that are too slow for the edge detectors in many newer SD card controllers when resistor voltage dividers are used. -The 5 to 3.3 V level shifter for 5 V arduinos should be IC based like +The 5 to 3.3 V level shifter for 5 V Arduinos should be IC based like the 74HC4050N based circuit shown in the file SdLevel.png. The Adafruit Wave Shield uses a 74AHC125N. Gravitech sells SD and MicroSD Card Adapters based on the 74LCX245. @@ -170,6 +148,10 @@ SdFormatter - This sketch will format an SD or SDHC card. SdInfo - Initialize an SD card and analyze its structure for trouble shooting. +StdioBench - Demo and test of stdio style stream. + +StreamParseInt - Simple demo of parseInt() Stream member function. + StressTest - Create and write files until the SD is full. Timestamp - Sets file create, modify, and access timestamps. @@ -183,4 +165,4 @@ Compile, upload to your Arduino and click on Serial Monitor to run the example. -Updated 06 Aug 2014 +Updated 25 Oct 2014