KEYENCE端末制御モジュール(互換IF版)の機能一覧

 

 

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

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

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

 

使用例

if(!$DESIGNTIME){
	if(!ExternalObject.IsLibraryIdUsed("sampleLib")){
		ExternalObject.LoadJar("sampleLib", "keyence_sdk.jar"); /* キーエンスSDK（DEX形式に変換済みのjar） */
		ExternalObject.LoadJar("sampleLibp", "keyence_poweruptool.jar", "sampleLib"); /* 互換IF端末制御モジュール（DEX形式に変換済みのjar） */
		
		var ns = "jp.co.opst.biz.util.poweruptool.keyencepoweuptool.DeviceControl"; /* DeviceControlクラス */
		var lib = "sampleLibp";
		var context = ExternalObject.GetCurrentContext(); /* 初期化処理用Context作成 */
		var eos = new ExternalObject(ns, lib,context); /* ExternalObject作成 */

		Append(eos,"eos"); /* オブジェクトツリーに登録 */
		
		Label03.Value = "Load OK";
	}
	
}

Button btn01 {
	Function OnTouch(e){
		try {
			var eos = ^.FindChild("eos"); /* 初期表示時に作成したオブジェクトを取得する */
			var res = eos.Invoke("crsLED", val(^.txt01.Value), val(^.txt02.Value), val(^.txt03.Value), val(^.txt04.Value)); /* ◆API呼び出し例 */
			
		}catch(e){
			//.MessageBox(e.message);
		}
	}
}

 

目次

 

メソッド名 概要
crsLED LEDの動作および停止を制御します。
crsPlayBuzzer ブザーの動作を制御します。すでに制御中の場合は何もしません。
crsPlayVibrator バイブレーターの動作を制御します。すでに制御中の場合は何もしません。
crsScan スキャンを開始します。スキャン開始後、処理がすぐにBiz/Browserに戻ります。戻り値はありません。
ReadBarcode スキャンで読み取ったときに発生します。
crsStopBuzzer 再生中のブザーの再生を停止します。
crsStopVibrator 振動中のバイブレータの振動を停止します。
crsSetScanKeyOutput スキャン読み取りした結果のキーボード出力を行うかどうかを設定します。
SetOCRReadDateSettings 日付の読み取りフォーマットを設定します。(西暦桁、日にち表記、1桁の月・日表示、セパレータ)
SetOCRStringFormat 文字列の読み取り形式を取得します。
SetOCRReadRecognizeDate 認識する日付の範囲を設定します。
SetOCRReadEra 認識する和暦の範囲を設定します。
SetOCRKanjiBME 日にちの上中下を設定します。（上旬、中旬、下旬）
SetOCRReadKanjiBME SetOCRKanjiBMEメソッドのエイリアスです。
SetOCRPattern OCRの認識パターンを設定します。
SetOCRReadPattern SetOCRPatternメソッドのエイリアスです。
SetOCRDateFormat 日付のYMDの並び順形式を設定します。
SetOCREnableCombi OCR,バーコード読み取りの組み合わせを設定します。
changeConfigGroup 使用する読み取り設定を指定します。設定は10個まで保存できます。
getCurrentConfigGroup 現在使用している読み取り設定の番号を取得します。

crsLEDメソッド

説明

LEDの動作および停止を制御します。

 

呼出形式

eos.invoke("startScanBarcode", ledOn,ledOff,ledCount,ledColor);

 

戻り値

なし

 

引数

integer ledOn

LED ON時間（ミリ秒）1～5000

 

 

integer ledOff

LED OFF時間（ミリ秒）1～5000

 

 

integer ledCount

繰り返し回数 1～10

 

 

integer ledColor

LED色 1～7

 

使用例

 
eos.Invoke("crsLED", 1000, 1000, 3, 1);

 

crsPlayBuzzerメソッド

説明

ブザーの動作を制御します。すでに制御中の場合は何もしません。

鳴らせるブザー音の種類は端末によって異なります。あらかじめ鳴るかどうかを確認してから使用してください。

 

任意の音声ファイル(wav形式等)を再生したい場合は、本メソッドの代わりにRuntime.PlaySoundメソッドが使用可能です。

 

呼出形式

eos.invoke("crsPlayBuzzer", bzrOn, bzrOff, bzrCount, bzrTone, bzrVolume);

 

戻り値

なし

 

引数

integer bzrOn

ブザーON時間（ミリ秒）1～5000

 

 

integer bzrOff

ブザーOFF時間（ミリ秒）1～5000

 

 

integer bzrCount

繰り返し回数 1～10

 

 

integer bzrTone

音の種類。ToneGenerator(android.media.ToneGenerator)クラスで指定できる音の種類と同じです。

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

 

 

integer bzrVolume

ブザー音量 1～100

 

使用例

 
eos.Invoke("crsPlayBuzzer", 1000, 1000, 3, 1, 50);

 

crsPlayVibratorメソッド

説明

バイブレーターの動作を制御します。すでに制御中の場合は何もしません。

 

呼出形式

eos.invoke("crsPlayVibrator", vibOn, vibOff, vibCount);

 

戻り値

なし

 

引数

integer vibOn

バイブレータ―ON時間（ミリ秒）1～5000

 

 

integer vibCount

繰り返し回数 1～10

 

 

integer vibOff

バイブレータ―OFF時間（ミリ秒）1～5000

 

使用例

 
eos.Invoke("crsPlayVibrator", 1000, 1000, 3);

 

crsScanメソッド

説明

スキャンを開始します。スキャン開始後、処理がすぐにBiz/Browserに戻ります。戻り値はありません。

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

 

呼出形式

eos.invoke("crsScan", timeoutMs);

 

戻り値

なし

 

 

 

スキャンの種類はそれぞれ下記に対応しています。

値バーコードの種類
1EAN-13(JAN-13)
2EAN-8(JAN-8)
4UPC-A
6郵便カスタマーバーコード
9ITF
11CODE-128
12CODE-93
13CODE-39
14CODABAR(NW-7)
17QR
18GS1 DataBar
25PDF417/2Dタイプ
26Data Matrix
28OCR

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

      ・ UPC-E は、 2（ EAN-8(JAN-8) ）で検知します。

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

      ・ Micro PDF は、 25（ PDF417/2Dタイプ ）で検知します。

 

引数

integer type

スキャンタイムアウト時間（ミリ秒）100～25500

 

使用例

 
eos.Invoke("crsScan", 3000);

 

ReadBarcodeイベント

説明

スキャンで読み取ったときに発生します。

 

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

型

名前

説明

String

type

バーコード種別

String

data

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

String

rawadata

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

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

 

使用例

 
/* イベントを受け取るCRSスクリプト */
/* Rootオブジェクトにイベントハンドラを定義 */
//{
	Function OnReadBarcode(e) {
		/* e.type, e.data, e.rawdata として各データが参照できます。 */
		frmKeyence.lbl01 = "type: " + e.type + "data: " +e.data + "rawdata: " +e.rawdata; 
	}
}

 

crsStopBuzzerメソッド

説明

再生中のブザーの再生を停止します。

ブザーが再生されていない場合は何もしません。

 

呼出形式

var res = eos.invoke("crsStopBuzzer");

 

戻り値

なし

 

引数

なし

 

使用例

 
eos.Invoke("crsStopBuzzer");

 

crsStopVibratorメソッド

説明

振動中のバイブレータの振動を停止します。

振動していない場合は何もしません。

 

呼出形式

var res = eos.invoke("crsStopVibrator");

 

戻り値

なし

 

引数

なし

 

使用例

 
eos.Invoke("crsStopVibrator");

 

crsSetScanKeyOutputメソッド

説明

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

 

呼出形式

eos.invoke("crsSetScanKeyOutput", enabled);

 

戻り値

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

 

引数

boolean enabled

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

 

 

crsGetScanKeyOutputメソッド

説明

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

 

呼出形式

eos.invoke("crsGetScanKeyOutput");

 

戻り値

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

 

引数

なし

 

 

 

SetOCRReadDateSettingsメソッド

説明

日付の読み取りフォーマットを設定します。(西暦桁、日にち表記、1桁の月・日表示、セパレータ)

 

呼出形式

var res = eos.invoke("SetOCRReadDateSettings", digit, dayExist, oneDigit, delimiter);

 

戻り値

成功:0、失敗:1

 

引数

integer digit

2桁の年表記(2:読み取らない、3:読み取る)

 

 

integer dayExist

日にち表記（1: 日にちありのみ 2: 日にち無しのみ 3: 日にちあり/無し）

 

 

integer oneDigit

1桁の月日（0: 無効 1: 有効）

 

 

integer delimiter

セパレータ（1:スラッシュ「/」 2: ピリオド「.」 4: ハイフン「-」 8: スペース「 」 16: 「年月」 32: なし 63: すべて）

 

使用例

 
var res = eos.Invoke("SetOCRReadDateSettings",3,3,1,63); 
//.MessageBox(res);

 

SetOCRStringFormatメソッド

説明

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

 

呼出形式

eos.invoke("SetOCRStringFormat", format);

 

戻り値

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

 

引数

String format

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

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

 

 

GetOCRStringFormatメソッド

説明

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

 

呼出形式

eos.invoke("GetOCRStringFormat");

 

戻り値

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

 

引数

なし

 

SetOCRReadRecognizeDateメソッド

説明

認識する日付の範囲を設定します。

 

呼出形式

eos.invoke("SetOCRReadRecognizeDate", yearStart, monthStart, dayStart, yearEnd, monthEnd, dayEnd);

 

戻り値

成功:0、失敗:1

 

引数

integer yearStart

開始年(2000～2099)

 

 

integer monthStart

開始月(1～12)

 

 

integer dayStart

開始日(1～31)

 

 

integer yearEnd

終了年(2000～2099)

 

 

integer monthEnd

終了月(1～12)

 

 

integer dayEnd

終了日(1～31)

 

使用例

 
var res = eos.Invoke("SetOCRReadRecognizeDate",2017,1,1,2029,12,31); 
//.MessageBox(res);

 

SetOCRReadEraメソッド

説明

認識する和暦の範囲を設定します。

 

呼出形式

eos.invoke("SetOCRReadEra", valid1, firstYear1, rangeMin1, rangeMax1, valid2, firstYear2, rangeMin2, rangeMax2);

 

戻り値

成功:0、失敗:1

 

引数

integer valid1

和暦表記1有効無効(0:無効、1:有効)

 

 

integer firstYear1

元年1(1989～2039)

 

 

integer rangeMin1

最小年1(1～99)

 

 

integer rangeMax1

最大年1(1～99)

 

 

integer valid2

和暦表記2有効無効(0:無効、1:有効)

 

 

integer firstYear2

元年2(1989～2039)

 

 

integer rangeMin2

最小年2(1～99)

 

 

integer rangeMax2

最大年2(1～99)

 

使用例

 
var res = eos.Invoke("SetOCRReadEra"1,1989,1,30,1,2019,1,99); 
//.MessageBox(res);

 

SetOCRKanjiBMEメソッド

説明

日にちの上中下を設定します。（上旬、中旬、下旬）

 

呼出形式

eos.invoke("SetOCRKanjiBME", enable, replaceB, replaceM, replaceE);

 

戻り値

成功:0、失敗:1

 

引数

integer enable

上中下文字の読取(0:無効、1:有効)

 

 

integer replaceB

上の置換え日にち(1～31)

 

 

integer replaceM

中の置換え日にち(1～31)

 

 

integer replaceE

下の置換え日にち(1～31)

 

使用例

 
var res = eos.Invoke("SetOCRKanjiBME",1,10,20,31);
//.MessageBox(res);

 

SetOCRReadKanjiBMEメソッド

説明

SetOCRKanjiBMEメソッドのエイリアスです。

引数や戻り値などは当該メソッドを参照してください。

 

 

SetOCRPatternメソッド

説明

OCRの認識パターンを設定します。

 

呼出形式

eos.invoke("SetOCRPattern", date);

 

戻り値

成功:0、失敗:1

 

引数

integer date

0:文字、1:日付

 

使用例

 
var res = eos.Invoke("SetOCRPattern",1);
//.MessageBox(res);

 

SetOCRReadPatternメソッド

説明

SetOCRPatternメソッドのエイリアスです。

引数や戻り値などは当該メソッドを参照してください。

 

 

SetOCRDateFormatメソッド

説明

日付のYMDの並び順形式を設定します。

 

呼出形式

eos.invoke("SetOCRDateFormat", order, alphabet);

 

戻り値

成功:0、失敗:1

 

引数

integer order

日付形式(1:YMD形式、2:DMY形式、4:MDY形式)

 

 

integer alphabet

英字表記の月の読取(0:読み取らない、1:読み取る)

 

使用例

 
var res = eos.Invoke("SetOCRDateFormat",1,1);
//.MessageBox(res);

 

SetOCRReadDateFormatメソッド

説明

SetOCRReadDateFormatメソッドのエイリアスです。

引数や戻り値などは当該メソッドを参照してください。

 

 

SetOCREnableCombiメソッド

説明

OCR,バーコード読み取りの組み合わせを設定します。

 

呼出形式

eos.invoke("SetOCREnableCombi", type);

 

戻り値

なし

 

引数;

integer type

1:OCR・バーコード有効、 2:OCR有効・バーコード無効、 3:OCR無効・バーコード有効

 

使用例

 
eos.Invoke("SetOCREnableCombi",1);

 

changeConfigGroupメソッド

説明

使用する読み取り設定を指定します。設定は10個まで保存できます。

設定を切り替えると、読み取り対象はOCR、バーコード両方に変更されます。

 

呼出形式

eos.invoke("changeConfigGroup", id);

 

戻り値

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

 

引数

integer id

読み取り設定のID(0-9)

 

 

getCurrentConfigGroupメソッド

説明

現在使用している読み取り設定の番号を取得します。

 

呼出形式

eos.invoke("getCurrentConfigGroup");

 

戻り値

現在の読み取り設定のID

 

引数

なし