Paylink Configurable Driver V1.2 2012
Contents
1. standard cfg in the folder from which it is run The exact configuration of the driver program itself can be accomplished by two means with identical results On the command line itself switch parameters can be used as follows S Paylink Serial is used in multiple Paylink installations and specifies the serial number of the Paylink device that this driver is to connect to L Log File Name is the full path to the desired log file Z K Bytes gt is the maximum size the log file is allowed to reach If it reaches this size then it is renamed with a old extension added and a new file started If omitted the maximum size is 128K bytes H if this is used no window or taskbar Icon are displayed N if this is used a normal window is shown on the screen CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 6 of 14 Milan Paylink Configurable Driver Manual Issue 1 2 24 April 2012 Configuration File The single parameter to Paylink exe AESCDriver exe is a simple text file containing a set of keywords and values that describe the configuration of the Paylink Line ends are never significant and anything on a line after a slash character is ignored This section describes the make up of a configuration file In the following description UPERCASE words represent keywords which must be spelt as shown but can be in any case Optional sections a2. Milan Paylinlk onrigurable Driver User Manual This document is the property of Aardvark Embedded Solutions Ltd and may not be reproduced in part or in total by any means electronic or otherwise without the written permission of Aardvark Embedded Solutions Ltd Aardvark Embedded Solutions Ltd does not accept liability for any errors or omissions contained within this document Aardvark Embedded Solutions Ltd shall not incur any penalties arising out of the adherence to interpretation of or reliance on this standard Aardvark Embedded Solutions 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 Aardvark Embedded Solutions Ltd reserves the right to amend improve or change the product referred to within this document or the document itself at any time Milan Paylink Configurable Driver Manual Issue 1 2 24 April 2012 Table of Contents MADIC OTC OMLSIIS exis eite actua tete statutes enr e GS ue e date aenssa Mate et 2 Hevision HIStOLy 1 arti e Ur RUE ORO CREBRA GREG RR CREER ORAE ERE REF DEOR dete 3 Introduction fees ee optare ater dote Put e ere T de tu e aye va ed ap dato vae qe PEE eiut 4 Purpose of Documentaries decret eroe pee peugeot pee e qe pe pcd 4 Intended Audierice uiii eee peregre nec p dee ee ru e pct 4 Associated Document s sien ive ve eeri vee dieere Ec ue e tp e
3. 2 24 April 2012 F53 F56 Cassette Definition F53 F56 cassettes are identified by one or two magnets fitted into the case that identify the bills notes that are loaded into the cassette This section allows for this specification CASSETTE AT Identity VALUE Value MAX Max MIN lt Min gt THICKNESS lt thickness gt This specifies that the cassette with the given magnet lt Identity gt contains bills notes with the given value in cents pence Paylink will default to allowing any size note to be accepted but for added security correctly encoded length and thickness bytes lt Max gt lt Min gt and lt thickness gt can optionally be specified and will be sent to the F53 F56 during cassette initialisation Examples F56 cassettes typically contain two magnets and so a common standard configuration uses the six two bit numbers Cassette 3 Value 10000 Cassette 5 Value 5000 Cassette 6 Value 2000 Cassette 9 Value 1000 Cassette 10 Value 500 Cassette 12 Value 100 Less common are one magnet but an alternative set uses the four one bit numbers Cassette 1 Value 10000 Cassette 2 Value 1000 Cassette 4 Value 500 Cassette 8 Value 100 Original Paylink Definition The definitions required to reproduce the original Paylink configuration are Protocol cctalk on connector cctalk Coin Acceptor at 2 Note Acceptor at 40 BNV 123456 CRC Hopper at 3 Value 100 Overri
4. options for this a normal windows service installed and managed in the same way as for other services and as an alternative a Windows program AESWDriver exe In practice the service option was never completed and all Milan Paylink installations prior to release 1 12 1 25 12 1 have used the AESWDriver exe The expected use of the driver program is that during initial program development the driver is run and the program window is referred to in order to monitor and control the connection to the Milan Paylink When the system approaches a live configuration the driver program is run silently with a log file being produced for incident investigation Finally the launch of the driver is placed into the system start up files With this release of the Milan Paylink system this original program has now been superseded by a new configuring driver program which is available in two distinct forms Paylink exe which only runs under Windows where it also supports USB peripherals made by MCL and AESCDriver exe the generic driver program primarily used on Linux This new program is an enhancement of the original driver which allows for the comprehensive tailoring of a Milan Paylink system to the requirements of the individual user When Paylink exe AESCDriver exe is run it needs to read in a configuration The path to the configuration file can be provided as a single parameter if no parameter is provided then it will try to read the file
5. the AES Intelligent Money Handling Equipment Interface Milan Paylink with specific reference to the Paylink or AESCDriver program that is an integral part of this system Intended Audience The intended audience of this document is the software engineers who will be configuring the PC that will communicate with the Paylink unit itself and run the users application Associated Document s Full details of the application interface to the Milan Paylink unit are given in the associated document Milan Paylink Applications Interface User Manual Document Layout The document itself is split into a number of sections 1 Milan Paylink peripherals This section gives the background on how Milan Paylink handles the peripherals to which it can be connected 2 System structure This provides a description of how the DLL and the driver program co operate with the Milan Paylink unit over the USB cable 3 Configuration File This describes the configuration file that is required on Paylink firmware releases after 1 12 1 25 12 1 CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 4 of 14 Milan Paylink Configurable Driver Manual Issue 1 2 24 April 2012 Milan Paylink Peripherals The Milan Paylink unit contains two types of interface Interfaces to specific hardware where the oe peripheral in question is essentially fully described PayL
6. K bytes gt This specifies that a log file is to be generated Name is the full path to the desired log file the symbols are compulsory even if there are no spaces in the name lt K Bytes gt is the maximum size the log file is allowed to reach If it reaches this size then it is renamed with a old extension added and a new file started If SIZE is omitted the maximum size is 128K bytes SERIAL NUMBER lt Paylink Serial gt This is used in multiple Paylink installations and specifies the serial number of the Paylink device that this driver is to connect to CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 8 of 14 Milan Paylink Configurable Driver Manual Issue 1 2 24 April 2012 SYSTEM Details The SYSTEM keyword introduces a section of overall configuration which includes one or more of SIMULTANEOUS HOPPERS lt Count gt Earlier versions of Paylink would only run a single hopper at a time in order to protect the power supplies If an installation has the ability to run multiple hoppers at once then this parameter can be used to increase the number of simultaneously running hoppers WATCHDOG On OUTPUT lt Pin gt The CheckOperation facility already allows Paylink to discover that PC application is no longer in contact and to inhibit all the peripherals This entry causes output lt pin gt on the Paylink to be driven only when Paylink is in no
7. ON CONNECTOR Connector This starts the definition of an addressable CCNet device More information is given below PROTOCOL MDB ON CONNECTOR Connector This starts the definition of a network of MDB devices More information on this network is given below PROTOCOL F53 ON CONNECTOR Connector DELIVERY AT NONE FRONT REAR PROTOCOL F56 ON CONNECTOR Connector DELIVERY AT NONE FRONT REAR This connection will be to a single Fujitsu F56 family bill note dispenser Paylink requires the specification of the note delivery system so as to know whether to issue a delivery command and which one The cassettes for this unit can optionally be configured More information on this is given below CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 10 of 14 Milan Paylink Configurable Driver Manual Issue 1 2 24 April 2012 CCTALK Device Definition The cctalk protocol handler supports a potentially large number of note bill acceptor coin acceptor and payout devices Following the introductory PROTOCOL entry all the ccctalk devices in use on this installation have to be defined as follows COIN ACCEPTOR AT lt Address gt BNV lt Key gt CRC This specifies that a coin acceptor is to found at the specified cctalk lt Address gt and may specify that BNV encryption with the given key and or that CRC message validation is used Normally cctalk
8. coin acceptors are at address 2 and do not use BNV or CRC messages NOTE ACCEPTOR AT Address BNV lt Key gt CRC BILL ACCEPTOR AT Address BNV lt Key gt CRC This specifies that a note bill acceptor is to found at the specified cctalk lt Address gt and may specify that BNV encryption with the given key and or that CRC message validation is used Normally cctalk note bill acceptors are at address 40 28H use a BNV key of 123456 and use CRC message validation lt Type gt RECYCLER AT lt Address gt BNV lt Key gt CRC This specifies that a note bill recycler is to found at the specified cctalk lt Address gt and may specify that BNV encryption with the given key and or that CRC message validation is used As there is no standard specification for controlling recycler the lt Type gt also has to be specified A lt Type gt from the following list can be used MERKUR Arecycler using the same commands as the Merkur MD100 device VEGA A recycler using the same commands as the JCM Vega unit NV11 Arecycler using the same commands as the Innovative NV11 NV200 A recycler using the same commands as the Innovative NV200 HOPPER AT Address This specifies that a coin hopper is to found at the specified cctalk Address and may specify that BNV encryption with the given key and or that CRC message validation is used Normally cctalk hoppers are at addresses that start at 3 and increase as
9. de Yes Readout Value Hopper at 4 Value 40 Override Yes Readout Value Hopper at 5 Value 25 Override Yes Readout Value Hopper at 6 Value 20 Override Yes Readout Value Hopper at 7 Value 10 Override Yes Readout Value Hopper at 8 Value 5 Override Yes Readout Value Hopper at 9 Value 200 Override Yes Readout Value Hopper at 10 Value 1 Override Yes Readout Value Protocol ID003 on connector RJ45 Protocol GEN2 on connector 11 Protocol MDB on connector MDB Changer at 08H Bill at 30H CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 13 of 14 Milan Paylink Configurable Driver Manual Issue 1 2 24 April 2012 Disclaimer This manual is intended only to assist the reader in the use of this product and therefore Aardvark Embedded Solutions shall not be liable for any loss or damage whatsoever arising form the use of any information or particulars in or any incorrect use of the product Aardvark Embedded Solutions reserve the right to change product specifications on any item without prior notice CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 14 of 14
10. ink 199 A by the hardware 1 MDB Slave Interface General interfaces to peripherals where one of the Pap vain peeled r Milan Paylink can be connected to many different 4 8 High Power Outputs 1st 3 peripherals 5 12V d c Power Input 3 6 8 Output Lines 2nd 7 USB Type B Connector ver 1 1 The first sort of interface is identified as connectors 3 4 8 ccTalk Interface Validators amp Hoppers 6 10 amp 12 on the Paylink lid 9 RS232 Interface Ardac 5 10 8 Input Lines 1st 11 2nd RS232 Interface Printer These connectors are provided to connect 12 8 Input Lines 2nd Milan Paylink to an SEC meter switch inputs and oe LEDs or other outputs fe USB not connected PC Driver is active These interfaces may be connected or not connected but the item they are connected to is completely defined by the electrical connection so far as Milan Paylink is USB not working known Green Flashing Application not running No contact with driver Application Running Rated Voltage 12V d c 3A ae T Serial Number 4408028801 The second sort of interfaces is identified as connectors Model Number APCUSBXX00007 1 8 9 and 11 on the Paylink lid Refer to installation instructions prior to connection These connectors provide the connections to 8 7 peripherals concerned with handling currency In this case there are many possible peripherals that can be connected to the Milan Paylink uni
11. more hoppers are added MCL hoppers can be addresses from 3 to 10 Hoppers require a significant amount of configuration Any combination of the following keywords in any order can be used Note that there are three different ways to specify the coin value any combination can be used but Paylink will not use a hopper which a value has not been obtained This may be a desired operational mode VALUE Coin Value gt Specifies the default value in pence of the coins in this hopper If neither of the following two options are used then this value is fixed OVERRIDE YES Specifies the any value set up during initialisation can be overridden by the application changing the coin value If this is not specified any application originated change will be ignored READOUT VALUE Specifies that the Hopper Eprom will be read during initialisation and any coin value found will be used instead of the default if any established by the Coin Value entry AZKOYEN CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 11 of 14 Milan Paylink Configurable Driver Manual Issue 1 2 24 April 2012 The detailed implementation of cctalk commands differs between Money Controls and Azkoyen This keyword forces Azkoyen specific processing of the hopper If the hopper replies to the relevant initialisation message with a Manufacturer starting Azk then this processing is selected a
12. n Paylink Configurable Driver Manual Issue 1 2 24 April 2012 3 PROTOCOL Details PROTOCOL Name ON CONNECTOR Connector This introduces a section describing the usage of the named protocol on the specified connector The Connector is specified by its identity on the lid of the Paylink and is one of the following CCTALK or 8 The six way connector near the USB cable MDB or 1 The three way Molex KK at the other end to the USB cable RJ45 or ARDACor9 The RS232 RJ45 connector near the USB cable GEN2 or RS232 or 11 The RS232 seven way Molex KK connector on the long side Note The cctalk and MDB protocols are usually used together with unique electrical levels on the connection Paylink provides these levels on the relevant connectors and so it would be unlikely that these would specify other than the dedicated connector but doing so is perfectly valid Specific protocols that can be defined are PROTOCOL ID003 ON CONNECTOR Connector WITH ACCEPTOR RECYCLER This connection will be to a single unit either a note acceptor or a recycler using the JCM ID 003 extensions no further configuration is possible PROTOCOL GEN2 ON CONNECTOR Connector This connection will be to a Gen 2 ticket printer no further configuration is possible PROTOCOL CCTALK ON CONNECTOR Connector This starts the definition of a network of cctalk devices More information on this network is given below PROTOCOL CCNET
13. ned e n veg 4 Document Layout aerie ieiet pce emet ipee eoe pr nec e ape dea ve ee cut 4 Milan Paylink Peripherals sssini iienaa tne nennen nnne enne nnne nre rennen nnne 5 cn MET 6 sorgten wedge Tc 7 DRIVER Details iarrita contre rp ert gaude ve be Vae dete ae eg p edv ua ed e inane 8 SYSTEM Details etg d e t ee ee aee Searle nl tese eee vu Pede ce 9 PROTOCOL Detalls 5 2 eh Gh te Feast vendredi ea dae da eren es ceu baee inan 10 CGTALEK Device DefiniliQn 5 oz cioe eene cett eene te t E Re eL PR CES ERHX ET ERU ea PEARa Eaa does 11 MDB Device Definition 2 o tenete eeepc ete erret E ERA tay dre Erb x a ace pe bea 12 F593 F56 GassetteDeflnitlOn oet tit edet x tate e e o Mn De Er e a E aaa 13 Original Paylink Definition x ectetuer 13 IBICTe Coe TE AER AE T 14 CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 2 of 14 Milan Paylink Configurable Driver Manual Issue 1 2 24 April 2012 Revision History Version Date Author Description 1 0 7 Oct 10 D Bush First release 1 1 12 Feb 12 D Bush Updated for 1 12 3 1 2 24th April 12 D Bush Updated for 1 12 4 CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 3 of 14 Milan Paylink Configurable Driver Manual Issue 1 2 24 April 2012 Introduction Purpose of Document This document describes the structure of a system using
14. re enclosed in square brackets and represent sections that can be included either to give further details on the item or to make the English read better lt Values gt are enclosed in angle brackets Values can be number expressed in decimal or hex or in some cases can be pre defined keywords that map onto numbers A string of digits is held to be decimal number hex numbers can either start with Ox or end in H Shows that one of the two values on either side if the symbol must be included There are three top level keywords PROTOCOL Which describes the peripherals connected to one of the Paylink s 4 serial ports SYSTEM Which defines the ways in which the overall running of Paylink is modified DRIVER Which gives the driver itself details on how it should run CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 7 of 14 Milan Paylink Configurable Driver Manual Issue 1 2 24 April 2012 DRIVER Details The DRIVER keyword introduces a section of configuration to control the driver program itself RUN HIDDEN VISIBLE This controls the Driver window independently from the presence of a log file If HIDDEN is specified then no window or taskbar Icon are displayed e f VISBLE is specified then a normal window is shown on the screen Ifthe item is omitted then a Taskbar Icon appears but the window is minimised LOGFILE lt Name gt SIZE
15. rmal operation to allow for the control of arbitrary external equipment POWER ON ON OUTPUT lt Pin gt DELAY lt MSec gt To allow for the power on sequencing of the elements within a cabinet this allows the Paylink device to control an output that turns on a specific time after the Paylink powers up This entry causes output lt pin gt on the Paylink to be driven lt Msec gt milliseconds after the Paylink itself powers up MECHANICAL METER lt Meter No gt ON OUTPUT lt pin gt This entry can repeated up to 8 times Each entry defines to the Paylink meter functionality that a mechanical meter lt Meter No gt is connect to output lt Pin gt More details are in the API document POWER FAIL ON INPUT lt Pin gt This does not appear anywhere in the API If used this is a connection that should short this pin to ground whenever the power supply is satisfactory and go open circuit as soon as there is a problem This input is used in two places 1 As soon as this output triggers all acceptors are disabled This primarily allows coin acceptors to reject coins that will not complete correct acceptance before the power fails complete 2 The mechanical meter processing will not start a pulse if this input is not satisfactory This removes the possibility of a pulse being cut short by a power failure CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 9 of 14 Mila
16. t When initially released only a limited number of the possible peripherals could be connected and three later 4 variants were produced which specified the protocol on connector 9 Since then the number of possible configurations has grown to the point where some method is needed to tell Milan Paylink details about where to look for specific peripherals and how it should regard those peripherals when it found them The method chosen to specify this is to describe the peripheral configuration in a simple text file and to download that file to the Milan Paylink unit as the system starts up The description of this file is prime purpose of this document CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 5 of 14 Milan Paylink Configurable Driver Manual Issue 1 2 24 April 2012 System Structure A system that uses a Milan Paylink unit comprises a users application that communicates via a DLL to the Milan firmware installed on the Milan Paylink unit As the Milan Paylink unit is connected to the PC by a USB cable there has to be software at both ends of this USB link to conduct the communications over the link At the Milan Paylink end this communications software is just built into the firmware At the PC end the communications software run as a separate Windows item In the theoretical model of the Milan Paylink system there were originally intended to be two
17. utomatically TIMEOUT lt Count gt This specifies that the cctalk header 165 Modify Variable Set be used to change the payout timeout value from its default of 10 seconds to lt Count gt periods of 1 3 second This is unlikely to work on hoppers not made by Money Controls Examples Hopper at 03 Value 100 is a hopper whose value is guaranteed to be 100 Hopper at 03 Readout Value is a hopper that is unusable unless a coin value can be read out Hopper at 03 Override Yes is a hopper that is unusable unless the application sets a coin value Hopper at 03 Value 100 Azkoyen is a hopper which will be unconditionally use the Azkoyen protocol variations Existing System The equivalent definitions to the original Paylink configuration are given further on MDB Device Definition The MDB protocol allows for two changer devices and for two bill acceptors This section states which are used CHANGER AT Address This specifies that a coin changer is to found at the specified MDB Address Normally MDB coin changers are at Address 08H NOTE ACCEPTOR AT Address BILL ACCEPTOR AT Address This specifies that a note bill acceptor is to found at the specified MDB Address Normally MDB note bill acceptors are at Address 30H CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 12 of 14 Milan Paylink Configurable Driver Manual Issue 1
Download Pdf Manuals
Related Search