クラス SDMMC

SDカードやMMCカードを操作する [詳細]

#include <sdmmc.h>

Public メソッド
void	begin ()
	メモリカードを使用するためにライブラリを初期化する [詳細]
void	begin (int cspin)
	メモリカードを使用するためにライブラリを初期化する [詳細]
void	insert (bool ins)
	カードの挿入状態をライブラリに支持する [詳細]
bool	exists (const char *filename)
	目的のファイルが存在するかどうか調べる [詳細]
bool	mkdir (const char *pathname)
	ディレクトリを作成する [詳細]
File	open (const char *filename, FILE_MODE mode=FILE_READ)
	指定されたファイルを開く [詳細]
bool	remove (const char *filename)
	指定されたファイルを削除する [詳細]
bool	rename (const char *oldname, const char *newname)
	ファイル名を変更する [詳細]
bool	rmdir (const char *pathname)
	ディレクトリを削除する [詳細]

Static Public メソッド
static unsigned long	getVersion (version_info *vi)
	ライブラリのバージョン情報を取得する [詳細]

説明

SDカードやMMCカードを操作する

MMC(Multi Media Card)やSDを利用するためのクラスです。このクラスを使うにはリンカオプションに -lsdmmc を追加してください。

覚え書き

ArduinoではSDという名前のクラスだったが、その名前を使うと問題がある。ここでは汎用的なMMCカードと、そのMMCの特異的な実装の一例である一部のカードについてアクセスするためのライブラリとするため、SDMMCという名称になっている。いわゆる大人の事情である。

sdmmc.h の 367 行で定義されています。

関数

static unsigned long SDMMC::getVersion ( version_info *  vi )

static

ライブラリのバージョン情報を取得する

引数

[out]

vi

拡張情報が必要ならばversion_info構造体へのポインタを与える。 構造体の各フィールドがセットされて戻る。各フィールドは文字列へのポインタだが、 static constな文字列を指すので、ユーザプログラムでfreeしてはならない。 拡張情報が不要ならばNULLを指定してもよい

戻り値

バージョン番号を1バイトずつ詰めた16進数で返す 例えば、バージョン1.00ならば、0x01000000を返す バージョン1.23ならば0x010203となる。 メジャーバージョン.マイナーバージョン.サブバージョン.デバッグバージョン

void SDMMC::begin

(

)

メモリカードを使用するためにライブラリを初期化する

CSピンは標準の端子が使われる

警告

SPIライブラリと一緒に使うときには、SPI::begin() よりも後に呼び出さなければならない

戻り値

なし

void SDMMC::begin

(

int

cspin

)

メモリカードを使用するためにライブラリを初期化する

CSピンの位置を任意のピンに割り当てられる

引数

cspin

CSピンのピン番号

警告

SPIライブラリと一緒に使うときには、SPI::begin() よりも後に呼び出さなければならない

戻り値

なし

void SDMMC::insert

(

bool

ins

)

カードの挿入状態をライブラリに支持する

カードの挿入状態はP15で判別しているが、そうでない場合、この関数で与えることができる

引数

ins	0:未挿入 1:挿入

戻り値

なし

bool SDMMC::exists

(

const char *

filename

)

目的のファイルが存在するかどうか調べる

引数

filename

調べたいファイル名

戻り値

- ファイルが存在していればtrueを返す。

• ファイル存在しないかカードが検出されていなければfalseを返す

bool SDMMC::mkdir

(

const char *

pathname

)

ディレクトリを作成する

引数

pathname

作成したいディレクトリのパス

戻り値

- 成功したらtrueを返す。

• 失敗したらfalseを返す

File SDMMC::open	(	const char *	filename,
		FILE_MODE	mode = FILE_READ
	)

指定されたファイルを開く

引数

filename	オープンしたいファイル名
mode	FILE_MODE 型の定数。 FILE_READ : ファイルを読み出し用に開く(デフォルト) FILE_WRITE : ファイルを書き込み用に開く

戻り値

- 成功したらファイルオブジェクトを返す。

• 失敗したらfalseを返す。具体的にはfalseとして評価される特殊なファイルオブジェクトを返す。

bool SDMMC::remove

(

const char *

filename

)

指定されたファイルを削除する

引数

filename

削除したいファイル名

戻り値

- 成功したらtrueを返す。

• 失敗したらfalseを返す

bool SDMMC::rename	(	const char *	oldname,
		const char *	newname
	)

ファイル名を変更する

引数

oldname	旧ファイル名
newname	新ファイル名

戻り値

- 成功したらtrueを返す。

• 失敗したらfalseを返す

bool SDMMC::rmdir

(

const char *

pathname

)

ディレクトリを削除する

引数

pathname

削除したいディレクトリ

戻り値

- 成功したらtrueを返す。

• 失敗したらfalseを返す