端末制御モジュール(IT-G400)の機能一覧

 

 

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

本機能一覧は、端末制御モジュール(IT-G400)バージョン1.3.0 に対応しています。

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

 

使用例

/* 本端末制御モジュール専用サービスID(本サービスにおいて固定値) */
String SERVICE_ID = "jp.co.opst.biz.util.poweruptool.casioITG400poweruptool/.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 端末の各種通知バイブレータの有効・無効設定を取得します。
setSymbologyEnable 指定したバーコードの読取り有効/無効を設定します。
getSymbologyEnable 指定したバーコードの読取り有効/無効を取得します。
setSymbologyMax 指定したバーコードの読取り可能最大桁数を設定します。
getSymbologyMax 指定したバーコードの読取り可能最大桁数を取得します。
setSymbologyMin 指定したバーコードの読取り可能最小桁数を設定します。
getSymbologyMin 指定したバーコードの読取り可能最小桁数を取得します。
setUserDefineKey 端末のハードウェアキーに、別のキーコードを設定します。
getUserDefineKey 端末のハードウェアキーに割り当てられているキーコードを取得します。
setCenterMode バーコードリーダーのセンターモードの有効/無効を指定します。
getCenterMode バーコードリーダーのセンターモードの有効/無効を取得します。
setAreaSize バーコードリーダーのセンターモード時の領域サイズを指定します。
getAreaSize バーコードリーダーのセンターモード時の領域サイズを取得します。
setTriggerKeyEnable トリガーキーの有効/無効を設定します。
getTriggerKeyEnable トリガーキーの有効/無効を取得します。
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
9ITF
10ISBT
11CODE-128
12CODE-93
13CODE-39
14CODABAR(NW-7)
15CODE-32
16MSI
17QR
18GS1 DataBar
20CODABLOCKF
21COMPOSITE
22HANXIN
23GS1-128
24MaxiCode
25PDF417/2Dタイプ
26Data Matrix
27MICRO_PDF

 

引数

integer timeoutMs

スキャンのタイムアウト時間[msec]。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メソッドを呼び出します。

 

呼出形式

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メソッド

説明

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

 

呼出形式

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

 

戻り値

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

 

引数

integer type

通知音の種類を指定します。
1 : スキャン成功時
2 : スキャン失敗時

 

 

boolean enabled

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

 

 

getNotificationBuzzerメソッド

説明

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

 

呼出形式

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

 

戻り値

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

 

引数

integer type

通知音の種類を指定します。
1 : スキャン成功時
2 : スキャン失敗時

 

 

setNotificationVibratorメソッド

説明

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

 

呼出形式

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

 

戻り値

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

 

引数

integer type

通知バイブレータの種類を指定します。
1 : スキャン成功時
2 : スキャン失敗時

 

 

boolean enabled

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

 

 

getNotificationVibratorメソッド

説明

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

 

呼出形式

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

 

戻り値

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

 

引数

integer type

通知バイブレータの種類を指定します。
1 : スキャン成功時
2 : スキャン失敗時

 

 

setSymbologyEnableメソッド

説明

指定したバーコードの読取り有効/無効を設定します。

 

呼出形式

var res = extsv.invoke("setSymbologyEnable", symbologyID, enabled);

 

戻り値

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

 

引数

integer symbologyID

各バーコードのシンボル ID を指定します。
指定できるシンボルIDはstartscanbarcodeを参照してください

 

 

boolean enabled

指定するシンボルの読取を有効にする(true)/無効にする(false)。

 

 

getSymbologyEnableメソッド

説明

指定したバーコードの読取り有効/無効を取得します。

 

呼出形式

var res = extsv.invoke("getSymbologyEnable", symbologyID);

 

戻り値

symbologyIDが有効ならtrue、そうでなければfalseを返します。

 

引数

integer symbologyID

各バーコードのシンボル ID を指定します。
指定できるシンボルIDはstartscanbarcodeを参照してください

 

 

setSymbologyMaxメソッド

説明

指定したバーコードの読取り可能最大桁数を設定します。
設定した桁数より大きいバーコードは読取りません。

 

呼出形式

var res = extsv.invoke("setSymbologyMax", symbologyID, max);

 

戻り値

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

 

引数

integer symbologyID

各バーコードのシンボル ID を指定します。
指定できるシンボルIDはstartscanbarcodeを参照してください

 

 

integer max

読取り可能最大桁数。
指定できる最大桁数はメーカーマニュアルに準じます。

 

 

getSymbologyMaxメソッド

説明

指定したバーコードの読取り可能最大桁数を取得します。

 

呼出形式

var res = extsv.invoke("getSymbologyMax", symbologyID);

 

戻り値

成功時は読取り可能最大桁数を1以上の整数で返します。
失敗時および桁数設定不可能なバーコードを指定した場合は0を返します。

 

引数

integer symbologyID

各バーコードのシンボル ID を指定します。
指定できるシンボルIDはstartscanbarcodeを参照してください

 

 

setSymbologyMinメソッド

説明

指定したバーコードの読取り可能最小桁数を設定します。
設定した桁数より小さいバーコードは読取りません。

 

呼出形式

var res = extsv.invoke("setSymbologyMin", symbologyID, min);

 

戻り値

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

 

引数

integer symbologyID

各バーコードのシンボル ID を指定します。
指定できるシンボルIDはstartscanbarcodeを参照してください

 

 

integer max

読取り可能最小桁数。
指定できる最小桁数はメーカーマニュアルに準じます。

 

 

getSymbologyMinメソッド

説明

指定したバーコードの読取り可能最小桁数を取得します。

 

呼出形式

var res = extsv.invoke("getSymbologyMin", symbologyID);

 

戻り値

成功時は読取り可能最大桁数を1以上の整数で返します。
失敗時および桁数設定不可能なバーコードを指定した場合は0を返します。

 

引数

integer symbologyID

各バーコードのシンボル ID を指定します。
指定できるシンボルIDはstartscanbarcodeを参照してください

 

 

setUserDefineKeyメソッド

説明

端末のハードウェアキーに、別のキーコードを設定します。

 

呼出形式

var res = extsv.invoke("setUserDefineKey", sourceKeyCode, destKeyCode);

 

戻り値

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

 

引数

integer sourceKeyCode

変換元ハードウェアキーのキーコードを指定します。

キーコードはAndroid標準のキーコード(android.view.KeyEventクラス)の値の他、対応していれば独自キーのキーコードを指定することができます。

KeyEventクラスに関する詳細な情報はAndroid Developers(Android開発者向けサイト)のリファレンスマニュアルをご参照ください。

 

対応キー
277右トリガーボタン
278左トリガーボタン

 

 

integer destKeyCode

変換先ハードウェアキーのキーコードを指定します。

キーコードはAndroid標準のキーコード(KeyEventクラス)の値の他、対応していれば独自キーのキーコードを指定することができます。

KeyEventクラスに関する詳細な情報はAndroid Developers(Android開発者向けサイト)のリファレンスマニュアルをご参照ください。

 

なお、引数に0を指定すると各ハードウェアキーのデフォルト設定に戻します。

 

 

 

getUserDefineKeyメソッド

説明

端末のハードウェアキーに割り当てられているキーコードを取得します。

 

呼出形式

var res = extsv.invoke("getUserDefineKey", sourceKeyCode);

 

戻り値

成功の場合、割り当てられている変換先ハードウェアキーのキーコードを返します。
キーコードについては、setUserDefineKeyメソッドのsourceKeyCode引数で使用可能な値を参照してください。
失敗の場合、-1を返します。

 

引数

integer sourceKeyCode

変換元ハードウェアキーのキーコードを指定します。
setUserDefineKeyで使用可能な値を参照してください。

 

 

setCenterModeメソッド

説明

バーコードリーダーのセンターモードの有効/無効を指定します。

 

呼出形式

var res = extsv.invoke("setCenterMode", enable);

 

戻り値

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

 

引数

boolean enable

センターモードを使用する(true)/使用しない(false)。

 

 

getCenterModeメソッド

説明

バーコードリーダーのセンターモードの有効/無効を取得します。

 

呼出形式

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

 

戻り値

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

 

 

setAreaSizeメソッド

説明

バーコードリーダーのセンターモード時の領域サイズを指定します。

 

呼出形式

var res = extsv.invoke("setAreaSize", size);

 

戻り値

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

 

引数

int size

読取領域のサイズを 0~10で指定。(0はクロスポイントのみ)

 

 

getAreaSizeメソッド

説明

バーコードリーダーのセンターモード時の領域サイズを取得します。

 

呼出形式

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

 

戻り値

成功時は領域サイズを0(クロスポイント)~10(領域全体)を整数で返します。
失敗時や未サポート時は-1を返します。

 

 

setTriggerKeyEnableメソッド

説明

トリガーキーの有効/無効を設定します。

 

呼出形式

var res = extsv.invoke("setTriggerKeyEnable", enable);

 

戻り値

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

 

引数

boolean enable

トリガーキーを使用する(true)/使用しない(false)。

 

 

getTriggerKeyEnableメソッド

説明

トリガーキーの有効/無効を取得します。

 

呼出形式

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

 

戻り値

トリガーキーが有効ならtrue、そうでなければfalseを返します。

 

引数

なし

 

 

ReadBarcodeイベント

説明

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

 

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

名前

説明

String

type

バーコード種別

String

data

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

String

rawadata

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

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