Star webPRNT User's Manual

Star webPRNT SDK

このSDKには、HTMLファイルとJavaScriptファイルがパッケージされています。

HTMLファイルは、WebブラウザーからStar webPRNT機能を利用して印刷するまでの一連の記載方法を紹介するサンプルプログラムです。
実際に動かしながら、プリンターの制御方法を確認してください。

JavaScriptファイルは、スター精密が提供するStar webPRNT機能組み込み用ライブラリファイルです。
変更は行わないでください。HTMLファイルから読み込んで使用します。

システム構築例

Star webPRNT対応 Starプリンター

※ 手順にマウスを合わせることで、イラストが変化します。


 

Star webPRNT Browser + Star Bluetooth®プリンター

※ 手順をタップすることで、イラストが変化します。


プログラムファイルリスト

HTMLファイル

名称説明
ComparisonReceiptDesign.htmlデバイスフォントおよびCanvas描画による印刷が行えることを確認します。

JavaScriptファイル

名称説明
StarWebPrintBuilder.jsStar webPRNT送信エレメントを生成します。
StarWebPrintTrader.jsStar webPRNT送信エレメント列を送信したり、受信したStar webPRNT受信エレメント列から状態を確認/抽出します。
StarBarcodeEncoder.jsHTML5 Canvas 2Dコンテキストへのバーコード描画を補うバーコードモジュール列を生成します。
StarWebPrintExtManager.jsバーコードリーダーやプリンターステータスの監視を、StarWebPRNTExtManager送信エレメント列やStarWebPRNTExtManager受信エレメント列を通して行います。
StarWebPrintDisplayBuilder.jsStar webPRNT Display送信エレメントを生成します。

* JavaScriptファイルは、Star webPRNT機能組み込み用ライブラリファイルです。変更は行わないでください。HTMLファイルから読み込んで使用します。


Webサーバへの登録

Webサーバの運用マニュアルを参考にサンプルプログラム一式を公開フォルダ用にコピーします。

使用方法

Star HE07x/08xインターフェイスプリンター、mC-Print2/3、TSP100IV

  1. Webブラウザーで公開したComparisonReceiptDesign.htmlを開き、JavaScript/Canvasのサポートに問題のないことを確認します。
    ComparisonReceiptDesign エラー画面

    * "Your browser does not support JavaScript!"と表示された場合には、お使いのWebブラウザーのJavaScript設定が無効になっていますので、JavaScriptを有効に変更してください。

    * "Your browser does not support Canvas!"と表示された場合には、Canvas機能に対応したWebブラウザーへ変更してください。

  2. Star webPRNTエンドポイントURLをプリンターのIPアドレスに合わせて編集します。

    Webアプリをhttpsで公開する場合、Webアプリからプリンターへの印刷データのリクエストをSSL/TLSによるhttps暗号化通信で行ってください。

    例)https://192.168.1.100/StarWebPRNT/SendMessage

    印刷データのリクエストを暗号化無しのhttp通信で行うと、ブラウザーのクロススキーム(https ⇔ http)の制限によりリクエストが失敗し、印刷が行えません。

    ComparisonReceiptDesign 設定画面

    mC-Print2/3 と TSP100IVは印刷処理のみで利用する場合、SSL/TLS通信に対応しています。
    また、HE07x/08xはインターフェイスのシャーシ部に”S"マークが刻印されていればSSL/TLS通信に対応しています。

    SSL/TLSによるHTTPS暗号化通信を行うには、プリンターと利用するブラウザー双方に証明書の設定が必要です。 設定方法は下記を参照してください。
  3. Send(API)ボタンでデバイスフォントによる印刷が行えることを確認します。
  4. Send(Canvas)ボタンでCanvas描画による印刷が行えることを確認します。

クライアント端末側の証明書の設定

プリンターで設定した自己署名証明書や自分で発行したCA署名証明書を利用する場合、 クライアント端末側で証明書の設定が必要です。

Windows10(Edge)


Self-Signed Certificate(自己署名証明書)ファイルの指定

  1. 使用するプリンターの設定画面(Web Configration)から証明書をダウンロードする。

    ※事前にプリンター側の設定を行ってください。

  2. ポップアップメニューから[開く]をクリックする。
  3. [開く]をクリックする。
  4. ダウンロードした証明書ファイルを指定して”証明書のインポートウィザード”が開きます。
  5. 証明書のインポートを行う。
  6. 証明書のインポート



CA-Signed Certificate(CA証明書)ファイルの指定

  1. [コントロールパネル]-[インターネットオプション] を開き、「コンテンツ」タブの”証明書”をクリックする。
  2. 「信頼されたルート証明機関」タブを選択して[インポート]をクリックする。
  3. [次へ]をクリックする。
  4. [参照]をクリックしてCA証明書ファイルを指定する。
  5. 証明書のインポートを行う。
  6. 証明書のインポート



証明書のインポート

  1. [次へ]をクリックする。
  2. 「証明書をすべて次のストアに配置する」を選択して[参照]をクリックする。
  3. ”信頼されたルート証明機関”を選択して[OK]をクリックする。
  4. [次へ]をクリックする。
  5. [完了]をクリックすると証明書がインポートされます。
  6. 警告の内容に問題がなければ[はい]をクリックする。
  7. [OK]をクリックするとウィザードを終了します。
  8. 信頼されたルート証明機関リストにインポートした証明書が追加されています。
    [閉じる]をクリックして設定は完了です。
    プリンターの電源を再投入し、"https:⁄⁄"で始まるアドレスにてプリンターのWeb画面にアクセスできることを確認してください。

iOS(Safari)

iOS端末で証明書の設定を行う場合、Safariを使用して証明書のダウンロードを行ってください。

  1. 証明書のダウンロードを行うと、以下のメッセージが表示されます。
    [許可]をタップします。
  2. [閉じる]をタップします。
  3. 設定画面を開き、[プロファイルがダウンロードされました]をタップします。
  4. ”インストール”をタップします。
  5. パスコードを入力します。
  6. ”インストール”をタップします。
  7. [インストール]をタップします。
  8. [完了]をタップします。証明書のインストールが完了しました。
  9. 続けて証明書の信頼設定を行います。
    設定画面を開き、[一般]-[情報]-[証明書信頼設定]を開きます。
  10. インストールした証明書のスイッチを[ON]にします。
  11. 警告メッセージを確認して問題がなければ[続ける]をタップします。
  12. 以上で証明書の設定は完了です。
    プリンターの電源を再投入し、"https:⁄⁄"で始まるアドレスにてプリンターのWeb画面にアクセスできることを確認してください。


Android(Google Chrome)

  1. 証明書のダウンロードを行うと、以下のメッセージが表示されます。
    証明書の名前(任意)を指定して[OK]をタップします。
  2. 設定画面を開き、"セキュリティ"をタップします。
  3. ”暗号化と認証情報”をタップします。
  4. ”ストレージからのインストール”をタップします。
  5. ダウンロードした認証書ファイル「StarCertificate.cer.crt」をタップします。
    証明書のインストールが行われます。
  6. [設定]-[セキュリティ]-[暗号化と認証情報]から”信頼できる認証情報”を開いて認証状況を確認します。
  7. ”ユーザー”タブを開き、インストールした認証情報をタップします。
  8. インストールした証明書の内容が表示されます。
    以上で証明書のインストールは完了です。
    プリンターの電源を再投入し、"https:⁄⁄"で始まるアドレスにてプリンターのWeb画面にアクセスできることを確認してください。


URLスキームによるStar webPRNT Browserの起動 (iOS/Android)

URLスキームによりStar webPRNT Browserを起動することができます。また、開きたいURLを指定することで、起動したStar webPRNT Browserは指定されたページを開きます。

単にStar webPRNT Browserを起動させたい場合、iOSの場合は(A)、Androidの場合は(A)と(B)を指定してください。

Star webPRNT Browserを起動させ、指定されたURLを開きたい場合、(A)-(E)全体を指定してください。

(E)のURLはパーセントエンコーディングを行ってください。 例えば、https://starmicronics.com/を開きたい場合、URLスキームはwebprnt://starmicronics.com/open?url=https%3A%2F%2Fstarmicronics.com%2Fとなります。

URL Scheme
  • webprnt://
  • starmicronics.com
  • /open
  • ?url=
  • [URL] - Star webPRNT Browserで開きたいURL

Star webPRNT Browser (iOS/Android) のユーザエージェント

Star webPRNT Browserでは、一般的なブラウザーと区別するためにユーザーエージェントに次の文字列が含まれています。 Star webPRNT Browserと一般的なブラウザーとを区別したい場合は、下記文字列をご利用ください。

StarWebPRNTBrowser/X.X.X

※X.X.Xには、バージョン名が記載されます。(例:3.4.0の場合は、StarWebPRNTBrowser/3.4.0)

iOS版 Star webPRNT Browserバージョンアップに伴うお願い

Apple社の指針* に従い、iOS版 Star webPRNT BrowserのブラウザーエンジンをUIWebViewからWKWebViewに変更します。


iOS版 Star webPRNT Browser Ver3.6.0(2020年6月リリース)より、上記変更を行っています。

この変更により、Webコンテンツの描画結果やJavascriptの挙動などに差異が発生する可能性があります。 あらかじめご留意ください。


併せて、変更後のiOS版 Star webPRNT Browser(Ver3.6.0以降)を利用する際には、下記バージョンのJavaScriptライブラリに差し替えをお願いします。

なお、下記バージョン未満のJavascriptライブラリでは印刷が行えません。


 StarWebPrintTrader.js Ver.1.0.1以降
 StarWebPrintExtManager.js  Ver.1.2.0以降

※StarWebPRNT_WebContents_V1.6.0.zip以降に同梱されています。
 StarWebPRNT_WebContentsのダウンロードは以下のサイトから行ってください。

このバージョンのJavaScriptは既存のStar webPRNT Browser(Ver3.6.0未満)にも対応しています。

Apple社のニュースリリース
 https://developer.apple.com/jp/news/?id=12232019b