Table of Contents
Installation and Usage
- Print Control - SpiritWeb
- Label Design - Designer
- Label Printing - SpiritLabel
- Registration Code Authorization
- Membership Authorization
- embeded Javascript
Development Manual
- JS API
- Dynamic Link Library
- REST API
- Third-party Website Integration
- Android Native SDK
- H5 APP
FAQ
打印精灵基本设置
配置入口
- SpiritWeb 通过systray菜单->控制台, 或浏览器打开http://127.0.0.1:9011 或 https://127.0.0.1:9443打开控制台
- SpiritDesktop 启动程序,通过设置菜单打开控制台
- SpiritCenter 浏览器打开http://127.0.0.1:9011/setup或https://127.0.0.1:9443/setup
配置打印机机
对Windows场景,多数情况下无需配置打印机, 打印/API调用时直接使用打印机名称即可。
以下场景,需设置打印机后方可使用。
- 配置网络打印机
- 设置打印机纸张类型
- 系统不能识别的新型号且打印机分辨率不是203DPI(8点/毫米)。
打印机名称
API调用时使用该名称,名称必须唯一,打印/API调用时使用该名称。
打印机类型
标签打印机一般支持均兼容斑马ZPL/CPCL打印机,请选择对应的指令集。如不清楚,请联系打印生产厂家。
如果打印机不支持上述指令集。则只能选择windows打印机,并安装相应的Windows打印驱动程序,
对于针试行打,可以通过printRaw()发送原始打印指令到打印机。
打印端口/打印机
可以选择Windows, USB/串口/并口或网络口打印机。
- 选择Windows。需要进一步选择已经安装的windows打印机。
- 选择USB端口。可以选择当前连接的USB打印机。
- 选择网络打印机, 需要进一步输入打印机IP地址和端口,格式为: IP:端口。 缺省端口为9100
分辨率
为打印机的打印分辨率, 如203DPI, 300DPI, 600DPI。对于windows打印机,该项设置无效。
附加参数
可以为打印机指定附加的参数, 如quality=[0,1,2]指定采用高速,平衡,高质量打印模式。 drv_image_binary : 指定使用二进制还是HEX格式的图片参数(对CPLC打印机有效),等等。
设置中心服务器(SpiritWeb)
为SpiritWeb配置中心服务器, 缺省情况下, SpiritWeb使用打印精灵官网为中心服务器, 也就是说: 在官网上获取标签模板, 在官网上获取打印授权许可。
SpiritWeb同时支持使用SpiritCenter作为中心服务器, 在指定的SpiritCenter上获取标签模板, 获取打印授权许可。该模式主要适用于内网, 一台SpiritCenter可以服务多台SpiritWeb, 形成企业内部的打印网络.
设置云打印服务(SpiritWeb)
开通云打印服务后, 打印精灵官网(或连接的SpiritCenter服务器)将对外暴露一个WebHook地址, 通过向本地址POST数据, 即可实现打印。方便对接各种第三方系统, 如WPS/飞书等多维表格, 丁丁宜搭/简道云低代码平台.
WebHook地址:
在线模式: `https://www.printspirit.cn/cloud/print/{云打印服务ID}?tpid={标签ID}&printer={打印机名称}`
SpritCenter: `https://SpriCente安装IP/cloud/print/{云打印服务ID}?tpid={标签ID}&printer={打印机名称}`
- 云打印服务ID 在线模式是开通云打印时自动产生的ID.
- 标签ID 是编辑标签保存后自动生成的ID
- 打印机名称 本机安装/配置的任何打印机的名称. 打印机名称可能有空格等字符, 需要urlencode.
开通云打印

如果账号符合条件,将生成一个云打印服务ID.

注意:云打印服务ID是访问云打印机的唯一凭证!任何人获得该ID,就可以控制你的打印机。为了安全,ID只显示一次, 务必记下来。 如忘记只能重新停止/启动生成新ID.
测试云打印机
最简单的验证方法是使用沙箱, 打开连接.
配置自定义字体 (Linux)
linux下使用SpiritCenter打印(包括或预览,移动打印)时, 需要在服务器上配置字体。否则无法正确显示选择的字体。
配置方式: 在安装目录下,添加字体配置文件(文件名font.json),格式示例如下:
1{
2 "fonts": {
3 "字魂古藤手书": "字魂古藤手书(商用需授权).ttf",
4 "字魂POP海报体": "字魂POP海报体(商用需授权).ttf",
5 "黑体": "msyh.ttc",
6 "OCR-B":"OCR-B.ttf",
7 "Arial": "/usr/share/fonts/truetype/arphic/ukai.ttc"
8 },
9 "maps":{
10 "楷体GB2312":["华文正楷","楷体"],
11 "微软雅黑":["文泉驿正黑","黑体"]
12 }
13}
核心配置分为, 字体列表(fonts)对象, 字体映射(maps)对象。
字体列表为字体名:字体文件路径对,字体文件可包含绝对路径或不含路径(此时文件需保存在安装目录的fonts子目录下)。字体文件支持ttf, ttc 格式
字体映射的每个项目是一个字体=>按优先级排序的替换字体列表。 打印时,如果字体不存在,将按顺序尝试用列表中字体替换。例子中,由于系统没有安装楷体GB2312字体,将尝试检查`华文楷体 ·是否存在,如果不存在,尝试"楷体", 如果也不存在,将使用缺省字体代替。
身份验证 (SpiritCenter)
SpiritCenter缺省关闭身份验证. 无需登陆均可编辑修改模板,
点击按钮添加用户后, 打开身份验证, 须登陆才能修改模板,
用户角色分为普通用户/管理员/第三方API三类:
- 普通用户: 就有编辑标签的权限
- 管理员 : 具有普通用户 + 创建新用户的权限
- 第三方API : 可以供第三方系统调用API, 用于第三方系统的嵌入对接.
第一个创建的用户自动为管理员角色.