Printer Service
Printer service is a service which provides a simplified api for printer related operations. This document describes usage of the available printer functions.
Last updated
Printer service is a service which provides a simplified api for printer related operations. This document describes usage of the available printer functions.
Last updated
Copy most recent aar lib file into your project.
Make sure you include aar lib in your Project. In this example project, it is done in /app/.build.gradle file like this:
You can access example usage from .
Line Width: Thermal printer has a fixed line width in pixels. It's 48x8, that is 384 pixels. It should be taken into consideration when using functions like drawLine, setCursorPosition, addTextToLine.
Cursor Position: Cursor position is the horizontal position where the text added by addText() function will be processed into line bitmap. It is incremented automatically.
LineSpacing: Vertical placement of the lines. If linespacing is 1, lines are spaced tightly, If linespacing is 1.5 there will be a half line sized gap between them etc. Line spacing cannot be less than 1.
Print Density: It is the setting that determines energy applied to thermal head. Inappropriate values of this setting may cause text to be too dark or indistinct. Note that use of energy also means battery drainage and heat generation. Here is a quote from original documentation of printer hardware:
Returns error code or 0 if no error.
Possible errorcodes (as listed in PrinterErrorCode enumeration):
Sets fonts face given the enumeration of it.
Sets fontSize to given value. Minimum fontSize value is 8, maximum value is 144
Draws given string into line buffer, does not print bitmap automatically. Useful for creating lines that has different fonts and sizes within. Alignment enumertaion has following values
Prints buffer for current line.
Draws and prints a horizontal line with given thickness and margins
thickness: Vertical thickness of the line in pixels verticalMargin: The empty space that will be left before and after line, in pixels horizontalMargin: The horizontal space (on left and right) to be left on the edges of the line
Prints given text, it can be multiline and can contain tabs. Print is excuted immediately, does not require another command to start.
Text can also include styling commands like setFontFace, setFontSize. This enables user to send multiline and multi style text with a single transaction.
Styled text should start with tag "<s>". You can put styling codes into text yourself, or use StyledString class which provides functions and processes a member string to send. To see a full implementation and example usage of it, see the example project (All available functionality is commented in StyledString class).
Prints a preloaded monochrome bitmap file
name: name of the preloaded monochrome bitmap file without .bmp extension verticalMargin: The empty space that will be left before and after bmp picture, in pixels
Prints given bitmap array
context: Android app context bitmapArray: Monochrome bitmap array to be printed
To make sure if your byte array is properly formatted bitmap, you can check it by BitmapChecker before printing:
Prints the logo of your app
context: Android app context verticalMargin: The empty space that will be left before and after the logo, in pixels
1) Add a drawable monochrome bmp file whose dimensions are 384 pixels (width) by H pixels (height, it can be any size). 2) Add the android:logo attribute to your AndroidManifest.xml that refers to your drawable file 3) Make sure that your app has the "app_name" meta-data that starts with "BNK"
Leaves a blank space of given height in pixels. Takes effect immediately, not a buffered command.
Leaves a blank space of given height in lineHeights (1.5 lines, for example). Takes effect immediately, not a buffered command.
Gets line spacing.
Sets line spacing.
Prints a monochrome bitmap file which is provided in byte array form.
byte array should be smaller than 300 KB and must be a monochrome bitmap format
To make sure if your byte array is properly formatted bitmap, you can check it by BitmapChecker before printing:
Prints given text in Qr Code form.
text: Android app context correctionLvl: ErrorCorrection Level for Qr Code generation Process. verticalMargin: The empty space that will be left before and after Qr Code, in pixels.
correctionLvl and verticalMargin parameters is optional when this function is called via styled string method.
Should be called at the end of each receipt. Cuts the paper or adds necessary space for manuel cutting (depends on device).
PrinterService supports usage of different fonts and it is possible to add new fonts.
Monospace Font: All characters represented with same width in these kind of fonts. Font size: How large the characters printed on a page are.
It is a monospace font.
Font size is 12.
24 characters fit on a line.
It is a monospace font.
Font size is 12.
21 characters fit on a line.
It is a monospace font.
Font size is 12.
24 characters fit on a line.
It is a monospace font.
Font size is 12.
24 characters fit on a line.
It is a monospace font.
Font size is 12.
42 characters fit on a line.
It is a monospace font.
Font size is 12.
48 characters fit on a line.
In order to check printer status in a event listener style method, an application can subscribe to 'Printer State Changed' broadcast. This can be achieved by following steps:
Create a BroadcastReceiver Class
Subscribe to the Broadcast by create an Instance of the PrinterBroadcastReceiver class
This can be achieved by calling the following function in you mainActivity class:
330TR/400TR/1000TR:
v19.6
NatoSansMono font enum is added for 330TR.
27.03.2024
-
-
v20.0
Await print for long print content is added.
08.08.2024
-
-
v20.1
Print aar version and user packagename is added. printTextWithResult api is removed.
14.09.2024
-
-
int
void (int font)
void (int fontSize)
void (String text, Alignment alignment)
void ()
void (int thickness, int verticalMargin, int horizontalMargin)
void (String text)
void (String name, int verticalMargin)
void (Context ctx, byte[] bitmapArray)
void (Context context, int verticalMargin)
void (int pixelHeight)
void (float lines)
float ()
void (float f)
int ()
void (int density)
void (byte[] bitmapArray)
void (String text, ErrorCorrectionLevel correctionLvl, int verticalMargin)
void ()
Returns current print density. See .
Sets print density. It can take values from 60 to 140 percent. Values out of this ranges are ignored. See
Note: This function is suitable for printing small bitmaps like logos. If your bitmap exceeds a certain size (30kb for now), no bitmap will be printed. If you need a larger bitmap to be printed, use void function instead.
