1. APIリファレンス

パラメータの指定は不要です。

戻り値

PrinterManagerクラスのインスタンスを返します。

start ¶

SDKサーバーとの通信を開始します。

構文

async start( { [ lockDevice: lockDevice ] } )

パラメータ

lockDevice

デバイスを他のホストやソフトウェアからアクセスできないようロックするかどうかをbooleanで指定します。
ロックする場合は、デバイスへ命令を送信する時間は短くなりますが、他のホストとデバイスを共有できません。
省略可能(デフォルト:false)です。
端末がスリープした場合、ロックは一時的に解除される場合があります。
ブラウザで「戻る」ボタンを押したり、再読込みしたりすると、SDKサーバーとの通信は切断されます。再度startメソッドの呼出しから行って下さい。
デバイスとWireless LAN, Ethernetで接続する場合、デバイスへの接続開始あるいは最後のデータ送信から、デバイスのTCP Socket Portのタイムアウト時間が経過すると、ロックが解除されます。

説明

本メソッドは、他のPrinterManagerクラスのメソッドを使用する前に呼び出してください。
バッファはクリアされます。
本メソッドを呼び出す前に、SDKサーバー上でデバイスを選択してください。本メソッド呼び出し後は、stop メソッドを呼び出すまではSDKサーバー上でデバイスを選択し直すことはできません。

参考

Web SDKサーバーは同時に1つの接続のみ受け付けます。他のページなどから接続を行う場合には、接続中のWebページで、stopメソッドによりWeb SDKサーバーとの接続を終了してください。
AndroidデバイスやWindows PCがスリープ状態になると、Web SDKサーバーへの接続は切断されます。
Web SDKサーバーは、元のページと異なるページから接続された場合、保持しているバッファ内のデータをクリアします。
各メソッド実行時、エラーコード-605(Web SDKサーバーと接続できなかったことによるエラー)が返された場合は、stopメソッドを実行後startメソッドを実行してください。このときのstopメソッドはエラーを返す場合があります。
appendXXXメソッド実行時にエラーコード-201(タイムアウトによるエラー)が返された場合は、もう一度 startメソッドを実行してください。バッファがクリアされていますので、もう一度最初から appendXXX メソッドを実行してください。

stop ¶

デバイスステータスの監視および Web SDKサーバーとの接続を終了します。

構文

async stop( { } )

パラメータ

空のオブジェクトを指定してください。

doPrint ¶

appendXXXメソッドで追加されたバッファ内のデータをプリンターへ送信して印刷します。

構文

async doPrint( { [ timeout: timeout] } )

パラメータ

timeout

印刷タイムアウトを数値で指定します。単位は秒です。
利用可能な値は-1,10～300です。-1を指定した場合は印刷タイムアウトが無効になります。プリンターのテイクンモードが有効な場合は、-1を指定してください。
省略可能(デフォルト:90)です。

戻り値

下記の要素を含む結果オブジェクトを返します。

printId

印刷IDを数値で返します。

説明

本メソッドは、SDKサーバー内のバッファに保存されたデータを、プリンターに送信して印刷します。
SDKサーバー内のバッファのサイズは最大10MBです。
onDeviceStatusにコールバック関数が設定されている場合、印刷が正常に終了すると印刷の完了が通知されます。
印刷中にエラーを検知した場合は印刷の完了は通知されません。
SDKサーバー内のバッファの内容は下記の場合にクリアされます。

start/stopメソッド呼び出し時
本メソッドの呼び出し後、最初のappendXXXメソッドの呼び出し時

appendText ¶

指定されたテキストをバッファに追加します。

構文

async appendText( { text: text,
                    [bold: bold,]
                    [underline: underline,]
                    [reverse: reverse,]
                    [inversion: inversion,]
                    [font: font,]
                    [widthScale: widthScale,]
                    [heightScale: hightScale,]
                    [alignment: alignment] } )

パラメータ

text

バッファに追加するテキストデータを文字列で指定します。
一度に指定可能なデータサイズは16KB（16384バイト）です。
省略できません。
テキストデータの終端には改行文字 '\n' を付加してください。ただし、1行の中で文字の太さを切り替えたいなど、1行を複数回のappendText呼び出しに分けてバッファに追加したい場合は除きます。その場合は最後のappendTextの呼び出しのテキストデータの終端には改行文字 '\n' を付加してください。

bold

強調印刷の有効/無効の設定をbooleanで指定します。
省略可能(デフォルト:false)です。

underline

アンダーラインの設定を数値で指定します。
下記表のいずれかの値を指定してください。
省略可能(デフォルト:0)です。

underline	アンダーライン
0	アンダーラインなし
1	1ドットアンダーライン
2	2ドットアンダーライン

reverse

白黒反転印刷の設定をbooleanで指定します。
true を指定した場合は白黒反転印刷を行います。
省略可能(デフォルト:false)です。

inversion

倒立印刷の設定をbooleanで指定します。
true を指定した場合は倒立印刷を行います。
省略可能(デフォルト:false)です。
1行の中で正立印刷と倒立印刷を混在させることはできません。

font

文字フォントを文字列で指定します。
利用可能な値は 'fontA', 'fontB' のいずれかです。
省略可能(デフォルト:'fontA')です。

widthScale

文字倍率（幅）を数値で指定します。
利用可能な値は1～8です。
省略可能(デフォルト:1)です。
漢字は2倍まで拡大されます。

heightScale

文字倍率（高さ）を数値で指定します。
利用可能な値は1～8です。
省略可能(デフォルト:1)です。
漢字は2倍まで拡大されます。

位置揃えを文字列で指定します。
利用可能な値は'left', 'center', 'right'のいずれかです。
省略可能(デフォルト:'left')です。
1行の中で位置揃えを混在させることはできません。

説明

本メソッドは、指定されたテキストデータを、setInternationalCharacter、及びsetCodePageを基にプリンターで印刷可能なテキストデータにエンコードしてバッファに追加します。

appendBarcode ¶

バーコードをバッファに追加します。各バーコードに入力可能なデータ形式はプリンターの技術説明書を参照ください。

・1次元バーコードの印刷¶

構文

async appendBarcode( { symbol: symbol,
                       [text: text,]
                       [data: data,]
                       moduleSize: moduleSize,
                       barcodeHeight: barcodeHeight,
                       [hriPosition: hriPosition,]
                       [hriFont hriFont,]
                       [alignment: alignment,]
                       nwRatio: nwRatio } )

パラメータ

バーコードシンボルを文字列で指定します。印刷するバーコードシンボルに応じて下記を指定してください。
省略できません。

symbol	バーコードシンボル
'upcA'	UPC A
'upcE'	UPC E
'ean13'	EAN13
'jan13'	JAN13
'ean8'	EAN8
'jan8'	JAN8
'code39'	CODE39
'code93'	CODE93
'code128'	CODE128
'itf'	ITF
'codabar'	CODABAR
'ean13Addon'	EAN13 ADDON
'jan13Addon'	JAN13 ADDON
'gs1OmniDirectional'	GS1 Databar Omni Directional
'gs1Truncated'	GS1 Databar Truncated
'gs1Limited'	GS1 Databar Limited
'gs1Expanded'	GS1 Databar Expanded

text

バーコードデータを文字列で指定します。
必ずtextかdataのいずれかの要素を指定してください。

data

バーコードデータをblobで指定します。指定したデータはそのままバッファに追加されます。
データのフォーマットはプリンターの技術説明書を参照してください。
必ずtextかdataのいずれかの要素を指定してください。

バーコードの幅を数値で指定します。
2～8の値を指定してください。
省略できません。

barcodeHeight

バーコードの高さ（ドット）を数値で指定します。
省略できません。

barcodeSymbolが下記の場合の利用可能な値は、1～255です。

'upcA', 'upcE', 'ean13', 'jan13' 'ean8', 'jan8', 'code39', 'code93', 'code128', 'itf', 'codabar', 'ean13Addon', 'jan13Addon'

barcodeSymbolが下記の場合は、barcodeSymbolとmoduleSizeにより利用可能な値が異なります。

barcodeSymbol	moduleSize	利用可能な値
'gs1OmniDirectional'	2	66 ～ 255
	3	99 ～ 255
	4	132 ～ 255
	5	165 ～ 255
	6	198 ～ 255
'gs1Truncated'	2	26 ～ 255
	3	39 ～ 255
	4	52 ～ 255
	5	65 ～ 255
	6	78 ～ 255
'gs1Limited'	2	20 ～ 255
	3	30 ～ 255
	4	40 ～ 255
	5	50 ～ 255
	6	60 ～ 255
'gs1Expanded'	2	68 ～ 255
	3	102 ～ 255
	4	136 ～ 255
	5	170 ～ 255
	6	204 ～ 255

hriPosition

HRI文字印刷位置を文字列で指定します。

hriPosition	詳細
'none'	HRI文字を印刷しない
'above'	バーコードの上
'below'	バーコードの下
'aboveBelow'	バーコードの上下

hriFont

HRI文字フォントを文字列で指定します。
利用可能な値は'fontA', 'fontB'のいずれかです。
省略可能(デフォルト:'fontA')です。

位置揃えを文字列で指定します。
利用可能な値は'left', 'center', 'right'のいずれかです。
省略可能(デフォルト:'center')です。

nwRatio

NW比を文字列で指定します。
利用可能な値は'1:2', '1:2.5', '1:3'のいずれかです。
指定したmoduleSizeとnwRatioにより、太エレメントの幅が下表のように設定されます。
省略できません。

moduleSize	nwRatio '1:2'	'1:2.5'	'1:3'
2	0.500 mm(4ドット)	0.625 mm(5ドット)	0.750 mm(6ドット)
3	0.750 mm(6ドット)	1.000 mm(8ドット)	1.125 mm(9ドット)
4	1.000 mm(8ドット)	1.250 mm(10ドット)	1.500 mm(12ドット)
5	1.250 mm(10ドット)	1.625 mm(13ドット)	1.875 mm(15ドット)
6	1.500 mm(12ドット)	1.875 mm(15ドット)	2.250 mm(18ドット)

・PDF417の印刷¶

PDF417をバッファに追加します。

構文

async appendBarcode( { symbol: symbol,
                       [text: text,]
                       [data: data,]
                       errorCorrection: errorCorrection,
                       row: row,
                       column: column,
                       moduleSize: moduleSize,
                       moduleHeight: moduleHeight,
                       [alignment: alignment,]
                       pdf417Symbol: pdf417Symbol } )

パラメータ

バーコードシンボルを文字列で指定します。
文字列 'pdf417' を指定してください。
省略できません。

text

バーコードデータを文字列で指定します。
必ずtextかdataのいずれかの要素を指定してください。

data

バーコードデータをblobで指定します。指定したデータはそのままバッファに追加されます。
データのフォーマットはプリンターの技術説明書を参照してください。
必ずtextかdataのいずれかの要素を指定してください。

errorCorrection

エラー訂正レベルを文字列で指定します。
利用可能な値は、'0', '1', '2', '3', '4', '5', '6', '7', '8'のいずれかです。
省略できません。

row

段数（段）を数値で指定します。
利用可能な値は、0～90です。
0を指定した場合は、段数が自動設定されます。省略できません。

column

データ領域のカラム数を数値で指定します。
利用可能な値は、0～30です。
0を指定した場合は、データ領域のカラム数が自動設定されます。省略できません。

公称細エレメント幅を数値で指定します。
利用可能な値は、2～8です。
省略できません。

moduleHeight

段高さ（ドット）を数値で指定します。
利用可能な値は、2～127です。
段高さの設定を小さくすると、バーコードスキャナーによっては読み取れない場合があります。通常の使用では、3以上を設定してください。
省略できません。

位置揃えを文字列で指定します。
利用可能な値は'left', 'center', 'right'のいずれかです。
省略可能(デフォルト:'center')です。

pdf417Symbol

PDF417のシンボルを文字列で指定します。
利用可能な値は、'standard'か'compact'のいずれかです。
省略できません。

・QRコードの印刷¶

QRコードをバッファに追加します。

構文

async appendBarcode( { symbol: symbol,
                       [text: text,]
                       [data: data,]
                       errorCorrection: errorCorrection,
                       moduleSize: moduleSize,
                       [alignment: alignment]  } )

パラメータ

String バーコードシンボルを指定します。
文字列 'qrCode' を指定してください。
省略できません。

text

バーコードデータを文字列で指定します。
バージョンはtextで指定したデータ数に応じて自動設定されます。
必ずtextかdataのいずれかの要素を指定してください。

data

バーコードデータをblobで指定します。指定したデータはそのままバッファに追加されます。
データのフォーマットはプリンターの技術説明書を参照してください。
バージョンはdataで指定したデータ数に応じて自動設定されます。
必ずtextかdataのいずれかの要素を指定してください。

errorCorrection

エラー訂正レベルを文字列で指定します。
利用可能な値は、'l', 'm', 'h', 'q' のいずれかです。
省略できません。

モジュールサイズを数値で指定します。
利用可能な値は、2～16です。
省略できません。

位置揃えを文字列で指定します。
利用可能な値は'left', 'center', 'right'のいずれかです。
省略可能(デフォルト:'center')です。

・Data Matrixの印刷¶

Data Matrixをバッファに追加します。

構文

async appendBarcode( { symbol: symbol,
                      [text: text,]
                      [data: data,]
                      dataMatrixModule: dataMatrixModule,
                      moduleSize: moduleSize,
                      [alignment: alignment] } )

パラメータ

バーコードシンボルを文字列で指定します。
文字列 'dataMatrix' を指定してください。
省略できません。

text

バーコードデータを文字列で指定します。
必ずtextかdataのいずれかの要素を指定してください。

data

バーコードデータをblobで指定します。指定したデータはそのままバッファに追加されます。
データのフォーマットはプリンターの技術説明書を参照してください。
必ずtextかdataのいずれかの要素を指定してください。

dataMatrixModule

Data Matrixモジュール数を文字列で指定します。
利用可能な値は、下記を参照してください。
省略できません。

dataMatrixModule	モジュール数
'auto'	モジュール数自動
'10x10'	モジュール数10×10
'12x12'	モジュール数12×12
'14x14'	モジュール数14×14
'16x16'	モジュール数16×16
'18x18'	モジュール数18×18
'20x20'	モジュール数20×20
'22x22'	モジュール数22×22
'24x24'	モジュール数24×24
'26x26'	モジュール数26×26
'32x32'	モジュール数32×32
'36x36'	モジュール数36×36
'40x40'	モジュール数40×40
'44x44'	モジュール数44×44
'48x48'	モジュール数48×48
'52x52'	モジュール数52×52
'64x64'	モジュール数64×64
'72x72'	モジュール数72×72
'80x80'	モジュール数80×80
'88x88'	モジュール数88×88
'96x96'	モジュール数96×96
'104x104'	モジュール数104×104
'120x120'	モジュール数120×120
'132x132'	モジュール数132×132
'144x144'	モジュール数144×144
'8x18'	モジュール数8×18
'8x32'	モジュール数8×32
'12x26'	モジュール数12×26
'12x36'	モジュール数12×36
'16x36'	モジュール数16×36
'16x48'	モジュール数16×48

モジュールサイズを数値で指定します。
利用可能な値は、2～16です。
省略できません。

位置揃えを文字列で指定します。
利用可能な値は'left', 'center', 'right'のいずれかです。
省略可能(デフォルト:'center')です。

・MaxiCodeの印刷¶

MaxiCodeをバッファに追加します。

構文

async appendBarcode( { symbol: symbol,
                       [text: text,]
                       [data: data,]
                       maxiCodeMode: maxiCodeMode,
                       [alignment: alignment] } )

パラメータ

バーコードシンボルを文字列で指定します。
文字列 'maxicode' を指定してください。
省略できません。

text

バーコードデータを文字列で指定します。
maxiCodeModeが'2'の場合、データの先頭にサービスクラス（3桁）、国コード（3桁）、郵便番号（9桁）を付加してください。
maxiCodeModeが'3'の場合、データの先頭にサービスクラス（3桁）、国コード（3桁）、郵便番号（6桁）を付加してください。
必ずtextかdataのいずれかの要素を指定してください。

data

バーコードデータをblobで指定します。指定したデータはそのままバッファに追加されます。
データのフォーマットはプリンターの技術説明書を参照してください。
maxiCodeModeが'2'の場合、データの先頭にサービスクラス（3桁）、国コード（3桁）、郵便番号（9桁）を付加してください。
maxiCodeModeが'3'の場合、データの先頭にサービスクラス（3桁）、国コード（3桁）、郵便番号（6桁）を付加してください。
必ずtextかdataのいずれかの要素を指定してください。

maxiCodeMode

MaxiCodeモードを文字列で指定します。利用可能な値は、'2', '3', '4', '5' のいずれかです。
省略できません。

位置揃えを文字列で指定します。
利用可能な値は'left', 'center', 'right'のいずれかです。
省略可能(デフォルト:'center')です。

・GS1 Databar Stackedの印刷¶

GS1 Databar Stackedをバッファに追加します。

構文

async appendBarcode( { symbol: symbol,
                       [text: text,]
                       [data: data,]
                       moduleSize: moduleSize,
                       [alignment: alignment] } )

パラメータ

バーコードシンボルを文字列で指定します。
文字列 'gs1DatabarStacked' を指定してください。
省略できません。

text

バーコードデータを文字列で指定します。
'0'～'9'を13文字入力してください。
先頭の'01'はプリンターにより自動付加されます。チェックデジットはプリンターにより自動計算されます。
必ずtextかdataのいずれかの要素を指定してください。

data

バーコードデータをblobで指定します。指定したデータはそのままバッファに追加されます。
データのフォーマットはプリンターの技術説明書を参照してください。
'0'～'9'を13文字入力してください。
先頭の'01'はプリンターにより自動付加されます。チェックデジットはプリンターにより自動計算されます。
必ずtextかdataのいずれかの要素を指定してください。

モジュールサイズを数値で指定します。
利用可能な値は、2～16です。
省略できません。

位置揃えを文字列で指定します。
利用可能な値は'left', 'center', 'right'のいずれかです。
省略可能(デフォルト:'center')です。

・GS1 Databar Stacked Omni-directionalの印刷¶

GS1 Databar Stacked Omni-directionalをバッファに追加します。

構文

async appendBarcode( { symbol: symbol,
                       [text: text,]
                       [data: data,]
                       moduleHeight: moduleHeight,
                       moduleSize: moduleSize,
                       [alignment: alignment] } )

パラメータ

バーコードシンボルを文字列で指定します。
文字列 'gs1DatabarStackedOmniDirectional' を指定してください。
省略できません。

text

バーコードデータを文字列で指定します。
'0'～'9'を13文字入力してください。
先頭の'01'はプリンターにより自動付加されます。チェックデジットはプリンターにより自動計算されます。
必ずtextかdataのいずれかの要素を指定してください。

data

バーコードデータをblobで指定します。指定したデータはそのままバッファに追加されます。
データのフォーマットはプリンターの技術説明書を参照してください。
'0'～'9'を13文字入力してください。
先頭の'01'はプリンターにより自動付加されます。チェックデジットはプリンターにより自動計算されます。
必ずtextかdataのいずれかの要素を指定してください。

moduleHeight

バーコードの段高さ（モジュール数）を数値で指定します。
利用可能な値は、33～255です。
省略できません。

モジュールサイズを数値で指定します。
利用可能な値は、2～16です。
省略できません。

位置揃えを文字列で指定します。
利用可能な値は'left', 'center', 'right'のいずれかです。
省略可能(デフォルト:'center')です。

・GS1 Databar Expanded Stackedの印刷¶

GS1 Databar Expanded Stackedをバッファに追加します。

構文

async appendBarcode( { symbol: symbol,
                       [text: text,]
                       [data: data,]
                       column: column,
                       moduleSize: moduleSize,
                       [alignment: alignment] } )

パラメータ

バーコードシンボルを文字列で指定します。
文字列 'gs1DatabarExpandedStacked' を指定してください。
省略できません。

text

バーコードデータを文字列で指定します。
' '、'!'、'"'、'%'、'&'、'''、'('、')'、'*'、'+'、','、'-'、'.'、'/'、':'、';'、'<'、'='、'>'、'?'、'_'、'0'～'9'、'A'～'Z'、'a'～'z'を任意の文字数分入力してください。
FNC1は、'{1'を入力してください。
チェックデジットはプリンターにより自動計算されませんので必ず入力してください。
必ずtextかdataのいずれかの要素を指定してください。

data

バーコードデータをblobで指定します。指定したデータはそのままバッファに追加されます。
データのフォーマットはプリンターの技術説明書を参照してください。
チェックデジットはプリンターにより自動計算されませんので必ず入力してください。
必ずtextかdataのいずれかの要素を指定してください。

column

1行のカラム数を数値で指定します。
1行のカラム数を指定してください。
利用可能な値は2～20の偶数です。
省略できません。

モジュールサイズを数値で指定します。
利用可能な値は、2～16です。
省略できません。

位置揃えを文字列で指定します。
利用可能な値は'left', 'center', 'right'のいずれかです。
省略可能(デフォルト:'center')です。

・Aztec Codeの印刷¶

Aztec Codeをバッファに追加します。

構文

async appendBarcode( { symbol: symbol,
                       [text: text,]
                       [data: data,]
                       layer: layer,
                       errorCorrection: errorCorrection,
                       moduleSize: moduleSize,
                       aztecSymbol: aztecSymbol,
                       [alignment: alignment] } )

パラメータ

バーコードシンボルを文字列で指定します。
文字列 'aztecCode' を指定してください。
省略できません。

text

バーコードデータを文字列で指定します。
データをUTF-8でバイナリにエンコードし、バッファに追加します。
送信するデータが文字列で指定できない場合は、下記のエスケープシーケンスで指定できます。
必ずtextかdataのいずれかの要素を指定してください。

エスケープシーケンス	説明
\u00nn	コントロールコード（nnは16進数で指定）
\	バックスラッシュ

FNC1を指定するには、データに"\u001b\u0030"を入力してください。 1Bhを指定するには、データに"\u001b\u001b"を入力してください。

data

バーコードデータをblobで指定します。指定したデータはそのままバッファに追加されます。
データのフォーマットはプリンターの技術説明書を参照してください。
必ずtextかdataのいずれかの要素を指定してください。

layer

レイヤー数。
フルレンジモードの利用可能な値は、0、4～32です。
コンパクトモードの利用可能な値は、0、1～4です。
0を指定した場合はレイヤーが自動設定されます。
省略できません。

errorCorrection

エラー訂正レベル(%)を文字列で指定します。
利用可能な値は、'0'、'5'～'95'です。
'0'を指定した場合は23%になります。
省略できません。

モジュールサイズを数値で指定します。
利用可能な値は、2～16です。
省略できません。

aztecSymbol

Aztecシンボルを文字列で指定します。
利用可能な値は、'fullRange', 'compact'のいずれかです。
省略できません。

位置揃えを文字列で指定します。
利用可能な値は'left', 'center', 'right'のいずれかです。
省略可能(デフォルト:'center')です。

プリンターにより Aztec Code の印刷の可否が異なります。

プリンター	Aztec Code の印刷
RP-F10	非対応
MP-A40	非対応
MP-B20	非対応
MP-B21L	対応
MP-B30	非対応
MP-B30L	対応
SLP720RT/721RT	非対応

・カスタマーバーコードの印刷¶

カスタマーバーコードをバッファに追加します。

構文

async appendBarcode( { symbol: symbol,
                       [text: text,]
                       [data: data,]
                       moduleSize: moduleSize,
                       [alignment: alignment] } )

パラメータ

バーコードシンボルを文字列で指定します。
文字列 'customerBarcodeJp' を指定してください。
省略できません。

text

バーコードデータを文字列で指定します。バーコードシンボルによってはsetCodePageで指定されたコードページに変換してバッファに追加します。
必ずtextかdataのいずれかの要素を指定してください。

data

バーコードデータをblobで指定します。指定したデータはそのままバッファに追加されます。
データのフォーマットはプリンターの技術説明書を参照してください。
必ずtextかdataのいずれかの要素を指定してください。

バーコードの幅を数値で指定します。
4～10の値を指定してください。
省略できません。

位置揃えを文字列で指定します。
利用可能な値は'left', 'center', 'right'のいずれかです。
省略可能(デフォルト:'center')です。

プリンターによりカスタマーバーコードの印刷の可否が異なります。

プリンター	カスタマーバーコードの印刷
RP-F10	非対応
MP-A40	非対応
MP-B20	非対応
MP-B21L	対応
MP-B30	非対応
MP-B30L	非対応
SLP720RT/721RT	非対応

appendBinary ¶

バイナリデータをバッファに追加します。

構文

async appendBinary( { data: data } )

パラメータ

data

バイナリデータをblobで指定します。
一度に指定可能なデータサイズは16KB（16384バイト）です。
なお、バイナリデータはBase64形式へ変換して送信されるため、実際に指定可能なバイナリデータサイズは最大12KB（12288バイト）となります。
省略できません。

説明

本メソッドは、指定されたバイナリデータを変換せずにバッファに追加します。
本メソッドでプリンターコマンドをバイナリデータとして送信することにより、ライブラリではサポートされていないプリンター機能を利用することができます。ただし、本メソッドではプリンターから応答を取得するコマンドには対応しておりません。
1つのプリンターコマンドを複数回に分けてdoPrintでプリンターに送信することはできません。

appendImage ¶

指定したイメージをバッファに追加します。

構文

async appendImage( { format: format,
                     data: data,
                     [ alignment: alignment] } )

パラメータ

format

イメージデータの形式を文字列で指定します。
指定可能な値は、'jpeg', 'png'. 'bmp' です。
省略できません。

data

イメージデータをblobで指定します。
指定可能なイメージデータのサイズは、最大3MB（3145728バイト）です。
format で指定した形式のイメージデータを指定してください。カラーイメージを指定した場合は、モノクロイメージに変換されます。
省略できません。

位置揃えを文字列で指定します。
利用可能な値は'left', 'center', 'right'のいずれかです。
省略可能(デフォルト:'center')です。

appendCut ¶

オートカッター付きのプリンターの場合、用紙カットのリクエストをバッファに追加します。オートカッター無しのプリンターの場合、用紙カット位置までの紙送りのリクエストをバッファに追加します。用紙のカットは行いません。

構文

async appendCut( { [ cuttingMethod: cuttingMethod ] } )

パラメータ

cuttingMethod

カット方法を文字列で指定します。
利用可能な値は、'full', 'fullNoFeed', 'partial', 'partialNoFeed' です。
省略可能(デフォルト:'full')です。

appendFeed ¶

用紙紙送りのリクエストをバッファに追加します。

構文

async appendFeed( { value: value } )

パラメータ

value

紙送り量を数値で指定します。
利用可能な値は、プリンターにより異なります。下記の表を参照してください。
省略できません。

プリンター	feedの値の範囲
RP-F10	-60 ～ 8000
MP-A40	-48 ～ 8000
MP-B20	0 ～ 8000
MP-B21L	-28 ～ 8000
MP-B30	0 ～ 8000
MP-B30L	0 ～ 8000
SLP720RT/721RT	-68 ～ 8000

appendMarkFeed ¶

マーク紙またはラベル紙頭出しのリクエストをバッファに追加します。

構文

async appendMarkFeed( { [ feedPosition: feedPosition ] } )

パラメータ

feedPosition

頭出し位置を文字列で指定します。
利用可能な値は、'cutPosition', 'printPosition' のいずれかです。
省略可能(デフォルト:'cutPosition')です。

feedPosition	説明
cutPosition	マークまたはギャップ検出後、カット位置まで紙送りを行います。
printPosition	次のマークまたはギャップ検出後、印刷位置まで紙送りを行います。

参考

マーク紙またはラベル紙の頭出し位置で本メソッドを実行しても、頭出しは行いません。

プリンターによりマーク紙またはラベル紙の頭出しの実行可否が異なります。
また、マーク紙またはラベル紙の頭出しを行う場合は、事前にプリンターのメモリスイッチの設定でマークモードを有効にしてください。

プリンター	マーク紙またはラベル紙の頭出し
RP-F10	非対応
MP-A40	対応
MP-B20	非対応
MP-B21L	対応
MP-B30/B30L	対応
SLP720RT/721RT	対応

appendDrawer ¶

指定されたキャッシュドロワのオープンのリクエストをバッファに追加します。

構文

async appendDrawer( { drawerNum: drawerNum,
                      onTime: onTime } )

パラメータ

drawerNum

ドロワ番号を文字列で指定します。
利用可能な値は、'1','2'です。
省略できません。

onTime

パルス幅(ミリ秒)を数値で指定します。
利用可能な値は、100～800です。下位2桁は無視されます。
省略できません。

プリンターによりキャッシュドロワのオープンの実行可否が異なります。

プリンター	キャッシュドロワのオープン
RP-F10	対応
MP-A40	非対応
MP-B20	非対応
MP-B21L	非対応
MP-B30/B30L	非対応
SLP720RT	非対応
SLP721RT	対応

appendBuzzer ¶

ブザー鳴動のリクエストをバッファに追加します。

構文

async appendBuzzer( { buzzerPattern: buzzerPattern,
                      buzzerCount: buzzerCount } )

パラメータ

buzzerPattern

ブザーパターンを数値で指定します。
利用可能な値は、1～4です。
外付けブザーの鳴動は下記のいずれかの条件で停止します。
・buzzerCountで設定したブザーの回数分の鳴動
・カバーオープン
・プリンターコマンド「外付けブザーの停止」の実行
省略できません。

buzzerCount

鳴動回数（回）を数値で指定します。
buzzerCountで設定した回数だけ外付けブザーを鳴動します。
利用可能な値は、1～255です。
省略できません。

プリンターによりブザー鳴動の実行可否が異なります。
ブザーの鳴動を行う場合は、外付けブザーを接続してください。

プリンター	ブザーの鳴動
RP-F10	対応
MP-A40	非対応
MP-B20	非対応
MP-B21L	非対応
MP-B30/B30L	非対応
SLP720RT	非対応
SLP721RT	対応

onDeviceStatus ¶

プリンターステータスが変化したときに実行するコールバックを指定・解除します。
解除する場合は、nullを指定してください。
onDeviceStatusによりコールバックが指定されている間は、他のホストからプリンターへ送信したり、プリンターステータスの取得をすることはできません。
コールバック呼び出し中に発生した例外は無視されます。

構文

 onDeviceStatus = function( object )

説明

プリンターの状態が変化した場合に、下記の要素を含んだオブジェクトを返します。
「優先順位」に値が記載されているものは、より優先順位の高い状態のみをコールバックします。

'type'	'status'	優先順位	説明
'error'	'communication error'	-	通信エラー(プリンターに接続できなかった場合など)
'error'	'timeout error'	-	タイムアウトエラー
'error'	'hardware error'	1	ハードウェアエラー
'error'	'battery error'	2	バッテリエラー
'error'	'head temperature error'	3	ヘッド温度エラー
'error'	'voltage error'	4	電圧エラー
'error'	'cutter error'	5	カッタエラー
'error'	'cover open error'	6	カバーオープンエラー
'error'	'paper jam error'	7	マーク検出時紙ジャムエラー (MP-B30L:マーク/ギャップ検出時紙ジャムエラー)
'error'	'out-of-paper error'	8	紙無しエラー
'info'	'print-ready'	9	印刷可能状態
'info'	'printing finished'	-	印刷終了を検知
'info'	'paper removal waiting'	-	テイクンセンサの状態(紙取り出し待ち)
'info'	'drawer open'	-	ドロワオープン
'info'	'drawer close'	-	ドロワクローズ

doReset ¶

プリンターをリセットします。

構文

async doReset( {} )

パラメータ

空のオブジェクトを指定してください。

説明

プリンターをリセットします。

setInternationalCharacter ¶

国際文字セットを設定します。

構文

async setInternationalCharacter( { internationalCharacter: internationalCharacter } )

パラメータ

internationalCharacter

国際文字セットを文字列で指定します。
利用可能な値は、下記表を参照してください。
省略できません。

internationalCharacter	説明
'usa'	アメリカ(USA)
'france'	フランス(France）
'germany'	ドイツ(Germany）
'england'	イギリス(United Kingdom）
'denmark1'	デンマークⅠ(Denmark I）
'sweden'	スウェーデン(Sweden）
'italy'	イタリア(Italy）
'spain'	スペインⅠ(Spain I）
'japan'	日本(Japan）
'norway'	ノルウェー(Norway）
'denmark2'	デンマークⅡ(Denmark II）
'spain2'	スペインⅡ(Spain II）
'latinAmerica'	ラテンアメリカ(Latin America）
'arabia'	アラビア(Arabia）

説明

本メソッドで国際文字セットの設定を行っていない場合は、OSの言語設定により下記の国際文字セットとなります。

OSの言語設定が日本の場合： 'japan'
OSの言語設定が日本以外の場合： 'usa'

setCodePage ¶

コードページを設定します。

構文

async setCodePage( { codePage: codePage } )

パラメータ

codePage

コードページ定数を文字列で指定します。
設定可能な値は、下記の表を参照してください。
省略できません。

codePage	説明
'437'	USA, Standard Europe（Code Page437）
'katakana'	Katakana
'850'	Multilingual（Code Page850）
'860'	Portuguese（Code Page860）
'863'	Canadian-French（Code Page863）
'865'	Nordic（Code Page865）
'857'	Turkish（Code Page857）
'737'	Greek（Code Page737）
'1252'	Latin（Code Page1252）
'866'	Russian（Code Page866）
'852'	Eastern Europe（Code Page852）
'858'	Euro（Code Page858）
'855'	Cyrillic（Code Page855）
'864'	Arabic（Code Page864）
'1250'	Central European（Code Page1250）
'1251'	Cyrillic（Code Page1251）
'1253'	Greek（Code Page1253）
'1254'	Turkish（Code Page1254）

説明

本メソッドでコードページの設定を行っていない場合は、OSの言語設定により下記のコードページとなります。

OSの言語設定が日本の場合： 'katakana'
OSの言語設定が日本以外の場合： '1252'

getVersion ¶

SDKのバージョンを文字列で取得します。

構文

async getVersion( { } )

パラメータ