QISHU DOCUMENT ARCHIVE
啓枢アーカイブ
製品ドキュメント、インターフェース資料、エンジニアリング記録の入口です。
sdk / prerequisites
導入前の確認
SDK 導入前に確認しておくべきデバイス、接続、業務情報。
導入前の確認の目的は、「このプリンターは実際にどう印刷するのか」を明確にすることです。NIB SDK は命令を構築し、connected device へ書き込み、必要に応じて応答を読み取ります。ただし、プリンターがどの Family に属するか、どの命令に対応しているか、現在の BLE でどの characteristic に書くべきかを自動判定するものではありません。
情報を早く確認しておくほど、クイックスタートは一度で通しやすくなります。
デバイス情報
Section titled “デバイス情報”| 項目 | 確認すること |
|---|---|
| デバイス型番 | 型番、ハードウェアバージョン、カスタムファームウェアの有無、Boxliy、Aryten、Lin8inch のどれに属するか。 |
| 命令対応 | プリンターが ESC、TSPL、CPCL のどれに対応しているか。SDK パッケージ名からプリンター能力を逆算しないでください。 |
| 用紙仕様 | レシート紙幅、ラベルサイズ、ギャップ、黒マーク、連続紙、カッターや剥離が必要か。 |
| エンコーディング要件 | テキストに GBK、UTF-8、その他 codepage が必要か。特に中国語印刷では確認が必要です。 |
| 画像/ラスタ | 画像、Logo、署名、ラスタ内容を印刷するか。画像処理は NIB の image/raster 基盤機能に基づきます。 |
| ステータス能力 | 用紙切れ、カバーオープン、電池残量、ファームウェアバージョン、シリアル番号などを読む必要があるか。また実機が本当にそのクエリに対応しているか。 |
| 印刷パラメーター | 速度、濃度、方向、部数、ラベル開始位置などの業務デフォルト値。 |
どの命令を選ぶかは、実機の対応状況を基準にしてください。一部のプリンターは特定の命令セットにしか対応していません。対応リストは、開発者、ハードウェア担当者、またはカスタマーサポートに確認してください。
| 接続 | 確認が必要なこと |
|---|---|
| BLE | service UUID、書き込み characteristic、読み取り/通知 characteristic、MTU または最大書き込み長、write with response かどうか、credit/通知ペースがあるか。 |
| クラシック Bluetooth | ペアリング方式、システム権限、socket の挙動、書き込みブロック、切断後の復旧。 |
| USB / WebUSB | ブラウザーまたはプラットフォームの認可、vendor/product フィルター、interface、endpoint、ユーザーによる手動デバイス選択が必要か。 |
| ネットワーク | host、port、接続タイムアウト、書き込みタイムアウト、再接続とリトライ戦略。 |
| ミニプログラム/クロスプラットフォームブリッジ | プラットフォーム API 名、権限ダイアログのタイミング、デバイス ID のライフサイクル、バックグラウンド/フォアグラウンド切り替え後の接続状態。 |
接続層が最終的に生成すべきものは connected device であり、印刷テンプレートが直接呼び出すプラットフォームの生オブジェクトではありません。
| 項目 | 確認すること |
|---|---|
| 対象プラットフォーム | TypeScript、Dart、Java、Objective-C、Swift のうち、実際にどれを提供するか。 |
| 印刷内容 | レシート、ラベル、バーコード、QR コード、画像、一括ジョブ、または単純なテキストだけか。 |
| セッション戦略 | 印刷前に一時接続するか、接続を維持するか。失敗後に自動リトライするか。 |
| ステータス読み取り | 印刷前/後にステータス読み取りが必須か。応答がない場合に業務上どう扱うか。 |
| ログ要件 | 接続、バイト長、分割進捗、ステータス応答、エラー理由を記録するか。 |
| オフライン能力 | 印刷ジョブをキャッシュするか。接続復旧後にどう再印刷するか。 |
これらの情報によって、SDK 導入時に言語ページ、接続ページ、フロー制御とステータス読み取りページのどれを優先して読むべきかが決まります。
よくある症状
Section titled “よくある症状”| 不足または誤った事実 | よくある症状 | 次の手順 |
|---|---|---|
| 命令ファミリーの選択ミス | デバイスへの書き込みはあるが印刷されない、または生のコマンド文字列が印刷される。 | デバイス資料に戻り、プリンターが ESC、TSPL、CPCL のどれに対応しているかを確認します。 |
| 用紙仕様が合っていない | ラベルがずれる、半分だけ印刷される、連続排紙される、黒マーク/ギャップ位置決めに失敗する。 | 紙幅、ラベル高さ、gap/black mark/continuous 設定を確認します。 |
| BLE characteristic が誤っている | 接続は成功するが書き込みに失敗する、または書き込み成功後も反応がない。 | service、write、read/notify characteristic を照合し、別 characteristic の自動選択を許可するか確認します。 |
| 分割サイズが大きすぎる | 小さなデータは印刷できるが、大きなテンプレートや画像が失敗する。 | MTU またはプラットフォームの最大書き込み長に基づいて chunk size を設定します。 |
| エンコーディング不一致 | 英文は正常だが、中国語が文字化けする、または欠字する。 | プリンターの codepage を確認し、対応するビルダー/エンコーディング設定を選びます。 |
| ステータス能力に非対応 | クエリがタイムアウトする、または応答を解析できない。 | プリンターと現在の命令ファミリーがそのステータスクエリに対応しているか確認します。 |