node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

escpos

ESCPOS npm version

ESC/POS Printer driver for node

NPM

Installation

npm

$ npm i escpos --save

yarn

$ yarn add escpos

if you use usb as an adapter :

  • On Linux, you'll need libudev to build libusb.
  • On Ubuntu/Debian: sudo apt-get install build-essential libudev-dev.
  • On Windows, Use Zadig to install the WinUSB driver for your USB device.

Otherwise you will get LIBUSB_ERROR_NOT_SUPPORTED when attempting to open devices.

Example

const escpos = require('escpos');
 
// Select the adapter based on your printer type
const device  = new escpos.USB();
// const device  = new escpos.Network('localhost');
// const device  = new escpos.Serial('/dev/usb/lp0');
 
const printer = new escpos.Printer(device);
 
device.open(function(){
  printer
  .font('a')
  .align('ct')
  .style('bu')
  .size(1, 1)
  .text('The quick brown fox jumps over the lazy dog')
  .text('敏捷的棕色狐狸跳过懒狗')
  .barcode('1234567', 'EAN8')
  .qrimage('https://github.com/song940/node-escpos', function(err){
    this.cut();
    this.close();
  });
});
  • See ./examples for more examples.

Adapter

Constructors

You can choose your adapter type as USB, Serial, Network, or Console.

USB(vid, pid)

const usbDevice = new escpos.USB(0x01, 0xff);

vid(Vendor Id) and pid (Product Id) can be checked with the lsusb command or escpos.USB.findPrinter() method.

Serial("port", options)

const serialDeviceOnWindows = new escpos.Serial('COM10');
const serialDeviceOnLinux = new escpos.Serial('/dev/usb/lp0', {
  bandRate: 14400,
  stopBit: 2
});

Check the serialport package documentation for more options.

Network(address, port = 9100)

const networkDevice = new escpos.Network('localhost', 3000);

The default port number is 9100.

Console(handler = stdout)

const debugDevice = new escpos.Console();

Methods

open(function callback)

Claims the current device USB (or other device type), if the printer is already in use by other process this will fail.

By default, the USB adapter will set the first printer found .

Triggers the callback function when done.

close(function callback)

Closes the current device and releases its USB interface.


Printer

Constructors

Printer(device)

const usbDevice = new escpos.USB();
const usbPrinter = new escpos.Printer(usbDevice);
 
const serialDevice = new escpos.Serial('/dev/usb/lp0');
const serialPrinter = new escpos.Printer(serialDevice);
 
const networkDevice = new escpos.Network('localhost');
const networkPrinter = new escpos.Printer(networkDevice);

Methods

Escpos inherits its methods to the printers. the following methods are defined:

text("text", encodeType)

Prints raw text. Raises TextError exception.

For the encode type, see the iconv-lite wiki document. Escpos uses iconv-lite for encoding.

If the type is undefined, the default type is GB18030.

encode("encodeType")

Sets the encoding value globally. default type is GB18030 (Chinese)

printer
.encode('EUC-KR')
.text('동해물과 백두산이 마르고 닳도록');

control("align")

Carrier feed and tabs.

align is a string which takes any of the following values:

  • LF for Line Feed
  • FF for Form Feed
  • CR for Carriage Return
  • HT for Horizontal Tab
  • VT for Vertical Tab

align("align")

Set text properties.

align set horizontal position for text, the possible values are:

  • CT is the Center alignment
  • LT is the Left alignment
  • RT is the Right alignment

Default: LT

font("type")

font type could be A or B. Default: A

size(width, heigth)

width is a numeric value, 1 is for regular size, and 2 is twice the standard size. Default: 1

height is a numeric value, 1 is for regular size and 2 is twice the standard size. Default: 1

barcode("code", "barcodeType", width, height, "position", "font")

Prints a barcode.

code is an alphanumeric code to be printed as bar code barcode_type must be one of the following type of codes:

  • UPC-A
  • UPC-E
  • EAN13
  • EAN8
  • CODE39
  • ITF
  • NW7

The EAN type automatically calculates the last parity bit. For the EAN13 type, the length of the string is limited to 12, and EAN8 is limited to 7. (#57)

width is a numeric value in the range between (1,255) Default: 64 height is a numeric value in the range between (2,6) Default: 3 position is where to place the code around the bars, could be one of the following values:

  • ABOVE
  • BELOW
  • BOTH
  • OFF

Default: BELOW

font is one of the 2 type of fonts, values could be:

  • A
  • B

Default: A

Raises BarcodeTypeError, BarcodeSizeError, BarcodeCodeError exceptions.

cut("mode")

Cut paper.

mode set a full or partial cut. Default: full Partial cut is not implemented in all printers.

*** Don't foget this, because cut will flush buffer to printer ***

cashdraw(pin)

Sends a pulse to the cash drawer in the specified pin.

pin is a numeric value which defines the pin to be used to send the pulse, it could be 2 or 5. Raises `CashDrawerError()``


Screencast

img_1031


Thanks


Contributing

  • Fork this repo
  • Clone your repo
  • Install dependencies
  • Checkout a feature branch
  • Feel free to add your features
  • Make sure your features are fully tested
  • Open a pull request, and enjoy <3

MIT license

Copyright (c) 2015 lsong

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.