AT24C1024の機能を簡単に使えるようにするライブラリー

at24c1024b.h

Committer:
r113330akki
Date:
2017-12-11
Revision:
0:b6847bb172b4
Child:
1:3d1e7763c6f5

File content as of revision 0:b6847bb172b4:

/**
 * @file at24c1024b.h
 * @brief EEPROMのAT24C1024B用ライブラリ
 * @author 西川顕史
 * @date 2017/12/11(開始日)
 */
#ifndef __AT24C1024B_H__
#define __AT24C1024B_H__

#include "mbed.h"
/**
* @brief AT24C1024Bの機能をまとめたクラス
* @details
*/
class AT24C1024B
{
public:
    /**
    * @brief 1バイト分データをEEPROMに書き込むための関数
    * @param[in] addr どのアドレスに書き込むか指定
    * @param[in] page どのページに書き込むか指定
    * @param[in] data 書き込むデータ
    * @return int エラーが発生したかを確認するためのもの
    * @details 正常終了したら0を返す。
    */
    int write(int addr, int page, char data);
    /**
    * @brief 1バイト分データをEEPROMに書き込むための関数
    * @param[in] addr どのアドレスに書き込むか指定
    * @param[in] page どのページに書き込むか指定
    * @param[in] data 書き込むデータ
    * @return int エラーが発生したかを確認するためのもの
    * @details 正常終了したら0を返す。
    */
    int write(int addr, int page, char *data, int length);
    /**
    * @brief 1バイト分データをEEPROMに書き込むための関数
    * @param[in] addr どのアドレスに書き込むか指定
    * @param[in] page どのページに書き込むか指定
    * @param[in] data 書き込むデータ
    * @return int エラーが発生したかを確認するためのもの
    * @details 正常終了したら0を返す。
    */
    int read(int addr, int page);
    /**
    * @brief 1バイト分データをEEPROMに書き込むための関数
    * @param[in] addr どのアドレスに書き込むか指定
    * @param[in] page どのページに書き込むか指定
    * @param[in] data 書き込むデータ
    * @return int エラーが発生したかを確認するためのもの
    * @details 正常終了したら0を返す。
    */
    int read(int addr, int page, char *data, int length);
}

#endif