启枢科技文档
启枢档案馆
这里是后续撰写产品文档的入口页。左侧负责文档分类与章节层级,右侧保留正式文档正文、提示块、代码、表格与上一页 / 下一页的位置。
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 中实际交付哪一种。 |
| 打印内容 | 小票、标签、条码、二维码、图片、批量任务,还是只打印简单文本。 |
| 会话策略 | 打印前临时连接,还是保持连接;失败后是否自动重试。 |
| 状态读取 | 是否必须在打印前/后读取状态;没有回包时业务如何处理。 |
| 日志要求 | 是否记录连接、字节长度、分片进度、状态回包和错误原因。 |
| 离线能力 | 是否缓存打印任务,以及恢复连接后如何补打。 |
这些信息决定 SDK 接入时应该优先看语言页面、连接页面,还是流控和状态读取页面。
| 缺少或错误的事实 | 常见症状 | 下一步 |
|---|---|---|
| 选错指令族 | 设备有写入但不打印,或打印出原始命令文本。 | 回到设备资料,确认机器支持 ESC、TSPL 还是 CPCL。 |
| 纸张规格不对 | 标签偏移、只打一半、连续吐纸、黑标/间隙定位失败。 | 确认纸宽、标签高度、gap/black mark/continuous 设置。 |
| BLE characteristic 错误 | 连接成功但写入失败,或写入成功没有任何反应。 | 核对 service、write、read/notify characteristic,并确认是否允许自动选择不同 characteristic。 |
| 分片过大 | 小数据能打,大模板或图片失败。 | 根据 MTU 或平台最大写入长度设置 chunk size。 |
| 编码不匹配 | 英文正常,中文乱码或缺字。 | 确认机器 codepage,并选择对应构建器/编码设置。 |
| 状态能力不支持 | 查询超时,或回包无法被解析。 | 确认机器和当前指令族是否支持该状态查询。 |