蓝牙标签打印机接入协议

文档目标

本文档用于描述得力蓝牙标签打印机设备的接入方式和SDK定义。

适用范围

本文档用于说明得力云平台对外提供的得力蓝牙标签打印机设备和云端打印应用服务接入方式,帮助和指导相关开发人员正确接入云平台。

接口设计

  • 接入流程

打印应用接入主要有两种途径:

1.  一是通过得力E+使用蓝牙连接设备,然后绑定相应应用服务;
2.  二是直接在App应用市场搜索并添加应用服务,然后扫描添加设备。
  • 蓝牙标签打印机功能

蓝牙标签打印机属于蓝牙设备,这里要求设备的蓝牙名称为设备的SN。由得力E+App使用蓝牙来连接设备,需要设备方提供Java版SDK,由服务端来完成打印/设置的报文转换,将报文传递给相关应用并通过蓝牙发送打印机来完成打印/设置功能。

需要SDK实现以下功能:

1. 固件升级;
2. 打印机信息查询(异常状态至少包含打印头过热、纸张状态、开合盖)
3. 打印;
4. 打印浓度设置(0-15);
5. 打印速度设置;
6. 打印纸张类型设置(便签纸、连续纸、黑标纸);
7. 恢复出厂设置。

关于固件升级,自身是无法联网检测固件版本以及下载固件。它使用蓝牙跟得力E+的便签纸打印应用连接,设备将SN、版本号等信息发送给应用,应用来判断是否需要升级,如果需要升级则下载好相应固件通过蓝牙再发送给设备。

  • 蓝牙标签打印应用功能

打印应用应至少具备以下功能:

1. 蓝牙标签打印机管理;
2. 打印模版管理;
3. 打印管理;

为了便于打印应用实现上述功能,平台应提供以下接口实现:

  • 应用安装通知

在组织管理员通过设备扫描或者主动安装应用时,平台会主动通过WebHook回调通知应用用户安装事件,回调应用指令为400。 考勤应用收到安装事件后,应启动初始化,通过数据同步指令507开始同步管理员数据。如果之前已有相关信息,则进行相应更新。

同样,当用户卸载删除了应用时,平台也会主动通知应用进行相应的数据清理操作,具体指令为401

  • 设备绑定通知

当应用绑定或者解绑某台打印设备时,平台会通过指令402403回调通知应用服务设备相关信息,应用服务可进行相应的处理操作。

  • 设备名称更新

平台会通过应用端回调指令404同步设备状态到应用端,包含设备的名称。应用端根据业务实际需求来更改内部设备名称。

  • JSAPI接口

应用端以网页方式嵌入APP时,需要通过原生APP访问相关数据,因此,需要提供基于JS的一套API库方便应用调用,具体接口定义见《第三方云应用JS-SDK API说明》文档

  • APP消息推送

应用服务可通过平台向终端用户APP推送消息。

具体接口实现可参考应用接入协议指令501

更新日志

  • 1.0 (2018-5-18)

    1. 完善文档,定义接口