Useful library to help Android developers to print with (Bluetooth, WIFI, Network, USB) thermal printers ESC/POS.
⭐ Star this repository to support this library. You can contribute to increase the visibility of this library 🙂
- CashTray/CashBox/CashDrawer Support Added.
- Encoding Improvemed.
- CashTray related function are mentioned below:
new Thread(new Runnable() {
public void run() {
try {
EscPosPrinter printer = new EscPosPrinter(new TcpConnection(ip, port), 203, 65f, 42);
printer.openCashBox();
printer.disconnectPrinter();
} catch (Exception e) {
e.printStackTrace();
}
}
}).start();
EscPosPrinter printer = null;
try {
printer = new EscPosPrinter(BluetoothPrintersConnections.selectFirstPaired(), 203, 48f, 32);
printer.printFormattedTextAndOpenCashBox(
"[C]<img>" + PrinterTextParserImg.bitmapToHexadecimalString(printer, getApplicationContext().getResources().getDrawableForDensity(R.drawable.testp, DisplayMetrics.DENSITY_MEDIUM)) + "</img>\n" +
"[L]\n" +
"[C]<u><font size='big'>ORDER N°1125</font></u>\n[L]\n" +
"[L] _________________________________________\n" +
"[L] Description [R]Amount\n[L]\n" +
"[L] <b>Beef Burger [R]10.00\n" +
"[L] Sprite-200ml [R]3.00\n" +
"[L] _________________________________________\n" +
"[L] TOTAL [R]13.00 BD\n" +
"[L] Total Vat Collected [R]1.00 BD\n" +
"[L]\n" +
"[L] _________________________________________\n" +
"[L]\n" +
"[C]<font size='tall'>Customer Info</font>\n" +
"[L] EM Haseeb\n" +
"[L] 14 Streets\n" +
"[L] Cantt, LHR\n" +
"[L] Tel : +923040017916\n" +
"[L]\n" +
"[L] <barcode type='ean13' height='10'>831254784551</barcode>\n[L]\n" +
"[L] <qrcode>http://github.com/EmHaseeb/</qrcode>\n[L]\n[L]\n[L]\n",5
);
printer.disconnectPrinter();
} catch (EscPosConnectionException | EscPosParserException | EscPosEncodingException | EscPosBarcodeException e) {
e.printStackTrace();
}
- Android version
- Tested printers
- Test It !
- Installation
- Bluetooth
- TCP
- USB
- Charset encoding
- Formatted text : syntax guide
- Class list
- Contributing
Minimum SDK Version 16 Android 4.1 and above are supported.
- EPSON TM-T88VI (121): SERIAL, USB, ETHERNET (Tested over Network/Ethernet 📶)
- EPSON TM-T20 SERIES (Tested over USB 🔌)
- Sewoo LK-P41 (Bluetooth Printer)
- OmniLink® TM-m50 POS Thermal Receipt Printer (Tested over Wifi)
To test this library, it's very simple.
- Create a directory and open a terminal inside
- Run
git clone https://github.com/EmHaseeb/ThermalPrinterESCPOS.git .
- Open the directory with Android Studio
- Test it
Step 1. Add the JitPack repository to your build file. Add it in your root /build.gradle
at the end of repositories:
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
Step 2. Add the dependency in /app/build.gradle
:
dependencies {
...
implementation 'com.github.EmHaseeb:ThermalPrinterESCPOS:1.0.2'
}
Be sure to have <uses-permission android:name="android.permission.BLUETOOTH" />
, <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
, <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
, <uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
in your AndroidManifest.xml
.
Also, you have to check the bluetooth permission in your app like this :
if (android.os.Build.VERSION.SDK_INT < android.os.Build.VERSION_CODES.S && ContextCompat.checkSelfPermission(this, Manifest.permission.BLUETOOTH) != PackageManager.PERMISSION_GRANTED) {
ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.BLUETOOTH}, MainActivity.PERMISSION_BLUETOOTH);
} else if (android.os.Build.VERSION.SDK_INT < android.os.Build.VERSION_CODES.S && ContextCompat.checkSelfPermission(this, Manifest.permission.BLUETOOTH_ADMIN) != PackageManager.PERMISSION_GRANTED) {
ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.BLUETOOTH_ADMIN}, MainActivity.PERMISSION_BLUETOOTH_ADMIN);
} else if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.S && ContextCompat.checkSelfPermission(this, Manifest.permission.BLUETOOTH_CONNECT) != PackageManager.PERMISSION_GRANTED) {
ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.BLUETOOTH_CONNECT}, MainActivity.PERMISSION_BLUETOOTH_CONNECT);
} else if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.S && ContextCompat.checkSelfPermission(this, Manifest.permission.BLUETOOTH_SCAN) != PackageManager.PERMISSION_GRANTED) {
ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.BLUETOOTH_SCAN}, MainActivity.PERMISSION_BLUETOOTH_SCAN);
} else {
// Your code HERE
}
The code below is an example to write in your activity :
EscPosPrinter printer = null;
try {
printer = new EscPosPrinter(BluetoothPrintersConnections.selectFirstPaired(), 203, 48f, 32);
printer.printFormattedTextAndCut(
"[C]<img>" + PrinterTextParserImg.bitmapToHexadecimalString(printer, getApplicationContext().getResources().getDrawableForDensity(R.drawable.testp, DisplayMetrics.DENSITY_MEDIUM)) + "</img>\n" +
"[L]\n" +
"[C]<u><font size='big'>ORDER N°1125</font></u>\n[L]\n" +
"[L] _________________________________________\n" +
"[L] Description [R]Amount\n[L]\n" +
"[L] <b>Beef Burger [R]10.00\n" +
"[L] Sprite-200ml [R]3.00\n" +
"[L] _________________________________________\n" +
"[L] TOTAL [R]13.00 BD\n" +
"[L] Total Vat Collected [R]1.00 BD\n" +
"[L]\n" +
"[L] _________________________________________\n" +
"[L]\n" +
"[C]<font size='tall'>Customer Info</font>\n" +
"[L] EM Haseeb\n" +
"[L] 14 Streets\n" +
"[L] Cantt, LHR\n" +
"[L] Tel : +923040017916\n" +
"[L]\n" +
"[L] <barcode type='ean13' height='10'>831254784551</barcode>\n[L]\n" +
"[L] <qrcode>http://github.com/EmHaseeb/</qrcode>\n[L]\n[L]\n[L]\n"
);
printer.disconnectPrinter();
} catch (EscPosConnectionException e) {
e.printStackTrace();
}
Be sure to have <uses-permission android:name="android.permission.INTERNET"/>
in your AndroidMenifest.xml
.
The code below is an example to write in your activity :
new Thread(new Runnable() {
public void run() {
try {
EscPosPrinter printer = new EscPosPrinter(new TcpConnection(ip, port), 203, 65f, 42);
printer.printFormattedTextAndCut(
"[C]<img>" + PrinterTextParserImg.bitmapToHexadecimalString(printer, getApplicationContext().getResources().getDrawableForDensity(R.drawable.testp, DisplayMetrics.DENSITY_MEDIUM)) + "</img>\n" +
"[L]\n" +
"[C]<u><font size='big'>ORDER N°1125</font></u>\n[L]\n" +
"[L] _________________________________________\n" +
"[L] Description [R]Amount\n[L]\n" +
"[L] <b>Beef Burger [R]10.00\n" +
"[L] Sprite-200ml [R]3.00\n" +
"[L] _________________________________________\n" +
"[L] TOTAL [R]13.00 BD\n" +
"[L] Total Vat Collected [R]1.00 BD\n" +
"[L]\n" +
"[L] _________________________________________\n" +
"[L]\n" +
"[C]<font size='tall'>Customer Info</font>\n" +
"[L] EM Haseeb\n" +
"[L] 14 Streets\n" +
"[L] Cantt, LHR\n" +
"[L] Tel : +923040017916\n" +
"[L]\n" +
"[L] <barcode type='ean13' height='10'>831254784551</barcode>\n[L]\n" +
"[L] <qrcode>http://github.com/EmHaseeb/</qrcode>\n[L]\n[L]\n[L]\n"
);
printer.disconnectPrinter();
} catch (EscPosConnectionException e) {
e.printStackTrace();
}
}
}).start();
Be sure to have <uses-feature android:name="android.hardware.usb.host" />
in your AndroidMenifest.xml
.
You have to check the USB permission in your app like this :
private static final String ACTION_USB_PERMISSION = "com.android.example.USB_PERMISSION";
private final BroadcastReceiver usbReceiver = new BroadcastReceiver() {
public void onReceive(Context context, Intent intent) {
String action = intent.getAction();
if (MainActivity.ACTION_USB_PERMISSION.equals(action)) {
synchronized (this) {
UsbManager usbManager = (UsbManager) getSystemService(Context.USB_SERVICE);
UsbDevice usbDevice = (UsbDevice) intent.getParcelableExtra(UsbManager.EXTRA_DEVICE);
if (intent.getBooleanExtra(UsbManager.EXTRA_PERMISSION_GRANTED, false)) {
if (usbManager != null && usbDevice != null) {
// YOUR PRINT CODE HERE
}
}
}
}
}
};
public void printUsb() {
UsbConnection usbConnection = UsbPrintersConnections.selectFirstConnected(this);
UsbManager usbManager = (UsbManager) this.getSystemService(Context.USB_SERVICE);
if (usbConnection != null && usbManager != null) {
PendingIntent permissionIntent = PendingIntent.getBroadcast(
this,
0,
new Intent(MainActivity.ACTION_USB_PERMISSION),
android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.S ? PendingIntent.FLAG_MUTABLE : 0
);
IntentFilter filter = new IntentFilter(MainActivity.ACTION_USB_PERMISSION);
registerReceiver(this.usbReceiver, filter);
usbManager.requestPermission(usbConnection.getDevice(), permissionIntent);
}
}
The code below is an example to write in your activity :
try {
EscPosPrinter printer = new EscPosPrinter(new UsbConnection(usbManager, usbDevice), 203, 65f, 42);
printer.printFormattedTextAndCut(
"[C]<img>" + PrinterTextParserImg.bitmapToHexadecimalString(printer, getApplicationContext().getResources().getDrawableForDensity(R.drawable.testp, DisplayMetrics.DENSITY_MEDIUM)) + "</img>\n" +
"[L]\n" +
"[C]<u><font size='big'>ORDER N°1125</font></u>\n[L]\n" +
"[L] _________________________________________\n" +
"[L] Description [R]Amount\n[L]\n" +
"[L] <b>Beef Burger [R]10.00\n" +
"[L] Sprite-200ml [R]3.00\n" +
"[L] _________________________________________\n" +
"[L] TOTAL [R]13.00 BD\n" +
"[L] Total Vat Collected [R]1.00 BD\n" +
"[L]\n" +
"[L] _________________________________________\n" +
"[L]\n" +
"[C]<font size='tall'>Customer Info</font>\n" +
"[L] EM Haseeb\n" +
"[L] 14 Streets\n" +
"[L] Cantt, LHR\n" +
"[L] Tel : +923040017916\n" +
"[L]\n" +
"[L] <barcode type='ean13' height='10'>831254784551</barcode>\n[L]\n" +
"[L] <qrcode>http://github.com/EmHaseeb/</qrcode>\n[L]\n[L]\n[L]\n"
);
printer.disconnectPrinter();
} catch (EscPosConnectionException e) {
e.printStackTrace();
}
Below a picture of the receipt printed with the code above :
To change charset encoding of the printer, use EscPosCharsetEncoding
class :
EscPosPrinter printer = new EscPosPrinter(deviceConnection, 203, 48f, 32, new EscPosCharsetEncoding("windows-1252", 16));
escPosCharsetId
may change with printer model.
Follow this link to find escPosCharsetId
that works with many printers
Use \n
to create a new line of text.
Add an alignment tag on a same line of text implicitly create a new column.
Column alignment tags :
[L]
: left side alignment[C]
: center alignment[R]
: right side alignment
Example :
[L]Some text
: One column aligned to left[C]Some text
: One column aligned to center[R]Some text
: One column aligned to right[L]Some text[L]Some other text
: Two columns aligned to left.Some other text
starts in the center of the paper.[L]Some text[R]Some other text
: Two columns, first aligned to left, second aligned to right.Some other text
is printed at the right of paper.[L]Some[R]text[R]here
: Three columns.[L][R]text[R]here
: Three columns. The first is empty but it takes a third of the available space.
<font></font>
tag allows you to change the font size and color. Default size is normal
/ black
.
-
<font size='normal'>Some text</font>
: Normal size -
<font size='wide'>Some text</font>
: Double width of medium size -
<font size='tall'>Some text</font>
: Double height of medium size -
<font size='big'>Some text</font>
: Double width and height of medium size -
<font size='big-2'>Some text</font>
: 3 x width and height -
<font size='big-3'>Some text</font>
: 4 x width and height -
<font size='big-4'>Some text</font>
: 5 x width and height -
<font size='big-5'>Some text</font>
: 6 x width and height -
<font size='big-6'>Some text</font>
: 7 x width and height -
<font color='black'>Some text</font>
: black text - white background -
<font color='bg-black'>Some text</font>
: white text - black background -
<font color='red'>Some text</font>
: red text - white background (Not working on all printer) -
<font color='bg-red'>Some text</font>
: white text - red background (Not working on all printer)
<b></b>
tag allows you to change the font weight.
<b>Some text</b>
<u></u>
tag allows you to underline the text.
<u>Some text</u>
text underlined<u type='double'>Some text</u>
text double-strike (Not working on all printer)
<img></img>
tag allows you to print image. Inside the tag you need to write a hexadecimal string of an image.
Use PrinterTextParserImg.bitmapToHexadecimalString
to convert Drawable
, BitmapDrawable
or Bitmap
to hexadecimal string.
<img>
hexadecimal string of an image</img>
⚠ WARNING ⚠ : This tag has several constraints :
- A line that contains
<img></img>
can have only one alignment tag and it must be at the beginning of the line. <img>
must be directly preceded by nothing or an alignment tag ([L][C][R]
).</img>
must be directly followed by a new line\n
.- You can't write text on a line that contains
<img></img>
. - Maximum height of printed image is 256px, If you want to print larger bitmap.
<barcode></barcode>
tag allows you to print a barcode. Inside the tag you need to write the code number to print.
<barcode>451278452159</barcode>
: (12 numbers)
Prints a EAN13 barcode (height: 10mm, width: ~70% printer width, text: displayed below).<barcode type='ean8'>4512784</barcode>
: (7 numbers)
Prints a EAN8 barcode (height: 10mm, width: ~70% printer width, text: displayed below).<barcode type='upca' height='20'>4512784521</barcode>
: (11 numbers)
Prints a UPC-A barcode (height: 20mm, width: ~70% printer width, text: displayed below).<barcode type='upce' height='25' width='50' text='none'>512789</barcode>
: (6 numbers)
Prints a UPC-E barcode (height: 25mm, width: ~50mm, text: hidden).<barcode type='128' width='40' text='above'>EmHaseeb</barcode>
: (string)
Prints a barcode 128 (height: 10mm, width: ~40mm, text: displayed above).
⚠ WARNING ⚠ : This tag has several constraints :
- A line that contains
<barcode></barcode>
can have only one alignment tag and it must be at the beginning of the line. <barcode>
must be directly preceded by nothing or an alignment tag ([L][C][R]
).</barcode>
must be directly followed by a new line\n
.- You can't write text on a line that contains
<barcode></barcode>
.
<qrcode></qrcode>
tag allows you to print a QR code. Inside the tag you need to write the QR code data.
<qrcode>http://www.github.com/</qrcode>
: Prints a QR code with a width and height of 20 millimeters.<qrcode size='25'>123456789</qrcode>
: Prints a QR code with a width and height of 25 millimeters.
⚠ WARNING ⚠ : This tag has several constraints :
- A line that contains
<qrcode></qrcode>
can have only one alignment tag and it must be at the beginning of the line. <qrcode>
must be directly preceded by nothing or an alignment tag ([L][C][R]
).</qrcode>
must be directly followed by a new line\n
.- You can't write text on a line that contains
<qrcode></qrcode>
.
Easy way to get the first bluetooth printer paired / connected.
- return
BluetoothConnection
Get a list of bluetooth printers.
- return
BluetoothConnection[]
⚠️ If the arrray returned bygetList()
does not contain you printer or ifselectFirstPaired()
does not return your printer.
- param
String address
: Targeted ip address - param
int port
: Targeted tcp port - param
int timeout
(optional) : Connection timeout (default : 30)
Easy way to get the first USB printer connected.
- return
UsbConnection
Get a list of USB printers.
- return
UsbConnection[]
Constructor : EscPosPrinter(DeviceConnection printer, int printerDpi, float printingWidthMM, int nbrCharactersPerLine [, EscPosCharsetEncoding charsetEncoding])
- param
DeviceConnection printer
: Instance of a connected printer - param
int printerDpi
: DPI of the connected printer - param
float printerWidthMM
: Printing width in millimeters - param
int printerNbrCharactersPerLine
: The maximum number of medium sized characters that can be printed on a line. - param
EscPosCharsetEncoding charsetEncoding
(optional) : Set the charset encoding.
Close the connection with the printer.
- return
Printer
: Fluent interface
Get the maximum number of characters that can be printed on a line.
- return
int
Get the printing width in millimeters
- return
float
Get the printer DPI
- return
int
Get the printing width in dot
- return
int
Get the number of dot that a printed character contain
- return
int
Convert the mmSize variable from millimeters to dot.
- param
float mmSize
: Distance in millimeters to be converted - return
int
: Dot size of mmSize.
Active "ESC *" command for image printing.
- param
boolean enable
: true to use "ESC *", false to use "GS v 0" - return
Printer
: Fluent interface
Print a formatted text and feed paper (20 millimeters). Read the "Formatted Text : Syntax guide" section for more information about text formatting options.
- param
String text
: Formatted text to be printed. - return
Printer
: Fluent interface
Print a formatted text, feed paper (20 millimeters) and cut the paper. Read the "Formatted Text : Syntax guide" section for more information about text formatting options.
- param
String text
: Formatted text to be printed. - return
Printer
: Fluent interface
Print a formatted text and feed paper (mmFeedPaper
millimeters). Read the "Formatted Text : Syntax guide" section for more information about text formatting options.
- param
String text
: Formatted text to be printed. - param
float mmFeedPaper
: Millimeter distance feed paper at the end. - return
Printer
: Fluent interface
Print a formatted text, feed paper (mmFeedPaper
millimeters) and cut the paper. Read the "Formatted Text : Syntax guide" section for more information about text formatting options.
- param
String text
: Formatted text to be printed. - param
float mmFeedPaper
: Millimeter distance feed paper at the end. - return
Printer
: Fluent interface
Print a formatted text, feed paper (mmFeedPaper
millimeters), cut the paper and open the cash box. Read the "Formatted Text : Syntax guide" section for more information about text formatting options.
- param
String text
: Formatted text to be printed. - param
float mmFeedPaper
: Millimeter distance feed paper at the end. - return
Printer
: Fluent interface
Print a formatted text and feed paper (dotsFeedPaper
dots). Read the "Formatted Text : Syntax guide" section for more information about text formatting options.
- param
String text
: Formatted text to be printed. - param
int dotsFeedPaper
: Distance feed paper at the end. - return
Printer
: Fluent interface
Print a formatted text, feed paper (dotsFeedPaper
dots) and cut the paper. Read the "Formatted Text : Syntax guide" section for more information about text formatting options.
- param
String text
: Formatted text to be printed. - param
int dotsFeedPaper
: Distance feed paper at the end. - return
Printer
: Fluent interface
Print a formatted text, feed paper (dotsFeedPaper
dots), cut the paper and open the cash box. Read the "Formatted Text : Syntax guide" section for more information about text formatting options.
- param
String text
: Formatted text to be printed. - param
int dotsFeedPaper
: Distance feed paper at the end. - return
Printer
: Fluent interface
Convert Bitmap object to ESC/POS image.
- param
Bitmap bitmap
: Instance of Bitmap - param
boolean gradient
:false
Black and white image,true
Grayscale image - return
byte[]
: Bytes contain the image in ESC/POS command
Convert Drawable instance to a hexadecimal string of the image data.
- param
Printer printer
: A Printer instance that will print the image. - param
Drawable drawable
: Drawable instance to be converted. - param
boolean gradient
(optional) :false
Black and white image,true
Grayscale image (Default :true
) - return
String
: A hexadecimal string of the image data. Empty string if Drawable cannot be cast to BitmapDrawable.
Static Method : bitmapToHexadecimalString(Printer printer, BitmapDrawable bitmapDrawable [, boolean gradient])
Convert BitmapDrawable instance to a hexadecimal string of the image data.
- param
Printer printer
: A Printer instance that will print the image. - param
BitmapDrawable bitmapDrawable
: BitmapDrawable instance to be converted. - param
boolean gradient
(optional) :false
Black and white image,true
Grayscale image (Default :true
) - return
String
: A hexadecimal string of the image data.
Convert Bitmap instance to a hexadecimal string of the image data.
- param
Printer printer
: A Printer instance that will print the image. - param
Bitmap bitmap
: Bitmap instance to be converted. - param
boolean gradient
(optional) :false
Black and white image,true
Grayscale image (Default :true
) - return
String
: A hexadecimal string of the image data.
Convert byte array to a hexadecimal string of the image data.
- param
byte[] bytes
: Bytes contain the image in ESC/POS command. - return
String
: A hexadecimal string of the image data.
Convert hexadecimal string of the image data to bytes ESC/POS command.
- param
String hexString
: Hexadecimal string of the image data. - return
byte[]
: Bytes contain the image in ESC/POS command.
- param
charsetName
Name of charset encoding (Ex: ISO-8859-1) - param
escPosCharsetId
Id of charset encoding for your printer (Ex: 6)
Please fork this repository and contribute back using pull requests.
Any contributions, large or small, major features, bug fixes, are welcomed and appreciated but will be thoroughly reviewed