LV document version
Copyright © 2005 Elcom s. r. o.
Revision History | ||
---|---|---|
Revision 1.00 | 27. Feb. 2006 | JAD |
Build of LV document version For Comm32.dll from version 4.29. | ||
Revision 1.01 | 4. May 2006 | JAD |
Documentation change for Comm32.dll from version 4.31. | ||
Revision 1.02 | 17. July 2006 | JAD |
Illegal characters and roman numbers are converted from text to binary data as 'space'. | ||
Revision 1.03 | 19. Apr. 2007 | JAD |
Fixed all known bugs in descriptions. | ||
Revision 1.04 | 22. May 2007 | JAD |
Added support for decimal comma/dot configuration. | ||
Revision 1.05 | 28. Mar. 2008 | JAD |
Added description for back ONLINE receive (Chapter 5, Data description for "ECR --> PC ONLINE mode" and Section 1.18, “Activation of receiving back ONLINE data”). |
Abstract
Document contains description how to use communication library Comm32.dll. This DLL can be used with the following ECR types: Euro-500T Handy.
Table of Contents
Table of Contents
Free Version License. By receiving and/or using Elcom communication software, you accept the following Free Version User Agreement. This agreement is a binding legal agreement between Elcom s. r. o. and the purchasers, users or evaluators of Elcom software and products. If you do not intend to honor this agreement, remove all installed Elcom software from your computer now.
Free Version Distribution. This Free Version software may be freely distributed, provided that:
Such distribution includes only the original archive supplied by Elcom s. r. o. You may not alter, delete or add any files in the distribution archive (the only exception is in point 3).
No money is charged to the person receiving the software, beyond reasonable cost of packaging and other overhead.
Original files can be distributed included in application software that supports product from Elcom s. r. o.
For information about redistribution of
Elcom communication software visit our web site at
http://www.elcom.sk or e-mail
us <elcom@elcom.sk>
.
Free Version User Agreement.
Usage and distribution restrictions. The evaluator/user/buyer/owner may not use or distribute Elcom software for any unlawful purpose. The evaluator/user/buyer/owner is not allowed to attempt to disassemble or decompile Elcom Software and products.
Copyright restriction. Elcom name and any logo or graphics file that represents our software may not be used in any way to promote products developed with our software. All parts of Elcom software and products are copyright protected.
Limitation of responsibility. The evaluator/user/buyer/owner of Elcom software will indemnify and defend Elcom against lawsuits, claims, costs associated with defense or accusations that result from the use of Elcom software.
Elcom is not responsible for any damages whatsoever, including loss of information, interruption of business, personal injury and/or any damage or consequential damage without limitation, incurred before, during or after the use of our products.
Table of Contents
int InitComm(
portNum, portSpeed)
;int
portNum
;int
portSpeed
;
description. This function is called before communication if it is necessary to open communication port.
input parameters.
portNum
port number, which is ECR connected to: 1 – 255 (COM1 – COM255)
portSpeed
communication speed between ECR and PC: 9600 Baud, 38400 Baud
return value.
0 – port initialized
1 – port number incorrect
2 – transmission speed incorrect
4 – unable to open particular port
5 – unable to read actual port setting
6 – unable to set port
Port setting: 8 data bits, 1 stop bit, none parity
Set communication speed 9600 Baud for modem communication
int DialUp(
phoneNumber)
;char *
phoneNumber
;
description. Calling before communication and directly after InitComm
function
for dial up a modem connection.
input parameters.
*phoneNumber
phone number in text form
return value.
0 – connection established
1 – connection not established
2 – port is not opened
String of modem setting is "ATE0V0X0
",
where:
E0
– echo off
V0
– numerical form of final codes
X0
– settings of final codes and monitoring of
connection progress
- for detailed information see user guide of the modem
int CloseComm(
)
;
description.
return value.
0 – port closed
1 – unable to close port
int InitEcr(
ecrNum, ecrType)
;int
ecrNum
;int
ecrType
;
int InitEcrEx( | ecrNum, | |
ecrType, | ||
ecrCountry) ; |
int | ecrNum; |
int | ecrType; |
int | ecrCountry; |
description.
Function sets ECR type and number for communication
InitEcrEx
function will also set up
the character conversion tables (for Windows), rounding
algorithm and other features specific to given country.
InitEcr
function will set up default
properties and the character conversion table to 1:1 mode, i. e.
no conversion takes place.
input parameters.
return value.
0 – type and ECR number set
1 – ECR number incorrect
2 – ECR type incorrect (or this ECR is not supported in this version or country)
int AutoDetect( | EcrNum, | |
PortNum, | ||
PortSpeed, | ||
EcrType) ; |
int | EcrNum; |
int * | PortNum; |
int * | PortSpeed; |
int * | EcrType; |
int AutoDetectEx( | EcrNum, | |
PortNum, | ||
PortSpeed, | ||
EcrType, | ||
nCountry, | ||
nOptions) ; |
int | EcrNum; |
int * | PortNum; |
int * | PortSpeed; |
int * | EcrType; |
int | nCountry; |
int | nOptions; |
description. Function detects type of connected ECR, port number to which is
ECR connected and transmission speed on which is ECR set. Function
AutoDetectEx
detects only ECR type for selected
country and with selected options. It is desirable to specify the
country so the application would not waste time detecting ECRs that
don't exist for the given country and tested only the ECRs implemented
for the given country. Selected options also makes the detection
faster.
input parameters.
EcrNum
number of connected ECR - must be entered.
PortNum
pointer of variable containing port number
PortSpeed
pointer of variable containing transmission speed
EcrType
pointer of variable containing type of connected ECR
nCountry
desired country
nOptions
auto detection parameters – it is a bit-map of settings where individual bits take following meanings:
bit 0 (value 1):
PortNum
variable contains the
number of tested port.
bit 1 (value 2):
PortSpeed
variable contains the
communication speed.
bit 2 (value 4): prolonged break signal – useful when testing via the modem connection.
Result number is obtained by simple addition of desired values.
output parameters.
PortNum
detected COM port
PortSpeed
detected Speed
EcrType
detected type
0 – auto detection successful
1 – auto detection not successful
3 – particular port reserved
4 – ECR number incorrect (out of range)
5 – incorrect port
6 – incorrect communication speed
int SendData( | CommandNum, | |
FirstItem, | ||
ItemCount, | ||
Data, | ||
Info) ; |
int | CommandNum; |
int | FirstItem; |
int | ItemCount; |
unsigned char * | Data; |
char * | Info; |
description. Function starts data transmission from PC to ECR.
Input parameters.
CommandNum
FirstItem
ItemCount
Data
Pointer to data (binary), which will be transmitted to ECR.
Info
Pointer to array, where will be stored information about
transfer. Should be used for commands 'Send PLUs' and 'Send
cashier message'. Length of variable
Info
should be equal to
ItemCount
at least.
Output parameters.
Info
Meaning of return values in Info
is:
'A' =
Changed VAT level for PLU
(only for programming PLUs).
'N' =
VAT level unchanged
(only for programming PLUs).
'W' =
Warning, item transmitted but
is incorrect and was not accepted by ECR.
'P' =
Line was printed on ECR.
(only for sending messages for
cashier).
'E' =
Error - wrong data or transfer
error.
'T' =
Incorrect Tax / VAT level
assignment (item but is incorrect and was not
accepted by ECR).
'D' =
Incorrect Department assignment
(item but is incorrect and was not accepted by
ECR).
'U' =
Incorrect Unit assignment
(item but is incorrect and was not accepted by
ECR).
'Q' =
Incorrect stock or
quantity(item but is incorrect and was not
accepted by ECR).
'V' =
Incorrect price (item
but is incorrect and was not accepted by
ECR).
'I' =
Index out of range.
'C' =
Incorrect text string /
character (e. g. PLU name).
'B' =
Incorrect bar code
(only for programming PLUs).
'@' =
OK (no error has occurred
during transfer of packet)
unchanged if item was not send to ECR.
First position in Info
represents first transmitted PLU, first line of message,
or fist transmitted packet for all other communication
commands.
0 – Transmission started
1 – Undefined or unsupported operation
2 – Number of transmitted data incorrect
3 – Number of first transmitted data is incorrect
4 – Missing or wrong pointer to
Data
5 – Missing or wrong pointer
Info
(not
used)
6 – Port is not open - need to call function InitComm
first.
7 – ECR is not initialized - need to call function
InitEcr
or InitEcrEx
first.
int RecvData( | CommandNum, | |
FirstItem, | ||
ItemCount, | ||
Data) ; |
int | CommandNum; |
int | FirstItem; |
int | ItemCount; |
unsigned char * | Data; |
description. Function starts data transmission from ECR to PC.
input parameters.
CommandNum
FirstItem
ItemCount
Data
Pointer to data array where should be stored received binary data from ECR.
output parameters.
Data
received binary data from ECR
0 – Transmission started
1 – Undefined or unsupported operation
2 – Number of transmitted data incorrect
3 – Number of first transmitted data is incorrect
4 – Missing or wrong pointer to
Data
6 – Port is not open - need to call function InitComm
first.
7 – ECR is not initialized - need to call function
InitEcr
or InitEcrEx
first.
int CancelComm(
)
;
description. Function aborts running communication.
return value.
0 – communication stopped
7 – ECR was not initialized
int GetStatus( | Percentage) ; |
unsigned int * | Percentage; |
description. Function informs about running communication.
input parameters.
Percentage
Pointer to variable to store transfer status in percentage.
output parameters.
Percentage
Field Percentage
contains state
of successfully transferred data in percent.
-1 – No communication is in progress
0 – Communication finished without any error
1 – Running communication
2 – Communication interrupted by function CancelComm()
3 – Error during communication – incorrect or missing packet ACK1 (connect to ECR)
4 – Error during communication – incorrect or missing packet ACK2 (bad ECR type or command or command parameters)
5 – Error during communication – incorrect or missing packet ACK3 (by communication PC -> ECR)
5 – Error during communication – incorrect or missing data packet (by communication ECR -> PC)
6 – Error during communication – incorrect or missing packet EOC
8 – Communication finished without any error and with tax level change of one PLU at least (only for programming PLUs)
9 – Sale is started in ECR
11 – Wrong received data.
12 – Unknown error (Extended code is possible to
get with GetECR_Info()
or / and GetLastAckResult()
)
13 – Sending data error.
int
GetLastAckResult(
)
;
description. Function returns value of last accepted ACK packet (”0” if no received).
return value. see ACK result table
Function is important especially for PC-Online communication and PLU programming.
int GetItemsCount(
CommandNum)
;int
CommandNum
;
description. Function returns maximal item count (of same type) for selected command.
input parameters.
CommandNum
return value.
-3 – ECR not initialized
-4 – command is not supported
0 – unknown items count (PLU with non zero sale, journals, ...)
n – Items count. (for CommandNum
=
3, n = PLU count, for CommandNum
= 5, n =
VAT levels count, ...)
int GetRecordLength( | CommandNum, | |
FirstItem, | ||
ItemCount) ; |
int | CommandNum; |
int | FirstItem; |
int | ItemCount; |
description. Function serves to determine the amount of memory space demanded for given record(s). (e. g. for proper allocation of memory space)
input parameters.
CommandNum
operation ID number
FirstItem
ordinal of first record (see range initialization)
ItemCount
number of records (see range initialization)
return value.
0 – given operation is unsupported or ECR not initialized
n – size of record(s) in bytes
int SetCommParam( | lpstrConfigString) ; |
char * | lpstrConfigString; |
Description. Function serves to set up various communication and conversion parameters.
Input parameter.
lpstrConfigString
The string is comprised of individual parameters separated by ';' (semicolon) characters. Parameters could contains also a numeric, or string value if needed. Such parameter is then written as “parameter=value”.
Table 1.1. Supported parameters (marked values in are automatically set during initialisation)
parameter name(s) | description |
---|---|
modem+ / modem- | sets up default settings for modem
communication. modem+ changes
break time for 9600 Baud to 1s and
timeout to 6s.
modem- changes break time for
9600 Baud to 20ms and timeout
to 5s. |
modemtime=time | sets the modem answer time-out for dialling in milliseconds (60 s) |
485+ / 485- | sets up the usage/disusage of flow control necessary for RS-485 converters |
485wait=time | sets up the time space between the command that switches the converter and actual start of transmission. Time is specified in microseconds. (Warning: not all PCs support measuring time in microseconds. In this case, the time will be rounded up to nearest whole millisecond) (1 microsecond) |
485coef=coefficient | sets up the coefficient for switching the 485 converter into state for receiving data. The coefficient is in fact time in which the PC will transmit 1,000 bytes via the communication port divided by the time necessary to send one bit. To transmit one byte, it is necessary to transmit ten bits (start bit, eight data bits and a stop bit) and also account for the time between individual bytes. |
timeout=time | sets up the time of maximum ECR answer time-out in milliseconds (5s) (changed by modem+/- parameter) |
break=time | sets up wait time for start communication after break signal in milliseconds (20ms / 1s) (changed by modem+/- parameter) |
break384=time | same as break , only
for speed of 38 400 Baud
(20ms) |
break96=time | same as break , only
for speed of 9 600 Baud (1s)
(changed by modem+/-
parameter) |
warning+ / warning / warning- | Specifies “warning mode”. “+” means – all warnings ends communication. “-” means – no warning ends communication. Without “+”/“-” means programming warnings ends communication (e. g. warning while programming PLUs) |
wait_sn =time | “n ” is number from
1 to 3 and time is delay in milliseconds. Meaning of
n is: 1 – delay time in
wait loop before change state to send (for 485), 2 =
time before send of packet, 3 = time after send of
packet (after send command to 485 for receive).
Default values: s1 = 0, s2 = 0, s3 = 0. |
wait_rn =time | “n ” is number from
1 to 3 and time is delay in milliseconds. Meaning of
n is: 1 – not
used from version 4.30, 2 = wait time in
"reading data from COM port loop",
3 = wait time in "wait for read data delay
loop". Default values: r1 = 1, r2 = 1, s3 =
0. |
decimal=character | This parameter allow the user to select decimal separator for numbers. Standard value of decimal separator is dot. This configuration is useful if there is a third party software (e. g. MS excel™, OOo Calc™) and this software requires decimal comma (depending on operation system settings) and not decimal dot. This character will be used for both sides conversion (binary->text and text->binary). Decimal separator can be only one character long. If there is given more than one character, then only the first character will be used. |
Return value.
n – specifies the number of successfully set parameters
-1 – undefined/erroneous configuration string
-2 – communication port is not initialized
-3 – not initialized ECR.
int GetECR_Info( | pcVariable, | |
pcValue, | ||
byMaxLength) ; |
const char * | pcVariable; |
char * | pcValue; |
BYTE * | byMaxLength; |
description. Function returns information about actual ECR and communication property and serves to get extended error codes.
input parameters.
pcVariable
pointer to string with “variable name”
pcValue
pointer to output text buffer
byMaxLength
pointer to variable containing buffer length
output parameters.
pcValue
text data in pointed buffer
byMaxLength
full text data length (also when not all data saved)
0 – All OK. In text buffer is full value.
-3 – ECR not initialized.
-4 – operation unsupported
-11 – text buffer too low. (saved only byMaxLength – 1 bytes)
-13 – no text buffer.
-14 – variable not implemented
n – Numeric result for numeric variables (e. g. count of, time of, etc.). No error is returned!!
Table 1.2. ECR Info variable names
Text informations: | |
---|---|
variable name | description |
ECR_Name | ECR type name*1 |
Numeric informations: *2 | |
---|---|
variable name | description |
PLU_Count | Maximal PLU Count for this cash register type. If selected type support extended memory module then the result is maximal possible PLU count, not the actual PLU count. Actual PLU count can be obtained from command 255 (this command is not supported by all cash registers). |
IsVariablePLU_Count? | If this variable returns zero then the cash register has fixed PLU count, otherwise the PLU count depends on current hardware configuration of cash register. |
LastErrorCode | Last Error Code |
WaitAfterCommandOnline | recommended time between*3 2 online commands (all except “end of sale”) |
WaitAfterCommandNoPrint | recommended wait time after*3 command without print on receipt |
WaitAfterCommandDefault | recommended wait time after*3 “normal” command |
WaitAfterCommandnnn | recommended wait time after*3
command “nnn ”. Where
“nnn ” is command number
|
WaitAfterEndOfSale | recommended wait time after*3 online command “end of sale” |
*1: Only name of the type of ECR. Name do not contain PLU count and/or specific version implementation.
*2: Result is returned as result value of call of function and can be saved as text. If text buffer is entered return value will be in text buffer and also as return value of function. If no text buffer is entered (pointer to null or zero length) no error will occur and result is only the return value of function.
*3: time to wait after send command to send next command (in milliseconds)
Table 1.3. Last communication Error list
error number | description |
---|---|
0 | All OK |
1 | Time out, no data |
2 | Time out, low data |
3 | Bad packet header (probably other device on com port) |
4 | Bad packet type (other device or other ECR type) |
5 | Bad (unexpected) data length. (probably is bad country protocol specified) |
6 | Corrupted packet. |
7 | Wrong (corrupted) data length or Error 5 and 6 occurred on the same time. |
100 | Is not possible to send data (operation system error). |
101 | Not all data was send (operation system error). |
200 | Cancelled by user. |
300-399 | Unknown errors. |
int InitConvert( | DecPosNumDisp, | |
DecPosNumRound, | ||
CodingTable, | ||
ItemSeparator, | ||
LineSeparator) ; |
int | DecPosNumDisp; |
int | DecPosNumRound; |
char * | CodingTable; |
char * | ItemSeparator; |
char * | LineSeparator; |
int SetCodeTable(
CodingTable)
;char
*
CodingTable
;
description. These functions are used to configure transformation between binary data form and text data form. Convert table can be different for receiving and sending.
input parameters.
DecPosNumDisp
number of decimal places for price displaying (0, 1, 2, 3)
DecPosNumRound
number of decimal places for tax and price rounding and rounding algorithm
(0, 1, 2, 3) – number of decimal places
(00, 10, 20, 30) – rounding algorithm (numbers are displayed at base 10)
00 – to nearest integer
10 – to nearest lower integer
20 – to nearest bigger integer
30 – rounding by quarters (i. e. to the nearest number whose double is an integer)
Result value is obtained by simple addition of both values (e. g. 12 – always round down to two decimal places)
CodingTable
Pointer for string containing letters of national alphabet character table (see national characters table) depends on the specific country and ECR. To determine the character table for an ECR, simply perform test 200 in the ECR.
Accented characters (up to 34)
character '\5' (Pascal syntax #5, Basic syntax Chr(5)) accented characters (up to 60)
It can be performed only one of "a" or "b" steps (not both at the same time).
(inactive if step 1b) has been used)
if there were 34 characters in step 1a) then at most three special characters will follow or if character '\4' follows (and in step 1a) there were up to 34 characters), then exactly three special characters follow: „euro character“, „yen character“ and „up arrow“ (these are not used in all ECRs)
In case that characters within range 'A'–'Z' and 'a'–'z', the conversion will take place only in the ECR->PC direction.
following is character greater or equal to character ' ' (space), or a character after character '\1' will be considered a character of double width. (following = immediately following, not first one greater than ' ')
characters is greater or equal to character ' ' (space), or characters following the character '\2' will be considered for characters denoting the VAT levels (displayed in the ECR as Roman numerals I–IV). If not set explicitly, these will be automatically set to characters 'A'–'F'. (this is always the unilateral conversion from ECR to PC)
If the character '\3' is entered, the conversion is cancelled (no conversion takes place).
Special character conversion PC <––> ECR. After character '\6', that is mandatory for the beginning of that block (otherwise this block will be left out), doubles of characters follow. The doubles are in format (PC character, ECR character). Block must end with character '\6'.
Unilateral conversion from PC to ECR. After character '\7' (is mandatory or this block will be left out) doubles of characters follow, that are converted only in PC––>ECR direction. Doubles are in format (PC character, ECR character) Block must end with character '\7'
Unilateral conversion from ECR to PC. After character '\8' (is mandatory or this block will be left out) doubles of characters follow, that are converted only in ECR––>PC direction. Doubles are in format (PC character, ECR character) Block must end with character '\8'
Blocks 5a), 5b) and 5c) are designed to convert special characters such as characters specific to given national alphabet (Cyrillic, Greek) that visually resemble Latin characters.
If the pointer contains NULL the table remains unchanged, regardless of country setting (or in 1:1 mode in case there is no county specified)
ItemSeparator
value for separator in line between items – not empty
string (character ';' (semicolon) by default) (if
ItemSeparator
contains NULL it remains
unchanged - default ';' semicolon)
LineSeparator
Line separator (in case of empty string there is/must be
(depending on conversion direction) every row
terminated with character '\0' and the entire block is/must be
finished with two consecutive characters '\0') (if
LineSeparator
contains NULL it remains
unchanged - default CR+LF = '\r\n' = 0D0A in hexadecimal
code)
ItemSeparator
and
LineSeparator
must have different contents
(mustn't contain identical characters). If this would happen,
their values will not change.
return value.
0 – value settings correct
1 – wrong setting for rounding algorithm (e. g. to round to more decimal places than should be displayed)
2 – (not used)
3 – conversion table and/or separators were not set up
4 – (not used)
5 – (not used)
7 – ECR was not initialised
int ConvertBinToString( | CommandNum, | |
FirstItem, | ||
ItemCount, | ||
Data, | ||
StringData) ; |
int | CommandNum; |
int | FirstItem; |
int | ItemCount; |
unsigned char * | Data; |
char * | StringData; |
description. Function converts data from binary form (read from ECR) to text
form. After one calling converts one line of final text file and saves
it to variable StringData
, therefore it is
necessary to repeat function calling till all data are converted. This
progress of part conversion from binary to text form was chosen
because of lower demands of memory during data transmission. Also
because it is not possible to find out largeness of memory useful for
text data saving by conversion of electronic journal.
input parameters.
CommandNum
FirstItem
ItemCount
Data
Pointer to data (binary) (downloaded data from ECR).
StringData
Pointer, which will contains string for one line of converted data in text form (minimal suggested size is 200 B)
For graphical logo is more free space needed. Size of converted data (of final BMP file) for graphical logo is:
4382 B for T printers (Euro-2000T Alpha, Euro-500T Handy, Euro-100T, Euro-200T)
5182 B for TX printers (Euro-500TX Handy, Euro-2100TX, Euro-2300TX, Euro-100TX, Euro-200TX)
11582 B for TE printers (Euro-2000TE Alpha, Euro-500TE Handy, Euro-2100TE, Euro-200TE)
output parameters.
StringData
StringData
contains one line of
converted text (or picture in BMP format in case of
graphics logo conversion).
0 – Conversion of particular line successful
1 – All data converted (next function calling not required)
3 – Convert operation not supported
4 – Missing or bad pointer to binary convert data
5 – Missing or bad pointer to text data
6 – Bad convert range (items count).
7 – Bad convert first item.
8 – Error during conversion (binary data invalid).
9 – ECR is not initialized - need to call function
InitEcrEx
or "InitEcr
and InitConvert
"
first.
int ConvertStringToBin( | CommandNum, | |
FirstItem, | ||
ItemCount, | ||
Data, | ||
StringData) ; |
int | CommandNum; |
int | FirstItem; |
int | ItemCount; |
unsigned char * | Data; |
char * | StringData; |
description. Function converts data from text form to binary form. All text
data are converted after one calling of function and stored in
Data
.
input parameters.
CommandNum
FirstItem
ItemCount
Data
Pointer to data (binary).
StringData
Pointer to string which will contains all data in text form.
output parameters.
Data
Data
contains converted binary
data ("ready for ECR").
0 – Conversion successful
2 – Wrong BMP data.
3 – Convert operation not supported
4 – Missing or wrong pointer to binary convert data
5 – Missing or wrong pointer to text data
6 – Incorrect convert range (items count).
7 – Incorrect convert first item.
8 – Error during conversion (text data invalid).
9 – ECR is not initialized - need to call function
InitEcrEx
or "InitEcr
and InitConvert
"
first.
int ReceiveEcrOnline( | hWnd, | |
dwMsgNum, | ||
dwTypes) ; |
HWND | hWnd; |
DWORD | dwMsgNum; |
DWORD | dwTypes; |
description. This function activates mechanism for receiving back ONLINE data.
Input parameters.
hWnd
Window handle - to this handle will be send messages concerning received back ONLINE data.
dwMsgNum
Message number
dwTypes
Form and decoding settings:
0 – binary data,
1 – text data (all items are separated with items separator),
3 – text data (first and second amount are separated by multiply, or division operator),
return value.
-2 – communication port is not set correctly.
-3 – no cash register was set.
-4 – this operation is not supported by selected ECR type.
-7 – no window handle specified.
-8 – incorrect message number given.
2 – communication aborted by user.
12 – unknown communication error.
13 – unknown error on sending data (operation system or hardware error).
This functions end only with error or user abort. Data receiving can
be aborted with call of CancelComm
function.
Data meaning is described in separate chapter.
Example 1.1. Calling progress of functions by data transmission
res = InitComm(m_port, m_speed);
if (res != 0)
{
// Can’t initialize port
return;
}
res = InitEcr(m_ecrNum, m_ecrType);
if (res != 0)
{
// Wrong number of ECR or type of ECR
CloseComm();
return;
}
res = RecvData(m_command, m_numOfItems, m_firstItem, m_data);
if (res != 0)
{
// Wrong command or parameters ...
CloseComm();
return;
}
while ((res = GetStatus(&perc)) == 1)
{
// Progress bar
}
if (res == 0)
// Everything OK
else
// Error message
CloseComm();
Example 1.2. Calling progress of functions by data conversion after data accepting from ECR
res = InitConvert(m_dispDec, m_roundDec, m_countryCode, m_sep1, m_sep2);
if (res != 0)
{
// Initialization of conversion failed
return;
}
res = InitEcr(m_ecrNum, m_ecrType);
if (res != 0)
{
// Wrong number of ECR or type of ECR
return;
}
while (!ConvertBinToString(m_command, m_firstItem, m_numOfItems, m_data, m_stringData))
{
// Process m_stringData
}
Example 1.3. Calling progress of functions by data conversion before data sending to ECR
res = InitConvert(m_dispDec, m_roundDec, m_countryCode, m_sep1, m_sep2);
if (res != 0)
{
// Initialization of conversion failed
return;
}
res = InitEcr(m_ecrNum, m_ecrType);
if (res != 0)
{
// Wrong number of ECR or type of ECR
return;
}
res = ConvertStringToBin(m_command, m_firstItem, m_numOfItems, m_data, m_stringData);
if (res != 0)
{
// Error while converting data
}
// the m_data can be sent to ECR
In API function SendData
, RecvData
, ConvertBinToString
and ConvertStringToBin
is used Range select ("number of first transmitted item" and "count (or
length) of transmitted items"). These values are not used by all communication commands.
There are two ways of using these values.
"number of first transmitted item" = first transmitted item count
from 0 (in data type WORD
)
"count (or length) of transmitted items" = count of items (in data
type WORD
), or length of data (in data type
DWORD
).
Particular communication commands uses different range selects.
none
for SendData
and
RecvData
=
"first item number" = 0, "count (or length) of items" = 1
(values have no real meaning, bud are not ignored and
must be in correct range)
for ConvertBinToString
and ConvertStringToBin
depends range on particular conversion. E. g. Select "first item
number" = 0, "count (or length) of items" = 7 if the data
consist of seven records and all should be converted.
type "Start
& Length
" - "first
item number" = Start
, "count (or length) of items" =
Length
For reading PLU with non-zero sale values is Start
value ignored. Length
mean count of PLU's with non-zero
sale.
type "LongLength
" - "first item number" = 0, "count
(or length) of items" = LongLength
Table 1.4. Countries codes
Number | Acronym | Country |
---|---|---|
0 | (none) | default (no country) |
1 | SK | Slovakia |
2 | CZ | Czech Republic (non fiscal version) |
3 | EN/GB | (generic English version) |
4 | ENf/GBf | (generic fiscal law English version) |
5 | SW | Old Sweden versions |
6 | RO | Romania |
7 | PL | Poland |
8 | HU | Hungary |
9 | LV | Latvia |
10 | MK | Macedonia |
11 | FI | Finland |
12 | GR | Greece |
13 | RS | Serbia |
14 | ME | Monte Negro |
15 | LT | Lithuania |
16 | reserved | reserved |
17 | DE | Germany |
18 | CZf | Czech Republic (fiscal law version) |
19 | reserved | reserved |
20 | reserved | reserved |
21 | reserved | reserved |
22 | DK | Denmark |
23 | SE | Sweden |
24 | AT | Austria |
Table 1.5. Error codes description
Error code | Description | ||
---|---|---|---|
0 | All OK | ||
1 | Communication error (wrong check sum, wrong packet, wrong operation...). | ||
2 |
| ||
3 | Opened receipt (sale in progress) in ECR (communication is not possible). | ||
4 | VAT assignment is out of range or VAT is not active! | ||
5 | Department assignment is out of range! | ||
6 | Sales unit is out of range! | ||
7 | Quantity is out of range! | ||
8 | Price is out of range! | ||
9 | Online sale not allowed in current ECR mode! | ||
10 | Command is out of range or not allowed in this mode! | ||
11 | PLU index is out of range! | ||
12 | Not right hexadecimal sign code (name of PLU or number of credit card). | ||
13 | Payment not allowed! | ||
14 | Payment type not allowed! | ||
15 | Currency payment is out of range or not allowed type of currency because ECR is in wrong Euro phase | ||
16 | Not started sale! Command not allowed!! | ||
17 | Wrong message line! (unsupported characters) | ||
18 | Message for cashier has more than maximal allowed lines (message cannot be send). | ||
19 | Electronic journal is full. Operation not possible. | ||
20 | Surcharge/Discount flag out of range. | ||
21 | Surcharge/Discount type out of range. | ||
22 | Surcharge/Discount database type out of range. | ||
23 | Value of Surcharge/Discount is out of range. | ||
24 | Surcharge/Discount was wrong used (not suddenly after sold of PLU). | ||
26 | Invalid bar-code | ||
27 | Operation is not possible. Make daily report first. | ||
28 | Operation is not possible. Fiscal memory is full. | ||
32 | It is not possible to make hourly report (periodical). Make first Hourly report (daily). | ||
33 | It is not possible to erase textual journal. It is necessary to read journal into PC first. | ||
34 | PLU link flag is out of range. | ||
35 | PLU description flag is out of range. | ||
36 | PLU type flag is out of range. | ||
37 | PLU stock report flag is out of range. | ||
38 | PLU negative stock flag is out of range. | ||
39 | PLU fractional flag is out of range. | ||
40 | PLU mode flag is out of range. | ||
41 | PLU halo limit flag is out of range. | ||
42 | Cash register is not fiscalized. Operation is not possible. (not used in non fiscal versions) | ||
43 | Discount type out of range (allowed values are 0 and 1). | ||
44 | Coupon value out of range. | ||
45 | Cash register is fiscalized. This operation is possible only befiore fiscalization. (not used in non fiscal versions) | ||
46 | PLU consignate flag out of range. | ||
47 | PLU DB type out of range. | ||
48 | Wrong cash register type. | ||
49 | Operation is not possible. Make PLU report first. | ||
50 | Operation is not possible. Make DPT report first. | ||
51 | Operation is not possible. Make cashier report first. | ||
58 | Wrong dosument number (online – command 11) | ||
59 | Payment is not possible. Sub-total in selected currency is nul. | ||
60 | Parameter value is out of range. | ||
101 | It is not possible to perform operation (wrong command combination). | ||
103 | PLU not sold. | ||
105 | Maximum count of PLU/lines in a sale has been reached. | ||
106 | Multiplication reached maximum amount. | ||
108 | It is not possible to sell item with programmed price. Programmed price is inactive. | ||
109 | Particular tax level amount is over limit from the last daily report. | ||
111 | Forbidden operation with returnable packs. | ||
112 | Forbidden sale of PLU. PLU is inactive. | ||
113 | Tax level inactive. | ||
114 | Price is missing. | ||
117 | Operation caused negative stock. | ||
118 | Maximum price of sale is reached. Terminate the sale. | ||
119 | Price HALO limit is over. | ||
120 | Add-on/discount to returnable packs disabled. | ||
122 | Open price is inactive. DPT (PLU) flag prevents entry of price from keyboard. | ||
124 | Add-on/discount amount limit is over. | ||
125 | Decimal places limit is over. 2nd system flag disables sale for more decimal places. | ||
127 | Add-on/discount to negative value disabled. | ||
128 | Void disabled in this stage of sale. | ||
130 | Grand-Totals reached the maximum amount. | ||
131 | Performed operation caused negative Grand-Total. | ||
132 | Attempt of check/credit payment in foreign currency. | ||
135 | Credit card payment limit is over. | ||
136 | Negative value of tax level. | ||
137 | Incorrect bar code. | ||
138 | Name of sold item is empty. Sale is not possible. | ||
142 | Negative items amount limit is over. | ||
143 | Discount amount limit is over. | ||
144 | Damaged tax record. | ||
193 | Programmed EAN has incorrect form. | ||
194 | Refund is not possible. Insufficient cashier rights. | ||
195 | Final price for EAN creating limit is over. | ||
196 | PLU price for EAN creating limit is over. | ||
197 | PLU amount for EAN creating limit is over. | ||
199 | Document entry is necessary for receipt opening. |
Table of Contents
In this type of communication is not necessary to create a session (relation). All connections are only data transfers (upload to ECR, download from ECR). Simply only send/receive data to/from ECR.
Table 2.1. Definition of data types
type name | length (in bytes) | description |
---|---|---|
BYTE | 1 | unsigned number (integer) |
WORD | 2 | unsigned number (integer), little endian (low byte, high byte) |
DWORD | 4 | unsigned number (integer), little endian (lowest byte first, highest byte last) |
N6 | 6 | signed integer, little endian. Low (first) 47 bits are used for unsigned part of number and last bit is used to determine positive (clear (set to 0)) or negative (set to 1) value. See example of 6 byte integer number. |
char | 1 | signed integer |
int | 2 | signed integer, little endian (low byte, high byte) |
long | 4 | signed integer, little endian (lowest byte first, highest byte last) |
double | 8 | real number. (compatible with type double
in Borland C++ Builder and MS Visual C++
). If type extension is
used then decimal places are not used. |
string | various | Text string. Maximal length depends from data type (reserved
length = end byte - start byte + 1 ). If actual string
length is less than the reserved length, then the string is null
terminated. After string termination (character 0x00 )
should be only null characters (0x00 ). See character map for correct interpreting
of characters. |
n* char | n | String with exact length n bytes. See character map for correct interpreting
of characters. (Most of these types are only numerical
values) |
BARCODE | various | bar-code stored in compressed BCD form (two numbers on each byte). If the count of numbers is odd, then on the first byte must be the top half of byte be set to zero. |
Table 2.2. Extension of definition of numerical data types
Decimal numbers are represented as whole numbers. Original value is multiplied (for encoding) or divided (for decoding) by number 1 (0 places), 10 (1 place), 100 (2 places), 1000 (3 places), according to number of places we want to use.
Table 2.3. Definition of string characters
code in ECR | character / meaning |
---|---|
0x7b | Ā |
0x7c | Č |
0x7d | Ē |
0x7e | Ģ |
0x7f | Ī |
0x80 | Ķ |
0x81 | Ļ |
0x82 | Ņ |
0x83 | Š |
0x84 | Ū |
0x85 | Ž |
0x86 | ā |
0x87 | č |
0x88 | ē |
0x89 | ģ |
0x8a | ī |
0x8b | ķ |
0x8c | ļ |
0x8d | ņ |
0x8e | š |
0x8f | ū |
0x90 | ž |
0x1f | double width character (character after this character has double width) |
0x5b* | Roman number "I" (TAX assignment to VAT level 1) (character Ⅰ) |
0x5c* | Roman number "II" (TAX assignment to VAT level 2) (character Ⅱ) |
0x5d* | Roman number "III" (TAX assignment to VAT level 3) (character Ⅲ) |
0x5e* | Roman number "IV" (TAX assignment to VAT level 4) (character Ⅳ) |
0x5f* | Roman number "V" (TAX assignment to VAT level 5) (character Ⅴ) |
0x60* | Roman number "VI" (TAX assignment to VAT level 6) (character Ⅵ) |
0x20 - 0x7a | standard ASCII characters (except character 0x5b-0x60 used for vat assignment) |
Table of Contents
all ECRs have seven VAT levels labelled as numbers from 1 to 7,
VAT level 7 is tax-free VAT level
VAT levels from 1 to 6 are programmable VAT levels
VAT level with value 100,00% is forbidden VAT level (sale not possible in this VAT level)
Table 3.2. Send to ECR
Table 3.3. Receive from ECR
Data contains text logo that will be printed on the receipt.
Command number: |
| ||
Data length: | 6 * 24 |
DATA consists of 6 strings from internal hexadecimal ECR codes (6 logo lines).
Byte(s) | Meaning | type | range |
---|---|---|---|
0-23 | Text logo line (in internal hexadecimal code of ECR) | string | characters |
For Euro-1000T, Euro-2000T Alpha and Euro-500T Handy only first 17 characters are used. The remaining characters are ignored.
Command number: | 1 - programming, 129 - receiving |
Data length: | 34 |
0.Byte | In ECR | |||
---|---|---|---|---|
bit | Meaning | Flag | number | |
0 | x | number of decimal places for price and TAX displaying (range: <0, 3>) | 1 | 6 |
1 | x | |||
2 | x | |||
3 | x | number of decimal places for price rounding (range: <0, 3>) | 1 | 5 |
4 | x | |||
5 | x | |||
6 | x | system of rounding 0 – up from 5; 1 – always up; 2 – always down; 3 - quarter rounding | 1 | 1 |
7 | x |
1.Byte | In ECR | |||
---|---|---|---|---|
bit | Meaning | Flag | number | |
0 | x | number of decimal places for TAX rounding (range: <0, 3>) | 1 | 4 |
1 | x | |||
2 | x | |||
3 | x | number of decimal places for total price of sale rounding (range: <0, 3>) | 1 | 3 |
4 | x | |||
5 | x | |||
6 | x | prices of PLU and DPT are programmed with TAX – without TAX ( 0 – prices with TAX, 1 – prices without TAX) | 1 | 2 |
7 | x |
2.Byte | In ECR | |||
---|---|---|---|---|
bit | Meaning | Flag | number | |
0 | x | number of decimal places for quantity rounding (range: <0, 3>) | 2 | 3 |
1 | x | |||
2 | x | number of blank lines between receipts (range: <0, 6>) | 2 | 4 |
3 | x | |||
4 | x | |||
5 | x | number of logo lines (range: <0, 6>) | 2 | 5 |
6 | x | |||
7 | x |
3.Byte | In ECR | |||
---|---|---|---|---|
bit | Meaning | Flag | number | |
0 | x | quantity multiplying: if 0 then m1 / m2 ,
if 1 then m1 * m2 | 2 | 6 |
1 | x | date format (0 – day month year, 1 – month day year) | 2 | 2 |
2 | x | 0 – not to print / 1 – to print TAX values on sale receipt | 2 | 1 |
3 | x | 0 – nothing is printed, 1 – print ID of PLU before PLU name, 2 – print barcode before PLU name | 2 | 7 |
4 | x | |||
5 | - | not used | ||
6 | - | |||
7 | - |
Byte(s) | Meaning | type | system flag | digits |
---|---|---|---|---|
4-5 | receipt number (range: <1, 9999>) | WORD | 3 | 4-7 |
6 | ECR number (range: <1, 99>) | BYTE | 3 | 2-3 |
7.Byte | In ECR | |||
---|---|---|---|---|
bit | Meaning | Flag | number | |
0 | x | 0 – resets the receipt number after daily report, 1-clear receipt number after monthly report | 3 | 1 |
1 | - | not used | ||
2 | - | |||
3 | - | |||
4 | - | |||
5 | - | |||
6 | - | |||
7 | - |
In some version can be the value of 0th bit in 7th byte ignored and number of receipt is cleared after daily report.
8.Byte | In ECR | |||
---|---|---|---|---|
bit | Meaning | Flag | number | |
0 | x | required subtotal key pressing before receipt finishing 0 – not required, 1 – required | 4 | 2 |
1 | x | subtotal amount printing after subtotal pressing 0 – no, 1 – yes | 4 | 1 |
2 | x | required credit card number entering if paid by Credit 0-not required, 1-required | 4 | 3 |
3 | x | required customer’s payment amount entering 0-not required, 1-required | 4 | 4 |
4 | - | not used | ||
5 | - | |||
6 | - | |||
7 | - |
Byte | Meaning | type | system flag |
---|---|---|---|
9 | not used | BYTE |
10.Byte | In ECR | |||
---|---|---|---|---|
bit | Meaning | Flag | number | |
0 | x | terminal code for bar code scanner (0 – CR+LF, 1 – CR, 2 – LF) | 5 | 1 |
1 | x | |||
2 | x | communication speed of bar code scanner (0 – 1200, 1 – 2400, 2 – 4800, 3 – 9600, 4 – 19200) | 5 | 2 |
3 | x | |||
4 | x | |||
5 | x | communication speed of PC (0 – 9600 or 1 – 38400) | 5 | 3 |
6 | x | type of electronic scales (bits 0 and 1) - see user manual for scales types | 5 | 4 |
7 | x |
11.Byte | In ECR | |||
---|---|---|---|---|
bit | Meaning | Flag | number | |
0 | x | type of electronic scales (bits 2 and 3) - see user manual for scales types | 5 | 4 |
1 | x | |||
2 | x | PC ONLINE (0 - PC->ECR, 1 – PC->ECR and ECR->PC) | 5 | 5 |
3 | x | payment's terminal protocol type: 0 - none, 1 - Bull Amadeo, 2 - PinPad - KeyCorp | 5 | 6 |
4 | x | |||
5 | x | |||
6 | - | |||
7 | - |
12.Byte | In ECR | |||
---|---|---|---|---|
bit | Meaning | Flag | number | |
0 | x | font for battery power supply | 6 | 1 |
1 | x | |||
2 | x | font for adapter power supply | 6 | 2 |
3 | x | |||
4 | x | graphical logo printing 0 – no, 1 – yes | 6 | 3 |
5 | x | 0 – large font (2,5 mm high) | 6 | 4 |
6 | - | not used | ||
7 | x | standby mode time (bit 0) | 6 | 5 |
13.Byte | In ECR | |||
---|---|---|---|---|
bit | Meaning | Flag | number | |
0 | x | standby mode time (bits 1 and 2): 0 - off , 1 - after 1 min, 2 - after 5min, 3 - after 10min, 4 - after 15min | 6 | 5 |
1 | x | |||
2 | - | not used | ||
3 | - | |||
4 | - | |||
5 | - | |||
6 | - | |||
7 | - |
Byte(s) | Meaning | type | system flag |
---|---|---|---|
14-15 | value of percent add-on (range: <1, 9999>) | WORD(2) | 7 |
16-17 | limit for percent add on entered by ECR keyboard (range: <1, 99>) | WORD | 7 |
18-19 | value of percent discount (range: <1, 9999>) | WORD(2) | 8 |
20-21 | limit for percent discount entered by ECR keyboard (range: <1, 9999>) | WORD | 8 |
22-27 | time: hour:min:sec , hour – two numbers, min –
two numbers, sec – two numbers, in internal hexadecimal ECR codes
(see example of stored
time) | 6*char | 9 |
28-33 | date: day.month.year , day – two numbers, month
– two numbers, year – two numbers, in internal hexadecimal ECR
codes (see example of stored
date) | 6*char | 10 |
Example 3.1. Time
The time "12:20:32" (24 hour time) is in ECR represented by
sequence of bytes: 0x31, 0x32, 0x32, 0x30, 0x33,
0x32
Example 3.2. Date
The date "1st April 1999" (01.04.99) is
in ECR represented by sequence of bytes: 0x30, 0x31, 0x30, 0x34,
0x39, 0x39
Change (overwrite) date and time (bytes 22 – 33) is possible only if daily report is done.
Data contains cashier names.
Command number: |
| ||
Data length: | 6 * 10 - for programming and receiving |
Only cashiers names can be programmed through computer. Passwords and access rights can be set only by ECR keyboard.
Byte(s) | Meaning | type | range |
---|---|---|---|
0-9 | Cashier name (in internal hexadecimal code of ECR) | string | characters |
Data contains information about PLUs.
Programming of stock state in ECR has own rules. These rules are in following text marked as *stock and means final state of PLU stock after programming.
If transmitted stock value is more than 1 000 000 000 then the difference of transmitted value and 1 000 000 000 is added to stock value in ECR.
Example 3.3. Adding PLU stock
PLU stock value in ECR is 50. Transmitted value is 1 000 000 050. Data are accepted to ECR and follow operation is done: New stock value = 50 {primal stock} + (1 000 000 050 {transmitted value} - 1 000 000 000) = 100.
If new stock value could be more than 109 – PLU stock in ECR will be not changed.
If transmitted stock value is less than -1 000 000 000 then the difference of absolute value of transmitted data and 1 000 000 000 stock value is deducted in ECR
Example 3.4. Subtracting PLU stock
PLU stock value in ECR is 45. Transmitted value is -1 000 000 030. Data are accepted to ECR and follow operation is done: New stock value = 45 {primal stock} - (1 000 000 030 {transmitted value} - 1 000 000 000) = 15.
If new stock value could be less than 0 – PLU stock in ECR will be not changed.
In all PLU commands is used Range
select of type Start
and Length
. Start
means first PLU number (start counting from 0
). Length means
amount of transmitted PLUs except of command 159 (receive PLU non
zero sale report).
Command number: | 30 - programming PLU with stock state (safety) |
Data length: | n * 36 |
Bytes | type | length | Meaning | range |
---|---|---|---|---|
0-1 | WORD | 2 | PLU number | <1, MAX PLU> |
2-8 | BARCODE | 7 | bar-code | 13 numbers |
9-22 | string | 14 | PLU name | characters |
23-27 | FLAGS | 5 | Euro-500 Handy Flags | |
28-31 | DWORD(*) | 4 | PLU price | <0, 99 999 999> |
32-35 | long(3) | 4 | stock value of particular PLU | <0, 999 999 999>*stock |
Command number: | 29 - programming PLU without stock state (safety) |
Data length: | n * 32 |
Bytes | type | length | Meaning | range |
---|---|---|---|---|
0-1 | WORD | 2 | PLU number | <1, MAX PLU> |
2-8 | BARCODE | 7 | bar-code | 13 numbers |
9-22 | string | 14 | PLU name | characters |
23-27 | FLAGS | 5 | Euro-500 Handy Flags | |
28-31 | DWORD(*) | 4 | PLU price | <0, 99 999 999> |
Command number: | 157 - Receive programmed PLUs (safety) |
Data length: | n * 34 |
Bytes | type | length | Meaning |
---|---|---|---|
0-6 | BARCODE | 7 | bar-code |
7-20 | string | 14 | PLU name |
21-25 | FLAGS | 5 | Euro-500 Handy Flags |
26-29 | DWORD(*) | 4 | PLU price |
30-33 | long(3) | 4 | stock value of particular PLU |
Command number: | 158 - Receive PLU sale report (safety) |
Data length: | n * 46 |
Command number: | 159 - receive PLU non zero sale report (safety) |
Data length: | n * 48 |
This command use Range select. See detailed description.
0.Byte | In ECR | |||
---|---|---|---|---|
bit | Meaning | Flag | number | |
0 | x | descriptive PLU (0 - no, 1 - yes) | 1 | 4 |
1 | x | single PLU sale (0 - no, 1 - yes) | 1 | 5 |
2 | x | stock status printed on PLU report (0 - no, 1 - yes) | 2 | 4 |
3 | x | Sale in case of negative stock value allowed (0 - no, 1 - yes) | 2 | 4 |
4 | x | possibility of fragmentary amount sale (0 - no, 1 - yes) | 2 | 5 |
5 | x | Sale unit (range: <0, 7>) | 2 | 3 |
6 | x | |||
7 | x |
Byte | Meaning | type | PLU flag | numbers |
---|---|---|---|---|
1 | DPT assignment (range: <0, 29>, 0 means DPT1, 29 means DPT30) | BYTE | 1 | 2-3 |
2.Byte | In ECR | |||
---|---|---|---|---|
bit | Meaning | Flag | number | |
0 | x | Assignment to VAT level. | 1 | 1 |
1 | x | |||
2 | x | |||
3 | x | |||
4 | x | Linked PLU (range: <0, 15>, 0 means no linked PLU, 1-15 means linked PLU 1001-1015). | 2 | 1-2 |
5 | x | |||
6 | x | |||
7 | x |
3.Byte | In ECR | |||
---|---|---|---|---|
bit | Meaning | Flag | number | |
0 | x | Sale features: 0 – forbidden, 1 – open, 2 – preset, 3 – open and preset | 1 | 6 |
1 | x | |||
2 | x | Price limits (range: <0, 7>, 0 means limit price to 1 digit...) | 2 | 7 |
3 | x | |||
4 | x | |||
5 | - | not used | ||
6 | - | |||
7 | - |
Byte | Meaning | type | PLU flag | numbers |
---|---|---|---|---|
4 | not used | BYTE |
Data contains DPT names, flags and prices.
Count of departments depends on cash register type.
Command number: | 4 | ||
Data length: |
|
Byte(s) | Meaning | type | range |
---|---|---|---|
0-13 | DPT name (in internal hexadecimal code of ECR) | string | characters |
14-15 | DPT FLAGS | ||
16-19 | price | DWORD(*) | <0, 99 999 999> |
0.Byte | In ECR | |||
---|---|---|---|---|
bit | Meaning | Flag | number | |
0 | x | Assignment to VAT level. | 1 | 1 |
1 | x | |||
2 | x | |||
3 | x | |||
4 | x | single DPT sale (0 - no, 1 - yes) | 1 | 2 |
5 | x | Sale features: 0 – forbidden, 1 – open, 2 – preset, 3 – open and preset | 1 | 4 |
6 | x | |||
7 | x | Negative department (0 - no, 1 - yes) | 1 | 3 |
1.Byte | In ECR | |||
---|---|---|---|---|
bit | Meaning | Flag | number | |
0 | x | Price limits (range: <0, 7>, 0 means limit price to 1 digit...) | 1 | 5 |
1 | x | |||
2 | x | |||
3 | x | |||
4 | - | |||
5 | - | |||
6 | - | |||
7 | - |
Data contains values for VAT levels.
Command number: | 5 |
Data length: | 7*12 |
Byte(s) | Meaning | type | range |
---|---|---|---|
0-9 | VAT description (text) | string | characters |
10-11 | VAT level rate | WORD(2) | <0, 10000> |
If the VAT rate is 10000 then the VAT level is forbidden.
The seventh item values have to be resettled (0x00 – text and rate too)!
Changing of VAT levels is possible only after report.
Data contains texts printed on receipt.
Command number: |
| ||
Data length: | 10*24 |
Byte(s) | Meaning | type | range |
---|---|---|---|
0-24 | functional texts | string | characters |
String has 24 characters but only first 17 are used in ECR. Others are ignored.
Table 3.4. Implicitly set functional texts in ECR
Text No. | Meaning | Implicitly |
---|---|---|
1 | Cash payment description | CASH |
2 | Check payment description | CHECK |
3 | Credit card payment description | CREDIT |
4 | Change value description | CHANGE |
5 | Description of refund operation | REFUND |
6 | Description of void operation | VOID |
7 | Description of Received on account entries cash or check | RA |
8 | Description of Cash or check paid out entries | PO |
9 | Description of total sale value | TOTAL |
10 | Description of text during reference number printing | DOCUMENT NUMBER |
Command number: | 12 |
Data length: | 1 |
In this commands is used Range
select of type Start
and Length
. Start
means first PLU number (start counting from 0
). Length
means count of PLUs witch sales data should be deleted.
Byte | Meaning | type | range |
---|---|---|---|
0 | not used | BYTE |
Command number: |
| ||
Data length: | 1 |
Byte | Meaning | type | range |
---|---|---|---|
0 | Not used | BYTE |
Data contains B&W bitmap of graphical logo.
Command number: |
| ||
Data length: | 3780 |
The dimensions of this bitmap are 168 (horizontally) x 180 (vertically). One pixel is represented by one bit. Pixels are placed from left to right and from top to bottom.
Data contains sale units (pieces, bottles, e.t.c.).
Command number: |
| ||
Data length: | 8 * 3 - for programming and receiving |
Byte(s) | Meaning | type | range |
---|---|---|---|
0-2 | Unit name | string | characters |
Data contains secondary currency exchange rate.
Command number: |
| ||
Data length: | 8 |
Byte(s) | Meaning | type | range |
---|---|---|---|
0-7 | Secondary currency exchange rate | double | <0.0001, 10000.0> |
It is possible to program all exchange rates between 0.0001 and 10000.0 with maximal 6 valid digits (leading and trailing zeros are not valid digits). Rates 0.000123456 or 9876.54 are valid. Rate 0.0001234567 will be truncated and rounded (to 0.000123457).
ON-LINE mode is a special command. This command allow use ECR as a fiscal printer (PLUs are sold from PC).
Command number: | 18 |
Data length: | 28 |
Cash register allow only one data packet (item) for communication command 18. If there is necessary to send more data this command must be repeated for each item.
Byte(s) | Meaning | type |
---|---|---|
0–26 | Data depending on command | |
27 | command number | BYTE |
Table 3.5. Online commands
number | description |
---|---|
1 | PLU sale |
2 | PLU refund |
3 | Finish sale – simulation of TOTAL key pressing |
4 | Finish PC ONLINE communication |
5 | Payment |
6 | PLU void |
Conditions for ON LINE mode calling are: ECR in R or T mode. Started sale through ECR keyboard has to be finished before ON LINE communication start. Keyboard is not functional instead of CLEAR key, which cannot be used for ON LINE mode cancelling. It is necessary to finish sale through ECR keyboard after ON LINE mode has been cancelled. Then next ON LINE transport can be called. PC ON LINE is also cancelled with ECR power off. Wholesale through ON LINE mode (command 1, 2 and index 0) is printed in PLU report and is signed with “PC - ON LINE” text.
Description of data used in commands 1 (PLU sale), 2 (PLU refund) and 6 (PLU void).
Byte(s) | Meaning | type | range | ||
---|---|---|---|---|---|
0–13 | PLU name (or text) | string | characters | ||
14 | unit name*1 (number) | BYTE | <0, 8>*1 | ||
15 | DPT assignment | BYTE |
| ||
16 | VAT level assignment | BYTE | taxes | ||
17-20 | price | DWORD(*) | <0, 99 999 999> | ||
21-24 | quantity | DWORD(#) | <1, 9 999 999> | ||
25-26 | index*2 | WORD | <0, MaxPLU>*2 |
*1: Unit number from 0 to 7 means sale unit. Number 8 means that actual PLU will be sold as descriptive one (index for PLU database of ECR is 0), In this case only PLU name is important and other bytes are ignored
*2: index has different meaning for each of command type
for command 1 (PLU sale) and 2 (PLU refund)
index = 0
– PLU will be sold – PLU name, sale
unit, DPT and VAT assignment, price and quantity will be used
during the sale
index = 1-MaxPLU
– PLU with this index will
be sold from PLU database of ECR. PLU name and flags are used
from PLU database. Price is used from packet (if more then 0) or
from PLU database of ECR if it is zero, quantity is used from
packet.
For command 6 (PLU void)
index = 0
– means - void will be done
immediately – last PLU will be void: bytes 0–24 are
ignored.
index > 0
– means – index for buffer of
sold PLU-s – PLU with this index will be void: if PLU was sold
using command 1:
index = 0
– assignments of quantity, DPT
and VAT, price are controlled with PLU from buffer of sold
PLU. PLU name, and unit sale are not controlled but should
be the same as void PLU.
index = 1-MaxPLU
– quantity and price
(if more then zero)
Indirect void is supported only by cash registers with alphanumerical display.
Example 3.5. Online sale and void
Operation (command) | Content of buffer of sold PLU | Number of PLU-s in buffer | Result | |||||
---|---|---|---|---|---|---|---|---|
Indexes in buffer of sold PLU | Content | |||||||
PLU 1 sale (1) | 1. | PLU 1 | 1 | OK | ||||
PLU 2 sale (1) |
|
| 2 | OK | ||||
PLU 1 voiding (6) index = 1 | 1. | PLU 2 | 1 | OK | ||||
Descriptive PLU 3 sale (1) | 1. | PLU 2 | 1 | OK | ||||
PLU 2 voiding (6) index = 2 | 1. | PLU 2 | 1 | Err | ||||
PLU 2 voiding (6) index = 1 | empty | 0 | OK | |||||
PLU 4 sale (1) | 1. | PLU 4 | 1 | OK |
As we can see in example, voiding operation decrement and relocate content of buffer in ECR and descriptive PLU-s are not saved in buffer.
In commands 3 (Finish sale) and 4 (Finish PC ONLINE communication) are data ignored, but should contain data in valid range (for example 0x00 in whole data area).
Finish sale: same function like TOTAL key pressing in sale mode.
Finish PC ONLINE communication: only ends PC ONLINE communication. Bill is open and it is not possible to end sale from PC. Next step must be done on ECR (sale, end of sale...).
Description of data used in command 5 (payment method).
Byte(s) | Meaning | type | range | |||
---|---|---|---|---|---|---|
0–3 | paid sum | DWORD(*) | <1, 2 100 000 000> | |||
4 | payment type | BYTE |
| |||
5 | flag paid in currency*4 | BYTE |
| |||
6-25 | ASCII string contains credit card number | string | numerical characters*5 | |||
26 | not used | BYTE |
*3: Credit card can be involved. Credit card number is printed only if system flag 4 digit 2 is set.
*4: Flag make a difference only in Euro phase 1, 2, 3.
*5: ASCII string contains credit card number {maximal 19 numbers}.
Data contains DPT names, flags and prices and sale values.
Command number: | 132 | ||
Data length: |
|
Byte(s) | Meaning | type |
---|---|---|
0-13 | DPT name (in internal hexadecimal code of ECR) | string |
14-15 | DPT FLAGS | |
16-19 | price | DWORD(*) |
20-27 | number of sales since last daily report | double(3) |
28-35 | value of sales since last daily report | double(*) |
36-43 | number of sales since last periodical report | double(3) |
44-51 | value of sales since last periodical report | double(*) |
Periodical values are updated only on performing daily report.
Data contains sale values for each VAT level.
Command number: | 133 |
Data length: | 7*68 |
Byte(s) | Meaning | type |
---|---|---|
0-9 | VAT description (text) | string |
10-11 | VAT level rate | WORD(2) |
12-19 | taxable value since last daily report | double(*) |
20-27 | net value since last daily report – only if system flag 1 digit 2 is set – otherwise not used | double(*) |
28-35 | not used | |
36-39 | not used | |
40-47 | number of sales since last periodical report | double(*) |
48-55 | value of sales since last periodical report | double(*) |
56-63 | not used | |
64-67 | not used |
See description of taxes.
Periodical values are updated only on performing daily report.
Data contains grand total (GT) values.
Command number: | 134 |
Data length: | 24 |
GT1 = GT2 + |GT3|
Sale values and counters are incremented to daily/periodical report since last daily/periodical report.
Command number: |
| ||
Data length: | 376 |
DATA items looks as follows:
Byte(s) | Meaning | type |
---|---|---|
0-7 | taxable value | double(*) |
8-11 | number of receipts | long |
12-19 | netto | double(*) |
20-27 | TAX | double(*) |
28-35 | void amount | double(*) |
36-39 | void quantity | long |
40-47 | amount of subtotal void | double(*) |
48-51 | quantity of subtotal void | long |
52-59 | refund amount | double(*) |
60-63 | refund quantity | long |
64-71 | RA cash amount | double(*) |
72-75 | RA cash quantity | long |
76-83 | RA cash amount in secondary currency | double(*) |
84-87 | RA cash quantity in secondary currency | long |
88-95 | PO cash amount | double(*) |
96-99 | PO cash quantity | long |
100-107 | PO cash amount in secondary currency | double(*) |
108-111 | PO cash quantity in secondary currency | long |
112-119 | RA check amount | double(*) |
120-123 | RA check quantity | long |
124-131 | not used (RA check amount in secondary currency) | double(*) |
132-135 | not used (RA check quantity in secondary currency) | long |
136-143 | PO check amount | double(*) |
144-147 | PO check quantity | long |
148-155 | not used (PO check amount in secondary currency) | double(*) |
156-159 | not used (PO check quantity in secondary currency) | long |
160-167 | discount amount | double(*) |
168-171 | discount quantity | long |
172-179 | add on amount | double(*) |
180-183 | add on quantity | long |
184-191 | difference of rounding (used for quarter rounding) | double(*) |
192-195 | not used | |
196-203 | not used | |
204-207 | not used | |
208-215 | total sale cash amount | double(*) |
216-219 | total sale cash quantity | long |
220-227 | total sale cash amount in secondary currency | double(*) |
228-231 | total sale cash quantity in secondary currency | long |
232-239 | total sale check amount | double(*) |
240-243 | total sale check quantity | long |
244-251 | not used (total sale check in secondary currency) | double(*) |
252-255 | not used (total sale check quantity in secondary currency) | long |
264-267 | total sale credit amount | double(*) |
264-267 | total sale credit quantity | long |
268-275 | not used | |
276-279 | not used | |
280-287 | cash in drawer | double(*) |
288-295 | cash in drawer in secondary currency | double(*) |
296-303 | check in drawer | double(*) |
304-311 | not used (check in drawer in secondary currency) | double(*) |
312-319 | credit in drawer | double(*) |
320-327 | not used | |
328-335 | not used (bottle sale amount) | double(*) |
336-339 | not used (bottle sale quantity) | long |
340-347 | not used (bottle refund amount) | double(*) |
348-351 | not used (bottle refund quantity) | long |
352-359 | not used (bottle subtotal void amount) | double(*) |
360-363 | not used (bottle subtotal void quantity) | long |
364-367 | number of all receipts | long |
368-371 | number of fiscal receipts | long |
372-375 | not used (number of changes of names and tax levels) | long |
Periodical values are updated only on performing daily report.
Data contains cashier names and sales report.
Command number: | 139 - cashier sales report |
Data length: | 6 * 34 - for cashier sale report |
Byte(s) | Meaning | type |
---|---|---|
0-9 | Cashier name (in internal hexadecimal code of ECR) | string |
10-13 | number of sales since last daily report | long |
14-21 | sale amount since last daily report | double(*) |
22-25 | number of sales since last periodical report | long |
26-33 | sale amount since last periodical report | double(*) |
Periodical values are updated only on performing daily report.
This command can be used to check actual state of online sale and correct sale of PLUs.
Command number: | 147 |
Data length: | 55 |
Byte(s) | Meaning | type |
---|---|---|
0 | number of PLU-s in buffer of sold PLU-s*1 | BYTE |
1–28 | PC - ONLINE content of sale packet of last sold PLU*2 | |
29-36 | value*3 | double(*) |
37-38 | number of actual receipt (value 0 – 9999) | WORD |
39-46 | total sum of sale | double(*) |
47-54 | total sum of sale in secondary currency | double(*) |
*1:
command 6 - void – voiding operation cuts number of PLU-s of 1
command 1 - sale – descriptive PLU sale – descriptive PLU are not counted to buffer of sold PLU-s
*2: zero if no PLU was sold
*3: if last item is
sold PLU (command 1) then total money sum
of last sold PLU: quantity*price = sum
(counted in
ECR)
refund PLU (command 2) then total money sum
of last sold item: -quantity*price = -sum
(counted in
ECR)
void PLU (command 6) then
total negative sum of money of voided item -sum
(from
buffer of sold PLU-s)
payment (command 5):
if sale was finished (payment was more or equal to total sum of sale) – change
if sale was not finished (payment was not more then total sum of sale) – surcharge
Command number: | 148 |
Data length: | 120 |
Byte(s) | Meaning | type |
---|---|---|
0-7 | total sum of sale (in basic currency) | double(*) |
8-15 | sum in non-taxable level | double(*) |
16-23 | taxable value in VAT level 1 | double(*) |
24-31 | tax value in VAT level 1 | double(*) |
32-39 | taxable value in VAT level 2 | double(*) |
40-47 | tax value in VAT level 2 | double(*) |
48-55 | taxable value in VAT level 3 | double(*) |
56-63 | tax value in VAT level 3 | double(*) |
64-71 | taxable value in VAT level 4 | double(*) |
72-79 | tax value in VAT level 4 | double(*) |
80-87 | taxable value in VAT level 5 | double(*) |
88-95 | tax value in VAT level 5 | double(*) |
96-103 | taxable value in VAT level 6 | double(*) |
104-111 | tax value in VAT level 6 | double(*) |
112-119 | not used |
All items are valid only during PC ONLINE sale (before last payment send from PC to ECR). Tax values are valid on to MAXTAX – others are zero. Values do not include roundings (e.g. quater rounding calculations) and are valid only during open sale.
Command is used to get information about sale through PC.
Command number: |
| ||
Data length: | 12 |
DATA contains sale info of PC Online sale.
Byte(s) | Meaning | type |
---|---|---|
0-3 | number of sales | long |
4-11 | amount of sales | double(*) |
Table of Contents
Table 4.1. Supported convert command (send to ECR)
Table 4.2. Supported convert command (receive from ECR)
Taxes are specific for each country. In the next table will be specified how are they interpreted in text form.
Table 4.3. Text interpretation of VAT levels
Acronym | Country/Version | VAT level | ||||||
---|---|---|---|---|---|---|---|---|
non taxable | minimal | maximal | special | |||||
(none) | Generic version | 0 | 1 | 6 | -- | |||
SK | Slovakia | |||||||
CZ | Czech republic (non fiscal law) | |||||||
EN/GB | Generic non fiscal law version | |||||||
ENf/GBf | Generic fiscal law version | |||||||
SW | old Swedish protocol | |||||||
FI | old Finish protocol | |||||||
DE | Germany | |||||||
AT | Austria | |||||||
DK | Denmark | |||||||
LV | Latvia | |||||||
CZf | Czech republic (fiscal law) | 0 | 1 | 5 | -- | |||
RO | Romania | 0 | 1 | 4 | -- | |||
GR | Greece | |||||||
HU | Hungary | 0 - TAM, 4 - AJT | 1 | 3 (programmable) | 0 - TAM, 4 - AJT | |||
PL | Poland | depends from TAX programming | 1 | 7 | 0 - disabled sale | |||
MK | Macedonia | -- | 1 | 5 | -- | |||
RS | Serbia | -- | 1 | 9 | -- | |||
LT | Lithuania | 0 | 1 | 4 |
| |||
CA | Canada | 0 | 1 | 6 |
| |||
ME | Monte Negro | 0 | 1 | 6 | 8 – not assigned |
Data contains text logo that will be printed on the receipt.
Command number: |
| ||
Lines count: | depends on ECR type |
The logo that will be printed on receipt. File contains text logo lines. Characters are in ASCII form.
Some cash register use only first characters (see table below) of the logo line.
New text logo will not be accepted when there are illegal characters.
Command number: | 1 - programming, 129 - receiving |
Lines count: | 12 |
System flag setting in ECR. File consists of 12 lines. Lines set system flags of ECR. Not all flags have to be used in particular ECR types, or flags can be used in turned-order (see ECR user’s guide). Particular digits in line are not separated with separator. Flag digits meaning (warning, digit order is not equal to programming order of system flags in ECR):
1st line
1st digit: number of decimal places for price and tax displaying (0 – 3)
2nd digit: number of decimal places for price rounding (0 – 3)
3rd digit: rounding 0 – from 5 up, 1 – up, 2 – down, 3 – quarter rounding
4th digit: number of decimal places for tax rounding (0 – 3)
5th digit: number of decimal places for total sale rounding (0 – 3)
6th digit: type of tax counting: 0 – PLU and DPT prices include tax, 1 – price without tax
2nd line
1st digit: number of decimal places for price and tax displaying (0 – 3)
2nd digit: number of free lines between receipts (0 – 6)
3rd digit: number of logo lines (0 – 6)
4th digit: multiple price , if 0
then m1/m2
, if 1 then m1*m2
5th digit: date form, 0 – day month year, 1 – month day year
6th digit: 0 – not to print / 1 – print tax data on receipt
7th digit: 0 – nothing is printed, 1 – print ID of PLU before PLU name, 2 – print barcode before PLU name
3rd line
digits 1-4: receipt number (1 – 9999) – it is ignored by transmission to ECR
digits 5-6: ECR number (1 – 99)
7th digit: reset: 0 – resets receipt number after daily report, 1 – after monthly report – in some version is ignored (in all fiscal versions and some others).
4th line
1st digit: obligation to press SUBTOTAL before TOTAL to finish sale: 0 – no, 1 – yes
2nd digit: ST printing on receipt: 0 – no, 1 – yes
3rd digit: obligation to enter credit card number by credit payment: 0 – no, 1 – yes
4th digit: cashier has to enter paid value accepted from customer: 0 – no, 1 – yes
5th line
1st digit: terminal character for bar code scanner (0 – CR+LF, 1 – CR, 2 – LF)
2nd digit: communication speed of scanner (0 – 1200, 1 – 2400, 2 – 4800, 3 – 9600, 4 –19200)
3rd digit: communication speed of PC serial port (0 – 9600, 1 – 38400)
4th digit: type of scales (0 – CAS Morcan, Martes T, 1 – EURO scales, Martes M, 3 – not used, 4 – not used)
5th digit: PC ONLINE (0 – PC -> ECR, 1 – PC -> ECR as well as ECR -> PC)
6th digit: protocol for payment terminal: 0 - none, 1 - Bull Amadeo, 2 - PinPad - KeyCorp
6th line
1st digit: printing mode for battery, (0 – normal mode, 1 – economic mode, 2 – fast)
2nd digit: printing mode for adapter, (0 – normal mode, 1 – economic mode, 2 – fast)
3rd digit: printing graphic logo at the end of receipt, (0 – not printed, 1 – printed)
4th digit font size (0 – large font (height 2,5 mm))
5th digit standby mode: 0 - none, 1 - after 1minute, 2 - after 5 minutes, 3 - after 10 minutes, 4 - after 15 minutes.
7th line: (four digits) value of percentage add-on always on two decimal places without decimal point (0 – 9999).
8th line: (two digits) limit of percentage add-on for entering through ECR keyboard (0 – 99)
9th line: (four digits) value of percentage discount always on two decimal places without decimal point (0 – 9999)
10th line: (two digits) limit of percentage discount for entering through ECR keyboard (0 – 99)
11th line: (six digits) time (hhmmss) (hh = hour, mm = minutes, ss = seconds)
12th line: (six digits) date (always in form DDMMYY (independent from digit 5 in second line)) (DD = day, MM = month, YY = year)
Command number: | 2 - programming, 130 - receiving |
Lines count: | for each cahier one line |
File consists of 6 lines per maximal 10 characters – names of 6 cashiers.
Data contains all information about PLU.
Command number: |
| |||
Lines count: | depends on transmitted PLU count |
Not all operation are supported in all ECR's.
Each line contains data about one PLU. Each item is separated by "ItemSeparator".
1st item: PLU number (Range depends on particular ECR type).
2nd item: PLU name (accepting only first 14 characters).
3rd item: PLU price*1 – number of decimal places according to setting of digit 6 system flag 1 of ECR,.
4th item: PLU flags: (see PLU flags)
5th item: bar code.
6th item: stock*2 on three decimal places
*1: entering price 1500 will be interpreted as price 15.00 in cash register (decimal point can be included but is ignored, digits are valid only) if 6th digit of the 1st system flag in ECR is set to value 2.
Entered number 15.0 is transmitted as value 150 (!!!only digits are valid!!!) and will be interpreted in depency on the setting of 6th digit of the 1st system flag in ECR. If this flag is set to 2, then the price in cash register will be 1.50.
*2: Value of transmitted stock is in range 1 - 999999999. If transmitted stock is out of range then only first 9 digits are used (in case plus sign or minus sign is used, then only first 8 digits are accepted). To change stock in ECR insert plus or minus sign before transmitted stock value, then transmitted stock value is added (deducted) to stock value of particular PLU in ECR. Stock value in ECR will not change in case new stock value should be besides allowed range.
Write transmitted value as –0 in case you do not want to change stock value in ECR.
Position of decimal point is ignored like it is by price.
Data all information about PLU sales.
Command number: |
| ||
Lines count: | depends on transmitted PLU count |
Not all operation are supported in all ECR's.
Each line contains data about one PLU. Each item is separated by "ItemSeparator".
1st item: PLU number (Range depends on particular ECR type).
2nd item: PLU name.
3rd item: PLU price*1 – number of decimal places according to setting of digit 6 system flag 1 of ECR,.
4th item: PLU flags are the same as in PLU structure:
5th item: bar code.
6th item: sale value
7th item: sold quantity
8th item: stock
Items are not separated by any separator.
1st digit: descriptive PLU: 0 – no, 1 – yes
2nd digit: one PLU sale: 0 – no, 1 – yes
3rd digit: stock list on report: 0 – no, 1 – yes
4th digit: sale in case of negative stock: 0 – no, 1 – yes
5th digit: possibility of fragmentary quantum sale: 0 – no, 1 – yes
6th digit: unit sale assignment (1 – 8)
digits 7 and 8: DPT assignment (1 – 30)
9th digit: sale possibility: 0 – forbidden, 1 – open, 2 – preset, 3 – open and preset
10th digit: price limits (1 – 8)
11th digit: VAT level assignment
digits 12 and 13: linked PLU – two digits (00 – 15) where "00" means no linked PLU and numbers from 01 to 15 means linked PLU from 1001 to 1015.
Data contains DPT names, flags and prices.
Command number: | 4 |
Lines count: | depends on DPT count in ECR |
Each line contains data about one DPT. Each item is separated by "ItemSeparator".
1st item: DPT name (name length depends on ECR type).
1st digit: VAT level assignment
2nd digit: single DPT sale: 0 – no, 1 – yes
3rd digit: sale possibility: 0 – forbidden, 1 – open, 2 – preset, 3 – open and preset
4th digit: negative sale: 1 – yes, 0 – no
5th digit: price limits (1 – 8)
3rd item: price – according to setting of digit 6 system flag 1 of ECR
Data contains values for VAT levels.
Command number: | 5 |
Lines count: | 7 |
1st item: maximal 10 characters of descriptive text
2nd item: tax rate value (0 – 10000) – always for two decimal places without decimal point (comma)
VAT level is forbidden if tax rate value is 10000, (not possible to count assigned PLU).
Data contains texts printed on receipt.
Command number: |
| ||
Lines count: | 10 |
File contains 10 lines. Descriptive text is in each line for particular operation of ECR according to programming manual. ECR uses only first 17 characters. For default values see implicitly set functional texts table.
Command number: | 12 |
Lines count: | 1 |
In this commands is used Range
select of type Start
and Length
. Start
means first PLU number (start counting from 0
). Length
means count of PLUs witch sales data should be deleted.
Data contains 1 line with one value. This value is ignored but must be given.
Command number: |
| ||
Lines count: | 1 |
Data contains 1 line with one value. This value is ignored but must be given.
Data contains graphical logo (picture) represented on receipt.
Command number: |
| ||
Data format: | uncompressed BMP |
Standard file the type BMP, black/ white format, no compressed, Windows norm. It is possible to create it by common graphic programs (PhotoShop, Corel, PaintBrush, ...). Sometimes is necessary to invert the picture before the saving process. Size depend to ECR type (must be exact the same resolution as graphics logo in ECR otherwise the data will be classified as invalid).
Data contains sale units (pieces, bottles, e.t.c.).
Command number: | 16 - programming, 144 - receiving |
Lines count: | 8 |
File contains 8 lines. Text of particular sale unit is placed in each line of file. Only first three characters are accepted.
Data contains secondary currency exchange rate.
Command number: | 17 - programming, 145 - receiving |
Lines count: | 1 |
File contains 1 line. It is one decimal number representing secondary currency rate (see ECR user’s guide)
Rate has to contain decimal point.
Online mode is a special command. This command allow use ECR as a fiscal printer (PLUs are sold from PC).
Command number: | 18 |
Lines count: | 1 or more |
File contains PLU sold through PC. Particular PLUs are separated in line with "LineSeparator". Line form depends on used command. Each item in line is separated with "ItemSeparator".
Commands 1 (PLU sale), 2 (PLU refund) and 6 (PLU void).
1st item: command ID
2nd item: name of sold PLU (depends on ECR type). Used only if PLU ID is set to 0.
3rd item: sale unit assignment: (0-7) 8-descriptive PLU
4th item: DPT assignment (depends on ECR type)
5th item: VAT level assignment (used only if PLU ID = 0)
6th item: PLU price*1. If price is 0 and PLU ID > 0 is used price from ECR database.
7th item: quantity on decimal place count depends on cash register settings - second system flag, third digit (decimal point is ignored)
8th item: index for PLU (values 0 to MaxPLU means PLU is sold from database of ECR, value 0 means PLU is sold from PC using previous item values) or Index for void PLU.
Indirect void is supported only by cash registers with alphanumerical display.
Commands 3 (Finish sale) and 4 (Finish PC ONLINE communication).
1st item: command ID
Command 5 (Payment).
1st item: command ID
2nd item: paid sum*1
3rd item: payment type: 0-cash, 1-check, 2-credit card
4th item: flag paid in currency: 0-in base currency, 1-in second currency
5th item: credit card number
*1: entering price 1500 will be interpreted as price 15.00 in cash register (decimal point can be included but is ignored, digits are valid only) if 6th digit of the 1st system flag in ECR is set to value 2.
Entered number 15.0 is transmitted as value 150 (!!!only digits are valid!!!) and will be interpreted in depency on the setting of 6th digit of the 1st system flag in ECR. If this flag is set to 2, then the price in cash register will be 1.50.
It is possible to convert multiple online PLUs at once but it is not possible to send multiple online PLUs at once into ECR.
Data contains DPT names, flags and prices and sale values.
Command number: | 132 |
Lines count: | depends on DPT count in ECR |
Each line contains data about one DPT. Each item is separated by "ItemSeparator".
1st item: DPT name.
3rd item: price – according to setting of digit 6 system flag 1 of ECR
4th item: sold quantity since last daily report
5th item: sale value since last daily report
6th item: sold quantity since last monthly report
7th item: sale value since last monthly report
Data contains sale values for each VAT level.
Command number: | 133 |
Lines count: | 7 |
1st item: maximal 10 characters of descriptive text
2nd item: tax rate value (0 – 100.00)
VAT level is forbidden if tax rate value is 10000, (not possible to count assigned PLU).
3rd item: taxable value since last daily report
4th item: value without tax (net) since last daily report
5th item: tax value since last daily report
6th item: taxable value since last monthly report
7th item: value without tax (net) since last monthly report
8th item: tax value since last monthly report
Data contains grand total (GT) values.
Command number: | 134 |
Lines count: | 3 (non fiscal version) |
1st line: GT1
2nd line: GT2
3rd line: GT3
Sale values and counters are incremented to daily/periodical report since last daily/periodical report.
Command number: |
| ||
Lines count: | 36 |
Both files have the same form. Two items are separated with ItemSeparator in each line. First item defines quantity and second one defines sale value. Empty place (gap) at the line means that particular item has no meaning. File items meaning:
1st line: total sale
2nd line: net
3rd line: tax
4th line: void
5th line: void of subtotal
6th line: refund
7th line: received cash on account
8th line: received cash on account in secondary currency
9th line: paid out cash
10th line: paid out cash in secondary currency
11th line: received check on account
12th line: not used (received check on account in secondary currency)
13th line: paid out check
14th line: not used (paid out check in secondary currency)
15th line: discounts
16th line: add-ons
17th line: rounding diference
18th line: not used
19th line: cash sale
20th line: cash sale in secondary currency
21th line: check sale
22th line: not used (check sale in secondary currency)
23th line: credit sale
24th line: not used
25th line: cash in drawer
26th line: cash in drawer in secondary currency
27th line: checks in drawer
28th line: not used (check in drawer in secondary currency)
29th line: credit in drawer
30th line: not used
31th line: not used (bottles)
32th line: not used (returnable bottles)
33th line: not used (void of bottle subtotal)
34th line: number of all receipts
35th line: number of fiscal receipts (in fiscal versions)
36th line: not used (number of changes of names and tax levels)
Data contains cashier names and sales report.
Command number: | 139 - cashier sales report |
Lines count: | for each cashier one line |
Each line contains data about one cashier.
1st item: programmed cashier’s name
2nd item: number of sales since last daily report
3rd item: sale value since last daily report
4th item: number of sales since last monthly report
5th item: sale value since last monthly report
This command can be used to check actual state of online sale and correct sale of PLUs.
Command number: | 147 |
Lines count: | 2 |
1st line:
1st item: number of PLU-s in buffer of sold PLU
2nd item: value
3rd item: number of actual receipt
4th item: total sale sum
5th item: total sale sum in second currency
2nd line: contains last sold PLU through PC-Online
Command number: | 148 |
Lines count: | 8 |
1st line: total sale sum (in base currency)
2nd line: sum in non-taxable level
3rd line:
1st item: taxable value in tax level 1
2nd item: tax value in VAT level 1
4th line:
1st item: taxable value in tax level 2
2nd item: tax value in VAT level 2
5th line:
1st item: taxable value in tax level 3
2nd item: tax value in VAT level 3
6th line:
1st item: taxable value in tax level 4
2nd item: tax value in VAT level 4
7th line:
1st item: taxable value in tax level 5
2nd item: tax value in VAT level 5
8th line:
1st item: taxable value in tax level 6
2nd item: tax value in VAT level 6
All items are valid only during PC ONLINE sale (before last payment send from PC to ECR). Tax values are valid on to MAXTAX – others are zero. Values do not include roundings (e.g. quater rounding calculations) and are valid only during open sale.
Command is used to get information about sale through PC.
Command number: |
| ||
Lines count: | 2 |
1st line: sold quantity – always three decimal places
2nd line: sales value
Table of Contents
When communication library receives data from cash register, these are send to user application as system message. These messages should be handled by the user application.
int ProcessEcrOnline( | wParam, | |
lParam) ; |
WPARAM | wParam; |
LPARAM | lParam; |
wParam
Contains data type information.
Table 5.1. Data types meaning
meaning | value | error value | lParam |
---|---|---|---|
start of communication = header | 0 | 101 | pointer to data |
initialization data | 1 | 102 | pointer to data |
data (items/payment) | 2 | 103 | pointer to data |
end of communication packet | 3 | 104 | pointer to data |
items count | 50 | - | data items count |
communication abort | 51 | - | no data |
error message | 100 | - | error code |
lParam
For
(items count) wParam
= 50lParam
contains number = count of data items in communication.
Communication abort (
) means, that the ECR started a new communication
before the old communication was finished (e. g. ECR shut
down on communication). For
wParam
=
51
(error) wParam
= 100lParam
contains one
of the following error number:
0 – no error,
1 – incorrect header received,
2 – incorrect initialization data received,
3 – incorrect data (items/payment) received,
4 – incorrect end of communication packet received,
5 – time out on initialization data receiving,
6 – time out on data (items/payment) receiving,
7 – time out on end of communication packet receiving,
8 – incorrect data length,
After a error message can be send a message with
incorrect data with "error value" as
wParam
. If any error occurred on data
receiving, then as first message is send a error message
and second message with received corrupted data.
For all other types contains lParam
pointer to data. First 2 bytes contains data length
(wLen
) for received data. Starting
from address lParam + 2
follow
wLen
bytes of data. Length of data depends on data type
(wParam
). Data form
(binary/text) depends on ReceiveEcrOnline
function settings.
In case of correct data processing (no error, only correct values) the return value is 1. On any error on processing the return value should be 0.
Example 5.1. Function for receiving data messages
Simple function for receiving data messages from back ONLINE in
C++ language (without data processing, for data processing it is
necessary to add functions StartNewOnlineSale
,
ProcessOnlineData
, SetOnlineItemsCount
and
EndOnlineSale
).
enum eBackOnlineData { bodRequest = 0, // start of communication - open receipt request bodInit, // init packet (contains ECR settings) bodData, // data packet (contains sold item or payment) bodEOC, // end of receipt bodDataCount = 50, // contains items count bodEndComm, // communication aborted bodErrMsg = 100, // error message bodErrDataMsg, // Corupted data: Add bodInit, bodData, or bodEOC to get // data type of packet }; BOOL CComm2ADlg::OnProcessBackOnline(WPARAM wParam, LPARAM lParam) { switch (wParam) { case bodRequest: if (!StartNewOnlineSale(...)) break; ProcessOnlineData((void*)(lParam + 2), *((WORD*)(lParam))); case bodInit: case bodData: case bodErrDataMsg + bodInit: case bodErrDataMsg + bodData: ProcessOnlineData((void*)(lParam + 2), *((WORD*)(lParam))); return wParam < bodDataCount; case bodEOC: case bodErrDataMsg + bodEOC: EndOnlineSale(); return wParam < bodDataCount; case bodDataCount: SetOnlineItemsCount((WORD)lParam); return true; default: break; } return false; }
Data types are the same as in the first part of the protocol. There is only one difference in extension of types (primary and secondary currency).
Table 5.2. Extension of definition of numerical data types for ECR ON-LINE mode
Decimal numbers are represented as whole numbers. Original value is multiplied (for encoding) or divided (for decoding) by number 1 (0 places), 10 (1 place), 100 (2 places), 1000 (3 places), according to number of places we want to use.
For each sale will be created a new data file. In file name of this data file will be added actual time on PC. Data will be stored in this format:
Table 5.3. Data storing method for "ECR --> PC ONLINE mode"
length in bytes | description/meaning |
---|---|
2 | header length = 6 bytes |
header length (always 6 bytes) | header data |
2 | initialization data length = 6 bytes |
initialization data length (always 6 bytes) | initialization data |
2 | first item length |
first item length | item data |
2 | second item length |
second item length | item data |
2 | third item length |
third item length | item data |
... | ... |
... | ... |
2 | nth item length |
nth item length | item data |
Header length is always 6 bytes and contains protocol identification and number of actual cash register.
Table 5.4. Header data format
Byte) | type | length | meaning |
---|---|---|---|
0 | BYTE | 1 | STX - fixed value = 0x02 |
1 | BYTE | 1 | ID1 - fixed value = 0x50 (ASCII code of char ‘P’) |
2 | BYTE | 1 | ID2 - fixed value = 0x43 (ASCII code of char ‘C’) |
3 | BYTE | 1 | REGNUM - Number of ECR which sends REQUEST (system flag 3, digit 2-3) increased by value 32 (0x20) e. g. if ECR number is 1 then REGNUM is 33 (0x21). |
4 | BYTE | 1 | ETX - fixed value = 0x03 |
5 | BYTE | 1 | CheckXor = control number
(CheckXor = ID1 xor
ID2 xor REGNUM xor
ETX ) |
Initialization data have always 6 bytes and contains all data required for decoding received sales data.
Table 5.5. Initialization data form
Byte | type | length | Meaning |
---|---|---|---|
0 | BYTE | 1 | ECR type |
1 | BYTE | 1 | Fixed value 146 (0x92) |
2 | BYTE | 1 | Number of decimal places for price (0 – 3) (system flag 1 digit 6) |
3 | BYTE | 1 | Quantities are multiplied or divided (0 – divided, 1 – multiplied) (system flag 2 – digit 6) |
4 | BYTE | 1 | Number of transmitted items |
5 | BYTE | 1 | Number of decimal places for price of second currency (0 – 3) (used only in Euro phase 1, 2 and 3) |
Table 5.6. online sale commands
command | meaning |
---|---|
1 (0x01) | PLU was sold |
2 (0x02) | DPT was sold |
3 (0x03) | PLU was refunded |
4 (0x04) | DPT was refunded |
5 (0x05) | Payment |
Data description for commands 1 (sold PLU), 2 (sold DPT), 3 (PLU refund) and 4 (DPT refund).
Byte(s) | meaning | type | commend | |||
---|---|---|---|---|---|---|
0 | Command | BYTE | from 1 to 4 (command 5 has different description) | |||
1–14 | Item name | string | characters | |||
15 | Sales unit assignment | BYTE | Used only for PLU (range: <0, 7>) | |||
16 | DPT assignment | BYTE |
| |||
17 | VAT assignment | BYTE | taxes | |||
18-25 | Total item price | double(*1) | Total price of PLU (DPT) without add-ons and discounts. The price is rounded. If PLU (or DPT) was refunded the sum is negative. | |||
26-29 | Unit item price | DWORD(*1) | ||||
30-33 | Quantity 1 | DWORD(3) | First quantity entered using ECR keyboard while selling. | |||
34-37 | Quantity 2 | DWORD | Second quantity entered using ECR keyboard while selling (second quantity can not be decimal). | |||
38-39 | PLU (DPT) index | WORD | ||||
40-47 | Add-Ons applied to item | double(*1) | Sum of all add-ons applied to the item. | |||
48-55 | Discounts applied to item | double(*1) | Sum of all discounts applied to the item. |
Data description for command 5 (Payment).
Byte(s) | meaning | type | commend |
---|---|---|---|
0 | Command | BYTE | value 5 (commands 1 to 4 have different description) |
1-8 | Cash | double(*1) | total sum paid by cash |
9-16 | Check | double(*1) | total sum paid by check |
17-24 | Credit | double(*1) | total sum paid by credit |
25-32 | Cash in second currency | double(*2) | total sum paid by cash in second currency (used only in Euro phase 1, 2 and 3). |
33-55 | not used |
Table 5.7. online sale commands
command | meaning |
---|---|
1 (0x01) | PLU was sold |
2 (0x02) | DPT was sold |
3 (0x03) | PLU was refunded |
4 (0x04) | DPT was refunded |
5 (0x05) | Payment |
Data description for commands 1 (sold PLU), 2 (sold DPT), 3 (PLU refund) and 4 (DPT refund).
Byte(s) | meaning | type | commend |
---|---|---|---|
0 | Command | BYTE | from 1 to 4 (command 5 has different description) |
1–20 | Item name | string | characters |
21 | Sales unit assignment | BYTE | Used only for PLU (range: <0, 7>) |
22 | DPT assignment | BYTE | Used only for PLU (range: <1, 30>) |
23 | VAT assignment | BYTE | taxes |
24-31 | Total item price | double(*1) | Total price of PLU (DPT) without add-ons and discounts. The price is rounded. If PLU (or DPT) was refunded the sum is negative. |
32-35 | Unit item price | DWORD(*1) | |
36-39 | Quantity 1 | DWORD(3) | First quantity entered using ECR keyboard while selling. |
40-43 | Quantity 2 | DWORD | Second quantity entered using ECR keyboard while selling (second quantity can not be decimal). |
44-45 | PLU (DPT) index | WORD | |
46-53 | Add-Ons applied to item | double(*1) | Sum of all add-ons applied to the item. |
54-61 | Discounts applied to item | double(*1) | Sum of all discounts applied to the item. |
Data description for command 5 (Payment).
Byte(s) | meaning | type | commend |
---|---|---|---|
0 | Command | BYTE | value 5 (commands 1 to 4 have different description) |
1-8 | Cash | double(*1) | total sum paid by cash |
9-16 | Check | double(*1) | total sum paid by check |
17-24 | Credit | double(*1) | total sum paid by credit |
25-32 | Cash in second currency | double(*2) | total sum paid by cash in second currency (used only in Euro phase 1, 2 and 3). |
33-61 | not used |
New data will be stored always at the end of the actual text file. Date and time will be added before each bill data. Individual lines have the following meaning:
1st line: Actual date (from PC) in
following format "Date: YYYY.MM.DD.
"
2nd line: Actual time (from PC) in
following format "Time: hh:mm:ss
"
3rd line: contains number of ECR (system flag 3, digit 2-3).
4th line: contains actual ECR settings. This line consist of 6 items.
Fixed value 146 (0x92)
Number of decimal places for price (0 – 3) (system flag 1 digit 6)
Quantities are multiplied or divided (0 – divided, 1 – multiplied) (system flag 2 – digit 6)
Number of transmitted records
Number of decimal places for price of second currency (0 – 3) (used only in Euro phase 1, 2 and 3)
The following lines ("Number of transmitted records" - 1) contains sales data (saled items)
Command number (from 1 to 4)
Item name
Sales unit assignment (Used only for PLU - range: <1, 8>)
DPT assignment (Used only for PLU)
VAT assignment
Total price of PLU (DPT) without add-ons and discounts. The price is rounded. If PLU (or DPT) was refunded the sum is negative.
Unit item price.
Second quantity entered using ECR keyboard while selling (second quantity can not be decimal).
PLU (DPT) index
Add-Ons applied to item. (Sum of all add-ons applied to the item.)
Discounts applied to item. (Sum of all discounts applied to the item.)
It is possible to change separator between first and second quantity. See settings.
last line contains information about payments
Command number = 5
total sum paid by cash
total sum paid by check
total sum paid by credit
total sum paid by cash in second currency (used only in Euro phase 1, 2 and 3).
If any error occurs while decoding of data, these data will be
printed in hexadecimal form at the corresponding line after
"##"
characters.
Bar-code = EAN.
For data type see types definition.
Binary form of data means data that are not readable by humans. It is the form of data that is used by computers to store numerical data (and strings) for processing. In most cases no data transformation is needed to process data stored in binary form. Needed is only description / meaning of each data position.
Binary journal is sometimes used as term for PC processing journal (see PC journal).
see types definition.
see types definition.
see types definition.
Electronic journal is used as symbol for non tactile journal. It can be the PC journal (in most cases is means this one) or Text journal.
see types definition.
see types definition.
see types definition.
Receipts stored in binary form (not human readable). Receipts are separated in logical blocks (its is possible to separate every stored purchase from whole block data). It is possible to use data from this journal to post-processing sale data (make hour reports, ....).
see Text journal
see PC journal
see types definition.
Human readable form of data. This form is also used by some application to import/export data from/to other programs.
Text journal is only a copy of journal tape in ECR. This journal is human readable. No direct post processing is possible.
see types definition.
Table of Contents
Minimal time equals to the reaction speed of ECR (25ms).
Recommend time is 150ms. Works on all ECRs.
Maximal time is not limited.
Minimal time equals to the time of printing of bill (times depends from initial bill (and logo) printing).
Recommend time is 4s. Works on all ECRs.
Maximal time is not limited.
Minimal time equals to the time of printing of bill header and first item.
Maximal time equals to the time of printing of text logo, bill header and first item.
All times depends on printer speed of cash register.
Recommend time is 8s. Works on all ECRs.
Minimal and maximal time equals to the time of printing of all tax information and payment.
If there are used all VAT levels and big prices the time will be longer than for only one VAT level.
Time depends on printer speed of cash register
Recommend time is 8-10s. Works on all ECRs.