I2CMaster (UM03-KO API リファレンス)

クラス

使用

ヘルプ

NTT DOCOMO and Hitachi Kokusai Electric Know-how & Confidential

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.docomo_um.module.connection
クラス I2CMaster

java.lang.Object
  com.docomo_um.module.connection.I2CDevice
      com.docomo_um.module.connection.I2CMaster

I2Cマスタ側を表すクラスです。

留意事項
デバイスと物理的に接続されていない場合、以下の場合にIOExceptionが発生します。 IOExceptionが発生した場合、そのデバイスとのストリームは自動的にcloseされます。

メソッドの概要
`java.io.InputStream`	`getInputStream()` 入力ストリームを取得します。
`java.io.OutputStream`	`getOutputStream()` 出力ストリームを取得します。
`byte[]`	`sendCombinedFormat(byte[] write, int bufferSize)` 書き込みと読み込みを合わせた命令を送信します。
`void`	`setCommSpeed(long speed)` 利用する通信速度(bps)を指定します。
`void`	`start()` I2C通信を開始します。
`void`	`stop()` I2C通信を終了します。

クラス java.lang.Object から継承されたメソッド
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait`

メソッドの詳細

public void start()

I2C通信を開始します。

public void stop()

I2C通信を終了します。
接続先とデータの送受信中に本メソッドをコールした場合は、データの送受信終了後にI2C通信を終了します。
start()で通信を開始していない状態の場合、本メソッドは無視されます。

通信が終了された際に、オープンされている入出力ストリームが存在する場合、当該ストリームに対して暗黙的にclose()が呼ばれます。

public void setCommSpeed(long speed)

利用する通信速度(bps)を指定します。

I2CSpec.getCommSpeedList()で取得した利用可能な通信速度のリストから、デバイスに合わせた正しい値を設定してください。

インスタンス生成時の初期値は通信モジュールの実装に依存します。

パラメータ:: speed - 利用する通信速度(bps)を指定します。
例外:: java.lang.IllegalArgumentException - 利用出来ない通信速度(bps)を指定したときに発生します。; java.lang.IllegalStateException - 通信速度を変更できない状態で、本メソッドをコールした場合に発生します。

public java.io.OutputStream getOutputStream()

出力ストリームを取得します。

start()で通信を開始していない状態の場合、IllegalStateExceptionが発生します。

出力ストリームでデータの出力処理中にIOExceptionが発生した場合、暗黙的にその出力ストリームのOutputStream.close()がコールされます。

戻り値:: 出力ストリームを返します。
例外:: java.lang.IllegalStateException - start()で通信を開始していない状態で、本メソッドをコールした場合に発生します。

public java.io.InputStream getInputStream()

入力ストリームを取得します。

start()で通信を開始していない状態の場合、IllegalStateExceptionが発生します。

入力ストリームでデータの入力処理中にIOExceptionが発生した場合、暗黙的にその入力ストリームのInputStream.close()がコールされます。

戻り値:: 入力ストリームを返します。
例外:: java.lang.IllegalStateException - start()で通信を開始していない状態で、本メソッドをコールした場合に発生します。

public byte[] sendCombinedFormat(byte[] write,
                                 int bufferSize)
                          throws java.io.IOException

書き込みと読み込みを合わせた命令を送信します。

本メソッドは書き込みと読み込みを合わせた複合フォーマットを生成して、マスタからスレーブに対して送信します。生成される複合フォーマットは、スレーブに対する書き込みと、スレーブからの読み込みの順番で生成されます。

start()で通信を開始していない状態の場合、IllegalStateExceptionが発生します。

パラメータ:: write - スレーブに対して送信するデータを指定します。; bufferSize - スレーブから受信したデータの格納先バッファのサイズを指定します。
戻り値:: スレーブから読み込んだ結果が格納されたバッファを返します。
例外:: java.lang.NullPointerException - writeがnullの場合に発生します。; java.lang.IllegalArgumentException - bufferSizeが負数、または0の場合に発生します。; java.lang.IllegalStateException - start()で通信を開始していない状態で、本メソッドをコールした場合に発生します。; java.io.IOException - 入出力エラーの場合に発生します。