AsReader制御モジュールの機能一覧

 

 

Biz/Browser HTと外部サービスを連携する機能「ExternalService」クラスを用いて使用することができるメソッドの一覧です。
サービスの使い方については、Biz/Browser HTのExternalServiceクラスのリファレンスも参照してください。

※正しく動作させるためには、端末のOSバージョンを最新にする必要があります。

 

本モジュールとリファレンスについて

メーカ

対応機種

サービスID値

バージョン

Biz/Browserの対応バージョン

対応ライブラリ

アスタリスク

ASR-A24D

jp.co.opst.biz.util.extensions.asreader/.MainService

v1.0.1

Biz/Browser HT v1.3.0以上
Biz/Browser SmartDevice v1.6.1以上

AsReader SDK for Android

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

 

使用例

/* モジュール専用サービスID(本サービスにおいて固定値) */
String SERVICE_ID = "jp.co.opst.biz.util.extensions.asreader/.MainService";

ExternalService externalService1{
	Function OnBoundStateChanged(e){
		if(e.state == "Bound"){
			//.Messagebox("サービスと接続しました");
		}
	}
}
Button btn1{
	Function OnTouch(e){
		^.externalService1.bind(^.SERVICE_ID);
	}
}

Button btn2{
	Function OnTouch(e){
		/* スキャン開始 */
		^.externalService1.invoke("startReadBarcode");
	}
}

 

目次

 

メソッド名 概要
startReadBarcode バーコードのスキャンを開始します。
stopReadBarcode バーコードのスキャンを停止します。
isOpened リーダーと接続状態であるかどうかを取得します。
getBattery リーダーのバッテリー情報を取得します。
setReaderSettings リーダーのハードウェア設定を変更します。
setTriggerMode リーダー側面のトリガーの制御方法を変更します。
setDecodeMode トリガーボタンを押したときに行われるスキャンのモードを設定します。
ReadBarcodeイベント バーコードを読み取ったときに発生します。
ConnectStateChangedイベント リーダーとの接続状態が変化したときに発生します。
TriggerChangedイベント トリガーボタンの押下状態が変化したときに発生します。

 

startReadBarcodeメソッド

説明

バーコードのスキャンを開始します。
読み取ったバーコードはReadBarcodeイベントで受け取ることができます。
引数に誤りがある場合や、正常に動作しなかった場合、例外が発生します。

 

引数を指定することによって停止条件がある場合、指定したどちらかの条件を満たした場合にスキャンが停止します。

停止条件がない場合、stopReadBarcodeメソッドを呼び出すか、スキャンの照射がタイムアウトするまでスキャンします。

 

呼出形式

連続スキャン(停止条件なし)

externalService1.invoke("startReadBarcode");

連続スキャン(停止条件あり)

externalService1.invoke("startReadBarcode", int count, int time);

 

戻り値

なし

 

引数

int count

読み取り回数。0〜255で指定します。
0の場合は無設定になり、timeの設定によってスキャンが停止します。
255の場合は無制限になります。それ以外の場合は、指定した回数読み取るとスキャンが停止します。

 

 

int time

読み取り時間。0〜255で指定します。単位は[秒]です。
0の場合は無設定になり、countの設定によってスキャンが停止します。
255の場合は無制限になります。それ以外の場合は、スキャン開始してから指定した時間経過するとスキャンが停止します。
なお、指定した値に関わらず、一定時間バーコードが読み取れなかった場合、スキャンが自動停止します。

 

 

stopReadBarcodeメソッド

説明

バーコードのスキャンを停止します。

 

呼出形式

externalService1.invoke("stopReadBarcode");

 

戻り値

なし

 

引数

なし

 

 

 

isOpenedメソッド

説明

リーダーと接続状態であるかどうかを取得します。

 

呼出形式

externalService1.invoke("isOpened");

 

戻り値

接続中ならtrueを、そうでなければfalseを返します。

 

引数

なし

 

 

getBatteryメソッド

説明

リーダーのバッテリー情報を取得します。

 

呼出形式

var battery = externalService1.invoke("getBattery");

 

戻り値

バッテリー残量値。100%なら100、80%なら80を返します。(例:100)

 

引数

なし

 

 

setReaderSettingsメソッド

説明

リーダーのハードウェア設定を変更します。

 

呼出形式

externalService1.invoke("setReaderSettings", int beep, int vibrate, int led, int aimer);

 

戻り値

なし

 

引数

int beep

読み取り時に音を鳴らす場合はtrue、鳴らさない場合はfalse

 

 

int vibrate

読み取り時に振動する場合はtrue、振動しない場合はfalse

 

 

int led

背面のバッテリー残量を示すLEDを点灯させる場合はtrue、点灯しない場合はfalse

 

 

int aimer

スキャン時にエイマーを照射する場合はtrue、照射しない場合はfalse

 

 

setTriggerModeメソッド

説明

リーダー側面のトリガーの制御方法を変更します。

 

呼出形式

externalService1.invoke("setTriggerMode", int mode);

 

戻り値

なし

 

引数

int mode

トリガーモードを以下から指定します。
これら以外の値を指定すると例外が発生します。

動作

0

オートモード。トリガーボタンを押すとスキャンが実行されます。

1

マニュアルモード。トリガーボタンを押すとスキャンは行われず、代わりにTriggerChangedイベントが発生します。

 

 

setDecodeModeメソッド

説明

トリガーボタンを押したときに行われるスキャンのモードを設定します。

 

呼出形式

externalService1.invoke("setDecodceMode", int mode);

 

戻り値

なし

 

引数

int mode

スキャンモードを以下から指定します。
これら以外の値を指定すると例外が発生します。

動作

0

単発スキャン(1回読み取ると停止)

1

連続スキャン

 

 

ReadBarcodeイベント

説明

バーコードを読み取ったときに発生します。

 

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

名前

説明

int

type

読み取ったバーコードの種類

String

data

読み取ったバーコードのデータ文字列

 

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

バーコードの種類
1EAN-13(JAN-13)、EAN-8(JAN-8)、UPC-E、UPC-A
5AZTEC
6郵便カスタマーバーコード
9ITF(Interleaved Two of Five)
11CODE-128
12CODE-93
13CODE-39
14CODABAR(NW-7)
16MSI
17QR
18GS1 DataBar
23GS1-128
26Data Matrix
27microPDF

 

 

ConnectStateChangedイベント

説明

リーダーとの接続状態が変化したときに発生します。

 

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

名前

説明

int

state

接続中ならtrue、そうでなければfalse

 

 

TriggerChangedイベント

説明

トリガーボタンの押下状態が変化したときに発生します。
このイベントはsetTriggerModeメソッドでトリガーモードがマニュアルに設定されているときのみ発生します。

 

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

名前

説明

int

state

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