ql

Documentation

Overview

Package ql is a Linux driver for Brother QL-series printers.

Index

• Constants
• type MediaInfo
  • func GetMediaInfo(widthMM, lengthMM int) *MediaInfo
• type Printer
  • func Open() (*Printer, error)
  • func (p *Printer) Close() error
  • func (p *Printer) Initialize() error
  • func (p *Printer) Print(image image.Image, rb bool) error
  • func (p *Printer) UpdateStatus() error
• type Status
  • func (s *Status) Dump(f io.Writer)
  • func (s *Status) Errors() (errors []string)
  • func (s *Status) MediaLengthMM() int
  • func (s *Status) MediaWidthMM() int
  • func (s *Status) Phase() StatusPhase
  • func (s *Status) String() string
  • func (s *Status) Type() StatusType
• type StatusPhase
• type StatusType

Constants

const (
	StatusTypeReplyToRequest    StatusType = 0x00
	StatusTypePrintingCompleted            = 0x01
	StatusTypeErrorOccurred                = 0x02
	StatusTypeTurnedOff                    = 0x04
	StatusTypeNotification                 = 0x05
	StatusTypePhaseChange                  = 0x06
)

Types

type MediaInfo

type MediaInfo struct {
	// Note that these are approximates, many pins within the margins will work.
	SideMarginPins int
	PrintAreaPins  int
	// If non-zero, length of the die-cut label print area in 300dpi pins.
	PrintAreaLength int
}

func GetMediaInfo

func GetMediaInfo(widthMM, lengthMM int) *MediaInfo

type Printer

type Printer struct {
	File         *os.File
	Manufacturer string
	Model        string

	LastStatus *Status
	MediaInfo  *MediaInfo

	// StatusNotify is called whenever we receive a status packet.
	StatusNotify func(*Status)
}

func Open

func Open() (*Printer, error)

Open finds and initializes the first USB printer found supporting the appropriate protocol. Returns nil if no printer could be found.

func (*Printer) Close

func (p *Printer) Close() error

Close closes the underlying file.

func (*Printer) Initialize

func (p *Printer) Initialize() error

Initialize initializes the printer for further operations.

func (*Printer) Print

func (p *Printer) Print(image image.Image, rb bool) error

func (*Printer) UpdateStatus

func (p *Printer) UpdateStatus() error

Request new status information from the printer. The printer must be in an appropriate mode, i.e. on-line and not currently printing.

type Status

type Status [32]byte

Status is a decoder for the status packed returned by the printer.

func (*Status) Dump

func (s *Status) Dump(f io.Writer)

Dump writes the status data to an io.Writer in a human-readable format.

func (*Status) Errors

func (s *Status) Errors() (errors []string)

func (*Status) MediaLengthMM

func (s *Status) MediaLengthMM() int

func (*Status) MediaWidthMM

func (s *Status) MediaWidthMM() int

func (*Status) Phase

func (s *Status) Phase() StatusPhase

func (*Status) String

func (s *Status) String() string

String implements the Stringer interface.

func (*Status) Type

func (s *Status) Type() StatusType

type StatusPhase

type StatusPhase byte

const (
	StatusPhaseReceiving StatusPhase = 0x00
	StatusPhasePrinting              = 0x01
)

type StatusType

type StatusType byte