ESC/POS Printer driver for nodejs
npm install @4keys/escposbash
$ npm i escpos --save
`
$3
`bash
$ 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
``javascript
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 options = { encoding: "GB18030" / default / }
// encoding is optional
const printer = new escpos.Printer(device, options);
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
$3
You can choose your adapter type as USB, Serial, Network, or Console.
#### USB(vid, pid)
`javascript
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)
`javascript
const serialDeviceOnWindows = new escpos.Serial('COM10');
const serialDeviceOnLinux = new escpos.Serial('/dev/usb/lp0', {
baudRate: 14400,
stopBit: 2
});
`
Check the serialport package documentation for more options.
#### Network(address, port = 9100)
`javascript
const networkDevice = new escpos.Network('localhost', 3000);
`
The default port number is 9100.
#### Console(handler = stdout)
`javascript
const debugDevice = new escpos.Console();
`
$3
#### 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
$3
#### Printer(device)
`javascript
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);
`
$3
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)
`javascript
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", "options")
Prints a barcode.
"code" is an alphanumeric code to be printed as bar code
"barcodeType" 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)
If you wish to disable the parity bit you must set "includeParity": false in the options provided to the command.
"options"
"options.width" is a numeric value in the range between (1,255) Default: 64
"options.height" is a numeric value in the range between (2,6) Default: 3
"options.includeParity" is a boolean that defined if the parityBit shall be calculated to EAN13/EAN8 printers. default: true
"options.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.
For backward compatibility the old method interface is still supported:
`
barcode("code", "barcodeType", width, height, "position", "font")
`
#### 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()``