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

 

 

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

 

対応機種とモジュール

メーカ

対応機種

値

略称と対応モジュール

東芝テック

UF-2200シリーズ

UF-3000シリーズ

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

TEC、TEC版

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

 

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

モジュール

バージョン

Biz/Browserの対応バージョン

TEC版

v1.0.6まで

v1.2.6

v1.1.0

v1.4.4

 

 

【注意事項】

Android 14以上の端末でRFIDリーダと接続する場合、以下のいずれかの操作を行う必要があります。（初回のみ）

 

◯操作手順1

1. Android OS設定＞アプリ＞すべてのアプリ＞RFID Extension Tec＞権限 の画面を開く

2. 「位置情報」を「常に許可」に設定する

 

◯操作手順2

1. connectメソッドによる接続要求時、権限を尋ねるポップアップが表示される

2. 位置情報の権限リクエスト時のポップアップメッセージに従い、設定画面を開く

3. 「位置情報」を「常に許可」に設定する

 

※BLE機器と接続するためには位置情報の権限を「常に許可」にする必要があります。

　位置情報の権限はBLE機器との接続を行う目的で使用します。制御モジュールがお客様の位置情報を取得・保存・送信することはありません。

※connectメソッドの呼び出し時に表示される権限を尋ねるポップアップ上で操作する場合、「常に許可」が選択肢に現れないため表示内容に従って設定画面を開く必要があります。

　Android OSバージョンが14未満のとき、「常に許可」が選択肢に現れることがあります。その場合は「常に許可」を選択することで接続可能です。

※Android OSの制約により、権限を尋ねるポップアップで各権限を複数回拒否すると、権限を尋ねるポップアップの表示が抑制されてしまい接続に失敗し続けることがあります。

　このような場合、制御モジュールを一旦アンインストールしてからインストールするか、または設定画面での直接許可を試行してください。

 

目次

 

メソッド名 概要
connect RFIDリーダと接続します。ペアリング済みのリーダを自動的に検出して接続します。
disconnect RFIDリーダとの接続を切断します。
inventoryTag インベントリ（スキャンを開始してRFタグのEPCを収集）を行います。
stopAccessTag inventoryTagメソッド、startReadTagメソッドで開始したスキャンを停止します。
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 バッテリー残量を取得します。
startRadar RFタグのEPCを指定してタグの位置探索を行います。
stopRadar 探索を停止します。
startRadarSGTIN RFタグのJANを指定してタグの位置探索を行います。
startScanBarcode バーコードスキャンを開始します。
stopScanBarcode バーコード読み取りを停止します。
setTriggerMode RFIDリーダのトリガーを押したときの動作を指定します。
setTriggerMonitoring RFIDリーダのトリガーの状態を監視し、TriggerChangedイベントを発生させるかどうかを設定します。
setDecodeTagEPC タグEPC読み取り時に、EPCを標準コードなどにデコードするかどうか、その方法を指定します。
setPolarization 偏波設定を設定します。
getPolarization 偏波設定を取得します。
ReadTagイベント inventoryTagメソッドやstartReadTagメソッドでタグを読み取ったときに発生します。
DeviceStateChangedイベント connectメソッドやdisconnectメソッドやRFIDリーダの操作により、RFIDリーダの状態が変化したときに発生します。
TriggerChangedイベント RFIDリーダのトリガーの押下状態が変化したときに発生します。
EPCLockedイベント startRadarSGTINメソッド実行時、探索対象となるEPCが確定した時に発生します。
PositionMoveイベント 遠距離モード時、startRadarメソッドでタグを探索したときに発生します。
RssiEventイベント 近距離モード時、startRadarメソッドでタグを探索したときに発生します。
ReadBarcodeイベント startScanBarcodeメソッドでバーコードを読み込んだときに発生します。
ログ出力機能 ログ設定ファイルを配置することでログの有無やSDKのログオプションを指定することができます。

 

connectメソッド

説明

RFIDリーダと接続します。ペアリング済みのリーダを自動的に検出して接続します。

 

UF-2200シリーズ

Bluetooth SPPで接続します。予めAndroid端末とRFIDリーダをペアリングしておく必要があります。

 

UF-3000シリーズ

BLEで接続します。ペアリングは不要ですが、connectメソッドに指定する引数によって条件があります。

　- connectメソッドの引数でMACアドレスを指定する場合、予めペアリングが必要です。

　- connectメソッドにデバイス名を指定する場合は事前のペアリングが必要です。

 

※connectメソッドの実行後、ハードウェア側の接続完了の前にDeviceStateChangedイベントが発生することがありますのでご注意ください。

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

 

呼出形式

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

 

戻り値

なし

 

引数

String deviceName

 

ペアリング済みRFIDリーダデバイスの名称、もしくはBluetoothアドレス（MACアドレス）
デバイス名称は、正規表現を使用することができます。

 

 

Integer deviceType

 

接続する機種を指定します。省略時は0です。

設定できる値と対応する機種は次の通りです。

値

機種

0

 UF-2200シリーズ

1

 UF-3000シリーズ

 

 

disconnectメソッド

説明

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

 

呼出形式

externalService1.invoke("disconnect");

 

戻り値

なし

 

引数

なし

 

 

inventoryTagメソッド

説明

インベントリ（スキャンを開始してRFタグのEPCを収集）を行います。
読み取ったタグはReadTagイベントで受け取れます。

 

※RFタグ読み取り中(startReadTagメソッド実行時)は実行できません。stopAccessTagメソッドでスキャンを停止した状態で実行してください。

※バーコード読み取り中(startScanBarcodeメソッド実行時)は実行できません。stopScanBarcodeメソッドでスキャンを停止した状態で実行してください。

※探索実行中(startRadarメソッド、startRadarSGTINメソッド実行時)は実行できません。stopRadarメソッドで探索を停止した状態で実行してください。

 

呼出形式

externalService1.invoke("inventoryTag" [, timeout ]);

 

戻り値

なし

 

引数

integer timeout

 

タグ読み取りのタイムアウト時間をミリ秒単位で指定します。

6,000ミリ秒（6秒）から600,000ミリ秒（10分）の範囲か、-1（読み込みが完了するまで無限に待つ）を指定できます。デフォルトは-1です。

1回のタグ読み取りの時間がタイムアウト時間を超えると、その時点での読み取り結果は破棄され、次のタグ読み込みを開始します。
※v1.0.5で追加

 

 

stopAccessTagメソッド

説明

inventoryTagメソッドとstartReadTagメソッドで開始したスキャンを停止します。

 

v1.0.5以降のバージョンでは、inventoryTagメソッド呼び出し後にstopAccessTagメソッドを呼び出すと、現在の読み込み処理が完了するまで制御を戻しません。

 

呼出形式

externalService1.invoke("stopAccessTag");

 

戻り値

なし

 

引数

なし

 

 

startReadTagメソッド

説明

タグの読み取りを行います。インベントリと異なり、タグの任意の領域にアクセスしてデータを受け取ります。
読み取ったタグはReadTagイベントで受け取れます。

 

※RFタグ読み取り中(inventoryTagメソッド実行時)は実行できません。stopAccessTagメソッドでスキャンを停止した状態で実行してください。

※バーコード読み取り中(startScanBarcodeメソッド実行時)は実行できません。stopScanBarcodeメソッドでスキャンを停止した状態で実行してください。

※探索実行中(startRadarメソッド、startRadarSGTINメソッド実行時)は実行できません。stopRadarメソッドで探索を停止した状態で実行してください。

 

呼出形式

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

 

戻り値

なし

 

引数

integer memoryType

 

読み取るメモリ領域
※ USER領域とEPC領域のみ指定可能です。

値

説明

1

EPC領域

3

USER領域

 

integer wordOffset

 

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

 

integer wordCount

 

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

 

Integer password

 

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

 

 

setTagAccessOnceメソッド

説明

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

 

呼出形式

externalService1.invoke("setTagAccessOnce", once);

 

戻り値

なし

 

引数

boolean once

 

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

 

 

isTagAccessOnceメソッド

説明

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

 

呼出形式

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

 

戻り値

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

 

引数

なし

 

 

clearAccessTagListメソッド

説明

スキャンしたタグの内部のリストをクリアします。同一タグの読み取りの判定に用います。

 

呼出形式

externalService1.invoke("clearAccessTagList");

 

戻り値

なし

 

引数

なし

 

 

setMaskメソッド

説明

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

 

呼出形式

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

 

戻り値

なし

 

引数

integer memoryType

 

マスクの対象とするメモリ領域
※　USER領域とEPC領域のみ指定可能です。

値

説明

1

EPC領域

2

TID領域

3

USER領域

 

integer maskOffset

 

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

 

integer maskBits

 

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

 

String maskPattern

 

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

 

 

clearMaskメソッド

説明

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

 

呼出形式

externalService1.invoke("clearMask");

 

戻り値

なし

 

引数

なし

 

 

setTagDecodeメソッド

説明

読み取ったタグを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);

 

戻り値

なし

 

引数

number power

 

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

モジュール

設定可能範囲

TEC版

0～30

dBm(設定値)

mW[参考](送信出力)

出力レベル[参考](UF-2200/3000SDKにおける出力レベル)

0

1

0近似

1

1.26

1近似

2

1.58

2近似

3

2

3近似

4

2.51

3~4

5

3.16

4~5

6

3.98

5~6

7

5.01

6~7

8

6.31

7近似

9

7.94

8近似

10

10

9近似

11

12.6

10近似

12

15.8

11近似

13

20

12近似

14

25.1

13近似

15

31.6

13~14

16

39.8

14~15

17

50.1

15~16

18

63.1

16~17

19

79.4

17~18

20

100

18近似

21

126

19近似

22

158

20近似

23

200

21~22

24

251

22~23

25

316

23~24

26

398

25近似

27

501

26近似

28

631

27~28

29

794

29~30

30

1000

31近似

 

 

getRadioPowerメソッド

説明

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

 

呼出形式

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

 

戻り値

出力電波強度 [dBm]

※小数点以下の値も含めて取得されます。

 

引数

なし

 

 

setQValueメソッド

説明

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

 

呼出形式

externalService1.invoke("setQValue", val);

 

戻り値

なし

 

引数

integer val

 

Q値 (2のn乗[枚])

モジュール

設定可能範囲

TEC版

0～15

 

 

getQValueメソッド

説明

Q値を取得します。

 

呼出形式

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

 

戻り値

Q値 (2のn乗[枚])

 

引数

なし

 

 

setBuzzerVolumeメソッド

説明

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

 

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

 

呼出形式

externalService1.invoke("setBuzzerVolume", val);

 

戻り値

なし

 

引数

integer val

 

ブザー音量 [%]　通常、0～100の範囲で設定します。
※実際に設定される音量はRFID機器によって異なります。
※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

 

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

 

String words

 

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

 

String uii

 

書き込むタグのUII

 

Integer password

 

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

 

 

lockSingleTagメソッド

説明

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

 

呼出形式

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

 

戻り値

なし

 

引数

integer target

 

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

値

説明

0x01

キルパスワード

0x02

アクセスパスワード

0x10

EPC領域

0x20

TID領域

0x40

USER領域

 

integer type

 

操作内容

値

説明

0

アンロック

1

ロック

2

永久アンロック

3

永久ロック

 

String uii

 

操作するタグのUII

 

Integer password

 

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

 

 

killSingleTagメソッド

説明

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

 

呼出形式

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

 

戻り値

なし

 

引数

String uii

 

 

integer password

操作するタグのUII

 

 

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

 

 

 

getVersionメソッド

説明

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

 

呼出形式

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

 

戻り値

バージョン番号

戻り値

バージョン

1

v1.0.0

 

引数

なし

 

 

getBatteryLevelメソッド

説明

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

 

呼出形式

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

 

戻り値

バッテリー残量 [%]

 

引数

なし

 

 

startRadarメソッド

説明

RFタグのEPCを指定してタグの位置探索を行います。

本メソッドを実行すると、まず遠距離モードでタグの方角と電波比率で位置を推定し、

タグの応答電波が安定してくると近距離モードに移行し応答電波を観測し続けます。

 

遠距離モード時は、タグの位置をPositionMoveイベントで受け取ることができます。

近距離モード時は、タグの応答電波をRssiEventイベントで受け取ることができます。

 

※RFタグ読み取り中(inventoryTagメソッド実行時)は実行できません。stopAccessTagメソッドでスキャンを停止した状態で実行してください。

※バーコード読み取り中(startScanBarcodeメソッド実行時)は実行できません。stopScanBarcodeメソッドでスキャンを停止した状態で実行してください。

 

呼出形式

externalService1.invoke("startRadar",epcode,handyPower,findPower,vol);

 

戻り値

なし

 

引数

String epcode

探索するタグのEPC

 

 

integer handyPower

探索を開始する電波強度

 

 

integer findPower

探索を終了する電波強度

 

 

integer vol

探索音の音量(0～1)

 

 

stopRadarメソッド

説明

探索を停止します。

 

呼出形式

externalService1.invoke("stopRadar");

 

戻り値

なし

 

引数

なし

 

 

startRadarSGTINメソッド

説明

RFタグのJANを指定してタグの位置探索を行います。
本メソッドを実行すると、引数に指定したJANコードに一致するEPCを探索します。
一致するタグが見つかった場合は、EPCLockedイベントが発生し、ターゲットとなったEPCを受け取ることができます。
一致するタグが見つかった後は、遠距離モードに移行して探索処理を行います。（その際に、他のタグはヒットしなくなります。）
その後、遠距離モードでタグの方角と電波比率で位置を推定し、タグの応答電波が安定してくると近距離モードに移行し応答電波を観測し続けます。
遠距離モード時は、タグの位置をPositionMoveイベントで受け取ることができます。
近距離モード時は、タグの応答電波をRssiEventイベントで受け取ることができます。

 

※RFタグ読み取り中(inventoryTagメソッド実行時)は実行できません。stopAccessTagメソッドでスキャンを停止した状態で実行してください。

※バーコード読み取り中(startScanBarcodeメソッド実行時)は実行できません。stopScanBarcodeメソッドでスキャンを停止した状態で実行してください。

 

呼出形式

externalService1.invoke("startRadarSGTIN",jancode , handyPower , findPower,vol [,exclusionEpc , filterType] );

 

戻り値

なし

 

引数

String jancode

探索するタグのJANコード

 

 

integer handyPower

探索を開始する電波強度

 

 

integer findPower

探索を終了する電波強度

 

 

integer vol

探索音の音量(0～1)

 

 

String exclusionEpc

対象外とするEPCコード。カンマ区切りで複数指定も可能。指定しない場合は空にします。

 

 

integer filterType

SGTIN96タグの探索時、タグのfilter値を1から書き換えます。0～7までの値が使用可能です。通常、商品に付属するタグは1という値が設定されているため省略可能なことが多いです。

 

 

 

startScanBarcodeメソッド

説明

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

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

 

※RFタグ読み取り中(inventoryTagメソッド実行時)は実行できません。stopAccessTagメソッドでスキャンを停止した状態で実行してください。

※バーコード読み取り中(startScanBarcodeメソッド実行時)は実行できません。stopScanBarcodeメソッドでスキャンを停止した状態で実行してください。

 

呼出形式

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

 

戻り値

なし

 

引数

integer sameInterval

 

 

boolean oneshot

同じバーコードを読み取らない時間（100ミリ秒単位）。0なら無制限に読み取らない。デフォルト0です。

 

 

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

 

 

 

stopScanBarcodeメソッド

説明

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

 

呼出形式

externalService1.invoke("stopScanBarcode");

 

戻り値

なし

 

引数

なし

 

 

setTriggerModeメソッド

説明

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

 

呼出形式

externalService1.invoke("setTriggerMode", mode [, type]);

 

戻り値

なし

 

引数

integer mode

 

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

値

説明

1

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

2

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

3

常にトリガーON

 

 

integer type

 

設定を行う対象の操作を指定します。デフォルトは0です。
※v1.0.5で追加

値

説明

0

RFIDスキャン時

1

バーコードスキャン時

 

 

setTriggerMonitoringメソッド

説明

RFIDリーダのトリガーの状態を監視し、TriggerChangedイベントを発生させるかどうかを設定します。
トリガー監視がOFFになっているとき、読み取り速度が向上することがありますがTriggerChangedイベントが発生しなくなります。

 

呼出形式

externalService1.invoke("setTriggerMonitoring", enabled);

 

戻り値

なし

 

引数

boolean enabled

 

トリガーの監視のON/OFFを指定します。
trueのとき監視ON、そうでなければOFFにします。デフォルトはOFFです。
※デフォルトでトリガー監視はOFFになっています。

 

 

setDecodeTagEPCメソッド

説明

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

 

呼出形式

externalService1.invoke("setDecodeTagEPC", type);

 

戻り値

なし

 

引数

integer type

 

変換方法を指定します。

値

説明

0x0000

無効(デフォルト)

0xF001

ASCII文字に変換　※変換できない場合'X'

 

 

setPolarizationメソッド

説明

偏波設定を設定します。

 

呼出形式

externalService1.invoke("setPolarization", polarization);

 

戻り値

なし

 

引数

integer polarization

 

偏波設定を指定します。

値

説明

0

両方

1

垂直

2

水平

 

 

getPolarizationメソッド

説明

偏波設定を取得します。

 

呼出形式

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

 

戻り値

偏波設定を取得します。

値

説明

0

両方

1

垂直

2

水平

 

引数

なし

 

 

ReadTagイベント

説明

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

 

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

型

名前

説明

String

epc

タグのUII

Number

rssi

タグアクセス時のRSSI値 [dBm]
※小数点以下の値も含めて取得されます。

String

data

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

String

decodedata

setDecodeTagEPCメソッドでASCII変換を指定した場合に出力

String

detail

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

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

 

 

DeviceStateChangedイベント

説明

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

 

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

型

名前

説明

String

state

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

 

 

TriggerChangedイベント

説明

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

 

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

型

名前

説明

Number

pressed

押下状態。押下中ならtrue、そうでなければfalse

 

 

EPCLockedイベント

説明

startRadarSGTINメソッド実行時、探索対象となるEPCが確定した時に発生します。

 

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

型

名前

説明

String

epc

探索対象となったタグのEPC

 

 

PositionMoveイベント

説明

遠距離モード時、startRadarメソッド、startRadarSGTINメソッドでタグを探索したときに発生します。

 

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

型

名前

説明

Number

angle

タグの絶対位置角度(deg)

Number

power

応答電波比率(0～1)

Number

realangle

タグを感知する実角度(deg)

 

 

RssiEventイベント

説明

近距離モード時、startRadarメソッド、startRadarSGTINメソッドでタグを探索したときに発生します。

 

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

型

名前

説明

Number

rssi

タグの応答電波の強さ。-1なら未検出、0(弱)～15(強)なら検出。

 

 

ReadBarcodeイベント

説明

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

 

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

型

名前

説明

integer

type

バーコードの種類

String

data

バーコードのデータの文字列表現

String

rawdata

バーコードのデータの生データ（バイト列）をBase64エンコードした文字列

 

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

値バーコードの種類
1EAN-13(JAN-13)
2EAN-8(JAN-8)
3UPC-E
4UPC-A
8Industrial 2 of 5 (Standard 2 of 5)
9ITF(Interleaved 2 of 5)
11CODE-128
12CODE-93
13CODE-39
14CODABAR(NW-7)
17QR
18GS1 DataBar
21GS1 Composite
25PDF417
26Data Matrix

 

 

ログ出力機能

このモジュールでは、ログ設定ファイルを配置することでログの有無やSDKのログオプションを指定することができます。

制御モジュールはconnectメソッドで設定ファイルを読み込みログの出力を開始します。

disconnectメソッドでログの出力を停止します。

 

ログ設定ファイル、ログファイルのパスは次の通りです。

ファイル

パス

ログ設定ファイル

(端末内蔵ディレクトリ)/Android/data/jp.co.opst.biz.util.rfid.tec/files/Documents/RFIDExtensionTECUF.ini

制御モジュールのログファイル

(端末内蔵ディレクトリ)/Android/data/jp.co.opst.biz.util.rfid.tec/files/Documents/log/log_yyyyMMdd_HHmmss_SSS.log
※ファイル名はログ出力開始時の時刻となります(例:log_202100720_130711_345.log)

 

設定ファイルの内容は次の通りです。設定ファイルで指定されていない項目や設定ファイルがない場合は、デフォルトとして扱います。

設定

説明

デフォルト

RfidExtensionLog

制御モジュールのログファイル出力の有無
true:出力する false:出力しない
数字で指定する場合、0以外はtrueと解釈します

true
※v1.0.3までのデフォルトはfalse

LogFileCountMax

制御モジュールのログファイルの保存数
1より小さい値は1として扱います

指定値を超えるログファイルは、ログ出力開始時に削除されます

20

SdkLogLevel

SDKのOption "LogLevel"の設定値
0-3の数字を指定します。範囲を超える値は、範囲内に丸められます

2

SdkLogOutput

SDKのOption "LogOutput"の設定値
0-2の数字を指定します。範囲を超える値は、範囲内に丸められます

1

 

設定ファイルの例

RfidExtensionLog:true
LogFileCountMax:5
SdkLogLevel:1
SdkLogOutput:1