example project to explain how to write a class library
Diff: test_LM75B.h
- Revision:
- 7:9a7235e5fe27
- Parent:
- 6:ab79d1157026
--- a/test_LM75B.h Mon Nov 03 00:30:02 2014 +0000 +++ b/test_LM75B.h Tue Nov 11 00:41:14 2014 +0000 @@ -1,33 +1,33 @@ -/** A sample code for class library development +/** サンプルコード:ライブラリ開発の例 * * @author Tedd OKANO - * @version 1.0 - * @date 22-Oct-2014 + * @version 1.1 + * @date 11-Nov-2014 * - * This code explains steps of the class code development. - * The each steps are saved in code repository. - * A I2C temperature sensor LM75B is used as a target device. + * ライブラリ開発の例として,コードをステップ・バイ・ステップで解説しています + * 各ステップはリポジトリ履歴で追うことができます + * I2Cインターフェースを持った温度センサのLM75Bをターゲットとしています * - * About LM75B: + * LM75Bの詳細は * http://www.nxp.com/documents/data_sheet/LM75B.pdf */ #include "mbed.h" -/** Default slave address */ +/** デフォルト・スレーブアドレス */ #define ADDRESS_LM75B 0x90 -/** LM75B register name ans addresses */ +/** LM75Bのレジスタ名とアドレス */ #define LM75B_Conf 0x01 #define LM75B_Temp 0x00 #define LM75B_Tos 0x03 #define LM75B_Thyst 0x02 -/** test_LM75B class library +/** test_LM75Bクラスライブラリ * - * Class library to provide very simple interface for mbed + * クラスライブラリは非常にシンプルなインターフェースを提供します * - * Example: + * コード例: * @code * #include "mbed.h" * #include "test_LM75B.h" @@ -58,38 +58,38 @@ { public: - /** Create a test_LM75B instance connected to specified I2C pins with specified address + /** I2Cピンとスレーブアドレスを指定し,インスタンスを作成します * - * @param sda I2C-bus SDA pin - * @param scl I2C-bus SCL pin - * @param address (option) I2C-bus slave address (default: 0x90) + * @param sda I2C-bus SDAピン + * @param scl I2C-bus SCLピン + * @param address (オプション) I2C-bus スレーブアドレス (デフォルト: 0x90) */ test_LM75B( PinName sda, PinName scl, char address = ADDRESS_LM75B ); - /** Create a test_LM75B instance connected to specified I2C pins with specified address + /** I2Cオブジェクトとスレーブアドレスを指定し,インスタンスを作成します * - * @param i2c_obj I2C object (instance) - * @param address (option) I2C-bus slave address (default: 0x90) + * @param i2c_obj I2C オブジェクト (インスタンス) + * @param address (オプション) I2C-bus スレーブアドレス (デフォルト: 0x90) */ test_LM75B( I2C &i2c_obj, char address = ADDRESS_LM75B ); - /** Destractor + /** デストラクタ */ ~test_LM75B(); - /** Initialization + /** 初期化 */ void init( void ); - /** Read temperature + /** 温度の読み出し * - * @return value of degree Celsius (in float) + * @return 摂氏温度を返します(float型) */ float read( void ); - /** Read temperature + /** 温度の読み出し * - * @return the object returns the read value + * @return オブジェクトが読みだした値を返すようにしています */ operator float( void );