Repository files navigation

This android library converted to kotlin and the background threading converted from async task to coroutines in TCP only for know, the originaljava library link.

Useful library to help Android developers to print with (Bluetooth, TCP, USB) ESC/POS thermal printers.

⭐ Star this repository to support this project. You will contribute to increase the visibility of this library 🙂

• Android version
• Tested printers
• Test It !
• Installation
• Bluetooth
  • Bluetooth permission
  • Bluetooth code example
• TCP
  • TCP permission
  • TCP code example
• USB
  • USB permission
  • USB code example
• Charset encoding
• Formatted text : syntax guide
• Class list
  • BluetoothPrintersConnections
  • UsbPrintersConnections
  • EscPosPrinter
  • PrinterTextParserImg
  • EscPosCharsetEncoding
• Contributing

Developed for SDK version 16 (Android 4.1 Jelly Bean) and above.

1. HOIN HOP H58 Thermal Printer ESC/POS.
2. XPRINTER XP-P300.
3. MUNBYN IMP001.
4. JP-Q2 POS Terminal PDA (Embedded printer is configured as Bluetooth device)
5. MUNBYN ITPP047 (tested over USB)

To test this library, it's pretty simple !

• Create a directory and open a terminal inside
• Rungit clone https://github.com/KhairoHumsi/Printer-ktx.git .
• Open the directory with Android Studio
• Test it !

Step 1. Add theJitPack 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.KhairoHumsi:Printer-ktx:1.0.1'}

Be sure to have<uses-permission android:name="android.permission.BLUETOOTH" /> in yourAndroidMenifest.xml.

Also, you have to check the bluetooth permission in your app like this :

if (ContextCompat.checkSelfPermission(this,Manifest.permission.BLUETOOTH) !=PackageManager.PERMISSION_GRANTED) {ActivityCompat.requestPermissions(this,newString[]{Manifest.permission.BLUETOOTH},MainActivity.PERMISSION_BLUETOOTH);}else {// Your code HERE}

The code below is an example to write in your activity :

EscPosPrinterprinter =newEscPosPrinter(BluetoothPrintersConnections.selectFirstPaired(),203,48f,32);printer    .printFormattedText("[C]<img>" +PrinterTextParserImg.bitmapToHexadecimalString(printer,this.getApplicationContext().getResources().getDrawableForDensity(R.drawable.logo,DisplayMetrics.DENSITY_MEDIUM))+"</img>\n" +"[L]\n" +"[C]<u><font size='big'>ORDER N°045</font></u>\n" +"[L]\n" +"[C]================================\n" +"[L]\n" +"[L]<b>BEAUTIFUL SHIRT</b>[R]9.99e\n" +"[L]  + Size : S\n" +"[L]\n" +"[L]<b>AWESOME HAT</b>[R]24.99e\n" +"[L]  + Size : 57/58\n" +"[L]\n" +"[C]--------------------------------\n" +"[R]TOTAL PRICE :[R]34.98e\n" +"[R]TAX :[R]4.23e\n" +"[L]\n" +"[C]================================\n" +"[L]\n" +"[L]<font size='tall'>Customer :</font>\n" +"[L]Raymond DUPONT\n" +"[L]5 rue des girafes\n" +"[L]31547 PERPETES\n" +"[L]Tel : +33801201456\n" +"[L]\n" +"[C]<barcode type='ean13' height='10'>831254784551</barcode>\n" +"[C]<qrcode size='20'>http://www.developpeur-web.khairo.com/</qrcode>"    );

Below a picture of the receipt printed with the code above :

Be sure to have<uses-permission android:name="android.permission.INTERNET"/> in yourAndroidMenifest.xml.

The code below is an example to write in your activity :

privatevar printer:CoroutinesEscPosPrinter?=nulloverridefunonCreate(savedInstanceState:Bundle?) {super.onCreate(savedInstanceState)        setContentView(R.layout.activity_main)        lifecycleScope.launch (Dispatchers.IO) { printTcp() }    }privatesuspendfunprintTcp() {try {            printer=CoroutinesEscPosPrinter(TcpConnection("192.168.1.160",9100).apply { connect(this@MainActivity) },203,48f,32)CoroutinesEscPosPrint(this).execute(                    printViaWifi(                            printer!!,45,                            body,34.98f,4,                            customer,"83125478455134567890"                    )            ).apply { printer=null }        }catch (e:NumberFormatException) {AlertDialog.Builder(this)                    .setTitle("Invalid TCP port address")                    .setMessage("Port field must be a number.")                    .show()            e.printStackTrace()        }    }privateval body:String        get()="[L]\n"+"[L]    <b>Pizza</b>[R][R]3[R][R]55 $\n"+"[L]      + Olive[R][R]1 $\n"+"[L]      + Cheese[R][R]5 $\n"+"[L]      + Mushroom[R][R]7 $\n"+"[L]\n"+"[L]    <b>Burger</b>[R][R]7[R][R]43.54 $\n"+"[L]      + Cheese[R][R]3 $\n"+"[L]\n"+"[L]    <b>Shawarma</b>[R][R]2[R][R]4 $\n"+"[L]      + Garlic[R][R]0.5 $\n"+"[L]\n"+"[L]    <b>Steak</b>[R][R]3[R][R]75 $\n"+"[L]\n"+"[R] PAYMENT METHOD :[R]Visa\n"privateval customer:String        get()="[C]================================\n"+"[L]\n"+"[L]<b>Delivery</b>[R]5 $\n"+"[L]\n"+"[L]<u><font color='bg-black' size='tall'>Customer :</font></u>\n"+"[L]Name : Mohammad khair\n"+"[L]Phone : 00962787144627\n"+"[L]Area : Khalda\n"+"[L]street : testing street\n"+"[L]building : 9\n"+"[L]Floor : 2\n"+"[L]Apartment : 1\n"+"[L]Note : This order is just for testing\n"    @SuppressLint("UseCompatLoadingForDrawables")fun Context.printViaWifi(printer:CoroutinesEscPosPrinter,orderId:Int,body:String,totalBill:Float,tax:Int,customer:String = "",barcode:String    ):CoroutinesEscPosPrinter {var test="[C]<img>"+PrinterTextParserImg.bitmapToHexadecimalString(                        printer,                        getDrawable(R.drawable.logo)                )+"</img>\n"+"[L]\n"+"[C]<u><font size='big'>ORDER N°$orderId</font></u>\n"+"[L]\n"+"[C]<u type='double'>${"'on' yyyy-MM-dd 'at' HH:mm:ss".getDateTime()}</u>\n"+"[C]================================\n"+"[L]\n"+"[L]    <b>Items</b>[R][R]<b>Qty</b>[R][R]<b>Price</b>\n"+"[L][R]\n"+"$body\n"+"[L][R]\n"+"[C]--------------------------------\n"+"[R] TOTAL :[R]${totalBill} $\n"        test+=if (tax!=0)"[R] TAX :[R]${tax} %\n"+"[R] GRAND TOTAL :[R]${totalBill* (tax/100f)+ totalBill} $\n"else""        test+="[L][R]\n"+"$customer\n"+"[C]<barcode type='128' height='10'>$barcode</barcode>\n"+"[L]\n"+"[C]<u><font size='big'>VISIT HIS SITE</font></u>\n"+"[L]\n"+"[L]\n"+"[C]<qrcode size='20'>http://www.developpeur-web.khairo.com/</qrcode>\n"+"[L]\n"+"[L]\n"+"[L]\n"+"[L]\n"+"[L]\n"return printer.setTextToPrint(test)    }    @SuppressLint("SimpleDateFormat")fun String.getDateTime():String=SimpleDateFormat(this).format(Date())

Be sure to have<uses-feature android:name="android.hardware.usb.host" /> in yourAndroidMenifest.xml.

You have to check the USB permission in your app like this :

privatestaticfinalStringACTION_USB_PERMISSION ="com.android.example.USB_PERMISSION";privatefinalBroadcastReceiverusbReceiver =newBroadcastReceiver() {publicvoidonReceive(Contextcontext,Intentintent) {Stringaction =intent.getAction();if (MainActivity.ACTION_USB_PERMISSION.equals(action)) {synchronized (this) {UsbManagerusbManager = (UsbManager)getSystemService(Context.USB_SERVICE);UsbDeviceusbDevice = (UsbDevice)intent.getParcelableExtra(UsbManager.EXTRA_DEVICE);if (intent.getBooleanExtra(UsbManager.EXTRA_PERMISSION_GRANTED,false)) {if (usbManager !=null &&usbDevice !=null) {// YOUR PRINT CODE HERE                    }                }            }        }    }};publicvoidprintUsb() {UsbConnectionusbConnection =UsbPrintersConnections.selectFirstConnected(this);UsbManagerusbManager = (UsbManager)this.getSystemService(Context.USB_SERVICE);if (usbConnection !=null &&usbManager !=null) {PendingIntentpermissionIntent =PendingIntent.getBroadcast(this,0,newIntent(MainActivity.ACTION_USB_PERMISSION),0);IntentFilterfilter =newIntentFilter(MainActivity.ACTION_USB_PERMISSION);registerReceiver(this.usbReceiver,filter);usbManager.requestPermission(usbConnection.getDevice(),permissionIntent);    }}

The code below is an example to write in your activity :

EscPosPrinterprinter =newEscPosPrinter(newUsbConnection(usbManager,usbDevice),203,48f,32);printer    .printFormattedText("[C]<img>" +PrinterTextParserImg.bitmapToHexadecimalString(printer,this.getApplicationContext().getResources().getDrawableForDensity(R.drawable.logo,DisplayMetrics.DENSITY_MEDIUM))+"</img>\n" +"[L]\n" +"[C]<u><font size='big'>ORDER N°045</font></u>\n" +"[L]\n" +"[C]================================\n" +"[L]\n" +"[L]<b>BEAUTIFUL SHIRT</b>[R]9.99e\n" +"[L]  + Size : S\n" +"[L]\n" +"[L]<b>AWESOME HAT</b>[R]24.99e\n" +"[L]  + Size : 57/58\n" +"[L]\n" +"[C]--------------------------------\n" +"[R]TOTAL PRICE :[R]34.98e\n" +"[R]TAX :[R]4.23e\n" +"[L]\n" +"[C]================================\n" +"[L]\n" +"[L]<font size='tall'>Customer :</font>\n" +"[L]Raymond DUPONT\n" +"[L]5 rue des girafes\n" +"[L]31547 PERPETES\n" +"[L]Tel : +33801201456\n" +"[L]\n" +"[C]<barcode type='ean13' height='10'>831254784551</barcode>\n" +"[C]<qrcode size='20'>http://www.developpeur-web.khairo.com/</qrcode>"    );

To change charset encoding of the printer, useEscPosCharsetEncoding class :

EscPosPrinterprinter =newEscPosPrinter(deviceConnection,203,48f,32,newEscPosCharsetEncoding("windows-1252",16));

escPosCharsetId may change with printer model.Follow this link to findescPosCharsetId 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 isnormal /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 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.

UsePrinterTextParserImg.bitmapToHexadecimalString to convertDrawable,BitmapDrawable orBitmap 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>.

<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'>khairo</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.developpeur-web.khairo.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.

• returnBluetoothConnection

Get a list of bluetooth printers.

• returnBluetoothConnection[]

Easy way to get the first USB printer connected.

• returnUsbConnection

Get a list of USB printers.

• returnUsbConnection[]

• paramDeviceConnection printer : Instance of a connected printer
• paramint printerDpi : DPI of the connected printer
• paramfloat printerWidthMM : Printing width in millimeters
• paramint printerNbrCharactersPerLine : The maximum number of medium sized characters that can be printed on a line.
• paramEscPosCharsetEncoding charsetEncoding(optional) : Set the charset encoding.

Close the connection with the printer.

• returnPrinter : Fluent interface

Get the maximum number of characters that can be printed on a line.

• returnint

Get the printing width in millimeters

• returnfloat

Get the printer DPI

• returnint

Get the printing width in dot

• returnint

Get the number of dot that a printed character contain

• returnint

Convert the mmSize variable from millimeters to dot.

• paramfloat mmSize : Distance in millimeters to be converted
• returnint : Dot size of mmSize.

Print a formatted text and feed paper (20 millimeters). Read the"Formatted Text : Syntax guide" section for more information about text formatting options.

• paramString text : Formatted text to be printed.
• returnPrinter : 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.

• paramString text : Formatted text to be printed.
• returnPrinter : 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.

• paramString text : Formatted text to be printed.
• paramfloat mmFeedPaper : Millimeter distance feed paper at the end.
• returnPrinter : 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.

• paramString text : Formatted text to be printed.
• paramfloat mmFeedPaper : Millimeter distance feed paper at the end.
• returnPrinter : 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.

• paramString text : Formatted text to be printed.
• paramint dotsFeedPaper : Distance feed paper at the end.
• returnPrinter : 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.

• paramString text : Formatted text to be printed.
• paramint dotsFeedPaper : Distance feed paper at the end.
• returnPrinter : Fluent interface

Convert Bitmap object to ESC/POS image.

• paramBitmap bitmap : Instance of Bitmap
• returnbyte[] : Bytes contain the image in ESC/POS command

Convert Drawable instance to a hexadecimal string of the image data.

• paramPrinter printer : A Printer instance that will print the image.
• paramDrawable drawable : Drawable instance to be converted.
• returnString : A hexadecimal string of the image data. Empty string if Drawable cannot be cast to BitmapDrawable.

Convert BitmapDrawable instance to a hexadecimal string of the image data.

• paramPrinter printer : A Printer instance that will print the image.
• paramBitmapDrawable bitmapDrawable : BitmapDrawable instance to be converted.
• returnString : A hexadecimal string of the image data.

Convert Bitmap instance to a hexadecimal string of the image data.

• paramPrinter printer : A Printer instance that will print the image.
• paramBitmap bitmap : Bitmap instance to be converted.
• returnString : A hexadecimal string of the image data.

Convert byte array to a hexadecimal string of the image data.

• parambyte[] bytes : Bytes contain the image in ESC/POS command.
• returnString : A hexadecimal string of the image data.

Convert hexadecimal string of the image data to bytes ESC/POS command.

• paramString hexString : Hexadecimal string of the image data.
• returnbyte[] : Bytes contain the image in ESC/POS command.

• paramcharsetName Name of charset encoding (Ex: ISO-8859-1)
• paramescPosCharsetId 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