Skip to content
啟樞科技文檔

啟樞檔案館

這裡是後續撰寫產品文檔的入口頁。左側負責文檔分類與章節層級,右側保留正式文檔正文、提示塊、程式碼、表格與上一頁 / 下一頁的位置。

sdk / prerequisites

接入前確認

SDK 接入前需要確認的裝置、連線和業務資訊。

接入前確認的目標是把“這台機器到底怎麼列印”說清楚。NIB SDK 負責建構指令、寫入 connected device、在需要時讀取回包;它不會自動判斷機器屬於哪個 Family、支援哪種指令,或目前 BLE 應該寫哪個 characteristic。

資訊越早確認,快速開始越容易一次跑通。

專案 要確認什麼
裝置型號 型號、硬體版本、是否定製韌體,以及它屬於 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/通知節奏。
經典藍牙 配對方式、系統權限、socket 行為、寫入阻塞和斷線恢復。
USB / WebUSB 瀏覽器或平台授權、vendor/product 過濾、介面、端點、是否需要使用者手動選擇裝置。
網路 host、port、連線逾時、寫入逾時、重連和重試策略。
小程式/跨端橋接 平台 API 名稱、權限彈窗時機、裝置 ID 生命週期、背景/前景切換後的連線狀態。

連線層最終要產出的是 connected device,而不是列印範本能直接呼叫的平台原始物件。

專案 要確認什麼
目標平台 TypeScript、Dart、Java、Objective-C、Swift 中實際交付哪一種。
列印內容 收據、標籤、條碼、QR Code、圖片、批次任務,還是隻列印簡單文字。
會話策略 列印前臨時連線,還是保持連線;失敗後是否自動重試。
狀態讀取 是否必須在列印前/後讀取狀態;沒有回包時業務如何處理。
日誌要求 是否記錄連線、位元組長度、分片進度、狀態回包和錯誤原因。
離線能力 是否快取列印任務,以及恢復連線後如何補打。

這些資訊決定 SDK 接入時應該優先看語言頁面、連線頁面,還是流控和狀態讀取頁面。

缺少或錯誤的事實 常見症狀 下一步
選錯指令族 裝置有寫入但不列印,或列印出原始命令文字。 回到裝置資料,確認機器支援 ESC、TSPL 還是 CPCL。
紙張規格不對 標籤偏移、只打一半、連續吐紙、黑標/間隙定位失敗。 確認紙寬、標籤高度、gap/black mark/continuous 設定。
BLE characteristic 錯誤 連線成功但寫入失敗,或寫入成功沒有任何反應。 核對 service、write、read/notify characteristic,並確認是否允許自動選擇不同 characteristic。
分片過大 小資料能打,大範本或圖片失敗。 根據 MTU 或平台最大寫入長度設定 chunk size。
編碼不匹配 英文正常,中文亂碼或缺字。 確認機器 codepage,並選擇對應建構器/編碼設定。
狀態能力不支援 查詢逾時,或回包無法被解析。 確認機器和目前指令族是否支援該狀態查詢。