base SD file system template class. More...

#include <SdFs.h>

Inheritance diagram for SdBase< Vol >:

Collaboration diagram for SdBase< Vol >:

Public Member Functions
bool	begin (uint8_t csPin=SS)

bool	begin (uint8_t csPin, SPISettings spiSettings)

bool	begin (SdSpiConfig spiConfig)

bool	begin (SdioConfig sdioConfig)

SdCard *	card ()

bool	cardBegin (SdSpiConfig spiConfig)

bool	cardBegin (SdioConfig sdioConfig)

void	errorHalt (Print *pr)

void	errorHalt ()

void	errorHalt (Print pr, const char msg)

void	errorHalt (Print pr, const __FlashStringHelper msg)

void	errorHalt (const __FlashStringHelper *msg)

void	errorHalt (const char *msg)

void	initErrorHalt (Print *pr)

void	initErrorHalt ()

void	printFatType (Print *pr)

void	printSdError (print_t *pr)

void	printSdErrorCode (Print *pr)

uint8_t	sdErrorCode ()

uint8_t	sdErrorData ()

bool	volumeBegin ()

Detailed Description

template<class Vol>
class SdBase< Vol >

base SD file system template class.

Member Function Documentation

template<class Vol>

bool SdBase< Vol >::begin ( uint8_t csPin = SS )

inline

Initialize SD card and file system.

Parameters

[in] csPin SD card chip select pin.

Returns: true for success else false.

template<class Vol>

bool SdBase< Vol >::begin	(	uint8_t	csPin,
		SPISettings	spiSettings
	)

inline

Initialize SD card and file system.

Parameters

[in]	csPin	SD card chip select pin.
[in]	spiSettings	SPI speed, mode, and bit order.

Returns: true for success else false.

template<class Vol>

bool SdBase< Vol >::begin ( SdSpiConfig spiConfig )

inline

Initialize SD card and file system for SPI mode.

Parameters

[in] spiConfig SPI configuration.

Returns: true for success else false.

template<class Vol>

bool SdBase< Vol >::begin ( SdioConfig sdioConfig )

inline

Initialize SD card and file system for SDIO mode.

Parameters

[in] sdioConfig SDIO configuration.

Returns: true for success else false.

template<class Vol>

SdCard* SdBase< Vol >::card ( )

inline

Returns: Pointer to SD card object.

template<class Vol>

bool SdBase< Vol >::cardBegin ( SdSpiConfig spiConfig )

inline

Initialize SD card in SPI mode.

Parameters

[in] spiConfig SPI configuration.

Returns: true for success else false.

template<class Vol>

bool SdBase< Vol >::cardBegin ( SdioConfig sdioConfig )

inline

Initialize SD card in SDIO mode.

Parameters

[in] sdioConfig SDIO configuration.

Returns: true for success else false.

template<class Vol>

void SdBase< Vol >::errorHalt ( Print * pr )

inline

Print error info and halt.

Parameters

[in] pr Print destination.

template<class Vol>

void SdBase< Vol >::errorHalt ( )

inline

Print error info to Serial and halt.

template<class Vol>

void SdBase< Vol >::errorHalt	(	Print *	pr,
		const char *	msg
	)

inline

Print error info and halt.

Parameters

[in]	pr	Print destination.
[in]	msg	Message to print.

template<class Vol>

void SdBase< Vol >::errorHalt	(	Print *	pr,
		const __FlashStringHelper *	msg
	)

inline

Print msg and halt.

Parameters

[in]	pr	Print destination.
[in]	msg	Message to print.

template<class Vol>

void SdBase< Vol >::errorHalt ( const __FlashStringHelper * msg )

inline

Print msg to Serial and halt.

Parameters

[in] msg Message to print.

template<class Vol>

void SdBase< Vol >::errorHalt ( const char * msg )

inline

Print error info and halt.

Parameters

[in] msg Message to print.

template<class Vol>

void SdBase< Vol >::initErrorHalt ( Print * pr )

inline

Print error info and halt.

Parameters

[in] pr Print destination.

template<class Vol>

void SdBase< Vol >::initErrorHalt ( )

inline

Print error info and halt.

template<class Vol>

void SdBase< Vol >::printFatType ( Print * pr )

inline

Print volume FAT/exFAT type.

Parameters

[in] pr Print destination.

template<class Vol>

void SdBase< Vol >::printSdError ( print_t * pr )

inline

Print error info and return.

Parameters

[in] pr Print destination.

template<class Vol>

void SdBase< Vol >::printSdErrorCode ( Print * pr )

inline

Print SD errorCode and errorData.

Parameters

[in] pr Print destination.

template<class Vol>

uint8_t SdBase< Vol >::sdErrorCode ( )

inline

Returns: SD card error code.

template<class Vol>

uint8_t SdBase< Vol >::sdErrorData ( )

inline

Returns: SD card error data.

template<class Vol>

bool SdBase< Vol >::volumeBegin ( )

inline

Initialize file system after call to cardBegin.

Returns: true for success else false.

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

ArduinoSdFs/libraries/SdFs/src/SdFs.h

Public Member Functions

Detailed Description

template<class Vol> class SdBase< Vol >

Member Function Documentation

template<class Vol>
class SdBase< Vol >