https://github.com/mazenrashed/Printooth

A well documented, high-level Android interface that makes printing via bluetooth printers easier
https://github.com/mazenrashed/Printooth

android android-library bluetooth bluetooth-printer kotlin kotlin-android kotlin-library library pairing print printer printing sewoo woosim

Last synced: about 2 months ago
JSON representation

A well documented, high-level Android interface that makes printing via bluetooth printers easier

• Host: GitHub
• URL: https://github.com/mazenrashed/Printooth
• Owner: mazenrashed
• License: mpl-2.0
• Created: 2018-10-13T11:00:59.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-13T07:26:36.000Z (over 1 year ago)
• Last Synced: 2024-07-03T04:06:49.937Z (5 months ago)
• Topics: android, android-library, bluetooth, bluetooth-printer, kotlin, kotlin-android, kotlin-library, library, pairing, print, printer, printing, sewoo, woosim
• Language: Kotlin
• Homepage:
• Size: 264 KB
• Stars: 395
• Watchers: 13
• Forks: 112
• Open Issues: 60
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-jordan - Printooth - Universal thermal Bluetooth printers driver, It's easy, generic and well documented. (Android)

README

        
# Printooth

[![](https://jitpack.io/v/mazenrashed/Printooth.svg)](https://jitpack.io/#mazenrashed/Printooth)

[![Android Arsenal]( https://img.shields.io/badge/Android%20Arsenal-Printooth-green.svg?style=flat )]( https://android-arsenal.com/details/1/7323 )

Printooth aim is to provide a simple abstraction for use the Bluetooth printers regardless of its brand.

###  Add the JitPack repository to your build file

```groovy

allprojects {

    repositories {

        ...

        maven { url 'https://jitpack.io' }

    }

}

```

### Add dependency

```groovy

dependencies {

    implementation 'com.github.mazenrashed:Printooth:${LAST_VERSION}'

}

```

### Add permissions to manifest

```groovy

  

```

### Initialize Printooth

Should be initialized once in `Application.onCreate()`:

```kotlin

Printooth.init(context);

```

### Scan and pair printer

Printooth is providing a scanning activity to make pairing process easy. Just start `ScanningActivity` and you will skip the process of pairing and saving printer.

```kotlin

startActivityForResult(Intent(this, ScanningActivity::class.java), ScanningActivity.SCANNING_FOR_PRINTER)

```

When the printer is being ready:

```kotlin

override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {  

    super.onActivityResult(requestCode, resultCode, data)  

    if (requestCode == ScanningActivity.SCANNING_FOR_PRINTER && resultCode == Activity.RESULT_OK)  

        //Printer is ready now 

}

```

If you want to make your own user interface, you can pass your paired printer to Printooth like this:

```kotlin

Printooth.setPrinter(printerName, printerAddress)

```

Check if Printooth has saved printer:

```kotlin

Printooth.hasPairedPrinter()

```

To get the current saved printer:

```kotlin

Printooth.getPairedPrinter()

```

To remove the current saved printer:

```kotlin

Printooth.removeCurrentPrinter()

```

### Printing

Printooth provides a simple builder to design your paper.

To print `Hello World` simply, write this code:

```kotlin

var printables = ArrayList()

var printable = TextPrintable.Builder()  

        .setText("Hello World")

        .build()

printables.add(printable)

Printooth.printer().print(printables)

```

Use all builder functionalities:

```kotlin

var printables = ArrayList()

var printable = TextPrintable.Builder()  

        .setText("Hello World") //The text you want to print

        .setAlignment(DefaultPrinter.ALLIGMENT_CENTER)

        .setEmphasizedMode(DefaultPrinter.EMPHASISED_MODE_BOLD) //Bold or normal  

        .setFontSize(DefaultPrinter.FONT_SIZE_NORMAL)

        .setUnderlined(DefaultPrinter.UNDELINED_MODE_ON) // Underline on/off

        .setCharacterCode(DefaultPrinter.CHARACTER_CODE_USA_CP437) // Character code to support languages

        .setLineSpacing(DefaultPrinter.LINE_SPACING_60)

        .setNewLinesAfter(1) // To provide n lines after sentence

        .build()

printables.add(printable)

Printooth.printer().print(printables)

```

### Listen to your printing order state:

```kotlin

Printooth.printer().printingCallback = object : PrintingCallback {  

    override fun connectingWithPrinter() { } 

  

    override fun printingOrderSentSuccessfully() { }  //printer was received your printing order successfully.

  

    override fun connectionFailed(error: String) { }  

  

    override fun onError(error: String) { }  

  

    override fun onMessage(message: String) { }  

}

```

### Use more than printer in the same time:

```kotlin

var printer1 = PairedPrinter(name, address)  

var printer2 = PairedPrinter(name, address)  

Printooth.printer(printer1).print(printables)  

Printooth.printer(printer2).print(printables)

```

### If you have a printer with deferent commands

Create a class from type `Printer` and override the initializers method, then return your printer commands from the printers command sheet ( You can find it on the Internet ), let's take an example:

 ```kotlin

 open class MyPrinter : Printer() {  

  

    override fun initLineSpacingCommand(): ByteArray = byteArrayOf(0x1B, 0x33)  

  

    override fun initInitPrinterCommand(): ByteArray = byteArrayOf(0x1b, 0x40)  

  

    override fun initJustificationCommand(): ByteArray = byteArrayOf(27, 97)  

  

    override fun initFontSizeCommand(): ByteArray = byteArrayOf(29, 33)  

  

    override fun initEmphasizedModeCommand(): ByteArray = byteArrayOf(27, 69)

  

    override fun initUnderlineModeCommand(): ByteArray = byteArrayOf(27, 45) 

  

    override fun initCharacterCodeCommand(): ByteArray = byteArrayOf(27, 116)  

  

    override fun initFeedLineCommand(): ByteArray = byteArrayOf(27, 100)  

    

    override fun initPrintingImagesHelper(): PrintingImagesHelper = DefaultPrintingImagesHelper()

}

```

If you have issues with printing images, you can implement the process of transfaring image from bitmap to ByteArray manually by extends PrintingImagesHelper class and implement getBitmapAsByteArray, then you shold return an object from your helper to initPrintingImagesHelper() as this example:

```kotlin

class MyPrintingImagesHelper : PrintingImagesHelper {  

    override fun getBitmapAsByteArray(bitmap: Bitmap): ByteArray {  

        return convertBitmapToByteArray(bitmap)  

    }  

}

//in your printer class

open class MyPrinter : Printer() {  

    ....

    ....

    override fun initPrintingImagesHelper(): PrintingImagesHelper = MyPrintingImagesHelper()

}

//when using printooth

private val printing = Printooth.printer(MyPrinter())

...

printing.print(printables)

```

Then pass your printer class to Printooth:

```kotlin

Printooth.printer(MyPrinter()).print(printables)

```

### Proguard config

````

-keep class * implements java.io.Serializable { *; }

````

## Contributing

We welcome contributions to Printooth!

* ⇄ Pull requests and ★ Stars are always welcome.

## Java examples

Thanks for @lafras-h for the nice project [JavaPrintooth](https://github.com/lafras-h/JavaPrintooth) , it's an examples to use Printooth in java