Manual JavaPOS LineDisplay English V1.01
Manual JavaPOS LineDisplay English V1.01
JavaPOS Driver
Ver. 1.01
BCD-2000 / BCD-3000
http://www.bixolon.com
JavaPOS Driver
Introduction
This manual provides information on the BIXOLON JavaPOS driver as well as on the
usage LineDisplay products offered by BIXOLON.
[Reference Websites]
http://www.javapos.com : Java POS committee website
http://java.com : Official Java website
http://www.bixolon.com : BIXOLON website
We at BIXOLON maintain ongoing efforts to enhance and upgrade the functions and
quality of all our products. In following, product specifications and/or user manual
content may be changed without prior notice.
- 2 -
Ver. 1.01
JavaPOS Driver
Table of Contents
1. Development environment .......................................................................................... 4
1-1 Communication Configuration ........................................................................................ 4
5. Reference ..................................................................................................................... 21
5-1 JPOS Constant Value (defines)........................................................................................ 21
5-1-1 Display Type ............................................................................................................... 21
5-1-2 Scroll Text ................................................................................................................... 21
5-1-3 Marquee Type ............................................................................................................ 21
5-1-4 Marquee Format........................................................................................................ 21
5-1-5 Bitmap ........................................................................................................................ 22
5-2 Codepage.......................................................................................................................... 23
5-2-1 Basic codepage .......................................................................................................... 23
5-2-2 International characterset code table .................................................................... 24
5-2-3 International characterset Example........................................................................ 24
- 3 -
Ver. 1.01
JavaPOS Driver
1. Development environment
1-1 Communication Configuration
Communication Configuration for serial interface
You will set communication configuration in JCL Utility.
- 4 -
Ver. 1.01
JavaPOS Driver
2. Properties / Methods
This section describes the properties and methods supported by the LineDisplay device.
For more details on UPOS, refer to the UPOS 1.13 agreement.
BCD-2000/2000K
Capability Property
BCD-3000
CapBlink DISP_CB_BLINKALL
CapBrightness FALSE
CapCharacterSet DISP_CCS_ASCII
CapDescriptors FALSE
CapHMarquee TRUE
CapVMarquee FALSE
CapICharWait TRUE
CapPowerReporting JPOS_PR_STANDARD
CapBlinkRate TRUE
CapCursorType DISP_CCT_UNDERLINE
CapCustomGlyph FALSE
CapReadBack FALSE
CapReverse DISP_CR_REVERSEEACH
CapBitmap TRUE
CapMapCharacterSet FALSE
CapScreenMode FALSE
CapStatisticsReporting FALSE
CapUpdateStatistics FALSE
CapCompareFirmwareVersion FALSE
CapUpdateFirmware FALSE
- 5 -
Ver. 1.01
JavaPOS Driver
2-1-2 Properties default value / range
- 6 -
Ver. 1.01
JavaPOS Driver
2-1-3 Description of Major Properties
1) deviceEnabled
• Description: It indicates whether LineDisplay is used or not. LineDisplay can be used
by setting this value as true after calling open and claim method.
• Relevant method: void setDeviceEnabled(boolean)
2) characterSetList
• Description: It brings the list of character set from LineDisplay.
• Relevant method: String getCharacterSetList()
3) characterSet
• Description: It is the character set used in case of outputting LineDisplay.
It can be set among values in the characterSetList.
It should be set after deviceEnabled is set as true.
• Relevant method: void setCharacterSet(int)
• Example
lineDisplay.setCharacterSet(1); // Katakana setting
4) deviceColumns
• Description: It refers to the number of characters which can be indicated in a line.
• Relevant method: void displayText(String, int)
void displayTextAt(int, int, String, int)
5) deviceRows
• Description: It refers to the number of lines which can be displayed on a screen.
• Relevant method: void displayText(String, int)
void displayTextAt(int, int, String, int)
- 7 -
Ver. 1.01
JavaPOS Driver
6) blinkRate
• Description: It sets a period of blinking text (time unit: ms)
• Relevant method: void displayText(String, int)
void displayTextAt(int, int, String, int)
• Example
//Setting the blinkRate as 1000ms (1 sec)
lineDisplay.setBlinkRate(1000);
7) interCharacterWait
• Description: It sets the waiting time between characters in the text output in the
Teletype mode
(effect of outputting each character one by one, time unit: ms).
• Relevant method: void displayText(String, int)
void displayTextAt(int, int, String, int)
• Example
//Setting an interval of character output as 300ms (0.3 sec)
lineDipslay.setInterCharacterWait(300);
8) maximumX
• Description: It refers to the number of pixels with the maximum width from
LineDisplay.
• Relevant method: void displayBitmap(String, int, int, int)
void setBitmap(int, String, int, int, int)
• Example
//Outputting a bitmap image in the center occupying half of the screen in size
String strPath = "logo.bmp";
int width = lineDisplay.getMaximumX() / 2;
lineDisplay.displayBitmap (strPath, width, LineDisplayConst.DISP_BM_CENTER,
lineDisplayConst.DISP_BM_CENTER);
For more details related to the properties, refer to the UPOS 1.13
Note Protocol Document.
- 8 -
Ver. 1.01
JavaPOS Driver
2-1-4 Methods
Method Value
clearText O
displayText O
displayTextAt O
scrollText O
clearDescriptors X
setDescriptors X
createWindow O
destroyWindow O
refreshWindow O
defineGlyph X
readCharacterAt X
displayBitmap O
setBitmap O
O: Supported X: Not Supported
- 9 -
Ver. 1.01
JavaPOS Driver
2-1-5 Description of Major Methods
1) displayText
• Description: It outputs the text at the position of the screen cursor.
• Method prototype: void displayText(String, int)
• Parameter information
- String data: It sets the text to output to the screen.
- int attribute: It designates the property for the method indicated on the screen
(Refer to JPOS constant value).
• Example
//Outputting the text at the current position of the cursor
lineDisplay.displayText("Normal", LineDisplayConst.DISP_DT_NORMAL);
2) displayTextAt
• Description: It outputs the text at the position designated on the screen.
• Method prototype: void displayTextAt(int, int, String, int)
• Parameter information
- int row: It designates the starting row of text to output.
- int column: It designates the starting column of text to output.
- String data: It sets the text to output on the screen.
- int attribute: It designates the property the method indicated on the screen
(Refer to JPOS constant value).
• Example
//Outputting the text on the position of row 1 and column 1
lineDisplay.displayTextAt(0, 0, "normal", LineDisplayConst.DISP_DT_NORMAL);
3) clearText
• Description: It erases all the texts output on the screen.
• Method prototype: void clearText(void)
- 10 -
Ver. 1.01
JavaPOS Driver
4) scrollText
• Description: It scrolls the text output on the screen up, down, left and right.
• Method prototype: void scrollText(int, int)
• Parameter information
- int direction: It designates a direction to scroll (Refer to JPOS constant value).
- int units: It designates the number of rows or columns to scroll.
• Example
//Scrolling two spaces to the right
lineDisplay.scrollText(LineDisplayConst.DISP_ST_RIGHT, 2);
5) createWindow
• Description: It generates viewport in the part of display screen by the first four
parameters.
The size of window is determined by the last two parameters.
• Method prototype: void createWindow(int, int, int, int, int, int)
• Parameter information
- int viewportRow: It designates the starting row of viewport.
- int viewportColumn: It designates the starting column of viewport.
- int viewportHeight: It designates the height of viewport.
- int viewportWidth: It designates the width of viewport.
- int windowHeight: It designates the height of window.
- int windowWidth: It designates the width of window.
• Example
// Generating viewport of 2x4 on the window of 2x4 in the row 1 and column 4
lineDisplay.createWindow(0, 3, 2, 4, 2, 4);
lineDisplay.displayText("abcdABCD", LineDisplayConst.DISP_DT_NORMAL);
- 11 -
Ver. 1.01
JavaPOS Driver
6) displayBitmap
• Description: It outputs a bitmap image on the screen.
• Method prototype : void displayBitmap(String, int, int, int)
• Parameter information
- String fileName: It designates the path of bitmap image file.
- int width: It designates the width of bitmap to output on the screen
(Refer to JPOS constant value).
- int alignmentX: It designates the position of alignment in the transverse direction
(Refer to JPOS constant value).
- int alignmentY: It designates the position of alignment in the longitudinal direction
(Refer to JPOS constant value).
• Example
//Bitmap image path
String strPath = "C:\\Logo.bmp";
//Outputting an image in the right center of the screen according to the width size
//of bitmap image
lineDisplay.displayBitmap(strPath, LineDisplayConst.DISP_BM_ASIS,
lineDisplayConst.DISP_BM_CENTER, LineDisplayConst.DISP_BM_CENTER);
For more details related to the methods, refer to the UPOS 1.13
Note Protocol Document.
- 12 -
Ver. 1.01
JavaPOS Driver
3. Extended Method
This section is to explain DirectIO method.
Command Description
DISP_DI_OUTPUT Send object data
DISP_DI_INTERNATIONAL_CHAR Define International characterset
command DISP_DI_OUTPUT
Argument data null
object Output data
Sends data without any process after checking LineDisplay status.
Description
“object” is not affected by “BinaryConversion”
Return Value Result Code ResultCodeExtended
JPOS_SUCCESS 0
JPOS_E_CLOSED 0
JPOS_E_CLAIMED 0
JPOS_E_NOTCLAIMED 0
JPOS_E_DISABLED 0
JPOS_E_BUSY 0
JPOS_E_ILLEGAL 0
JPOS_E_OFFLINE 0
JPOS_E_FAILURE 0
- 13 -
Ver. 1.01
JavaPOS Driver
3-2-2 International characterset setting
command DISP_DI_INTERNATIONAL_CHAR
One of the commands:
DISP_DI_CHAR_USA: 0
DISP_DI_CHAR_FRANCE: 1
DISP_DI_CHAR_GERMANY: 2
DISP_DI_CHAR_UK: 3
DISP_DI_CHAR_DENMARK1: 4
DISP_DI_CHAR_SWEDEN: 5
DISP_DI_CHAR_ITALY: 6
Argument data DISP_DI_CHAR_SPAIN: 7
DISP_DI_CHAR_JAPAN: 8
DISP_DI_CHAR_NORWAY: 9
DISP_DI_CHAR_DENMARK2: 10
DISP_DI_CHAR_SPAIN2 : 11
DISP_DI_CHAR_LATIN_AMERICA : 12
DISP_DI_CHAR_KOREA : 13
DISP_DI_CHAR_SLOVENIA_CROATIA : 14
DISP_DI_CHAR_CHINA : 15
object null
Sets International character set. If CharacterSet property value is
Description changed, International character set will be reset.
Refer to International character code table and related method.
Return Result Code ResultCodeExtended
JPOS_SUCCESS 0
JPOS_E_CLOSED 0
JPOS_E_CLAIMED 0
JPOS_E_NOTCLAIMED 0
JPOS_E_DISABLED 0
JPOS_E_BUSY 0
JPOS_E_ILLEGAL 0
JPOS_E_OFFLINE 0
JPOS_E_FAILURE 0
3-3 DirectIOEvent
Not used.
- 14 -
Ver. 1.01
JavaPOS Driver
4. Error Information
This section contains information about the return results when using the properties
and methods related to LineDisplay.
4-1-1 Properties
Property Name ResultCode ResultCodeExtended Description
Refer to UPOS
JPOS_SUCCESS 0
Specification
BinaryConversion Refer to UPOS
JPOS_E_CLOSED 0
Specification
JPOS_E_ILLEGAL JPOS_EXX_BADARGUMENT Set value is illegal
Refer to UPOS
JPOS_SUCCESS 0
Specification
Refer to UPOS
DeviceEnabled JPOS_E_CLOSED 0
Specification
Refer to UPOS
JPOS_E_NOTCLAIMED 0
Specification
Refer to UPOS
JPOS_SUCCESS 0
Specification
FreezeEvent
Refer to UPOS
JPOS_E_CLOSED 0
Specification
Refer to UPOS
JPOS_SUCCESS 0
Specification
Refer to UPOS
JPOS_E_CLOSED 0
Specification
PowerNotify Refer to UPOS
0
Specification
JPOS_E_ILLEGAL The function
JPOS_EXX_INCAPABLE
cannot be used
JPOS_EXX_BADARGUMENT Set Value is illegal
Refer to UPOS
JPOS_SUCCESS 0
Specification
Refer to UPOS
JPOS_E_CLOSED 0
Specification
Refer to UPOS
JPOS_E_NOTCLAIMED 0
Specification
DeviceBrightness
Refer to UPOS
JPOS_E_DISABLED 0
Specification
Refer to UPOS
0
Specification
JPOS_E_ILLEGAL
Marquee is under
JPOS_EXX_INVALIDMODE
execution
- 15 -
Ver. 1.01
JavaPOS Driver
JPOS_EXX_DEVBUSY The device is busy
Output result is
not returned
JPOS_EXX_TIMEOUT
within the
timeout period
The function
JPOS_EXX_INCAPABLE
cannot be used
- 16 -
Ver. 1.01
JavaPOS Driver
Refer to UPOS
JPOS_SUCCESS 0
Specification
MarqueeFormat Refer to UPOS
JPOS_E_CLOSED 0
Specification
JPOS_E_ILLEGAL JPOS_EXX_BADARGUMENT Illegal value
Refer to UPOS
JPOS_SUCCESS 0
Specification
MarqueRepeatW
Refer to UPOS
ait JPOS_E_CLOSED 0
Specification
JPOS_E_ILLEGAL JPOS_EXX_BADARGUMENT Illegal value
Refer to UPOS
JPOS_SUCCESS 0
Specification
InterCaracterWai Refer to UPOS
JPOS_E_CLOSED 0
t Specification
Set value is
JPOS_E_ILLEGAL JPOS_EXX_BADARGUMENT
illegal
- 17 -
Ver. 1.01
JavaPOS Driver
4-1-2 Methods
Method
ResultCode ResultCodeExtended Description
Name
Refer to UPOS
JPOS_SUCCESS 0
Specification
Refer to UPOS
JPOS_E_CLOSED 0
Specification
Refer to UPOS
ClaimDevice JPOS_E_TIMEOUT 0
Specification
JPOS_EXX_BADARGUMENT Set value is illegal
JPOS_EXX_DEVBUSY The device is busy
JPOS_E_ILLEGAL
Port number is
JPOS_EXX_PORTUSED
illegal
Refer to UPOS
JPOS_SUCCESS 0
Specification
Refer to UPOS
JPOS_E_CLOSED 0
Specification
Refer to UPOS
JPOS_NOTCLAIMED 0
Specification
Refer to UPOS
JPOS_E_DISABLED 0
Specification
CheckHealth JPOS_EXX_BADARGUMENT Set value is illegal
JPOS_EXX_DEVBUSY The device is busy
Marquee is under
JPOS_EXX_INVALIDMODE
JPOS_E_ILLEGAL execution
Output result is not
JPOS_EXX_TIMEOUT returned within the
timeout
Refer to UPOS
JPOS_E_BUSY 0
Specification
Refer to UPOS
JPOS_SUCCESS 0
Specification
Refer to UPOS
JPOS_E_CLOSED 0
Specification
Refer to UPOS
JPOS_NOTCLAIMED 0
Specification
Refer to UPOS
JPOS_E_DISABLED 0
DirectIO Specification
JPOS_EXX_BADARGUMENT Set value is illegal
JPOS_EXX_DEVBUSY The device is busy
Marquee is under
JPOS_EXX_INVALIDMODE
JPOS_E_ILLEGAL execution
Output result is not
JPOS_EXX_TIMEOUT returned within the
timeout
- 18 -
Ver. 1.01
JavaPOS Driver
Method ResultCode ResultCodeExtended Description
Refer to UPOS
JPOS_SUCCESS 0
Specification
Refer to UPOS
JPOS_E_CLOSED 0
Specification
DisplayText Refer to UPOS
JPOS_NOTCLAIMED 0
DisplayTextAt Specification
ClearText Refer to UPOS
JPOS_E_DISABLED 0
CreateWindow Specification
RefreshWindo JPOS_EXX_BADARGUMENT Set value is illegal
w JPOS_EXX_DEVBUSY The device is busy
ScrollText Marquee is under
JPOS_EXX_INVALIDMODE
JPOS_E_ILLEGAL execution
Output result is not
JPOS_EXX_TIMEOUT returned within the
timeout
Refer to UPOS
JPOS_SUCCESS 0
Specification
Refer to UPOS
JPOS_E_CLOSED 0
Specification
Refer to UPOS
JPOS_NOTCLAIMED 0
Specification
DestroyWindo Refer to UPOS
JPOS_E_DISABLED 0
w Specification
JPOS_EXX_DEVBUSY The device is busy
Marquee is under
JPOS_EXX_INVALIDMODE
execution
JPOS_E_ILLEGAL
Output result is not
JPOS_EXX_TIMEOUT returned within the
timeout
- 19 -
Ver. 1.01
JavaPOS Driver
4-2 Added error information
ResultCodeExtended Description
Parameters for Method are out of range or have
JPOS_EXX_BADARGUMENT
logical error.
JPOS_EXX_INCAPABLE Not supported by LineDisplay
JPOS driver failed to send data to LineDisplay during
JPOS_EXX_TIMEOUT
the period of default time out value.
JPOS_EXX_INVALIDMODE Linedisplay is in marquee mode.
Other application is occupying LineDisplay or
JPOS_EXX_DEVBUSY
LineDisplay is processing other requests.
Other device or application program occupies the
JPOS_EXX_PORTUSED
current port.
- 20 -
Ver. 1.01
JavaPOS Driver
5. Reference
- 21 -
Ver. 1.01
JavaPOS Driver
5-1-5 Bitmap
Code define Description
It outputs an image on the screen
DISP_BM_ASIS
according to the width.
DISP_BM_LEFT It outputs an image aligned to the left.
DISP_BM_CENTER It outputs an image aligned to the center.
DISP_BM_RIGHT It outputs an image aligned to the right.
DISP_BM_TOP It outputs an image aligned upwards.
DISP_BM_BOTTOM It outputs an image aligned downwards.
- 22 -
Ver. 1.01
JavaPOS Driver
5-2 Codepage
- 23 -
Ver. 1.01
JavaPOS Driver
5-2-2 International characterset code table
- 24 -
Ver. 1.01
JavaPOS Driver
This User Manual and product are protected under copyright law.
It is strictly prohibited to copy, duplicate, translate or convert into electronic form the
whole or any part of the manual and product without the prior written approval of
BIXOLON.
BIXOLON maintains ongoing efforts to enhance and upgrade the functions and quality
of all our products. In the following, product specifications and/or user manual content
may be changed without prior notice.
Warning - U.S.A
This equipment has been tested and found to comply with the limits for a Class A digital
device pursuant to Part 15 of the FCC Rules. These limits are designed to provide
reasonable protection against harmful interference when the equipment is operated in
a commercial environment. This equipment generates uses, and can radiate radio
frequency energy and, if not installed and used in accordance with the instruction
manual, may cause harmful interference to radio communications. Operation of this
equipment in a residential area is likely to cause harmful interference in which case the
user will be required to correct the interference at his own expense.
Notice - Canada
This Apparatus complies with class “A” limits for radio interference as specified in the
Canadian department of communications radio interference regulations. Get appareil
est conforme aux normes class “A” d’interference radio tel que specifier par ministre
canadien des communications dans les reglements d’interference radio.
Caution
Some semiconductor devices are easily damaged by static electricity. You should turn
the LineDisplay “OFF”, before you connect or remove the cables on the rear side, in
order to guard the LineDisplay against the static electricity. If the LineDisplay is
damaged by the static electricity, you should turn the LineDisplay “OFF”.
- 25 -
Ver. 1.01
JavaPOS Driver
Revision history
- 26 -
Ver. 1.01