QISHU DOCUMENT ARCHIVE
Qishu Archives
제품 문서, 인터페이스 자료, 엔지니어링 기록을 위한 공통 입구입니다.
commands / tspl/boxliy
TSPL Boxliy
TsplBoxliy가 제공하는 TSPL 명령.
TsplBoxliy is the base NIB TSPL family for label pages that need explicit size, coordinates, and template elements.
Boxliy Command list
The supported protocols, families, and parameter values depend on the target firmware. Ask engineering or support for the printer support list.
| SDK method | Emitted command | Parameters | Purpose | Response / notes |
|---|---|---|---|---|
size(width, height)Paper and media | SIZE {width} mm,{height} mm | width/height: label size in mm. | Sets label size. | - |
gap(height, offset) / label(...)Paper and media | GAP {height} mm,{offset} mm | height/offset: gap and offset. | Sets gap-label media. | - |
bline(height, offset)Paper and media | BLINE {height} mm,{offset} mm | height/offset: black-mark height and offset. | Sets black-mark media. | - |
continuous()Paper and media | CONTINUOUS / GAP 0 mm,0 mm | - | Sets continuous media. | Output differs slightly by SDK. |
cls()Print and layout | CLS | - | Clears print buffer. | - |
direction(rotation, mirror)Print and layout | DIRECTION {rotation},{mirror} | rotation, mirror. | Sets direction and mirror mode. | - |
reference(x, y)Print and layout | REFERENCE {x},{y} | x/y: reference origin. | Sets coordinate origin. | - |
offset(mm)Print and layout | OFFSET {mm} mm | mm: offset. | Sets global offset. | - |
shift(dots)Print and layout | SHIFT {dots} | dots: dot offset. | Sets horizontal shift. | - |
speed(speed)Print and layout | SPEED {speed} | speed: print speed. | Sets speed. | - |
density(density)Print and layout | DENSITY {density} | density: density. | Sets density. | - |
codePage(codePage)Device settings | CODEPAGE {value} | codePage: code page. | Sets character code page. | Exposed by Java; Lin8inch also has gbkCodepage/utf8Codepage. |
gapSensor(enabled)Device settings | SET GAP ON|OFF | enabled: on/off. | Turns gap sensing on or off. | Exposed by Java. |
ribbon(enabled)Device settings | RIBBON ON|OFF / SET RIBBON ON|OFF | enabled: ribbon on/off. | Sets ribbon mode. | - |
cut(enabled)Device settings | SET CUTTER 1|0 / SET CUTTER ON|OFF | enabled: cutter on/off. | Sets cutter mode. | - |
tear(enabled)Device settings | SET TEAR ON|OFF | enabled: tear on/off. | Sets tear mode. | - |
peel(enabled)Device settings | SET PEEL ON|OFF | enabled: peel on/off. | Sets peel mode. | - |
bar(...)Print and layout | BAR {x},{y},{width},{height},{line} | x/y, size, line style. | Draws a TSPL bar. | Exposed by TypeScript. |
line(...)Print and layout | LINE {x1},{y1},{x2},{y2},{width} | Start/end points and width. | Draws a line. | - |
box(...)Print and layout | BOX {x1},{y1},{x2},{y2},{width},{radius} | Box bounds, width, radius. | Draws a box. | - |
circle(...)Print and layout | CIRCLE {x},{y},{radius},{width} | Center, radius, line width. | Draws a circle. | - |
ellipse(...)Print and layout | ELLIPSE {x},{y},{width},{height},{lineWidth} | Position, size, line width. | Draws an ellipse. | - |
text(...)Print and layout | TEXT {x},{y},"{font}",{rotation},{xMul},{yMul},"{content}" | Position, font, rotation, scale, content. | Prints single-line text. | - |
textBox(...)Print and layout | TEXTBOX {x},{y},"{font}",{rotation},{xMul},{yMul},{width}[,L{lineSpace}][,B1][,D{rotation}],"{content}" | Text box parameters. | Prints text inside a box. | Exposed by TypeScript. |
barcode(...)Print and layout | BARCODE {x},{y},"{type}",{height},{show},{rotation},{cellW},{cellW},"{content}" | Barcode type, height, display mode, rotation, width, content. | Prints a 1D barcode. | - |
qrcode(...)Print and layout | QRCODE {x},{y},{level},{cellWidth},A,{rotation},M2,S7[,V{version}],"{content}" | Correction level, cell width, rotation, version, content. | Prints a QR code. | - |
dmatrix(...)Print and layout | DMATRIX {x},{y},{width},{height},"{content}" | Position, size, content. | Prints a Data Matrix code. | - |
image(...)Images and graphics | BITMAP {x},{y},{byteWidth},{height},{mode},{bitmap} | Image, position, threshold, reverse, compression, mode. | Sends a bitmap to the page. | Compressed mode uses mode 3 and includes data length. |
downloadBmp(fileName, data)Images and graphics | DOWNLOAD "{fileName}",{length},{data} | File name and image data. | Downloads bitmap data to the device. | Exposed by TypeScript. |
putImage(...)Images and graphics | PUTBMP {x},{y},"{fileName}",{contrast},{brightness} | Position, file name, contrast, brightness. | Prints a downloaded bitmap. | Exposed by TypeScript. |
detect()Status queries | SELFTEST PATTERN | - | Runs self-test pattern. | Exposed by Java. |
readState()Status queries | READSTA | - | Reads status. | - |
status() / state()Status queries | STATUS | - | Queries status. | - |
realtimeStatus()Status queries | 1B 21 3F | - | Queries realtime status. | Exposed by Java. |
querySerialNumber()Device information | READC PRDOCUTID | - | Reads product ID / serial-related data. | Keeps PRDOCUTID spelling from source. |
sn() / sns()Device information | SN? | - | Queries serial number. | - |
queryVersion()Device information | READC VERSION | - | Reads version information. | - |
version() / versions()Device information | VERSION | - | Queries version. | - |
queryModel()Device information | READC MDDLE | - | Reads model information. | Keeps MDDLE spelling from source. |
model() / models()Device information | MODEL? | - | Queries model. | - |
batteryVolume()Status queries | READC BATTERY_LEVEL | - | Queries battery level. | - |
print(copies) / print(sets, copies)Print and layout | PRINT {sets},{copies} | sets and copies. | Starts printing. | - |
raw(...)Composites and aliases | Caller-provided TSPL text. | template/args. | Sends an unwrapped TSPL command. | - |