com.docomo_um.module.connection
クラス SPIConnection

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

すべての実装されたインタフェース:

Connectable

public class SPIConnection
extends java.lang.Object
implements Connectable

SPIを表すクラスです。

利用可能なSPI情報を取得するには、getSPISpec()を使用します。 SPIのマスタ側(SPIMaster)のインスタンスを取得するには、SPI情報(SPISpec)の インスタンスを引数として、getSPIMaster(SPISpec, SPIMasterSettingInfo)で取得します。 SPIのスレーブ側(SPISlave)のインスタンスを取得するには、SPI情報(SPISpec)の インスタンスを引数として、getSPISlave(SPISpec)で取得します。

用語定義

• データ
  送信または受信する情報です。 1つ以上のフレームから形成されます。
• フレーム
  伝送するデータをフレームビット数ごとに分けた単位です。
  フレームビット数はSPIMasterSettingInfo.setBitsPerFrame(int)で設定します。
• クロック
  データの送信やサンプリングのタイミングを図るための信号です。 CS信号がアクティブの時にフレームが伝送されるタイミングで周期的に発振され、1回のクロック信号で1ビットのデータが伝送されます。
  クロックの周波数はSPIMasterSettingInfo.setClockFrequency(long)で設定します。
• 送受信
  マスタとスレーブの間でデータの伝送を行うことです。 フレーム送受信と記載されている場合は、データの中の1フレームの送受信を指します。
• CS信号
  マスタとスレーブの間で送受信を行う際の同期を取るための信号です。 データの送受信が開始されたタイミングでCS信号がアクティブになり、終了したタイミングで非アクティブになります。 また設定によって、フレーム送受信ごとに一度、非アクティブになります。
  データの送受信中にCS信号が変化するタイミングはSPIMasterSettingInfo.setCsMode(int)で設定します。
  スレーブでは、CS信号が変化したタイミングがSPIListener.onChangedStatus(SPIDevice, boolean)に通知されます。
• サンプリング
  データを受信する際に、実際にビットデータを取得するタイミングです。 クロック信号に合わせて1ビットずつデータを取得します。
  サンプリングのタイミングはSPIMasterSettingInfo.setClockMode(int)で設定します。

留意事項
デバイスの故障などによる障害が発生した状態、または物理的に接続されていない状態において、以下の場合に例外は発生しません。

• SPIMaster.sendFullduplexFormat(byte[])による入出力処理を行った場合
• SPIMaster.sendCombinedFormat(SPICombinedFormatData[])による入出力処理を行った場合

そのような場合において、各メソッドがどのような値を返すのかは、通信モジュールの実装に依存します。

連続してデータを送受信する際は、相手側の送受信に対応した順序となるように送受信を行ってください。

関連項目:

SPIConnection, SPISpec, SPIMaster, SPISlave

メソッドの概要

SPIMaster	getSPIMaster(SPISpec spi, SPIMasterSettingInfo info) SPIマスタ側インスタンスを生成します。
SPISlave	getSPISlave(SPISpec spi) SPIスレーブ側インスタンスを生成します。
java.util.List<SPISpec>	getSPISpec() 利用可能なSPI情報のリストを取得します。

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

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

メソッドの詳細

getSPISpec

public java.util.List<SPISpec> getSPISpec()

利用可能なSPI情報のリストを取得します。

戻り値:

SPI情報のリストを返します。

getSPIMaster

public SPIMaster getSPIMaster(SPISpec spi,
                              SPIMasterSettingInfo info)
                       throws ConnectionException

SPIマスタ側インスタンスを生成します。

SPIマスタ側インスタンスは1つのSPI情報につき1つです。 既に生成したSPI情報で再度生成しようとした場合、生成済みのSPIマスタ側インスタンスを返します。 その際に現在の設定情報と異なる設定情報を設定していた場合は、その設定情報が反映されます。 また、既にgetSPISlave(SPISpec)でスレーブ側インスタンスとして生成したSPI情報を、 本メソッドで生成しようとすると、IllegalStateExceptionが発生します。

パラメータ:

spi - マスタとして利用するSPI情報を指定します。

info - マスタとして利用するための設定情報を指定します。

戻り値:

SPIマスタ側インスタンスを返します。

例外:

java.lang.NullPointerException - spiまたはinfoがnullの場合に発生します。

java.lang.IllegalStateException - 既にスレーブ側インスタンスとして生成したデバイスを、本メソッドで生成しようとした場合に発生します。

java.lang.IllegalStateException - このインスタンスがSPIMaster.start()で通信を開始している状態で、本メソッドをコールした場合に発生します。

java.lang.IllegalArgumentException - スレーブのみで動作するspiを指定した場合に発生します。

ConnectionException - 内部エラーにより処理が中断した場合に発生します。

getSPISlave

public SPISlave getSPISlave(SPISpec spi)
                     throws ConnectionException

SPIスレーブ側インスタンスを生成します。

SPIスレーブ側インスタンスは1つのSPI情報につき1つです。 既に生成したSPI情報で再度生成しようとした場合、生成済みのSPIスレーブ側インスタンスを返します。 また、既にgetSPIMaster(SPISpec, SPIMasterSettingInfo)でマスタ側インスタンスとして生成したSPI情報を、 本メソッドで生成しようとすると、IllegalStateExceptionが発生します。

パラメータ:

spi - スレーブとして利用するSPI情報を指定します。

戻り値:

SPIスレーブ側インスタンスを返します。

例外:

java.lang.NullPointerException - spiがnullの場合に発生します。

java.lang.IllegalStateException - 既にマスタ側インスタンスとして生成したデバイスを、本メソッドで生成しようとした場合に発生します。

java.lang.IllegalArgumentException - マスタのみで動作するspiを指定した場合に発生します。

ConnectionException - 内部エラーにより処理が中断した場合に発生します。