Public Member Functions

SdFat Class Reference

Integration class for the SdFat library. More...

#include <SdFat.h>

Collaboration diagram for SdFat:
Collaboration graph
[legend]

List of all members.

Public Member Functions

Sd2Cardcard ()
bool chdir ()
bool chdir (const char *path)
SdFilecwd ()
void errorHalt (char const *msg)
void errorHalt ()
void errorHalt_P (PGM_P msg)
void errorPrint ()
void errorPrint (char const *msg)
void errorPrint_P (PGM_P msg)
bool exists (const char *name)
bool init (uint8_t sckRateID=SPI_FULL_SPEED, uint8_t chipSelectPin=SD_CHIP_SELECT_PIN)
void initErrorHalt ()
void initErrorPrint ()
void ls (uint8_t flags=0, uint8_t indent=0)
bool mkdir (const char *path, bool pFlag=true)
bool remove (const char *path)
bool rmdir (const char *path)
SdVolumevol ()

Detailed Description

Integration class for the SdFat library.


Member Function Documentation

Sd2Card* SdFat::card (  ) [inline]
Returns:
a pointer to the Sd2Card object.
bool SdFat::chdir ( const char *  path )

Change current working directory

Changes the current working directory to the path subdirectory.

Example: Executing chdir("SUB") in the "/DIR" directory will change the current working directory from "/DIR" to "/DIR/SUB".

Parameters:
[in]pathThe name of the subdirectory.
Returns:
The value one, true, is returned for success and the value zero, false, is returned for failure.
bool SdFat::chdir (  )

Change current working directory to root

Changes the current working directory to the SD's root directory.

Returns:
The value one, true, is returned for success and the value zero, false, is returned for failure.
SdFile* SdFat::cwd (  ) [inline]
Returns:
a pointer to the current working directory.
void SdFat::errorHalt (  )

Print any SD error code and halt.

void SdFat::errorHalt ( char const *  msg )

Print msg, any SD error code, and halt.

Parameters:
[in]msgMessage to print.
void SdFat::errorHalt_P ( PGM_P  msg )

Print msg, any SD error code, and halt.

Parameters:
[in]msgMessage in program space (flash memory) to print.
void SdFat::errorPrint (  )

Print any SD error code.

void SdFat::errorPrint ( char const *  msg )

Print msg, any SD error code.

Parameters:
[in]msgMessage to print.
void SdFat::errorPrint_P ( PGM_P  msg )

Print msg, any SD error code.

Parameters:
[in]msgMessage in program space (flash memory) to print.
bool SdFat::exists ( const char *  name )

Test for the existence of a file.

Parameters:
[in]nameName of the file to be tested for.
Returns:
true if the file exists else false.
bool SdFat::init ( uint8_t  sckRateID = SPI_FULL_SPEED,
uint8_t  chipSelectPin = SD_CHIP_SELECT_PIN 
)

Initialize an SdFat object.

Initializes the SD card, SD volume, and root directory.

Parameters:
[in]sckRateIDvalue for SPI SCK rate. See Sd2Card::init().
[in]chipSelectPinSD chip select pin. See Sd2Card::init().
Returns:
The value one, true, is returned for success and the value zero, false, is returned for failure.
void SdFat::initErrorHalt (  )

Print error details and halt after SdFat::init() fails.

void SdFat::initErrorPrint (  )

Print error details after SdFat::init() fails.

void SdFat::ls ( uint8_t  flags = 0,
uint8_t  indent = 0 
)

List the directory contents of the current working directory to Serial.

Parameters:
[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.
bool SdFat::mkdir ( const char *  path,
bool  pFlag = true 
)

Make a subdirectory in the current working directory.

Parameters:
[in]pathA path with a valid 8.3 DOS name for the subdirectory.
[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.
bool SdFat::remove ( const char *  path )

Remove a file from the current working directory.

Parameters:
[in]pathA path with a valid 8.3 DOS name for the file.
Returns:
The value one, true, is returned for success and the value zero, false, is returned for failure.
bool SdFat::rmdir ( const char *  path )

Remove a subdirectory from the current working directory.

Parameters:
[in]pathA path with a valid 8.3 DOS name for the subdirectory.

The subdirectory file will be removed only if it is empty.

Returns:
The value one, true, is returned for success and the value zero, false, is returned for failure.
SdVolume* SdFat::vol (  ) [inline]
Returns:
a pointer to the SdVolume object.

The documentation for this class was generated from the following files: