Home

Datasheet PayLink Lite USB

1. 142 0 E 1 1 e SS 3 L a B _ i a amp o 0 j L oe E i L L i J t 255 126 0 114 5 109 5 Money Controls 2008 All rights reserved Page 17 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 Figure 6 PayLink Lite mechanical dimensions 68 0 81 0 7 0 12 0 amo Money Controls 2008 All rights reserved Page 18 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 3 5 Electrical Specification Table 1 Electrical Specification PayLink Environmental Operating temperature range 0 C to 55 C Storage temperature range 20 C to 70 C Humidity range Up to 75 RH non condensing Electrical General Voltage range 10 8Vdc to 13 2Vdc nominal 12Vdc Outputs fuse protected 12Vdc 2 5A continuous 5A peak for 200ms Outputs fuse protected 24Vdc 2 5A continuous 5A peak for 200ms Electrical I O Ports 16 inputs Switch inputs 3V3 CMOS thresholds with 3V3 pull ups 5mA max 8 high power outputs Open drain up to 300mA max output 36V Inductive or resistive 8 low power outputs Open drain up to 30mA max output 12V resistive only Communications Inter
2. Status Name Event Classification Value 0x17 REJECTING REJECTED 0x41 POWER_UP_WITH_BILL_IN ACCEPTOR REJECTED 0x42 POWER_UP_WITH_BILL_IN STACKER REJECTED 0x43 STACKER_FULL OUTPUT PROBLEM 0x44 STACKER_OPEN OUTPUT PROBLEM 0x45 JAM_IN ACCEPTOR JAM 0x46 JAM_IN STACKER OUTPUT PROBLEM 0x47 PAUSE UNKNOWN 0x48 CHEATED FRAUD 0x49 FAILURE Fault Report 0x4A COMMUNICATION_ERROR INTERNAL_PROBLEM Money Controls 2008 All rights reserved Page 86 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 13 Note Reader Escrow 13 1 EscrowEnable 13 11 1 Synopsis Change the mode of operation of all escrow capable acceptors to hold inserted currency in escrow until a call of EscrowAccept The EscrowEnable call is used to start using the escrow system void EscrowEnable void 13 11 2 Parameters None 13 11 3 Return Value None 13 2 EscrowDisable 13 21 1 Synopsis Change the mode of operation of all escrow capable acceptors back to the default mode in which all currency is fully accepted on insertion void EscrowDisable void 13 21 2 Parameters None 13 21 3 Return Value None 13 21 4 Remarks 1 If any currency is currently held in escrow when this call is made it will be accepted without comment Money Controls 2008 All rights reserved Page 87 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 13 3 EscrowThroughput 13 31 1 Synopsis Deter
3. A call to ReadAcceptorDetails followed by call to WriteAcceptorDetails for the same data will have no effect on the system Money Controls 2008 All rights reserved Page 63 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 11 6 ReadDispenserDetails 11 61 1 Synopsis The ReadDispenserDetails call provides a snapshot of all the information possessed by the interface on a single unit of money dispensing equipment bool ReadDispenserDetails long Number DispenserBlock Snapshot l 11 61 2 Parameters 1 Number The serial number of the coin or note dispenser about which information is required 2 Snapshot A pointer to a program buffer into which all the information about the specified dispenser will be copied 11 61 3 Return Value True if the specified input device exists False if the end of the list is reached 11 61 4 Remarks The serial numbers of the dispensers are contiguous and run from zero upwards 11 7 WriteDispenserDetails 11 71 1 Synopsis The WriteDispenserDetails call updates all the changeable information to the interface for a single unit of money handling equipment void WriteDispenserDetails long Number DispenserBlock Snapshot 7 11 71 2 Parameters 1 Number The serial number of the coin or note dispenser being configured 2 Snapshot A pointer to a program buffer containing the configuration data for the specified dispenser See below for details 11 71 3 Retu
4. 1 X Paylink power cable 4 X 20 way headers for use with inputs outputs 1 XUSB Type A Type B cable 1 X Ardac 5 Power cable 1 X RJ45 RS232 adapter 1 X RJ45 cable 1 X MDB cable VVVVVVVVVVVVV VV V Money Controls 2008 All rights reserved Page 11 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 PayLink Lite development kit part number APCUSBXX00004 Money Controls recommend purchasing a development kit in order to aid the integration process in the host machine The contents of the PayLink Lite Development Kit are as follows PayLink Lite 1 X cctalk multidrop cable 2 X SR5 Lumina cable 1 x Ardac Elite ccTalk Cable 1 X SR3 Condor Plus cable 1 X SCH2 cable set to address 4 1 X SUH cable set to address 3 1 X Paylink power cable 1 X USB Type A Type B cable 1 X 2 way Switch Input loom VVVVVVVVVV Money Controls 2008 All rights reserved Page 12 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 3 Specification 3 1 PayLink Functional block diagram Figure 1 Functional block diagram Note Acceptor Note Acceptor Changer Serial ticket Coin Acceptor Barcode Note Printer Hopper Acceptor Serial Meter Switches LEDs Diagnostics amp amp amp Buttons Lamps System Info Money Controls 2008 All rights reserved Page 13 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 3 2 PayLink Lite Functional block diagram Figure 2
5. August 2008 11 13Coin Routing Coins can be easily routed to fill a coin dispenser and one or more cash boxes There are 3 routing techniques e Route coins to a general cash box e Route specific coins to a specific cash box e Route specific coins to a dispenser until it is full then route it to a coin specific cash box There are 3 settings for each coin that are important e Coin Path The path to the coin specific hopper e Coin DefaultPath The path to the coin specific cash box e Coin PathSwitchLevel When Coin PathCount reaches Coin PathSwitchLevel coins are routed to the coin cash box 11 131 ROUTE COINS TO A GENERAL CASH BOX e Setall coin paths to the desired route e g General Cash box on route 4 e Path 4 for all coins e DefaultPath O for all coins e PathSwitchLevel O for all coins 11 132 ROUTE SPECIFIC COINS TO A SPECIFIC CASH BOX e Set Coin Path for each coin that is routed to a specific cash box e The other 2 coin settings are zero e g General Cash box on route 4 coins 1 and 2 have separate cash boxes on routes 5 and 6 e Path 5 for coin 1 6 for coin 2 and 4 for all other coins e DefaultPath O for all coins e PathSwitchLevel O for all coins 11 133 ROUTE COINS TO A DISPENSER UNTIL IT IS FULL THEN ROUTE IT TO A COIN CASH BOX e Set Coin Path to the dispenser route for each coin that is routed to a hopper e Set Coin DefaultPath to the cash box route for each coin that is routed to a hopper This m
6. Enter the Lumina 6 digit security code found on a label on the top of Lumina and click Enter This will close the application PayLink will now work with the code specified To change to a different code run LuminaSerial exe again to change the code Money Controls 2008 All rights reserved Page 33 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 6 3 ccTalk hoppers gt Currently 8 Hoppers at addresses 3 to 10 are supported and the pre set values are linked to the cctalk address shown below gt 6 are supported on PayLink Lite 2 when a Coin or Bill acceptor are connected gt The below hoppers values have been implemented from PayLink firmware version 4 1 9 6 and above gt The hopper addresses is selected by hardwiring the connector Table 5 Hopper address Wiring amp Coin Values X Connect to Vs Pins 4 or 5 ccTalk Address Coin Address select 3 Address select 2 Address select 1 Value Pin 1 Pin 2 Pin 3 3 100 X 4 50 X 5 25 X X 6 20 X 7 10 X X 8 5 X X 9 200 X X X 10 1 gt Itis recommend to use only use 24V hoppers gt 12V SCH2 hoppers can be used but you must not power via PayLink as the current consumption will be too high Under no circumstances can any more than 2 5A drawn through the card gt Hopper level sense is supported in PayLink firmware version 3 1 10 1 and above See section 7 2 Demo exe amp 11 22 Dispen
7. Reported from device 0x00000020 Reported from device 0x00000040 Reported from device INS 256 Maximum coins or notes handled by any device ctures for AcceptorBlocks long Value Value of this coin long Inhibit Set by PC this coin is inhibited long Count Total number read ever long Path Set by PC this coin s chosen output path long PathCount Number ever sent down the chosen Path long PathSwitchLevel Set by PC PathCount level to switch coin to default path char DefaultPath Set by PC Default path for this specific coin char FutureExpansion Set by PC for future use char HeldInEscrow count of this note coin in escrow usually max 1 char FutureExpansion2 for future use char CoinName A string usually as returned from the acceptor describing this coin AcceptorCoin typedef struct long long long long long long long char AcceptorCoin long char AcceptorBlock Unit Specification of this unit Status AcceptorStatuses zero if device OK NoOfCoins The number of different coins handled InterfaceNumber The bus connection UnitAddress For addressable units DefaultPath EventCount Count of events e g rejects for this acceptor Currency 4 Main currency code reported by an intelligent acceptor Coin MAX_ACCEPTOR_COINS only NoOfCoins are set up SerialNumber Reported se
8. 4 2 Software Installation Note These instructions are for Windows XP only Please contact Money Controls for information on installing the software under different operating systems Found New Hardware Wizard Welcome to the Found New Hardware Wizard This wizard helps you install software for AES Genoa USB Hub Choose Install from a specific location then click ext If your hardware came with an installation CD 42 or floppy disk insert it now What do you want the wizard to do O Install the software automatically Recommended Install from a list or specific location Advance Click Next to continue Cancel Found New Hardware Wizard Please choose your search and installation options Y SS each for the best driver in these locations Use the check boxes below To tm pand the default search which includes local Choose Search for the best paths and removable media The best pu found wiber driver in these locations Search removable media floppy CD ROM then click Next J Include this location in the search O Don t search will choose the driver to install Choose this option to select the device driver from a list Windows does not quarafttee that the driver you choose will be the best match for your hardware Hardware Installation A The software you are installing for this hardware If this screen appears click Continue Anyway Money Handling Equipment Interface has
9. Vv Issue 1 5 gt gt A is August 2005 1 Issue A A E A November 2005 Changed the value for cctalk hopper address 10 from 500 to 1 Corrected a mistake with the pinout for RS232 printer interface Change red and black to orange and black for 24V Included information on hotswapping Above mentioned changes in line with firmware release 4 1 9 6 A nt eb ee ee ee eee abe een December 2005 Corrected a mistake with the cctalk connector pinout information A te wore hota a Rte Mech 21 sho Sc Seat May 2006 Added hopper level sense support Added MDB changer support Added hopper power fail support Corrected mistakes in Figure 14 and Figure 15 Added SCH3 Combi Support Removed all connector details referecne now to release drawings Added driver and dll revisions Added additional functions available in AESWDriver and Firmware updater Above mentioned changes in line with firmware release 4 1 10 4 O A TOTANA November 2006 Changes to reflect 4 1 10 6 release of software Updated the hopper Address vs Value table aio rdeO aren August 2008 Changes to reflect 4 1 10 9 release of software Added PayLink Lite reference OMoney Controls 2008 All rights reserved Page 8 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 2 2 1 Overview Introduction PayLink is a simple compact system that offers trouble free interfacing between a PC and money handling Equipment PayLink allows the
10. long CheckOperation long Sequence long Timeout 12 11 2 Parameters 1 Sequence A unique number for this call freely chosen by the application 2 Timeout A time in milliseconds before which another CheckOperation call must be made with a different value in Sequence in order to continue the normal operation of Paylink If zero then this functionality is inactive from then on 12 11 3 Return Value The last Sequence value of which the PayLink unit has been notified or 1 if the PayLink does not support this facility 12 11 4 Remarks 1 In normal operation PayLink can be expected to have updated the value to be returned by this within 100 milliseconds of the previous call It is suggested that this call is made every 500 milliseconds or longer to allow for transient delays 2 Ifthe Timeout expires PayLink will silently disable all the acceptors that are connected to it The next call to CheckOperation will silently re enable them This facility is not operation until the first call of CheckOperation Money Controls 2008 All rights reserved Page 73 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 12 2 NextEvent 12 21 1 Synopsis This call provides access to all the detailed workings of the peripherals connected to the system All Acceptor Dispenser events such as errors frauds and rejects including pass fail of internal self test that are received will be queued in a short que
11. printf IMHEI open failed ld n OpenStatus else Then the open call was successful The interface is currently disabled EnableInterface PayOut NoOfCoins 100 while LastPayStatus 0 if LastPayStatus lt 0 printf Error d when paying d coins n LastPayStatus NoOfCoins else printf Sd coins paid out n NoOfCoins Money Controls 2008 All rights reserved Page 56 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 10 133 INDICATOR EXAMPLE void LEDs void long OpenStatus OpenMHE char Loop if OpenStatus EnableInterface for Loop 0 Loop lt 8 Loop IndicatorOn Loop Sleep 1000 for Loop 0 Loop lt 8 Loop IndicatorOff Loop Sleep 1000 DisableInterface 10 134 SWITCH EXAMPLE void LEDs void long OpenStatus OpenMHE char Loop if OpenStatus EnableInterface for Loop 0 Loop lt 8 Loop printf Switch d is currently s n Loop SwitchCloses Loop SwitchOpens Loop Open Closed printf It has closed d times n SwitchCloses Loop DisableInterface Money Controls 2008 All rights reserved Page 57 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 11 Full Game System 11 1 Background When implementing a full game i
12. 10 x 11 16 Combi Hopper Support 1 10 x 11 17 Multiple PayLink Unit Support 11 171 AO se ciebesd sede sadecabadinidad sa tadesibeaiad eaatsanttiaecaadevess 11 172 Unit Identification add oca dadas 12 Utility FUNCTIONS oonnnncccnnnncocnnnncccnnnacrcnnnn rn 12 4 lt GheckOperation 111X cin at cit re res 12111 ES A ANN 12 11 2 Parameters LTS ROTO MAS ria T2211 4 AROMAS A ne dardo dee Bede 122 ANOXTEVEN E ta ads 12211 SYNODSIS Ti hss eerie ERE hse aves ne we 12 21 2 Parameters 12 21 3 Return Value T2294 5 ROMANS iscc55 E T tna dnievdeed O 12 3 AvallableV alle a EL lee PA ES e AA E NO 12 31 2 Parameters 12 31 3 Return Value 12 31 4 Remarks NN 12 4 ValueNeeded cvccoccocooicotoicn dida iia TLATIT SYROpS S r e a a dee R a aaae a e Handy Th dated 12 41 2 Parameters 12 41 3 Return Value TRATA Remarks La A AA da A 12157 SetDevice Key viii A ee nye Aa raid ae edie el eaten eas 12 51 1 Synopsis 12 51 2 Parameters 12 51 3 Return Value E gt A NR NO 12 6 SerlalNUMbDer cuicos aii cabo ia Sete 12 61 1 Synopsis 12 61 2 Parameters 12 61 3 Return Value E CRA RA NN A O O EATE TRIAS OOPS S ita dE A E A A e 12 71 2 Parameters 12 71 3 Return Values 12 71 4 RematkS iii ii E E a a ira E AE aa e AR E Aaaa iiaa 12 8 USBDriverStatus cccccccccccccssssceccecceessssseeee
13. 500 msec This is the minimum time in milliseconds that will elapse between successive coin insertions It should be overridden by the application where a fast coin acceptor is in use 2 NoteTime Default STANDARD_NOTE_TIME 5000 msec This is the minimum time in milliseconds that will elapse between successive note insertions It should be overridden by the application where a fast note acceptor is in use 12 101 3 Return Value 1 If all the data structures are both consistent and reasonable the function returns NULL If there is any problem an English text message is returned describing the problem 12 101 4 Remarks 1 A non NULL return is a totally unrecoverable situation It is expected that application will report the error and then stop operation 2 As well as calling this function periodically it is recommended that it is called after the detection of a credit increase Money Controls 2008 All rights reserved Page 79 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 12 11 Auditing Event Processing This section elaborates further on the processing behind the events returned by the NextEvent function There is no intention that these events would be used for the normal operation of the game Rather the intention is that they can be captured and presented in management reports Obviously the application can respond automatically to events such as fraud by disabling everything for a whil
14. 51 1 Synopsis 16 51 2 Parameters sas 16 91 34 Rom Vale o at bil A Medea LEA od A de LI AI deed a ea a 16 514 RAMAS iii A A a a ai BarcodeAccept 16 61 1 Synopsis 16 61 2 Parameters 16 61 3 Return Value 16 61 4 Remarks Barcode Rel ed LA aid AS EA E A EN A ANNO 16 71 2 Parameters 16 71 3 Return Value 16 754 Remarks emina ann a a ATT Barcode Printing saraan erea ii BarcodePrint 16 911 SA NO RR NO 16 91 2 ParaMeterS aeaeaie anaia A rE 16 91 3 Return Value 16 91 4 Remarks BarcodePrintStatus usara a A whee ee ee es eet 102 16 101 1 SVIIODSIS i east E e RR E AN 102 16 101 2 PANES e Rin 102 16 101 3 RAOUUTO Val E A A A A A A A Ai 102 Money Controls 2008 All rights reserved Page 6 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 16 101 4 ROMS A AAA AA cada labs A IEA add eii 17 Engineering Support 17 1 WritelnterfaceBlock IZII NOISE A A a aiaa I2 E AA PEA 17 11 3 ROtU V lse eearri E ania EEr aE A a ROMAIKS NT 1 1 2 ReadinterfaceBloCk iii ee bc ed TALE SYNOPSIS ii E A adi idas AAA E AAA AN 17 21 3 Return Values A UE ARA AS Figures Figure 1 Functional block diagram Figure 2 Functional block liagraM cion faena Figure 3 PayLink Connector overview With examples oooooncccnocccncccnoncccnnccnoncnnnncnnnncnnanc cnn cn nan nn narra nan nn ran nnnnnnnnnnnins 15 Figure 4 PayLink Lite
15. Barcode at the time this call is made it will immediately cause the BarcodeTicket to be updated 2 If no ticket is currently held when this call is made it will be silently ignored Money Controls 2008 All rights reserved Page 100 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 16 8 Barcode Printing 16 9 BarcodePrint 16 91 1 Synopsis This call is used to print a barcoded ticket if the IMHEI system supports a printer void BarcodePrint TicketDescription TicketContents i 16 91 2 Parameters 1 TicketContents Pointer to a TicketDescription structure that holds pointers to the strings that the application is filling in NULL pointers will cause the relevant fields to default usually to blanks typedef struct long TicketType The template for the ticket char BarcodeData char AmountinWords char AmountAsNumber But still a string char Machineldentity char DatePrinted char TimePrinted TicketDescription 16 91 3 Return Value None 16 91 4 Remarks 1 There are a number of fields that can be printed a barcode ticket Rather than provide a function with a large number of possibly null parameters we use a structure which may have fields added to end The user should ensure that all unused pointers are zero 2 Before issuing this call the application should ensure that BarcodePrintStatus has returned a status of PRINTER_IDLE 3 The mechanics of the
16. PayLink Technical Manual TSP129 Issue 1 5 August 2008 11 15 Dispenser Power Fail support 1 10 x Some dispensers especially some hoppers produced by MCL are guaranteed to correctly count coins even if power is removed during a payout sequence This facility is explicitly supported in the PayLink software The Count field for these hoppers is set during initialisation to correspond to the total coins paid since manufacture value retrieved from the hopper and is then updated as payouts occur It is this field that allows for the correct counting of coins over a power failure At the end of every payout sequence the PayLink stores internally the Count for each hopper At initialisation as well as reporting the retrieved count it is also compared with the saved value This enables the CurrentPaid function to continue to report the correct value and also generates an IMHEI_COIN_DISPENSER_UPDATE Event see below to register this update 11 16 Combi Hopper Support 1 10 x This single unit dispenses two different coin values It is therefore handled in a similar way to the MDB system There is a primary dispenser which is set up as a normal unit with a Unit field of DP_MCL_SCH3 and a Value field with the lower coin value in it The Count in this dispenser is the count of the lower value coins dispensed In addition another dispenser is set up with a matching Address field a Unit field of DP_CC_GHOST_ HOPPER the Value of the hi
17. ReadDispenserDetails 11 61 1 Synopsis cococccccccancnn 11 61 2 Parameters 11 61 3 Return Value ari ria 11614 Remarks cti a a Ai OMoney Controls 2008 All rights reserved Page 3 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 11 7 11 8 11 9 11 10 Dual Currency Handling Coin Ids 1 11 x WriteDispenserDetalls ivi evasive tito 64 A ES A REO 11 71 2 Parameters 11 71 3 Return Value TIA Remarks iii ti ieni rriat Dispenser Value Reassignment 1 10 7 cccconncccconncccononancnnnnncnonnn nr Loken Handling Goin lds TANX az caesec es sesak segetdhaaenseeakbenateeaaadgeusssvaaachuiedetastteasdsieadvishaateassaaecshesuecees 11 11 Read out of Acceptor Details 1 11 X ooonoocccnnncccononcccnnnoncnonanoncnnnononnnnnnn cnn rnnnn ran nnr are n nar n rre rnnr rra ran nn 11 12 Read out of Dispenser Details 1 11 X oononcconnnccccnnoncccnnnanncnnanncononan cnn nano nr r narrar rn r nr rn r rr 11 13 COM ROUTING aut chinks attri a tirita 11 131 Route coins to a general cash boOx 11 132 Route specific coins to a specific cash box 11 133 Route coins to a dispenser until it is full then route it to a coin cash box 11 134 Paylink Routing Flow DiagraM ooocononcccnnonccnnnnonnnnnnonnncnnnancnn nano cnn nnnn cnn 11 14 MDB changer support 1 10 x 11 141 MDB tube level monitoring 11 15 Dispenser Power Fail support 1
18. This is where the IMHEI system keeps the value in value out counters the configuration information etc void E2PromReset long LockE2Prom 15 11 2 Parameters 1 LockE2Prom This is a Boolean flag If zero then the EZ2PROM may be reset again later If non zero then all future calls to this function will have no effect on the card 15 11 3 Return Value None 15 11 4 Remarks An example application for this is available within the SDK folder structure Money Controls 2008 All rights reserved Page 95 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 15 2 E2PromWrite 15 21 1 Synopsis The E2PromWrite call is made by the PC application software to write to all or part of the user E PROM on the card void E2PromWrite void UserBuffer long BufferLength 15 21 2 Parameters 1 UserBuffer This is the address of the user s buffer from which BufferLength bytes of data are copied to the start of the user area 2 BufferLength This is the count of the number bytes to be transferred If this is greater than 256 the extra will be silently ignored 15 21 3 Return Value None 15 21 4 Remarks 1 This call schedules the write to the E FPROM memory and returns immediately There is no way of knowing when the E PROM has actually been updated but barring hardware errors it will be complete within one second of the call 15 3 E2PromRead 15 31 1 Synopsis The E2PromRead call is made by the PC applic
19. all coins and notes read 10 71 4 Remarks 1 The value returned by this call is never reset but increments for the life of the interface card Since this is a long 32 bit integer the card can accept 21 474 836 47 of credit before it runs into any rollover problems This value is expected to exceed the life of the game 2 Itis the responsibility of the application to keep track of value that has been used up and to monitor for new coin note insertions by increases in the returned value 3 Note that this value should be read following the call to OpenMHE and before the call to Enablelnterface to establish a starting point before any coins or notes are read Money Controls 2008 All rights reserved Page 51 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 10 8 PayOut 10 81 1 Synopsis The PayOut call is used by the PC application to instruct the interface to pay out coins or notes void PayOut long Value 10 81 2 Parameters Value This is the value in the lowest denomination of the currency i e cents pence etc of the coins and notes to be paid out 10 81 3 Return Value None 10 81 4 Remarks 1 This function operates in value not coins It is the responsibility of the interface to decode this and to choose how many coins or notes to pay out and from which device to pay them 10 9 PayStatus 10 91 1 Synopsis The PayStatus call provides the current status of the payout process lon
20. can be added to the file name to provide enhanced functionality Force will automatically re program the PayLink even if the images match Check will cause the loader to exit without showing a window if the PayLink firmware matches and has no errors Nogui will never display anything on the screen and will report progress to stdout or a console window if either is available AES Programming Utility Currently Loaded Version 1 9 8 Status Full Release Compiled on Mar 8 2006 at 11 44 44 This Image Version 1 10 4 Status Full Release Compiled on May 42006 at 14 11 36 112 blocks out of 1194 programmed Once complete the AES Programming Utility will self terminate While running a Configure button is accessible This can be used to access advanced features AES Programming Utility Currently Loaded Version 1 9 8 Status Full Release Compiled on Mar 8 2006 at 11 44 44 This Imaqe Version 1 10 4 Status Full Release Compiled on May 42006 at 14 11 38 750 blocks out of 1194 programmed ETT TT Startup Configuration Program Card Startup Configuration provides the ability to Set Startup Check None and Clear an entry in the This facility all ce nee ae Windows registry that wil Set is facility allows you to set an automatic check at startup Petty to ensure that the AES IMHE card is running the silently run this Be of dd correct version of the firmware programming utility a
21. message 17 11 3 Return Value 17 11 4 Remarks Using this function with some interfaces does not make sense see status returns from ReadinterfaceBlock Money Controls 2008 All rights reserved Page 103 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 17 2 ReadinterfaceBlock 17 21 1 Synopsis The ReadinterfaceBlock call reads the raw response to a single WritelnterfaceBlock long ReadInterfaceBlock long Interface void Block long Length 17 21 2 Parameters 1 Interface The serial number of the interface being accessed 2 Block A pointer to the program buffer into which any response is read 3 Length The space available in the program buffer 17 21 3 Return Values ve return values indicate a message has been returned Other values are 5 INTERFACE NO_ DATA The handshake has completed but no data was returned 4 INTERFACE TOO LONG Input command is too long 3 INTERFACE_NON_ EXIST Non command oriented interface the corresponding WritelnterfaceBlock was ignored 2 INTERFACE_OVERFLOW Command buffer overflow the corresponding WritelnterfaceBlock was ignored 1 INTERFACE_TIMEOUT Timeout on the interface no response occurred The interface will be reset if possible O INTERFACE BUSY The response from the WritelnterfaceBlock has not yet been received gt 0 Normal successful response the number of bytes received and placed into the buffer 17 21 4 Remarks 1 Repeated call
22. not passed Windows Logo testing to verify its compatibility with Windows lt P Tell me why this testing is important Continuing your installation of this software m or destabilize the correct operation of your either immediately or in the future Micros impair strongly now and contact the hardware vendor for soft passed Windows Logo testing Money Controls 2008 All rights reserved Page 24 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 Found New Hardware Wizard Click Finish to complete Completing the Found New the software installation for Hardware Wizard PayLink The wizard has finished installing the software for 2 AES Genoa USB Hub Click Finish to close the wizard To complete the software installation Take the following step In the PayLink Distribution CD there is a file called Aesimhei dll copy this to C Windows System32 amp PayLink Distribution CD Fie Edt Vew Favortes Toos Help Ow F Puen f 7 Product Information Mise Proceso er Tasks a e Ez Please note If this step is ES Make a new Folder A E aa ie a es not performed the Bak PayLink applications will not function correctly Other Places Ea Portes L pe ye Date Modfied 17 10 2003 11 06 My oomerts DD Progr anmer s Guide LKB Interret Strorteut My Comecter Release fotat 3KB Text Document My Network Places 20KB Microsoft Word Doc GORD Apphcabon Extension we Nike ane IKB L 33KB
23. of the PC system In keeping with the IMHEI concept an interface is defined to an idealised meter This will be implemented transparently by the card using the available hardware Initially the IMHEI will support a Starpoint Electronic Counter although other hardware may be supported at a later date 14 1 Counterlncrement 14 11 1 Synopsis The Counterlncrement call is made by the PC application software to increment a specific counter value void CounterIncrement long CounterNo long Increment 14 11 2 Parameters 1 CounterNo This is the number of the counter to be incremented 2 Increment This is the value to be added to the specified counter 14 11 3 Return Value None 14 11 4 Remarks 1 If the counter specified is higher than the highest supported then the call is silently ignored 14 2 CounterCaption 14 21 1 Synopsis The CounterCaption call is used to associate a caption with the specified counter This is related to the CounterDisplay call described below void CounterCaption long CounterNo char Caption 14 21 2 Parameters 1 CounterNo This is the number of the counter to be associated with the caption 2 Caption This is an ASCII string that will be associated with the counter Money Controls 2008 All rights reserved Page 90 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 14 21 3 Return Value None 14 21 4 Remarks 1 The meter hardware may have limited display c
24. one ccTalk coin note acceptor is supported Connect the SR5 cable to the ccTalk multidrop cable and SR5 lina Connect the SR3 Condor Plus cable to the ccTalk multidrop cable and SR3 Condor Plus MA a PayLink Technical Manual TSP129 Issue 1 5 August 2008 Connect the SCH2 cable to the ccTalk multidrop cable and SCH2 F E Connect the Lumina cable to the ccTalk multidrop cable and Lumina A Connect the ccTalk multidrop cable orange and black to a 24V dc power supply Money Controls 2008 All rights reserved Page 21 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 OMoney Controls 2008 All rights reserved Page 22 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 Connect the 4 X 20 way headers to the I O connectors Note Each 20 way header has a different key way to correspond with the missing pin on the 20 way connectors The ends of the cables are left open to use as desired Connect PayLink to the 2 pin power cable and to a 12V dc power supply The status LED will show RED ON Connect the USB cable to PayLink and to the PC Windows will indicate that a new USB device has been detected and will prompt for the drivers The following screen will be shown this begins the software installation Money Controls 2008 All rights reserved Page 23 of 104 P ayLink Technical Manual TSP129 Issue 1 5 August 2008
25. priniting mechanism rely on BarcodePrintStatus being called regularly after this call in order to stage the data to the interface Money Controls 2008 All rights reserved Page 101 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 16 10 BarcodePrintStatus 16 101 1 Synopsis This call is used to determine the status of the barcoded ticket printing system long BarcodePrintStatus void 16 101 2 Parameters None 16 101 3 Return Value 7 Mnemonic Value Meaning PRINTER_NONE 0 Printer completely non functional not present PRINTER_FAULT 0x80000000 There is a fault somewhere PRINTER_IDLE 0x00000001 The printer is OK Idle Finished PRINTER_BUSY 0x00000002 Printing is currently taking place PRINTER_PLATEN_UP 0x00000004 PRINTER_PAPER_OUT 0x00000008 PRINTER_HEAD_ FAULT 0x00000010 PRINTER_VOLT_FAULT 0x00000040 PRINTER_TEMP_FAULT 0x00000080 PRINTER_INTERNAL_ERROR 0x00000100 PRINTER_PAPER_IN_CHUTE 0x00000200 PRINTER_OFFLINE 0x00000400 PRINTER_MISSING_SUPPY_INDEX 0x00000800 PRINTER_CUTTER_FAULT 0x00001000 PRINTER_PAPER_JAM 0x00002000 PRINTER_PAPER_LOW 0x00004000 PRINTER_NOT_TOP_OF_FORM 0x00008000 PRINTER_OPEN 0x00010000 PRINTER_TOP_OF_FORM 0x00020000 PRINTER_JUST_RESET 0x00040000 16 101 4 Remarks 1 The mechanics of the priniting mechanism rely on this being called regularly after the BarcodePrint c
26. rapid integration of a variety of payment peripherals into new machine platforms without the need for bespoke software Designed for use in a wide range of applications gt gt gt gt Gaming Amusement Transportation Vending Interfaces protocols supported VVVVV ccTalk 1D003 MDB Master amp Slave Ardac 2 RS232 serial Products supported VVVVVVVVVV VV SR3 Condor Plus Condor Premier SR5 SR5i Ardac Elite Lumina MC7200 Serial Compact Hopper MK2 SCH2 SCH3 Combi Serial Universal Hopper SUH Ardac 5 Serial ticket printer GEN2 MDB Changer Coin Co Vortex Quantum Pro Guardian 1 O supported gt gt gt 16 Outputs 8 High Power 8 Low Power 16 Inputs Serial electronic meter Money Controls 2008 All rights reserved Page 9 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 PayLink Lite allows the connection of a range of payment peripherals but with fewer hoppers than PayLink driven using the ccTalk industry standard protocol Designed for use in a wide range of applications gt Gaming gt Amusement gt Transportation gt Vending Interfaces protocols supported gt ccTalk Products supported SR3 Condor Plus Condor Premier SR5 SR5i Ardac Elite Lumina MC7200 Serial Compact Hopper MK2 SCH2 SCH3 Combi Serial Universal Hopper SUH VVVVVVVVV 1 O supported gt 2 Inputs Money Controls 2008 All rights reserved Page 1
27. system Startup Money Controls 2008 All rights reserved Page 42 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 8 User Manual Revision History Version Date Author Description 0 0 Draft 5 Feb03 D Bush Initial description document A Graham 0 1 Draft 16 Feb 03 D Bush Detail corrections Bug Fixes 0 2 Draft 28 Feb 03 D Bush Changes to Coin Path handling 0 3 Draft 10 Apr 03 D Bush Minor change to SystemStatus 0 4 Draft 30 Apr 03 D Bush Further Changes to Coin Path Handling 1 0 14 Oct 03 D Bush Addition of Meters Various clarifications 1 1 24 Nov 03 D Bush New Meter Functions Changes to details on dispensers 1 2 3 Dec 03 D Bush New E2Prom Functions 1 3 2 Apr 04 D Bush Various Bug Fixes new constants 1 4 9 Aug 05 D Bush Sections added on e Escrow functions e Event Queue e Barcode functions 1 5 8 Mar 06 D Bush Document structure revised Added a number of Usage Details sections 1 10 x Functions detailed 1 6 13 Nov 06 A Tainsh Rewritten the Coin Routing description 1 7 11 Sep 07 D Bush Added description of multiple unit support Money Controls 2008 All rights reserved Page 43 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 9 Introduction 9 1 Purpose of Document This document describes the software interface to the AES Intelligent Money Handling Equipment Interf
28. system32 Drivers FTDZXX sys Timestamp Fri Apr 22 01 00 00 2005 Checking DLL Found at C WINDOWS system3Z2 AesIMHEI d1l Timestamp Fri Apr 04 14 56 16 2008 Version 1 4 0 1 Details on AES Genoa USB Interface Unit AES Intelligent Money Handling Equpiment Interface 6 code version 04010a09 Firmware Release Type Firmware Code Version 1 10 9 Click Done to close the Diagnostics application Money Controls 2008 All rights reserved Page 39 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 7 3 Demo exe This is an API example which also doubles up as a quick and easy way to test demo PayLink before the software writing can begin The application is called Demo exe and is in the following location PayLink SDK Click Acceptors to show the current connected Coin Note acceptors Click Dispensers to show the current connected Hoppers Click Escrow for the Escrow control The Latest Event notifies the application of events that are not to do with money Faults misreads etc Coins and notes entered Aardvark Embedded Solutions Aardvark Intelligent Coin Interface Demonstration Click Switches LEDs to control the Details Inputs outputs Acceptors Switches Leds Dispensers Click Meter to show Meter the current scrow On ount Just Read into the peripherals will be displayed in the Amount Just Read box The Total Amount Read box is the amount read over th
29. using the extended mechanism Where an extended mechanism dispenser is available the individual tubes are pre set to inhibited To perform a normal payout you just issue a PayOut request and call PayStatus and CurrentPaid to monitor the results If you have a level 2 changer CurrentPaid will update almost instantaneously rather than at the end and will always show that all coins have been paid If you have a level 3 changer CurrentPaid will update during the process and you may get a PAY_EMPTY status from PayStatus with CurrentPaid then reflecting the actual payout achieved The current levels of MDB tubes as reported by the coin changer are returned in the field CoinCount In addition the field CoinCountStatus will contain the value DISPENSER_ACCURATE for a normal tube and DISPENSER_ACCURATE_FULL if the changer is reporting the tube as full Note that the levels reported by the changer do not necessarily update in a sensible fashion after a payout Should you wish to perform an operation on a specific tube e g emptying it you should inhibit the extended mechanism dispenser and enable the specific tube you wish to control As the manufacturer is shown in the acceptor detail block for the changer the extended mechanism dispenser has the constant type DP_MDB_TYPE_3_PAYOUT while the individual tubes have the type DP_MDB_LEVEL 2 TUBE Money Controls 2008 All rights reserved Page 69 of 104 PayLink Technica
30. which peripherals are connected 7 Aes Diagnostics DER File Edit Help 1 Pause E Mail N Comment ke Clear FX Copy al EB Save B Print Diagnostic Dutput Peripherals System Information Dispensers on the system are Acceptors on the system are This example Acceptor 0 MCL SRS Default Path 8 Event count 0 Currency lt NO gt 16 coins shows an SR5 Coin Value 50 Count O Path 8 Coin 1 Value 100 Count 0 Path 5 coin acceptor and Coin Value 500 Count Path 7 Hi s Coin 3 Value 1000 Count 0 Path 1 information about Coin Value 2000 Count Path 6 i Coin 5 Value 0 Count Path 8 the coin paths and Coin Value Count Path 8 Coin 7 Value Count Path 8 values etc Coin Value Count Path 8 Coin 9 Value Count Path 8 Coin 10 Value Count Path 8 Coin 11 Value Count Path 8 Coin 12 Value Count Path 8 Coin 13 Value Count Path 8 Coin 14 Value Count Path 8 Coin 15 Value Count Path 8 Show Version Click on the System Information tab to display various system information about PayLink Money Controls 2008 All rights reserved Page 38 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 7 Aes Diagnostics File Edit Help m Pause Diagnostic Output Peripherals System Infornfation AES Intelligent Money Handling Equipment Interface OS Version 5 1 Checking Driver Files Found at C WINDOWS
31. 0 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 2 2 Contents PayLink or PayLink Lite does not come with any cables or software In order to obtain the software CD drivers API please contact your local Money Controls Technical Services Dept The verison of software currently available and released is as follows PayLink Firmware 4 1 10 9 AESWDriver exe 1 1 3 3 Aesimhei dll 1 4 0 2 FTD2XX dll 3 1 8 1 Demo exe 1 1 0 5 MilanDiag exe 1 0 3 6 To obtain a copy of these drivers please contact Technical Services link http www moneycontrols com support technical_support asp PayLink part number APCUSBXX00001 PayLink Lite part number APCUSBXX00003 However Money Controls can provide a development kit which consists of example cables and a software CD but this is only available as a 1 off order Please contact your local Customer Services Dept to place an order Customer Services link http www moneycontrols com support customer_support asp PayLink development kit part number APCUSBXX00002 Money Controls recommend purchasing a development kit in order to aid the integration process in the host machine The contents of the PayLink Development Kit are as follows PayLink 1 X cctalk multidrop cable 2 X SR5 Lumina cable 1 x Ardac Elite ccTalk Cable 1 X SR3 Condor Plus cable 1 X SCH2 cable set to address 4 1 X SUH cable set to address 3 1 X Serial ticket printer cable 1 X Serial meter cable
32. 31 2 Parameters None 10 31 3 Return Value If the Open call succeeds then the value zero is returned In the event of a failure one of the following standard windows error codes will be returned either as a direct echo of a Windows API call failure or to indicate internally detected failures that closely correspond to the quoted meanings Error Suggested string for English Microsoft Mnemonic Retry Number decoding 13 The DLL application or device are at ERROR_INVALID_DATA No incompatible revision levels 20 The system cannot find the device ERROR_BAD_UNIT No specified 21 The device is not ready ERROR_NOT_READY Yes 31 Driver program not running or No PCI ERROR_GEN_FAILURE Yes card in system 170 The USB link is in use ERROR_BUSY Yes 1167 The device is not connected ERROR_DEVICE_NOT_CONNECTED Yes 10 31 4 Remarks 1 With a USB system there is a noticeable time for the USB communications to start This may cause error returns labelled Yes under Retry in the above table This indicates that the call to OpenMHE should be retried periodically until it has failed for at least 5 consecutive seconds before deciding that the interface is actually inoperative 2 Whereas an Open service normally requires a description of the item to be opened and returns a reference to that Item there is only one IMHE Interface unit in a system Hence any Oper call must refer to that single
33. 5 Enablelnterface 10 51 1 Synopsis The Enablelnterface call is used to allow turn on the IMHE This would be called when a game is initialised and ready Until this call is made no acceptors will accept credit void Enablelnterface void 10 51 2 Parameters None 10 51 3 Return Value None 10 51 4 Remarks 1 Normally the application will initialise the saved values of all the information it is monitoring before this call 2 This must be called following the call to OpenMHE before any coins notes will be registered 10 6 Disablelnterface 10 61 1 Synopsis The Disablelnterface call is used to prevent users from entering any more coins or notes void DisableInterface void 10 61 2 Parameters None 10 61 3 Return Value None 10 61 4 Remarks 1 There is no guarantee that a coin or note can not be successfully read after this call has been made a successful read may be in progress OMoney Controls 2008 All rights reserved Page 50 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 10 7 CurrentValue 10 71 1 Synopsis Determine the current monetary value that has been accepted The CurrentValue call is used to determine the total value of all coins and notes read by the money handling equipment connected to the interface long CurrentValue void 10 71 2 Parameters None 10 71 3 Return Value The current value in the lowest denomination of the currency i e cents pence etc of
34. 7 15 23 19 08 2005 09 26 19 08 2005 09 26 19 08 2005 09 26 19 08 2005 09 26 19 08 2005 09 26 04 04 2006 14 00 19 08 2005 09 26 19 08 2005 09 26 18 07 2008 10 16 19 08 2005 09 26 19 08 2005 09 26 19 08 2005 09 26 19 08 2005 09 26 01 11 2006 14 13 01 11 2006 14 13 14 02 2006 10 38 19 08 2005 09 26 PayLink Technical Manual TSP129 Issue 1 5 August 2008 6 Peripheral Features Support 6 1 SR3 Condor Plus SR5 SR5i gt At present only one coin acceptor at address 2 is supported gt A complex system of routing is provided which supports the diversion of coins gt Both individual coins and the entire unit can be easily inhibited gt The automatic retrieval from the unit of the value of each coin is supported 6 2 Lumina gt At present only one note acceptor at address 40 is supported gt PayLink fully supports the ccTalk encryption scheme needed to communicate with Lumina gt Both individual notes and the entire unit can be easily inhibited gt The automatic retrieval from the unit of the value of each note is supported gt The default Lumina 6 digit security code is 123456 To use a Lumina with a different security code an application is provided Luminaserial exe is found in the following directory PayLink SDK Run LuminaSerial exe the following screen will be shown ex Z Product Information Misc Products Paylink PayL ink Distribution CDISDKW uminaSerial exe fx Enter Serial No
35. Connector overview With exaMpleS oooococincccnoncccocccnonnconoccnnnnnnnn cnn nn cnnn nn nn nc nana nn nc cnn cn nnncans 16 Figure 5 PayLink mechanical dimensions cooonncccnnnoniconncccnnnncnnnnnnnnnc rn 17 Figure 6 PayLink Lite mechanical diMEnNsiONS ooocconnncccnnoncccnnnoncnonanncnonon cnn nano nrnnnnn cnn nnnr nc nn nar n nr enn r ner nnr nn n nara nnnnnns 18 Figure 7 PayLink power Interface A Tea 26 Figure 8 PayLink coTalk interface cional apa ae a EAEE 26 Figure 9 Lumina SR5 ccTalk interface osisssa inienn aiia ie rtedec de 27 Figure 10 SR3 Condor Plus ccTalk interface c eeccececeeeeeeeeeeeeeeeeeneeeeeeeeeseeeeeeeeeeeeseaeeesaeeseaeeseaeeseeeeeeeesieeeeaeeees 27 Figure 11 SCH2 ccTalk interface Figure 12 SUH ccTalk interface cniinne a nei Figure 13 PayLink IDOO3 Ardac 2 interface ooooooccccnnocccononoccnononcncnnnoncnnnnno conoser o unuttu nnt nan r nn nn nar n rre nar nr ener nrn nana nenas 28 Figure 14 Ardac 5 ID003 Ardac 2 interface oooooncccnnonccononcccnononcnnnnnannonnnnononnnonn rr naar nrn rra n rr rra n rre ran nr rr nr n rn nnnr arenas 28 Figure 15 Connector 4 High power outputs ocooccconccccooccconcnononcnonancnnncnnnoncnnnn nana nc nn n nana n carr rra rear n cn nnn anne rc rncnnnncnns 29 Figure 16 Connector 6 Low power OUtDUIS ooocococccccccconcccnncccnncncnncncnnnnnoncc nono n cnn nn cnn nn ran n rra n rra n naar ranma nan r cnn nnnnnncnns 29 Figure 17 Connector 10 Switches I
36. D 7 Bill jammed in stacker OUTPUT_PROBLEM 8 Bill pulled backwards FRAUD 9 Bill tamper FRAUD 10 Stacker OK OUTPUT_FIXED 11 Stacker removed OUTPUT_PROBLEM 12 Stacker inserted OUTPUT_FIXED 13 Stacker faulty OUTPUT_PROBLEM 14 Stacker full OUTPUT_PROBLEM 15 Stacker jammed OUTPUT_PROBLEM 16 Bill jammed in transport safe mode JAM 17 Opto fraud detected FRAUD 18 String fraud detected FRAUD 19 Anti string mechanism faulty INTERNAL_PROBLEM Money Controls 2008 All rights reserved Page 83 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 12 115 CCTALK HOPPER PROCESSING This is divided into two parts the processing associate with reporting the ongoing ability of a functioning hopper to pay out coins and that associated with checking that the hopper is operational Both of these require a Test Hopper command to be sent to the unit but the reporting mechanism is different The ongoing ability to pay out is reported as the Status field in the dispenser block the results of the regular check are reported as self test events Note that when a Payout is issued the results of the self Test are ignored the dispense coins command is dent to the hopper regardless On a regular basis the Test Hopper command is sent to the each hopper and the result evaluated After start up and regularly thereafter a IMHEI_COIN_DISPENSER_NOW_OK is reported if there are no errors The defined return
37. Functional block diagram Note Acceptor Coin Acceptor Hopper Switches Diagnostics amp amp Buttons System Info Money Controls 2008 All rights reserved Page 14 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 3 3 Connector Overview Below is an overview of each connector on PayLink Figure 3 PayLink Connector overview with examples MDB Device Serial meter High power Switches Door float RS232 Ardac5 Download 12V DC Ticket printer Power in Switches Low power Door float LEDs yww moneycontrols com 7 RS232 RJ45 connector type ccTalk USB Type B connector Ardac 5 note acceptor ccTalk peripherals Connects to the USB Type A connector on the PC Money Controls 2008 All rights reserved Page 15 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 Figure 4 PayLink Lite Connector overview with examples 2 Switches Red On Red Off isa j a Not Used Green Off Green Flashing 12V DC Power in Serial Number Model Number USB Type B connector Connects to the USB Type A ccTalk connector on the PC ccTalk peripherals Money Controls 2008 All rights reserved Page 16 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 3 4 Mechanical Dimensions Figure 5 PayLink mechanical dimensions
38. K 1 No Meter has ever been found METER_MISSING 2 The Meter is no longer functioning METER_DIED 3 The Meter is functioning but is itself METER_FAILED reporting internal problems 14 61 4 Remarks None Money Controls 2008 All rights reserved Page 93 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 14 7 MeterSerialNo 14 71 1 Synopsis The MeterSerialNo call is used determine which item meter equipment is connected long MeterSerialNo void 14 71 2 Parameters None 14 71 3 Return Value The 32 bit serial number retrieved from the meter equipment 14 71 4 Remarks 1 Where the meter equipment is not present or does not have serial number capabilities zero is returned Money Controls 2008 All rights reserved Page 94 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 15 E Prom Included in the IMHEI card is E7PROM memory which is used by the embedded process to maintain counters etc 256 bytes of this E7PROM is available to users to store essential information if they wish to run their system with no other writeable storage In this section routines are described to access this user storage and to allow for a user application to clear all the EPROM memory on the card after testing and before delivery to an end user 15 1 E2PromReset 15 11 1 Synopsis The E2PromReset call is made by the PC application software to clear all the internal E7PROM memory on the card
39. Manual TSP129 Issue 1 5 August 2008 5 4 PayLink Auxiliary input output interface Figure 15 Connector 4 High power outputs 2 20 19 12V 12V NC 12V 12V 12V 12V 12V Key 12V 0 1 2 3 N C 4 N C 5 6 7 Figure 16 Connector 6 Low power outputs 2 20 0000000000 1 000 000080 FF 12V 12V N C 12V 12V 12V 12V 12V N C 12V 8 9 10 11 Key 12 N C 13 14 15 Figure 17 Connector 10 Switches Inputs 2 20 1 19 OV OV Key OV OV OV OV OV N C OV 0 1 2 3 N C 4 N C 5 6 7 Figure 18 Connector 12 Switches Inputs OV OV N C OV OV OV OV OV N C OV 8 9 10 11 N C 12 Key 13 14 15 Money Controls 2008 All rights reserved Page 29 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 Table 4 VO Interface Pin Conn 4 Conn 6 Conn 10 Conn 12 1 Output 0 Output 8 Input O Input 8 2 12V 12V OV OV 3 Output 1 Output 9 Input 1 Input 9 4 12V 12V OV OV 5 Output 2 Output 10 Input 2 Input 10 6 N C N C KEYWAY N C 7 Output 3 Output 11 Input 3 Input 11 8 12V 12V OV OV 9 N C KEYWAY N C N C 10 12V 12V OV OV 11 Output 4 Output 12 Input 4 Input 12 12 12V 12V OV OV 13 N C N C N C KEYWAY 14 12V 12V OV OV 15 Output 5 Out
40. NPUtS oconocconocconociconacinoncnonononnncnnnoconnn nano nc nn n nana nc nn cnn nn nn cana ncnrncnanncnns 29 Figure 18 Connector 12 Switches INDUtS ooonocconncccnociconaccnocnnonaconnncnnnn non nnnnnnn conc nnnnn cnn rra arena nn cana n nar nc ranas 29 Figure 19 PayLink Lite Switch INPUTS isc aaa Tes sa raitea staet 30 Figure 19 PayLink RS232 Serial Printer Interface ecceeceeeeeeeeeeeeeeeeeeeeeseeeeseaeeseaeeseaeeseaeeseaeeseaeeeeeesieeeeeeees 31 Figure 20 PayLink serial meter interface ooooooccononccccnnoccnonancncnononcnnnnnon cnn nnn ocn naar nr e rnnen rn rra r rr rene n rre ran n nn rr nnn rra nana nenas 31 Figure 21 MDB Slave interface einion eaa eea eaaeo aaa a aan aaraa a e eadera E aeaaaee deaan 32 Tables Table 1 Electrical Specification Pay LinKyestiie sei ioen iaren iiaaaeaoe eiaa aeoaea a aae 19 Table 2 Electrical Specification PayLink Lite 2 0 0 eee cceeeeeeeteneeeeeeeteeeeeeeeceaeeseaeeseaeeseaeeseaeeseaeesiaeeseeeeseaeeneeeensas 19 Table 3 Status LED table iii tai ia di ai 20 Table 3 V O Interface ui A a ae 30 Table 4 Hopper address Wiring amp Coin Values oooococinnicinnccincccnonnconancnnnncnnnncnnn ccoo n cnn nacen crac 34 Money Controls 2008 All rights reserved Page 7 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 1 Diary of Changes Issue 1 0 gt Issue 1 1 VVVVV Issue 1 2 v Issue 1 3 VVVVVVVVV Issue 1 4
41. PayLink Technical Manual TSP129 Issue 1 5 August 2008 So o Money Controls PayLink Technical Manual coTalk MDB picid USB Connection i 0O E a Buttons y Switches Serial i N Status LEDs Printer Serial Lamp Drivers Others Meter This document is the copyright of Money Controls Ltd and may not be reproduced in part or in total by any means electronic or otherwise without the written permission of Money Controls Ltd Money Controls Ltd does not accept liability for any errors or omissions contained within this document Money Controls Ltd shall not incur any penalties arising out of the adherence to interpretation of or reliance on this standard Money Controls Ltd will provide full support for this product when used as described within this document Use in applications not covered or outside the scope of this document may not be supported Money Controls Ltd reserves the right to amend improve or change the product referred to within this document or the document itself at any time OMoney Controls 2008 All rights reserved PayLink Technical Manual TSP129 Issue 1 5 August 2008 Contents 1 DiarysOt CHANGES AAA PP 8 PA A O de Sictets fevesnacet vet A dcwacbiscvoasids Mescabs don Naszeusucszcedcind ences E E A tatees 9 2 1 TATHOCIUICTION pt ost es oa AO Anke da nd a SMart BS SM Sees dela o A A LAs ate e A oe 9 2 2 A A ee a re eae 11 Biy A T TA A AO 13 3 1 PayLink Fun
42. Paylih Intelligent Checksum 30d4b122a RSZ3Z ID OG3 only Copy all this copies the shown text to clipboard Mail this opens the default mail client so that the information can be e mailed oney Handling Equipment Save This saves the text in a log Diagnostic Oytput file Exec Clicking the Comment button allows a co appear Comment Enter the comment below DP App task took 68 msec Print This prints the current text went to be added the following screen will A comment will then appear in the diagnostics window Money Controls 2008 All rights reserved Page 37 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 Clicking on the Show Version button will show the following screen 7 Aes Diagnostics File Edit Help m Pause Ke Clear System Information Mail F Copy All Diagnostic Output Print Peripherals This is the firmware of PayLink Milan Paylink 12 24 16 090 Ver 004 001 010 009 Aug 14 2008 15 09 56 12 24 16 090 Intelligent Money Handling Equipment 12 24 16 150 Checksum 33e73f93 Ue oe a gt 12 24 16 150 New USB protocol RS232 ID 003 only This indicates whether Paylink 12 24 16 150 Diagnostic Output i i Exec DP App task took 64 msec IS programmed with ID003 or Ardac 2 protocol compatible firmware see section 6 8 Ardac 5 for more info Click on the Peripherals tab to see
43. S_ELECTRONICS 0x00000300 DP_MANU_AZKOYEN 0x00000400 DP_MANU_NRI 0x00000500 DP_MANU_ICT 0x00000600 DP_MANU_JCM 0x00000700 DP_MANU_GPT 0x00000800 DP_MANU_COINCO 0x00000900 DP_MANU_ASAHI_SEIKO 0x00000A00 DP_MANU_ASTROSYSTEMS 0x00000B00 y enum ManufacturerSpecificDeviceTypes These device types are manufacturer dependent so that each manufacturer can have up to 255 known devices DP_SPECIFIC_DEVICE_MASK 0x000000ff Money Controls Devices DP_MCL_SCH2 1 DP_MANU_MONEY_CONTROLS DP_CCTALK_INTERFACE DP_COIN_PAYOUT_DEVICE Please see the latest AESIMHEI H file in the SDK for an up to date list of these Asahi Seiko Devices DP_AS_WH2 0 DP_MANU_ASAHI_SEIKO DP_CCTALK_INTERFACE DP_COIN_PAYOUT_DEVICE 11 3 CurrentUpdates 1 10 4 11 31 1 Synopsis Detect updates to the data presented to the API by the firmware The fact that the value returned by CurrentUpdates has changed prompts the application to re examine all the variable data in which it is interested long CurrentUpdates void 11 31 2 Parameters None 11 31 3 Return Value Technically CurrentUpdates returns the number of times that the API data has been updated since the PC system initialised In practice only changes in this value are significant 11 31 4 Remarks 1 Itis possible that the value could change without any visible data changing 2 This is only available with the DLL associated with firmw
44. UT_FIXED HEI RNAL_ERROR T INTERNAL_PROBLEM HET_ E_UNCLASSIFIED_EVENT T UNKNOWN Coin Dispenser HEI_COIN_DISPENSER_NOW_OK COIN_DISPENSER_EVENT FAULT_BIT NOW_OK HEI_COIN_DISPENSER_REPORTED_FAULT COIN_DISPENSER_EVENT FAULT_BIT REPORTED_FAULT HEI_COIN_DISPENSER_TIMEOUT COIN_DISPENSER_EVENT FAULT_BIT UNIT_TIMEOUT HEI_COIN_DISPENSER_RESET COIN_DISPENSER_EVENT FAULT_BIT UNIT_RESET HEI_COIN_DISPENSER_SELF_TEST_REFUSED COIN_DISPENSER_EVENT FAULT_BIT SELF_TEST_REFUSED HEI_COIN_DISPENSER_FRAUD_ATTEMPT COIN_DISPENSER_EVENT FRAUD HEI_COIN_DISPENSER_UPDATE COIN_DISPENSER_EVENT DISPENSE_UPDATE OMoney Controls 2008 All rights reserved Page 81 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 12 113 CCTALK COIN PROCESSING 12 113 1 Fault Events During start up the ccTalk command Do self Test is sent to the acceptor The response is queued as an event with the first byte of the response in RawEvent and an EventCode type of IMHEI_COIN_NOW_OK or IMHEI_COIN_UNIT_REPORTED_FAULT If the unit is reset the sequence number is found to be zero or repeated messages are ignored IMHEI_COIN_UNIT_RESET or IMHEI_COIN_UNIT_TIMEOUT event is queued Whenever any of these faults have been reported the handler will continually poll the acceptor with Do Self Test commands until a non faulty response is returned 12 113 2 Coin Events When the acceptor reports an event ot
45. a ici TODIT SVNOPSIS tii A ia 10 512 ParaMelelS noia colinas di ldccadana dnd dias dead do dr ida dsd 10 51 3 Return Value 10 51 4 ROM a A AA is 10 6 Disablelntertace iis iii disc IES e A weet tas aac taci essa tesa rae cea aw ie gosaat Ea TAAA ae AAAA AAO A E E AEE EAE EA aAA Ta TEENA Money Controls 2008 All rights reserved Page 2 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 11 10 612 PAlAMCTOlS n nakeranan A e A A AA AA DARA adi 10 61 3 Return Value 10 61 4 Remarks 10 7 CurrentValue a VOT UT IS OOPS iii ii Hess tase ria E aa daveersands tati I E acia MOTTEDS RUANO AS a az 10 71 3 Return Value 10 71 4 Remarks vie O A A AN TOBIAS ESOO ii a dt EE EA EAR 10 81 2 Parameters 10 81 3 Return Value 10 81 4 Remarks ere WO 9 rPayStatus cA E O ON IES le A RO AT T ANN 10 91 2 Parameters p 10 91 3 Return Values sit wat eh 10 914 A A A NN 10 10 CurrentP alacant e Ds le At E E io 10 101 1 SYNOPSIS oo 10 101 2 Parameters 10 101 3 Return Value whet re 10 101 4 Remarks oi ia tad VE A tered eee devant ane ey alanis ee ee eae 10 11 IndicatorOn INdiGatOrOThe cocina tal thawed ct tada data 53 10 111 1 SYNOPSIS cooconcccacccnccnnos 10 111 2 Parameters vis evs Gad 10 111 3 A A ao loci 10 12 SwitchOpens SwitChClosSes aeei eee aenaran aoa oraaa aiaa asiasana kainai ne rn nnn nn k iare inanon i
46. ace IMHE as seen by a software engineer writing in either the C or C programming languages on the PC 9 2 Intended Audience The intended audience of this document is the software engineers who will be writing software on the PC that will communicate with the IMHE card itself or will read the monetary information or diagnostic information provided by the card 9 3 Document Layout The document itself is split into a number of sections Within each section there are three sections e Operational Overview Where the way in which this area is intended to work is explained e Function Definitions Where you will find exact details on each function call e Usage Details This gives details on exactly how the IMHEI system operates The first two sections are intended to reflect different levels of complexity at which an initial game programmer may wish to use the interface 1 Getting Started These are the minimum set of vanilla functions that may be used to get a working demonstration program running Using these calls alone the software engineer can write a working program and get a feel for the ease with which he can now communicate with the Money Handling Equipment attached to his game 2 Full Game System These build on the set of functions provided within the Getting Started section They add functionality that can determine the status of the peripherals attached to the interface card By these status analysis f
47. all in order to stage the data to the interface until PRINTER_BUSY is no longer returned 2 Any reported fault that requires an operator action will cause the PRINTER_FAULT bit to be set 3 A PRINTER_NONE status will be reported if the printer is powered off after having been working OMoney Controls 2008 All rights reserved Page 102 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 17 Engineering Support It is not envisaged that games programmers will use these particular functions They are included here for completeness but can be ignored if you are just interfacing game software to a collection of standard peripherals 17 1 WritelnterfaceBlock 17 11 1 Synopsis The WritelnterfaceBlock call sends a raw block to the specified interface There is no guarantee as to when in relation to this regular polling sequences will be sent except that while the system is disabled the interface card will not put any traffic onto the interface void WriteInterfaceBlock long Interface None void Block long Length 17 11 2 Parameters Interface The serial number of the interface that is being accessed Block A pointer to program buffer with a raw message for the interface This must be a sequence of bytes with any addresses and embedded lengths required by the peripheral device included Overheads such as standard checksums will be added by the IMHEI Length The number of bytes in the
48. amp Switches Switches h 0 A E 7 Meter information about the connected Dispensers is shown ies Click on the Switches LEDs SLED button to see the following Led screen 0 1 Click on the Led buttons to drive the LED output The switch box will light when the switch inputs are activated Click on the Meter button to show Metering this screen The counter can be Meter 050712FB Status OK incremented using the Increment Counter button Just Counter REFILL C Show Caption m Click on th e Barcodes button to show the following screen Bar Code System When a barcode is inserted the ali hl number will be shown here Click Tees Accept ticket or Return ticket to 5337798 E J proceed Return Ticket Last Ticket Stacked Count 475962575587710231 1 Barcode printer status No printer OA The barcodes screen can be exited ca penc using the Bar Codes Off button Numeric amount Date Time Machine 55 00 02 03 05 23 59 59 123456 Barcode value 12345678901 2345678 Bar Codes OF Money Controls 2008 All rights reserved Page 41 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 7 4 Upgrading PayLink firmware PayLink has an on board flash device which can be reprogrammed using a small application through the USB link The application is found in the following directory PayLink PayLink Firmware The following parameters
49. apability It is the system designer s responsibility to use captions that are within the meter hardware s capabilities 2 Ifthe counter specified is higher than the highest supported then the call is silently ignored 3 The specified caption is not stored in the meter even if the meter offers this facility Money Controls 2008 All rights reserved Page 91 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 14 3 CounterRead 14 31 1 Synopsis The CounterRead call is made by the PC application software to obtain a specific counter value as stored by the meter interface long CounterRead long CounterNo 14 31 2 Parameters 1 CounterNo This is the number of the counter to be incremented 14 31 3 Return Value The Value of the specified meter at system start up 14 31 4 Remarks 1 If the counter specified is higher than the highest supported then the call returns 1 2 If the counter external hardware does not support counter read out then this will return the total of all increments since PC start up 3 If error conditions prevent the meter updating this call will show the value it should be at not its actual value The value is read only read from the meter at system start up 14 4 ReadCounterCaption 14 41 1 Synopsis The ReadCounterCaption call is used to determine the caption for the specified counter char CounterCaption long CounterNo 14 41 2 Parameters 1 CounterNo This is the numb
50. are versions 1 10 8 and higher Money Controls 2008 All rights reserved Page 62 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 11 4 ReadAcceptorDetails 11 41 1 Synopsis The ReadAcceptorDetails call provides a snapshot of all the information possessed by the interface on a single unit of money handling equipment bool ReadAcceptorDetails long Number AcceptorBlock Snapshot 7 11 41 2 Parameters 1 Number The serial number of the coin or note acceptor about which information is required 2 Snapshot A pointer to a program buffer into which all the information about the specified acceptor will be copied 11 41 3 Return Value True if the specified input device exists False if the end of the list is reached 11 41 4 Remarks The serial numbers of the acceptors are contiguous and run from zero upwards 11 5 WriteAcceptorDetails 11 51 1 Synopsis The WriteAcceptorDetails call updates all the changeable information to the interface for a single unit of money accepting equipment void WriteAcceptorDetails long Number AcceptorBlock Snapshot 7 11 51 2 Parameters 1 Number The serial number of the coin or note acceptor being configured 2 Snapshot A pointer to a program buffer containing the configuration data for the specified acceptor See below for details 11 51 3 Return Value None 11 51 4 Remarks The serial numbers of the acceptors are contiguous and run from zero upwards
51. ation software to obtain all or part of the user E PROM from the card void E2PromRead void UserBuffer long BufferLength 15 31 2 Parameters 1 UserBuffer This is the address of the user s buffer into which the current contents of the user E7PROM area are copied 2 BufferLength This is the count of the number bytes to be transferred If this is greater than 256 the extra will be silently ignored 15 31 3 Return Value None 15 31 4 Remarks 1 Unwritten E Prom memory is initialised all one bits Writes performed by E2PromWrite will be reflected immediately in the data returned by this function regardless of whether or not they have been committed to E7Prom memory Money Controls 2008 All rights reserved Page 96 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 16 Bar Codes Where an acceptor provides barcode facilities the IMHEI card fully support this by enabling bar code acceptance and reporting the barcodes read Barcode reading is always handled using the Escrow position on the acceptor The barcode is held in the acceptor pending a call from the application the either stack or return it In most systems only one barcode capable acceptor will be present the IMHEI card will however support barcodes on an unlimited number of acceptors In order to allow for accurate information and control to pass between the game and the IMHEI firmware the barcode reported is limited to a single acceptor at
52. ay be added Any response other than STANDARD_DRIVER should be regarded as indicating that the system is not currently functional Money Controls 2008 All rights reserved Page 77 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 12 9 USBDriverExit 12 91 1 Synopsis The USBDriverExit call allows a control application to request that the USB driver program exits in a controlled manner void USBDriverExit void 12 91 2 Parameters None 12 91 3 Return Values None 12 91 4 Remarks This sets the USBDriverStatus to DRIVER_RESTART Driver programs with version 1 0 3 1 or greater will report their exit by changing the USBDriverStatus to USB_IDLE For PCI systems this is obviously meaningless and has no effect Money Controls 2008 All rights reserved Page 78 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 12 10IMHEIConsistencyError 12 101 1 Synopsis The IMHEIConsistencyError call allows an application to check that a transient hardware error has not caused corruption of the underlying data structures used to hold the current monetary situation Although the use of state tables removes the vulnerability of the system to time problems it increases its vulnerability to expensive hardware errors which could falsely indicate very large money increments char DLL IMHEIConsistencyError int CoinTime int NoteTime 12 101 2 Parameters None 1 CoinTime Default STANDARD_COIN_TIME
53. char CompileDate char CompileTime 12 71 2 Parameters 1 CompileDate This is a pointer to a 16 byte area that receives a null terminated printable version of the date on which the firmware was installed 2 CompileTime This is a pointer to a 16 byte area that receives a null terminated printable version of the time at which the firmware was installed 12 71 3 Return Values The firmware version as a 32 bit integer This is normally shown as 4 x 8 bit numbers separated by dots 12 71 4 Remarks Either or both of the character pointers may be null 12 8 USBDriverStatus 12 81 1 Synopsis The USBDriverStatus call allows an interested application to retrieve the status of the USBDriver program for PayLink system USBStatus DLL USBDriverStatus void 12 81 2 Parameters None 12 81 3 Return Values Mnemonic Value Meaning NOT_USB 1 Interface is to a PCI card USB_IDLE 0 No driver or other program running STANDARD_DRIVER The driver program is running normally FLASH_LOADER The flash re programming tool is using the link MANUFACTURING_TEST The manufacturing test tool is using the link DRIVER_RESTART The standard driver is in the process of exiting restarting oA OO PO USB_ ERROR The driver has received an error from the low level driver 12 81 4 Remarks 1 For PCI systems this is obviously meaningless and the system returns NOT_USB 2 Be aware that further error statuses m
54. ctional block diagraM ooooconocccc noncccnononcnonanancnnnorononnnn cnn nnno cnn nn n nr nr nr nr rr r rre 13 3 2 PayLink Lite Functional block diagram oooocoooccccnnoocncnanononononcnonnnan non nnnnnnnnnon cnn naar n nn rnr nn rra rr rnnr rra 14 3 3 COMECIONOVE VIEW rra iio 15 3 4 Mechanical DIMENSIONS vis iccccsccceecdacsaceevsecevecdelinaseveavdecidicsavesuecebsbandsusabadactegusvssdsadcbaceevoasseauabiavgvessedeance 17 3 5 Electrical Specification ld 19 Gs AR O 20 4 1 Hardware INStallation ico cirio drid rica its deta cad dc ta dada savdscbecateuuddvadeeaee 20 4 2 Soltware InstallatOM mi icon A Ass Se as Sa AEAEE 24 AAA nn save EAEAN KAEWA AEAN KA cos 26 5 1 RoWer IMGT ACC ta a o o e o a Be 26 5 2 COT AIK ANTEHAGE cimil iia 26 5 3 IDOO3 Ardac 2 interface occcccccccononcccnnncnonononnnnnnnnnonononnnennnnnonononnrrnnnnnnnnnrrnnnnnnnnnnnnrrrnnnnnnnnnnnrrnnnnnnnnanonanoos 28 5 4 PayLink Auxiliary input output interface oooooooccccnnonccononcncnononnnonnnrn cnn nnro non nnn nr rr nr nr rr nr ran 29 5 5 PayLink Lite input interface conca api 30 5 6 S rial printer interaccion 31 5 7 Serial Meter iNtemace s ceice ccccec ds adas 31 5 8 MDB Device interface occcccccccoonnnccnnncnocononcncnnnnononononnnnnnnnnnnnrrnnnnnnnnnnnnrrrnnnnnnonnnnrrnnnnnnnonnnnrrnnnnnnonenonarennnnns 32 5 9 AAA sede A A L A A T ed ioe taves A N 32 6 Peripheral Features Support momia 33 6 1 SR3 Gondor Pl s SR5 SRBi koreera etenoa cevessciesvenevs lt tyets
55. ddssadeedieavsacbanasciessstuath ccsaedinededacedees fousedberees 33 6 2 MN o o e reer he abad li e o so el datos 33 6 3 CC Talk hoppers iii oi odia 34 6 4 AA A o A E 35 6 5 Setialiticket printer ostia aaa raaa TaT 35 6 6 MDB DOV ICC scsi te tddi atienda 35 6 7 OO 35 6 8 Outputs acia ii its Dati 35 6 9 ALE O AN ON 35 La Using Payliink vi iiiiinietescisavatcteccnscinvsseusedrsccucenstuevecisngusdesntetdvasecsiddaecceananuerdaunaeisesdvacgantusaiesedecsdtciereanvesiavaauades 36 7 1 NAS IAS ee 36 7 2 MilanDiag X irnn it ciepetin ernest a EEN 37 7 3 Demo exe 7 4 Upgrading PayLink firmMWare oooococcnonccnnnsoccccnnccnnnnoncncnn nn nr 42 8 User Manual Revision History onnnnnnncccnnnnccnnncccrccrcnrrr cre 43 Di INTO UC OA ii aca 44 9 1 Purpose of DOCUMENT ceive aioe dee ee eis eerie 44 9 2 INTENGEG AUGIENGE Stic rana iii 44 9 3 Document Cayo t orea taty n e a Eco 44 10 Getting tar enea cach eaaa aeara aE aa aa aaraa aaa Eaa E aAa AAACASA Saai EEEa iaia 10 1 Installation a a a rE 1032 Operativa id da ec ead ene ed dy 10 3 OpenMHE ius tante Sen teat 10 31 1 Synopsis 1312 Para Mel oi a ins Nodos 10 31 3 Return Value 10 314 Remake e Sshe cdsedesiaanetheaannadseaieeninessdevds gatvalnes 10 4 OpenSpecificMHE ec eceeeeeceneeeeeeeeeeeeeeneeeeeeeeeeeseeeseeetieeeeneees 10 411 SYNOPSES eaan aaa aaa EEEa E EEA EAAS 10 412 E AT 10 41 3 Return Value TOV FROMALKS otha A OR RT 10 5 Enablelnteriace cusco di iii id
56. dor Plus ccTalk interface 12V DC O PIN 1 NC O GND O DATA O i Figure 11 SCH2 ccTalk interface tPin4 Note This is NOT the conventional position of pin 1 Pin Function Pin Function 1 Address select 3 MSB 6 7 OV 2 Address select 2 8 ccTalk data line 3 Address select 1 LSB 9 N C 4 5 Vs 10 RESET The address selection process is covered in Section 6 3 Money Controls 2008 All rights reserved Page 27 of 104 PayLink Technical Manual TSP129 Figure 12 SUH ccTalk interface Issue 1 5 August 200 View of Base plate Connector from Rear 9 5 1 10 6 2 i MKII Cinch 11 7 3 Plug 12 8 4 Pin Function Pin Function 1 OV 8 Address Select 2 2 3 N C 9 Vs 4 Address Select 1 LSB 10 11 N C 5 ccTalk data line 12 Address Select 3 MSB 6 7 N C The address selection process is covered in section 6 3 5 3 1D003 Ardac 2 interface Figure 13 PayLink IDOO3 Ardac 2 interface 87654321 Figure 14 Ardac 5 IDOO3 Ardac 2 interface Pin Ardac5 Function 2 Rx Violet 3 TX Yellow 7 GND Green Pin PayLink Function 3 Rx Green White 4 TX Blue 2 GND Orange Ardac 5 25 Way D type Female Connector Important This view is from the mating side Money Controls 2008 All rights reserved Page 28 of 104 8 PayLink Technical
57. during payout Information only 17 Unknown coin type paid Fault 18 Pin number incorrect Fault 19 Incorrect cipher key Fault 20 Unused Information only 21 Unused Information only 22 Unused Information only 23 Unused Information only 24 Unused Information only 25 Unused Information only 26 Unused Information only 27 Unused Information only 28 Unused Information only 29 Unused Information only 30 Use other hopper Information only PAY_NOT_EXACT 31 Opto fraud Fraud PAY_FRAUD Money Controls 2008 All rights reserved Page 85 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 12 116 ID 003 NOTE PROCESSING 12 116 1 Fault Events There is no specific self test command with ID 003 the acceptor reports faults in response to a poll When the protocol handler completes its initialisation the first idle response is reported as IMHEI_NOTE_NOW_OK When a FAILURE response to a status poll is received this is reported as an IMHEI_NOTE_UNIT_REPORTED_FAULT event A failure status is expected to be continually reported by the acceptor until it is cleared When the acceptor again reports IDLING then an IMHEI_NOTE_NOW_OK event is reported Other non normal responses to a status poll are reported as events as they are receive according to the table below In a similar way to the action for faults OUTPUT_FIXED is reported when events that translate to OUTPUT_PROBLEM are cleared
58. e but this doesn t form part of the algorithms by which the application manages the peripherals 12 111 STRUCTURE FOR EVENTDETAILBLOCK typedef struct long EventCode The code the same as rturned by NextEvent long RawEvent The actual code returned by the peripheral long DispenserEvent True if the device was a dispenser False for an acceptor long Index The ReadxxxBlock index of the generating device EventDetailBlock 12 112 EVENT CODES FOR NEXTEVENT EVENTDETAILBLOCK Event codes have an internal structure allowing cateogizations The bottom 6 bits are the unique code for the event serious fault related codes have bit 5 set Above this are bits describing the type of unit affected enums to allow this categoisation to be acheived enum EVENT_CODE_MASK 0x03f UNIT_TYPE_MASK 0x03f FAULT_BIT 0x020 COIN_DISPENSER_EVENT 0x040 NOTE_DISPENSER_EVENT 0x080 COIN_EVENT 0x0C0 NOTE_EVENT 0x100 y The common base codes enum EVENT_OK Internal use only EVENT_BUSY Internal use only REJECTED INHIBITED MISREAD FRAUD JAM JAM_FIXED RETURN OUTPUT_PROBLEM OUTPUT_FIXED INTERNAL_PROBLEM UNKNOWN DISPENSE_UPDATE Fault codes NOW_OK 0 REPORTED_FAULT UNIT_TIMEOUT Money Controls 2008 All rights reserved Page 80 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 UNIT_RESET SELF_TEST_REFUSED E The actual Ful
59. e acceptor and comparing the coin name Coin CoinName with that of the token 11 10 Dual Currency Handling Coin Ids 1 11 x If an acceptor is being used to accept coins of more than one currency the application can determine the currency of a specific coin by examining the first two characters of the name of the coin Coin CoinName For supported acceptors the firmware guarantees that a coin name will always contain a currency code as the first two characters of a coin name ccTalk This contains up to eight characters as returned by the Request Coin Id 184 command ID 003 This contains a representation of the three bytes as return by the Get Currency Assignment 0x8A command The first two bytes are the hex value for country code then a then the base value as a decimal number followed by a then the count of extra zeros as a decimal number MDB TBD GPT TBD ARDAC The Ardac protocol does not return any information about notes Money Controls 2008 All rights reserved Page 65 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 11 11 Read out of Acceptor Details 1 11 x Different protocols manufacturers provide different details on acceptors The Acceptor Description field is generated as follows ccTalk The replies to e Request Currency Specification ID 91 e Request Currency Revision 145 e Request Software Revision 241 e Request P
60. e lifetime of the PayLink This drop down menu shows the acceptors connected Click Disable to disable the acceptor selected Disable No sentto path Level to switch at Acceptors connected Serial Bar Codes Meter Payout Click Barcodes to 2 00 control the barcode features Ardac 5 Serial ticket Acceptor 1 MCL SR Sta Types Handled 12 Default Path 0 Unit Address 2 Reject Count 0 50 20 Count X printer The Payout box shows the value to be paid out Click the Pay It button to pay out the desired value Paylink will decide how to pay out the value depending on which value hoppers are connected The Total Amount Paid Out shows the amount paid over the lifetime of the PayLink Interface 12 Currency GB Coins Notes 10 0 5 Routed path Default path 0 2 0 0 0 0 0 1 0 0 0 No in Escrow 0 Inhibit Click Done to return to the front screen 4 0 0 0 0 0 4 0 0 D 0 Money Controls 2008 All rights reserved Page 40 of 104 Various information about the selected acceptor such as currency coins programmed etc PayLink Technical Manual TSP129 Issue 1 5 August 2008 7 Dispensers Click on the Dispensers Value Address Coins Paid Contents Status Inhibit button and this screen will MCL Serial Compact Hopper 50 4 69 Low Idle OK be shown Various 2 Leds
61. e the interface via which this device is connected DP_INTERFACE_MASK Ox00ff0000 DP_INTERFACE_UNIT 0x00000000 DP_ONBOARD_PARALLEL_INTERFACE 0x00010000 DP_CCTALK_INTERFACE 0x00020000 DP_SSP_INTERFACE 0x00030000 DP_HII_INTERFACE 0x00040000 DP_ARDAC_INTERFACE 0x00050000 DP_JCM_INTERFACE 0x00060000 DP_GPT_INTERFACE 0x00070000 DP_MDB_INTERFACE 0x00080000 DP_MDB_LEVEL_3_INTERFACE 0x00080000 DP_MDB_LEVEL_2_INTERFACE 0x00090000 Some Generic Identities DP_ID003_NOTE 0 DP_JCM_INTERFACE DP_NOTE_ACCEPT_DEVICE DP_MDB_LEVEL_2 0 DP_MDB_LEVEL_2_INTERFACE DP_COIN_ACCEPT_DEVICE DP_MDB_LEVEL_3 0 DP_MDB_LEVEL_3_INTERFACE DP_COIN_ACCEPT_DEVICE DP_MDB_LEVEL_2_TUBE 0 DP_MDB_LEVEL_2_INTERFACE DP_COIN_PAYOUT_DEVICE DP_MDB_TYPE_3_PAYOUT 0 DP_MDB_LEVEL_3_INTERFACE DP_COIN_PAYOUT_DEVICE DP_MDB_BILL 0 DP_MDB_INTERFACE DP_NOTE_ACCEPT_DEVICE DP_CC_GHOST_HOPPER 255 DP_CCTALK_INTERFACE Used by Value hopperz DP_COIN_PAYOUT_DEVICE y define GET_INTERFACE code code gt gt 16 amp Oxff Money Controls 2008 All rights reserved Page 61 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 enum Manufacturerldentities These describe the manufacturer of the device DP_MANUFACTURER_MASK 0x0000ff00 DP_MANU_UNKNOWN 0x00000000 DP_MANU_MONEY_CONTROLS 0x00000100 DP_MANU_INNOVATIVE_TECH 0x00000200 DP_MANU_MAR
62. eeeessseaeeeeeeeeseseessaeeeeeesessessaeeeees PR SYNOPSIS T a ERa RNE 12 81 2 Parameters 12 81 3 Return Values 12 81 4 Remarks a ia ceed TN 129 USBDriverE tts cccccss ssivives dada oliendo Dita 12 OFT SVNOPSIS RO ie 12 91 2 Parameters 12 91 3 Return Values OMoney Controls 2008 All rights reserved Page 4 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 12 91 24 FROIMAIKS resien A cde dewhee a e aay A AAA ARTE ALA RANES 12 10 IMHEIConsistencyError 12 101 1 SYNOPSIS aaaeeeaa 12 101 2 Parameters eae vies bea 12 101 3 PROTUEA VAIO iii ween ra ete vet San Vik Ng BESET ve ca Liban pie sca stad dads Disease rie AAC ds aoe iv A EE 12 101 4 AO a 12 11 Auditing Event Processing 12 111 Structure for EventDetailBlock 12 112 Event Codes for NextEvent EventDetailBlock occccccccccccccncncconononocononononononononononononononononos 80 12 113 cctalk coin processing 12 113 1 Fault Events 12 113 2 Coin Events 12 114 Ectalk N te processing irrin asnan ene apea aa er aitcevecttenveschendaseceesevagds daria 83 12 114 1 Fault Events 12 114 2 Note Events 12 115 Cctalk hopper Processing a vezeiecsccseiccaecsaeeusccsegsenectestacecanssinegtaste deseadseactesceseedeastecesdenepiesceesseusteseiee 84 12 116 ID2O0O03 NOte processing ii iraia naaa a A a ea aa aa e aaa eaaa a A a Eoia aaien 86 12 116 1 Fault Events 13 Note Read
63. er ESCrOW A T A E RE 13 1 A E 13 11 1 Synopsis 13 11 2 Parameters ae oes see TAGS E RO RAT 13 2 EsctoWDisabl iia O is 13 21 1 Synopsis 13 21 2 Parameters 13 21 3 Return Value 13 21 4 Remarks 133 EscrowThroughput 13 31 1 Synopsis 13 31 2 Parameters AR aig ae ES NN NN E TR RN 13 4 EscrowAccept 13 5 EscrowReturn 13 6 Escrow system usage 14 13 41 1 Synopsis 13 41 2 Parameters 13 41 3 Return Value 13 41 4 Remarks 13 51 1 Synopsis 13 51 2 Parameters 13 51 3 Return Value 13 51 4 RemarKkS ocomonco Meters Counters 14 1 CounterIncrement 14 11 1 Synopsis 14 11 2 Parameters 14 11 3 Return Value 14 11 4 Remarks 14 2 CounterCaption 14 21 1 Synopsis dt A LE A O E O TER e Ea 14 263 NT NA 14 214 Remarks 14 3 CounterRead sts TASTED 0 SYNOPSIS cose else A O E E O 14312 a TRAFAMOIO Sd A A A ae ERIS SE E A AA BN costars Tiss 14 31 3 Return Value 14 314 RemalKS ooooooconcccnn 14 4 ReadCounterCaption 14 41 1 Synopsis 14 41 2 Parameters 14 41 3 Return Value 14 414 Remarks cade 14 5 GounterDisplay iaa iia T4511 1 SVMOPSIS A A sects A E ta alee Oe aed eae eee cee cin T4 51 2 PAM US iii A db teeta Money Control
64. er of the counter to be incremented 14 41 3 Return Value None 14 41 4 Remarks 1 If the counter specified is higher than the highest supported then the call returns an empty string 2 All captions stored in the meter are read out at system start up and used to initialise the captions used by the interface Money Controls 2008 All rights reserved Page 92 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 14 5 CounterDisplay 14 51 1 Synopsis The CounterDisplay call is used to control what is displayed on the meter void CounterDisplay long DisplayCode None 7 14 51 2 Parameters DisplayCode If positive this specifies the counter that will be continuously display by the meter hardware If negative then the display will cycle between the caption if set for the specified counter for 1 second followed by its value for 2 seconds 14 51 3 Return Value 14 51 4 Remarks This result of this call with a negative parameter is undefined if no counters have an associated caption Whenever the meter displayed is changed the caption if set is always displayed for one second 14 6 MeterStatus 14 61 1 Synopsis The MeterStatus call is used determine whether working meter equipment is connected long MeterStatus void 14 61 2 Parameters None 14 61 3 Return Value One of the following Value Meaning Mnemonic 0 A Meter is present and working correctly METER_O
65. face USB Type B interface V1 1 and above Protocols support ccTalk Ardac 2 ID003 MDB RS232 Table 2 Electrical Specification PayLink Lite Environmental Operating temperature range 0 C to 55 C Storage temperature range 20 C to 70 C Humidity range Up to 75 RH non condensing Electrical General Voltage range USB Powered Outputs fuse protected 12Vdc 2 5A continuous 5A peak for 200ms Outputs fuse protected 24Vdc 2 5A continuous 5A peak for 200ms Electrical I O Ports 2 inputs Switch inputs 3V3 CMOS thresholds with 3V3 pull ups 5mA max Communications Interface USB Type B interface V1 1 and above Protocols support ccTalk Money Controls 2008 All rights reserved Page 19 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 4 Installation 4 1 Hardware installation PayLink connects to the PC via the USB Type A Type B cable during the installation process the LED indicates the current status of PayLink Table 3 Status LED table RED on USB not connected electrical RED off PC driver is active RED flashing No contact with PC driver program GREEN off USB not working GREEN flashing Application not running GREEN on Application running amp Peripherals Enabled Connect the ccTalk multi drop cable to PayLink Please note Only
66. from this command is a string of up to 4 bytes depending upon the exact unit with one or theoretically more bits set to indicate the problem The action of PayLink is to regard these bytes as containing 32 bits The bits are classified by this section of PayLink as an Error a Fraud attempt a Payout result or information only PayLink scans along these bits looking for the first Error or Fraud bit that is non zero Other bits are ignored The bit number of this first bit i e a number between 0 to 31 is then returned in RawEvent and an EventCode of either IMHEI_COIN_DISPENSER_FRAUD_ATTEMPT or IMHEI_COIN_DISPENSER_REPORTED_ FAULT Money Controls 2008 All rights reserved Page 84 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 For reference the bit numbers and their classification are Bit Meaning Event Classification Payout Result Number 0 Jammed Information only PAY_JAMMED 1 Empty Information only PAY_EMPTY 2 Reversed Information only 3 Idle fraud blocked Fraud PAY FRAUD 4 Idle fraud short Fraud PAY FRAUD 5 Payout blocked Information only PAY FAILED BLOCKED 6 Power up Information only 7 Disabled Fault 8 Fraud short Fraud PAY FRAUD 9 Sngle coin mode Fault 10 Chksum a Fault 11 Chksum b Fault 12 Chksum c Fault 13 Chksum d Fault 14 Pwr fail during write Fault 15 Pin locked Fault 16 Powerdown
67. g LastPayStatus void 10 91 2 Parameters None 10 91 3 Return Values Value Meaning Mnemonic 0 The interface is in the process of paying out PAY_ONGOING 1 The payout process is up to date PAY_FINISHED 1 The dispenser is empty PAY_EMPTY 2 The dispenser is jammed PAY_JAMMED 3 Dispenser non functional PAY_US 4 Dispenser shut down due to fraud attempt PAY_FRAUD 5 The dispenser is blocked PAY_FAILED_BLOCKED 6 No Dispenser matches amount to be paid PAY_NO_HOPPER 7 The dispenser is inhibited PAY_INHIBITED 8 The internal self checks failed PAY_SECURITY_FAIL 10 91 4 Remarks 1 Following a call to PayOut the programmer should poll this to check the progress of the operation 2 If one out of multiple hoppers has a problem the PCI card will do the best it can If it can not pay out the entire amount the status will reflect the last attempt Money Controls 2008 All rights reserved Page 52 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 10 10 CurrentPaid 10 101 1 Synopsis The CurrentPaid call is available to keep track of the total money paid out because of calls to the PayOut function long CurrentPaid void 10 101 2 Parameters None 10 101 3 Return Value The current value in the lowest denomination of the currency i e cents pence etc of all coins and notes ever paid out 10 101 4 Remarks 1 This value that is returned by th
68. gher coin and the Count of the higher value coins dispensed Note that due to limitations of the unit during a payout operation the Count of the main dispenser only is updated as though all coins dispensed were of this value At the end of the sequence while LastPayStatus is still returning PAY_ONGOING the accurate count of both coins is retrieved and the two separate Count fields updates The result of this is that as the operation finishes the Count for the lower value dispenser decrements Money Controls 2008 All rights reserved Page 71 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 11 17 Multiple PayLink Unit Support 11 171 OVERVIEW Although the PayLink system was designed on the basis of a single PayLink unit being connected to a PC facilities are provided to support multiple PayLink units The only change that is visible to a programmer when multiple units are in use is that the OpenSpecificMHE is used to associate a specific one of the multiple PayLink unit interface areas with the program It is envisaged that in a system with multiple PayLink units a separate instance of the program will be running for each PayLink unit interface area and a supervisory level will start the different programs This is not compulsory as OpenSpecificMHE can be called repeatedly with different parameters so as to switch between PayLink unit interface areas 11 172 UNIT IDENTIFICATION The USB interface chip on a Pa
69. gust 2008 12 5 SetDeviceKey 12 51 1 Synopsis The SetDeviceKey call is made by the PC application software to set such things as an encryption key void SetDeviceKey long InterfaceNo long Address long Key 12 51 2 Parameters 1 InterfaceNo The Interface on which the device is located 2 Address The address of the device whose key is being updated 3 Key The 32 bit key to be remembered for the device 12 51 3 Return Value None 12 51 4 Remarks 1 At present this can only be used for a Lumina acceptor at address 40 on interface 2 the ccTalk interface The key as 6 hex digits is used as the encryption key 2 An example application for this is available within the SDK folder structure 12 6 SerialNumber 12 61 1 Synopsis The SerialNumber call provides access to the electronic serial number stored on the device long SerialNumber void 12 61 2 Parameters None 12 61 3 Return Value 32 bit serial number 12 61 4 Remarks 1 Aserial number of 1 indicates that a serial number has not been set in the device 2 A serial number of 0 indicates that the device firmware does not support serial numbers 12 7 FirmwareVersion Money Controls 2008 All rights reserved Page 76 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 12 71 1 Synopsis The FirmwareVersion call allows a control application to discover the exact description of the firmware running on the unit long FirmwareVersion
70. he underlying concept behind the state tables is that the all activity causes counters to be incremented The application programmer reads out the totals at the time the application starts and then compares these with the current totals Peripheral activity will cause these totals to increment subtracting the old saved value from the current value enables the application to determine the value inserted by the customer Using state tables on the PC in this way allows the programmer to be unconcerned with hardware response times Although the state tables have to be periodically examined to see if anything has changed there is never any requirement that this is done quickly and the programmer does not have to be concerned that the OS may suspend his program for significant periods Regardless of how long the program spends between examinations the system will function perfectly and no money insertion or payout will be missed The following function calls are provided to implement a minimum system Using the functions described within this section one can provide a fully working system with credit and payout capability as well as a number of indicators and switches Money Controls 2008 All rights reserved Page 47 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 10 3 OpenMHE 10 31 1 Synopsis This call is made by the PC application software to open the Money Handling Equipment Interface long OpenMHE void 10
71. her than an accepted coin this is queued as a COIN_DISPENSER_EVENT event with the actual event byte reported in RawEvent The handler classifies ccTalk events as Event Meaning Event Classification Number 1 Coin Rejected REJECTED 2 Coin Inhibited INHIBITED 3 Multiple window REJECTED 4 Wake up timeout JAM 5 Validation timeout JAM 6 Credit sensor timeout JAM 7 Sorter opto timeout OUTPUT_PROBLEM 8 2nd close coin error REJECTED 9 Accept gate not ready REJECTED 10 Credit sensor not ready REJECTED 11 Sorter not ready REJECTED 12 Reject coin not cleared REJECTED 13 Validation sensor not ready REJECTED 14 Credit sensor blocked JAM 15 Sorter opto blocked OUTPUT _PROBLEM 16 Credit sequence error FRAUD 17 Coin going backwards FRAUD 18 Coin too fast over credit sensor FRAUD 19 Coin too slow over credit sensor FRAUD 20 C O S mechanism activated coin on string FRAUD 21 DCE opto timeout FRAUD 22 DCE opto not seen FRAUD 23 Credit sensor reached too early FRAUD 24 Reject coin repeated sequential trip FRAUD 25 Reject slug FRAUD 26 Reject sensor blocked JAM 27 Games overload INTERNAL_PROBLEM 28 Max coin meter pulses exceeded INTERNAL_PROBLEM 128 159 Inhibited Coin INHIBITED 254 Flight Deck Open RETURN Money Controls 2008 All rights reserved Page 82 of 104 PayL
72. ilableValue call is available to keep track of how much money is available in the coin or note dispensers long AvailableValue void 12 31 2 Parameters None 12 31 3 Return Value The approximate minimum value in the lowest denomination of the currency i e cents pence etc of all coins and notes that could be paid out 12 31 4 Remarks The accuracy of the value returned by this call is entirely dependent upon the accuracy of the information returned by the money dispensers At present this facility is not implemented 12 4 ValueNeeded 12 41 1 Synopsis The ValueNeeded call provides an interface to an optional credit card acceptor unit It is not envisaged that this would be used within many systems but may be used for example in vending applications void ValueNeeded long Amount 12 41 2 Parameters Amount The figure that CurrentValue is required to reach before the next event can happen 12 41 3 Return Value None 12 41 4 Remarks 1 This function does not necessarily have any affect on the system If the MHE includes a credit card acceptor or similar then the MHE interface unit will arrange for the next use of that unit to bring CurrentValue up to latest figure supplied by this routine 2 If CurrentValue is greater or equal to the last supplied figure then any such acceptors are disabled Money Controls 2008 All rights reserved Page 75 of 104 PayLink Technical Manual TSP129 Issue 1 5 Au
73. ink Technical Manual TSP129 Issue 1 5 August 2008 12 114 CCTALK NOTE PROCESSING 12 114 1 Fault Events Shortly after start up the ccTalk command Do self Test is sent to the acceptor The response is queued as an event with the first byte of the response in RawEvent and an EventCode type of IMHEI_NOTE_NOW_OK Or IMHEI_NOTE_UNIT_REPORTED_FAULT Some acceptors reply to this command with a NAK these are reported as IMHEI_NOTE_SELF_TEST_REFUSED If the unit is reset the sequence number is found to be zero or repeated messages are ignored IMHEI_NOTE_UNIT_RESET or IMHEI_NOTE_UNIT_TIMEOUT event is queued Whenever any of these faults have been reported the handler will continually poll the acceptor with Do Self Test commands until a non faulty response is returned 12 114 2 Note Events When the acceptor reports an event other than an accepted note this is queued as an NOTE_DISPENSER_EVENT event with the actual event byte reported in RawEvent The handler classifies ccTalk events as Event Meaning Event Classification Number 0 Master inhibit active INHIBITED 1 Bill returned from escrow RETURN 2 Invalid bill due to validation fail REJECTED 3 Invalid bill due to transport problem REJECTED 4 Inhibited bill on serial INHIBITED 5 Inhibited bill on DIP switches INHIBITED 6 Bill jammed in transport unsafe mode MISREA
74. is function is updated in real time as the money handling equipment succeeds in dispensing coins 2 The value that is returned by this call is never reset but increments for the life of the interface card It is the responsibility of the application to keep track of starting values and to monitor for new coin note successful payments by increases in the returned value 3 Note that this value can be read following the call to OpenMHE and before the call to Enablelnterface to establish a starting point before any coins or notes are paid out 10 11 IndicatorOn IndicatorOff 10 111 1 Synopsis The IndicatorOn IndicatorOff calls are used by the PC application to control LED s and indicator lamps connected to the interface void IndicatorOn long IndicatorNumber void IndicatorOff long IndicatorNumber 10 111 2 Parameters IndicatorNumber This is the number of the Lamp that is being controlled Return Value None 10 111 3 Remarks 1 Although the interface is described in terms of lamps any equipment at all may in fact be controlled by these calls depending only on what is physically connected to the interface card Money Controls 2008 All rights reserved Page 53 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 10 12SwitchOpens SwitchCloses 10 121 1 Synopsis The calls to SwitchOpens and SwitchCloses are made by the PC application to read the state of switches connected to the interface ca
75. item 3 Even following this call all the money handling equipment will be disabled and rejecting all currency inserted until the successful execution of a call to Enablelnterface Money Controls 2008 All rights reserved Page 48 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 10 4 OpenSpecificMHE 10 41 1 Synopsis This call is made by the PC application software to open or to switch to one of the multiple Money Handling Equipment Interfaces installed on the PC Details on how a system works with multiple PayLinks are given in a later section long OpenSpecificMHE char SerialNo 8 10 41 2 Parameters None 10 41 3 Return Value If the Open call succeeds then the value zero is returned In the event of a failure the same standard windows error codes are returned as for OpenMHE 10 41 4 Remarks 1 Every PayLink requires a unique instance of the USB driver program to be running If there is no driver for the PayLink whose Serial Number is quoted then the function returns 31 ERROR_GEN_FAILURE 2 As the default serial number for PayLink unit is AE000001 the OpenMHE call is equivalent to the call OpenSpecficMHE AE000001 3 This call may be issued repeatedly with no ill effects Each call will serve to swap all the other calls in this document to the specified unit Money Controls 2008 All rights reserved Page 49 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 10
76. l immediately cause the EscrowThroughput to be updated 2 If no currency is currently held in escrow when this call is made it will be silently ignored Money Controls 2008 All rights reserved Page 88 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 13 5 EscrowReturn 13 51 1 Synopsis If the acceptor that was last reported as holding currency in escrow is still in that state this call will cause it to return that currency void EscrowReturn void 13 51 2 Parameters None 13 51 3 Return Value None 13 51 4 Remarks 1 If a second acceptor has unreported currency in escrow at the time this call is made it will immediately cause the EscrowThroughput to be updated 2 If no currency is currently held in escrow when this call is made it will be silently ignored 13 6 Escrow system usage Where an acceptor provides escrow facilities the IMHEI card fully supports these by enabling escrow mode It reports the note that is currently held in escrow by an acceptor and allows the game to either return or accept the escrow holding of the acceptor In most system only one escrow capable acceptor will be present the IMHE card will however support escrow on an unlimited number of acceptors In order to allow for accurate information and control to pass between the game and the IMHEI firmware the escrow holding reported is limited to a single acceptor at time If two acceptors are holding escrow at the same ti
77. l Event Codes enum 1 General HEI_NULL 0 HEI_INTERFACE_START A HEI_APPLICATION_START 2 HEI_APPLICATION_EXIT 3 HEI_OVERFLOW Oxlf Coin Acceptors HEI_COIN_NOW_OK an FAULT_BIT NOW_OK HEI_COIN_UNIT_REPORTED_FAULT ale FAULT_BIT REPORTED_FAULT HEI_COIN_UNIT_TIMEOUT T FAULT_BIT UNIT_TIMEOUT HEI_COIN_UNIT_RESET T FAULT_BIT UNIT_RESET HEI_COIN_SELF_TEST_REFUSED T FAULT_BIT SELF_TEST_REFUSED HEI_COIN_REJECT_COIN T REJECTED HEI_COIN_INHIBITED_COIN T INHIBITED HEI_COIN_FRAUD_ATTEMPT T FRAUD HEI_COIN_ACCEPTOR_JAM T JAM HEI_COIN_COIN_RETURN T RETURN HEI_COIN_SORTER_JAM T OUTPUT_PROBLEM HEI_COIN_INTERNAL_PROBLEM T INTERNAL_PROBLEM HEI_COIN_UNCLASSIFIED_EVENT T UNKNOWN Note Acceptors HEI_NOTE_NOW_OK NOTE T FAULT_BIT NOW_OK HE OTE_UNIT_REPORTED_FAULT NOTE T FAULT_BIT REPORTED_FAULT HEI_NOTE_UNIT_TIMEOUT NOTE T FAULT_BIT UNIT_TIMEOUT HEI_NOTE_UNIT_RESET NOTE T FAULT_BIT UNIT_RESET HEI_NOTE_SELF_TEST_REFUSED NOTE T FAULT_BIT SELF_TEST_REFUSED HEI_NOTE_REJECT_NOTE a REJECTED HEI BITED_NOTE T INHIBITED HEI _MISREAD T ISREAD HEI D_ATTEMPT T FRAUD HEI PTOR_JAM T JAM HE PTOR_JAM_FIXED T JAM_FIXED HEI _RETURNED T RETURN HEI ER_PROBLEM T OUTPUT_PROBLEM HEI ER_FIXED T OUTP
78. l Manual TSP129 Issue 1 5 August 2008 11 141 MDB TUBE LEVEL MONITORING Monitoring The main method for determining tube levels is via the Tube Status 0x02 MDB command This is issued during startup and then every 25 seconds The response to this is copied directly into the tube coin level and one of the DISPENSER_ACCURATE or DISPENSER_ACCURATE FULL level statuses set Coin Insertion When a coin insertion event code 0x40 is reported as going to a tube the changer also includes an updated value for the tube level If this is non zero then this is used to overwrite the coin level for the tube When a coin insertion is reported as going to the cashbox for a coin that has an associated tube PayLink immediately issues a Tube Status 0x02 MDB command to obtain an accurate on the levels Note that after a delay of up to 25 seconds this will be replaced by the value from a Tube Status command Manual Dispense When a manual dispense event code 0x80 is reported then the reported tube level copied directly into the tube coin level Note that after a delay of up to 25 seconds this will be replaced by the value from a Tube Status command if that is different Payout While a payout is in progress no updates are made to the coin level As soon as the payout completes PayLink immediately issues a Tube Status 0x02 MDB command to obtain the changer s opinion of the new levels OMoney Controls 2008 All rights reserved Page 70 of 104
79. le 32 bit number it is created by concatenating four 8 bit values The program will usually only be interested in distinguishing the coin and note acceptors which are distinguished by values in the top 8 bits For this purpose two C macros are defined IS_COIN_ACCEPTOR Unit and IS NOTE_ACCEPTOR Unit see below which can easily be translated into other languages For a dispenser this will normally involve the Value as that shows the coin value assumed by Milan interface which is the most important distinguishing feature of a dispenser 11 2 C Program Structures and Constants This is currently an extract of the C header file the comments should serve to define the various fields we hope to enhance the format of this section of the document in the near future For people unfamiliar with C a data item prefixed with long is a 32 bit integer a data item prefixed with char is an 8 bit integer Money Controls 2008 All rights reserved Page 58 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 11 21 ACCEPTORBLOCK 11 21 1 Constants for AcceptorBlock enum AcceptorConsta ACCEPTOR_DEAD ACCEPTOR_DISABL ACCEPTOR_INHIBI ACCEPTOR_FRAUD ACCEPTOR_BUSY ACCEPTOR_FAULT MAX_ACCEPTOR_CO 11 21 2 Stru typedef struct nts 0x00000001 No response to communications for this device ED 0X00000004 Disabled by Interface T 0X00000008 Specific by Application 0x00000010
80. lt Yes Coin PathSwitch Fill Level Increment No Coin PathCount Hopper Full y y Coin Path Coin DefaultPath Coin Path Cash Box Coin Cash Box Coin Hopper Notes e Setting route 0 should be avoided as it does not exist on an SR5 coin acceptor e The settings for PathSwitchLevel and PathCount are restored automatically by PayLink after a reset Money Controls 2008 All rights reserved Page 68 of 104 8 PayLink Technical Manual TSP129 Issue 1 5 August 2008 11 14 MDB changer support 1 10 x If an MDB changer is used it will appear as an acceptor in very much the same way as any other acceptor The coins that are routed to tubes can be distinguished as having a non zero Routed Path although obviously any changes made to the routing will be ignored With the payout the situation is slightly more complicated The MDB changer protocol supports two different payout mechanisms a basic one that is always present and an extended one which is supported on some level 3 changers The basic provides control over the individual payout tubes but has no feedback as to whether the payout works The extended one provides feedback as to the success of the payout but does not allow any control over which tubes the payout is from The solution adopted is to always provide one dispenser for each tube which is run using the basic mechanism and if the extended mechanism is present to provide an additional dispenser which is run
81. me the second will not be reported until the first has completed At start up the system does not report escrow details and all acceptors are run in normal mode where all currency is accepted To use escrow the call EscrowEnable is issued Following this the call EscrowThroughput will return the total value of all currency that has ever been held in escrow in the same way as for CurrentValue except that the value is not preserved over resets An increase in the value returned indicates that a note is now in escrow The HeldinEscrow field within the AcceptorCoin structure will indicate the number of each note coin that is currently being held The EscrowAccept call will cause the IMHEI card to complete the acceptance of the currency in question When complete this will be indicated by an increase in CurrentValue An EscrowReturn call will cause the currency to be returned with no further indication to the game Following either call the EscrowThroughput value may increase immediately due to another acceptor having an escrow holding If the game wishes to stop using the escrow facilities it may issue the EscrowDisable call This will have the side effect of accepting any outstanding escrow holdings Money Controls 2008 All rights reserved Page 89 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 14 Meters Counters The IMHE units will support the concept of external meters that are accessible from the outside
82. mine the cumulative monetary value that has been held in escrow since the system was reset The EscrowThroughput call is used to determine the cumulative total value of all coins and notes read by the money handling equipment that have ever been held in escrow long EscrowThroughput void 13 31 2 Parameters None 13 31 3 Return Value The current value in the lowest denomination of the currency i e cents pence etc of all coins and notes ever held in Escrow 13 31 4 Remarks 1 Itis the responsibility of the application to keep track of value that has been accepted and to monitor for new coin note insertions by increases in the returned value 2 Note that this value should be read following the call to OpenMHE and before the call to Enablelnterface EscrowEnable to establish a starting point before any coins or notes are read 3 Ifthe acceptor auto returns the coin note then this will fall to its previous value This can potentially occur after a call to EscrowAccept or EscrowReturn if the acceptor has already started its return sequence 13 4 EscrowAccept 13 41 1 Synopsis If the acceptor that was last reported as holding currency in escrow is still in that state this call will cause it to accept that currency void EscrowAccept void 13 41 2 Parameters None 13 41 3 Return Value None 13 41 4 Remarks 1 If a second acceptor has unreported currency in escrow at the time this call is made it wil
83. mplementation tighter control over the behaviour and response of the individual acceptors and hoppers is frequently necessary for such purposes as routing coins to hoppers and cashboxes and emptying hoppers Some more details on these operations are given at the end of this section The data retrieval functionality is achieved by reading the control blocks for the acceptors with ReadAcceptorDetails and possibly hoppers with ReadDispenserDetails at initialisation time and then continually checking the current contents of these against saved copies To aid in this process the CurrentUpdates function guarantees that if it returns an unchanged value then none of the control blocks will have changed Most of the control functionality is achieved by reading a data structure from the API modifying it as appropriate or necessary and writing it back Four functions are involved ReadAcceptorDetails ReadDispenserDetails WriteAcceptorDetails amp WriteDispenserDetails All these functions identify the individual units by a serial number in the range 0 N 1 The programmer should not assume that any particular unit is present at any particular number the numbers are assigned dynamically and are liable to change from run to run To find the particular unit of interest the programmer should scan number from 0 up looking for a match on the structure members For an acceptor this will usually involve the Unit field Although this is defined as sing
84. nkoni 10 121 1 SYNOPSIS coococcccocccnnconancninnono 10 121 2 Parameters 10 121 3 Return Value 10 121 4 Remarks cooococccccnccooccnncconananon 10 13 Getting Started Code Examples 10 131 Currency Accept eee 10 132 Currency Payout 10 133 Indicator Example 10 134 Switch Example Full Game System 11 1 Background seeren 11 2 C Program Structures and Constants 11 21 ACCOptorBlOCk an aaa iis Gen te he ee ee eee 11 21 1 Constants for AcceptorBlock 11 21 2 Structures for AcceptorBlocks 11 22 DispenserBlOCK aieiaa a tes e a a a ee att ad 11 22 1 Constants for DiSD NSEIBIOCK 21 ccccccceccesseeeseeeneceseeceseesaneceaeeeaaeceaeesececeseeeaaeseaeesaaeeaaeeseaesesaeesssaaeseeeseeeeeneees 11 22 2 Structure for DispenserBlock 11 23 Device Identity Constants 11 23 1 Example tee nea nates dee no e noe mes ue ernie penal conto donar enn retar seo NX 113 GurrentUpdates 1 10 4 0ass ansia rada Bide ates 11 31 1 SYNOPSIS cococicocicccnccnnos 11 31 2 Parameters 11 31 3 Return Value desa sire E e TA E loca se seaduhs duke A O ROT 11 4 ReadAcceptorDetalls girsin ctm q da 11 41 1 SYNOPSIS wees 11 41 2 Parameters mae ies an 11 41 3 gt ROTUO Vall iio ia a At a dE AAA AAA A Aa A O gt UE CRA a a a NT 115 WriteAcceptorDetails 11 51 1 Synopsis cococicccccccncnn 11 51 2 Parameters 11 51 3 Return Value 11 514 RemalKS oooooocnncccnn 116
85. ount The number of coins in the dispenser long CoinCountStatus Flags Relating to Coin Count See above long SerialNumber Reported serial number 0 if N A char Description Device specific string for type revision DispenserBlock Money Controls 2008 All rights reserved Page 60 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 11 23 DEVICE IDENTITY CONSTANTS These constants are ORed together to form the coded device identity that can be extracted from the interface 11 23 1 Example As an example a Money Controls Serial Compact Hopper 2 will have the following device code DP_MCL_SCH2 made up from e A device specifc code ORed with e DP_COIN_PAYOUT_DEVICE ORed with e DP_CCTALK_INTERFACE ORed with e DP_MANU_MONEY_CONTROLS This is a device code of 0x01020101 enum GenericDevices DP_GENERIC_MASK Oxff000000 DP_COIN_ACCEPT_DEVICE 0x02000000 DP_NOTE_ACCEPT_DEVICE 0x12000000 DP_CARD_ACCEPT_DEVICE 0x22000000 DP_COIN_PAYOUT_DEVICE 0x01000000 DP_NOTE_PAYOUT_DEVICE 0x11000000 DP_CARD_PAYOUT_DEVICE 0x21000000 a define IS_ACCEPTOR code code amp 0x02000000 define IS_COIN_ACCEPTOR code code amp DP_GENERIC_MASK DP_COIN_ACCEPT_DEVICE define IS_NOTE_ACCEPTOR code code amp DP_GENERIC_MASK DP_NOTE_ACCEPT_DEVICE Es define IS_PAYOUT code enum InterfaceNumbers o de 0x01000000 These describ
86. owe SD FTOGAUN INE LKB Configuration Settings READ ME tat LKB Tent Document Bubp LKB SPP Pe Note At this point in order to test PayLink Refer to Section 7 Using PayLink Money Controls 2008 All rights reserved Page 25 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 5 Interface 5 1 Power interface Figure 7 PayLink power interface P n 1 Pin Function 1 GND 2 12V de 5 2 ccTalk interface Figure 8 PayLink ccTalk interface Pin Function Pin Function 1 ccTalk data line 4 24V Out 12V Out 5 OV In Serial Select 0V 6 24V In IMPORTANT INFORMATION 12V Out is the supply which is provided to PayLink on the 2 pin connector via a polyfuse for protection 24V In must be provided by the host machine in the PayLink development kit this is shown by orange and black power cables and is passed through a polyfuse for protection this becomes 24V Out Under no circumstances can any more than 2 5A drawn through the card Under no circumstances should PayLink be hot swapped Money Controls 2008 All rights reserved Page 26 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 Figure 9 Lumina SR5 ccTalk interface Pin Description Pin Description 1 ccTalk data line Lumina SR5 2 3 4 5 6 Not Used 7 12V 9 Not Used oe select ine 8 OV 10 Not Used Figure 10 SR3 Con
87. put 13 Input 5 Input 13 16 12V 12V OV OV 17 Output 6 Output 14 Input 6 Input 14 18 KEYWAY N C N C N C 19 Output 7 Output 15 Input 7 Input 15 20 12V 12V OV OV 5 5 PayLink Lite input interface Figure 19 PayLink Lite Switch Inputs Pin 1 ow Pin PayLink Function 1 GND 2 Switch 1 3 GND 4 Switch 2 Money Controls 2008 All rights reserved Page 30 of 104 P ayLink Technical Manual TSP129 Issue 1 5 August 200 5 6 Serial printer interface Figure 20 PayLink RS232 Serial Printer Interface 7 Pope 14 6 oped 13 Pin 1 5i E a al ON Jm Pin PayLink Function Pin Serial Printer 3 JE 10 a TX from PayLink i 2 DEM 9 RX to PayLink 12 1 ss 8 5 7 Serial meter interface Figure 21 PayLink serial meter interface Pin 1 Ss This is a 1 to 1 connection between PayLink and the Serial meter rene r Function pee r Function 1 SPI Data Output 4 SEC Reset 2 SPI Clock Input 5 12V Supply 3 SPI Data Input 6 OV Supply Money Controls 2008 All rights reserved Page 31 of 104 8 PayLink Technical Manual TSP129 Issue 1 5 August 2008 5 8 MDB Device interface Figure 22 MDB Slave interface Pin 1 Pin PayLink Function Pin MDB ee 1 Rx to PayLink 5 TX from PayLink 4 Signal GND 6 OV DC 2 V DC 1 No
88. rd long SwitchOpens long SwitchNumber long SwitchCloses long SwitchNumber 10 121 2 Parameters SwitchNumber This is the number of the switch that is being controlled In principle the API can support 64 switches though note that not all of these may be support by any particular hardware unit 10 121 3 Return Value The number of times that the specified switch has been observed to open or to close respectively 10 121 4 Remarks 1 The convention is that at initialisation time all switches are open a switch that starts off closed will therefore return a value of 1 to a SwitchCloses call immediately following the OpenMHE call 2 The expression SwitchCloses n SwitchOpens n will always return 0 if the switch is currently closed and 1 if the switch is currently open 3 Repeat pressing tapping of a switch by a user will be detected by an increment in the value returned by SwitchCloses or SwtichOpens 4 The user only needs to monitor changes in one of the two functions in the same way as most windowing interfaces only need to provide functions for button up or button down events 5 The inputs are debounced The unit reads all 16 inputs every 2 milliseconds If we detect a change we then require the next two reads to give exactly the same pattern before reporting the change This means that a simple electronic input change will be reported between 4 and 6 milliseconds of it occurring Money Controls 2008 All
89. rial number 0 if N A Description Device specific string for type revision coin set r Money Controls 2008 All rights reserved Page 59 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 11 22 DISPENSERBLOCK 11 22 1 Constants for DispenserBlock enum DispenserConstants MAX_DISPENSERS 16 Maximum handled Coin Count Status Values DISPENSER_COIN_NONE 0 No dispenser coin reporting DISPENSER_COIN_LOW 1 Less than the low sensor level DISPENSER_COIN_MID 2 Above low sensor but below high DISPENSER_COIN_HIGH 3 High sensor level reported DISPENSER_ACCURATE 1 Coin Count reported by Dispenser SPENSER_ACCURATE_FULL 2 The Dispenser is full DISPENSER_REASSIGN_VALUE 100 The Value has just been updated by the application DISPENSER_VALUE_REASSIGNED 101 The updated Value has just been accepted by the IMHEI r 11 22 2 Structure for DispenserBlock typedef struct long Unit Specification of this unit long Status Individual Dispenser status This takes the same values as PayStatus long InterfaceNumber The bus connection long UnitAddress For addressable units long Value The value of the coins in this dispensor long Count Number dispensed according to the hopper records long Inhibit Set to 1 to inhibit Dispenser long Currency The currency code reported by an intelligent dispenser long CoinC
90. rights reserved Page 54 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 10 13 Getting Started Code Examples The following code fragments are intended to provide clear examples of how the calls to the IMHEI are designed to be used Each function will provide the central processing for a small command line demonstration program 10 131 CURRENCY ACCEPT void AcceptCurrencyExample int NoOfChanges long LastCurrencyValue long NewCurrencyValue long OpenStatus OpenMHE if OpenStatus 0 printf IMHEI open failed ld n OpenStatus else Then the open call was successful Currency acceptance is currently disabled LastCurrencyValue CurrentValue printf Initial currency accepted ld pence n LastCurrencyValue EnableInterface printf Processing d change events n NoOfChanges while NoOfChanges gt 0 Sleep 100 NewCurrencyValue CurrentValue if NewCurrencyValue LastCurrencyValue More money has arrived we do not care where from printf The user has just inserted ld pence n NewCurrencyValue LastCurrencyValue LastCurrencyValue NewCurrencyValue NoOfChanges Money Controls 2008 All rights reserved Page 55 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 10 132 CURRENCY PAYOUT void PayCoins int NoOfCoins long OpenStatus OpenMHE if OpenStatus 0
91. rn Value None 11 71 4 Remarks The serial numbers of the dispensers are contiguous and run from zero upwards A call to ReadDispenserDetails followed by call to WriteDispenserDetails for the same data will have no effect on the system Money Controls 2008 All rights reserved Page 64 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 11 8 Dispenser Value Reassignment 1 10 7 Releases of PayLink after 1 10 7 allow the value of the coin associated with a Dispenser to be re assigned To do this e the dispenser to be updated should be found using ReadDispenserDetails e the Dispenser Value updated to the new value e the Dispenser Status field changed to DISPENSER_REASSIGN_VALUE and WriteDispenserDetails used to update the record to Paylink Paylink will acknowledge that the update has been processed by setting the Dispenser Status field to DISPENSER_VALUE_REASSIGNED f this value is not seen in the Dispenser Status field then the value change has not be processed by Paylink 11 9 Token Handling Coin Ids 1 11 x As tokens do not have a known value they appear as coins with value zero The only way for a game to detect tokens is to use the CurrentUpdates function to detect activity and then to check for increases in the count of the token s to be accepted Coin Count The index for the coin that holds the count for a particular token can be obtained by searching the coin array belonging to th
92. roduct Code 244 commands separated by characters Each individual field is truncated to 15 characters and is omitted if there is no response to the command although the character is still inserted ID 003 The entire reply to the Get Version Request 0x88 command MDB TBD GPT TBD ARDAC TBD The Acceptor SerialNumber field is generated as follows ccTalk The binary reply to the ID Serial No 242 command ID 003 The standard ID 003 protocol does not allow for a serial number A non standard Ox8F query is issued and any response will be stored here MDB TBD GPT TBD ARDAC TBD 11 12 Read out of Dispenser Details 1 11 x Different protocols manufacturers provide different details on acceptors The Description Dispenser Description field is generated as follows ccTalk The replies to e Request Software Revision 241 e Request Product Code 244 commands separated by characters Each individual field is truncated to 15 characters and is omitted if there is no response to the command although the character is still inserted MDB TBD The Dispenser SerialNumber field is generated as follows ccTalk The binary reply to the ID Serial No 242 command MDB TBD Money Controls 2008 All rights reserved Page 66 of 104 PayLink Technical Manual TSP129 Issue 1 5
93. s 2008 All rights reserved Page 5 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 14 6 14 7 15 15 1 15 2 15 3 16 16 1 16 2 16 3 16 4 16 5 16 6 16 7 16 8 16 9 16 10 14 51 3 Return E SR NO 93 T4514 A NN 93 MeterStat sS cont a dt be ada deta tee ees 93 14 611 SYNOPSIS AAA RN 14 61 2 Parameters ss 14 61 3 Return Value 14 61 4 Remarks MeterSerialNo ica e Ai ok ae ee On Be ls EA ES lol ii shs cos basse Gta NO 14 71 2 Parameters 14 71 3 Return Value ee TAT T 4 AE RE TO e y A AN A IR A A ae er E2PromReset TEATE S SYNOPSIS A A aa dada TA DAGZ APA MO CO SS ii a TA wan ihe LAT AREAS AA ai anes Alain aie time ae 15 11 3 Return Value 15 11 4 Remarks A E O ak Bl E A ade Ma dot A ES A NN 15 21 2 Parameters 15 21 3 Return Value AA O O Td A O RR OE SR RR ARO E2SProMRe ade A on 15 31 1 Synopsis 15 31 2 Parameters 15 31 3 Return Value 15 31 4 Remarks Bar Codes s 000 Barcode Reading BarcodeEnable 16 21 1 Synopsis A A A AAN 16 21 3 Return Value BarcodeDisable 16 31 1 Synopsis 16 31 2 Parameters 16 31 3 Return Value 16 31 4 Remarks Barcode MESCrow eiii a aia TOATIA SS OOPS ia A td A E T tia Oh aT 16 41 2 Parameters A 16 41 3 Return Value TOATA ROMS tii a A a ton tells BarcodeStacked EEEE T E E EE ET A E T 16
94. s that the current ticket has been stacked its contents will be in the BarcodeString buffer 16 51 4 Remarks 2 Itis the responsibility of the application to keep track of the number of tickets that have been accepted and to monitor for new insertions by increases in the returned value 3 Note that this value should be read following the call to OpenMHE and before the call to Enablelnterface BarcodeEnable to establish a starting point before any new tickets are read Money Controls 2008 All rights reserved Page 99 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 16 6 BarcodeAccept 16 61 1 Synopsis If the acceptor that was last reported as holding a Barcode ticket is still in that state this call will cause it to accept that currency void BarcodeAccept void 16 61 2 Parameters None 16 61 3 Return Value None 16 61 4 Remarks 1 If a second acceptor has unreported currency in Barcode at the time this call is made it will immediately cause the BarcodeTicket to be updated 2 If no ticket is currently held when this call is made it will be silently ignored 16 7 BarcodeReturn 16 71 1 Synopsis If the acceptor that was last reported as holding a Barcode ticket is still in that state this call will cause it to return that currency void BarcodeReturn void 16 71 2 Parameters None 16 71 3 Return Value None 16 71 4 Remarks 1 If a second acceptor has unreported currency in
95. s to WritelnterfaceBlock without a successful response are not guaranteed not to overflow internal buffers 2 The program is expected to poll the interface for a response indicated by a non zero return value Money Controls 2008 All rights reserved Page 104 of 104
96. serBlock for information gt Hopper power fail is supported in PayLink firmware version 3 1 10 1 and above See section 11 15 Hopper Power Fail support 1 10 x for information Money Controls 2008 All rights reserved Page 34 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 6 4 Ardac 5 gt Paylink supports either ID003 or Ardac 2 protocol but not both In order to convert from Ardac 2 protocol to the ID003 protocol and vice versa the necessary firmware needs to be programmed into Paylink Refer to section 7 4 Upgrading PayLink firmware for information on how to do this gt Must be powered at 24V as the current consumption at 12V will be too high Under no circumstances can any more than 2 5A drawn through the card gt Both individual notes and the entire unit can be easily inhibited gt The automatic retrieval from the unit of the value of each note is supported 6 5 Serial ticket printer gt The printer needs to be preloaded with a template gt Currently only supports Futurelogic GEN2 ticket printer Please contact Money Controls Technical Services for details 6 6 MDB Device gt The MDB hardware has always existed on the PayLink PCB However the PayLink firmware only supports an MDB Device from version 3 1 10 1 and above 6 7 Inputs gt 16 Individual external switches are supported by the unit and are easily accessible by the user s application gt Provision is made for the
97. te The MDB Master interface is currently not supported and can be used for special projects only Please contact Money Controls if you would like further information 5 9 Connector details Full drawings and connector details are provided within the PayLink Looms section of the CD me 2 Input 1 wmh619 pdf Input 2 wmh620 pdf St MDB WMH645 pdf Output 1 wmh621 pdF Output 2 wmh622 pdF OR J45 25D wmh614 pdf 0 USB A B wmh613 pdf Ardac Elite ccTalk WMH682 pdF ccTalk Multi wmh610 pdf SF ccTalk SCH2 wmh615 pdf ccTalk SUH wmh611 pdf PayLink Lite Switches 704 1 pdf Y PayLink Power wmh618 pdF O RJ45 Cable wmh616 pdf MU SEC Meter wmh617 pdf O SR3 Condor WMH360 8 pdf SF SRSi Lumina wmh359 6 pdf Ticket Printer wmh612R2 pdf Size 222 KB 68 KB 345 KB 189 KB 190 KB 279 KB 279 KB 69 KB 275 KB 275 KB 51 KB 216 KB 321 KB 261 KB 248 KB 50 KB 44 KB 79 KB 255 KB Type Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Adobe Acrobat Doc Money Controls 2008 All rights reserved Page 32 of 104 Date Modified 19 08 2005 09 26 07 06 200
98. th any USB peripheral when the unit is detected the user is prompted to insert the installation CD This CD will install the low level drivers which may be removed using the standard Add or Remove Programs facility for the AES Genoa USB Drivers entry In addition two other steps need to be undertaken at present manually e The interface AESIMHEI DLL needs to be copied from the installation CD to Windows System32 e The High Level driver program needs to be copied from the installation CD to a convenient folder and an entry made in the Startup folder to run this at system boot The IMHEI card is a standard PCI interface card which has the normal Windows Plug n Play automatic installation facilities When an interface card is detected in a PC the user is prompted to insert the installation CD This CD will configure the system to use the card and copy into the system directories the two elements of the interface e The device driver AESIMHEI SYS e The interface AESIMHEI DLL These provide all the software necessary to allow the user s program to access the money handling equipment Money Controls 2008 All rights reserved Page 46 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 10 2 Operation The Milan unit contains an embedded processor that is responsible for all communication with the peripherals It handles the event based protocols and uses the results to update a set of state tables T
99. time If two acceptors are holding barcoded tickets at the same time the second will not be reported until the first has completed All the barcodes processed by the IMHEI system are in the format Interleaved 2 of 5 and are 18 characters long Functions return a 19 character NULL terminated string Barcodes read by the IMHEI can also be printed if a dedicated barcode printer is connected 16 1 Barcode Reading 16 2 BarcodeEnable 16 21 1 Synopsis Change the mode of operation of all Barcode capable acceptors to accept tickets with barcodes on them The BarcodeEnable call is used to start using the Barcode system void BarcodeEnable void 16 21 2 Parameters None 16 21 3 Return Value None Money Controls 2008 All rights reserved Page 97 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 16 3 BarcodeDisable 16 31 1 Synopsis Change the mode of operation of all Barcode capable acceptors back to the default mode in which only currency is accepted void BarcodeDisable void 16 31 2 Parameters None 16 31 3 Return Value None 16 31 4 Remarks 1 If a Barcoded ticket is currently held when this call is made it will be returned without comment Money Controls 2008 All rights reserved Page 98 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 16 4 BarcodelnEscrow 16 41 1 Synopsis This is the regular polling call that the application should make into the DLL
100. to obtain the current status of the barcode system If a barcode is read by an acceptor it will be held in escrow and this call will return true in notification of the fact bool BarcodeInEscrow char BarcodeString 19 16 41 2 Parameters 1 BarcodeString A pointer to a buffer of at least 18 characters into which the last barcode read from any acceptor is placed This will be all NULL if no barcoded ticket has been read since system start up 16 41 3 Return Value The return value is true if there is a barcode ticket currently held in an Acceptor false if there is not 16 41 4 Remarks 1 There is no guarantee that at the time the call is made the acceptor has not irrevocably decided to auto eject the ticket 16 5 BarcodeStacked 16 51 1 Synopsis Following a call to BarcodeAccept the system may complete the reading of a barcoded ticket If it does then the count returned by BarcodeStacked will increment There is no guarantee that this will take place so the application should continue to poll BarcodelnEscrow long BarcodeStacked char BarcodeString 19 16 51 2 Parameters 2 BarcodeString A pointer to a buffer of at least 18 characters into which the last barcode read from any acceptor is placed This will be all NULL if no barcoded ticket has been read since system start up 16 51 3 Return Value The count of all the barcoded tickets that have been stacked since system start up An increase in this value indicate
101. ue and can be retrieved with NextEvent calls int NextEvent EventDetailBlock EventDetail 12 21 2 Parameters 3 EventDetail NULL or the address of the single structure at which to store more details of the event given by the return value 12 21 3 Return Value The return code is 0 IMHEI NULL if no event is available otherwise it is the next event 12 21 4 Remarks 3 Inthe case where one or more events are missed the code IMHEl_OVERFLOW will replace the missed events 4 If only basic information is required then as note coin amp Dispenser event codes do not overlap the EventDetail parameter can often be set to NULL as the device is implicit in the event 5 The values for the EventCodes returned are in the separate header file ImheiEvent h see Appendix 1 6 The RawEvent field for various drivers is as follows Driver Software Raw Code for Event Raw Code for Fault ccTalk coin Byte from Read Buffered 1 byte of Perform self test Credit response response ccTalk note Byte from Read Buffered Bill 1 byte of Perform self test Events response response Ardac II note ID 003 Response to Status Poll The byte following a FAILURE response GPT note MDB Bill Acceptor MDB Changer Money Controls 2008 All rights reserved Page 74 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 12 3 AvailableValue 12 31 1 Synopsis The Ava
102. un the following screen will be shown You can output to a log file by adding a parameter to AESWDriver start line This will generate a time stamped log that will show driver and PayLink events There will be no GUI when this is performed 7 AES Windowed USB Driver Output from Driver gpen ina Genoa USB u 10 popada t ndiso Description Genoa USB Hu Manufacturer Aardvark AE up USB unit eed OP Interface memory set Exec Task DP App took 74 msec Show Traffic The contents of this screen should be similar to the one shown above The status LED on PayLink will now Flash GREEN to indicate that the driver is working correctly Refer to Table 3 Status LED table for information This driver MUST be run before running the demo software Money Controls 2008 All rights reserved Page 36 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 7 2 MilanDiag exe This is a Diagnostics program which shows various information about PayLink such as the peripherals which are connected and the version number of PayLink firmware Diag exe is found in the following directory PayLink SDK screen will be shown 7 Aes Diagnostics When the application is run the following DEX ment K Clear 3 Copy All EB Save B Print Clear clears the screen System Information File Edit Help m Pause dai Pause This Diagnostic Dutput pauses the gt application Milan
103. unctions the game programmer could determine say the exact reason that an attempted payout failed and then notify either and engineer or a cash collector 3 Utility Functions Money Controls 2008 All rights reserved Page 44 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 These miscellaneous functions are concerned with the administration of the game system 4 Note Reader Escrow Here you will find functions that enable the escrow feature provided by note acceptors to be easily used 5 Meters Counters This section is concerned with the support of the SEC meter a small external unit that allow audit numbers to be maintained 6 E2Prom The IMHEI units incorporate E Prom storage for internal configuration storage Some of this is made available to the PC programmer 7 Barcode Reading Here you will find functions that enable the barcoded ticket features provided by some note acceptors to be easily used 8 Barcode Printing These functions are used by the IMHEI units to support a Ticket Printer which will produce barcoded tickets 9 Engineering Support These functions provide full blown diagnostics and reconfiguration facilities Money Controls 2008 All rights reserved Page 45 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 10 Getting Started 10 1 Installation The Genoa PayLink unit is a standard USB 1 1 peripheral Installation of the OS driver is as wi
104. user s application to easily use switches in two modes 1 Key Press Where a button may be pressed several times and it is important to know how many times 2 State Where the switch changes over a long time frame and all the application needs to know is where the switch is at any instant 6 8 Outputs gt 8 Individual external LED s are supported by the unit and are easily accessible by the user s application gt 8 high power lamp outputs are supported by the unit and are easily accessible by the user s application 6 9 Serial meter gt One external meter with an SPI interface corresponding to that defined by Starpoint is supported gt The PayLink board fully supports all 31 of the Starpoint s counters gt Provision is made to allow the user s application to easily support the BACTA standard for displaying counter values as well as to implement any other scheme gt The PayLink board continually checks that the meter is operation Money Controls 2008 All rights reserved Page 35 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 7 7 1 Using PayLink This section shows how to run and use various programs all of which are provided on the PayLink distribution CD AESWDriver exe the PayLink driver MilanDiag exe diagnostics program Demo exe API example Firmware exe upgrade program AESWDriver exe AESWDriver exe is found in the PayLink directory When the application is r
105. ust be non zero e Set Coin PathSwitchLevel to the Coin PathCount value at which the dispenser becomes full This must be non zero e g General Cash box on route 4 coin 1 goes to a dispenser on route 1 and a cash box on route 2 Coin PathCount is 100 and there is space for 300 more coins in the hopper e Path 1 for coin 1 4 for all other coins e DefaultPath 2 for coin 1 O for all other coins e PathSwitchLevel 400 for coin 1 O for all other coins When coins are routed to the dispenser via the Coin Path route the variable Coin PathCount is incremented When PathCount reaches PathSwitchLevel further coins are routed to the coin cash box As the dispenser pays out coins the PathSwitchLevel should be increased by the corresponding amount Further coins will then be routed to the dispenser again until the new switch level is reached Money Controls 2008 All rights reserved Page 67 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 200 11 134 PAYLINK ROUTING FLOW DIAGRAM Route Switching is Enabled when Coin Coin PathSwitchLevel and Coin DefaultPath are both non zero Route Switching is Disabled when Coin PathSwitchLevel and Coin DefaultPath are both zero Route Switching Enabled If one setting is zero and the other is non zero then operation is not defined Yes No Switching Configured Switching Not being used v Coin PathCount
106. yLink unit provides a Serial Number This is pre set during manufacture to AE000001 but is not used or checked in a system that does not have multiple units When the AESWDriver program is run the default is for it to search all USB devices that may be a PayLink and connect to the first one it finds When the S lt SerialNo gt switch is provided on the command line this has two effects Firstly it causes the driver program to create a named PayLink unit interface area which can then be connected to by an OpenSpecificMHE call with a matching parameter Secondly it causes the driver program to search all USB devices that may be a PayLink until it finds one with a matching programmed serial number The serial number is not associated with the PayLink firmware and any release of PayLink firmware may be used in a multiple PayLink system The PaylinkSerial utility is available as a part of the released SDK which takes as a parameter a serial number and programs it into the single PayLink unit currently connected to the system Money Controls 2008 All rights reserved Page 72 of 104 PayLink Technical Manual TSP129 Issue 1 5 August 2008 12 Utility Functions 12 1 CheckOperation 1 11 x 12 11 1 Synopsis This call allows an application to check that the PayLink and its connection to the PC are operational It also allows the application to automatically close down currency acceptance in the event of any PC malfunction

Datasheet PayLink Lite USB

Contents

Download Pdf Manuals

Related Search

Related Contents