com.docomo_um.module.connection
クラス Serial

java.lang.Object
  com.docomo_um.module.connection.Serial

public class Serial
extends java.lang.Object

シリアルデバイスを表すクラスです。

通信速度の設定は、setCommSpeed(long)で行ないます。 データ送信は、getOutputStream()で出力ストリームを取得し、データの出力処理を行います。 データ受信は、SerialListener.onReceived(Serial device)を受け、 getInputStream()で入力ストリームを取得し、データの入力処理を行います。

関連項目:

SerialConnection, SerialSpec, SerialListener

メソッドの概要

boolean	getERStatus() ER信号の状態を取得します。
java.io.InputStream	getInputStream() 入力ストリームを取得します。
java.io.OutputStream	getOutputStream() 出力ストリームを取得します。
boolean	isEnabled() シリアルデバイスが有効か無効かを問い合わせます。
void	setCommSpeed(long speed) デバイスの通信速度を設定します。
void	setEnable(boolean enabled) シリアルデバイスの有効/無効を設定します。
void	setSerialListener(SerialListener listener) リスナを登録します。

クラス java.lang.Object から継承されたメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait

メソッドの詳細

setCommSpeed

public void setCommSpeed(long speed)
                  throws ConnectionException

デバイスの通信速度を設定します。

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

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

USBデバイスが物理的に接続されていない場合は、ConnectionExceptionが発生します。 UARTデバイスが物理的に接続されていない場合は、内部エラーにより処理が中断した場合を除き、ConnectionExceptionは発生しません。

パラメータ:

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

例外:

java.lang.IllegalArgumentException - 利用出来ない通信速度(bps)を指定した場合に発生します。

ConnectionException - USBデバイスが物理的に接続されていない場合、または内部エラーにより処理が中断した場合に発生します。

java.lang.IllegalStateException - 通信速度を変更できない状態で、本メソッドをコールした場合に発生します。

getOutputStream

public java.io.OutputStream getOutputStream()

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

setEnable(boolean)で通信を有効にしていない状態の場合、 USBデバイスへの出力ストリームでデータの出力処理を行うとIOExceptionが発生します。 UARTデバイスへの出力ストリームでデータの出力処理を行った場合は、出力ストリームがcloseされている、 または出力ストリームに異常がある場合を除き、例外は発生しません。

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

戻り値:

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

getInputStream

public java.io.InputStream getInputStream()

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

setEnable(boolean)で通信を有効にしていない状態の場合、 USBデバイスへの入力ストリームでデータの入力処理を行うとIOExceptionが発生します。 UARTデバイスへの入力ストリームでデータの入力処理を行った場合は、入力ストリームがcloseされている、 または入力ストリームに異常がある場合を除き、例外は発生しません。

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

戻り値:

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

setEnable

public void setEnable(boolean enabled)
               throws ConnectionException

シリアルデバイスの有効/無効を設定します。

シリアルデバイスを無効とすると低消費電力モードになり、電力消費を抑えることが出来ます。

シリアルデバイスが無効の間は、シリアルデバイスに対するあらゆる通信は出来なくなります。 シリアルデバイスを利用したい場合は、有効にしてください。

シリアルデバイスが無効にされた際に、オープンされている入出力ストリームが存在する場合、当該ストリームに対して暗黙的にclose()が呼ばれます。

UARTデバイスの場合、インスタンス生成時には無効(false)が設定されます。
USBデバイスの場合、インスタンス生成時の初期値は通信モジュールの実装に依存します。

USBデバイスが物理的に接続されていない場合は、ConnectionExceptionが発生します。 UARTデバイスが物理的に接続されていない場合は、内部エラーにより処理が中断した場合を除き、ConnectionExceptionは発生しません。

パラメータ:

enabled - シリアルデバイスを有効にする場合はtrueを、無効にする場合はfalseを指定します。

例外:

ConnectionException - USBデバイスが物理的に接続されていない場合、または内部エラーにより処理が中断した場合に発生します。

isEnabled

public boolean isEnabled()

シリアルデバイスが有効か無効かを問い合わせます。

USBデバイスが物理的に接続されていない場合は、必ず無効(false)を返します。 UARTデバイスが物理的に接続されていない場合は、setEnable(boolean)で設定された状態を返します。

戻り値:

シリアルデバイスが有効である場合はtrueを、無効である場合はfalseを返します。

setSerialListener

public void setSerialListener(SerialListener listener)

リスナを登録します。

このインスタンスに登録できるリスナは1つだけです。 このメソッドを複数回呼出した場合、最後に登録したリスナだけが有効です。 null を指定すると、リスナの登録を削除します。

パラメータ:

listener - リスナを指定します。

getERStatus

public boolean getERStatus()

ER信号の状態を取得します。

接続先のシリアルデバイスが通信可能か否かを表すER信号を取得します。 ER信号の状態がtrueの場合は接続先のシリアルデバイスが通信可能であることを示し、 falseの場合は接続先のシリアルデバイスが通信不可であることを示します。

戻り値:

ER信号の状態を返します。