OPTICON端末制御モジュールの機能一覧

 

 

Biz/Browser HTと外部サービスを連携する機能「ExternalService」クラスを用いて使用することができるメソッドの一覧です。
通常、ExternalServiceクラスを用いてこれらの機能を呼び出す場合、下記のように利用します。

本機能一覧は、OPTICON端末制御モジュールv1.0.1に対応しています。

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

 

使用例

/* 本端末制御モジュール専用サービスID(本サービスにおいて固定値) */
String SERVICE_ID = "jp.co.opst.biz.util.poweruptool.opticonpoweruptool/.MainService";
/* メソッド名称 */
String METHOD_NAME = "playBuzzer";

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

Button btn2{
	Function OnTouch(e){
		^.sv.invoke(^.METHOD_NAME, 7, 2000);
	}
}

 

目次

 

メソッド名 概要
startScanBarcode バーコードの読み取り処理を行い、読み込んだバーコードのデータおよび種別を返します。
startScanBarcodeContinuous 連続スキャンを開始します。
stopScanBarcode 連続スキャンを終了します。
setNotificationBuzzer 端末の各種通知音の有効・無効を設定します。
getNotificationBuzzer 端末の各種通知音の有効・無効設定を取得します。
setNotificationVibrator 端末の各種通知バイブレータの有効・無効を設定します。
getNotificationVibrator 端末の各種通知バイブレータの有効・無効設定を取得します。
ReadBarcodeイベント 連続スキャンでバーコードを読み取ったときに発生します。

 

startScanBarcodeメソッド

説明

バーコードの読み取り処理を行い、読み込んだバーコードのデータおよび種別を返します。

バーコードの読み取りに成功するかタイムアウト時間が経過するまでスキャンを行います。

スキャンが終了し、このメソッドが結果を返すまで処理は戻りません。

 

呼出形式

extsv.invoke("startScanBarcode", timeoutMs);

 

戻り値

以下の3つの要素を持つ連想配列のArrayオブジェクト

 

integer		type	バーコードの種類
String		data	バーコードのデータの文字列表現
String		rawdata	バーコードのデータの生データ(バイト列)をBase64エンコードした文字列(※)

※Biz/BrowserのBase64Decoderクラスを用いてBase64デコードすることでバイナリデータを復元することができます。
 読み込むバーコードに日本語の文字を含む場合や、バイナリデータを含む場合に使用できます。

 

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

バーコードの種類
1EAN-13(JAN-13) ,UPC-A
2EAN-8(JAN-8)
3UPC-E
4UPC-A
5AZTEC
6郵便カスタマーバーコード
11CODE-128
12CODE-93
13CODE-39
14CODABAR(NW-7)
16MSI
17QR
18GS1 DataBar
22HANXIN
24MaxiCode
25PDF417/2Dタイプ
26Data Matrix
27MICRO_PDF

 

引数

integer timeoutMs

スキャンのタイムアウト時間[msec]。0以下の値を設定するとデフォルトの時間だけ待機します。
デフォルトのタイムアウト時間は7000(7秒)です。なお、60000(60秒)より長くすることはできません。

 

使用例

var res = extsv.Invoke("startScanBarcode", 3000);
//.MessageBox("データ:" + res[0]["data"] + "/種類:" + Str(res[0]["type"]) + "/生データ:" + Base64Decoder.Convert(res[0]["rawdata"]));
	

 

startScanBarcodeContinuousメソッド

説明

連続スキャンを開始します。

バーコードを読み取ると、ExternalServiceオブジェクトからReadBarcodeイベントが発生します。

読み取ったバーコードのデータはReadBarcodeイベントから取得することができます。

連続スキャンを停止する場合は、stopScanBarcodeメソッドを呼び出します。

 

呼出形式

var res = extsv.invoke("startScanBarcodeContinuous", sameInterval);

 

戻り値

なし

 

引数

integer sameInterval

同一バーコードの二度読み防止時間を、100ミリ秒単位で指定します。
1以上を設定すると、同一のバーコードを設定した時間が経過するまで読み取りません。
0を設定すると、同一バーコードは異なるバーコードを読み取るまで読み取りません。

 

使用例

ExternalService exs{
	Function OnReadBarcode(e){
		^.Label1.value = e.type + " : " + e.data ;
	}
}
Button Button51 {
    X = 199;
    Y = 333;
    Width = 80;
    Height = 54;
    Title = "スキャン開始";

    Function OnTouch( e ) {
        var res = ^.exs.Invoke("startScanBarcodeContinuous", 3);
    }
}
		

 

stopScanBarcodeメソッド

説明

連続スキャンを終了します。

 

呼出形式

extsv.invoke("stopScanBarcode");

 

戻り値

なし

 

引数

なし

 

setNotificationBuzzerメソッド

説明

端末の各種通知音の有効・無効を設定します。デフォルトは有効です。

端末制御モジュールを初期化するたびに設定は初期化されます。

 

呼出形式

var res = extsv.invoke("setNotificationBuzzer", type, enabled);

 

戻り値

成功時はtrueを、そうで無い場合はfalseを返します。

 

引数

integer type

通知音の種類を指定します。
1 : スキャン成功時
2 : スキャン失敗時 ※本モジュールでは使用できません。指定した場合はメソッド呼び出しはfalseを返して失敗します。

 

 

boolean enabled

通知音を有効にする(true)/無効にする(false)。

 

 

getNotificationBuzzerメソッド

説明

端末の各種通知音の有効・無効設定を取得します。

 

呼出形式

var res = extsv.invoke("getNotificationBuzzer", type);

 

戻り値

typeに指定した種類の通知音が有効ならtrue、そうでなければfalseを返します。

 

引数

integer type

通知音の種類を指定します。
1 : スキャン成功時
2 : スキャン失敗時 ※本モジュールでは使用できません。指定した場合はメソッド呼び出しはfalseを返して失敗します。

 

 

setNotificationVibratorメソッド

説明

端末の各種通知バイブレータの有効・無効を設定します。デフォルトは有効です。

端末制御モジュールを初期化するたびに設定は初期化されます。

 

呼出形式

var res = extsv.invoke("setNotificationVibrator", type, enabled);

 

戻り値

成功時はtrueを、そうで無い場合はfalseを返します。

 

引数

integer type

通知バイブレータの種類を指定します。
1 : スキャン成功時
2 : スキャン失敗時 ※本モジュールでは使用できません。指定した場合はメソッド呼び出しはfalseを返して失敗します。

 

 

boolean enabled

通知バイブレータを有効にする(true)/無効にする(false)。

 

 

getNotificationVibratorメソッド

説明

端末の各種通知バイブレータの有効・無効設定を取得します。

 

呼出形式

var res = extsv.invoke("getNotificationVibrator", type);

 

戻り値

typeに指定した種類の通知バイブレータが有効ならtrue、そうでなければfalseを返します。

 

引数

integer type

通知バイブレータの種類を指定します。
1 : スキャン成功時
2 : スキャン失敗時 ※本モジュールでは使用できません。指定した場合はメソッド呼び出しはfalseを返して失敗します。

 

 

ReadBarcodeイベント

説明

連続スキャンでバーコードを読み取ったときに発生します。

 

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

名前

説明

String

type

バーコード種別

String

data

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

String

rawadata

バーコードのデータの生データ(バイト列)をBase64エンコードした文字列(※)

※Biz/BrowserのBase64Decoderクラスを用いてBase64デコードすることでバイナリデータを復元することができます。
 読み込むバーコードに日本語の文字を含む場合や、バイナリデータを含む場合に使用できます。