QISHU DOCUMENT ARCHIVE
Qishu Archives
제품 문서, 인터페이스 자료, 엔지니어링 기록을 위한 공통 입구입니다.
sdk / quickstart
빠른 시작
가장 짧은 경로로 SDK 인쇄를 한 번 완료합니다.
빠른 시작은 한 가지만 합니다. 최소 인쇄 스크립트를 생성하고, 이미 연결된 디바이스 객체에 씁니다. 먼저 장비가 텍스트 한 줄을 인쇄하게 만든 뒤 이미지, QR 코드, 라벨 템플릿 또는 상태 읽기를 연동하세요.
최소 흐름
섹션 제목: “최소 흐름”- 장비 Family와 명령어 계열을 확인합니다. 예: Boxliy + TSPL.
- 대상 언어에서 해당 전달 패키지를 설치합니다.
- 플랫폼 연결 계층을 통해 connected device를 얻습니다.
- 명령어 빌더로 스크립트/바이트를 생성합니다.
- 쓰기 파이프라인으로 바이트를 디바이스에 씁니다.
connected device란
섹션 제목: “connected device란”예제의 device는 SDK가 자동으로 스캔한 디바이스도 아니고, 특정 플랫폼의 원시 블루투스 객체도 아닙니다. 연결 계층에서 이미 어댑트된 connected device여야 합니다.
平台扫描/授权/连接 -> transport adapter -> connected device -> writeTo(...)WeChat, UniApp, Taro, WebUSB, Android 블루투스, iOS BLE 모두 각자의 연결 방식을 가질 수 있습니다. 하지만 인쇄 템플릿에 들어가기 전에는 같은 connected device 계약으로 수렴시키는 것이 좋습니다.
TypeScript TSPL 예제
섹션 제목: “TypeScript TSPL 예제”아래 예제는 TSPL을 지원하는 Boxliy 장비에 적합합니다. 다른 장비에서는 해당 Family와 명령어 계열에 맞는 빌더로 바꾸세요.
import { TsplBoxliy, writeTo } from '@boxliy/nib'
const bytes = new TsplBoxliy() .size(60, 40) .gap(2) .cls() .text({ x: 20, y: 20, content: 'NIB SDK' }) .print(1) .bytes()
await writeTo(device, bytes)TypeScript의 구체적인 디바이스 패키지가 아직 확실하지 않다면, 먼저 흐름을 의사 코드로 작성해도 됩니다.
const device = await connectPrinterFromYourPlatform()const bytes = buildReceiptOrLabel()await writeTo(device, bytes)여기서 중요한 것은 경계입니다. connectPrinterFromYourPlatform()은 권한, 스캔, 연결, characteristic을 처리하고, buildReceiptOrLabel()은 인쇄 바이트만 생성합니다.
첫 연동 권장 사항
섹션 제목: “첫 연동 권장 사항”| 단계 | 권장 사항 |
|---|---|
| 텍스트 인쇄부터 시작 | 이미지, 바코드, 라벨 템플릿보다 연결 문제를 찾기 쉽습니다. |
| 한 가지 장비를 먼저 고정 | 처음부터 여러 모델과 여러 명령어 집합을 섞지 마세요. |
| 쓰기 바이트 길이 기록 | 스크립트 생성 실패인지 전송 계층 쓰기 실패인지 판단하기 쉽습니다. |
| 디바이스 로그 보관 | 연결, 분할, 타임아웃, 상태 응답을 모두 추적할 수 있어야 합니다. |
최소 텍스트 인쇄가 아직 성공하지 않았다면 이미지, QR 코드, 복잡한 라벨 템플릿을 먼저 연동하지 마세요.