sklad/ql/ql.go

290 lines
7.2 KiB
Go
Raw Normal View History

2019-04-12 02:15:28 +02:00
// Package ql is a Linux driver for Brother QL-series printers.
package ql
// Resources:
// http://etc.nkadesign.com/Printers/QL550LabelPrinterProtocol
// https://github.com/torvalds/linux/blob/master/drivers/usb/class/usblp.c
2019-04-12 02:15:28 +02:00
// http://www.undocprint.org/formats/page_description_languages/brother_p-touch
// http://www.undocprint.org/formats/communication_protocols/ieee_1284
2019-04-12 02:15:28 +02:00
import (
"errors"
"io"
"os"
"path/filepath"
"regexp"
"strings"
"syscall"
"time"
"unsafe"
)
// #include <linux/ioctl.h>
import "C"
// -----------------------------------------------------------------------------
func _IOC(dir, typ, nr, size int) uintptr {
return (uintptr(dir) << C._IOC_DIRSHIFT) |
(uintptr(typ) << C._IOC_TYPESHIFT) |
(uintptr(nr) << C._IOC_NRSHIFT) |
(uintptr(size) << C._IOC_SIZESHIFT)
}
const (
iocnrGetDeviceID = 1
)
// lpiocGetDeviceID reads the IEEE-1284 Device ID string of a printer.
func lpiocGetDeviceID(fd uintptr) ([]byte, error) {
var buf [1024]byte
if _, _, err := syscall.Syscall(syscall.SYS_IOCTL, fd,
_IOC(C._IOC_READ, 'P', iocnrGetDeviceID, len(buf)),
uintptr(unsafe.Pointer(&buf))); err != 0 {
return nil, err
}
// In theory it might get trimmed along the way.
length := int(buf[0])<<8 | int(buf[1])
if 2+length > len(buf) {
return buf[2:], errors.New("the device ID string got trimmed")
}
return buf[2 : 2+length], nil
}
// -----------------------------------------------------------------------------
var deviceIDRegexp = regexp.MustCompile(
`(?s:\s*([^:,;]+?)\s*:\s*([^:;]*)\s*(?:;|$))`)
type deviceID map[string][]string
// parseIEEE1284DeviceID leniently parses an IEEE 1284 Device ID string
// and returns a map containing a slice of values for each key.
func parseIEEE1284DeviceID(id []byte) deviceID {
m := make(deviceID)
for _, kv := range deviceIDRegexp.FindAllStringSubmatch(string(id), -1) {
var values []string
for _, v := range strings.Split(kv[2], ",") {
values = append(values, strings.Trim(v, "\t\n\v\f\r "))
}
m[kv[1]] = values
}
return m
}
func (id deviceID) Find(key, abbreviation string) []string {
if values, ok := id[key]; ok {
return values
}
if values, ok := id[abbreviation]; ok {
return values
}
return nil
}
func (id deviceID) FindFirst(key, abbreviation string) string {
for _, s := range id.Find(key, abbreviation) {
return s
}
return ""
}
2019-04-12 02:15:28 +02:00
// -----------------------------------------------------------------------------
type Printer struct {
File *os.File
Manufacturer string
Model string
2019-04-12 02:15:28 +02:00
}
func compatible(id deviceID) bool {
for _, commandSet := range id.Find("COMMAND SET", "CMD") {
if commandSet == "PT-CBP" {
return true
}
}
return false
}
// Open finds and initializes the first USB printer found supporting
// the appropriate protocol. Returns nil if no printer could be found.
func Open() (*Printer, error) {
// Linux usblp module, located in /drivers/usb/class/usblp.c
paths, err := filepath.Glob("/dev/usb/lp[0-9]*")
if err != nil {
return nil, err
}
for _, candidate := range paths {
f, err := os.OpenFile(candidate, os.O_RDWR, 0)
if err != nil {
continue
}
// Filter out obvious non-printers.
deviceID, err := lpiocGetDeviceID(f.Fd())
if err != nil {
f.Close()
continue
}
parsedID := parseIEEE1284DeviceID(deviceID)
2019-04-12 02:15:28 +02:00
// Filter out printers that wouldn't understand the protocol.
if !compatible(parsedID) {
2019-04-12 02:15:28 +02:00
f.Close()
continue
}
return &Printer{
File: f,
Manufacturer: parsedID.FindFirst("MANUFACTURER", "MFG"),
Model: parsedID.FindFirst("MODEL", "MDL"),
}, nil
2019-04-12 02:15:28 +02:00
}
return nil, nil
}
// Initialize initializes the printer for further operations.
func (p *Printer) Initialize() error {
// Clear the print buffer.
invalidate := make([]byte, 400)
if _, err := p.File.Write(invalidate); err != nil {
return err
}
// Initialize.
if _, err := p.File.WriteString("\x1b\x40"); err != nil {
return err
}
// Flush any former responses in the printer's queue.
//
// I'm not sure if this is necessary, or rather whether the kernel driver
// does any buffering that could cause data to be returned at this point.
/*
for {
dummy := make([]byte, 32)
if _, err := f.Read(dummy); err == io.EOF {
break
}
}
*/
return nil
}
// GetStatus retrieves the printer's status as raw data. The printer must be
// in an appropriate mode, i.e. on-line and not currently printing.
func (p *Printer) GetStatus() ([]byte, error) {
// Request status information.
if _, err := p.File.WriteString("\x1b\x69\x53"); err != nil {
return nil, err
}
// We need to poll the device a bit.
status := make([]byte, 32)
start := time.Now()
for {
if n, err := p.File.Read(status); err == io.EOF {
time.Sleep(10 * time.Millisecond)
} else if err != nil {
return nil, err
} else if n < 32 {
return nil, errors.New("invalid read")
} else {
return status, nil
}
if time.Now().Sub(start) > time.Second {
return nil, errors.New("timeout")
}
}
}
// Close closes the underlying file.
func (p *Printer) Close() error {
return p.File.Close()
}
// -----------------------------------------------------------------------------
2019-04-12 04:52:03 +02:00
type mediaSize struct {
WidthMM int
LengthMM int
2019-04-12 04:52:03 +02:00
}
type MediaInfo struct {
// Note that these are approximates, many pins within the margins will work.
2019-04-12 04:52:03 +02:00
SideMarginPins int
PrintAreaPins int
// If non-zero, length of the die-cut label print area in 300dpi pins.
PrintAreaLength int
2019-04-12 04:52:03 +02:00
}
var media = map[mediaSize]MediaInfo{
2019-04-12 04:52:03 +02:00
// Continuous length tape
{12, 0}: {29, 106, 0},
{29, 0}: {6, 306, 0},
{38, 0}: {12, 413, 0},
{50, 0}: {12, 554, 0},
{54, 0}: {0, 590, 0},
{62, 0}: {12, 696, 0},
2019-04-12 04:52:03 +02:00
// Die-cut labels
{17, 54}: {0, 165, 566},
{17, 87}: {0, 165, 956},
{23, 23}: {42, 236, 202},
{29, 42}: {6, 306, 425},
{29, 90}: {6, 306, 991},
{38, 90}: {12, 413, 991},
{39, 48}: {6, 425, 495},
{52, 29}: {0, 578, 271},
{54, 29}: {59, 602, 271},
{60, 86}: {24, 672, 954},
{62, 29}: {12, 696, 271},
{62, 100}: {12, 696, 1109},
2019-04-12 04:52:03 +02:00
// Die-cut diameter labels
{12, 12}: {113, 94, 94},
{24, 24}: {42, 236, 236},
{58, 58}: {51, 618, 618},
}
func GetMediaInfo(widthMM, lengthMM int) *MediaInfo {
if mi, ok := media[mediaSize{widthMM, lengthMM}]; ok {
return &mi
}
return nil
2019-04-12 04:52:03 +02:00
}
// -----------------------------------------------------------------------------
2019-04-12 02:15:28 +02:00
type Status struct {
2019-04-12 04:52:03 +02:00
MediaWidthMM int
MediaLengthMM int
Errors []string
2019-04-12 02:15:28 +02:00
}
func decodeBitfieldErrors(b byte, errors [8]string) []string {
var result []string
for i := uint(0); i < 8; i++ {
if b&(1<<i) != 0 {
result = append(result, errors[i])
}
}
return result
}
// TODO: What exactly do we need? Probably extend as needed.
func DecodeStatus(d []byte) *Status {
2019-04-12 02:15:28 +02:00
var status Status
status.MediaWidthMM = int(d[10])
status.MediaLengthMM = int(d[17])
2019-04-12 04:52:03 +02:00
status.Errors = append(status.Errors, decodeBitfieldErrors(d[8], [8]string{
2019-04-12 02:15:28 +02:00
"no media", "end of media", "cutter jam", "?", "printer in use",
"printer turned off", "high-voltage adapter", "fan motor error"})...)
2019-04-12 04:52:03 +02:00
status.Errors = append(status.Errors, decodeBitfieldErrors(d[9], [8]string{
2019-04-12 02:15:28 +02:00
"replace media", "expansion buffer full", "communication error",
"communication buffer full", "cover open", "cancel key",
"media cannot be fed", "system error"})...)
return &status
2019-04-12 02:15:28 +02:00
}