SdFat Class Reference

Integration class for the SdFat library. More...

#include <SdFat.h>

Public Member Functions
	SdFat ()
bool	begin (uint8_t chipSelectPin=SD_CHIP_SELECT_PIN, uint8_t sckRateID=SPI_FULL_SPEED)
Sd2Card *	card ()
bool	chdir (bool set_cwd=false)
bool	chdir (const char *path, bool set_cwd=false)
void	chvol ()
void	errorHalt ()
void	errorHalt_P (PGM_P msg)
void	errorHalt (char const *msg)
void	errorPrint ()
void	errorPrint_P (PGM_P msg)
void	errorPrint (char const *msg)
bool	exists (const char *name)
bool	init (uint8_t sckRateID=SPI_FULL_SPEED, uint8_t chipSelectPin=SD_CHIP_SELECT_PIN)
void	initErrorHalt ()
void	initErrorHalt (char const *msg)
void	initErrorHalt_P (PGM_P msg)
void	initErrorPrint ()
void	initErrorPrint (char const *msg)
void	initErrorPrint_P (PGM_P msg)
void	ls (uint8_t flags=0)
void	ls (Print *pr, uint8_t flags=0)
bool	mkdir (const char *path, bool pFlag=true)
bool	remove (const char *path)
bool	rename (const char *oldPath, const char *newPath)
bool	rmdir (const char *path)
bool	truncate (const char *path, uint32_t length)
SdVolume *	vol ()
SdBaseFile *	vwd ()
Static Public Member Functions
static void	setStdOut (Print *stream)
static Print *	stdOut ()
Private Attributes
Sd2Card	card_
SdVolume	vol_
SdBaseFile	vwd_
Static Private Attributes
static Print *	stdOut_

---

Detailed Description

Integration class for the SdFat library.

---

Constructor & Destructor Documentation

SdFat

(

)

[inline]

---

Member Function Documentation

bool begin	(	uint8_t	chipSelectPin = SD_CHIP_SELECT_PIN,
		uint8_t	sckRateID = SPI_FULL_SPEED
	)		[inline]

Initialize an SdFat object. Arduino friendly version of init.

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

Parameters:

[in]	chipSelectPin	SD chip select pin. See Sd2Card::init().
[in]	sckRateID	value for SPI SCK rate. See Sd2Card::init().

Returns:

The value one, true, is returned for success and the value zero, false, is returned for failure.

Sd2Card* card

(

)

[inline]

Returns:

a pointer to the Sd2Card object.

bool chdir

(

bool

set_cwd = false

)

bool chdir	(	const char *	path,
		bool	set_cwd = false
	)

void chvol

(

)

void errorHalt

(

)

void errorHalt

(

char const *

msg

)

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 initErrorHalt

(

char const *

msg

)

void initErrorHalt_P

(

PGM_P

msg

)

void initErrorPrint

(

)

void initErrorPrint

(

char const *

msg

)

void initErrorPrint_P

(

PGM_P

msg

)

void ls

(

uint8_t

flags = 0

)

void ls	(	Print *	pr,
		uint8_t	flags = 0
	)

bool mkdir	(	const char *	path,
		bool	pFlag = true
	)

bool remove

(

const char *

path

)

bool rename	(	const char *	oldPath,
		const char *	newPath
	)

bool rmdir

(

const char *

path

)

static void setStdOut

(

Print *

stream

)

[inline, static]

Set stdOut Print stream for messages.

Parameters:

[in]

stream

The new Print stream.

static Print* stdOut

(

)

[inline, static]

Returns:

Print stream for messages.

bool truncate	(	const char *	path,
		uint32_t	length
	)

SdVolume* vol

(

)

[inline]

Returns:

a pointer to the SdVolume object.

SdBaseFile* vwd

(

)

[inline]

Returns:

a pointer to the volume working directory.

---

Field Documentation

Sd2Card card_ [private]

Print* stdOut_ [static, private]

SdVolume vol_ [private]

SdBaseFile vwd_ [private]

---

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

• Repetier/SdFat.h