jp.go.aist.dmrc.platform.beans.io

クラス PFFirmataConnector

java.lang.Object

jp.go.aist.dmrc.platform.beans.io.PFFirmataConnector

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

java.io.Serializable, PFComponent, PFXMLSerializable, PFActionEventSource, PFDataUpdateEventSource, PFEventSource, PFProcessTerminateEventSource

public class PFFirmataConnector
extends java.lang.Object
implements PFComponent, PFDataUpdateEventSource, PFProcessTerminateEventSource, PFActionEventSource, PFXMLSerializable

Firmata通信コンポーネント。 PC側のアプリケーションからFirmataプロトコルでマイコンと通信する。 firmata4jを使用している。

このコンポーネントから発生するイベントは以下のとおり。

• 処理完了イベント

  トリガ	結果データ	イベント番号
  ポート切断時	切断したポート名 String	0
  ポート接続時	接続したポート名 String	1

  
  
• データ更新イベント

  トリガ	対象データ	更新データ	イベント番号
  ポートのデータ受信	ピン番号/td>	更新後の値	0

  
  

バージョン:

1.00

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
PFFirmataConnector() コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	addDigitalInputConstantEventRule(int index, int eventNo, boolean high, long msec) デジタル入力の一定ルールを追加する。
boolean	addDigitalInputTransitionEventRule(int index, int eventNo, boolean high) デジタル入力の遷移ルールを追加する。
boolean	addInputConstantEventRule(int index, int eventNo, int border, boolean up, long msec) 入力値の一定ルールを追加する。
boolean	addInputRangeEventRule(int index, int eventNo, int lower, int upper) 入力値範囲のルールを追加する。
boolean	addInputRangeEventRule(int index, int eventNo, int lower, int upper, boolean diff) 入力値の範囲ルールを追加する。
boolean	addInputTransitionEventRule(int index, int eventNo, int border, boolean up) 入力値の遷移ルールを追加する。
boolean	addInputTransitionEventRule(int index, int eventNo, int border, boolean up, boolean diff) 入力値の遷移ルールを追加する。
void	addPFActionListener(PFActionListener lis) 引数で与えられたイベントリスナを登録し、 アクションイベント発生時に処理を行う対象とする。
void	addPFDataUpdateListener(PFDataUpdateListener lis) 引数で与えられたイベントリスナを登録し、 データ更新イベント発生時に処理を行う対象とする。
void	addPFProcessTerminateListener(PFProcessTerminateListener lis) 引数で与えられたイベントリスナを登録し、 処理完了イベント発生時に処理を行う対象とする。
void	clearEventRules() 全ルールを削除する。
void	evaluateInputRules() ルール判定の実行。
protected void	fireDataUpdated(PFDataUpdateEvent event) データ更新イベントを発生させる。
protected void	fireProcessTerminated(PFProcessTerminateEvent event) 処理完了イベントを発生させる。
int	getAnalogInputIndexAt(int index) アナログ入力のインデックスを位置指定で取得する。
PFObjectList	getAnalogInputIndexList() アナログ入力のインデックスリストを取得する。
int	getAnalogInputSize() アナログ入力の配列サイズを取得する。
long	getAnalogInputValueAt(int index) アナログ入力の値を位置指定で取得する。
PFObjectList	getAnalogInputValueList() アナログ入力の値リストを取得する。
int	getComponentID() コンポーネントIDを取得する。
java.lang.String	getComponentKey() コンポーネントキーを取得する。
PFMultiLocaleString	getComponentKeys() 全ロケール分のコンポーネントキーを返す。
java.lang.String	getComponentName() コンポーネント名称を取得する。
java.lang.String	getComponentPublicName() コンポーネント公開名を取得する.
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する。
float	getCurrentSamplingRate() 現在の入力ピンのサンプリング回数を取得する。
long	getCurrentSamplingTime() 現在の入力ピンのサンプリング間隔を取得する。
int	getDigitalInputIndexAt(int index) デジタル入力のインデックスを位置指定で取得する。
PFObjectList	getDigitalInputIndexList() デジタル入力のインデックスリストを取得する。
int	getDigitalInputSize() デジタル入力の配列サイズを取得する。
boolean	getDigitalInputValueAt(int index) デジタル入力の値を位置指定で取得する。
PFObjectList	getDigitalInputValueListAsInteger() デジタル入力の値リストを取得する。
java.util.Iterator	getPFActionListenerList() イベントリスナ配列を取得する。
java.util.Iterator	getPFDataUpdateListenerList() データ更新イベントリスナ配列を取得する。
java.util.Iterator	getPFProcessTerminateListenerList() 処理完了イベントリスナ配列を取得する。
java.lang.String	getPinModeAt(int index) 接続デバイスのピンモードを取得する。
PFObjectList	getPinModeList() 接続デバイスのピンモードの一覧を取得する。
int	getPinsCount() 接続デバイスのピン数を取得する。
PFObjectTable	getPinTable() 現在のピンの状態をテーブルで取得する。
long	getPinValueAt(int index) 接続デバイスのピンの値を取得する。
PFObjectList	getPortList() シリアルポートの一覧を取得する。
protected void	init() 初期化する。
boolean	isAllowPullTransfer() 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowPushTransfer() 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowRemoteInvocation() 他PFからのコンポーネント連携要求に対する可否属性を取得する.
boolean	isNoUpdateEventMode() データ更新イベント無モードを取得する。
boolean	isRepeatMode() 連続データ更新モードを取得する。
boolean	isStarted() 接続状態を返す。
void	localeUpdated() ロケール変更に対応する。
void	readXML(PFXMLLoader in) XMLを入力する.
void	removePFActionListener(PFActionListener lis) 引数で与えられたイベントリスナを削除し、 アクションイベント発生時に処理を行う対象から外す。
void	removePFDataUpdateListener(PFDataUpdateListener lis) 引数で与えられたイベントリスナを削除し、 データ更新イベント発生時に処理を行う対象から外す。
void	removePFProcessTerminateListener(PFProcessTerminateListener lis) 引数で与えられたイベントリスナを削除し、 処理完了イベント発生時に処理を行う対象から外す。
void	setAllowPullTransfer(boolean flag) 他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowPushTransfer(boolean flag) 他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowRemoteInvocation(boolean flag) 他PFからのコンポーネント連携要求に対する可否属性を設定する.
void	setComponentID(int id) コンポーネントIDを設定する。
void	setComponentKey(java.lang.String key) コンポーネントキーを設定する。
void	setComponentKeys(PFMultiLocaleString keys) 全ロケール分のコンポーネントキーを設定する。
void	setComponentPublicName(java.lang.String publicName) コンポーネント公開名を設定する.
void	setNoUpdateEventMode(boolean noupdate) データ更新イベント無モードを設定する。
void	setPinModeAt(int index, java.lang.String modeName) 接続デバイスのピンモードを設定する。
void	setPinValueAt(int index, long value) 接続デバイスのピンの値を設定する。
void	setRepeatMode(boolean repeat) 連続データ更新モードを設定する。
void	start() ポートを検索して接続を開始する。
boolean	start(java.lang.String port) ポート名指定で接続を開始する。
void	stop() 接続を終了する。
void	updateInputArray() 入力ピンの値の配列を更新する。
void	writeXML(PFXMLGenerator out) XMLを出力する.

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

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

コンストラクタの詳細

PFFirmataConnector

public PFFirmataConnector()
                   throws PFException

コンストラクタ。

例外:

PFException

メソッドの詳細

getComponentName

public java.lang.String getComponentName()

コンポーネント名称を取得する。

定義:

getComponentName インタフェース内 PFComponent

戻り値:

コンポーネント名

getComponentKey

public java.lang.String getComponentKey()

コンポーネントキーを取得する。

定義:

getComponentKey インタフェース内 PFComponent

戻り値:

コンポーネントキー

setComponentKey

public void setComponentKey(java.lang.String key)

コンポーネントキーを設定する。

定義:

setComponentKey インタフェース内 PFComponent

パラメータ:

key - コンポーネントキー

getComponentKeys

public PFMultiLocaleString getComponentKeys()

全ロケール分のコンポーネントキーを返す。

戻り値:

全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)

全ロケール分のコンポーネントキーを設定する。

パラメータ:

keys - 全ロケール分のコンポーネントキー

setComponentID

public void setComponentID(int id)

コンポーネントIDを設定する。
コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。

定義:

setComponentID インタフェース内 PFComponent

パラメータ:

id - 設定するコンポーネントID

getComponentString

public java.lang.String getComponentString()

コンポーネントの文字列表現を取得する。
形式："Component Name" [ ID : "ID" ]

定義:

getComponentString インタフェース内 PFComponent

戻り値:

文字列表現

getComponentID

public int getComponentID()

コンポーネントIDを取得する。

定義:

getComponentID インタフェース内 PFComponent

戻り値:

コンポーネントID

getComponentPublicName

public java.lang.String getComponentPublicName()

コンポーネント公開名を取得する.

定義:

getComponentPublicName インタフェース内 PFComponent

戻り値:

コンポーネント公開名

setComponentPublicName

public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException

コンポーネント公開名を設定する.
空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。 また、既存コンポーネントとの重複も認めない.

定義:

setComponentPublicName インタフェース内 PFComponent

パラメータ:

publicName - 設定するコンポーネント公開名

例外:

PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()

他PFからのコンポーネント連携要求に対する可否属性を取得する.

定義:

isAllowRemoteInvocation インタフェース内 PFComponent

戻り値:

コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)

他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:

setAllowRemoteInvocation インタフェース内 PFComponent

パラメータ:

flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

public boolean isAllowPullTransfer()

他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.

定義:

isAllowPullTransfer インタフェース内 PFComponent

戻り値:

Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)

他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.

定義:

setAllowPullTransfer インタフェース内 PFComponent

パラメータ:

flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

public boolean isAllowPushTransfer()

他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.

定義:

isAllowPushTransfer インタフェース内 PFComponent

戻り値:

Push型コンポーネント転送要求可否属性

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)

他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.

定義:

setAllowPushTransfer インタフェース内 PFComponent

パラメータ:

flag - Push型コンポーネント転送要求に対する可否

getPFProcessTerminateListenerList

public java.util.Iterator getPFProcessTerminateListenerList()

処理完了イベントリスナ配列を取得する。

定義:

getPFProcessTerminateListenerList インタフェース内 PFProcessTerminateEventSource

戻り値:

イベントリスナイテレータ

addPFProcessTerminateListener

public void addPFProcessTerminateListener(PFProcessTerminateListener lis)

引数で与えられたイベントリスナを登録し、 処理完了イベント発生時に処理を行う対象とする。

定義:

addPFProcessTerminateListener インタフェース内 PFProcessTerminateEventSource

パラメータ:

lis - 追加対象イベントリスナ

removePFProcessTerminateListener

public void removePFProcessTerminateListener(PFProcessTerminateListener lis)

引数で与えられたイベントリスナを削除し、 処理完了イベント発生時に処理を行う対象から外す。

定義:

removePFProcessTerminateListener インタフェース内 PFProcessTerminateEventSource

パラメータ:

lis - 削除対象イベントリスナ

fireProcessTerminated

protected void fireProcessTerminated(PFProcessTerminateEvent event)
                              throws PFMethodException,
                                     PFRuntimeException

処理完了イベントを発生させる。

パラメータ:

event - 処理完了イベント

例外:

PFMethodException - イベント伝播先のメソッド起動時のエラー

PFRuntimeException - 予期しない実行時エラー

getPFDataUpdateListenerList

public java.util.Iterator getPFDataUpdateListenerList()

データ更新イベントリスナ配列を取得する。

定義:

getPFDataUpdateListenerList インタフェース内 PFDataUpdateEventSource

戻り値:

イベントリスナイテレータ

addPFDataUpdateListener

public void addPFDataUpdateListener(PFDataUpdateListener lis)

引数で与えられたイベントリスナを登録し、 データ更新イベント発生時に処理を行う対象とする。

定義:

addPFDataUpdateListener インタフェース内 PFDataUpdateEventSource

パラメータ:

lis - 追加対象イベントリスナ

removePFDataUpdateListener

public void removePFDataUpdateListener(PFDataUpdateListener lis)

引数で与えられたイベントリスナを削除し、 データ更新イベント発生時に処理を行う対象から外す。

定義:

removePFDataUpdateListener インタフェース内 PFDataUpdateEventSource

パラメータ:

lis - 削除対象イベントリスナ

fireDataUpdated

protected void fireDataUpdated(PFDataUpdateEvent event)
                        throws PFMethodException,
                               PFRuntimeException

データ更新イベントを発生させる。

パラメータ:

event - データ更新イベント

例外:

PFMethodException - イベント伝播先のメソッド起動時のエラー

PFRuntimeException - 予期しない実行時エラー

getPFActionListenerList

public java.util.Iterator getPFActionListenerList()

イベントリスナ配列を取得する。

定義:

getPFActionListenerList インタフェース内 PFActionEventSource

戻り値:

イベントリスナイテレータ

addPFActionListener

public void addPFActionListener(PFActionListener lis)

引数で与えられたイベントリスナを登録し、 アクションイベント発生時に処理を行う対象とする。

定義:

addPFActionListener インタフェース内 PFActionEventSource

パラメータ:

lis - 追加対象イベントリスナ

removePFActionListener

public void removePFActionListener(PFActionListener lis)

引数で与えられたイベントリスナを削除し、 アクションイベント発生時に処理を行う対象から外す。

定義:

removePFActionListener インタフェース内 PFActionEventSource

パラメータ:

lis - 削除対象イベントリスナ

localeUpdated

public void localeUpdated()

ロケール変更に対応する。

定義:

localeUpdated インタフェース内 PFComponent

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException

XMLを出力する.

定義:

writeXML インタフェース内 PFXMLSerializable

パラメータ:

out - XML出力ユーティリティ

例外:

java.io.IOException

readXML

public void readXML(PFXMLLoader in)

XMLを入力する.

定義:

readXML インタフェース内 PFXMLSerializable

パラメータ:

in - XML入力ユーティリティ

start

public boolean start(java.lang.String port)
              throws PFException

ポート名指定で接続を開始する。

パラメータ:

port - ポート名

例外:

PFException - 接続失敗またはイベント処理失敗

start

public void start()
           throws PFException

ポートを検索して接続を開始する。

例外:

PFException - 接続失敗

isStarted

public boolean isStarted()

接続状態を返す。

戻り値:

接続中はtrue

stop

public void stop()
          throws PFException

接続を終了する。

例外:

PFException - 接続終了失敗またはイベント処理失敗

getPortList

public PFObjectList getPortList()

シリアルポートの一覧を取得する。

戻り値:

ポート名の一覧

getPinsCount

public int getPinsCount()

接続デバイスのピン数を取得する。

戻り値:

ピン数

getPinModeList

public PFObjectList getPinModeList()

接続デバイスのピンモードの一覧を取得する。

戻り値:

ピンモードの一覧

getPinModeAt

public java.lang.String getPinModeAt(int index)

接続デバイスのピンモードを取得する。

パラメータ:

index - 位置

戻り値:

ピンモード

setPinModeAt

public void setPinModeAt(int index,
                         java.lang.String modeName)
                  throws PFException

接続デバイスのピンモードを設定する。

パラメータ:

index - 位置

modeName - モード名

例外:

PFException - モード設定失敗

getPinValueAt

public long getPinValueAt(int index)

接続デバイスのピンの値を取得する。

パラメータ:

index - 位置

戻り値:

値

setPinValueAt

public void setPinValueAt(int index,
                          long value)
                   throws PFException

接続デバイスのピンの値を設定する。

パラメータ:

index - 位置

value - 値

例外:

PFException - 値設定の失敗

evaluateInputRules

public void evaluateInputRules()
                        throws PFException

ルール判定の実行。 データ更新イベント発生時には自動で呼び出される。 データ更新イベント無モードでは明示的に呼び出す必要がある。

例外:

PFException - イベント処理失敗

getPinTable

public PFObjectTable getPinTable()

現在のピンの状態をテーブルで取得する。

戻り値:

状態テーブル

updateInputArray

public void updateInputArray()

入力ピンの値の配列を更新する。 データ更新イベント発生時には自動で呼び出される。 データ更新イベント無モードでは明示的に呼び出す必要がある。

getCurrentSamplingTime

public long getCurrentSamplingTime()

現在の入力ピンのサンプリング間隔を取得する。

戻り値:

時間(msec)

getCurrentSamplingRate

public float getCurrentSamplingRate()

現在の入力ピンのサンプリング回数を取得する。

戻り値:

回数(Hz)

getAnalogInputSize

public int getAnalogInputSize()

アナログ入力の配列サイズを取得する。

戻り値:

配列サイズ

getAnalogInputValueAt

public long getAnalogInputValueAt(int index)

アナログ入力の値を位置指定で取得する。

パラメータ:

index - 配列内の位置

戻り値:

値

getAnalogInputIndexAt

public int getAnalogInputIndexAt(int index)

アナログ入力のインデックスを位置指定で取得する。

パラメータ:

index - 配列内の位置

戻り値:

ピンのインデックス

getAnalogInputValueList

public PFObjectList getAnalogInputValueList()

アナログ入力の値リストを取得する。

戻り値:

リスト(要素はLong)

getAnalogInputIndexList

public PFObjectList getAnalogInputIndexList()

アナログ入力のインデックスリストを取得する。

戻り値:

リスト(要素はInteger)

getDigitalInputSize

public int getDigitalInputSize()

デジタル入力の配列サイズを取得する。

戻り値:

配列サイズ

getDigitalInputValueAt

public boolean getDigitalInputValueAt(int index)

デジタル入力の値を位置指定で取得する。

パラメータ:

index - 位置

戻り値:

値

getDigitalInputIndexAt

public int getDigitalInputIndexAt(int index)

デジタル入力のインデックスを位置指定で取得する。

パラメータ:

index - 位置

戻り値:

インデックスr

getDigitalInputValueListAsInteger

public PFObjectList getDigitalInputValueListAsInteger()

デジタル入力の値リストを取得する。

戻り値:

リスト(要素はInteger)

getDigitalInputIndexList

public PFObjectList getDigitalInputIndexList()

デジタル入力のインデックスリストを取得する。

戻り値:

リスト(要素はInteger)

addInputRangeEventRule

public boolean addInputRangeEventRule(int index,
                                      int eventNo,
                                      int lower,
                                      int upper)

入力値範囲のルールを追加する。

パラメータ:

index - ピン位置

eventNo - イベント番号

lower - 下限値

upper - 上限値

戻り値:

追加できたらtrue

addInputRangeEventRule

public boolean addInputRangeEventRule(int index,
                                      int eventNo,
                                      int lower,
                                      int upper,
                                      boolean diff)

入力値の範囲ルールを追加する。

パラメータ:

index - ピン位置

eventNo - イベント番号

lower - 下限値

upper - 上限値

diff - 差分かどうか

戻り値:

追加できたらtrue

addDigitalInputTransitionEventRule

public boolean addDigitalInputTransitionEventRule(int index,
                                                  int eventNo,
                                                  boolean high)

デジタル入力の遷移ルールを追加する。

パラメータ:

index - ピン位置

eventNo - イベント番号

high - 対象値(HIGHがtrue)

戻り値:

追加できたらtrue

addInputTransitionEventRule

public boolean addInputTransitionEventRule(int index,
                                           int eventNo,
                                           int border,
                                           boolean up)

入力値の遷移ルールを追加する。

パラメータ:

index - ピン位置

eventNo - イベント番号

border - 基準値

up - 遷移方向(上がtrue)

戻り値:

追加できたらtrue

addInputTransitionEventRule

public boolean addInputTransitionEventRule(int index,
                                           int eventNo,
                                           int border,
                                           boolean up,
                                           boolean diff)

入力値の遷移ルールを追加する。

パラメータ:

index - ピン位置

eventNo - イベント番号

border - 基準値

up - 遷移方向(上がtrue)

diff - 差分かどうか

戻り値:

追加できたらtrue

addDigitalInputConstantEventRule

public boolean addDigitalInputConstantEventRule(int index,
                                                int eventNo,
                                                boolean high,
                                                long msec)

デジタル入力の一定ルールを追加する。

パラメータ:

index - ピン位置

eventNo - イベント番号

high - 対象値(HIGHがtrue)

msec - 経過時間

戻り値:

追加できたらtrue

addInputConstantEventRule

public boolean addInputConstantEventRule(int index,
                                         int eventNo,
                                         int border,
                                         boolean up,
                                         long msec)

入力値の一定ルールを追加する。

パラメータ:

index - ピン位置

eventNo - イベント番号

border - 基準値

up - 遷移方向(上がtrue)

msec - 経過時間

戻り値:

追加できたらtrue

clearEventRules

public void clearEventRules()

全ルールを削除する。

setRepeatMode

public void setRepeatMode(boolean repeat)

連続データ更新モードを設定する。

パラメータ:

repeat - 連続の場合true

isRepeatMode

public boolean isRepeatMode()

連続データ更新モードを取得する。

戻り値:

連続の場合true

setNoUpdateEventMode

public void setNoUpdateEventMode(boolean noupdate)

データ更新イベント無モードを設定する。

パラメータ:

noupdate - 無の場合true

isNoUpdateEventMode

public boolean isNoUpdateEventMode()

データ更新イベント無モードを取得する。

戻り値:

無の場合true

init

protected void init()

初期化する。