SDK for APS Master Interface
Contents
1. 1 you want to dispense change using your Coin Acceptor you just need to activate the function by clicking in the Dispense Change checkbox Please note that the availability of dispensing change is limited by the quantity and type of coins that you Coin Accepioe will hold the tubes when this function is required We highly recommend the use of additional Hoppers when a high amount of transactions will require dispensing change 4 1 4 Test Console Tarore 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 1 you made changes to the parameter it is necesary to click the Save button this will automatically close the AMI Engine Console application Once you open again the AMI Engine Console the Bill Validator andlor Coin Acceptor will receive the new settings defined in your parameters test your equipment you just need to type the Amount of money to be charged in the Amount textbox then click the button Apt The AMI Engine Console will activate the STOF Para Validator and or Coin Acceptor so you com start inserting the money When you click the Pay button the function for that button will change to STOP Paying You can click on this button at any time to cancel the paying process Once the payment operation is in process the Status Displ2. AMI 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 SA power supply should work with your MDB device Please follow the picture bellow as a guide to connect your equipments to the AML You can use standalone 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 Some equipments have to be configured to support the MDB protocol Please make sure your equipment meet this requirement before connecting it to the AMI If your equipment is already included in the list of equipment tested by APS Chapter 25 and you need additional information on bow to set it up please feel free to contact us to support you on this task 4 0 USING THE SOFTWARE The APS Master Interface Engine software has two operating modes APS Master Interface Engine Console Used to setup parameters debug your application and test Bil Validator andor Coin Acceptor and the APS Master Interface Engine Hide Used to control the Bill Validator andor Coin Acceptor while your application is running In this mode the AMI Engine won t be visible to the user 4 1 APS Master Interi Engine Console Before starting the APS Master Inte
3. For additional information APS Team can be contacted through our technical support email at techsuppor apsmx com 14 Acronyms and Abbreviations Multidrop Bus SDK Software Development Kit APS Automatic Payment Systems APS Master Interface 2 0 SYSTEM SUMMARY 2 1 Hardware Configuration The APS Master Interface AMI is configured to be connected to one available USB port in a PC Running Windows XP Using the MDB Master Interface Cable t is possible to connect a Bill Validator and or a Coin Acceptor AMI is powered up by the USB connection An additional External Power Supply is required to power up the Bill Validator and or Coin Acceptor AMI contains the electrical interface for MDB master the device is compliant with the timing of the MDB 2 0 Specification Some low level parts of the MDB communication is implemented directly on the interface microcontroller This allow to mest the MDB timing specification and to control the mode bit ofthe 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 s send to the interface endpoint The response of the slave is then read from the interface endpoint 22 Software Configuration APS Master Interface Software was developed to allow the interaction of any applicat
4. Master Interface Engine software please make sure your computer meets the following minimal system requirements Microsoft Windows XP R Professional with SP2 Intel R Pentium R Processor 1 73 GHZ 1LAN Network Port d Universal Serial Bus USB 2 0 2 5 Hardware and Software Compatibility As we continue looking to increase the amount of Bill Validators and Change Acceptos tested With our APS Master Interface we 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 AMI Engine Console to update your settings Here is the list af the equipment successfully tested by APS 2 prc Pn c NM a IE you have a different equipment not provided in Section 1 3 of this Manual ed in this table please feel free to contact our Technical Support Staff to get the latest information on tested equipment Use contact information 3 0 GETTING STARTED 3 1 Extracting from the zip files The APS Master Interface hardware requires USB drivers to work with your computer those divers distributed in a zip file Master Interface Driverzip containing 2 files that you will nee
5. SDK for APS Master Interface Version 2 0 User Manual APS Automatic Payment Systems April 2009 aps mastel interface Revision Sheet Feb 3rd 2009 Release 1 0 GENERAL INFORMATION Ll System Overview The APS Master Interface allows connecting a Bill Validator and or Coin Acceptor using the standard Vending Protocol to a PC running Microsoft Windows XP The APS Master Interface is connected to one of the USB ports in the PC 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 is intended to be received by them Multdrop 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 contol all the machine s component The Software Development Kit SDK for the APS Master Interface includes all the drivers required to operate the equipment and also Visual Basie sample code to speed up the leaming process creating new application with this system 12 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
6. ay will change to active role displaying the status and balance of the amont due The Status Display is divided im three 3 The top section displays the amount of money due b The middie section displays the creditor amount of money already paid c The boton section display the status af the AMI Engine Status There are six types of status that the AMI Engine uses Bill Inserted Coin Inserted Processing Payment Insert Coin or Bill Dipeasing Change and Change Dispensed AMI 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 AMI Engine to your application this isthe same software that will communicate with your devices but the AMI Engine will be hidden to the user 42 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 is that the application runs in the background without displaying any Forms While your are using the AMI Engine Console using the Hide parameter your will be able to control the payment process using your Bill Validator andlor Coin Acceptor but you wont be able to change the parameters 4 2 1 Windows Registry Settings for AMI Engine Console The Windows Registry is database which stores settings and options for Microsoft Windows operating systems It contains informat
7. d once the Interface is connected for the first ime to your computers USB por Details on how to install the Interface will be described in the next chapters Feda de moaienn 218 nfermac n seb 03 19 2009 2222 Besse 2718 Mave 098500010030 The SDK for APS Master Interface is distributed in a zip file SDK Master_Interface zip containing all the software and drivers you will need to develop your applications After you have uncompressed it you will find the following files 7 Rire Pt ir Engr one dece m pu aspe Eteran dels 12 15 200 Snin S VasesceumHe 0409 200 17 12 ton Soucest Node Mach Vase bieten 1G Vessart ses Mare Deacon 1G elec Pes 3 12 APS_Master_Interface_Engine exe APS Master Intefuce Engineexe is the main application that 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 Coin Acceptor 3 13 APSMaster dll APSMaster dll is the Dynamic Link Library that contains all the functions required by AMI Engine to control the Bili Validator and or Coin Acceptor 3 14 SDK_APS_Master_Interface vbp SDK_APS_Master_Interface vop is sumple application written in Microsoft R Visual Basic 6 010 demons
8. e specification fom p deseribed in chapter 2 4 please contact us to help you to define the Tee 5 best parameters for your system Please note that mot all the 5 systems wili work with our AMI S888 The most common applications are developed to conto one Bill Validator dior onc Coin Acceptor using one AMI only Since AMI Engine is designe to work with your USB we ean develop special applications to have one computer controlling more than one AMI this is your case please comact us to Damn the feasibility of your project you make changes to the General Settings you need to pres the Save button so they are available next time you run the AML Engine Console When you click Save the AMI Engine application will be closed 4 1 2 Bill Validator Settings mg 34 ET Wer mar mer mr mur sur mur sc Her m Bill Validator Settings are used to enable disable the use of a Bil Validator and also to specify the value of bill assigned to each ype Click on the Enabled checkbox to activate deactivate the Bill Validator 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 isa number from 1 to 16 Fach brand has different assignments for the value of the Bil Type Default va
9. face drivers in the selected folder 6 16 the destination folder was selected correctly the wizard will show the APS Master Interface driver Select the APS Master Interface Click the Next gt button 7 You will receive a notification stating that the APS Master Interface has not passed Windows Logo testing t0 verify ds compatibility with Windows XP Ignore the message and click the Continue Anyway button 8 The wizard will ask you to find the APS Misys file Click on the Browse button find the APS Master Interface Driver folder then select the file 9 Congratulations now your APS Master Interface is installed and ready to use Click Finish 3 3 Installing the APS Master Interface Engine we explained before the APS Master Interface Engine is the main software that will be used to setup the parameters of the Bill Validator and or Coin Acceptor Once your application i operating the AMI Engine will be running in the background to communicate with your application and control the equipment connected to the interface IMPORTANT The AMI Engine license can be used in only one computer If you need 10 install the AMI Engine in different computer you need to buy a new license Please refer to chapter 2 3 for more details this matter Once the software is installed you cannot uninstall and install it again in a new compute 1 Find t
10. he APS Master Interface Engine exe file and double click on it 2 You will receive a warning APS Software Not Registered The AMI Engine software will generate an unique Serial Number for your computer 3 Send an email to APS requesting num your Validation Key email address an be found in chapter 1 3 Write the name of your Company Copy and paste the Serial Number into the body of your message 4 You will receive an email back from APS with your Validation Key number S Once you get the Validation Key you will need to open the AMI Engine again once you get to the APS Software Not Registered screen write your Company Name and Validation Key im thc appropriate text boxes Click the Save button The sereen will be closed 6 In the next chapters you will learn that there are two methods of opening the AMI Engine One is by double clicking in the exe file and the second is calling it directly from the Command prompt used to run the application in the background Regardless of the method you use if you Registered your software correctly you will see this sereen every time you run the AMI Engine application 34 Connecting the Bill Validator and or Coin Acceptor Once you have installed your APS Master Interface Engine software and registered it you are ready to connect the Bill Validator and or Coin Acceptor to you APS Master Interface we mentioned before the
11. ion 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 curently active hardware AMI 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 Windows Registry can be accessed manually using the Regedit utility from Windows XP uta detent aue de ae noe ae SCY mee Once the Windows Registry editor is open you can find the AMI Engine Console parameters under the HKEY USERS directory in My PC My PC HKEY_USERS S 2 Snftware VB and VBA Program Settings APS Note As the can be diferent from one computer to another you can also search forthe right path using the Ses menu option typing VB and VBA Program ss the AMI Engine Console uses three Windows Registry categories to storage all the parameters and Variables to communicate with your applications License Settings and Status NE Bl porte tensa a EI 58 rage 2 License Windows Registry License Windows Registry is used to record the values used by the AMI Engine Console validation software t
12. ion written in any programming language that is able to communicate and change Windows Registry values in the Windows XP Operative System AMI Software consists on two different modules a APS Master Interface Drivers Used to control the AMI Hardware via USB Port b APS Master Interface Engine Used to control the functions of the AMI Hardware including the operation of one Bill Validator and or one Coin Acceptor The AMI Engine is also the link that communicates those devices with Your Application using Windows Registry variables values 1 x Windows Registry values are used to store AMI Engine settings such as General Settings for Bil Validator and Coin Acceptor type of bills o accept value of the type of bills accepted type of coins to accept enable disable delivery of change ete The AMI Engine must be initialized before the payment procedure starts The AMI Engine will run in the background waiting for the Application to trigger the payment process Atypical Application consist on software that request the user to provide an account number or a selection of a product then the system connects to Data Base to get the amount of money that the user will pay using the Bill Validator and or Coin Acceptor Once the amount of money to be paid is defined Your Application will write this value in Windows Registry variable The AMI Engine continuously monitoring the Windows Regis
13. lues for the Bill Validator Settings were defined using a CashCode Backload Bill Validator where the Bill Type number 1 has a value of 20 pesos number 2 is 50 pesos etc Bill Type from number 7 to mumber 16 are not used im this type of Bill Validator You can disable the use of a Bill Type by clicking in the checkbox next to it Don t forget to click Save if you want to keep your changes 4 1 3 Coin 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 tht unlike the Bil Validator m the Coin Acceptor itis not possible to assign the value that each type of coin This information is already programmed in the Coin Acceptor and will he communicated to the AMI Engine once the equipment is activated Some Coin Acceptors manufacturers use different Seales when they setup the equipments you notice that the value of the coins inserted doesn t match with the one returned by the AMI Engine Console you can adjust the Scaling factor im the General Settings Chapter 4 1 1 enable disable the use of a coi tothe Coin Type number just click on the checkbox next With this Version of the AMI Engine Console it is not possible to the actual value of the coins programmed in the Coin Acceptrs but we already left a column that will be used for this proposes in the near future currently is showing the N A value
14. o authenticate the license number registered by the customer As this value can be changed manually we don t recommend it because mistake typing the numbers can block you from using the AMI Engine Console application A Nene Ter ter p REESE yr nomics E FALSE S Ants amen ystems ES Secr sun a Bl soe sve aoe 8 EI 4 2 3 Settings Windows Registry Settings Windows Registry is used to record the values used by the AMI Engine Console to set the parameters of the Bill Validator and Coin Acceptor As this values he changed manually we recommend using the AMI Engine Console described in Chapter 4 1 E 3 Sau ea Poan senros mecs 4 2 3 Status Windows Registry Status Windows Registry values are used to communicate the AMI Engine Console with your application While there are five variables under this section only three Due Cancel Exit should be updated by your application and the other two Credit Staus will be automatically updated by the AMI Engine Console EE NETS pem yer e erce o EM E m
15. rface Engine Console make sure your AMI Interface and Bill Validator and or Coin Acceptor are connected and powered To san the AMI Engine Console you just need to double click on the file APS Master Interface and you will see the following screen Sessio Concent Soror Tet Carane tm mer Tee foe hoa mie ae mel 10 ang Matai mw Te fae Sere e te Ee ame s lt P we oy T aur we e mri REI mr SEE nri no 0 Amar UJ SF I rer Ji utc uenire The AMI Engine Console is divided in four sections General Settings Bill Validator Settings Coin Acceptor Settings and Test Console In the following sections we will describe in detail every single one 4 1 1 General Settings Fws Settings are variables used to initialize the APS Master Interface these settings define the communication parameters between the computer and the AMI Dee Fewest Normally there is not need to modify the values on the General teal FEE Songs these are predefined by APS I you computer meets the hanen T10 Specification described im chapter 2 4 then you dont need to Her 0 Change them Se 10 Camm D IF you have a computer that doesn t meet wit th
16. trate the use of the AMI Engine Feel free to modify the source code to integrate it All other files in the uncompressed folder are related to this sample Visual Basic Project 32 Installing the APS Master Interface Afer you uncompressed the drivers in your computer follow the next steps to Install your APS Master Interface for the first ime 1 Connect the APS Master Interface to your computer using an USB Cable Note At this stage it is not necessary to connect the MDB Master Cable to your Bill Validator andor Coin Acceptor The APS Master Interface hanlware is powered up directly fom the USB port soit is not necessary to connect the power supply neither 2 Windows XP will detect your new hardware and start the Found New Hardware Wizard Select the No not this time option Click the Next gt button 3 The wizard will show the name of the APS Master Interface and ask if you have Select the Install from list or specific location Advanced option c 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 Master Interface Driver S The wizard will search for the APS Master Inter
17. try 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 AMI 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 AMI Engine Once the payment is done the AMI Engine will calculate the difference between the due amount and the credit if your Coin Acceptor is able to dispense change and that function is enabled in the AMI Engine Settings the user will receive his change in coins 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 AMI Engine in a different computer from the one that the AMI will be used you need to request a new license to APS Jf you have any questions regarding our License Policy please contact us Use contact information provided in Section 1 3 of this Manual 24 System Requirements Before you install your APS
Download Pdf Manuals
Related Search