Biz/Browser HTと外部サービスを連携する機能「ExternalService」クラスを用いて使用することができるメソッドの一覧です。
本項では、RFIDリーダ制御モジュールで使用可能な機能を説明します。
サービスの使い方については、Biz/Browser HTのExternalServiceクラスのリファレンスも参照してください。
対応機種とモジュール
メーカ |
対応機種 |
値 |
略称と対応モジュール |
|---|---|---|---|
|
ゼブラテクノロジーズ |
MC3330R |
jp.co.opst.biz.util.rfid.zebra/.MainService |
ゼブラ、ゼブラ版 |
|
MC3330xR |
jp.co.opst.biz.util.rfid.zebra2/.MainService |
ゼブラ2、ゼブラ版2 |
|
|
RFD40 |
※掲載されている会社名や製品名は、一般に各社の商標または登録商標です。
本APIリファレンスのバージョン
モジュール |
バージョン |
Biz/Browserの対応バージョン |
|---|---|---|
|
ゼブラ版 |
v1.0.5 |
v1.2.6以上 |
|
ゼブラ版2 |
v1.2.0 |
v1.4.4以上 |
|
v1.1.0まで |
v1.2.6以上 |
| メソッド名 | 概要 |
|---|---|
| connect | RFIDリーダと接続します。引数で指定した方法でリーダを自動的に検出して接続します。 |
| disconnect | RFIDリーダとの接続を切断します。 |
| inventoryTag | インベントリ(スキャンを開始してRFタグのEPCを収集)を行います。 |
| stopAccessTag | スキャンを停止します。 |
| startReadTag | タグの読み取りを行います。インベントリと異なり、タグの任意の領域にアクセスしてデータを受け取ります。 |
| setTagAccessOnce | 同一のタグ(UII)を一度だけ読むようにするかどうかを設定します。 |
| isTagAccessOnce | 同一のタグ(UII)を一度だけ読むようにするかどうかの設定を取得します。 |
| clearAccessTagList | スキャンしたタグの内部のリストをクリアします。同一タグの読み取りの判定に用います。 |
| setMask | タグの読み取りマスクを設定します。 |
| clearMask | タグの読み取りマスクを消去します。 |
| setTagDecode | 読み取ったタグをReadTagイベントで通知する際に、タグのデータをデコードするかどうかを設定します。 |
| setUseTagAccessOnceByApplication | ソフトウェア側の機能によるタグの二度読み防止チェックを有効にするかどうかを指定します。ゼブラ版2専用機能 |
| isUseTagAccessOnceByApplication | ソフトウェア側の機能によるタグの二度読み防止チェックを有効にするかどうかの設定値を取得します。ゼブラ版2専用機能 |
| setRadioChannel | 出力電波のチャンネルを設定します。 |
| getRadioChannel | 出力電波のチャンネルを取得します。 |
| setRadioPower | 出力電波の強度を設定します。高いほどタグが応答しやすくなり、読み取りが成功しやすくなります。 |
| getRadioPower | 出力電波の強度を取得します。 |
| setQValue | Q値を設定します。高いほどタグの読み取り衝突を抑えやすくなります。 |
| getQValue | Q値を取得します。 |
| setBuzzerVolume | 読み取り時などのブザー音の音量を設定します。 |
| getBuzzerVolume | 読み取り時などのブザー音の音量を取得します。 |
| setSessionFlag | タグへのアクセス時のセッションフラグを設定します。 |
| getSessionFlag | タグへのアクセス時のセッションフラグを取得します。 |
| writeSingleTag | UIIを指定して1枚のタグの任意の領域に書き込みを行います。 |
| lockSingleTag | UIIを指定して1枚のタグの任意の領域をロックまたはアンロックします。 |
| killSingleTag | UIIを指定して1枚のタグをキルします。 |
| getVersion | 本モジュールのバージョンを取得します。 |
| getBatteryLevel | バッテリー残量を取得します。 |
| getMaxRadioPower | setRadioPowerメソッドで設定可能な最大の電波強度を取得します。 |
| intrinsic.connect | RFIDリーダと接続します。 |
| startScanBarcode | バーコードスキャンを開始します。対応機種のみ |
| stopScanBarcode | バーコード読み取りを停止します。対応機種のみ |
| setTxTime | 電波照射時間を指定します。 |
| getTxTime | 電波照射時間を取得します。 |
| setDecodeTagEPC | タグEPC読み取り時に、EPCを標準コードなどにデコードするかどうか、その方法を指定します。 |
| setBarcodeEnabled | 指定したバーコードを読み取り対象にするかどうかを設定します。ゼブラ版2専用機能、対応機種のみ |
| getBarcodeEnabled | 指定したバーコードを読み取り対象にするかどうかを取得します。ゼブラ版2専用機能、対応機種のみ |
| ReadTagイベント | inventoryTagメソッドやstartReadTagメソッドでタグを読み取ったときに発生します。 |
| DeviceStateChangedイベント | connectやdisconnectやRFIDリーダの操作により、RFIDリーダの状態が変化したときに発生します。 |
| TriggerChangedイベント | RFIDリーダのトリガーの押下状態が変化したときに発生します。 |
| ReadBarcodeイベント | startScanBarcodeメソッドでバーコードを読み込んだときに発生します。対応機種のみ |
説明 |
RFIDリーダと接続します。引数で指定した方法でリーダを自動的に検出して接続します。 ※RFIDリーダのペアリング等のハードウェア側の操作については、メーカーのドキュメントをご参照ください。 ※Android 13以降では、初回起動時に必要な権限を要求しますので、許可を選択してください。
|
|||||||||||
呼出形式 |
externalService1.invoke("connect" [, reader]);
|
|||||||||||
戻り値 |
なし
|
|||||||||||
引数 |
integer reader
|
リーダ種別。引数省略時は0(自動選択)です。
|
||||||||||
説明 |
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
|
タグに設定されているアクセスパスワード。省略時は0です。
|
||||||||||
説明 |
同一のタグ(UII)を一度だけ読むようにするかどうかを設定します。 inventoryTagメソッドでの読み取りにのみ反映されます。
|
|
呼出形式 |
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進数文字列で指定します。また、16ビット以上(4文字分以上)である必要があります。
|
||||||||
説明 |
タグの読み取りマスクを消去します。
|
|
呼出形式 |
externalService1.invoke("clearMask");
|
|
戻り値 |
なし
|
|
引数 |
なし
|
|
説明 |
読み取ったタグをReadTagイベントで通知する際に、タグのデータをデコードするかどうかを設定します。
|
|
呼出形式 |
externalService1.invoke("setTagDecode", enabled);
|
|
戻り値 |
なし
|
|
引数 |
boolean enabled
|
デコードするかどうかを設定します。 デコードする場合はtrueを、デコードしない場合はfalseを指定します。デフォルトはfalseです。
|
説明 |
ソフトウェア側の機能によるタグの二度読み防止チェックを有効にするかどうかを指定します。 デフォルト設定はfalseです。 ※本機能はゼブラ版2のみ対応しています。
この機能を有効にした場合、タグのEPC/UIIがすでに読み取ったものと重複しているかどうかをチェックし、重複していなければReadTagイベントを発生させるようにします。
setTagAccessOnceメソッドによるハードウェア設定には影響しません。 同時に有効にしても動作には問題ありませんが、通常、この機能を有効に利用する場合はハードウェア設定側の二度読み防止を無効にして使用します。
なお、この機能によってすでに読み取り済みのタグを読み取った場合、ReadTagイベントは発生しませんが読み取り音は鳴動することに注意してください。
|
|
呼出形式 |
externalService1.invoke("setUseTagAccessOnceByApplication", enabled);
|
|
戻り値 |
なし
|
|
引数 |
boolean enabled
|
機能を有効にするかどうかを設定します。 有効にする場合はtrueを、無効にする場合はfalseを指定します。
|
説明 |
ソフトウェア側の機能によるタグの二度読み防止チェックを有効にするかどうかの設定値を取得します。 ※本機能はゼブラ版2のみ対応しています。
|
|
呼出形式 |
var res = externalService1.invoke("isUseTagAccessOnceByApplication");
|
|
戻り値 |
機能を有効にするかどうかを取得します。 有効にする場合はtrueを、無効にする場合はfalseが返ります。
|
|
引数 |
なし
|
|
説明 |
出力電波のチャンネルを設定します。
|
|||||||||||||||
呼出形式 |
externalService1.invoke("setRadioChannel", channels);
|
|||||||||||||||
戻り値 |
なし
|
|||||||||||||||
引数 |
integer channels
|
以下の値の組み合わせで、使用するチャンネルを指定します。
|
||||||||||||||
説明 |
出力電波のチャンネルを取得します。
|
|||||||||||||||
呼出形式 |
var res = externalService1.invoke("getRadioChannel");
|
|||||||||||||||
戻り値 |
出力電波の設定が値の組み合わせで返ります。
|
|||||||||||||||
引数 |
なし
|
|||||||||||||||
説明 |
出力電波の強度を設定します。高いほどタグが応答しやすくなり、読み取りが成功しやすくなります。
|
|||||
呼出形式 |
externalService1.invoke("setRadioPower", power);
|
|||||
戻り値 |
なし
|
|||||
引数 |
number power
|
出力電波強度 [dBm]
|
||||
説明 |
出力電波の強度を取得します。
|
|
呼出形式 |
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乗[枚])
|
|
引数 |
なし
|
|
説明 |
読み取り時などのブザー音の音量を設定します。
|
||||||||||
呼出形式 |
externalService1.invoke("setBuzzerVolume", val [, persitent]);
|
||||||||||
戻り値 |
なし
|
||||||||||
引数 |
|||||||||||
|
integer val
|
ブザー音量 [%] 通常、0~100の範囲で設定します。
|
||||||||||
|
boolean persitent
|
設定を端末で保持し、次回接続時に自動的に反映するかどうかを設定します。 自動設定する場合はtrueを、自動設定しない場合はfalseを指定します。デフォルトはfalseです。
|
||||||||||
説明 |
読み取り時などのブザー音の音量を取得します。
|
|
呼出形式 |
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
|
タグに設定されているアクセスパスワード。省略時は0です。
|
||||||||||
説明 |
UIIを指定して1枚のタグの任意の領域をロックまたはアンロックします。
|
||||||||||||
呼出形式 |
externalService1.invoke("lockSingleTag", target, type, uii [, password]);
|
||||||||||||
戻り値 |
なし
|
||||||||||||
引数 |
|||||||||||||
|
integer target
|
操作対象
|
||||||||||||
|
integer type
|
操作内容
|
||||||||||||
|
String uii
|
操作するタグのUII
|
||||||||||||
|
String password
|
タグに設定されているアクセスパスワード。省略時は0です。
|
||||||||||||
説明 |
UIIを指定して1枚のタグをキルします。
|
|
呼出形式 |
externalService1.invoke("killSingleTag", uii [, password]);
|
|
戻り値 |
なし
|
|
引数 |
String uii
integer password |
操作するタグのUII
タグに設定されているキルパスワード。省略時は0です。
|
説明 |
本モジュールのバージョンを取得します。
|
|
呼出形式 |
var res = externalService1.invoke("getVersion");
|
|
戻り値 |
バージョン番号+リビジョン番号が文字列で返ります。
|
|
引数 |
なし
|
|
説明 |
バッテリー残量を取得します。
|
|
呼出形式 |
var res = externalService1.invoke("getBatteryLevel");
|
|
戻り値 |
バッテリー残量 [%]
|
|
引数 |
なし
|
|
説明 |
setRadioPowerメソッドで設定可能な最大の電波強度を取得します。
|
|
呼出形式 |
var res = externalService1.invoke("getMaxRadioPower");
|
|
戻り値 |
最大電波強度 [dBm]
|
|
引数 |
なし
|
|
説明 |
RFIDリーダと接続します。 ※本メソッドは非推奨APIで、互換性のために残されています。通常はconnectメソッドをご利用ください。
|
|
|
説明 |
バーコードスキャンを開始します。 読み取ったバーコードはReadBarcodeイベントとしてBiz/Browserに送信されます。 ※バーコードスキャン機能を持つRFD8500、RFD40 Premium Plusモデルのみ対応しています。
|
|
呼出形式 |
externalService1.invoke("startScanBarcode",sameInterval,oneshot);
|
|
戻り値 |
なし
|
|
|
引数 |
integer sameInterval
boolean oneshot |
同じバーコードを読み取らない時間(msec単位)。0なら無制限に読み取らない。デフォルト0。
一度バーコードを読み取ったら強制的にスキャンを終了するかどうか。デフォルトfalse。
|
説明 |
バーコード読み取りを停止します。 ※バーコードスキャン機能を持つRFD8500、RFD40 Premium Plusモデルのみ対応しています。
|
|
呼出形式 |
externalService1.invoke("stopScanBarcode");
|
|
戻り値 |
なし
|
|
引数 |
なし
|
|
説明 |
電波照射時間を指定します。
|
|
呼出形式 |
externalService1.invoke("setTxTime", TxTime);
|
|
戻り値 |
なし
|
|
引数 |
Integer TxTime
|
電波の照射時間を0〜5000の範囲で指定します(ミリ秒)。
|
説明 |
電波照射時間を取得します。
|
|
呼出形式 |
var res = externalService1.invoke("getTxTime");
|
|
戻り値 |
指定されている電波照射時間(ミリ秒)
|
|
引数 |
なし
|
|
説明 |
タグEPC読み取り時に、EPCを標準コードなどにデコードするかどうか、その方法を指定します。
|
|||||||
呼出形式 |
externalService1.invoke("setDecodeTagEPC", type);
|
|||||||
戻り値 |
なし
|
|||||||
引数 |
integer type
|
変換方法を指定します。
|
||||||
|
説明 |
指定したバーコードを読み取り対象にするかどうかを指定します。 設定に失敗した場合は例外が発生します。 ※本機能はゼブラ版2のみ対応しています。また、RFD40 Premium Plusモデルのみ対応しています。
|
|||||||||||||||||||||||||||||||||||||||||||||
|
呼出形式 |
externalService1.invoke("setBarcodeEnabled", type, enabled);
|
|||||||||||||||||||||||||||||||||||||||||||||
|
戻り値 |
なし
|
|||||||||||||||||||||||||||||||||||||||||||||
|
引数 |
integer type |
設定を行うバーコードの種類を指定します。 バーコードの種類はそれぞれ下記に対応しています。
※GS1 Compositeバーコードを読み取る場合は、読み取り対象のバーコードを構成している他のバーコード(GS1-128等)も同時に読み取り可にする必要があります。
|
||||||||||||||||||||||||||||||||||||||||||||
|
|
boolean enabled |
読み取りを行う場合はtrueを、読み取りを行わない場合はfalseを指定します。
|
||||||||||||||||||||||||||||||||||||||||||||
|
説明 |
指定したバーコードが読み取り対象かどうかを取得します。 ※本機能はゼブラ版2のみ対応しています。また、RFD40 Premium Plusモデルのみ対応しています。
|
|||||||||||||||||||||||||||||||||||||||||||||
|
呼出形式 |
var res = externalService1.invoke("getBarcodeEnabled", type);
|
|||||||||||||||||||||||||||||||||||||||||||||
|
戻り値 |
読み取り対象である場合はtrueを、読み取り対象ではない場合はfalseを返します。
|
|||||||||||||||||||||||||||||||||||||||||||||
|
引数 |
integer type |
設定を取得するバーコードの種類を指定します。 バーコードの種類はそれぞれ下記に対応しています。
|
||||||||||||||||||||||||||||||||||||||||||||
説明 |
inventoryTagメソッドやstartReadTagメソッドでタグを読み取ったときに発生します。
Eventオブジェクトには以下の子オブジェクトが付加されています。
|
|||||||||||||||||||
説明 |
connectメソッドやdisconnectメソッドやRFIDリーダの操作により、RFIDリーダの状態が変化したときに発生します。
Eventオブジェクトには以下の子オブジェクトが付加されています。
|
|||||||
説明 |
RFIDリーダのトリガーの押下状態が変化したときに発生します。
Eventオブジェクトには以下の子オブジェクトが付加されています。
|
|||||||
説明 |
startScanBarcodeメソッドでバーコードを読み込んだときに発生します。 ※バーコードスキャン機能を持つRFD8500、RFD40 Premium Plusモデルのみ対応しています。
Eventオブジェクトには以下の子オブジェクトが付加されています。
バーコードのタイプの種類は以下の通りです。
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||