RFIDリーダ制御モジュール APIリファレンス

説明

RFIDリーダと接続します。
このメソッドはご利用の機器と動作モードによって使用方法が異なります。詳しくは各RFIDリーダとの接続方法を参照ください。

呼出形式

externalService1.invoke("connect" [, deviceName [, entryConnection]]);

戻り値

なし

引数

String deviceName

ペアリング済みRFIDリーダデバイスの名称、もしくはBluetoothアドレス（MACアドレス）
MACアドレス形式(**:**:**:**:**:**)で指定した場合はMACアドレスとして接続先デバイスの検索を行います。
それ以外の場合は、ペアリング済みデバイスの名称として接続先デバイスの検索を行います。デバイス名称は正規表現が使用可能です。

boolean entryConnection

接続モード。trueならスレーブモードで接続、falseならマスターモードで接続します。デフォルトはfalseです。

説明

NFC機能を利用してRFIDリーダと接続します。
詳しくは各RFIDリーダとの接続方法を参照ください。

※本機能はDENSO SP2専用です。

SP2の電源状態（ON/OFF）や接続モード（マスター/スレーブ）は問いません。

事前にBluetoothペアリングを行う必要はありません。NFCで接続する際に、自動的にペアリング要求が行われます。

SP2の電源がOFFの場合、接続が完了するまで数秒かかることがあります。

接続待機中に、以下のようなポップアップが表示されます。

このとき、SP2側のNFCマークへホスト端末を近づけると接続できます。

※接続音が鳴るまでホスト端末を離さないでください。

呼出形式

externalService1.invoke("nfcConnect", timeout);

戻り値

なし

引数

integer timeout

タイムアウト時間[ms]

5000[ms]～10000[ms]の範囲内で指定します。範囲外の値を指定した場合、5000[ms]が指定されたものとして動作します。

説明

RFIDリーダとの接続を切断します。

呼出形式

externalService1.invoke("disconnect");

戻り値

なし

引数

なし

説明

インベントリ（スキャンを開始してRFタグのEPCを収集）を行います。
読み取ったタグはReadTagイベントで受け取れます。
すでにスキャンが開始されている場合は一度現在のスキャンを停止してから行います。

呼出形式

externalService1.invoke("inventoryTag");

戻り値

なし

引数

なし

説明

スキャンを停止します。

呼出形式

externalService1.invoke("stopAccessTag");

戻り値

なし

引数

なし

説明

タグの読み取りを行います。インベントリと異なり、タグの任意の領域にアクセスしてデータを受け取ります。
読み取ったタグはReadTagイベントで受け取れます。
すでにスキャンが開始されている場合は一度現在のスキャンを停止してから行います。

呼出形式

externalService1.invoke("startReadTag", memoryType, wordOffset, wordCount [, password]);

戻り値

なし

引数

integer memoryType

読み取るメモリ領域

integer wordOffset

アクセス対象のオフセット位置（ワード単位）

※1ワードとは、2バイト分の長さを指します。2バイト目をオフセット位置とする場合は1を指定します。

integer wordCount

オフセット位置から読み取るデータの長さ（ワード単位）

String password

タグに設定されているアクセスパスワードを16進数表現の文字列で指定します。

省略時は0です。

※v1.0.6の仕様変更により、passwordの型がintegerからStringとなりました。

　アクセスパスワードを指定している場合、CRSを下記のように変更する必要があります。

説明

同一のタグ（UII）を一度だけ読み取るようにするかどうかを設定します。

※スキャン停止直前にタグを読み取った場合、リーダー側ではタグを読み取った扱いでもReadTagイベントが発生しないことがあります。

呼出形式

externalService1.invoke("setTagAccessOnce", once);

戻り値

なし

引数

boolean once

一度だけ読むようにするかどうかを設定します。
trueなら1度だけ読み取り、falseなら何度でも読み取ります。デフォルトは端末の設定に依存します。

説明

同一のタグ（UII）を一度だけ読み取るようにするかどうかの設定を取得します。

呼出形式

var res = externalService1.invoke("isTagAccessOnce");

戻り値

一度だけ読み取るようにするかどうかの設定を返します。
trueなら1度だけ読み取り、falseなら何度でも読み取ります。

引数

なし

説明

スキャンしたタグの内部のリストをクリアします。

setTagAccessOnceメソッドによる同一タグの読み取りの判定に用います。

呼出形式

externalService1.invoke("clearAccessTagList");

戻り値

なし

引数

なし

説明

タグの読み取りマスクを設定します。
マスクを設定すると、設定したマスクパターンに一致するタグのみ読み取るようになります。

呼出形式

externalService1.invoke("setMask", memoryType, maskOffset, maskBits, maskPattern);

戻り値

なし

引数

integer memoryType

マスクの対象とするメモリ領域

integer maskOffset

メモリ領域内の、マスク対象とするオフセット位置（ビット単位）

0 以上の値を指定します。

integer maskBits

マスク対象とするデータの長さ（ビット単位）

16 以上 256 未満の値を指定します。

String maskPattern

マスクパターン。16進数表現の文字列で指定します。

説明

タグの読み取りマスクを消去します。

呼出形式

externalService1.invoke("clearMask");

戻り値

なし

引数

なし

説明

読み取ったタグをReadTagイベントで通知する際に、タグのデータをデコードするかどうかを設定します。

デコードした結果は、ReadTagイベントの子オブジェクトdetailとして追加されます。

呼出形式

externalService1.invoke("setTagDecode", enabled);

戻り値

なし

引数

boolean enabled

デコードするかどうかを指定します。

する場合はtrue、そうでない場合はfalseを指定します。デフォルトではfalseとして動作します。

説明

ソフトウェア側の機能によるタグの二度読み防止チェックを有効にするかどうかを指定します。

デフォルト設定はfalseです。

この機能を有効にした場合、タグのEPC/UIIがすでに読み取ったものと重複しているかどうかをチェックし、重複していなければReadTagイベントを発生させるようにします。

setTagAccessOnceメソッドによるハードウェア設定には影響しません。

同時に有効にしても動作には問題ありませんが、通常、この機能を有効に利用する場合はハードウェア設定側の二度読み防止を無効にして使用します。

なお、この機能によってすでに読み取り済みのタグを読み取った場合、ReadTagイベントは発生しませんが読み取り音は鳴動することに注意してください。

呼出形式

externalService1.invoke("setUseTagAccessOnceByApplication", enabled);

戻り値

なし

引数

boolean enabled

機能を有効にするかどうか。する場合はtrue、そうでない場合はfalseを指定します。

説明

ソフトウェア側の機能によるタグの二度読み防止チェックを有効にするかどうかの設定値を取得します。

呼出形式

var res = externalService1.invoke("isUseTagAccessOnceByApplication");

戻り値

機能を有効にするかどうか。する場合はtrue、そうでない場合はfalseが返ります。

引数

なし

説明

出力電波のチャンネルを設定します。

呼出形式

externalService1.invoke("setRadioChannel", channels [, channelSet]);

戻り値

なし

引数

integer channels

以下の値の組み合わせで、使用するチャンネルを指定します。
SP2の場合、チャンネル種別が「channel」と「channel2」の2種類があり、引数channelSetの値によって指定したいずれか1種類の値を設定することができます。
SP1の場合、「channel」のみ使用できます。
※日本の電波法に基づいて適切な値を使用するようご注意ください。
※channel2はSP1では使用できません。

integer channelSet

設定先のチャンネル種別を指定します。

SP1、SP2いずれの場合も、対応していないチャンネル種別を指定すると例外が発生します。

説明

出力電波のチャンネルを取得します。

呼出形式

var res = externalService1.invoke("getRadioChannel" [, channelSet]);

戻り値

出力電波の設定が値の組み合わせで返ります。

引数

integer channelSet

取得先のチャンネル種別を指定します。

SP1、SP2いずれの場合も、対応していないチャンネル種別を指定すると例外が発生します。

説明

出力電波の強度を設定します。高いほどタグが応答しやすくなり、読み取りが成功しやすくなります。

呼出形式

externalService1.invoke("setRadioPower", power);

戻り値

なし

引数

integer power

出力電波強度 [dBm] 4 ～ 30
※日本の電波法に基づいて適切な値を使用するようご注意ください。

説明

出力電波の強度を取得します。

呼出形式

var res = externalService1.invoke("getRadioPower");

戻り値

出力電波強度 [dBm]

引数

なし

説明

Q値を設定します。高いほどタグの読み取り衝突を抑えやすくなります。
対応するタグの枚数は 2 のn乗で表され、例えば 15 を設定した場合は 2^15 = 32768[枚] となります。

呼出形式

externalService1.invoke("setQValue", val);

戻り値

なし

引数

integer val

Q値 (2のn乗[枚])

説明

Q値を取得します。

呼出形式

var res = externalService1.invoke("getQValue");

戻り値

Q値 (2のn乗[枚])

引数

なし

説明

読み取り時などのブザー音の音量を設定します。

呼出形式

externalService1.invoke("setBuzzerVolume", val);

戻り値

なし

引数

integer val

ブザー音量 [%]　通常、0～100の範囲で設定します。
※実際に設定される音量はRFID機器によって異なります。
※getBuzzerVolumeメソッドで取得したとき、設定値と異なる値が戻る場合があります。

説明

読み取り時などのブザー音の音量を取得します。

呼出形式

var res = externalService1.invoke("getBuzzerVolume");

戻り値

ブザー音量 [%]
※setBuzzerVolumeメソッドの設定値と異なる値が戻る場合があります。

引数

なし

説明

タグへのアクセス時のセッションフラグを設定します。

呼出形式

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

アクセス対象のオフセット位置（ワード単位）

String words

タグに書き込むデータを、16進数文字列で指定します。（ワード単位の長さ）

String uii

書き込むタグのUII

String password

タグに設定されているアクセスパスワードを16進数表現の文字列で指定します。

省略時は0です。

※v1.0.6の仕様変更により、passwordの型がintegerからStringとなりました。

アクセスパスワードを指定している場合、CRSを下記のように変更する必要があります。

説明

UIIを指定して1枚のタグの任意の領域をロックまたはアンロックします。
このメソッドは同期的に実行され、実行を終えるかタイムアウトするまで処理が返りません。

呼出形式

externalService1.invoke("lockSingleTag", target, type, uii [, password]);

戻り値

なし

引数

integer target

操作対象。値の組み合わせで複数指定できます。

integer type

操作内容

String uii

操作するタグのUII

String password

タグに設定されているアクセスパスワードを16進数表現の文字列で指定します。

省略時は0です。

※v1.0.6の仕様変更により、passwordの型がintegerからStringとなりました。

アクセスパスワードを指定している場合、CRSを下記のように変更する必要があります。

説明

UIIを指定して1枚のタグをキルします。
このメソッドは同期的に実行され、実行を終えるかタイムアウトするまで処理が返りません。

呼出形式

externalService1.invoke("killSingleTag", uii [, password]);

戻り値

なし

引数

String uii

String password

操作するタグのUII

タグに設定されているキルパスワードを16進数表現の文字列で指定します。

省略時は0です。

※v1.0.6の仕様変更により、passwordの型がintegerからStringとなりました。

キルパスワードを指定している場合、CRSを下記のように変更する必要があります。

説明

本モジュールのバージョンを取得します。

呼出形式

var res = externalService1.invoke("getVersion");

戻り値

本モジュールのバージョン情報を示す文字列。
バージョン番号、リビジョン番号、その他のモジュールを区別する情報で構成されます。

引数

なし

説明

バッテリー残量を取得します。
※残量に応じて「10」「40」「100」のいずれかのみ返ります。
※SP2の場合、２つのバッテリー残量の大きい方を返します。

呼出形式

var res = externalService1.invoke("getBatteryLevel");

戻り値

バッテリー残量 [%]

引数

なし

説明

偏波設定を設定します。

呼出形式

externalService1.invoke("setPolarization", polarization);

戻り値

なし

引数

integer polarization

偏波設定を指定します。

説明

偏波設定を取得します。

呼出形式

var res = externalService1.invoke("getPolarization");

戻り値

偏波設定を取得します。

引数

なし

説明

RFIDリーダと接続します。

本メソッドの仕様はconnectメソッドと同じです。実行時はconnectメソッドが呼ばれたものとして扱われます。

※本メソッドは非推奨APIで、互換性のために残されています。通常はconnectメソッドをご利用ください。

説明

バーコードスキャンを開始します。

読み取ったバーコードはReadBarcodeイベントとしてBiz/Browserに送信されます。

呼出形式

externalService1.invoke("startScanBarcode",sameInterval,oneshot);

戻り値

なし

引数

integer sameInterval

同一バーコードを読み取らない時間。デフォルト0。100ミリ秒単位で指定します。
0ミリ秒を指定した時の挙動は以下の通りになります。

boolean oneshot

一度バーコードを読み取ったら強制的にスキャンを終了するかどうか。デフォルトfalse。

説明

バーコード読み取りを停止します。

呼出形式

externalService1.invoke("stopScanBarcode");

戻り値

なし

引数

なし

説明

指定したバーコードを読み取り対象にするかどうかを指定します。

呼出形式

externalService1.invoke("setBarcodeEnabled", type, enabled);

戻り値

なし

引数

integer type

設定を行うバーコードの種類を指定します。

バーコードの種類はそれぞれ下記に対応しています。

※1 "ISBT-128"は"CODE-128"(11)として識別されます。

※2 読み取り時、ReadBarcodeイベントが2回発生します。（1回目：上段シンボル, 2回目：下段シンボル）

※3 "GS1-128"のスキャン制御は"CODE-128"(11)に依存します。

※4 読み取り時の種類は"PDF417"(25)として識別されます。

boolean enabled

スキャンを有効にする場合はtrueを、無効にする場合はfalseを指定します。

説明

指定したバーコードを読み取り対象にするかどうかを取得します。

呼出形式

var res = externalService1.invoke("getBarcodeEnabled", type);

戻り値

読み取り対象である場合はtrueを、読み取り対象ではない場合はfalseを返します。

引数

integer type

設定を取得するバーコードの種類を指定します。

バーコードの種類はそれぞれ下記に対応しています。

※1 "ISBT-128"は"CODE-128"(11)として識別されます。

※2 スキャン時、ReadBarcodeイベントが2回発生します。（1回目：上段シンボル、2回目：下段シンボル）

※3 "GS1-128"のスキャン制御は"CODE-128"(11)に依存します。

※4 スキャン時の種類は"PDF417"(25)として識別されます。

説明

拡張省電力設定を指定します。

呼出形式

externalService1.invoke("setPowerSaveExt", powersave);

戻り値

なし

引数

integer powersave

拡張省電力設定を指定します。

説明

拡張省電力設定を取得します。

呼出形式

var res = externalService1.invoke("getPowerSaveExt");

戻り値

拡張省電力設定を取得します。

引数

なし

説明

LinkProfile番号を設定します。

呼出形式

externalService1.invoke("setLinkProfile", val);

戻り値

なし

引数

integer val

LinkProfile番号

説明

LinkProfile番号を取得します。

呼出形式

var res = externalService1.invoke("getLinkProfile");

戻り値

LinkProfile番号

引数

なし

説明

AutoLinkProfileモードを設定します。

内部的にLinkProfileを変更しながらinventoryを行います。

この設定値は次回inventory操作を開始したときから機器側で反映されます。inventory以外の操作には影響しません。

呼出形式

externalService1.invoke("setAutoLinkProfile", mode);

戻り値

なし

引数

integer mode

AutoLinkProfileモードを指定します。

説明

AutoLinkProfileモードの設定を取得します。

呼出形式

var res = externalService1.invoke("getAutoLinkProfile");

戻り値

AutoLinkProfileモードの設定値

引数

なし

説明

タグEPC読み取り時に、EPCを標準コードなどにデコードするかどうか、その方法を指定します。

呼出形式

externalService1.invoke("setDecodeTagEPC", type);

戻り値

なし

引数

integer type

変換方法を指定します。

説明

電子ペーパータグに送信するワークパネルを作成します。

ワークパネルに描画した画像データが電子ペーパータグに描画されます。

呼出形式

externalService1.invoke("createWorkPanel", width, height, color);

戻り値

なし

引数

integer width

ワークパネルの横幅を指定します。

1から296の範囲で指定します。

integer height

ワークパネルの高さを指定します。

1から128の範囲で指定します。

integer color

ワークパネルの背景色を下記から指定します。

説明

ワークパネルに画像データのバイナリデータを書き込みます。

指定するバイナリデータは、SP1/SP2が対応する2値画像データか、Bitmap形式の画像データとなります。

Bitmap形式の画像データはモノクローム画像を想定しています。

本機能を使用するためには、Biz/Browser HT 1.3.0以上が必要です。

createWorkPanelメソッドを呼び出す前に本メソッドを呼び出すと、処理に失敗します。

呼出形式

externalService1.invoke("editWorkPanel", x, y, width, height, tcolor, format, data);

戻り値

なし

引数

integer x

画像データの描画開始位置のx座標を指定します。

0から295の範囲で指定します。

integer y

画像データの描画開始位置のy座標を指定します。

0から127の範囲で指定します。

integer width

画像データの横幅を指定します。

1から296の範囲で指定します。

integer height

画像データの高さを指定します。

1から128の範囲で指定します。

integer tcolor

透過色を下記から指定します。

integer format

dataの形式を下記から指定します。

ByteArray data

画像データのバイナリデータ。

説明

指定したImageクラスオブジェクトの画像データをワークパネルに書き込みます。

Imageクラスオブジェクトで指定する画像データはモノクローム画像を想定しています。

本機能を使用するためには、Biz/Browser HT 1.3.0以上が必要です。

createWorkPanelメソッドを呼び出す前に本メソッドを呼び出すと、処理に失敗します。

呼出形式

externalService1.invoke("editWorkPanelWithImage", x, y, tcolor, img);

戻り値

なし

引数

integer x

画像データの描画開始位置のx座標を指定します。

0から295の範囲で指定します。

integer y

画像データの描画開始位置のy座標を指定します。

0から127の範囲で指定します。

integer tcolor

透過色を下記から指定します。

Image img

画像データを格納したImageクラスオブジェクト。

説明

ワークパネルの内容を電子ペーパータグに送信します。

呼出形式

externalService1.invoke("sendWorkPanel", uii, timeoutMsec [, password]);

戻り値

なし

引数

String uii

ワークパネルを送信するタグのuii。

integer timeoutMsec

タイムアウト時間をミリ秒単位で指定します。

ワークパネルの送信には時間がかかる場合があるため、十分な時間を指定してください。

String password

タグに設定されているアクセスパスワードを16進数表現の文字列で指定します。

省略時は0です。

説明

ワークパネルの内容をSP1/SP2に保存します。

最大で4つのデータを保存できます。

保存されたデータは電源を切っても保持されます。

ワークパネルが作成されていない場合、メソッドの呼び出しは失敗します。

呼出形式

externalService1.invoke("saveEPDPanel", index);

戻り値

なし

引数

integer index

保存先番号を指定します。

1から4の範囲で指定します。

説明

SP1/SP2に保存されたデータをワークパネルにロードします。

呼出形式

externalService1.invoke("loadEPDPanel", index);

戻り値

なし

引数

integer index

保存先番号を指定します。

1から4の範囲で指定します。

説明

画像データのバイナリデータをワークパネル、もしくはSP1/SP2の保存先に直接保存します。

指定するバイナリデータは、SP1/SP2が対応する2値画像データか、Bitmap形式の画像データとなります。

本機能を使用するためには、Biz/Browser HT 1.3.0以上が必要です。

本メソッドで横幅x高さが8の倍数ではない画像を指定すると、uploadEPDPanelメソッドの呼び出しに失敗します。

呼出形式

externalService1.invoke("downloadEPDPanel", index, width, height, format, data);

戻り値

なし

引数

integer index

画像データの保存先を下記から指定します。

integer width

画像データの横幅を指定します。

1から296の範囲で指定します。

integer height

画像データの高さを指定します。

1から128の範囲で指定します。

integer format

dataの形式を下記から指定します。

ByteArray data

画像データのバイナリデータ。

説明

指定したImageクラスオブジェクトの画像データをワークパネル、もしくはSP1/SP2の保存先に直接保存します。

Imageクラスオブジェクトで指定する画像データはモノクローム画像を想定しています。

本機能を使用するためには、Biz/Browser HT 1.3.0以上が必要です。

本メソッドで横幅x高さが8の倍数ではない画像を指定すると、uploadEPDPanelメソッドメソッドの呼び出しに失敗します。

呼出形式

externalService1.invoke("downloadEPDPanelWithImage", index, img);

戻り値

なし

引数

integer index

画像データの保存先を下記から指定します。

Image img

画像データを格納したImageクラスオブジェクト。

説明

ワークパネルの内容やSP1/SP2に保存されているパネルのデータをImageオブジェクトとして取得します。

本機能を使用するためには、Biz/Browser HT 1.3.0以上が必要です。

downloadEPDPanelメソッド、またはdownloadEPDPanelWithImageメソッドで横幅x高さが8の倍数ではない画像を指定すると、uploadEPDPanelメソッドの呼び出しに失敗します。

呼出形式

var res = externalService1.invoke("uploadEPDPanel", index);

戻り値

ワークパネルの内容、もしくはSP1/SP2に保存されている画像データをImageクラスオブジェクトとして返します。

引数

integer index

画像データの取得先を下記から指定します。

説明

inventoryTagメソッドやstartReadTagメソッドでタグを読み取ったときに発生します。

Eventオブジェクトには以下の子オブジェクトが付加されています。

説明

connectメソッドやdisconnectメソッドやRFIDリーダの操作により、RFIDリーダの状態が変化したときに発生します。

Eventオブジェクトには以下の子オブジェクトが付加されています。

説明

RFIDリーダのトリガーの押下状態が変化したときに発生します。

Eventオブジェクトには以下の子オブジェクトが付加されています。

説明

startScanBarcodeメソッドでバーコードを読み込んだときに発生します。

Eventオブジェクトには以下の子オブジェクトが付加されています。

バーコードのタイプの種類は以下の通りです。

※1 "ISBT-128"は"CODE-128"(11)として識別されます。

※2 読み取り時、ReadBarcodeイベントが2回発生します。（1回目：上段シンボル、2回目：下段シンボル）

※3 "GS1-128"のスキャン制御は"CODE-128"(11)に依存します。

※4 読み取り時の種類は"PDF417"(25)として識別されます。