EPSON FISCAL DRIVER

SPECIFICATION
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 2/21

1 INTRODUCTION ............................................................................................................................................................................... 6

2 LIBRARIES ....................................................................................................................................................................................... 7

2.1 FOR WINDOWS (32 AND 64 BITS)..................................................................................................................................................... 7

2.2 FOR LINUX (32 AND 64 BITS) ........................................................................................................................................................... 7
2.3 FOR ANDROID ................................................................................................................................................................................ 7
3 INSTALLATION ................................................................................................................................................................................ 8

3.1 LINUX ............................................................................................................................................................................................ 8

3.2 WINDOWS ...................................................................................................................................................................................... 8
3.3 ANDROID ....................................................................................................................................................................................... 8
4 CODE ERROR .................................................................................................................................................................................. 9

5 PROGRAMMING INTERFACE ....................................................................................................................................................... 10

5.1 API VERSION ............................................................................................................................................................................... 10

5.1.1 DLL .................................................................................................................................................................................. 10
5.1.2 OCX ................................................................................................................................................................................. 10
5.2 MULTI PRINTER ............................................................................................................................................................................ 10
5.2.1 DLL .................................................................................................................................................................................. 10
5.2.2 OCX ................................................................................................................................................................................. 10
5.2.3 Notes ............................................................................................................................................................................... 10
5.3 COMMUNICATIONS PORT ............................................................................................................................................................... 10
5.3.1 DLL .................................................................................................................................................................................. 10
5.3.2 OCX ................................................................................................................................................................................. 10
5.3.3 Notes ............................................................................................................................................................................... 11
5.4 BAUD RATE.................................................................................................................................................................................. 11
5.4.1 DLL .................................................................................................................................................................................. 11
5.4.2 OCX ................................................................................................................................................................................. 11
5.4.3 Notes: .............................................................................................................................................................................. 11
5.5 PROTOCOL TYPE .......................................................................................................................................................................... 11
5.5.1 DLL .................................................................................................................................................................................. 11
5.5.2 OCX ................................................................................................................................................................................. 11
5.5.3 Notes ............................................................................................................................................................................... 12
5.6 STATE ......................................................................................................................................................................................... 12
5.6.1 DLL .................................................................................................................................................................................. 12
5.6.2 OCX ................................................................................................................................................................................. 12
5.6.3 Notes ............................................................................................................................................................................... 12
5.7 LASTERROR................................................................................................................................................................................. 12
5.7.1 DLL .................................................................................................................................................................................. 12
5.7.2 OCX ................................................................................................................................................................................. 12
5.7.3 Notes ............................................................................................................................................................................... 12
5.8 FISCALSTATUS ............................................................................................................................................................................. 12
5.8.1 DLL .................................................................................................................................................................................. 12
5.8.2 OCX ................................................................................................................................................................................. 13
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 3/21

5.9 PRINTERSTATUS .......................................................................................................................................................................... 13

5.9.1 DLL .................................................................................................................................................................................. 13
5.9.2 OCX ................................................................................................................................................................................. 13
5.10 RETURNCODE .............................................................................................................................................................................. 13
5.10.1 DLL .................................................................................................................................................................................. 13
5.10.2 OCX ................................................................................................................................................................................. 13
5.11 OPEN PORT ................................................................................................................................................................................. 13
5.11.1 DLL .................................................................................................................................................................................. 13
5.11.2 OCX ................................................................................................................................................................................. 13
5.12 OPEN PORT BY NAME .................................................................................................................................................................... 14
5.12.1 DLL .................................................................................................................................................................................. 14
5.12.2 OCX ................................................................................................................................................................................. 14
5.12.3 Notes: .............................................................................................................................................................................. 14
5.13 CLOSE PORT................................................................................................................................................................................ 14
5.13.1 DLL .................................................................................................................................................................................. 14
5.13.2 OCX ................................................................................................................................................................................. 14
5.14 RE OPEN PORT ............................................................................................................................................................................. 14
5.14.1 DLL .................................................................................................................................................................................. 15
5.14.2 OCX ................................................................................................................................................................................. 15
5.14.3 Notes: .............................................................................................................................................................................. 15
5.15 PURGE COMMUNICATIONS ............................................................................................................................................................. 15
5.15.1 DLL .................................................................................................................................................................................. 15
5.15.2 OCX ................................................................................................................................................................................. 15
5.16 ADD FIELD TO TRANSMIT BUFFER ................................................................................................................................................... 15
5.16.1 DLL .................................................................................................................................................................................. 15
5.16.2 OCX ................................................................................................................................................................................. 15
5.16.3 Note: ................................................................................................................................................................................ 15
5.17 ADD FIELD TO TRANSMIT BUFFER ................................................................................................................................................... 16
5.17.1 OCX ................................................................................................................................................................................. 16
5.18 SEND COMMAND........................................................................................................................................................................... 16
5.18.1 DLL .................................................................................................................................................................................. 16
5.18.2 OCX ................................................................................................................................................................................. 16
5.19 SEND COMMAND IN A SINGLE OPERATION ....................................................................................................................................... 16
5.19.1 DLL .................................................................................................................................................................................. 16
5.19.2 OCX ................................................................................................................................................................................. 16
5.19.3 Notes: .............................................................................................................................................................................. 16
5.20 EXTENDED FIELDS NUMBERS ......................................................................................................................................................... 17
5.20.1 DLL .................................................................................................................................................................................. 17
5.20.2 OCX ................................................................................................................................................................................. 17
5.21 EXTENDED FIELD .......................................................................................................................................................................... 17
5.21.1 DLL .................................................................................................................................................................................. 17
5.21.2 OCX ................................................................................................................................................................................. 17
5.22 TRANSMIT FRAME ......................................................................................................................................................................... 17
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 4/21

5.22.1 DLL .................................................................................................................................................................................. 17

5.22.2 OCX ................................................................................................................................................................................. 17
5.23 RECEIVE FRAME ........................................................................................................................................................................... 17
5.23.1 DLL .................................................................................................................................................................................. 17
5.23.2 OCX ................................................................................................................................................................................. 18
5.24 ADD HTTP HEADER...................................................................................................................................................................... 18
5.24.1 DLL .................................................................................................................................................................................. 18
5.24.2 OCX ................................................................................................................................................................................. 18
5.24.3 Notes: .............................................................................................................................................................................. 18
5.25 POST ......................................................................................................................................................................................... 18
5.25.1 DLL .................................................................................................................................................................................. 18
5.25.2 OCX ................................................................................................................................................................................. 18
5.25.3 Notes: .............................................................................................................................................................................. 18
5.26 GET ............................................................................................................................................................................................ 18
5.26.1 DLL .................................................................................................................................................................................. 18
5.26.2 OCX ................................................................................................................................................................................. 19
5.26.3 Notes: .............................................................................................................................................................................. 19
5.27 HTTP/S STATUS CODE ................................................................................................................................................................. 19
5.27.1 DLL .................................................................................................................................................................................. 19
5.27.2 OCX ................................................................................................................................................................................. 19
5.27.3 Notes: .............................................................................................................................................................................. 19
5.28 HTTP/S RESPONSE HEADERS NUMBERS........................................................................................................................................ 19
5.28.1 DLL .................................................................................................................................................................................. 19
5.28.2 OCX ................................................................................................................................................................................. 19
5.28.3 Notes: .............................................................................................................................................................................. 19
5.29 HTTP/S RESPONSE HEADER ......................................................................................................................................................... 20
5.29.1 DLL .................................................................................................................................................................................. 20
5.29.2 OCX ................................................................................................................................................................................. 20
5.29.3 Notes: .............................................................................................................................................................................. 20
5.30 HTTP/S RESPONSE BODY............................................................................................................................................................. 20
5.30.1 DLL .................................................................................................................................................................................. 20
5.30.2 OCX ................................................................................................................................................................................. 20
5.30.3 Notes: .............................................................................................................................................................................. 20
5.31 HTTPS PERMISSIONS................................................................................................................................................................... 20
5.31.1 DLL .................................................................................................................................................................................. 20
5.31.2 OCX ................................................................................................................................................................................. 20
5.31.3 Notes: .............................................................................................................................................................................. 21
5.32 GETPERMISSION........................................................................................................................................................................... 21
5.32.1 AAR ................................................................................................................................................................................. 21
5.32.2 Notes: .............................................................................................................................................................................. 21
5.33 GETUSBHOSTPORT ..................................................................................................................................................................... 21
5.33.1 AAR ................................................................................................................................................................................. 21
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 5/21

5.33.2 Notes: .............................................................................................................................................................................. 21

6 EXAMPLES..................................................................................................................................................................................... 21
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 6/21

1 Introduction

This document describes the properties and methods of the EpsonFiscalDriver.

 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 7/21

2 Libraries

2.1 For Windows (32 and 64 bits)

 EpsonFiscalDriver.dll – Dynamic Link Library (DLL)

 EpsonFiscalDriver.lib – Static Library (LIB)
 comEpsonFiscalDriver.ocx – Component Object Model (COM)
2.2 For Linux (32 and 64 bits)

 libEpsonFiscalDriver.a – Static lib (LIB)

 libEpsonFiscalDriver.so – Dynamic lib (LIB)
2.3 For Android

 EpsonFiscalDriver.aar – Android archive library(aar)

 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 8/21

3 Installation

3.1 Linux
Static Linking – Just link the lib (.a file) during the application building process.
Dynamic Linking – Link and distribute the lib (.so file) with your executable file.
3.2 Windows
Install the drivers package running EpsonFiscalDriverInstaller.exe
After that, OCX can be referenced and used by the application.
The dynamic/static libraries (DLL and LIB) are used by the application in the same way as Linux ones.

Note that, in all cases, EpsonFiscalDriverInstaller.exe should also be installed in the PC where the application is
executed.
3.3 Android
In your project add EpsonFiscalDriver.aar as dependencies and after that can be imported and used by the
application.
This is a mandatory import: import epson.epsonfiscaldriver.EpsonFiscalDriver.
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 9/21

4 Code Error

Error Code (dec) Description

0 Success
1 Port in use
2 Invalid port number
3 Port already open
4 Port already close
5 Initialization error
6 Port closed
7 Maximum length reached
8 Invalid data field
9 Operation in progress
10 Write error
11 Timeout Error
12 Byte 0x15 received
13 Invalid index
14 Invalid buffer size
15 Invalid data in field
16 Reception error
17 Invalid baud rate
18 Invalid protocol type
19 Invalid thread
20 Invalid syntax
21 Invalid method
22 More data
23 Invalid hash
24 SSL protocol fail
25 Invalid certificate
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 10/21

5 Programming Interface

5.1 API Version

Returns the API version.
5.1.1 DLL
Prototype: void GetAPIVersion( char *api_version );
5.1.2 OCX
Access method: Property
Name: APIVersion
Access: Read only
Return type: OLE String

5.2 Multi printer

Set multi printer mode
5.2.1 DLL
Prototype: void SetMultiPrinter( void );
5.2.2 OCX
Access method: Method
Name: SetMultiPrinter
Output: Nothing
5.2.3 Notes
By default, the dll/ocx woks only with a single fiscal printer. Once this method is executed it is possible to control
several fiscal printers. Keep control of each fiscal printer by encapsulating all communications handling in a
separate thread. Then there can be as many threads as fiscal printers want to control. You can use the
ReOpenPortByName method to be able to control the same fiscal printer from another thread using the same or
another protocol.

5.3 Communications port

Defines the communication port where the printer is connected.
5.3.1 DLL
Prototype: void setComPort( int portnumber );
Prototype: int getComPort( void );
5.3.2 OCX
Access method: Property
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 11/21

Name: ComPort
Access: Read/Write
Input: Integer
Output: Integer
5.3.3 Notes
Windows
The value of the port can be: 0=USB, 1=Com1, 2=Com2…
Linux
The value of the port can be: 0=USB, 1=/dev/tty/S0 or /dev/ttyUSB0, 2=/dev/ttyS1 or /dev/ttyUSB1

5.4 Baud Rate

Defines the communication port speed.
5.4.1 DLL
Prototype: void setBaudRate( int baud );
Prototype: int getBaudRate( void );
5.4.2 OCX
Access method: Property
Name: BaudRate
Access: Read/Write
Input: Integer
Output: Integer
5.4.3 Notes:
Supported baudrates are: 1200, 2400, 4800, 9600, 19200, 38400, 57600 and 115200

5.5 Protocol type

Define the protocol type
5.5.1 DLL
Prototype: void setProtocolType( int protocol );
Prototype: int getProtocolType( void );
5.5.2 OCX
Access method: Property
Name: ProtocolType
Access: Read/Write
Input: Integer
Output: Integer
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 12/21

5.5.3 Notes
Set the value to “0” to use the Compatible protocol
Set the value to “1”to use Extended protocol
Set the value to “2” to use HTTP protocol
Set the value to “3” to use HTTPS protocol

5.6 State
Gets the current control state.
5.6.1 DLL
Prototype: getState( void );
5.6.2 OCX
Access method: Property
Name: State
Access: Read only
Output: Integer
5.6.3 Notes
Close=0, Idle=1, Busy=2

5.7 LastError
Gets the last control error.
5.7.1 DLL
Prototype: int getLastError( void );
5.7.2 OCX
Access method: Property
Name: State
Access: Read only
Output: Integer
5.7.3 Notes
Check the error codes table.

5.8 FiscalStatus
Gets the last fiscal status.
5.8.1 DLL
Prototype: int getFiscalStatus( void );
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 13/21

5.8.2 OCX
Access method: Property
Name: FiscalStatus
Access: Read only
Output: Integer

5.9 PrinterStatus
Get the last printer status.
5.9.1 DLL
Prototype: int getPrinterStatus( void );
5.9.2 OCX
Access method: Property
Name: PrinterStatus
Access: Read only
Output: Integer
5.10 ReturnCode
Get the last command’s return code.
5.10.1 DLL
Prototype: getReturnCode( void );
5.10.2 OCX
Access method: Property
Name: ReturnCode
Access: Read only
Output: Integer

5.11 Open Port

This method opens the communication port.
5.11.1 DLL
Prototype: void OpenPort( void );
5.11.2 OCX
Access method: Method
Name: OpenPort
Output: Nothing
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 14/21

5.12 Open port by name

This method opens the communication port using the string like a parameter. The HTTP and HTTPS protocols must use
this method to establish communication. See Notes about the correct nomenclature.
5.12.1 DLL
Prototype: void OpenPortByName( char *portname );
5.12.2 OCX
Access method: Method
Name: OpenPortByName
Input: OLE String
Output: Nothing
5.12.3 Notes:
Each port must be preceded by one of the following tags:
 serial ( For serial ports )
 usb ( For USB ports )
 lan ( For HTTP and HTTPS ports )
Examples
 OpenPortByName(“serial:COM1”); // Open Windows serial COM1
 OpenPortByName(“serial:/dev/ttyS4”); // Open Linux serial ttyS4
 OpenPortByName(“usb:usb”); // Open usb
 OpenPortByName(“lan:192.168.1.1”); // HTTP to 192.168.1.1
 OpenPortByName(“lan:192.168.1.1:443”); // HTTPS to 192.168.192.169 at port 443

5.13 Close Port

Close the communication port
5.13.1 DLL
Prototype: void ClosePort( void );
5.13.2 OCX
Access method: Method
Name: ClosePort
Input: Nothing
Output: Nothing

5.14 Re open port

Open another instance of an open port
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 15/21

5.14.1 DLL
Prototype: void ReOpenPortByName( char *portname );
5.14.2 OCX
Access method: Method
Name: ReOpenPortByName
Input: OLE String
Output: Nothing
5.14.3 Notes:
The DLL/OCX is a thread safe control. Use this method if your application requires than multiplex threads to
access the same fiscal printer communication port

5.15 Purge communications

Clean all communications buffers and reset the internal controls
5.15.1 DLL
Prototype: void Purge( void );
5.15.2 OCX
Access method: Method
Name: Purge
Input: Nothing
Output: Nothing

5.16 Add field to transmit buffer

Add data to transmit buffer
5.16.1 DLL
Prototype: void AddDataField( char *in_buffer, int in_buffer_length );
5.16.2 OCX
Access method: Method
Name: AddDataField
Input: OLE String, int
Output: Nothing
5.16.3 Note:
Not recommended by new design, instead use addField method
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 16/21

5.17 Add field to transmit buffer

Add data to transmit buffer
5.17.1 OCX
Access method: Method
Name: addField
Input: OLE String
Output: Nothing

5.18 Send command

Send command to Fiscal Printer
5.18.1 DLL
Prototype: void SendCommand( void );
5.18.2 OCX
Access method: Method
Name: SendCommand
Input: Nothing
Output: Nothing

5.19 Send command in a single operation

5.19.1 DLL
Prototype: void SendCommadComplete( char *command );
5.19.2 OCX
Access method: Method
Name: SendCommandComplete
Input: OLE String
Output: Nothing
5.19.3 Notes:
This method sends a command complete. Each field is separated with the pipe character. The first field is the
command in ascii hex format, the second field is the command extension in the ascii hex format also. The following
additional fields are in ascii format.

Example SendCommandComplete( “020A|0000”);

 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 17/21

5.20 Extended fields numbers

Return the number of extended fields in response to a command
5.20.1 DLL
Prototype: int getExtraFieldCount( void );
5.20.2 OCX
Access method: Property
Name: ExtraFieldsCount
Access: Read
Output: Integer

5.21 Extended field

Get an extended extra field
5.21.1 DLL
Prototype: GetExtraField( int field_number, char *output_buffer, int out_buffer_length );
5.21.2 OCX
Access method: Method
Name: GetExtraField
Input: Long
Output: OLE String

5.22 Transmit frame

Gets the last frame (protocol frame) that was sent to the printer.
5.22.1 DLL
Prototype: GetSentFrame( char *output_buffer, int output_buffer_length, int *final_length);
5.22.2 OCX
Access method: Property
Name: SentFrame
Input: Nothing
Output: OLE String

5.23 Received frame

Gets the last frame (protocol frame) received from the printer.
5.23.1 DLL
Prototype: void GetReceivedFrame( char *output_buffer, int output_buffer_length, int *final_length);
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 18/21

5.23.2 OCX
Access method: Property
Name: ReceivedFrame
Input: Nothing
Output: OLE String

5.24 Add HTTP header

Add request header to HTTP/S method
5.24.1 DLL
Prototype: AddRequestHeader( char *header );
5.24.2 OCX
Access method: Method
Name: AddRequestHeader
Input: OLE String
Output: Nothing
5.24.3 Notes:
This method is valid only in the HTTP/S protocols

5.25 POST
Send POST request
5.25.1 DLL
Prototype: void SendPostRequest( char *uri, char *body );
5.25.2 OCX
Access method: Method
Name: SendPostRequest
Input: OLE Strings
Output: Nothing
5.25.3 Notes:
This method is valid only in the HTTP/S protocols

5.26 GET
Send GET request
5.26.1 DLL
Prototype: void SendGetRequest( char *uri, char *query_string );
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 19/21

5.26.2 OCX
Access method: Method
Name: SendGetRequest
Input: OLE Strings
Output: Nothing
5.26.3 Notes:
This method is valid only in the HTTP/S protocols

5.27 HTTP/S status code

Get HTTP/S status code
5.27.1 DLL
Prototype: int GetHTTPStatusCode( void );
5.27.2 OCX
Access method: Property
Name: HTTPStatusCode
Input: Nothing
Output: Integer
5.27.3 Notes:
This method is valid only in the HTTP/S protocols

5.28 HTTP/S response headers numbers

Get the numbers of the response HTTP headers
5.28.1 DLL
Prototype: int GetResponseHeadersCount( void );
5.28.2 OCX
Access method: Property
Name: ResponseHeadersCount
Input: Nothing
Output: Integer
5.28.3 Notes:
This method is valid only in the HTTP/S protocols
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 20/21

5.29 HTTP/S response header

Get specific HTTP/S response header
5.29.1 DLL
Prototype: void GetResponseHeader( int header_num, char* output_buffer, int output_buffer_length, int
*final_length);
5.29.2 OCX
Access method: Property
Name: ResponseHeader
Input: Integer
Output: OLE String, Integer
5.29.3 Notes:
This method is valid only in the HTTP/S protocols. The first header index is 1.

5.30 HTTP/S response body

Get the body response
5.30.1 DLL
Prototype: void GetResponse( char *output_buffer, int output_buffer_length, int*final_length );
5.30.2 OCX
Access method: Property
Name: Response
Input: Integer
Output: OLE String, Integer
5.30.3 Notes:
This method is valid only in the HTTP/S protocols.

5.31 HTTPS permissions

Add certificate and private key files
5.31.1 DLL
Prototype: void AddCertificate( char*certificate_file, char *private_jey_file);
5.31.2 OCX
Access method: Method
Name: AddCertificate
Input: OLE Strings
Output: Nothing
 EPSON FISCAL DRIVER

EpsonFiscalDriver - Version: 3.0.1 August 15, 2019 Page 21/21

5.31.3 Notes:
This method is valid only in the HTTP/S protocols.

5.32 getPermission
This method returns a string with information about device and request a permission to use USB port. It is only available in
ANDROID.
5.32.1 AAR
Prototype: String getPermission( void );
Input: Nothing
Output: String
5.32.2 Notes:
The device must have a USB host( check in specification device ). Use the function getUSBHostPort to check it.
The function getPermission is mandatory and must to be used before the function OpenPort. After execution will be
appears a dialog box. Press “OK” to allow the use of USB port.

5.33 getUSBHostPort
This method checks if device has a USB Host. It is only available in ANDROID.
5.33.1 AAR
Prototype: getUSBHostPort( void );
Input: Nothing
Output: Boolean
5.33.2 Notes:
True – device has a USB host, otherwise False

6 Examples

Code examples can be found into the .\Examples folder, showing the use of the methods and properties. It is very
important to correctly check the return codes and exceptions.