Biz/Browser HTと外部サービスを連携する機能「ExternalService」クラスを用いて使用することができるメソッドの一覧です。
本項では、RFIDリーダ制御モジュール（Unitech版）で使用可能な機能を説明します。
サービスの使い方については、Biz/Browser HTのExternalServiceクラスのリファレンスも参照してください。
対応機種とモジュール
メーカ |
対応機種 |
サービスID値 |
略称と対応モジュール |
|---|---|---|---|
|
Unitech |
EA530 |
com.accenture.biz.util.rfid.unitech/.MainService |
Unitech、Unitech版 |
※掲載されている会社名や製品名は、一般に各社の商標または登録商標です。
本APIリファレンスのバージョン
モジュール |
バージョン |
Biz/Browserの対応バージョン |
|---|---|---|
|
Unitech版 |
v1.0.0 |
v1.4.8以上 |
【注意事項】
EA530について、アプリ「DuraSpeed(※)」が有効になっている場合、以下の動作不具合を起こすことが判明しています。
※DuraSpeedとは、バックグラウンドアプリを制限することで、フォアグラウンドアプリを高速化するアプリケーションです。
・下記条件時にRFIDリーダ制御モジュールのサービスプロセスがDuraSpeedによって強制終了される。
RFIDリーダ制御モジュールがBindされていない状態で端末をスリープ状態にし、5分以上経過した場合。
・下記条件時にBiz/Browser HTからRFIDリーダ制御モジュールへのBindが失敗する。
- 手動でアプリ情報の「強制停止」によってRFIDリーダ制御モジュールのプロセスを強制終了した場合
- RFIDリーダ制御モジュールのプロセスが強制終了した場合(DuraSpeedにより強制終了された場合も含む)
- RFIDリーダ制御モジュールを上書きインストールした場合
RFIDリーダ制御モジュールを使用する際は、以下の手順でDuraSpeedをOFFに設定してください。
(1)OS設定＞DuraSpeedを開く
(2)OFFに切り替える(以降、ONに切り替えない限りは恒常的に維持されます)
| メソッド名 | 概要 |
|---|---|
| connect | RFIDリーダと接続します。 |
| disconnect | RFIDリーダとの接続を切断します。 |
| inventoryTag | インベントリ（スキャンを開始してRFタグのEPCを収集）を行います。 |
| stopAccessTag | スキャンを停止します。 |
| startReadTag | タグの読み取りを行います。インベントリと異なり、タグの任意の領域にアクセスしてデータを受け取ります。 |
| setTagAccessOnce | 同一のタグ（UII）を一度だけ読み取るようにするかどうかを設定します。 |
| isTagAccessOnce | 同一のタグ（UII）を一度だけ読み取るようにするかどうかの設定を取得します。 |
| clearAccessTagList | スキャンしたタグの内部のリストをクリアします。同一タグの読み取りの判定に用います。 |
| setMask | タグの読み取りマスクを設定します。 |
| clearMask | タグの読み取りマスクを消去します。 |
| setTagDecode | 読み取ったタグをReadTagイベントで通知する際に、タグのデータをデコードするかどうかを設定します。 |
| setRadioPower | 出力電波の強度を設定します。高いほどタグが応答しやすくなり、読み取りが成功しやすくなります。 |
| getRadioPower | 出力電波の強度を取得します。 |
| getMaxRadioPower | 出力電波強度の上限値を取得します。 |
| setQValue | Q値を設定します。高いほどタグの読み取り衝突を抑えやすくなります。 |
| getQValue | Q値を取得します。 |
| setBuzzerVolume | 読み取り時などのブザー音の音量を設定します。 |
| getBuzzerVolume | 読み取り時などのブザー音の音量を取得します。 |
| setSessionFlag | タグへのアクセス時のセッションフラグを設定します。 |
| getSessionFlag | タグへのアクセス時のセッションフラグを取得します。 |
| writeSingleTag | UIIを指定して1枚のタグの任意の領域に書き込みを行います。 |
| lockSingleTag | UIIを指定して1枚のタグの任意の領域をロックまたはアンロックします。 |
| getVersion | 本モジュールのバージョンを取得します。 |
| getBatteryLevel | バッテリー残量を取得します。 |
| startScanBarcode | バーコードスキャンを開始します。 |
| stopScanBarcode | バーコード読み取りを停止します。 |
| setBarcodeEnabled | 指定したバーコードを読み取り対象にするかどうかを指定します。 |
| ReadTagイベント | inventoryTagメソッドやstartReadTagメソッドでタグを読み取ったときに発生します。 |
| DeviceStateChangedイベント | connectメソッドやdisconnectメソッド、RFIDリーダの操作により、RFIDリーダの状態が変化したときに発生します。 |
| ReadBarcodeイベント | startScanBarcodeメソッドでバーコードを読み取ったときに発生します。 |
説明 |
RFIDリーダと接続します。
|
|
呼出形式 |
externalService1.invoke("connect");
|
|
戻り値 |
なし
|
|
引数 |
なし
|
|
説明 |
RFIDリーダとの接続を切断します。
|
|
呼出形式 |
externalService1.invoke("disconnect");
|
|
戻り値 |
なし
|
|
引数 |
なし
|
|
説明 |
インベントリ（スキャンを開始してRFタグのEPCを収集）を行います。
|
|
呼出形式 |
externalService1.invoke("inventoryTag");
|
|
戻り値 |
なし
|
|
引数 |
なし
|
|
説明 |
スキャンを停止します。
|
|
呼出形式 |
externalService1.invoke("stopAccessTag");
|
|
戻り値 |
なし
|
|
引数 |
なし
|
|
説明 |
タグの読み取りを行います。インベントリと異なり、タグの任意の領域にアクセスしてデータを受け取ります。
アクセスパスワードは常に"00000000"が使用されます。 |
||||||||||
呼出形式 |
externalService1.invoke("startReadTag", memoryType, wordOffset, wordCount);
|
||||||||||
戻り値 |
なし
|
||||||||||
引数 |
|||||||||||
|
integer memoryType
|
読み取るメモリ領域
|
||||||||||
|
integer wordOffset
|
アクセス対象のオフセット位置（ワード単位） ※1ワードは2バイト。0以上の値を指定してください。
|
||||||||||
|
integer wordCount
|
オフセット位置から読み取るデータの長さ（ワード単位）。0以上の値を指定してください。
|
||||||||||
説明 |
同一のタグ（UII）を一度だけ読み取るようにするかどうかを設定します。
|
|
呼出形式 |
externalService1.invoke("setTagAccessOnce", once);
|
|
戻り値 |
なし
|
|
引数 |
boolean once
|
一度だけ読み取りようにするかどうかを設定します。
|
説明 |
同一のタグ（UII）を一度だけ読み取るようにするかどうかの設定を取得します。
|
|
呼出形式 |
var res = externalService1.invoke("isTagAccessOnce");
|
|
戻り値 |
一度だけ読み取るようにするかどうかの設定を返します。
|
|
引数 |
なし
|
|
説明 |
スキャンしたタグの内部のリストをクリアします。同一タグの読み取りの判定に用います。
|
|
呼出形式 |
externalService1.invoke("clearAccessTagList");
|
|
戻り値 |
なし
|
|
引数 |
なし
|
|
説明 |
タグの読み取りマスクを設定します。 設定したマスクは、writeSingleTag、lockSingleTagの各メソッドを実行した後も維持されます。
|
||||||||
呼出形式 |
externalService1.invoke("setMask", memoryType, maskOffset, maskBits, maskPattern);
|
||||||||
戻り値 |
なし
|
||||||||
引数 |
|||||||||
|
integer memoryType
|
マスクの対象とするメモリ領域
|
||||||||
|
integer maskOffset
|
メモリ領域内の、マスク対象とするオフセット位置（ビット単位）。0以上の値を指定してください。
|
||||||||
|
integer maskBits
|
マスク対象とするデータの長さ（ビット単位）。0以上の値を指定してください。 maskBitsはmaskPatternの長さ（文字数）× 4と完全に一致している必要があります。
|
||||||||
|
String maskPattern
|
マスクパターン。16進数文字列で指定。
|
||||||||
説明 |
タグの読み取りマスクを消去します。
|
|
呼出形式 |
externalService1.invoke("clearMask");
|
|
戻り値 |
なし
|
|
引数 |
なし
|
|
説明 |
読み取ったタグをReadTagイベントで通知する際に、タグのデータをデコードするかどうかを設定します。
|
|||||||
呼出形式 |
externalService1.invoke("setTagDecode", mode);
|
|||||||
戻り値 |
なし
|
|||||||
引数 |
integer mode
|
デコード内容を、以下のビットの組み合わせ（ビットOR）で指定します。0以上の値を指定してください。
|
||||||
説明 |
出力電波の強度を設定します。高いほどタグが応答しやすくなり、読み取りが成功しやすくなります。
|
|
呼出形式 |
externalService1.invoke("setRadioPower", power);
|
|
戻り値 |
なし
|
|
引数 |
integer power
|
出力電波強度 [dBm] 11～getMaxRadioPowerメソッドで取得できる上限値
|
説明 |
出力電波の強度を取得します。
|
|
呼出形式 |
var res = externalService1.invoke("getRadioPower");
|
|
戻り値 |
出力電波強度 [dBm]
|
|
引数 |
なし
|
|
説明 |
出力電波強度の上限値を取得します。
|
|
呼出形式 |
var res = externalService1.invoke("getMaxRadioPower");
|
|
戻り値 |
出力電波強度の上限値 [dBm]
|
|
引数 |
なし
|
|
説明 |
Q値を設定します。高いほどタグの読み取り衝突を抑えやすくなります。
|
|
呼出形式 |
externalService1.invoke("setQValue", val);
|
|
戻り値 |
なし
|
|
引数 |
integer val
|
Q値。0～15の範囲で設定します。
|
説明 |
Q値を取得します。
|
|
呼出形式 |
var res = externalService1.invoke("getQValue");
|
|
戻り値 |
Q値
|
|
引数 |
なし
|
|
説明 |
読み取り時などのブザー音の音量を設定します。 ※getBuzzerVolumeメソッドで取得したとき、設定値と異なる値が戻る場合があります。
|
|
呼出形式 |
externalService1.invoke("setBuzzerVolume", val);
|
|
戻り値 |
なし
|
|
引数 |
||
|
integer val
|
ブザー音量 [%] 0～100の範囲で設定します。
|
|
説明 |
読み取り時などのブザー音の音量を取得します。
|
|
呼出形式 |
var res = externalService1.invoke("getBuzzerVolume");
|
|
戻り値 |
ブザー音量 [%]
|
|
引数 |
なし
|
|
説明 |
タグへのアクセス時のセッションフラグを設定します。
|
|||||||||||
呼出形式 |
externalService1.invoke("setSessionFlag", session);
|
|||||||||||
戻り値 |
なし
|
|||||||||||
引数 |
integer session
|
セッションフラグを、以下の値のいずれかで指定します。
|
||||||||||
説明 |
タグへのアクセス時のセッションフラグを取得します。
|
|||||||||||
呼出形式 |
var res = externalService1.invoke("getSessionFlag");
|
|||||||||||
戻り値 |
セッションフラグを返します。
|
|||||||||||
引数 |
なし
|
|||||||||||
説明 |
UIIを指定して1枚のタグの任意の領域に書き込みを行います。 setMaskメソッドでマスクが設定されている場合、本メソッドの実行後もマスクの設定は維持されます。
アクセスパスワードは常に"00000000"が使用されます。 |
||||||||||
呼出形式 |
externalService1.invoke("writeSingleTag", memoryType, wordOffset, words, uii);
|
||||||||||
戻り値 |
なし
|
||||||||||
引数 |
|||||||||||
|
integer memoryType
|
書き込み先のメモリ領域
|
||||||||||
|
integer wordOffset
|
アクセス対象のオフセット位置（ワード単位）。0以上の値を指定してください。
|
||||||||||
|
String words
|
タグに書き込むデータ。16進数文字列で指定します。ワード単位（2バイトの倍数）の長さである必要があります。
|
||||||||||
|
String uii
|
書き込むタグのUII
|
||||||||||
説明 |
UIIを指定して1枚のタグの任意の領域をロックまたはアンロックします。 setMaskメソッドでマスクが設定されている場合、本メソッドの実行後もマスクの設定は維持されます。
アクセスパスワードは常に"00000000"が使用されます。 |
||||||
呼出形式 |
externalService1.invoke("lockSingleTag", target, type, uii);
|
||||||
戻り値 |
なし
|
||||||
引数 |
|||||||
|
integer target
|
操作対象。複数の値のビットORで複数領域を指定可能です。-1を指定すると全領域が対象となります。
|
||||||
|
integer type
|
操作内容
|
||||||
|
String uii
|
操作するタグのUII
|
||||||
説明 |
本モジュールのバージョンを取得します。
|
|||||
呼出形式 |
var res = externalService1.invoke("getVersion");
|
|||||
戻り値 |
本モジュールのバージョン情報を示す文字列。
|
|||||
引数 |
なし
|
|||||
説明 |
バッテリー残量を取得します。
|
|
呼出形式 |
var res = externalService1.invoke("getBatteryLevel");
|
|
戻り値 |
バッテリー残量 [%]
|
|
引数 |
なし
|
|
|
説明 |
バーコードスキャンを開始します。 読み取ったバーコードはReadBarcodeイベントで受け取れます。
|
||||||||||||
呼出形式 |
externalService1.invoke("startScanBarcode", sameInterval, oneshot);
|
||||||||||||
戻り値 |
なし
|
||||||||||||
|
引数 |
|||||||||||||
|
integer sameInterval |
同一バーコードの読み取り抑制時間を100ms単位で指定します。
|
||||||||||||
|
boolean oneshot |
一度バーコードを読み取ったら自動的にスキャンを終了するかどうか。
|
||||||||||||
説明 |
バーコード読み取りを停止します。
|
|
呼出形式 |
externalService1.invoke("stopScanBarcode");
|
|
戻り値 |
なし
|
|
引数 |
なし
|
|
|
説明 |
指定したバーコードを読み取り対象にするかどうかを指定します。
|
||||||||||||||||||||||||||||||||||||||||||||||
|
呼出形式 |
externalService1.invoke("setBarcodeEnabled", type, enabled);
|
||||||||||||||||||||||||||||||||||||||||||||||
|
戻り値 |
なし
|
||||||||||||||||||||||||||||||||||||||||||||||
|
引数 |
|||||||||||||||||||||||||||||||||||||||||||||||
|
integer type |
バーコードの種類を指定します。
|
||||||||||||||||||||||||||||||||||||||||||||||
|
boolean enabled |
trueなら読み取り対象にする、falseなら対象から外す。
|
||||||||||||||||||||||||||||||||||||||||||||||
説明 |
inventoryTagメソッドやstartReadTagメソッドでタグを読み取ったときに発生します。
Eventオブジェクトには以下の子オブジェクトが付加されています。
|
|||||||||||||||||||
説明 |
connectメソッドやdisconnectメソッド、RFIDリーダの操作により、RFIDリーダの状態が変化したときに発生します。
Eventオブジェクトには以下の子オブジェクトが付加されています。
|
|||||||
説明 |
startScanBarcodeメソッドでバーコードを読み取ったときに発生します。
Eventオブジェクトには以下の子オブジェクトが付加されています。
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||