Biz/Browser HTと外部サービスを連携する機能「ExternalService」クラスを用いて使用することができるメソッドの一覧です。
本項では、RFIDリーダ制御モジュールで使用可能な機能を説明します。
サービスの使い方については、Biz/Browser HTのExternalServiceクラスのリファレンスも参照してください。
対応機種とモジュール
メーカ |
対応機種 |
値 |
略称と対応モジュール |
|---|---|---|---|
|
CipherLab |
RK25 |
jp.co.opst.biz.util.rfid.cipherlab/.MainService |
CipherLab、CipherLab版 |
※掲載されている会社名や製品名は、一般に各社の商標または登録商標です。
本APIリファレンスのバージョン
モジュール |
バージョン |
Biz/Browserの対応バージョン |
|---|---|---|
|
CipherLab版 |
v1.0.4まで |
v1.2.6以上 |
|
v1.1.0 |
v1.4.4以上 |
| メソッド名 | 概要 |
|---|---|
| connect | RFIDリーダと接続します。 |
| disconnect | RFIDリーダとの接続を切断します。 |
| inventoryTag | インベントリ（スキャンを開始してRFタグのEPCを収集）を行います。 |
| stopAccessTag | スキャンを停止します。 |
| startReadTag | タグの読み取りを行います。インベントリと異なり、タグの任意の領域にアクセスしてデータを受け取ります。 |
| setTagAccessOnce | 同一のタグ（UII）を一度だけ読むようにするどうかを設定します。 |
| isTagAccessOnce | 同一のタグ（UII）を一度だけ読むようにするかどうかの設定を取得します。 |
| clearAccessTagList | スキャンしたタグの内部のリストをクリアします。同一タグの読み取りの判定に用います。 |
| setMask | タグの読み取りマスクを設定します。 |
| clearMask | タグの読み取りマスクを消去します。 |
| setTagDecode | 読み取ったタグをReadTagイベントで通知する際に、タグのデータをデコードするかどうかを設定します。 |
| setRadioChannel | 出力電波のチャンネルを設定します。 |
| getRadioChannel | 出力電波のチャンネルを取得します。 |
| setRadioPower | 出力電波の強度を設定します。 |
| getRadioPower | 出力電波の強度を取得します。 |
| setQValue | Q値を設定します。高いほどタグの読み取り衝突を抑えやすくなります。 |
| getQValue | Q値を取得します。 |
| setBuzzerVolume | 読み取り時などのブザー音の音量を設定します。 |
| getBuzzerVolume | 読み取り時などのブザー音の音量を取得します。 |
| setSessionFlag | タグへのアクセス時のセッションフラグを設定します。 |
| getSessionFlag | タグへのアクセス時のセッションフラグを取得します。 |
| writeSingleTag | UIIを指定して1枚のタグの任意の領域に書き込みを行います。 |
| lockSingleTag | UIIを指定して1枚のタグの任意の領域をロックまたはアンロックします。 |
| killSingleTag | UIIを指定して1枚のタグをキルします。 |
| getVersion | 本モジュールのバージョンを取得します。 |
| getBatteryLevel | バッテリー残量を取得します。 |
| setTriggerMode | RFIDリーダのトリガーを押したときの動作を指定します。 |
| setTriggerReaderMode | RFIDリーダのトリガーを押したときの動作をバーコードスキャナとRFIDスキャナで切り替えます。 |
| setDecodeTagEPC | タグEPC読み取り時に、EPCを標準コードなどにデコードするかどうか、その方法を指定します。 |
| ReadTagイベント | inventoryTagメソッドやstartReadTagメソッドでタグを読み取ったときに発生します。 |
| DeviceStateChangedイベント | connectやdisconnectやRFIDリーダの操作により、RFIDリーダの状態が変化したときに発生します。 |
説明 |
RFIDリーダと接続します。 ※RFIDリーダのペアリング等のハードウェア側の操作については、メーカードキュメントをご参照ください。
|
|
呼出形式 |
externalService1.invoke("connect" [, reset ]);
|
|
戻り値 |
なし
|
|
引数 |
boolean reset
|
RFID機器の設定を初期化するかどうかを指定します。trueが指定された場合は初期化します。省略時はfalseです。
|
説明 |
RFIDリーダとの接続を切断します。
|
|
呼出形式 |
externalService1.invoke("disconnect");
|
|
戻り値 |
なし
|
|
引数 |
なし
|
|
説明 |
インベントリ（スキャンを開始してRFタグのEPCを収集）を行います。
|
|
呼出形式 |
externalService1.invoke("inventoryTag");
|
|
戻り値 |
なし
|
|
引数 |
なし
|
|
説明 |
スキャンを停止します。
|
|
呼出形式 |
externalService1.invoke("stopAccessTag");
|
|
戻り値 |
なし
|
|
引数 |
なし
|
|
説明 |
タグの読み取りを行います。インベントリと異なり、タグの任意の領域にアクセスしてデータを受け取ります。
|
||||||||||
呼出形式 |
externalService1.invoke("startReadTag", memoryType, wordOffset, wordCount [, password]);
|
||||||||||
戻り値 |
なし
|
||||||||||
引数 |
|||||||||||
|
integer memoryType
|
読み取るメモリ領域
|
||||||||||
|
integer wordOffset
|
アクセス対象のオフセット位置（ワード単位） ※1ワードは2バイト
|
||||||||||
|
integer wordCount
|
オフセット位置から読み取るデータの長さ（ワード単位）
|
||||||||||
|
String password
|
タグに設定されているアクセスパスワードを16進数文字列で指定します。省略時は0です。
|
||||||||||
説明 |
同一のタグ（UII）を一度だけ読むようにするどうかを設定します。
|
|
呼出形式 |
externalService1.invoke("setTagAccessOnce", once);
|
|
戻り値 |
なし
|
|
引数 |
boolean once
|
一度だけ読むようにするかどうかを設定します。
|
説明 |
同一のタグ（UII）を一度だけ読むようにするかどうかの設定を取得します。
|
|
呼出形式 |
var res = externalService1.invoke("isTagAccessOnce");
|
|
戻り値 |
一度だけ読むようにするかどうかの設定を返します。
|
|
引数 |
なし
|
|
説明 |
スキャンしたタグの内部のリストをクリアします。同一タグの読み取りの判定に用います。
|
|
呼出形式 |
externalService1.invoke("clearAccessTagList");
|
|
戻り値 |
なし
|
|
引数 |
なし
|
|
説明 |
タグの読み取りマスクを設定します。
|
||||||||
呼出形式 |
externalService1.invoke("setMask", memoryType, maskOffset, maskBits, maskPattern);
|
||||||||
戻り値 |
なし
|
||||||||
引数 |
|||||||||
|
integer memoryType
|
マスクの対象とするメモリ領域
|
||||||||
|
integer maskOffset
|
メモリ領域内の、マスク対象とするオフセット位置（ビット単位）
|
||||||||
|
integer maskBits
|
マスク対象とするデータの長さ（ビット単位）
|
||||||||
|
String maskPattern
|
マスクパターン。16進数文字列で指定。
|
||||||||
説明 |
タグの読み取りマスクを消去します。
|
|
呼出形式 |
externalService1.invoke("clearMask");
|
|
戻り値 |
なし
|
|
引数 |
なし
|
|
説明 |
読み取ったタグをReadTagイベントで通知する際に、タグのデータをデコードするかどうかを設定します。
|
|
呼出形式 |
externalService1.invoke("setTagDecode", enabled);
|
|
戻り値 |
なし
|
|
引数 |
boolean enabled
|
デコードするかどうか。trueならする、falseならしない。デフォルトはfalseです。
|
説明 |
出力電波のチャンネルを設定します。
|
|||||||||||||||
呼出形式 |
externalService1.invoke("setRadioChannel", channels);
|
|||||||||||||||
戻り値 |
なし
|
|||||||||||||||
引数 |
integer channels
|
以下の値の組み合わせで、使用するチャンネルを指定します。
|
||||||||||||||
説明 |
出力電波のチャンネルを取得します。
|
|||||||||||||||
呼出形式 |
var res = externalService1.invoke("getRadioChannel");
|
|||||||||||||||
戻り値 |
出力電波の設定が値の組み合わせで返ります。
|
|||||||||||||||
引数 |
なし
|
|||||||||||||||
説明 |
出力電波の強度を設定します。高いほどタグが応答しやすくなり、読み取りが成功しやすくなります。
|
|
呼出形式 |
externalService1.invoke("setRadioPower", power);
|
|
戻り値 |
なし
|
|
引数 |
integer power
|
出力電波強度[dBm] 5～30
|
説明 |
出力電波の強度を取得します。
|
|
呼出形式 |
var res = externalService1.invoke("getRadioPower");
|
|
戻り値 |
出力電波強度 [dBm]
|
|
引数 |
なし
|
|
説明 |
Q値を設定します。高いほどタグの読み取り衝突を抑えやすくなります。
|
|||||
呼出形式 |
externalService1.invoke("setQValue", val);
|
|||||
戻り値 |
なし
|
|||||
引数 |
integer val
|
Q値 (2のn乗[枚])
|
||||
説明 |
Q値を取得します。
|
|
呼出形式 |
var res = externalService1.invoke("getQValue");
|
|
戻り値 |
Q値 (2のn乗[枚])
|
|
引数 |
なし
|
|
説明 |
読み取り時などのブザー音の音量を設定します。
Android端末のサイレントモードが有効の時にこのメソッドを呼び出すと、例外が発生します。
|
|
呼出形式 |
externalService1.invoke("setBuzzerVolume", val);
|
|
戻り値 |
なし
|
|
引数 |
||
|
integer val
|
ブザー音量 [%] 通常、0～100の範囲で設定します。
|
|
説明 |
読み取り時などのブザー音の音量を取得します。
|
|
呼出形式 |
var res = externalService1.invoke("getBuzzerVolume");
|
|
戻り値 |
ブザー音量 [%]
|
|
引数 |
なし
|
|
説明 |
タグへのアクセス時のセッションフラグを設定します。 inventoryTagメソッドでの読み取りにのみ反映されます。
|
|||||||||||
呼出形式 |
externalService1.invoke("setSessionFlag", session);
|
|||||||||||
戻り値 |
なし
|
|||||||||||
引数 |
integer session
|
セッションフラグを、以下の値のいずれかで指定します。
|
||||||||||
説明 |
タグへのアクセス時のセッションフラグを取得します。
|
|||||||||||
呼出形式 |
var res = externalService1.invoke("getSessionFlag");
|
|||||||||||
戻り値 |
セッションフラグを返します。
|
|||||||||||
引数 |
なし
|
|||||||||||
説明 |
UIIを指定して1枚のタグの任意の領域に書き込みを行います。
|
||||||||||
呼出形式 |
externalService1.invoke("writeSingleTag", memoryType, wordOffset, words, uii [, password]);
|
||||||||||
戻り値 |
なし
|
||||||||||
引数 |
|||||||||||
|
integer memoryType
|
書き込み先のメモリ領域
|
||||||||||
|
integer wordOffset
|
アクセス対象のオフセット位置（ワード単位）
|
||||||||||
|
integer words
|
タグに書き込むデータ（ワード単位の長さ）
|
||||||||||
|
String uii
|
書き込むタグのUII
|
||||||||||
|
String password
|
タグに設定されているアクセスパスワードを16進数文字列で指定します。省略時は0です。
|
||||||||||
説明 |
UIIを指定して1枚のタグの任意の領域をロックまたはアンロックします。
|
||||||||||||
呼出形式 |
externalService1.invoke("lockSingleTag", target, type, uii [, password]);
|
||||||||||||
戻り値 |
なし
|
||||||||||||
引数 |
|||||||||||||
|
integer target
|
操作対象。1種類のみ指定できます。
|
||||||||||||
|
integer type
|
操作内容
|
||||||||||||
|
String uii
|
操作するタグのUII
|
||||||||||||
|
String password
|
タグに設定されているアクセスパスワードを16進数文字列で指定します。省略時は0です。
|
||||||||||||
説明 |
UIIを指定して1枚のタグをキルします。
|
|
呼出形式 |
externalService1.invoke("killSingleTag", uii [, password]);
|
|
戻り値 |
なし
|
|
引数 |
String uii
String password |
操作するタグのUII
タグに設定されているアクセスパスワードを16進数文字列で指定します。省略時は0です。
|
説明 |
本モジュールのバージョンを取得します。
|
|
呼出形式 |
var res = externalService1.invoke("getVersion");
|
|
戻り値 |
バージョン番号が文字列で返ります。
|
|
引数 |
なし
|
|
説明 |
バッテリー残量を取得します。
|
|
呼出形式 |
var res = externalService1.invoke("getBatteryLevel");
|
|
戻り値 |
バッテリー残量 [%]
|
|
引数 |
なし
|
|
説明 |
RFIDリーダのトリガーを押したときの動作を指定します。
|
|||||||||
呼出形式 |
externalService1.invoke("setTriggerMode", mode);
|
|||||||||
戻り値 |
なし
|
|||||||||
引数 |
integer mode
|
動作内容を指定します。デフォルトは機器の現在の設定が適用されます。
|
||||||||
説明 |
RFIDリーダのトリガーを押したときの動作をバーコードスキャナとRFIDスキャナで切り替えます。
|
|||||||
呼出形式 |
externalService1.invoke("setTriggerReaderMode", mode);
|
|||||||
戻り値 |
なし
|
|||||||
引数 |
integer mode
|
動作内容を指定します。デフォルトは機器の現在の設定が適用されます。
|
||||||
説明 |
タグEPC読み取り時に、EPCを標準コードなどにデコードするかどうか、その方法を指定します。
|
|||||||
呼出形式 |
externalService1.invoke("setDecodeTagEPC", type);
|
|||||||
戻り値 |
なし
|
|||||||
引数 |
integer type
|
変換方法を指定します。
|
||||||
説明 |
inventoryTagメソッドやstartReadTagメソッドでタグを読み取ったときに発生します。
Eventオブジェクトには以下の子オブジェクトが付加されています。
|
|||||||||||||||||||
説明 |
connectメソッドやdisconnectメソッドやRFIDリーダの操作により、RFIDリーダの状態が変化したときに発生します。
Eventオブジェクトには以下の子オブジェクトが付加されています。
|
|||||||