KEYENCE DX-A600端末制御モジュールの機能一覧

説明

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

読み取るバーコード種別などのスキャン設定は、端末制御モジュール初期化のたびに端末デフォルト値に戻ります。

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

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

呼出形式

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

戻り値

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

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

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

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

    ※ 以下のバーコードはバーコード種別が異なる形で検知します。

      ・ GS1-128 は、 11（ CODE-128 ）で検知します。

      ・ ISBT は、 11（ CODE-128 ）で検知します。

      ・ Micro PDF は、 25（ PDF417 ）で検知します。

引数

integer timeoutMs

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

使用例

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

説明

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

読み取るバーコード種別などのスキャン設定は、端末制御モジュール初期化のたびに端末デフォルト値に戻ります。

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

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

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

呼出形式

extsv.invoke("startScanBarcodeContinuous", sameInterval);

戻り値

なし

引数

integer sameInterval

同一バーコードの二度読み防止時間を、100ミリ秒単位で指定します。0〜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);
    }
}
		

説明

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

呼出形式

extsv.invoke("stopScanBarcode");

戻り値

なし

引数

なし

説明

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

呼出形式

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

戻り値

なし

引数

integer type

通知音の種類。下記の値を指定できます。

boolean enabled

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

説明

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

呼出形式

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

戻り値

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

引数

integer type

通知音の種類。下記の値を指定できます。

説明

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

呼出形式

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

戻り値

なし

引数

integer type

通知バイブレータの種類。下記の値を指定できます。

boolean enabled

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

説明

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

呼出形式

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

戻り値

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

引数

integer type

通知バイブレータの種類。下記の値を指定できます。

説明

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

呼出形式

extsv.invoke("setScanTriggerMode", mode);

戻り値

なし

引数

integer mode

トリガーモードの種類。下記の値を指定できます。

説明

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

呼出形式

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

戻り値

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

引数

なし

説明

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

呼出形式

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

戻り値

成功すると0。そうでなければ-1が返ります。

引数

boolean enabled

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

説明

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

呼出形式

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

戻り値

有効なら1、無効なら0が返ります。

引数

なし

説明

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

呼出形式

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

戻り値

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

引数

integer type

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

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

※EAN-13、EAN-8、UPC-A、UPC-Eの設定は共通となります。

boolean enabled

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

説明

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

呼出形式

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

戻り値

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

引数

integer type

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

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

※EAN-13、EAN-8、UPC-A、UPC-Eの設定は共通となります。

説明

スキャン結果データのエンコードを設定します。

呼出形式

var res = extsv.invoke("setCharsetEncoding", charset);

戻り値

正常なら0、そうでなければ(引数に指定した文字コード名称が間違っている場合など)0以外を返します。

引数

string charset

以下の４つが指定可能です。ハイフン（-）やアンダーバー（_）、および大文字小文字は区別しません。

説明

スキャン結果データのエンコードを取得します。

呼出形式

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

戻り値

正常なら下記いずれかの文字コード名称を返します。

引数

なし

説明

読取日付範囲を設定します。

呼出形式

var res = extsv.invoke("setOCRDateRange", yearStart, monthStart, dayStart, yearEnd, monthEnd, dayEnd);

戻り値

成功すると0が返ります。

引数

integer yearStart

開始年(2000-2199)

integer monthStart

開始月(1-12)

integer dayStart

開始日(1-31)

integer yearEnd

終了年(2000-2199)

integer monthEnd

終了月(1-12)

integer dayEnd

終了日(1-31)

説明

読取日付範囲を取得します。

呼出形式

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

戻り値

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

integer		yearStart	読み取り開始年
integer		monthStart	読み取り開始月
integer		dayStart	読み取り開始日
integer		yearEnd		読み取り終了年
integer		monthEnd	読み取り終了月
integer		dayEnd		読み取り終了日

引数

なし

説明

和暦認識の設定を行います。

呼出形式

var res = extsv.invoke("setOCRReadEra", valid1, firstYear1, rangeMin1, rangeMax1, valid2, firstYear2, rangeMin2, rangeMax2);

戻り値

成功すると0が返ります。

引数

boolean valid1

和暦1を有効にするかどうか。

integer firstYear1

和暦1の元年(1989-2039)

integer rangeMin1

和暦1として認識する最小年(1-99)

integer rangeMax1

和暦1として認識する最大年(1-99)

boolean valid2

和暦2を有効にするかどうか。

和暦2のみを有効にすることはできません。

integer firstYear2

和暦2の元年(1989-2039)

integer rangeMin2

和暦2として認識する最小年(1-99)

integer rangeMax2

和暦2として認識する最大年(1-99)

説明

和暦認識の設定を取得します。

呼出形式

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

戻り値

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

boolean		valid1		和暦1を有効にするかどうか
integer		firstYear1	和暦1の元年
integer		rangeMin1	和暦1として認識する最小年
integer		rangeMax1	和暦1として認識する最大年
boolean		valid2		和暦2を有効にするかどうか
integer		firstYear2	和暦2の元年
integer		rangeMin2	和暦2として認識する最小年
integer		rangeMax2	和暦2として認識する最大年

引数

なし

説明

上中下の漢字を置き換える日にちを設定します。

例えばreplaceBに10を指定すると、「2020.2上」を「2020年2月10日」として認識します。

上中下を置き換える場合、日付の区切り文字は「.」(ピリオド)である必要があります。また、setOCRReadDateSettingsメソッドで「日にちあり」または「日にちあり/無し」を指定する必要があります。

呼出形式

ver res = extsv.invoke("setOCRKanjiBME", enable, replaceB, replaceM, replaceE);

戻り値

成功すると0が返ります。

引数

boolean enable

上中下の置換を行うかどうか。

integer replaceB

上を置き換える日にち(1-31）

integer replaceM

中を置き換える日にち(1-31)

integer replaceE

下を置き換える日にち(1-31)

説明

上中下の漢字を置き換える日にちを取得します。

呼出形式

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

戻り値

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

boolean		enable		上中下の置換を行うかどうか
integer		replaceB	上を置き換える日にち
integer		replaceM	中を置き換える日にち
integer		replaceE	下を置き換える日にち

引数

なし

説明

一回のスキャンで同時に読み取る文字列数を設定します。

呼出形式

var res = extsv.invoke("setOCRSubStringCount", count);

戻り値

成功すると0が返ります。

引数

integer count

同時に読み取る文字列の数(1-4)

説明

同時に読み取る文字数を取得します。

呼出形式

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

戻り値

同時に読み取る文字列の数

引数

なし

説明

複数の文字列を読み取る際の文字列の並びを設定します。

呼出形式

var res = extsv.invoke("setOCRMultiSubStringArrangement", arrangement);

戻り値

成功すると0が返ります。

引数

integer arrangement

文字列の並びを指定します。以下の値を指定します。

説明

複数の文字列を読み取る際の文字列の並びを取得します。

呼出形式

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

戻り値

文字列の並びが返ります。以下の値が返ります。

引数

なし

説明

OCR認識パターンを切り替えます。

substringで指定するインデックス値は、複数の文字列を検出した場合の文字列の順番に対応します。

呼出形式

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

戻り値

成功すると0が返ります。

引数

integer substring

パターンを切り替える文字列のインデックス値(0-3)

integer type

認識のパターン。以下の値を指定します。

説明

OCR認識パターンを取得します。

substringで指定するインデックス値は、複数の文字列を検出した場合の文字列の順番に対応します。

呼出形式

var res = extsv.invoke("getOCRPattern", substring);

戻り値

認識のパターン。以下の値が返ります。

引数

integer substring

パターンを取得する文字列のインデックス値(0-3)

説明

検出する日付の順番、英字表記の月の読み取りについての設定を行います。

呼出形式

var res = extsv.invoke("setOCRDateFormat", order, alphabet);

戻り値

成功すると0が返ります。

引数

integer order

日付形式。以下の値を指定します。

integer alphabet

英字表記の月を読み取るかどうかを指定します。以下の値を指定します。

説明

検出する日付の順番、英字表記の月の読み取り設定を取得します。

呼出形式

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

戻り値

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

integer		order		日付形式(1:YMD形式、2:DMY形式、4:MDY形式)
integer		alphabet	英字表記の月の読取(0:読み取らない、1:大文字、小文字を読み取る、2:大文字のみ読み取る)

引数

なし

説明

日付形式の設定を行います。

呼出形式

var res = extsv.invoke("setOCRReadDateSettings", digit, dayExist, oneDisit, delimiter);

戻り値

成功すると0が返ります。

引数

integer digit

年表記の桁数。以下の値を指定します。

integer dayExist

日にちの有無を指定します。以下の値をしてします。

boolean oneDisit

1桁の月日を有効にするかどうかを指定します。trueを指定すると、月日が1桁の日付を検出します。

integer delimiter

日付のセパレータとして判定する文字の種類を指定します。以下の値の組み合わせとなります。

説明

日付形式の設定を取得します。

呼出形式

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

戻り値

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

integer		digit		年表記の桁数(2:4桁のみ 3:2桁or4桁)
integer		dayExist	日にちの有無(1:日にちありのみ 2:日にち無しのみ 3:日にちあり/無し)
boolean		oneDisit	1桁の月日を有効にするかどうか(false:無効 true:有効)
integer		delimiter	日付のセパレータとして判定する文字の種類。次の数の組み合わせとなります(1:スラッシュ 2:ピリオド 4:ハイフン 8:スペース 16:年月 32:なし 63:すべて)

引数

なし

説明

文字列の読み取りフォーマットを設定します。

呼出形式

var res = extsv.invoke("setOCRStringFormat", format);

戻り値

成功すると0が返ります。

引数

String format

文字列認識のフォーマット(最大1024文字)

フォーマットの詳細については、DX-A600シリーズのアプリケーション開発ガイドをご参照ください。

説明

文字列の読み取り形式を取得します。

呼出形式

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

戻り値

文字列認識のフォーマット

引数

なし

説明

文字列の出力フォーマットを設定します。

呼出形式

var res = extsv.invoke("setOCRStringOutput", removeMarks, removeSpaces, trimmingWordLists);

戻り値

成功すると0が返ります。

引数

boolean removeMarks

出力文字列から記号を取り除くかどうか

boolean removeSpaces

出力文字列からスペースを取り除くかどうか

String trimmingWordLists

指定文字よりも右の文字を出力します。

複数の文字を指定する場合はカンマで区切ります。(例 "/,#,No")

説明

文字列の出力フォーマットを取得します。

呼出形式

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

戻り値

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

boolean		removeMarks		出力文字列から記号を取り除くかどうか
boolean		removeSpaces		出力文字列からスペースを取り除くかどうか
String		trimmingWordLists	trimmingWordListsで指定された文字列より右の文字を出力する

引数

なし

説明

日付の出力フォーマットを設定します。

呼出形式

var res = extsv.invoke("setOCRDateOutput", order, delimiter);

戻り値

成功すると0が返ります。

引数

integer order

年月日の並びを指定します。下記の値を指定します。

integer delimiter

セパレータの種類

説明

日付のフォーマット設定を取得します。

呼出形式

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

戻り値

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

integer		order		年月日の並び(1:YYYYMMDD、2:YYYYMM、3:YYMMDD、4:YYMM、5:MMDDYYYY、6:MMYYYY、7:MMDDYY、8:MMYY、9:DDMMYYYY、10:DDMMYY)
integer		delimiter	セパレータの種類(0:なし 1:スラッシュ「/」 2: ピリオド「.」 4: ハイフン「-」 8: スペース「 」)

引数

なし

説明

複数の文字列を読み取った出力結果のフォーマットを設定します。

呼出形式

var res = extsv.invoke("setOCRMultiTargetOutput", delimiterEnabled, delimiter);

戻り値

成功すると0が返ります。

引数

boolean delimiterEnabled

複数の文字列を検出した際に、結果の文字列をセパレータで接続して出力するかどうか

String delimiter

セパレータの文字

説明

複数の文字列を読み取った出力結果のフォーマットを取得します。

呼出形式

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

戻り値

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

boolean		delimiterEnabled	文字列を結合する際にセパレータを有効にするかどうか
String		delimiter		セパレータの文字

引数

なし

説明

文字検出の認識レベルを設定します。

呼出形式

var res = extsv.invoke("setOCRConditionLevel", successAlert, alertFailure);

戻り値

成功すると0が返ります。

引数

integer successAlert

成功とアラートの閾値(0-2)

integer alertFailure

失敗とアラートの閾値(0-4)

説明

文字検出の認識レベルを取得します。

呼出形式

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

戻り値

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

integer		successAlert	成功とアラートの閾値
integer		alertFailure	失敗とアラートの閾値

引数

なし

説明

文字列が回転しているかどうかを設定します。

呼出形式

var res = extsv.invoke("setOCRDetectionRotation", stringRotation);

戻り値

成功すると0が返ります。

引数

integer stringRotation

文字列の回転。以下の値を指定します。

説明

文字列が回転しているかどうかの設定を取得します。

呼出形式

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

戻り値

文字列の回転の設定。以下の値が返ります。

引数

なし

説明

背景のムラなど、文字列が読みづらい場合の設定を行います。

呼出形式

var res = extsv.invoke("setOCRDetectionValidation", irregularLevel, heightValidation, charactersCrossingOverLines);

戻り値

成功すると0が返ります。

引数

integer irregularLevel

背景のムラ。以下の値を指定します。

boolean heightValidation

高さにばらつきがある文字列かどうか。trueを指定すると、高さにばらつきがある文字列を検出します。

boolean charactersCrossingOverLines

枠線をまたぐ文字列かどうか。trueを指定すると、枠線をまたぐ文字列を検出します。

説明

背景のムラなど、文字列が読みづらい場合の設定を取得します。

呼出形式

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

戻り値

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

integer		irregularLevel			背景のムラ(1:ムラなし 2:ムラが薄い 3:ムラが濃い)
boolean		heightValidation		高さにばらつきがある文字列を検出するかどうか
boolean		charactersCrossingOverLines	枠線をまたぐ文字列を検出するかどうか

引数

なし

説明

近接した文字列の検出に関する設定を行います。

呼出形式

var res = extsv.invoke("setOCRDetectionContacting", marginAtTopOrBottom, verticallyContacting, horizontallyContacting);

戻り値

成功すると0が返ります。

引数

boolean marginAtTopOrBottom

文字列の上下にマージンがあるかどうか。falseを指定すると、上下にマージンがなくても文字列として検出します。

boolean verticallyContacting

文字が上下に接触している文字列かどうか。trueを指定すると、文字が上下に接触している場合でも別々の文字として検出します。

boolean horizontallyContacting

文字が左右に接触している文字列かどうか。trueを指定すると、文字が左右に接触している場合でも別々の文字として検出します。

説明

近接した文字列の検出に関する設定を取得します。

呼出形式

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

戻り値

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

boolean		marginAtTopOrBottom		文字列の上下にマージンがあるかどうか
boolean		verticallyContacting		文字が上下に接触している文字列かどうか
boolean		horizontallyContacting		文字が左右に接触している文字列かどうか

引数

なし

説明

OCRとバーコードの読取の組み合わせを設定します。デフォルトは端末のデフォルト値に準じます。

本メソッドは各バーコード読み取り許可をするコード種別をそれぞれ一括で変更します。

コード種別を個別に変更する場合は、setBarcodeEnabledメソッドをご利用ください。

呼出形式

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

戻り値

成功すると0が返ります。

引数

integer type

読取の組み合わせ。以下の値を指定します。

説明

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

また、端末のトリガーボタンを押してスキャンして読み取ったときも発生します。

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