啟樞科技文檔

啟樞檔案館

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

commands / tspl/boxliy

TSPL Boxliy

TsplBoxliy 支持的 TSPL 指令清單。

TsplBoxliy 是 NIB TSPL 指令的基礎 Family，適合需要明確頁面尺寸、坐標和模板元素的標籤打印。

Boxliy 命令清单

具体机器支持哪些协议、Family 和参数值，需要以目标机器固件为准；机器支持列表请联系开发人员或客服确认。

SDK 方法	实际指令	参数	作用	返回 / 备注
`size(width, height)` 纸张 / 介质	`SIZE {width} mm,{height} mm`	width/height: 标签尺寸，单位 mm。	设置标签尺寸。	-
`gap(height, offset) / label(...)` 纸张 / 介质	`GAP {height} mm,{offset} mm`	height/offset: 间隙和偏移。	设置间隙标签。	-
`bline(height, offset)` 纸张 / 介质	`BLINE {height} mm,{offset} mm`	height/offset: 黑标高度和偏移。	设置黑标纸。	-
`continuous()` 纸张 / 介质	`CONTINUOUS / GAP 0 mm,0 mm`	-	设置连续纸。	不同 SDK 输出略有差异。
`cls()` 打印与版面	`CLS`	-	清空打印缓冲区。	-
`direction(rotation, mirror)` 打印与版面	`DIRECTION {rotation},{mirror}`	rotation、mirror。	设置打印方向和镜像。	-
`reference(x, y)` 打印与版面	`REFERENCE {x},{y}`	x/y: 参考点。	设置坐标原点。	-
`offset(mm)` 打印与版面	`OFFSET {mm} mm`	mm: 偏移量。	设置整体偏移。	-
`shift(dots)` 打印与版面	`SHIFT {dots}`	dots: 点数偏移。	设置横向位移。	-
`speed(speed)` 打印与版面	`SPEED {speed}`	speed: 打印速度。	设置速度。	-
`density(density)` 打印与版面	`DENSITY {density}`	density: 浓度。	设置浓度。	-
`codePage(codePage)` 设备设置	`CODEPAGE {value}`	codePage: 代码页。	设置字符代码页。	Java SDK 暴露；Lin8inch 另有 gbkCodepage/utf8Codepage。
`gapSensor(enabled)` 设备设置	`SET GAP ON\|OFF`	enabled: 是否启用。	开关间隙传感器。	Java SDK 暴露。
`ribbon(enabled)` 设备设置	`RIBBON ON\|OFF / SET RIBBON ON\|OFF`	enabled: 是否启用碳带。	设置碳带模式。	-
`cut(enabled)` 设备设置	`SET CUTTER 1\|0 / SET CUTTER ON\|OFF`	enabled: 是否启用切刀。	设置切刀。	-
`tear(enabled)` 设备设置	`SET TEAR ON\|OFF`	enabled: 是否启用撕纸。	设置撕纸模式。	-
`peel(enabled)` 设备设置	`SET PEEL ON\|OFF`	enabled: 是否启用剥离。	设置剥离模式。	-
`bar(...)` 打印与版面	`BAR {x},{y},{width},{height},{line}`	x/y、宽高、线型。	绘制 TSPL 条块。	TypeScript SDK 暴露。
`line(...)` 打印与版面	`LINE {x1},{y1},{x2},{y2},{width}`	起止点和线宽。	绘制线条。	-
`box(...)` 打印与版面	`BOX {x1},{y1},{x2},{y2},{width},{radius}`	矩形范围、线宽、圆角。	绘制矩形。	-
`circle(...)` 打印与版面	`CIRCLE {x},{y},{radius},{width}`	圆心、半径、线宽。	绘制圆。	-
`ellipse(...)` 打印与版面	`ELLIPSE {x},{y},{width},{height},{lineWidth}`	位置、宽高、线宽。	绘制椭圆。	-
`text(...)` 打印与版面	`TEXT {x},{y},"{font}",{rotation},{xMul},{yMul},"{content}"`	坐标、字体、旋转、缩放、内容。	打印单行文本。	-
`textBox(...)` 打印与版面	`TEXTBOX {x},{y},"{font}",{rotation},{xMul},{yMul},{width}[,L{lineSpace}][,B1][,D{rotation}],"{content}"`	文本框参数。	打印多行文本框。	TypeScript SDK 暴露。
`barcode(...)` 打印与版面	`BARCODE {x},{y},"{type}",{height},{show},{rotation},{cellW},{cellW},"{content}"`	条码类型、高度、显示方式、旋转、宽度、内容。	打印一维条码。	-
`qrcode(...)` 打印与版面	`QRCODE {x},{y},{level},{cellWidth},A,{rotation},M2,S7[,V{version}],"{content}"`	纠错等级、单元宽度、旋转、版本、内容。	打印二维码。	-
`dmatrix(...)` 打印与版面	`DMATRIX {x},{y},{width},{height},"{content}"`	坐标、宽高、内容。	打印 Data Matrix。	-
`image(...)` 图片与图形	`BITMAP {x},{y},{byteWidth},{height},{mode},{bitmap}`	图片、坐标、阈值、反色、压缩、模式。	发送位图到页面。	压缩模式使用 mode 3 并附加数据长度。
`downloadBmp(fileName, data)` 图片与图形	`DOWNLOAD "{fileName}",{length},{data}`	文件名和图片数据。	下载位图到设备。	TypeScript SDK 暴露。
`putImage(...)` 图片与图形	`PUTBMP {x},{y},"{fileName}",{contrast},{brightness}`	坐标、文件名、对比度、亮度。	打印已下载图片。	TypeScript SDK 暴露。
`detect()` 状态查询	`SELFTEST PATTERN`	-	执行自检图样。	Java SDK 暴露。
`readState()` 状态查询	`READSTA`	-	读取状态。	-
`status() / state()` 状态查询	`STATUS`	-	查询状态。	-
`realtimeStatus()` 状态查询	`1B 21 3F`	-	查询实时状态。	Java SDK 暴露。
`querySerialNumber()` 设备信息	`READC PRDOCUTID`	-	读取产品 ID/序列相关信息。	按源码保留 PRDOCUTID 拼写。
`sn() / sns()` 设备信息	`SN?`	-	查询序列号。	-
`queryVersion()` 设备信息	`READC VERSION`	-	读取版本信息。	-
`version() / versions()` 设备信息	`VERSION`	-	查询版本。	-
`queryModel()` 设备信息	`READC MDDLE`	-	读取型号信息。	按源码保留 MDDLE 拼写。
`model() / models()` 设备信息	`MODEL?`	-	查询型号。	-
`batteryVolume()` 状态查询	`READC BATTERY_LEVEL`	-	查询电量。	-
`print(copies) / print(sets, copies)` 打印与版面	`PRINT {sets},{copies}`	份数和套数。	触发打印。	-
`raw(...)` 组合方法 / 别名	`调用方提供的 TSPL 文本。`	template/args。	发送未封装的 TSPL 指令。	-