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

 

 

Biz/Browser HTと外部サービスを連携する機能「ExternalService」クラスを用いて使用することができるメソッドの一覧です。
本項では、RFIDリーダ制御モジュールで使用可能な機能を説明します。
サービスの使い方については、Biz/Browser HTのExternalServiceクラスのリファレンスも参照してください。

 

対応機種とモジュール

メーカ

対応機種

値

略称と対応モジュール

Keyence

DX-RH1(DXシリーズ用RFIDユニット)

jp.co.opst.biz.util.rfid.keyence/.MainService

Keyence、Keyence版

※掲載されている会社名や製品名は、一般に各社の商標または登録商標です。

 

本APIリファレンスのバージョン

モジュール

バージョン

Biz/Browserの対応バージョン

Keyence版

v1.0.0

v1.2.8

v1.1.0

v1.4.4

 

 

【注意事項】

DX-A600/DX-A400について、アプリ「DuraSpeed(※)」が有効になっている場合、以下の動作不具合を起こすことが判明しています。

※DuraSpeedとは、バックグラウンドアプリを制限することで、フォアグラウンドアプリを高速化するアプリケーションです。

 

・下記条件時に端末制御モジュールのサービスプロセスがDuraSpeedによって強制終了される。

　端末制御モジュールがBindされていない状態で端末をスリープ状態にし、5分以上経過した場合。

 

・下記条件時にBiz/Browser HTから端末制御モジュールへのBindが失敗する。

　- 手動でアプリ情報の「強制停止」によって端末制御モジュールのプロセスを強制終了した場合

　- 端末制御モジュールのプロセスが強制終了した場合(DuraSpeedにより強制終了された場合も含む)

　- 端末制御モジュールを上書きインストールした場合

 

端末制御モジュールを使用する際は、同梱のTaskKillerDisableアプリも同時に使用してください。

 

TaskKillerDisableアプリのインストール・使用方法

目次

 

メソッド名 概要
connect RFIDリーダと接続します。
disconnect RFIDリーダとの接続を切断します。
inventoryTag インベントリ（スキャンを開始してRFタグのEPCを収集）を行います。
stopAccessTag スキャンを停止します。
startReadTag タグの読み取りを行います。インベントリと異なり、タグの任意の領域にアクセスしてデータを受け取ります。
setTagAccessOnce 同一のタグ（UII）を一度だけ読むようにするかどうかを設定します。
isTagAccessOnce 同一のタグ（UII）を一度だけ読むようにするかどうかを取得します。
setMask タグの読み取りマスクを設定します。
clearMask タグの読み取りマスクを消去します。
setTagDecode 読み取ったタグをReadTagイベントで通知する際に、タグのデータをデコードするかどうかを設定します。
setRadioChannel 出力電波のチャンネルを設定します。
getRadioChannel 出力電波のチャンネルを取得します。
setRadioPower 出力電波の強度を設定します。
getRadioPower 出力電波の強度を取得します。
setBuzzerVolume 読み取り時などのブザー音の音量を設定します。
getBuzzerVolume 読み取り時などのブザー音の音量を取得します。
setSessionFlag タグへのアクセス時のセッションフラグを設定します。
getSessionFlag タグへのアクセス時のセッションフラグを取得します。
writeSingleTag UIIを指定して1枚のタグの任意の領域に書き込みを行います。
lockSingleTag UIIを指定して1枚のタグの任意の領域をロックまたはアンロックします。
killSingleTag UIIを指定して1枚のタグをキルします。
setSingleRead 単発読みを有効にするかどうかを設定します。
isSingleRead 単発読みを有効にするかどうかを取得します。
setScanKeyOutput 単発読みで読み取ったタグをキーボード入力として与えるかどうかを設定します。
isScanKeyOutput 単発読みで読み取ったタグをキーボード入力として与えるかどうかを取得します。
getVersion 本モジュールのバージョンを取得します。
getBatteryLevel バッテリー残量を取得します。
intrinsic.connect RFIDリーダと接続します。本機能はconnectメソッドと同じ動作です。
setTriggerMode RFIDリーダのトリガーを押したときの動作を指定します。
ReadTagイベント inventoryTagメソッドやstartReadTagメソッドでタグを読み取ったときに発生します。
DeviceStateChangedイベント connectやdisconnectやRFIDリーダの操作により、RFIDリーダの状態が変化したときに発生します。

 

connectメソッド

説明

RFIDリーダと接続します。
モジュールの初期化および接続のための準備を行います。

※RFIDリーダのペアリング等のハードウェア側の操作については、メーカードキュメントをご参照ください。

 

呼出形式

externalService1.invoke("connect");

 

戻り値

なし

 

引数

なし

 

 

disconnectメソッド

説明

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

 

呼出形式

externalService1.invoke("disconnect");

 

戻り値

なし

 

引数

なし

 

 

inventoryTagメソッド

説明

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

 

呼出形式

externalService1.invoke("inventoryTag");

 

戻り値

なし

 

引数

なし

 

 

stopAccessTagメソッド

説明

スキャンを停止します。

 

呼出形式

externalService1.invoke("stopAccessTag");

 

戻り値

なし

 

引数

なし

 

 

startReadTagメソッド

説明

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

 

呼出形式

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

 

戻り値

なし

 

引数

integer memoryType

 

読み取るメモリ領域

値

説明

0

RESERVED領域

1

EPC領域

2

TID領域

3

USER領域

 

integer wordOffset

 

アクセス対象のオフセット位置（ワード単位。1ワードは2バイト）

 

integer wordCount

 

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

 

String password

 

タグに設定されているアクセスパスワード。省略時は0です。

 

 

setTagAccessOnceメソッド

説明

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

 

呼出形式

externalService1.invoke("setTagAccessOnce", once);

 

戻り値

なし

 

引数

boolean once

 

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

 

 

isTagAccessOnceメソッド

説明

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

 

呼出形式

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

 

戻り値

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

 

引数

なし

 

 

setMaskメソッド

説明

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

 

呼出形式

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

 

戻り値

なし

 

引数

integer memoryType

 

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

値

説明

1

EPC領域

2

TID領域

3

USER領域

 

integer maskOffset

 

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

 

integer maskBits

 

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

 

String maskPattern

 

マスクパターン。16進数文字列で指定。

 

 

clearMaskメソッド

説明

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

 

呼出形式

externalService1.invoke("clearMask");

 

戻り値

なし

 

引数

なし

 

 

setTagDecodeメソッド

説明

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

デコードする場合は、タグのデータをSGTIN96等にデコードし、ReadTagイベントで取得できる値にその結果情報を追加で付与します。

 

呼出形式

externalService1.invoke("setTagDecode", enabled);

 

戻り値

なし

 

引数

boolean enabled

 

デコードするかどうか。trueならする、falseならしない。デフォルトはfalseです。

 

 

setRadioChannelメソッド

説明

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

 

呼出形式

externalService1.invoke("setRadioChannel", channels);

 

戻り値

なし

 

引数

integer channels

 

以下の値の組み合わせで、使用するチャンネルを指定します。
※日本の電波法に基づいて適切な値を使用するようご注意ください。

値

説明

0x00000001

Ch5

0x00000002

Ch11

0x00000004

Ch17

0x00000008

Ch23

0x00000010

Ch24

0x00000020

Ch25

 

 

 

getRadioChannelメソッド

説明

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

 

呼出形式

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

 

戻り値

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

値

説明

0x00000001

Ch5

0x00000002

Ch11

0x00000004

Ch17

0x00000008

Ch23

0x00000010

Ch24

0x00000020

Ch25

 

引数

なし

 

 

setRadioPowerメソッド

説明

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

 

呼出形式

externalService1.invoke("setRadioPower", power);

 

戻り値

なし

 

引数

integer power

 

出力電波強度 [dBm] 0～30
※日本の電波法に基づいて適切な値を使用するようご注意ください。
※DX-RH1では、実際には5未満は無効で、設定できません。

 

 

getRadioPowerメソッド

説明

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

 

呼出形式

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

 

戻り値

出力電波強度 [dBm]

 

引数

なし

 

 

setBuzzerVolumeメソッド

説明

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

 

Android端末のサイレントモードが有効の時にこのメソッドを呼び出すと、例外が発生します。

 

呼出形式

externalService1.invoke("setBuzzerVolume", val);

 

戻り値

なし

 

引数

integer val

 

ブザー音量 [%]　通常、0～100の範囲で設定します。
※getBuzzerVolumeメソッドで取得したとき、設定値と異なる値が戻る場合があります。

 

 

getBuzzerVolumeメソッド

説明

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

 

呼出形式

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

 

戻り値

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

 

引数

なし

 

 

setSessionFlagメソッド

説明

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

 

呼出形式

externalService1.invoke("setSessionFlag", session);

 

戻り値

なし

 

引数

integer session

 

セッションフラグを、以下の値のいずれかで指定します。

値

説明

0

S0を指定。一度アクセスしたタグにすぐに再アクセス可能。

1

S1を指定。一度アクセスしたタグに一定時間後に再アクセス可能。

2

S2を指定。一度アクセスしたタグは電波が届かなくなってから一定時間後に再アクセス可能。

3

S3を指定。動作はS2と同じ。

 

 

getSessionFlagメソッド

説明

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

 

呼出形式

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

 

戻り値

セッションフラグを返します。

値

説明

0

S0を指定。一度アクセスしたタグにすぐに再アクセス可能。

1

S1を指定。一度アクセスしたタグに一定時間後に再アクセス可能。

2

S2を指定。一度アクセスしたタグは電波が届かなくなってから一定時間後に再アクセス可能。

3

S3を指定。動作はS2と同じ。

 

引数

なし

 

 

writeSingleTagメソッド

説明

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

 

呼出形式

externalService1.invoke("writeSingleTag", memoryType, wordOffset, words, uii [, password]);

 

戻り値

なし

 

引数

integer memoryType

 

書き込み先のメモリ領域

値

説明

0

RESERVED領域

1

EPC領域

2

TID領域

3

USER領域

 

integer wordOffset

 

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

 

integer words

 

タグに書き込むデータ（ワード単位の長さ）

 

String uii

 

書き込むタグのUII

 

String password

 

タグに設定されているアクセスパスワード。16進数文字列で指定します。省略時は0です。

 

 

lockSingleTagメソッド

説明

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

 

呼出形式

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

 

戻り値

なし

 

引数

integer target

 

操作対象。1種類のみ指定できます。

値

説明

0x01

キルパスワード

0x02

アクセスパスワード

0x10

EPC領域

0x20

TID領域

0x40

USER領域

 

integer type

 

操作内容

値

説明

0

アンロック

1

ロック

2

永久アンロック

3

永久ロック

 

String uii

 

操作するタグのUII

 

String password

 

タグに設定されているアクセスパスワード。16進数文字列で指定します。省略時は0です。

 

 

killSingleTagメソッド

説明

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

 

呼出形式

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

 

戻り値

なし

 

引数

integer uii

 

 

integer password

操作するタグのUII

 

 

タグに設定されているキルパスワード。16進数文字列で指定します。省略時は0です。

 

 

 

setSingleReadメソッド

説明

トリガーボタンの押下時に、タグの単発読み取りをするかどうかを設定します。

 

呼出形式

externalService1.invoke("setSingleRead", enabled);

 

戻り値

なし

 

引数

boolean enabled

 

タグの単発読み取りをするかどうか

 

 

isSingleReadメソッド

説明

トリガーボタンの押下時に、タグの単発読み取りをするかどうかを取得します。

 

呼出形式

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

 

戻り値

単発読み取りをするかどうかの設定値を返します。

 

引数

なし

 

 

setScanKeyOutputメソッド

説明

単発読みで読み取ったタグをキーボード入力として与えるかどうかを設定します。

 

呼出形式

externalService1.invoke("setScanKeyOutput", enabled);

 

戻り値

なし

 

引数

boolean enabled

 

読み取ったタグをキーボード入力として与えるかどうか

 

 

isScanKeyOutputメソッド

説明

単発読みで読み取ったタグをキーボード入力として与えるかどうかを取得します。

 

呼出形式

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

 

戻り値

読み取ったタグをキーボード入力として与えるかどうかの設定値を返します。

 

引数

なし

 

 

getVersionメソッド

説明

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

 

呼出形式

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

 

戻り値

バージョン番号＋リビジョン番号が文字列で返ります。

 

引数

なし

 

 

getBatteryLevelメソッド

説明

バッテリー残量を取得します。

 

呼出形式

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

 

戻り値

バッテリー残量 [%]

 

引数

なし

 

 

setTriggerModeメソッド

説明

RFIDリーダのトリガーボタンを押したときの動作を指定します。

この設定はinventoryTagメソッドまたはstartReadTagメソッドを実行している間だけ有効です。

 

呼出形式

externalService1.invoke("setTriggerMode", mode);

 

戻り値

なし

 

引数

integer mode

 

動作内容を指定します。デフォルトは機器の現在の設定が適用されます。

値

説明

1

押している間だけトリガーON

2

押すたびにトリガーONとOFFを切り替え

3

常にトリガーON

 

 

ReadTagイベント

説明

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

 

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

型

名前

説明

String

epc

タグのUII

Number

rssi

タグアクセス時のRSSI値 [dBm]

String

data

startReadTagメソッドによって読み取った場合、読み取ったタグの領域のデータ

String

detail

デコードしたデータの連想配列（setTagDecodeメソッドで取得するように指定した場合）

※SGTIN96の場合は、["header"]=>EPCヘッダ部分, ["indicator"]=>インジケータ(GTIN-14), ["jan"]=>JANコード, ["serial"]=>シリアルNo

 

 

DeviceStateChangedイベント

説明

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

 

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

型

名前

説明

String

state

接続状態
Finding … 接続待機状態
Connected … 接続状態
Disconnected … 切断状態