Star WebPRNT User's Manual

StarWebPrintTrader.js

StarWebPRNT送信エレメント列を送信したり、受信したStarWebPRNT受信エレメント列から状態を確認/抽出します。

コンストラクタ

名称説明
StarWebPrintTraderStarWebPrintTraderオブジェクトを生成します。

メソッド

名称説明
sendMessageStarWebPRNT送信エレメント列を送信します。
isCoverOpenStarWebPRNT受信エレメント列からカバーオープンか確認します。
isOffLineStarWebPRNT受信エレメント列からオフラインか確認します。
isCompulsionSwitchCloseStarWebPRNT受信エレメント列からコンパルジョンスイッチがクローズしているか確認します。
isEtbCommandExecuteStarWebPRNT受信エレメント列からETBコマンド実行済みか確認します。
isHighTemperatureStopStarWebPRNT受信エレメント列から印字ヘッド高温停止中か確認します。
isNonRecoverableErrorStarWebPRNT受信エレメント列から復帰不可能エラーか確認します。
isAutoCutterErrorStarWebPRNT受信エレメント列から用紙カッターエラーか確認します。
isBlackMarkErrorStarWebPRNT受信エレメント列からブラックマークエラーか確認します。
isPaperEndStarWebPRNT受信エレメント列から用紙エンドか確認します。
isPaperNearEndStarWebPRNT受信エレメント列から用紙ニアエンドか確認します。
extractionEtbCounterStarWebPRNT受信エレメント列からETBカウンタを抽出します。

プロパティ

名称説明
onReceive正常受信イベント
onError異常受信イベント

機種別対応リスト

POSプリンター
名称FVP10TSP650IITSP700IITSP800IImPOPmC-Print2mC-Print3
sendMessage*1
isCoverOpen
isOffLine
isCompulsionSwitchClose
isEtbCommandExecute
isHighTemperatureStop
isNonRecoverableError
isAutoCutterError
isBlackMarkError----
isPaperEnd
isPaperNearEnd--
extractionEtbCounter

*1 Bluetoothプリンターは印刷完了待ち有効固定、名前付き引数’checkedblock'は作用しない

モバイルプリンター (ESC/POS)
名称SM-S210iSM-S220i
(Jpモデル
以外)
SM-S230iSM-T300iSM-T400i
sendMessage*1 *2
isCoverOpen
isOffLine
isCompulsionSwitchClose-----
isEtbCommandExecute-----
isHighTemperatureStop-----
isNonRecoverableError-----
isAutoCutterError-----
isBlackMarkError-----
isPaperEnd
isPaperNearEnd-----
extractionEtbCounter-----

*1 印刷完了待ち有効固定、名前付き引数’checkedblock'は作用しない

*2 名前付き引数’papertype'は作用しない

モバイルプリンター (StarPRNT)
名称SM-S210iSM-S220i
(Jpモデル
以外)
SM-S230iSM-T300iSM-T400iSM-L200SM-L300
sendMessage*1 *2
isCoverOpen
isOffLine
isCompulsionSwitchClose-------
isEtbCommandExecute
isHighTemperatureStop
isNonRecoverableError-------
isAutoCutterError-------
isBlackMarkError
isPaperEnd
isPaperNearEnd-------
extractionEtbCounter

*1 印刷完了待ち有効固定、名前付き引数’checkedblock'は作用しない

*2 名前付き引数’papertype'は作用しない

StarWebPrintTrader

StarWebPrintTraderオブジェクトを生成します。

構文

StarWebPrintTrader(args);

名前付き引数

名称説明省略時
urlStarWebPRNTエンドポイントURL
※省略時はsendMessageメソッドで指定すること
String-
checkedblock印刷完了待ち
  • true … 印刷完了待ち有効
  • false … 印刷完了待ち無効
Booleantrue
papertype用紙の種類
  • normal … 普通紙
  • black_mark … ブラックマーク紙
  • black_mark_and_detect_at_power_on … ブラックマーク紙 (電源投入時の位置検出有効)
String-

戻り値

説明
StarWebPrintTraderオブジェクトStarWebPrintTrader
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
  var trader = new StarWebPrintTrader({url:url});

    trader.sendMessage({request:request});
}
// -->
</script>

sendMessage

StarWebPRNT送信エレメント列を送信します。

構文

sendMessage(args);

名前付き引数

名称説明省略時
urlStarWebPRNTエンドポイントURL
※省略時はStarWebPrintTraderコンストラクタで指定すること
String-
checkedblock 印刷完了待ち
  • true … 印刷完了待ち有効
  • false … 印刷完了待ち無効

※省略時はStarWebPrintTraderコンストラクタで指定された値
Boolean-
requestStarWebPRNT送信エレメント列String省略不可
papertype用紙の種類
  • normal … 普通紙
  • black_mark … ブラックマーク紙
  • black_mark_and_detect_at_power_on … ブラックマーク紙 (電源投入時の位置検出有効)

※省略時はStarWebPrintTraderコンストラクタで指定された値
StarWebPrintTraderコンストラクタでも指定されていない場合は未設定
String-

戻り値

説明
--
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
  var trader = new StarWebPrintTrader({url:url});

    trader.sendMessage({request:request});
}
// -->
</script>

isCoverOpen

StarWebPRNT受信エレメント列からカバーオープンか確認します。

構文

isCoverOpen(args);

名前付き引数

名称説明省略時
traderStatusonReceiveイベントに渡されたresponseのtraderStatusプロパティString省略不可

戻り値

説明
カバーオープン状態
  • true … カバーオープン
  • false … カバークローズ
Boolean
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
  var trader = new StarWebPrintTrader({url:url});

  trader.onReceive = function (response) {
        if (trader.isCoverOpen({traderStatus:response.traderStatus})) {
            alert('CoverOpen');
    }
  }

    trader.sendMessage({request:request});
}
// -->
</script>

isOffLine

StarWebPRNT受信エレメント列からオフラインか確認します。

構文

isOffLine(args);

名前付き引数

名称説明省略時
traderStatusonReceiveイベントに渡されたresponseのtraderStatusプロパティString省略不可

戻り値

説明
オフライン状態
  • true … オフライン
  • false … オンライン
Boolean
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
  var trader = new StarWebPrintTrader({url:url});

  trader.onReceive = function (response) {
      if (trader.isOffLine({traderStatus:response.traderStatus})) {
      alert('OffLine');
    }
  }

    trader.sendMessage({request:request});
}
// -->
</script>

isCompulsionSwitchClose

StarWebPRNT受信エレメント列からコンパルジョンスイッチがクローズしているか確認します。

構文

isCompulsionSwitchClose(args);

名前付き引数

名称説明省略時
traderStatusonReceiveイベントに渡されたresponseのtraderStatusプロパティString省略不可

戻り値

説明
コンパルジョンスイッチ状態
  • true … コンパルジョンスイッチクローズ
  • false … コンパルジョンスイッチオープン
Boolean
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
  var trader = new StarWebPrintTrader({url:url});

  trader.onReceive = function (response) {
      if (trader.isCompulsionSwitchClose({traderStatus:response.traderStatus})) {
      alert('CompulsionSwitchClose');
    }
  }

    trader.sendMessage({request:request});
}
// -->
</script>

isEtbCommandExecute

StarWebPRNT受信エレメント列からETBコマンド実行済みか確認します。

構文

isEtbCommandExecute(args);

名前付き引数

名称説明省略時
traderStatusonReceiveイベントに渡されたresponseのtraderStatusプロパティString省略不可

戻り値

説明
ETBコマンド実行状態
  • true … ETBコマンド実行済み
  • false … ETBコマンド未実行
Boolean
// -->
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
  var trader = new StarWebPrintTrader({url:url});

  trader.onReceive = function (response) {
      if (trader.isEtbCommandExecute({traderStatus:response.traderStatus})) {
      alert('EtbCommandExecute');
    }
  }

    trader.sendMessage({request:request});
}
// -->
</script>

isHighTemperatureStop

StarWebPRNT受信エレメント列から印字ヘッド高温停止中か確認します。

構文

isHighTemperatureStop(args);

名前付き引数

名称説明省略時
traderStatusonReceiveイベントに渡されたresponseのtraderStatusプロパティString省略不可

戻り値

説明
印字ヘッド高温停止状態
  • true … 印字ヘッド高温停止
  • false … 印字ヘッド高温未停止
Boolean
// -->
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
  var trader = new StarWebPrintTrader({url:url});

  trader.onReceive = function (response) {
      if (trader.isHighTemperatureStop({traderStatus:response.traderStatus})) {
      alert('HighTemperatureStop');
    }
  }

    trader.sendMessage({request:request});
}
// -->
</script>

isNonRecoverableError

StarWebPRNT受信エレメント列から復帰不可能エラーか確認します。

構文

isNonRecoverableError(args);

名前付き引数

名称説明省略時
traderStatusonReceiveイベントに渡されたresponseのtraderStatusプロパティString省略不可

戻り値

説明
復帰不可能エラー状態
  • true … 復帰不可能エラー発生
  • false … 復帰不可能エラー未発生
Boolean
// -->
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
  var trader = new StarWebPrintTrader({url:url});

  trader.onReceive = function (response) {
      if (trader.isNonRecoverableError({traderStatus:response.traderStatus})) {
      alert('NonRecoverableError');
    }
  }

    trader.sendMessage({request:request});
}
// -->
</script>

isAutoCutterError

StarWebPRNT受信エレメント列から用紙カッターエラーか確認します。

構文

isAutoCutterError(args);

名前付き引数

名称説明省略時
traderStatusonReceiveイベントに渡されたresponseのtraderStatusプロパティString省略不可

戻り値

説明
用紙カッターエラー状態
  • true … 用紙カッターエラー発生
  • false … 用紙カッターエラー未発生
Boolean
// -->
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
  var trader = new StarWebPrintTrader({url:url});

  trader.onReceive = function (response) {
      if (trader.isAutoCutterError({traderStatus:response.traderStatus})) {
      alert('AutoCutterError');
    }
  }

    trader.sendMessage({request:request});
}
// -->
</script>

isBlackMarkError

StarWebPRNT受信エレメント列からブラックマークエラーか確認します。

構文

isBlackMarkError(args);

名前付き引数

名称説明省略時
traderStatusonReceiveイベントに渡されたresponseのtraderStatusプロパティString省略不可

戻り値

説明
ブラックマークエラー状態
  • true … ブラックマークエラー発生
  • false … ブラックマークエラー未発生
Boolean
// -->
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
  var trader = new StarWebPrintTrader({url:url});

  trader.onReceive = function (response) {
      if (trader.isBlackMarkError({traderStatus:response.traderStatus})) {
      alert('BlackMarkError');
    }
  }

    trader.sendMessage({request:request});
}
// -->
</script>

isPaperEnd

StarWebPRNT受信エレメント列から用紙エンドか確認します。

構文

isPaperEnd(args);

名前付き引数

名称説明省略時
traderStatusonReceiveイベントに渡されたresponseのtraderStatusプロパティString省略不可

戻り値

説明
用紙エンド状態
  • true … 用紙エンド発生
  • false … 用紙エンド未発生
Boolean
// -->
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
  var trader = new StarWebPrintTrader({url:url});

  trader.onReceive = function (response) {
      if (trader.isPaperEnd({traderStatus:response.traderStatus})) {
      alert('PaperEnd');
    }
  }

    trader.sendMessage({request:request});
}
// -->
</script>

isPaperNearEnd

StarWebPRNT受信エレメント列から用紙ニアエンドか確認します。

構文

isPaperNearEnd(args);

名前付き引数

名称説明省略時
traderStatusonReceiveイベントに渡されたresponseのtraderStatusプロパティString省略不可

戻り値

説明
用紙ニアエンド状態
  • true … 用紙ニアエンド発生
  • false … 用紙ニアエンド未発生
Boolean
// -->
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
  var trader = new StarWebPrintTrader({url:url});

  trader.onReceive = function (response) {
      if (trader.isPaperNearEnd({traderStatus:response.traderStatus})) {
            alert('PaperNearEnd');
    }
  }

    trader.sendMessage({request:request});
}
// -->
</script>

extractionEtbCounter

StarWebPRNT受信エレメント列からETBカウンタを抽出します。

構文

extractionEtbCounter(args);

名前付き引数

名称説明省略時
traderStatusonReceiveイベントに渡されたresponseのtraderStatusプロパティString省略不可

戻り値

説明
ETBカウンタ値Number
// -->
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
  var trader = new StarWebPrintTrader({url:url});

  trader.onReceive = function (response) {
      alert('EtbCounter = ' + trader.extractionEtbCounter({traderStatus:response.traderStatus}).toString();
  }

    trader.sendMessage({request:request});
}
// -->
</script>

onReceive

正常受信イベント

構文

function(response);

名前付き引数

名称説明
traderSuccess印刷結果
  • true … 印刷成功
  • false … 印刷失敗
Boolean
traderCode終了コード
  • 0 … 正常終了
  • 1100 … プリンターオフライン状態(エラー発生中)
  • 2001 … プリンタービジー状態(他の端末機器がプリンター使用中:要再送)
Number
traderStatusスター自動ステータス
※コマンド仕様書参照
String
statusXMLHttpRequestオブジェクトのstatusプロパティ
※XMLHttpRequest仕様参照
Number
responseTextXMLHttpRequestオブジェクトのresponseTextプロパティ
※XMLHttpRequest仕様参照
String
// -->
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
  var trader = new StarWebPrintTrader({url:url});

  trader.onReceive = function (response) {
        var msg = '- onReceive -\n\n';

        msg += 'TraderSuccess:' + response.traderSuccess + '\n';

       msg += 'TraderCode:' + response.traderCode + '\n';

        msg += 'TraderStatus:' + response.traderStatus + '\n';

        msg += 'Status:' + response.status + '\n';

       msg += 'ResponseText:' + response.responseText;

        alert(msg);
  }

    trader.onError = function (response) {
        var msg = '- onError -\n\n';

        msg += '\tStatus:' + response.status + '\n';

        msg += '\tResponseText:' + response.responseText;

        alert(msg);
    }

    trader.sendMessage({request:request});
}
// -->
</script>

onError

異常受信イベント

構文

function(response);

名前付き引数

名称説明
statusXMLHttpRequestオブジェクトのstatusプロパティ
※XMLHttpRequest仕様参照
Number
responseTextXMLHttpRequestオブジェクトのresponseTextプロパティ
※XMLHttpRequest仕様参照
String
// -->
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript'>
<!--
function onSend(url, request) {
  var trader = new StarWebPrintTrader({url:url});

  trader.onReceive = function (response) {
        var msg = '- onReceive -\n\n';

        msg += 'TraderSuccess:' + response.traderSuccess + '\n';

       msg += 'TraderCode:' + response.traderCode + '\n';

        msg += 'TraderStatus:' + response.traderStatus + '\n';

        msg += 'Status:' + response.status + '\n';

       msg += 'ResponseText:' + response.responseText;

        alert(msg);
  }

    trader.onError = function (response) {
        var msg = '- onError -\n\n';

        msg += '\tStatus:' + response.status + '\n';

        msg += '\tResponseText:' + response.responseText;

        alert(msg);
    }

    trader.sendMessage({request:request});
}
// -->
</script>