THE FACTORY HKA

Soporte e Integracin

Librera Tfhkaif
Manual de Integracin

SOPORTE E INTEGRACIN

Manual de Integracin
Revision 1.0

The Factory HKA

La California Norte, Callejn Gutirrez
Edif. Riva, PB Ofic. 2-1
Caracas - Venezuela
Telfono (212) 237.4112 Fax (212) 239.8176

Historial de Revisiones
Revisin

Fecha

1.o

19/05/14

Paginas
Afectadas
Todas

Comentario
Versin inicial

ndice
Capitulo 1 .......................................................................................................... 1
Introduccin .............................................................................................................. 1
Resumen .................................................................................................................... 1
Requerimientos de Hardware ................................................................................. 2
Requerimientos de Software ................................................................................... 2

Capitulo 2 .......................................................................................................... 3
Instalacin ................................................................................................................. 3
Alcance de la librera ................................................................................................ 6

Capitulo 3 .......................................................................................................... 7
Importacin y Declaraciones .................................................................................. 7
Funciones de la Libreria Tfhkaif ............................................................................ 8
OpenFpctrl .................................................................................................. 8
CloseFpctrl................................................................................................... 8
CheckFprinter ............................................................................................. 8
ReadFpStatus ............................................................................................... 9
SendCmd ...................................................................................................... 9
SendFileCmd ............................................................................................... 9
UploadReportCmd ................................................................................... 10
UploadStatusCmd ..................................................................................... 10
UploadReportCmdDin ............................................................................ 11
UploadStatusCmdDin .............................................................................. 11
Anexos ..................................................................................................................... 13
ANEXO 1: Lista de cdigos de Status .................................................. 13
ANEXO 2: Lista de cdigos de Error ................................................... 14
ANEXO 3: Ejemplo bsico de emisin de Factura para Consumidor
Final ............................................................................................................ 15

T H E

F A C T O R Y

Captulo

H K A

Introduccin
La librera Tfhkaif permite la integracin con sistemas
administrativos desarrollados bajo la tecnologa de Win 32; como
lo son Delphi, FoxPro, PowerBuilder y Visual Basic 6.

Resumen

n las siguientes pginas se describen los detalles de la interfaz de aplicacin

Tfhkaif, desde los requerimientos de hardware, la referencia a la librera de
integracin, los componentes adicionales tales como libreras dinmicas y
finalmente la estructura de la Clase compilada que contiene los mtodos y
propiedades para el uso de cualquiera de las impresoras distribuidas por The Factory
HKA a travs de un sistema administrativo desarrollado bajo Win 32.

T H E

F A C T O R Y

H K A

Requerimientos de Hardware

Procesador de 1Ghz o superior

Memoria RAM de 512MB o superior

Espacio libre en Disco Duro de 50MB

Puerto Serial fsico o USB 2.0

Requerimientos de Software

Sistema Operativo Windows

IDE para manejar un desarrollo en Delphi, FoxPro, PowerBuilder &
Visual Basic 6

T H E

F A C T O R Y

H K A

Captulo

Instalacin
En el SDK descargado, usted se encontrar con las tres herramientas bsicas para
realizar la integracin del sistema administrativo con nuestra impresora fiscal; la librera
de integracin (Tfhkaif.dll), el manual de dicha librera y un demo funcional de cdigo
abierto en donde se ejemplifica el uso de la librera de forma prctica.
Instalacin
Antes de comenzar a hacer uso de la librera en el desarrollo, lo primero que se debe
hacer es registrar y referenciar la librera en nuestro proyecto. Esto se consigue
siguiendo los siguientes pasos:
1. Creamos una nueva carpeta.

T H E

F A C T O R Y

H K A

2. Descomprimimos el contenido del SDK en la capeta previamente creada.

3. Copiamos la librera.

T H E

F A C T O R Y

H K A

4. Pegamos la librera en la carpeta System32 de Windows.

5. Finalmente, creamos tres variables de control para trabajar la librera durante el

uso de nuestro desarrollo y declaramos las distintas funciones a utilizar de la
librera.

Acto seguido, nos encontramos listos para empezar a utilizar las funciones que
contiene la librera.

T H E

F A C T O R Y

H K A

Alcance de la librera
La librera Tfhkaif es compatible con cualquier desarrollo cuya base sea el lenguaje
Delphi, FoxPro, PowerBuilder o Visual Basic 6.

T H E

F A C T O R Y

H K A

Captulo

Importacin y Declaraciones
Una vez agregada la referencia de la librera Tfhkaif a la Solucin se puede empezar a
trabajar con la misma, utilizando sus funciones de integracin.

T H E

F A C T O R Y

H K A

Funciones de la Librera Tfhkaif

OpenFpctrl
BOOLEAN OpenFpctrl(String IpPortName)
Permite realizar la apertura del puerto de comunicaciones por el cual se
establecer comunicacin con la impresora. Este mtodo se ejecuta en
el constructor nico de la clase, pero puede ser ejecutada nuevamente
de ser requerido.
Parmetros:

String IpPortName: Nombre del puerto COM a abrir.

Retorno:
True: Puerto Abierto
False: Falla en apertura
CloseFpctrl
VOID CloseFpctrl()
Permite cerrar del puerto COM asociado, abierto anteriormente
Retorno:
Esta funcin devuelve un booleano en donde si el mismo es
verdadero, significa que se ha cerrado el puerto de comunicaciones
con xito, de lo contrario no se cerr el puerto de comunicaciones.
CheckFprinter
BOOLEAN CheckFprinter()
Permite verificar si la impresora est conectada al PC.
Retorno:
True: impresora conectada.
False: impresora no detectada.

T H E

F A C T O R Y

H K A

ReadFpStatus
BOOLEAN ReadFpStatus()
Permite leer las variables de estado y error de la impresora. Al ejecutar
este mtodo se establece el valor de la variable tipo String Estado. (Ver
Anexos 1 y 2)
Retorno:
True: Mtodo ejecutado exitosamente
False: Error en ejecucin del mtodo
SendCmd
BOOL SendCmd(Status Long, Error Long, String Cmd)
Permite realizar el envo de comandos hacia la impresora, en forma de
tramas de caracteres ASCII, tal como es descrito en los manuales de
integracin de las respectivas impresoras, y en el manual general de
protocolos y comandos del protocolo TFHKA.
Parmetros:

String cmd: trama de comando en ASCII que se enviara a la

impresora.
Retorno:
True: Mtodo ejecutado exitosamente.
False: Error en ejecucin del mtodo.
SendFileCmd
INT SendFileCmd(Status Long, Error Long, String file)
Permite realizar el envo de un archivo de lotes de comando hacia la
impresora.
Parmetros:

String rutaFile: ruta en la cual se encuentra el archivo de comandos

por lote que se enviar a la impresora.

T H E

F A C T O R Y

H K A

Retorno:
(int) Nmero de lneas del archivo de lotes de comandos ejecutadas
exitosamente.
UploadReportCmd
BOOLEAN UploadReportCmd(Status Long, Error Long, String cmd,
String file)
Permite almacenar en un archivo de texto simple, un reporte de la
impresora.
Parmetros:

String cmd: tipo de reporte a solicitar. Los reportes que pueden ser

solicitados son los siguientes (consultar manual general de integracin

de las respectivas impresoras):
-

U0X

U0Z

U1Z

U1X

String file: ruta del archivo donde se almacenar el reporte solicitado.

Retorno:
True: Mtodo ejecutado exitosamente.
False: Error en ejecucin del mtodo.
UploadStatusCmd
BOOLEAN UploadStatusCmd(Status Long, Error Long, String cmd,
String file)
Esta funcin permite almacenar en un archivo de texto simple, un
status de la impresora.
Parmetros:

String cmd: tipo de Status a solicitar. Los Status que pueden ser
solicitados son los siguientes:
-

S1
S2
S3

S4
S5
S8E

S8P

String file: ruta del archivo donde se almacenar el Status solicitado.

10

T H E

F A C T O R Y

H K A

Retorno:
True: Mtodo ejecutado exitosamente.
False: Error en ejecucin del mtodo.
UploadReportDin
BOOLEAN UploadReportCmdDin(Status As Long, Error As Long, cmd As String, Cadena As String)

Permite almacenar en una cadena, un reporte de la impresora.

Parmetros:

String cmd: tipo de reporte a solicitar. Los reportes que pueden ser

solicitados son los siguientes (consultar manual general de integracin

de las respectivas impresoras):
-

U0X

U0Z

U1Z

U1X

String Cadena: variable donde se almacenar el reporte.

Retorno:
True: Mtodo ejecutado exitosamente.
False: Error en ejecucin del mtodo.
UploadStatusDin
BOOLEAN UploadStatusCmdDin(Status As Long, Error As Long, cmd As String, Cadena As String)

Esta funcin permite almacenar en una cadena, un status de la

impresora.
Parmetros:

String cmd: tipo de Status a solicitar. Los Status que pueden ser

solicitados son los siguientes (consultar manual general de integracin

de las respectivas impresoras):
-

S1
S2
S3

S4
S5
S8E

String Cadena: variable donde se almacenar el status.

Retorno:
11

S8P

T H E

F A C T O R Y

H K A

True: Mtodo ejecutado exitosamente.

False: Error en ejecucin del mtodo.

12

T H E

F A C T O R Y

H K A

Anexos
ANEXO 1: Lista de cdigos de Status
STATUS
Retorno
(Hex)

Retorno
(Decimal)

Estado desconocido.

En modo prueba y en espera.

En modo prueba y emisin de documentos fiscales.

En modo prueba y emisin de documentos no fiscales.

En modo fiscal y en espera.

En modo fiscal y emisin de documentos fiscales.

0A

10

0B

11

0C

12

En modo fiscal y emisin de documentos no fiscales.

En modo fiscal, cercana carga completa de la memoria fiscal y
en espera.
En modo fiscal, cercana carga completa de la memoria fiscal y
en emisin de documentos fiscales.
En modo fiscal, cercana carga completa de la memoria fiscal y
en emisin de documentos no fiscales.
En modo fiscal, carga completa de la memoria fiscal y en
espera.
En modo fiscal, carga completa de la memoria fiscal y en
emisin de documentos fiscales.
En modo fiscal, carga completa de la memoria fiscal y en
emisin de documentos no fiscales.

Comentario

13

T H E

F A C T O R Y

H K A

ANEXO 2: Lista de cdigos de Error

ERROR
Retorno
(Hex)

Retorno
(Decimal)

00

No hay error.

01

Fin en la entrega de papel.

02

Error de ndole mecnico en la entrega de papel.

03

Fin en la entrega de papel y error mecnico.

50

80

Comando invalido o valor invalido.

54

84

Tasa invalida.

58

88

No hay asignadas directivas.

5C

92

Comando invalido.

60

96

Error fiscal.

64

100

Error de la memoria fiscal.

6C

108

Memoria fiscal llena.

70

112

Buffer completo. (debe enviar el comando de reinicio)

80

128

Error en la comunicacin.

89

137

No hay respuesta.

90

144

Error LRC.

91

145

Error interno api.

99

153

Error en la apertura del archivo.

Comentario

14

T H E

F A C T O R Y

H K A

ANEXO 3: Ejemplo bsico de emisin de Factura

'Variables de Control
Public Response As Boolean
Private Sub cmdInvoice_Click()
Response = SendCmd(status,
Response = SendCmd(status,
Response = SendCmd(status,
Response = SendCmd(status,
Response = SendCmd(status,
End Sub

error,
error,
error,
error,
error,

" 000000053200001000Milk")
"!000000021700001000Cookies")
Chr(34) & "000000053200001000Aspirin")
"#000000053200001000Jewels")
"101")

15