SDK for APS Master Interface
Contents
1. User s Manual 4 1 3 Com Acceptor Settings Coin Acceptor Settings are used to enable disable the use of a Coin Acceptor and also to specify the type of coins to be used Please note that unlike the Bill Validator in the Coin Acceptor is not possible to assign the value to each type of coin This information 1s already programmed in the Coin Acceptor and will be communicated to the APSMI Engine once the equipment is activated and has established communication with the APS Master Interface FI APS Master Interface Engine V5 0 0 Coin Acceptor Settings Coin Types Enabled Disabled Change Management 09 N A W Enable Change NA B TT NA N HIT IT MA Tube Coin Type 1 HN Hi MA Tube Coin Type 2 m3 Ir MA Tube Coin Type 3 Hl4 7 NA Tube Coin Type 4 15 Fr NA Tube Coin Type E ne HM HIE HA Total Amount in Tubes NA W Com Acceptor Enabled 401 x R M _ Changer Feature Lewel 402 x Country Currency Code 403 x Coin Scaling Factor 404 Decimal Places 405 NZA M NA NA x Manufacturer Code E Serial Number Model Humber M E E T Save Cancel To enable disable the use of a coin just click on the checkbox next to the Coin Type number From Version 3 0 of the APSMI Engine Console until the latest versions is possible to get the actual value of the coins programmed in the Coin Acceptor also 1s possible to know the exact quantity2. 0 lw Bil Malidator Enabled H T Ww Bill alidator Feature Level fy A Manufacturer Code fy teh HOZ w Bill Scaling Factor Serial Number N HOA yw Decimal Places Model Number M HOG e ma F J o Hal oo Stacker Capacity HOE 0 145 D Bill Security Levels HOY D HE TT Escrow Capability HUB 0 HIB D 20 50 County Currency Code NA Soltware Version NA 03 fe 100 11 T7 oo 200 500 Save Cancel MDB protocol requires Bill Validators to send the Bill Type inserted by the user when the equipment is operating There are 16 different types of bill supported by the MDB protocol The Bill Type is a number from 1 to 16 Each Bill Validator manufacturer has different assignments for the value of the Bill Type This setting must be updated manually once you have the right value for each type of bill Default values for the Bill Validator Settings were defined using an ICT Bill Validator where the Bill Type number 01 is not used number 02 is 20 pesos etc Bill Type from number 06 to number 16 are not used in this type of Bill Validator You can disable the use of a Bill Type by clicking in the checkbox next to 1t Don t forget to click Save if you want to keep your changes All the fields showing a N A value will be updated automatically once the Bill Validator is activated an has established the communication with the APS Master Interface APS Master Interface
3. Cancel SaveSetting APS Status Exit display Caption Format 0 eurrency status Caption due Caption DUE AMOUNT Format 0 currency End Sub SaveSetting 1s the Visual Basic Function used to write into the Regedit variables As we explained before these variables are being monitored by the APS Master Interface Engine application that 1s running in the background 4 4 2 Sub Form Terminate The Sub Form Terminate will request to stop the APS Master Interface Engine application by Saving the value 1 into the Exit Regedit variable Private Sub Form Terminate Savesetting APFS Status Exit i End Sub APS Master Interface User s Manual 4 4 3 Sub Form Pay Click The Sub Form Pay Click is the action attached to the Pay CommandButton from the Main frm When the button is clicked the application will check the current legend on the button based in this information will decide 1f the application should start the payment process or cancel it The payment process starts by setting the Due Regedit variable to a value greater than 0 At this moment the APS Master Interface Engine will activate the Bill Validator and or Coin Acceptor according to the parameters setup If you want to process they payment using a Credit Card then you will need to save the value in the DueCC veriable In order to monitor the p
4. Project1 Main Form amp File Edit view Project Format Debug Run Query Diagram Tools Add Ins Window Help gt E 3 E DD Project Project1 x Ga Projecti SDK_APS_Master_Inte 23 Forms El Main Main frm A Properties Main Main 1 3D False B enoos040408 1 Fixed Single SDK APS Master Interf True Name Returns the name used in code to identify an object Form Layout 4 3 1 Main Form elements due The Main Form has several labels that are used to display the current status of the payment process The due Label is used to display the amount to be paid by the customer when the customer clicks on the Cash button This is a fix value that won t change during the payment 4 3 2 Main Form elements display The display Label is used to show the amount of money introduced into the Bill Validator and or Coin Acceptor during the payment process This value is not fix and will change every time a coin or bill is inserted APS Master Interface User s Manual 4 3 3 Main Form elements status The status Label 1s used to show the current step on the payment process after the Pay Button is pressed The APS Master Interface Engine will report 4 possible conditions Insert Coins or Bills Payment Completed Transaction Cancelled Dispensing change 4 3 3 1 Insert Coins or Bills Insert Coins or Bills status
5. mj JLL a For Visual Eas APS_Master_Interface_Engine_V5 0 0 folder and Microsoft Corporation double click on 1t Follow the instructions from the install wizard until the application 1s fully installed 2 Find the APS Master Interface Engine V5 0 0 in the Start Menu and click on it fn APS Master Interface Engine V3 0 EE APS Master Interface Engine 3 0 SLAPS Software Not Registered 3 You will receive a warning message indicating that your copy of the software is not registered yet APS Software Not Registered Serial Number 5686 3535 5596 0775 8476 8484 Company Name The APSMI Engine software will generate an Walidation Key unique Serial Number for your computer APS Master Interface User s Manual Validation Key Mensaje Texto enriquecido oll 4 Send an email to APS requesting Archivo Edici n Ver Insertar Formato Herramientas Acciones Gener B attach as Adobe POF gt arai Jo TATa z as ET your Validation Key email address A can be found in chapter 1 3 qe sal A Asunto Validation Key C D22 GH Company Name Your Company Name Write the name of your Company Serial Number 5686 3535 5596 0775 8476 8484 Copy and paste the Serial Number into the body of your message RE Validation Key Mensaje Texto enriquecido N You will receive an email back Archivo Edici n Ver Insertar Formato Herramientas Acciones enver El Attach as
6. Bill Dispenser Refill Bill Dispenser Status Dispense Bills Bill Type Save Cancel If you want to dispense change using Bills go to the Bill Dispenser tab and click on the Bill Dispenser Enabled checkbox under the Bill Dispenser Settings section 1f there everything 1s working correctly all the fields with N A values will be updated By default the APS Master Interface Engine will set the Bill Type to 50 you can always change this value to any of the options available in the menu Please note that the Bill Dispenser is not able to identify the type of bill you are using so it will dispense the notes considering the value you selected here You can test the Bill Dispenser typing the quantity of bills you will like to dispense in the Quantity of Bills to Dispense field under the Bill Dispenser Functions section Then click on the Dispense Bills and the equipment will be activated to dispense the quantity selected and report the actual quantity dispensed in the Quantity of Bills Dispensed field If the Bill Dispenser is empty it will update the Bill Dispenser Status to NOK value Once you have loaded the Bill Dispenser you must to click Bill Dispenser Refill to override the status APS Master Interface User s Manual 4 1 6 Hoppers Settings Hoppers Settings are used to enable disable and test up to two Coin Hoppers In order to use these devic
7. Adobe POF EE from APS with your Validation Key Para yourname yourcomany com nul ber ES Asunto JRE Validation Key Validation Key 9419235 Mensaje original De Your Name retin voumname your omany com Saturday April 11 2009 14 techsupport apsmx com Validation Key Company Name Your Company Name Serial Number 5686 3535 5596 0775 8476 8484 APS Software Not Registered 3 6 Once you get the Validation Key you will need to open the APSMI Engine again once you get to the ees APS Software Not Registered screen write your 5686 3535 5595 0775 0476 6484 Company Name and Validation Key in the Company Name APS Automatic Payment Systems lt 4 1 Cc TTTTT appropriate text boxes Validation Key cu o ced swe Click the Save button The screen will be closed 7 In the next chapters you will learn that there are two a methods of opening the APSMI Engine One is by double ARI clicking in the exe file and the second is calling it directly IN from the Command prompt used to run the application in the background Regardless of the method you use 1f you Registered your DD reee uaa software correctly you will see this screen every time you run the APSMI Engine application APS Master Interface User s Manual 3 4 Connecting the Bill Validator and or Coin Acceptor Once you have installed your APS Master Interface Engine software and registered 1t you are ready
8. If you use the value 1 the system will cancel the transaction and dispense the current Credit amount 4 5 6 Coin Tubes Quantity update after each transaction The Coin Tubes amount is updated after each transaction in the Tubes variable under the Status section However this value is updated individually for each coin type in their assigned tubes also You can check what is the quantity of coins per tube in the tubeCoinQtyX variable under the ComAcceptor section of the registry variables The type of coin is recorded under the tubeCoinTypeX under the same section 4 5 7 Coin Acceptor and Bill Validator Error handling at Runtime In case of any communication errors during Runtime between the APS Master Interface software and the Coin Acceptor or Bill Validator the systems will retry 3 times to recover it from the error 1f the communication is not possible the system will report the error using the Status variable under the Status section with the values Error Coin Acceptor or Error Bill Validator 4 5 8 Setup Reference ID for Credit Card Transactions If you want to process a payment using a Credit Card you will need to write the amount to charge in the DueCC Regedit variable under the Status section Every Credit Card transaction must have a Reference ID for further reference in case of any dispute You can create any reference number selection Customer Account Nu
9. Incluir esta ubicaci n en la b squeda WAPS_Master_Interface_Driver No buscar Seleccionar el controlador que se va a instalar Mediante esta opci n podr seleccionar de una lista el controlador del dispositivo Windows no puede garantizar que el controlador que elija sea el m s apropiado para su hardware Asistente para hardware nuevo encontrado Espere mientras el asistente est buscando APS Master Interface Asistente para hardware nuevo encontrado Seleccione de la siguiente lista el hardware que mejor se ajuste al suyo SS Y Dad APS Master Interface Desconocido APS c windows inf oem 32 inf A Este controlador no est firmado digitalmente Por qu la firma de controladores es importante APS Master Interface User s Manual 3 The wizard will show the name of the APS Master Interface and ask 1f you have the installation files Select the Install from a list or specific location Advanced option Click the Next gt button 4 The wizard will ask you to choose your search and installation options Select Search for the best drivers in this locations and disable Search removable media floppy CD ROM Select Include this location in the search then click the Browse button to find the folder APS Master Interface Driver V3 5 The wizard will search for the APS Master Interface drivers in the selected folder 6 If the destination folder was selected co
10. the APS Master Interface to your computer using an USB Cable Note At this stage 1t 1s not necessary to connect the MDB Master Cable to your Bill Validator and or Coin Acceptor The APS Master Interface hardware is powered up directly from the USB port so it is not necessary to connect the power supply neither 2 Windows XP or Windows 7 will detect your new hardware and start the Found New Hardware Wizard Select the No not this time option Click the Next gt button Note If Windows 7 installs the driver automatically you will need to reinstall it later using the Device Manager on the Control Panel Menu Asistente para hardware nuevo encontrado Este asistente le ayudar a instalar software para APS Master Interface Si su hardware viene con un CD o disquete de QE instalaci n ins rtelo ahora Qu desea que haga el asistente O Instalar autom ticamente el software recomendado instalar desde una lista o ubicaci n espec fica avanzado Haga clic en Siguiente para continuar Asistente para hardware nuevo encontrado Bija sus opciones de b squeda e instalaci n a Y Buscar el controlador m s adecuado en estas ubicaciones Use las siguientes casillas de verificaci n para limitar o expandir la b squeda predeterminada la cual incluye rutas locales y medios extra bles Se instalar el mejor controlador que se encuentre C Buscar en medios extra bles disquete CD ROM
11. to connect the Bill Validator and or Coin Acceptor to you APS Master Interface As we mentioned before the APSMI will get the power from the USB connection You will need a Power Supply for the Bill Validator and or Coin Acceptor Power requirements change between different brands usually a 24V to 36V 4A power supply should work with your MDB devices Please follow the picture bellow as a guide to connect your equipments to the APSMI You can use a stand alone Coin Acceptor or Bill Validator In case you want to use both equipments first you must connect your Bill Validator to the MDB Master Cable and then use the built in cable to connect your Coin Acceptor as it is shown in the picture bellow BILL VALIDATOR COIN ACCEPTOR MDB MASTER CABLE CABLE TO 24V 5A POWER SUPPLY APS MASTER INTERFACE zi COIN ACCEPTOR MDB CABLE BILL VALIDATOR USB CABLE MDB CABLE CONNECTED TO COMPUTER Some equipment have to be configured to support the MDB protocol Please make sure your equipment meet this requirement before connecting it to the APSMI If your equipment is already included in the list of equipment tested by APS Chapter 2 5 and you need additional information on how to set 1t up please feel free to contact us to support you on this task APS Master Interface User s Manual 3 4 1 MEI Cashflow7000 Coin Acceptor Error Message After power connection of the MEI Cashflow7000 Coin Acceptor you will notice an error messa
12. will be displayed after the Pay Button is pressed If the setup is properly configured in this step the Bill Acceptor and or Coin Validator should be active and ready to receive Bills and or Coins 4 3 3 2 Payment Completed Payment Completed status is used to indicate that the user has completed the payment process At this step the due and credit amounts have the same monetary value 4 3 3 3 Transaction Cancelled After they Cash Button is pressed to start the payment process it will change the text displayed in the Button from Cash to Cancel If the Cancel button is pressed it will stop the payment process and the status Label will display the Transaction Cancelled legend If the APS Master Interface is setup to dispense change the application will return the credit amount using coins only 4 3 3 4 Dispensing change Dispensing change status 1s used to indicate that the Coin Acceptor is returning coins to the client Dispensing change process time can vary depending on the amount to be returned APS Master Interface User s Manual 4 4 SDK APS Master Interface Visual Basic Code As we explained in the previous section the SDK APS Master Interface sample application has one form called Main frm In this section we will explain the 4 Subroutines used to communicate the application with the APS Master Interface Engine Option Explicit Private Sub F
13. ARE The APS Master Interface Engine software has two operating modes APS Master Interface Engine Console Used to setup parameters debug your application and test Bill Validator and or Coin Acceptor and the APS Master Interface Engine Hide Used to control the Bill Validator and or Coin Acceptor while your application 1s running In this mode the APSMI Engine will be running in the background and won t be visible to the user 4 1 APS Master Interface Engine Console Before starting the APS Master Interface Engine Console make sure your APS Master Interface Bill Validator and or Coin Acceptor are connected and powered To start the APSMI Engine Console you just need to double click on the file APS Master Interface Engine exe or open it directly from Start Menu and you will see the following screen RI APS Master Interface Engine V5 0 0 Pay Cash Credit Card Save Cancel The APSMI Engine Console is divided into seven sections Test Console General Settings Coin Acceptor Bill Validator Bill Dispensers Hoppers and Credit Card In the following chapters we will describe in detail every single one APS Master Interface User s Manual 4 1 1 General Settings The APSMI Engine V5 0 0 General Settings tab includes the MDB devices port the Bill Dispenser port and the Hoppers Interface port Both MDB and Hoppers Interface ports are USB while the Bill Dispenser port is a RS232 FI APS Master Interface Engine V5 0 0
14. Interface User s Manual Windows Registry can be accessed manually using the Regedit utility from Windows XP or Windows 7 Ejecutar al Escriba el nombre del programa carpeta documento o recurso de Internet que desea que Windows abra Cancelar Examinar Once the Windows Registry editor is open you can find the APSMI Engine Console parameters under the HKEY CURRENT USER directory in My Computer My Computer HKEY CURRENT USER Software VB and VBA Program Settings APS Note The user name can be different from one computer to another you can also search for the right path using the Search menu option typing VB and VBA Program Settings as the searched item APSMI Engine Console uses nine Windows Registry categories to storage all the parameters and variables to communicate with your applications BillDispenser Bill Validator CoinAcceptor Hoppers License Monitoring Pin Pad Settings and Status m Registry Editor File Edit wiew Favorites Help Mame BillDispenser ab iD efault Billvalidator Coin cceptor Hoppers License Monitoring Pin Pad Settings Status My Computer HEEY CURRENT USER Software VB and B Program Settings4P5 APS Master Interface User s Manual 4 2 2 License Windows Registry License Windows Registry is used to record the values used by the APSMI Engine Console validation software to authenticate the license number registered by the customer As this value can be changed man
15. MOB Interface Configuration Bill Dispenser Configuration Hoppers Interface Configuration COM Port 10 COM Port j COM Pork 11 Save Cancel If you don t know what COM Port has been assigned to the APS Master Interface follow the steps on Section 3 2 2 Checking the correct installation ofthe APS Master Interface If you select a wrong Port or the APS Master Interface 1s not connected properly to that Port you will receive an Port Error message asking you to select another Port The Error message will disappear when you have selected the correct Port and the communication is established between your computer and the APS Master Interface If you have a computer that doesn t meet the specification described in chapter 2 4 please contact us to help you to define the best parameters for your system Please note that not all the systems will work with the APSMI If you make changes to the General Settings you need to press the Save button so they are available next time you run the APSMI Engine Console APS Master Interface User s Manual 4 1 2 Bill Validator Settings Bill Validator Settings are used to enable disable the use of a Bill Validator and also to specify the value of a bill assigned to each type Click on the Bill Validator Enabled checkbox to activate deactivate the Bill Validator FI APS Master Interface Engine V5 0 0 Bill Validator Settings Bill Types Enabled Disabled Ros r 0 u r
16. Model Cashflow 690 691 Model GLOBAL MXPF703 Protocol MDB Protocol MDB Protocol MDB Bill Validator Bill Validator Bill Validator Brand CashCode Brand ICT Brand CashCode Model Backload Validator Model TAO V MXP4 Model Currenza Protocol MDB Protocol MDB Protocol MDB If you have a different equipment not listed in this table please feel free to contact our Technical Support Staff to get the latest information on tested equipment Use contact information provided in Section 1 3 of this Manual APS Master Interface User s Manual 2 6 Hardware Compatibility for Bill Dispensing The APS Master Interface allows the connection of one Bill Dispenser to provide change to the users The Bill Dispenser is connected directly to the RS232 port in the PC Bill Dispenser Dispensers OE Brand Fujitsu Model F50 Protocol RS232 2 7 Hardware Compatibility for Coin Hoppers The APS Master Interface Software allows the control of two Coin Hoppers to provide change to the users The connection requires an additional USB port in the PC and additional hardware APS Hoppers Interface Coin Hopper Brand AZKOYEN Model U II Protocol Parallel APS Master Interface User s Manual 2 8 Hardware Compatibility for Credit Card Processing The APS Master Interface Software allows the Credit Card Processing using EMV L1 and L2 Devices We have developed our software and certified the following devices POS Credit Card Pin Pa
17. SDK for APS Master Interface Version 5 0 0 User Manual APS Automatic Payment Systems January 2015 ADS ea a master Gy terface Revision Sheet Release No Date Revision Description Feb 3rd 2009 Initial Release March 9 2011 April 17 2012 January 5 2015 September 25 2014 APS Master Interface User s Manual APS Master Interface Version 3 0 1s released with new features drivers and software interface Picture for Power Supply connection added Picture for Error Message in Coin Acceptor added Note added for 64 bit Operative Systems Currenza Bill Validator picture added Major document update from APS Master Interface Version 4 3 3 is released including Bill Dispenser and Hoppers Control New driver released to support Windows 7 Professional Operative System New APS Master Interface Version 5 0 0 Turn Key Solution for Credit Card processing using EMV Ll and L2 certificated devices 1 0 GENERAL INFORMATION 1 1 System Overview The APS Master Interface is a Multi Protocol software that allows the connection of a Bill Validator Coin Acceptor Bill Dispeser and Coin Hoppers using the standard MDB Vending Protocol to a PC running Microsoft Windows XP or Windows 7 Professional The APS Master Interface is connected to one of the USB ports in the PC The latest version of the ASP Master Interface also integrates a Turnkey Solution for Credit Card processing using EMV L1 an
18. Then Timerl Enabled False Pay Caption Pay End IE End Sub APS Master Interface User s Manual 4 5 Additional Functions In addition to the basic functions mentioned in the previous chapter there are additional functions included in the APS Master Interface that can be used to increase the control of the cash transactions and payment processes 4 5 1 Disable and enable bills at Runtime As you already now you can manually setup the bills that you want to use during the payment process You can also perform this task during runtime before you set the amount to be paid Set the BillTypeX Enabled value to 1 under the Bill Validator registry values to allow the use of that bill type use the value 0 to disable it Then save the amount to be paid in due 4 5 2 Change Dispensed after a cash transaction After each transaction you can always check the value of the CashDispensed variable under the Status registry variables This variable returns the actual amount dispensed in change considering the coins dispensed by the Coin Acceptor Coin Hoppers and Bill Dispenser This function is updated in both manual and automatic change dispensing 4 5 3 Manual Change Dispensing While the APS Master Interfase software is an idle state you can manually dispense change by writing the amount of money in the Change variable under the Status registry variables The system will use the enabled equ
19. at will be used to setup the parameters and also is used to run in the background to communicate with your application and control the functions of the Bill Validator and or Com Acceptor The installation files are distributed in the APS Master Interface Engine V5 0 0 folder where you will find the following files Details on how to install the APS Master Interface Engine will be described in the next chapters Mombre Tama o Tipo Fecha de modificaci n a APS Master Interface Engine CAB 2 098 KB Archivo contenedor 3 9 2011 9 40 PM BEJ setup exe 138KB Aplicaci n 6 18 1998 2 00 AM E SETUP LST SKB Archivo LST 3 9 2011 9 40 PM APS Master Interface User s Manual 3 1 3 SDK APS Master Interface V5 0 0 Folder The SDK for APS Master Interface 1s distributed in a folder containing a sample application that will help you to develop your own applications SDK APS Master Interface _V5 0 0 Folder where you will find the following files Mombre Ta Tipo Fecha de modificaci n BB APS Master_Interface Engine exe 216KB Aplicaci n 3 2 2011 6 26 PM E Main fem 6 KE Visual Basic Form File 3 9 2011 9 48 PM SDK APS Master_Interface exe 24 KE Aplicaci n 3 9 2011 9 48 PM di SOK_APS Master Interface vbp 1KB Visual Basic Project 3 9 2011 9 48 PM 3 1 3 1 APS Master Interface Engine exe As mentioned before the APS Master Inteface Engine exe is the main application that controls all the functions of the Bill Validator Coin Acceptor Bill Di
20. ayment process and know when the process is completed we use a Timer control In this case our Timer1 control is setup to cycle every 5ms once it is enabled Private Sub Pay Clieck If Pay Caption Pay Then SaveSetting APS Status Due Val amountToPay Text Timerl Enabled True Pay Caption Cancel Else Pay Caption Pay SaveSetting APS Status Cancel 1 display Caption Format 0 currency status Caption due Caption DUE AMOUNT amp Format 0 currency Timerl Enabled False End If End Sub To notify to the APS Master Interface Engine that the payment process should Stop it is necessary to setup the Cancel Regedit variable to 1 If the dispense change parameter is setup the current credit amount will be returned to the client 4 4 4 Sub Timerl Timer The Sub Timerl Timer will be running in cycles every 5ms to monitor the status of the credit due and status Regedit variables The information will be displayed in the Main frm Text Labels Once the due amount is equal or less than 0 the cycle stops Private Sub Timer Timer display Caption Format Val GetSetting APS Status credit currency due Caption DUE AMOUNT amp Format Val GetSetting APS Status due gt currency statiis Caption GetSetting APS Status Status If Val GetSetting APS Status due lt 0
21. d L2 devices A Multidrop Bus MDB is a computer bus in which all components are connected to the same set of electrical wires A process of arbitration determines which device gets the right to be the sender of information at any point in time The other devices must listen for the data that 1s intended to be received by them Multidrop Buses are used by Vending Machine controllers to communicate with the vending machine s components The APS Master Interface opens the doors for a wide range of customized applications using a simple PC to control all the machine s components The Software Development Kit SDK for the APS Master Interface includes all the drivers required to operate the equipment and also a Visual Basic sample code to speed up the learning process on creating new applications with this system 1 2 Authorized Use Permission Usage of the APS Master Interface software is limited to its owner via the APS Terms and Conditions 26 08 2004 1 3 Points of Contact For additional information APS Team can be contacted through our technical support email at techsupport apsmx com 1 4 Acronyms and Abbreviations MDB Multidrop Bus SDK Software Development Kit APS Automatic Payment Systems APSMI APS Master Interface APS Master Interface User s Manual 2 0 SYSTEM SUMMARY 2 1 Hardware Configuration The APS Master Interface APSMI is configured to be connected to one available USB port in a PC Running Windo
22. d Unattended Card Reader and Pin Pad Brand Verifone Brand Ingenico Model VX820 Model Self Protocol USB Protocol USB APS Master Interface User s Manual 3 0 GETTING STARTED 3 1 Installation Files and Folders 3 1 1 1 APS Master Interface Driver V3 0 Folder for Windows XP The APS Master Interface hardware requires USB drivers to work with your computer those files are distributed in the APS Master Interface Driver _V3 0 folder containing 2 files that you will need once the Interface is connected for the first time to your computer s USB port Details on how to install the Interface will be described in the next chapters Mombre To Tipo Fecha de modificaci n Edl APS cat SKB Catalogo de seguridad 1 4 2008 9 39 4M APS MI Y3 inf 4KEB Informacion sobre la instalaci n 3 11 2011 7 55 PM 3 1 1 2 APS Master Interface Driver Windows7 Folder for Windows 7 The APS Master Interface hardware requires USB drivers to work with your computer those files are distributed in the APS Master Interface Driver Windows folder containing 2 files that you will need once the Interface is connected for the first time to your computer s USB port Details on how to install the Interface will be described in the next chapters Sa Type Date Modified SKB Security Catalog 14 11 08 4 18 PM 4 KB Setup Information 19 05 14 8 09 AM 3 1 2 APS Master Interface Engine V5 0 0 Folder The APS Master Interface Engine is the main application th
23. d in Section 1 3 of this Manual 2 4 System Requirements Before you install your APS Master Interface Engine software please make sure your computer meets the following minimal system requirements Microsoft R Windows XP R Professional with SP2 or Windows 7 Professional 32bits Intel R Pentium R Processor 1 73 GHZ 1 LAN Network Port 1 Universal Serial Bus for MDB devices USB 2 0 1 Universal Serial Bus for Coin Hopper Optional 1 Universal Serial Bus for Credit Card Pin Pad Optional 1 RS232 Port for Bill Dispenser Optional Note The APS Master Interface Engine doesn t support 64bit Operative Systems APS Master Interface User s Manual 2 5 Hardware and Software Compatibility for MDB Devices As we continue looking to increase the amount of Bill Validators and Change Acceptors tested with our APS Master Interface we can say that most of the MDB protocol devices are compatible with our equipment with minor adjustments With the development of the APS Master Interface Engine now you are able to configure each Brand and Model according to the factory settings preloaded in every equipment If for any reason you need to change the Brand of the equipment used you can easily do it using the APSMI Engine Console to update your settings Here 1s the list of Coin Acceptors and Bill Validators successfully tested by APS Change Acceptor Change Acceptor Change Acceptor Brand MEI Brand MEI Brand COINCO Model Cashflow 7000
24. dores de pantalla gal Visor de sucesos B Adaptadores de red Carpetas compartidas a Adaptadores PCMCIA 2 Usuarios locales y grupos Y Bater as a Registros y alertas de rendir Controladoras de bus serie universal USB 2 Administrador de dispositivos 39 Controladoras de host de bus IEEE 1394 y Almacenamiento SB Controladoras de host digital sequro Medios de almacenamiento e Controladoras IDE ATA ATAPI Desfragmentador de disco 7 Dispositivo de memoria de PCMCIA y Flash Administraci n de discos yg Dispositivos de interfaz de usuario HID Ta Servicios y Aplicaciones Dispositivos de sistema 0 Dispositivos de sonido v deo y juegos 4 Equipo x M dems ig Monitor Mouse y otros dispositivos se aladores my Otros dispositivos Gi Controladora de bus serie universal USB 9 Procesadores Y Puertos COM amp LPT A APS Master Interface 3 0 COM Teclados ape E gt Teclados Propiedades de APS Master Interface V3 0 COM General Configuraci n de puerto Controlador ii Detalles Bits por segundo EHTI w Bits de datos Paridad Bits de parada Control de flujo Opciones avanzadas Restaurar valores predeterminados APS Master Interface User s Manual 1 Using the Control Panel go to the Components Manager then look for the Ports COM amp LPT section If the APS Master Interface was correctly installed you will f
25. due Caption DUE AMOUNT dl amp Format Val GetSetting APS arcs eg OU Ps Rk due u ie ae currency status CapEion Getsetting ArPS Status Status If Val GetSetting APS Status due lt 0 Then Timerl Enabled False Pay Caption Pay End If End Sub APS Master Interface User s Manual 4 4 1 Sub Form Load The Sub Form Load is the first code executed when the application is launched The Shell function is used to start the APS Master Interface Engine exe with the hide parameter set as we described in chapter 4 2 The number 1 parameter of the Shell function is used to stop the execution of next steps until the APS Master Interface Engine exe is loaded Private Sub Form Load Dim InitEngine As Double Open APS Master Interface Engine This Engine will perform all the functions and communication between your computer and the payment systems Bill Validator and or Coin Acceptor If you want to debug your application you can ommit the hide parameter to view the APS Master Interface Engine Console InitEngine Shell APS Master Interface Engine exe hide 1 Reset Regedit variables These variables are used to communicate your application with the APS Master Interface Engine SaveSetting APS Status Due 0 4 SaveSetting APS Status Credit 0 SaveSetting APS Status Status SaveSetting APS Status
26. dules a APS Master Interface Drivers Used to control the APSMI Hardware via USB Port b APS Master Interface Engine Used to control the functions of the APSMI Hardware including the operation of one Bill Validator and or one Coin Acceptor Bill Dispenser two Hoppers and a Credit Card Reader including 1ts Pin Pad The APSMI Engine 1s also the link that communicates those devices with Your Application using Windows Registry variables values Bill Validator And or Coin Acceptor x Data Base Bill Dispenser Used by Hoppers Application Credit Card Pin Pad E APS Master Interface Engine Windows Registry O Settings Status WURA P le alof APS Master lnterface Variables Drivers Windows Registry values are used to store APSMI Engine settings such as General Settings for Bill Validator and Coin Acceptor type of bills to accept value of the type of bills accepted type of coins to accept enable disable delivery of change etc The APSMI Engine must be initialized before the payment procedure starts The APSMI Engine will run in the background waiting for the Application to trigger the payment process A typical Application consist on a software that request the user to provide an account number or a selection of a product then the system connects to a Data Base to get the amount of money that the user will pay using the Bill Validator and or Coin Acceptor and or Credit Card APS Master Interface User s Manual Once the am
27. e lowest one to complete the change At the end of the operation it will report the actual amount dispensed in the Amount Dispensed field under the Hoppers Functions section APS Master Interface User s Manual 4 1 7 Credit Card Settings Credit Card payments processing 1s offered by APS as a Turnkey Solution only If you are interested in processing Credit and Debit Card transactions using VISA Master Card and American Express please contact us via email at ventas apsmx com Once you have completed our setup process you will receive a EMV certified Pin Pad terminal that will be used by the APS Master Interface Engine to process the payments You will also get a User Password and secure URL Those values will be used to fill their fields under the Business Parameters section of the Credit Card Tab EZ APS Master Interface Engine V5 0 0 Test Console General Settings Coin Acceptor Bill Validator Bill Dispenser Hoppers Credit Card Pin Pad Settings Business Parameters Liser lusemame Password password EMW Ful WA URL lhttps paymentgateway com OnLine JJJ Model NAL ee am be a Company MES Branch H Country NA Ml N A Test Pin Pad App Version M N mero de Tarjeta NA COM Pot NA Tarjetahabiente NVA Pin Pad Printer DNAS Mensajes en Pantalla Pin Pad M Yaucher Printer Star FYP1O If all parameters are correct and your account is active the On Line text will cha
28. e to call the APSMI Engine Console from your selected platform Check our SDK for APS Master Interface with a real example using Visual Basic code cs CAWINDOWS system3 7 cmd exe CisArchivos de programasAPS5S_Master_Interface_Engine gt dir El volumen de la unidad C no tiene etiqueta El n mero de serie del volumen es 84C03 AF6B Directorio de C Archivos de programa APS_Master_Interface_Engine E l Pd l ji l BIB 89 31 PM lt DIR gt H3716 26011 69 31 PM lt DIR gt ane 43 82 2411 86 26 PM 221 184 E ER A IA H3716 26011 69 31 PMH 3 464 ST6UNST LOG 2 archivos 225 848 bytes 2 dirs 5 768 404 992 bytes libres Archivos programaAPS _Master_Interface_Engine gt APS_Master_Interface_Engine exe hide 4 2 1 Windows Registry Settings for APSMI Engine Console The Windows Registry is a database which stores settings and options for Microsoft Windows operating systems It contains information and settings for hardware operating system software most non operating system software and per user settings The registry also provides a window into the operation of the kernel exposing runtime information such as performance counters and currently active hardware APSMI Engine Console uses the Windows Registry database to save the application parameters and also to communicate with you application By using this database we are able to support any programming language since the values are available from any platform APS Master
29. es with the APS Master Interface Engine you will need an additional hardware APS Hoppers Interface the one you will connect to an available USB port in the PC Once you have connected the APS Hoppers Inteface to the PC go to the General Settings tab and select the COM Port being used under the Hoppers Interface Configuration section If the connection is not possible it will display an error message asking you to select the right Port Don t forget to click Save to make the changes permanent EZ APS Master Interface Engine V5 0 0 Hoppers Functions Hopper Ho 1 Hopper Ho 2 W Hoppers Enabled Amount to Dispense Amount Dispensed 0 Coin value i Coin alue 10 Dispense Coins If you want the APS Master Interface Engine to use the Coins Hoppers to dispense change first you need to check the Hoppers Enabled checkbox under the Hoppers Functions section then you need to select the Coin Value that you will be using under the Hopper No X sections If for any reason you want to disable an individual hopper but still using the other you can do it by selecting a Coin Value of 0 To test the configuration you can type the amount of money to dispense in the Amount to Dispense field under the Hoppers Functions section and then click Dispense Coins The APS Master Interface Engine algorithm will try to dispense the higher coin value and then use th
30. ge Revisar maq Err de comunicaci n in the display This error message is completely normal and doesn t affects the functionality of the system In a regular Vending Machine environment the main controller is constantly communicating the Coin Acceptor to receive coins at any time so the device is always available to receive coins If the equipment is disconnected or stops receiving polls from the main controller the equipment shows the indicated error message once the communication is establish again the message disappears Working with the APS Master Interface environment is different there is not communication or polling between the software and the Coin Acceptor while there are not any operation in progress When there is a need to charge an amount the Coin Acceptor will be activated and then the error message will disappear while the payment is in progress Once the transaction 1s done the error message will appear once again APS Master Interface User s Manual 3 4 2 APS Master Interface Power Supply Wires Connection The APS Master Interface integration kit includes a 24V power supply to connect the Bill Validator and Coin Acceptor The following pictures shows how to correctly connect them Reference for B amp W printing White Cable gt gt L Black Cable gt gt N Green Cable gt gt Ground Blue Cable gt gt V Red Cable gt gt V APS Master Interface User s Manual 4 0 USING THE SOFTW
31. ind it there The COM port between parentheses indicates the port number where the APS Master Interface 1s currently connected If you change to another port this number will be updated Note In Windows 7 the name of the driver will be shown as APS Master Interface V3 0 for W7 If this legend is read differently then the driver was installed incorrectly and will need a reinstallation 2 Right click on the APS Master Interface icon and select Properties Look for the Port Configuration tab and make sure the parameters are setup like the image on the left FT Accesorios 7 ActiveXperts Software gt FA aA tnde lt k F Acrobat Distiller 6 0 3 3 Installing the APS Master Interface Engine As we explained before the APS Master Interface Engine APSMI Engine is the main software that will be used to setup the parameters of the Bill Validator and or Coin Acceptor Once your application is operating the APSMI Engine will be running in the background to communicate with your application and control the equipment connected to the interface IMPORTANT The APSMI Engine license can be used in only one computer If you need to install the APSMI Engine in a different computer you need to buy a new license Please refer to chapter 2 3 for more details on this matter Once the software is installed you cannot uninstall and install it again in a new computer 1 Find the Setup exe file inside the
32. ipment for this task Coin Acceptor and or Bill Dispenser and or Coins Hoppers If the Enable Change option under Coin Acceptor is disabled the system will temporary activate the Enable Change parameter to dispense the money once the operation is completed it will return the Enable Change variable to its original value When more than one equipment is used to dispense change the APS Master Interface software will try to use the highest bill and or coin available If the equipment is enabled the algorithm will try to use the Bill Validator first followed by the Coin Acceptor and finally the Coins Hoppers 4 5 4 APS Master Interface Startup Error The APS Master Interface is a very robust and tested system however there might be occasions where the APS Master Interface 1s unable to boot correctly caused by a driver and or hardware malfunction If the system is unable to load it correctly it will report 1t saving a value 1 in the APS Error registry variable under the Status section APS Master Interface User s Manual 4 5 5 Cancel Cash Transaction without dispensing change If for any reason you need to cancel the current Cash Transaction without dispensing change you can do it by writing a value 2 in the Cancel registry variable under the Status section Even if the Bill Dispenser and Coins Hoppers are enable this function will override their settings and not dispense any change
33. mber Phone Number etc and write 1t in the ReferenceCC Regedit variable before you write the amount to change in DueCC If you write a value in DueCC and ReferenceCC is empty the APS Master Interface Engine will generate a random number using a combination of the computer unique id values and the date and time when the transaction was completed After the payment is completed or rejected the ReferenceCC number will be erased APS Master Interface User s Manual APS Master Interface User s Manual APSO Automatic Payment Systems Ram n Corona No 289 C Colonia Santa Anita Tlaquepaque Jalisco C P 45600 M xico Tel fono Oficina 52 33 8421 1284 Correo Electr nico ventas apsmx com P gina en Internet www apsmx com
34. nge Cancel Exit should be updated by your application and the remaining APS Error BDCassette BDDispensed BDStatus ChangeDispensed Credit Status Tubes will be automatically updated by the APSMI Engine Console Registry Editor 3 i Ed File Edit wiew Favorites Help Name Type Data R ab Default REG 5z value not set a si ean ab aps Error REG SZ 0 Diab lab eDCassette REG 52 Coin cceptor Ga Hoppers i ab BDDispensed RE _5Z ab 23 License BO Status REG_5Z Ga Monitoring ab cancel REG SZ Pin Pad ab Change REG_5Z Sq Settings lab ChangeDispensed REG_52 E Credit REG Sz Jagarmedical ab Due REG 5Z Logical Concept ab Dueto REG SZ Metroset fab exit REG SZ Microsoft isual Basic 4ddIns ab Referencecc REG SZ wbVidCap ab Status REG_5Z Winzip Computing ab Tubes REG 52 elf od Weber LL My Computer HEEY CURRENT USER Software VB and VB4 Program Settings 4P5 Status Ge Ge El APS Master Interface User s Manual 43 SDK APS Master Interface Main Form Integrating the APS Master Interface Engine to your application is very simple We have developed a Visual Basic sample application that can be used to explain how to control the payment systems connected to your machine The SDK APS Master Interface is distributed in a zip file as described in chapter 3 1 3 The Visual Basic Project has one form named Main frm Project Microsoft Visual Basic design
35. nge to Yes with a green background indicating that now you can start receiving payments with your account All other settings will be filled automatically by the application If you want to check that the Pinpad Terminal is working correctly click the Read Card button in the Test Pin Pad section follow the instructions shown in the Mensajes en Pantalla Pin Pad If everything is working correctly your Credit Card number and name will be used to fill the N mero de Tarjeta and Tarjetahabiente fields under the Test Pin Pad section In order to print the result of the transaction it is necessary to specify the Vaucher Printer The list of printers installed in the computer will be updated automatically in the selection menu APS Master Interface User s Manual 4 1 8 Test Console Once you have finished with the setup of your parameters you can use the Test Console to verify that your Bill Validator and or Coin Acceptor are working correctly EZ APS Master Interface Engine V5 0 0 Pay Cash Credit Card Save Cancel To test your equipment you just need to type the Amount of money to be charged in the Amount textbox then click the Cash button The APSMI Engine Console will activate the Bill Validator and or Coin Acceptor so you can start inserting the money When you click the Cash button the text in the button will change to Stop Payment You can click on this but
36. of coins in the tubes their values and the total amount in those tubes These features were not available in previous versions If you want to dispense change automatically using your Coin Acceptor Bill Dispenser and Coin Hoppers you just need to activate the function by clicking in the Enable Change checkbox Please note that Enable Change is a global setting that will enable or disable the Bill Dispenser and Coin Hoppers automatic change All the fields showing a N A value will be updated automatically once the Coin Acceptor is activated an has established communication with the APS Master Interface APS Master Interface User s Manual 4 1 5 Bill Dispenser Settings Bill Dispenser Settings are used to enable disable test and refill the equipment Connect your Bill Dispenser to an available RS232 Port in your PC then go to the General Settings tab and select the COM Port being used under the Bill Dispenser Configuration section If the connection 1s not possible 1t will display an error message asking you to select the right Port Don t forget to click Save to make the changes permanent EZ APS Master Interface Engine V5 0 0 Bill Dispenser Settings Bill Dispenser Functions iw Bill Dispenser Enabled Bill Dispenser SW Version MAA Quantity of Bills to Dispense 1 Casette Status HN ty Quantity of Bills Dispensed O Bill Size Mas Lenght HN Bill Size Min Lenght Bill Size Thickness
37. orm Load Dim InitEngine As Double Open APS Master Interface Engine This Engine will perform all the functions and communication between your computer and the payment systems Bill Validator and or Coin Acceptor If you want to debug your application you can ommit the hide parameter to view the APS Master Interface Engine Console InitEngine Shell APS Master Interface Engine exe hide 1 Reset Regedit variables These variables are used to communicate your application with the APS Master Interface Engine Savesetting APS Status Due O SaveSetting APS Status Credit 0 Savesetting TAPS Status Status savesettino APS Status Cancel P savesettino TAPS Statys Exit display Caption Format 0 currency status Caprion due Caption DUE AMOUNT amp Format 0 currency End Sub Private Sub Form Terminate caveserttina AP Status Exit T1 End Sub Private Sub Pay Click If Pay Caption Pay Then SaveSetting APS Status Due Val amountToPay Text Timerl Enabled True Pay Caption Cancel Else Pay Caption Pay Savesetting APS Status Cancel 1 display Caption Format 0 currency status Caption due Caption DUE AMOUNT amp Format 0 currency Timerl Enabled False End If End Sub Private Sub Timerl Timer display Caption Format Val GetSetting APS Status credit currency
38. ount of money to be paid is defined Your Application will write this value in a Windows Registry variable The APSMI Engine continuously monitoring the Windows Registry variables will detect that the value to charge will activate the Bill Validator and or Change Acceptor and wait for the user to complete the payment While the APSMI Engine is receiving the payment from the user it will continue updating the Windows Registry variables with the due amount the status of the equipments and the credit already paid At the same time your application will wait and monitor the Windows Registry variables until the payment is done before continuing with the next step in the selling process You can also setup in Your Application a Cancel button so the user is able to cancel the payment process at any time This is also done using the Windows Registry variables communicating with the APSMI Engine Once the payment is done the APSMI Engine will calculate the difference between the due amount and the credit and if necessary it will dispense the change using coins and or bills 2 3 Software License Every APS Master Interface Hardware is sold with one license of the APS Master Interface Engine software If you want to install the APSMI Engine in a different computer from the one that the APSMI will be used you need to request a new license to APS If you have any questions regarding our License Policy please contact us Use contact information provide
39. rrectly the wizard will show the APS Master Interface driver Select the APS Master Interface Click the Next gt button Instalaci n de hardware A El software que est instalando para este hardware APS Master Interface no ha superado la prueba del logotipo de Windows que comprueba que es compatible con Windows XP Por qu es importante esta prueba Si contin a con la instalaci n de este software puede z 4 o desestabilizar la correcta Finalizaci n del Asistente para hardware nuevo encontrado El asistente ha terminado de instalar el software para e APS Master Interface Haga clic en Finalizar para cerrar el asistente APS Master Interface User s Manual 7 You will receive a notification stating that the APS Master Interface has not passed Windows Logo testing to verify its compatibility with Windows XP Ignore the message and click the Continue Anyway button 9 Congratulations now your APS Master Interface is installed and ready to use Click Finish 3 2 2 Checking the correct installation of the APS Master Interface At this point you already installed the drivers that will be used to control the APS Master Interface You can check if the drivers were installed correctly by following the next steps Administraci n de equipos a Archivo Acci n Yer Ventana Ayuda om fS ALLRA Administraci n del equipo local HPPAVILION j Herramientas del sistema 2 Adapta
40. spenser Coin Hoppers and Credit Card Processing Please note that this file might not run properly 1f the installation 1s not completed correctly as it will be described in the next chapters This executable file requires several additional components that normally are not installed in a regular Windows XP environment If you start this application prior to the installation of the files it will return an error message related to the missing components 3 1 3 2 SDK APS Master Interface vbp SDK APS Master Interface vbp is a sample application written in Microsoft R Visual Basic 6 0 to demonstrate the use of the APSMI Engine Feel free to modify the source code to integrate it to your application APS Master Interface User s Manual 3 2 Installing the APS Master Interface 3 2 1 Connecting the Interface and Installing the Drivers After you uncompressed the drivers in your computer follow the next steps to Install your APS Master Interface for the first time Found New Hardware Wizard Welcome to the Found New Hardware Wizard Windows will search for current and updated software by looking on your computer on the hardware installation CD or on the Windows Update Web site with your permission Can Windows connect to Windows Update to search for software O Yes this time only O Yes now and every time connect a device No not this time Click Next to continue APS Master Interface User s Manual 1 Connect
41. ton at any time to cancel the payment process Once the payment operation is in process the Status Display will change to an active role displaying the status and balance of the amont due The Status Display is divided in 3 sections a The top section displays the amount of money due b The middle section displays the credit or amount of money already paid c The botton section display the status of the APSMI Engine Status APSMI Engine Test Console is very usefull when you are writing your applications you can always use it to debug your code and monitor the payment functions When you integrate APSMI Engine to your application this is the same software that will communicate with your devices but the APSMI Engine will be hidden to the user APS Master Interface User s Manual 4 2 APS Master Interface Engine Console Hide The APS Master Interface Engine Console Hide is the same application described in the previous chapter the only difference 1s that the application runs in the background without displaying any Forms While your are using the APSMI Engine Console using the Hide parameter your will be able to control the payment process using your Bill Validator and or Coin Acceptor but you won t be able to change the parameters Here an example of how you can call the APSMI Engine Console using a regular DOS line command with the hide parameter Once you are programming your application you need to find the right cod
42. ually we don t recommend it because any mistake on typing the numbers can block you from using the APSMI Engine Console application 2 Registry Editor File Edit View Favorites Help Data value not set APS ab YE REQ 52 971476 BillDispenser Billalidator Coindcceptor Hoppers Eg License 3 Monitoring Pin Pad Settings _ Status TT My ComputeriHKEY_CURRENT_ USER SoftwareWB and YBA Program Settings 14PS License 4 2 3 Settings Windows Registry Settings Windows Registry is used to record the values used by the APSMI Engine Console to set the parameters of the Bill Validator and Coin Acceptor As this values can be changed manually we recommend using the APSMI Engine Console described in Chapter 4 1 z Registry Editor E nx File Edit View Favorites Help Name Type Data Billbispenser ab Default REG 52 value not set BillValidator Bill value 1 REG SZ Coim cceptor ab Bill_Value _1 REG_52 Hoppers ab Bill_Value_11 REG_52 el EN ab Bill_V alue_12 REG_52 ead lab Bill_Value_13 REG SZ E Settings lab Bill_Value_14 REG Sz Sam ablbil_Value_15 REG_52 License My ComputeriHKEY_CURRENT_ USER SofFtwareWB and VB4 Program Settings 4P5 Settings APS Master Interface User s Manual 4 2 3 Status Windows Registry Status Windows Registry values are used to communicate the APSMI Engine Console with your application While there are 14 variables under this section only six Due DueCC ReferenceCC Cha
43. ws XP or Windows 7 Using the MDB Master Interface Cable it 1s possible to connect a Bill Validator and or a Coin Acceptor Bill Validator Coin Acceptor PC Running ji Windows XP with one USB Port Available USB Cable MDB Master Interface Cable APS Master Interface Power Supply Hm Power Source 120V The APSMI is powered up by the USB connection An additional External Power Supply is required to power up the Bill Validator and or Coin Acceptor The APSMI contains the electrical interface for MDB master the device is compliant with the timing of the MDB 4 0 Specification Some low level parts of the MDB communication is implemented directly on the interface microcontroller This allow to meet the MDB timing specification and to control the mode bit of the MDB protocol To communicate with a MDB slave we must use the MDB master of the interface The timing and mode bit control is handled by the interface microcontroller The full MDB Data Frame including command and checksum is send to the interface endpoint The response of the MDB Slave is then read from the interface endpoint APS Master Interface User s Manual 2 2 Software Configuration APS Master Interface Software was developed to allow the interaction of any application written In any programming language that 1s able to communicate and change Windows Registry values in the Windows XP or Windows 7 Operative Systems APSMI Software consists on two different mo
Download Pdf Manuals
Related Search