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

 

 

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

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

 

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

メーカ

対応機種

サービスID値

バージョン

Biz/Browserの対応バージョン

CipherLab

RK25
RK25J
RS35
RS36

jp.co.opst.biz.util.poweruptool.cipherlabpoweruptool/.MainService

v1.1.0

v1.2.0以上

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

 

使用例

/* 本端末制御モジュール専用サービスID（本サービスにおいて固定値） */
String SERVICE_ID = "jp.co.opst.biz.util.poweruptool.cipherlabpoweruptool/.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 連続スキャンを開始します。
startScanBarcodeCollection 累積読み取りまたは一括読み取りで複数のバーコードを読み取り、読み込んだバーコードのデータおよび種別を返します。
stopScanBarcode 連続スキャンを終了します。
setNotificationBuzzer 端末の各種通知音の有効・無効を設定します。
getNotificationBuzzer 端末の各種通知音の有効・無効設定を取得します。
setNotificationVibrator 端末の各種通知バイブレータの有効・無効を設定します。
getNotificationVibrator 端末の各種通知バイブレータの有効・無効設定を取得します。
setBarcodeEnabled 指定したバーコードを読み取り対象にするかどうかを指定します。
isBarcodeEnabled 指定したバーコードが読み取り対象かどうかを取得します。
ReadBarcodeイベント 連続スキャンでバーコードを読み取ったときに発生します。

 

startScanBarcodeメソッド

説明

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

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

モジュールの初期化時に読み取るコード種別は端末の現在の設定が用いられます。読み取るコード種別を個別に変更する場合は、setBarcodeEnabledメソッドをご利用ください。

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

※制限事項：スキャン中はHID機能が無効になります。

 

呼出形式

var res = extsv.invoke("startScanBarcode", timeoutMs);

 

戻り値

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

 

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

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

 

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

値バーコードの種類
1EAN-13(JAN-13)
2EAN-8(JAN-8)
3UPC-E
4UPC-A
5AZTEC
6郵便カスタマーバーコード
9ITF(InterLeaved 2 Of 5)
10ISBT
11CODE-128
12CODE-93
13CODE-39
14CODABAR(NW-7)
15CODE-32
16MSI/Plessey
17QRコード
18GS1 DataBar
21GS1 Composite CC-A/B/C
23GS1-128
24MaxiCode
25PDF417
26Data Matrix
27MicroPDF

 

引数

integer timeoutMs

スキャンのタイムアウト時間[msec]。500ミリ秒未満を指定した場合は500ミリ秒がタイムアウト時間となります。
0以下の値を設定するとデフォルトの時間だけ待機します。デフォルトのタイムアウト時間は7秒です。

 

使用例

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

 

startScanBarcodeContinuousメソッド

説明

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

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

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

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

※制限事項：スキャン中にレーザーが点滅する場合があります。

※制限事項：スキャン中はHID機能が無効になります。

 

呼出形式

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 ) {
        ^.exs.Invoke("startScanBarcodeContinuous", 3);
    }
}

 

startScanBarcodeCollectionメソッド

説明

累積収集、もしくは一括収集で複数のバーコードを読み取り、読み込んだバーコードのデータおよび種別を返します。

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

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

 

引数:methodで指定した値が1(累積読み)の場合

規定の個数のバーコードを読み取ると、読み取ったバーコードをすべて戻り値に返却します。

規定の個数のバーコードを読み取れずにタイムアウトした場合も、それまでに読み取ったバーコードを返却します。

 

引数:methodで指定した値が2(一括読み)の場合

規定の個数のバーコードを読み取ると、読み取ったバーコードをすべて戻り値に返却します。

規定の個数のバーコードを読み取れずにタイムアウトした場合、nullを返却します。

 

呼出形式

var res = extsv.invoke("startScanBarcodeCollection", method, codeCount, timeoutMs);

 

戻り値

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

 

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

 

引数

integer method

収集方法を指定します。以下の値を指定します。範囲外の値を指定した場合は例外が発生します。

値説明
1累積収集
2一括収集

 

 

integer codeCount

収集するバーコードの数を指定します。範囲外の値を指定した場合は例外が発生します。

収集方法設定値の範囲
累積収集1〜10
一括収集1〜10

 

 

integer timeoutMs

スキャンのタイムアウト時間[msec]。0以下の値を設定するとデフォルトの時間だけ待機します。
デフォルトのタイムアウト時間は7秒です。

 

使用例

 
var res = extsv.invoke("startScanBarcodeCollection", 1, 3, 3000);
for (var i = 0; i < res.length; i++) {
	//.MessageBox("データ:" + res[i]["data"] + "/種類:" + Str(res[i]["type"]) + "/生データ:" + Base64Decoder.Convert(res[i]["rawdata"]));
}

 

stopScanBarcodeメソッド

説明

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

※制限事項：連続スキャンの終了は最大で500ミリ秒かかります。

 

呼出形式

extsv.invoke("stopScanBarcode");

 

戻り値

なし

 

引数

なし

 

setNotificationBuzzerメソッド

説明

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

 

呼出形式

extsv.invoke("setNotificationBuzzer", type, enabled);

 

戻り値

なし

 

引数

integer type

通知音の種類。現在は1(スキャン成功時)のみ指定できます。

 

 

boolean enabled

通知音を有効にするかどうか。

 

 

getNotificationBuzzerメソッド

説明

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

 

呼出形式

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

 

戻り値

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

 

引数

integer type

通知音の種類。現在は1(スキャン成功時)のみ指定できます。

 

 

setNotificationVibratorメソッド

説明

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

 

呼出形式

extsv.invoke("setNotificationVibrator", type, enabled);

 

戻り値

なし

 

引数

integer type

通知バイブレータの種類。現在は1(スキャン成功時)のみ指定できます。

 

 

boolean enabled

通知バイブレータを有効にするかどうか。

 

 

getNotificationVibratorメソッド

説明

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

 

呼出形式

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

 

戻り値

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

 

引数

integer type

通知バイブレータの種類。現在は1(スキャン成功時)のみ指定できます。

 

 

setBarcodeEnabledメソッド

説明

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

設定に失敗した場合は例外が発生します。

 

呼出形式

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

 

戻り値

なし

 

引数

integer type

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

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

値バーコードの種類
1EAN-13(JAN-13)
2EAN-8(JAN-8)
3UPC-E
4UPC-A
5AZTEC
6郵便カスタマーバーコード
9ITF(InterLeaved 2 Of 5)
10ISBT
11CODE-128
12CODE-93
13CODE-39
14CODABAR(NW-7)
15CODE-32(※1)
16MSI/Plessey
17QRコード
18GS1 DataBar
21GS1 Composite CC-A/B/C
23GS1-128
24MaxiCode
25PDF417
26Data Matrix
27MicroPDF

※1 CODE-39とCODE-32どちらか一方を有効にすると、もう一方が読み取り無効になります。

 

 

boolean enabled

読み取りを行う場合はtrueを、読み取りを行わない場合はfalseを指定します。

 

isBarcodeEnabledメソッド

説明

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

取得に失敗した場合は例外が発生します。

 

呼出形式

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

 

戻り値

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

 

引数

integer type

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

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

値バーコードの種類
1EAN-13(JAN-13)
2EAN-8(JAN-8)
3UPC-E
4UPC-A
5AZTEC
6郵便カスタマーバーコード
9ITF(InterLeaved 2 Of 5)
10ISBT
11CODE-128
12CODE-93
13CODE-39
14CODABAR(NW-7)
15CODE-32
16MSI/Plessey
17QRコード
18GS1 DataBar
21GS1 Composite CC-A/B/C
23GS1-128
24MaxiCode
25PDF417
26Data Matrix
27MicroPDF

 

ReadBarcodeイベント

説明

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

 

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

型

名前

説明

integer

type

バーコード種別

String

data

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

String

rawdata

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

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