サポート&ダウンロード

お客様が開発した Web アプリ/ネイティブアプリから、印刷仲介アプリである iOS/Android™版 Smooth Print を呼び出してプリンターにラベル/レシート印刷を行なう

概要

Smooth Print は、モバイル端末(iPhone/iPad、Android™)向け印刷仲介アプリです。
お客さまが開発した Web アプリ/ネイティブアプリから、URL スキームを用いて Smooth Print を呼び出すことで、簡単にラベル/レシート印刷を行なうことができます。

  • * iOS 版 Smooth Print は、AppStore からダウンロードが可能です。
  • * Android™ 版 Smooth Print は、開発者向け情報サイトからダウンロードが可能です。

設定手順概要

<管理者の手順>

<利用者の手順>

  1. [4] 利用者は Smooth Print をインストールし、プリンターとの接続設定を行ないます。管理者からの案内手順に従い Web アプリ/ネイティブアプリを操作することで、URL スキームを用いて Smooth Print を呼び出してラベル/レシート印刷を行ないます。

システム構成図

システム構成図

*Smooth Print は、URL スキームによる発行指示により、テンプレートファイルと用紙情報ファイルをダウンロードします。
Smooth Print は、URL スキームに含まれる各値(テキスト/バーコード、部数)をテンプレートファイルに反映して発行を行ないます。

設定手順(詳細)

[1] 管理者は、Windows PC を用いて Smooth Print が使用するテンプレートファイルと用紙情報ファイルを用意します。

<テンプレートファイル (lbx) の作成方法>
  1. a. P-touch Editor を起動してレイアウトを作成します。
    lbxファイルの作成例
  2. b. レイアウト上に作成したテキストやバーコードにそれぞれ、オブジェクト名を設定します。
    lbxファイルの作成例
  3. c. P-touch Editor のメニュー [ファイル] - [名前を付けて保存] から、テンプレートファイルとして lbx ファイルを保存します。
<用紙情報ファイル (bin) の作成方法>
  1. カスタム用紙設定ツールを起動します。
    カスタム用紙サイズを作成後、[オプション] ボタンをクリックし、"コマンドファイルに保存…" を選択してコマンドファイル(bin 形式)を保存します。
    カスタム用紙設定ツール
    注) 用紙情報ファイルは、モデル毎に作成する必要があります。

[2] 管理者は、テンプレートファイルと用紙情報ファイルを Web サーバー (http) へ置きます。

[3] 管理者が用意する Web アプリに、Smooth Print を呼び出すための URL スキームを組み込みます。

  • URL スキームは次の形式で指定します。青文字は任意のパラメータです。

    <URLスキーム>

    brotherwebprint://print?filename=テンプレート&size=用紙情報&copies=部数&text_オブジェクト名=テキスト&barcode_オブジェクト名=バーコード
     
       URLスキーム記述例  
  •   
  • テンプレートと用紙情報は、以下を設定します。設定値は全て URL エンコーディング を行なう必要があります。

    <必須パラメータ>

    パラメータ名 設定可能な値 設定値の例
    テンプレート テンプレートファイル (lbx)
    ・ローカルパスもしくはインターネット上のパスを設定する
    <ローカルパスの場合> file.lbx
    <インターネット上のパスの場合>
    http%3A%2F%2Fexample.com%2F%E3%82%B5%E3%83%B3%
    E3%83%97%E3%83%AB.lbx
    用紙情報 用紙情報ファイル (bin)
    ・ローカルパスもしくはインターネット上のパスを設定する
    <ローカルパスの場合> 26x76.bin
    <インターネット上のパスの場合> http%3A%2F%2Fexample.com%2F%E3%82%B5%E3%83%B3%
    E3%83%97%E3%83%AB.bin

    *1: あらかじめ他アプリから OS 標準のファイル共有機能でテンプレートファイル (lbx) や用紙情報ファイル (bin) を Smooth Print にダウンロードしておきたい場合、共有先のアプリとして Smooth Print が選択可能です。ファイルを共有済みの場合はファイル名のみの指定で印刷が可能です。


    <任意パラメータ>

    [部数][データ指定] の部分に、以下のパラメータを設定します。

    パラメータ名 対象 設定値の例
    copies 印刷部数 (数値を設定します。デフォルトは1です) 1
    text_オブジェクト名 テキストオブジェクトのテキスト (文字列を設定します) サンプル
    barcode_オブジェクト名 バーコードオブジェクトのデータ (文字列を設定します) 12345

    注1) text_オブジェクト名と barcode_オブジェクト名の場合、オブジェクト名には、P-touch Editor でレイアウト上に作成したテキストやバーコードにそれぞれ設定したオブジェクト名を入力します。
    例えば、"TEXT" というオブジェクト名のテキストに文字列を入力して印刷したい場合、パラメータ名は text_TEXT となります。

    注2) 同じパラメータ名が複数定義されている場合、最後に定義されたパラメータ値が採用されます。 パラメータによるデータの変更指示は、オブジェクトタイプ(テキストまたはバーコード)およびオブジェクト名が一致する全てのオブジェクトに対して適用します。

    URL エンコーディング

    パラメータの値は UTF-8 で符号化し、コロンやスラッシュを含めて URL エンコードを行なう必要があります。 上記の filename の 2 行目の例では、エンコード前の値は http://example.com/サンプル.lbx となります。

    注) ファイル名は大文字・小文字を区別します。ただし Android™ のローカルパスは大文字・小文字を区別しないため、大文字・小文字のみが異なるファイルが存在した場合、そのファイルを使用します。

仕様

対応モデル一覧

対応 OS
iOS Android™
Bluetooth® (MFi) Wi-Fi® Bluetooth® Wi-Fi®
TD-4550DNWB
TD-4420DN × ×
TD-2130N/2130NSA ×
RJ-4250WB
RJ-4230B × ×
RJ-3250WB
RJ-3230B × ×
RJ-3150Ai
RJ-3150 ×
RJ-2150
RJ-2140 × ×

対応インタフェース

  • iOS:Bluetooth (MFi)、Wi-Fi
  • Android™:Bluetooth、Wi-Fi

注)Bluetooth は Classic のみ対応、BLE は非対応。

動作環境

iOS: iOS 14.1 以上
Android™: Android™ OS 8.0 以上

Smooth Print で定義するエラーコード一覧

エラーコード 発生条件 発生時に表示するトースト
SUCCESS 印刷に成功した場合 なし
PRINT_CANCEL 印刷をキャンセルした場合 なし
ERROR_PRINTER_NO_SETTING 印刷準備開始時、プリンターが未選択、もしくは未設定の場合 プリンター未設定アラート
ERROR_INVALID_SCHEME_PARAMETER URL スキームの必須パラメータが指定されていない場合 パラメータ不正アラート
ERROR_NO_PRINT_DATA,
ERROR_OPEN_LBX_FAILED
印刷対象の取得に失敗した場合、または取得した LBX ファイルが開けなかった場合 印刷ファイルなしアラート
ERROR_NO_CUSTOM_PAPER_FILE 用紙情報ファイルの取得に失敗した場合 用紙情報ファイルなしアラート
NO_FILES_ACCESS_PERMISSION (端末の内部ストレージに保存された印刷対象ファイル、もしくは用紙情報ファイルを指定した場合のみ)本アプリに端末内ストレージへのアクセス権限が付与されていない場合 印刷ファイルなしアラートもしくは用紙情報ファイルなしアラート
DIALOG_CLOSE 印刷処理の完了前に印刷中画面を閉じた場合 なし
ERROR_UNKNOWN 上記以外のエラーが発生した場合 印刷中アラート一覧内システムエラーアラート「原因不明のエラーが発生しました」

Brother Print SDK のエラーコード

プリンターとの接続処理および印刷処理は Brother Print SDK を利用しています。 Brother Print SDK 内でエラーが発生した場合は、取得したエラーコードをそのまま起動元アプリに返します。
発生するエラーコードについては、Brother Print SDK のマニュアルをご参照ください。
https://support.brother.co.jp/j/s/support/html/mobilesdk/reference/android/printerinfo.html#errorcode

ダウンロード

* apkファイルをダウンロード後、手動で Android™ 端末にインストールしてください。
* iOS 版 Smooth Print は AppStore からダウンロードが可能です。

サポート&ダウンロード