Driver Billetero CashCode

Vault 400 BackLoad ST

FECHA 21/05/10 09/06/10 22/07/10 16/08/11 24/08/11

HISTORIAL Y CONTROL DE VERSIONES MOTIVO Versin inicial Definicin de Denominacin de Billetes por parmetros de inicializacin de Driver Agregacin de 2 comandos para Aceptar un billete en 2 etapas Correccin en respuesta de comando Status Correccin en la inicializacin del modulo de comunicacin rs232 Bug fixing cuando la caja se remueve del billetero o cuando se encuentra llena

REV 1.00 1.01 1.02 1.03 1.04

ESTADO Aprobado Aprobado Aprobado Aprobado Aprobado

ndice
ndice ...............................................................................................................................................3 INTRODUCCION...................................................................................................................4 ASPECTOS GENERALES....................................................................................................4 CARACTERISTICAS TECNICAS.........................................................................................4
Protocolo..................................................................................................................................... 4 Comandos................................................................................................................................... 5

OPCIONES DE CONFIGURACION....................................................................................11
Parmetros de Ejecucin.........................................................................................................11

ANEXO

...........................................................................................................................12

Tabla de errores........................................................................................................................ 12

V1.04

INTRODUCCION
Este documento describe las especificaciones y caractersticas del funcionamiento del driver del Aceptador de billetes CashCode Vault 400 BackLoad ST.

ASPECTOS GENERALES
El Driver est implementado como un servicio Windows. El servicio ofrece un socket TCP/IP que atiende conexiones de aplicaciones Cliente que van a operar con el dispositivo por medio de comandos !" de tipo #E$%E&T 'en el sentido Cliente ( Driver) con sus respectivos #E&P*+&E 'en el sentido Driver ( Cliente). El Driver soporta los comandos ,sicos -enerales .omolo-ados para todos los drivers/ son los si-uientes0 &tatus Capa,ilit1 2ersi3n 4dems de las funciones -enerales 'status/ capa,ilit1/ version)/ el driver posee implementadas las si-uientes funciones espec5ficas del dispositivo0 Store_Bill Enable_Bill Hold_Bill

CARACTERISTICAS TECNICAS
Protocolo
La Aplicacin Cliente enva un RESQUEST bloqueante al Driver usando XML y este enva el RESPONSE luego de ejecutar el comando requerido con su resultado. Si un REQUEST an no est soportado por el Driver, un RESULT "Not Supported" (-200) ser devuelto a la aplicacin, pero si no es vlido un RESULT "Invalid XML" (-100) ser devuelto a la aplicacin. El Driver soporta mltiples REQUEST al mismo tiempo, encolando y atendiendo de a uno los requerimientos.

V1.04

Comandos

Status:

Este mtodo no recibe parmetros y devuelve un estado operativo y una lista de propiedades (status properties) con sus correspondientes estados. Este comando si no puede contactar al dispositivo, deber indicar que est "No Operacional". La respuesta est compuesta por los siguientes campos:
Propiedad Operational Sta e Error Descripcin Muestra si el dispositivo est conectado Muestra el estado de ejecucin en que se encuentra el aceptador de billetes Indica si el estado es un error o no

Los siguientes son ejemplos de RESQUEST /RESPONSE de "status":

*************** REQUEST ******************* <?xml version="1.0" encoding="ISO- !"-1"?# <s$%$&s#<'s$%$&s# *************** RES(O)SE ****************** <?xml version="1.0" encoding="UT*- "?# <s$%$&s# <res&l$# <code#0<'code# <mess%ge#o+<'mess%ge# <'res&l$# <o,er%$ion%l# <v%l&e $-,e=".oole%n"#$r&e<'v%l&e# <'o,er%$ion%l# <,ro,er$ies# <,ro,er$-# <n%me#s$%ge<'n%me# <v%l&e $-,e="s$ring"#I)/I0IT<'v%l&e# <',ro,er$-# <,ro,er$-# <n%me#error<'n%me# <v%l&e $-,e=".oole%n"#1%lse<'v%l&e# <',ro,er$-# <',ro,er$ies# <'s$%$&s#

El tag "operational" es un booleano que indica, sin posibilidad de error, si el dispositivo est operativo (true) o no (false). Este valor es formado por el Driver del dispositivo en funcin de los diversos estados y ser utilizado por la aplicacin para decidir si cuenta o no con la funcionalidad del dispositivo. El tag "stage" indica el estado en que se encuentra el dispositivo. El tag "error" indica si existi algn error en el proceso de lectura del estado del dispositivo.

V1.04

Capability: Este mtodo no recibe parmetros y devuelve una lista de propiedades con sus correspondientes valores. Este comando no puede generar errores (aunque podra devolver una lista vaca de "properties" si no pudiera contactar al dispositivo). La respuesta est compuesta por los siguientes campos:
Propiedad !anu"acturer !odel Descripcin MEDITERRANEA ST Vault- !!

Los siguientes son ejemplos de RESQUEST /RESPONSE de "capability":

*************** REQUEST ******************* <?xml version="1.0" encoding="UT*- "?# <c%,%.ili$-'# *************** RES(O)SE ****************** <?xml version="1.0" encoding="UT*- "?# <c%,%.ili$-# <res&l$# <code#0<'code# <mess%ge#o+<'mess%ge# <'res&l$# <,ro,er$ies# <,ro,er$-# <n%me#2%n&1%c$&rer<'n%me# <v%l&e $-,e="s$ring"#3%s43ode<'v%l&e# <',ro,er$-# <,ro,er$-# <n%me#2odel<'n%me# <v%l&e $-,e="s$ring"#ST 5%&l$-600<'v%l&e# <',ro,er$-# <',ro,er$ies# <'c%,%.ili$-#

V1.04

Versin: Este mtodo no recibe parmetros y devuelve: Una lista de propiedades que identifican la versin de software del servicio. Una lista de los tags soportados por el servicio (como mnimo, la lista debe contener: "version", "capability", "status", que son los comandos bsicos requeridos por la arquitectura). Este comando no puede generar errores. Las propiedades que debe informar son: versin, date, company, www, build y type. La respuesta est compuesta por los siguientes campos:

Propiedad #ersion Date compan$ %%% &uild T$pe Ta s

Descripcin Versin Driver "ec#a Mediterrnea S$A$ Direccin %eb &as#&ode Vault !! 'ac()oad ST RS*+* 'I)) A&&E,T-R &o.andos ,osibles a ejecutar

Los siguientes son ejemplos de request/response de "version":

*************** REQUEST ******************* <?xml version="1.0" encoding="ISO- !"-1"?# <version'# *************** RES(O)SE ****************** <?xml version="1.0" encoding="UT*- "?# <version# <res&l$# <code#0<'code# <mess%ge#o+<'mess%ge# <'res&l$# <,ro,er$ies# <,ro,er$-# <n%me#version<'n%me# <v%l&e $-,e="s$ring"#1.06<'v%l&e# <',ro,er$-# <,ro,er$-# <n%me#d%$e<'n%me# <v%l&e $-,e="d%$e"#70110 76<'v%l&e# <',ro,er$-# <,ro,er$-# <n%me#com,%n-<'n%me# <v%l&e $-,e="s$ring"#2edi$err%ne% S.8.<'v%l&e# <',ro,er$-# <,ro,er$-# <n%me#999<'n%me# <v%l&e $-,e="s$ring"#4$$,:''999.medi$err%ne%-s%.com.%r'<'v%l&e# <',ro,er$-# <,ro,er$-# <n%me#.&ild<'n%me# <v%l&e $-,e="s$ring"#3%s43ode 5%&l$ 600 0%c+;o%d ST RS7<7<'v%l&e# <',ro,er$-# <,ro,er$-# <n%me#$-,e<'n%me# <v%l&e $-,e="s$ring"#0I;; 833E(TOR<'v%l&e# <',ro,er$-# <',ro,er$ies# <$%gs# <$%g#version<'$%g# <$%g#c%,%.ili$-<'$%g# <$%g#s$%$&s<'$%g# <$%g#en%.le=.ill<'$%g# <$%g#4old=.ill<'$%g# <$%g#s$ore=.ill<'$%g# <'$%gs#

V1.04

<'version#

V1.04

Store_Bill: Este mtodo habilita el Billetero para la recepcin y almacenamiento de un billete. Al finalizar la ejecucin se retorna un cdigo de terminacin de la operacin o un cdigo de error (ver tabla de cdigos de errores). Se requiere la especificacin de los siguientes parmetros:
Propiedad TimeOut Descripcin Tie.po de espera de ejecucin .edido en se/undos$ Si no se especi0ica este par.etro se utili1ar un valor de 23 se/undos$ Si supera los 4! se/undos5 se utili1ar un valor de 4! se/undos$

La respuesta est compuesta por los siguientes campos:

Propiedad bill Descripcin N6.ero del 'illete al.acenado$

Los siguientes son ejemplos de request/response de "store_bill":

*************** <?xml version="1.0" encoding="ISO- !"-1"?# <s$ore=.ill# <$ime=o&$#10<'$ime=o&$# <'s$ore=.ill# *************** <?xml version="1.0" encoding="UT*- "?# <s$ore=.ill# <.ill#70<'.ill# <res&l$# <code#0<'code# <mess%ge#o+<'mess%ge# <'res&l$# <'s$ore=.ill# REQUEST *******************

RES(O)SE

******************

Enable_Bill: Este mtodo habilita el Billetero para la recepcin de un billete. Al ingresar el billete se valida y se detecta quedando en espera por al menos 3 segundos en estado de Escrow. En esta espera se debe ejecutar el comando Hold_Bill indicando si se desea retornar o almacenar el respectivo billete. De no recibir el comando Hold_Bill dentro del time out de hardware, el dispositivo retorna automticamente el billete contenido. El time out de hardware es de 3 segundos pero puede estirarse hasta 10 segundos si se mantiene ejecutando el comando Status. Al finalizar la ejecucin se retorna un cdigo de terminacin de la operacin o un cdigo de error (ver tabla de cdigos de errores). En el caso de xito se retorna el valor del billete detectado. Se requiere la especificacin de los siguientes parmetros:
Propiedad TimeOut Descripcin Tie.po de espera de ejecucin .edido en se/undos$ Si no se especi0ica este par.etro se utili1ar un valor de 23 se/undos$ Si supera los 4! se/undos5 se utili1ar un valor de 4!

V1.04

se/undos$

La respuesta est compuesta por los siguientes campos:

Propiedad bill Descripcin N6.ero del 'illete detectado$

Los siguientes son ejemplos de request/response de "enable_bill":

*************** <?xml version="1.0" encoding="ISO- !"-1"?# < en%.le=.ill# <$ime=o&$#10<'$ime=o&$# <'en%.le=.ill# *************** <?xml version="1.0" encoding="UT*- "?# < en%.le=.ill# <.ill#70<'.ill# <res&l$# <code#0<'code# <mess%ge#o+<'mess%ge# <'res&l$# <'en%.le=.ill# REQUEST *******************

RES(O)SE

******************

Hold_Bill: Este mtodo indica al Billetero que almacene o retorne el billete detectado. Al finalizar la ejecucin se retorna un cdigo de terminacin de la operacin o un cdigo de error (ver tabla de cdigos de errores). Se requiere la especificacin de los siguientes parmetros:
Propiedad 'old Descripcin Indica si debe al.acenarse 7true8 o si debe retornarse 70alse8 el billete contenido$

Los siguientes son ejemplos de request/response de "hold_bill":

*************** <?xml version="1.0" encoding="ISO- !"-1"?# <4old=.ill# <4old#1%lse<'4old# <'4old=.ill# *************** <?xml version="1.0" encoding="UT*- "?# <4old=.ill# <res&l$# <code#0<'code# <mess%ge#o+<'mess%ge# <'res&l$# <'4old=.ill# REQUEST *******************

RES(O)SE

******************

V1.04

10

OPCIONES DE CONFIGURACION
Parmetros de Ejecucin
sv6illetero2ault78997prod.exe /C!D :;ipaddress<0;port<= :;C*!>06aud7rate/Parit1/"en-.t/&top76it<= :;,ill7denomination<=

/C!D0
o

o o o o

/INSTALL0 Instala el Driver como servicio del Sistema Operativo, esperando una conexin en la direccin <ipaddress puerto T!" <port # mane$ando el dispositivo por el puerto %S&'& <com ( /START0 )rranca el servicio( /STOP0 Detiene el servicio( /DELETE0 Desinstala el servicio *%e+uiere ,a-er detenido el servicio previamente.( /RUN0 /$ecuta el servicio en modo consola, para de-u0( De-e estar detenido el servicio( %eci-e los mismos par1metros +ue 2I3ST)LL(

Parmetros0 &on sensi,les al orden de prioridad de su definici3n. &e de,e respetar el orden.
o

o o

[<ipaddress>:<port>]0 direccin <ipaddress # puerto T!" <port +ue de4inen la conexin con aplicacin cliente( /$5 local,ost5&0006, 75&0006 *a-ierto para todas las direcciones I".( De4ault575&0004 [<COM#: a!d"rate#Parit$#Le%&'t#Stop" it>]0 puerto %S&'& de comunicacin con dispositivo con sus parametros( De4ault5 !O8659:00,/,;,6 [<(i))"de%o*i%atio%>]0 denominacin de tipos de -illetes validos a reci-ir en dispositivo( La denominacin de-e presentarse de ma#or a menor con <=> separando cada denominacin( De4ault5 600=?0=&0=60=?=&

E+e*p)o de !so: ?(0< sv6illetero2ault78997prod.exe /I+&T4"" local.ost0@999? C*!?0AB99/E/C/? @(0< sv6illetero2ault78997prod.exe /&T4#T D(0< sv6illetero2ault78997prod.exe /&T*P 8(0< sv6illetero2ault78997prod.exe /DE"ETE Nota: sv6illetero2ault78997lo-.exe (Eenera un arc.ivo lo- para el developer.

V1.04

11

ANEXO
Tabla de errores Estado
Enable (Idling) Accepting Escrow Staking Vend Valid Stacked e!ecting et#rning Holding &isable (In'ibit) Initiali(e *ower +p Stat#s *ower +p *ower +p -it' )ill In Acceptor *ower +p -it' )ill In Stacker Error Stat#s Stacker .#ll Stacker /pen 0a1 In Acceptor 0a1 In Stacker *a#se 2'eated .ail#re 2o11#nication Error

Codigo de Error
11H 12H 13H 14H 15H 16H 1"H 1$H 1%H 1AH 1)H 4,H 41H 42H 43H 44H 45H 46H 4"H 4$H 4%H 4AH

V1.04

12