Opticon H-35端末制御モジュールの機能一覧

 

 

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

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

 

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

メーカ

対応機種

サービスID値

バージョン

Biz/Browserの対応バージョン

オプトエレクトロニクス

H-35

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

v1.0.0

v1.3.5以上

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

 

使用例

/* 本端末制御モジュール専用サービスID（本サービスにおいて固定値） */
String SERVICE_ID = "jp.co.opst.biz.util.poweruptool.opticonH35poweruptool/.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 端末の各種通知バイブレータの有効・無効設定を取得します。
loadSettingsFile 設定ファイルを読み込んで設定をロードします。
saveSettingsFile 現在の設定を設定ファイルにセーブします。
setReadMode 読取モードを設定します。
getReadMode 読取モードを取得します。
setIllumination 読み取り時の照明を設定します。
getIllumination 読み取り時の照明を取得します。
setAimerMode 読み取り時のエイマーを設定します。
getAimerMode 読み取り時のエイマーを取得します。
setBarcodeEnabled 指定したバーコードを読み取り対象にするかどうかを指定します。
isBarcodeEnabled 指定したバーコードが読み取り対象かどうかを取得します。
setScanKeyOutput キーボード出力を行うかどうかを設定します。
getScanKeyOutput キーボード出力を行うかどうかの設定値を取得します。
setTriggerKeyEnable トリガーキーの有効/無効を設定します。
getTriggerKeyEnable トリガーキーの有効/無効を取得します。
setCharsetEncoding スキャン結果データのエンコードを設定します。
getCharsetEncoding スキャン結果データのエンコードを取得します。
ReadBarcodeイベント 連続スキャンでバーコードを読み取ったときに発生します。

 

startScanBarcodeメソッド

説明

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

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

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

 

呼出形式

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)
11CODE-128
12CODE-93
13CODE-39
14CODABAR(NW-7)
16MSI/Plessey
17QR
18GS1 DataBar
20codablockF
24Maxicode
25PDF417/2Dタイプ
26Data Matrix
27MicroPDF
29industrial 2 of 5

 

引数

integer timeoutMs

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

 

使用例

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

 

startScanBarcodeContinuousメソッド

説明

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

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

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

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

 

呼出形式

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);
    }
}

 

stopScanBarcodeメソッド

説明

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

 

呼出形式

extsv.invoke("stopScanBarcode");

 

戻り値

なし

 

引数

なし

 

setNotificationBuzzerメソッド

説明

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

 

呼出形式

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

 

戻り値

なし

 

引数

integer type

通知音の種類。下記の値を指定できます。それ以外を指定したときは例外が発生します。

値説明
1スキャン成功時
2スキャンタイムアウト時（startScanBarcodeメソッド実行中のみ）

 

 

boolean enabled

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

 

 

getNotificationBuzzerメソッド

説明

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

 

呼出形式

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

 

戻り値

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

 

引数

integer type

通知音の種類。下記の値を指定できます。それ以外を指定したときは例外が発生します。

値説明
1スキャン成功時
2スキャンタイムアウト時（startScanBarcodeメソッド実行中のみ）

 

 

setNotificationVibratorメソッド

説明

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

 

呼出形式

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

 

戻り値

なし

 

引数

integer type

通知音の種類。下記の値を指定できます。それ以外を指定したときは例外が発生します。

値説明
1スキャン成功時
2スキャンタイムアウト時（startScanBarcodeメソッド実行中のみ）

 

 

boolean enabled

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

 

 

getNotificationVibratorメソッド

説明

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

 

呼出形式

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

 

戻り値

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

 

引数

integer type

通知音の種類。下記の値を指定できます。それ以外を指定したときは例外が発生します。

値説明
1スキャン成功時
2スキャンタイムアウト時（startScanBarcodeメソッド実行中のみ）

 

 

loadSettingsFileメソッド

説明

設定ファイルを読み込んで設定をロードします。
スキャン設定を保存した設定ファイル（JSON）を読み込んで、現在の設定値へ反映します。
スキャン設定を保存する方法はsaveSettingsFileメソッドを参照してください。

なお、外部アプリケーションなどによって同一フォーマットによって保存された設定ファイルもロードすることができます。
本メソッドでロードされる設定は、本制御モジュールで設定可能なスキャン設定以外の設定も対象となります。

 

呼出形式

extsv.invoke("loadSettingsFile", path);

 

戻り値

なし

 

引数

String path

ロードするファイルパス名を指定します。（例：settings.json）
/Android/data/jp.co.opst.biz.util.poweruptool.opticonH35poweruptool/files/Documents/settingsディレクトリ配下のパスを指定します。

 

 

saveSettingsFileメソッド

説明

現在の設定を設定ファイルに保存します。
スキャン設定をロードする方法はloadSettingsFileメソッドを参照してください。

本メソッドで保存される設定は、本制御モジュールで設定可能なスキャン設定以外の設定も対象となります。

 

呼出形式

extsv.invoke("saveSettingsFile", path);

 

戻り値

なし

 

引数

String path

保存するファイルパス名を指定します。（例：settings.json）
/Android/data/jp.co.opst.biz.util.poweruptool.opticonH35poweruptool/files/Documents/settingsディレクトリ配下のパスを指定します。

 

 

setReadModeメソッド

説明

トリガーモードを設定します。

 

呼出形式

extsv.invoke("setReadMode", mode);

 

戻り値

なし

 

引数

integer mode

トリガーモードの種類。下記の値を指定できます。それ以外を指定したときは例外が発生します。

値説明
0単発スキャン
バーコードを1件だけ読み取ります。読み取り後、スキャンを自動停止します。
1連続スキャン（重複許可）
バーコードを連続で読み取ります。スキャン中、同じバーコードを読むことができます。
2連続スキャン（重複禁止）
バーコードを連続で読み取ります。スキャン中、同じバーコードは再び読むことができません。

 

 

getReadModeメソッド

説明

トリガーモードを取得します。

 

呼出形式

var res = extsv.invoke("getReadMode");

 

戻り値

トリガーモードの種類。下記の値が戻ります。

値説明
0単発スキャン
バーコードを1件だけ読み取ります。読み取り後、スキャンを自動停止します。
1連続スキャン（重複許可）
バーコードを連続で読み取ります。スキャン中、同じバーコードを読むことができます。
2連続スキャン（重複禁止）
バーコードを連続で読み取ります。スキャン中、同じバーコードは再び読むことができません。

 

引数

なし

 

 

 

setIlluminationメソッド

説明

読み取り時の照明を設定します。
照明とは、スキャン時に照射される白色の光で、この光の照射方法を切り替えることができます。

 

呼出形式

extsv.invoke("setIllumination", mode);

 

戻り値

なし

 

引数

integer mode

照射設定。以下から値を指定します。それ以外を指定したときは例外が発生します。

 

値種類
0常時点灯
1常時消灯
2自動切り替え（点灯と消灯を繰り替えす）
3鏡面反射防止（鏡面反射を判定したら消灯し、それ以外は点灯）

 

 

getIlluminationメソッド

説明

読み取り時の照明を取得します。
機能に関しては、setIlluminationメソッドを参照してください。

 

呼出形式

var res = extsv.invoke("getIllumination");

 

戻り値

以下の値が返却されます。

 

値種類
0常時点灯
1常時消灯
2自動切り替え（点灯と消灯を繰り替えす）
3鏡面反射防止（鏡面反射を判定したら消灯し、それ以外は点灯）

 

引数

なし

 

setAimerModeメソッド

説明

読み取り時のエイマーを設定します。
エイマーとは、スキャン中に照射される十字の赤いレーザーを指します。

 

呼出形式

extsv.invoke("setAimerMode", mode);

 

戻り値

なし

 

引数

boolean mode

エイマーを表示するならtrue、そうでなければfalseを指定します。

 

getAimerModeメソッド

説明

読み取り時のエイマーを取得します。
機能に関しては、setAimerModeメソッドを参照してください。

 

呼出形式

var res = extsv.invoke("getAimerMode");

 

戻り値

エイマーを表示するならtrue、そうでなければfalseが返ります。

 

引数

なし

 

setBarcodeEnabledメソッド

説明

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

 

呼出形式

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

 

戻り値

成功した場合はtrueを、失敗した場合はfalseを返します。

 

引数

integer type

設定を行うバーコードの種類を指定します。それ以外を指定したときは例外が発生します。

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

値バーコードの種類
1EAN-13(JAN-13)
2EAN-8(JAN-8)
3UPC-E
4UPC-A
5AZTEC
6郵便カスタマーバーコード
9ITF(Interleaved 2 of 5)
11CODE-128
12CODE-93
13CODE-39
14CODABAR(NW-7)
16MSI/Plessey
17QR
18GS1 DataBar
20codablockF
24Maxicode
25PDF417/2Dタイプ
26Data Matrix
27MicroPDF
29industrial 2 of 5

 

 

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)
11CODE-128
12CODE-93
13CODE-39
14CODABAR(NW-7)
16MSI/Plessey
17QR
18GS1 DataBar
20codablockF
24Maxicode
25PDF417/2Dタイプ
26Data Matrix
27MicroPDF
29industrial 2 of 5

 

setScanKeyOutputメソッド

説明

スキャン読み取りした結果のキーボード出力を行うかどうかを設定します。

 

呼出形式

extsv.invoke("setScanKeyOutput", enabled);

 

戻り値

なし

 

引数

boolean enabled

有効にする場合はtrue、無効にする場合はfalseを指定します。

 

 

getScanKeyOutputメソッド

説明

スキャン読み取り結果のキーボード出力を行うかどうかを取得します。

 

呼出形式

var res = extsv.invoke("getScanKeyOutput");

 

戻り値

有効ならtrue、無効ならfalseが返ります。

 

引数

なし

 

 

 

 

setTriggerKeyEnableメソッド

説明

トリガーキーの有効/無効を設定します。
トリガーキーが有効である場合、トリガーボタンを押している間スキャンが行なえます。
トリガーボタンを押したことによってバーコードを読み取った場合、ReadBarcodeイベントが発生します。

 

呼出形式

extsv.invoke("setTriggerKeyEnable", enabled);

 

戻り値

なし

 

引数

boolean enabled

トリガーによる読み取りを有効にする場合はtrue、無効にする場合はfalseを指定します。

 

getTriggerKeyEnableメソッド

説明

トリガーキーの有効/無効を取得します。
機能に関しては、setTriggerKeyEnableメソッドを参照してください。

 

呼出形式

var res = extsv.invoke("getTriggerKeyEnable");

 

戻り値

トリガーによる読み取りが有効である場合はtrue、そうでなければfalseが返ります。

 

引数

なし

 

setCharsetEncodingメソッド

説明

スキャン結果データのエンコードを設定します。
各種読み取りで取得したバーコードデータの文字列表現について、読み取ったデータを規定の文字エンコード設定でエンコードします。
データと設定のエンコードが異なるとき、文字化けすることがあります。

 

呼出形式

extsv.invoke("setCharsetEncoding", charset);

 

戻り値

なし

 

引数

String charset

エンコード設定。以下から値を指定します。大文字小文字は区別しません。また、記号の一部など表記揺れにも対応します。
それ以外を指定したときは例外が発生します。

 

値種類
ISO-8859-1、latin1、cp1252のいずれかCP1252
SHIFT_JIS、SHIFTJIS、SHIFT-JISのいずれかSHIFT_JIS
GB18030、GBKのいずれかGB18030
UTF8、UTF-8、UTF_8のいずれかUTF-8
Big5Big5

 

 

getCharsetEncodingメソッド

説明

スキャン結果データのエンコードを取得します。
機能に関しては、setCharsetEncodingメソッドを参照してください。

 

呼出形式

var res = extsv.invoke("getCharsetEncoding");

 

戻り値

現在の設定値に応じて、「ISO-8859-1」「Shift_JIS」「GB18030」「UTF-8」「Big5」のいずれかが文字列で返ります。

 

引数

なし

 

ReadBarcodeイベント

説明

トリガーボタン押下による読み取り、またはstartScanBarcodeContinuousメソッドによる連続スキャンでバーコードを読み取ったときに発生します。

 

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

型

名前

説明

String

type

バーコード種別

String

data

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

String

rawdata

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

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