search

KhairoHumsi / Printer-ktx

Useful library to help Android developers to print with (Bluetooth, TCP, USB) ESC/POS thermal printers.
35 stars 5 forks source link
android-library barcode bluetooth-printer pos pos-thermal-printers printer qrcode tcp-permission tcp-printer

readme

Jitpack package repository - ESCPOS-ThermalPrinter-Android v2.0.8 GitHub issues GitHub forks GitHub stars License: MIT

This Android library was created by Alary Franck (DantSu)

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

Android library for ESC/POS Thermal Printer

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

✨ Supporting

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

Table of contents

Android version

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

Tested printers

  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)

Test it !

To test this library, it's pretty simple !

Installation

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

Bluetooth

Bluetooth permission

Be sure to have <uses-permission android:name="android.permission.BLUETOOTH" /> in your AndroidMenifest.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, new String[]{Manifest.permission.BLUETOOTH}, MainActivity.PERMISSION_BLUETOOTH);
} else {
    // Your code HERE
}

Bluetooth code example

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

EscPosPrinter printer = new EscPosPrinter(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 :

Example of a printed receipt

TCP

TCP permission

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

TCP code example

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

private var printer: CoroutinesEscPosPrinter? = null

override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        lifecycleScope.launch (Dispatchers.IO) { printTcp() }

    }

private suspend fun printTcp() {
        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()
        }
    }

    private val 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"

    private val 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())

USB

USB permission

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), 0);
        IntentFilter filter = new IntentFilter(MainActivity.ACTION_USB_PERMISSION);
        registerReceiver(this.usbReceiver, filter);
        usbManager.requestPermission(usbConnection.getDevice(), permissionIntent);
    }
}

USB code example

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

EscPosPrinter printer = new EscPosPrinter(new UsbConnection(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>"
    );

Charset encoding

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

Formatted text : syntax guide

New line

Use \n to create a new line of text.

Text alignment and column separation

Add an alignment tag on a same line of text implicitly create a new column.

Column alignment tags :

Example :

Font

Size

<font></font> tag allows you to change the font size and color. Default size is normal / black.

Bold

<b></b> tag allows you to change the font weight.

Underline

<u></u> tag allows you to underline the text.

Image

<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.

⚠ WARNING ⚠ : This tag has several constraints :

Barcode

<barcode></barcode> tag allows you to print a barcode. Inside the tag you need to write the code number to print.

⚠ WARNING ⚠ : This tag has several constraints :

QR Code

<qrcode></qrcode> tag allows you to print a QR code. Inside the tag you need to write the QR code data.

⚠ WARNING ⚠ : This tag has several constraints :

Class list

Class : com.khairo.escposprinter.connection.bluetooth.BluetoothPrintersConnections

Static Method : selectFirstPaired()

Easy way to get the first bluetooth printer paired / connected.

Method : getList()

Get a list of bluetooth printers.

Class : com.khairo.escposprinter.connection.usb.UsbPrintersConnections

Static Method : selectFirstConnected()

Easy way to get the first USB printer connected.

Method : getList()

Get a list of USB printers.

Class : com.khairo.escposprinter.EscPosPrinter

Constructor : EscPosPrinter(DeviceConnection printer, int printerDpi, float printingWidthMM, int nbrCharactersPerLine [, EscPosCharsetEncoding charsetEncoding])

Method : disconnectPrinter()

Close the connection with the printer.

Method : getNbrCharactersPerLine()

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

Method : getPrinterWidthMM()

Get the printing width in millimeters

Method : getPrinterDpi()

Get the printer DPI

Method : getPrinterWidthPx()

Get the printing width in dot

Method : getPrinterCharSizeWidthPx()

Get the number of dot that a printed character contain

Method : mmToPx(float mmSize)

Convert the mmSize variable from millimeters to dot.

Method : printFormattedText(String text)

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

Method : printFormattedTextAndCut(String text)

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.

Method : printFormattedText(String text, float mmFeedPaper)

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

Method : printFormattedTextAndCut(String text, float mmFeedPaper)

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.

Method : printFormattedText(String text, int dotsFeedPaper)

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

Method : printFormattedTextAndCut(String text, int dotsFeedPaper)

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.

Method : bitmapToBytes(Bitmap bitmap)

Convert Bitmap object to ESC/POS image.

Class : com.khairo.escposprinter.textparser.PrinterTextParserImg

Static Method : bitmapToHexadecimalString(Printer printer, Drawable drawable)

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

Static Method : bitmapToHexadecimalString(Printer printer, BitmapDrawable bitmapDrawable)

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

Static Method : bitmapToHexadecimalString(Printer printer, Bitmap bitmap)

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

Static Method : bytesToHexadecimalString(byte[] bytes)

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

Static Method : hexadecimalStringToBytes(String hexString)

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

Class : com.khairo.escposprinter.EscPosCharsetEncoding

Constructor : EscPosCharsetEncoding(String charsetName, int escPosCharsetId)

Contributing

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