- aardvark.eu.com
Contents
1. Ardac5Download lib This file describes the interface to the DLL in a way suitable for inclusion in a Microsoft Visual Studio project Ardac5DownloadBorland lib This files describes the interface to the DLL in a way suitable for inclusion in a Borland project Example The DLL has been linked into command line application to allow simple calling of the DLL without building your own application File Name Description PayLinkDownload exe An executable command line application CommanoLine c The code for the command line that interfaces to the DLL CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 12 of 16 Milan Paylink Coin Note Download User Manual Issue 0 1 6 May 2008 05 06 DLL Operation The DLL is not intended to download individual bill or coin descriptions but rather complete files of currency information The following flowchart shows the intended use of the DLL ICO StartArdac5Download DownloadS tarted Yes Ardac5DownloadStatus ThreadR unning lt No q End of Download D ExtractArdac5Firmware Version int DLL ExtractArdac5FirmwareVersion char DestinationBuffer This function is used to read the firmware version string from the Ardac5 unit Parameters DestinationBuffer The memory location where the version string is to be written to The ver2. 001 issue 0041 tab de a40 While the download is in progress the DOS program reports DownloadStatus and progress The options for DownloadStatus are defined in the DefinitionDownloadStatus section above If an error occurs during download then the TerminationStatus is also reported TerminationStatus options are defined in the DefinitionDownloadStatus section above NB The download status options are different for Ardac5 downloads See the Ardac5 section for more information CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 10 of 16 Milan Paylink Coin Note Download User Manual Issue 0 1 6 May 2008 05 06 Creating a Coin Definition file for an SR5i Money controls supply individual coin definitions which have to be combined into a single coin definition file The coin definition file can then be downloaded via PayLink to any SR5i on the ccTalk line Windows Application Run SR5FileSet exe Coin File This application allows you to select the individual coins for each slot that you want to include in the coin definition file Up to 16 coins can be selected You can include multiple definitions of the same value and or mix denominations Unused coin file slots can be left blank Browse Click the browse button and navigate to the coin definition directory Select the desired coin file A directory of coin definitions is included with this release but ma
3. ii ae ee ee ea ve Sat eh Gees 5 EXAM PIG oe E ile oad outa ele Se E E Sel esta ovate eal etd 5 DEL Operations fives cciciets nicer eee adv seek Gg Sine desde ya Ge eevee A ti 6 SetEncryptionSerialNUMbel ccccceceecceeeeeceeeeeeeeeeeceaeeeeaaeseeaeseeneecaeeeeaaesseaeeseeeeeseaeeseaaesseneeesaees 7 PAM Sucia idad 7 A tet cote cen E AAEE ATE E E EAE E cuba swale lua lbo ty cui beetla late e cad maui late 7 StartDefinition DOWMO AGS tte toba E 8 ENEE E EAE E E a ctl at cutest ds era nubeabd EE A sy tiki wbul tate caied tulle telus 8 A rn Pre ne AT 8 DefinitionDownloadStatUS titi rt ta abia 9 EEVEE EA E EA E E A E liada beca eh ects eit lea abe diced Jolla tail 9 ROTO EA EEE A A 10 DOS Command Line Application sere cerrara aero ee 10 Creating a Coin Definition file for AN SRhl oooonnnnninnnnnicninnnnccnaccnnncccnnrcann rra 11 Windows ADDICION uone en all lira ts 11 AN O AT 11 A E A EAA A E AN 11 A A NAO 11 Write SRS Goin Sete 2d P A ALEE AE A LERET 11 Eo EEEE A EEE AEE N SO Ee ee Te Se ee 11 i MPP ES SPB PRE Sg PCED E Re PEE tA OE Or Pn i Ie PES Oe PE PO OE AO PO PPA AE 11 Aldac 5 DOWN a tito dai Dada 12 Supplicd Files aaa alii idad 12 ERA E PEE T IEEE da el add 12 DLL Operati ad Ie SS 13 ExtractArdac5FirmwareVersiON s ssrdsn aer ad aeee a raaa aai ia lankeaa opipa beai tta 13 Parameters ES TA APE A EEEE A EE ERE a OEE EE E E TSE 13 CA A A O EA TTIE 13 StartArdacSDOWwnloaad EREE E AEA A nn arc na nnn EETA 14 Paramet
4. DownloadStatus DownloadStatus returns the current status of the download Valid if the Ardac5DownloadStatus return value is DOWNLOAD_THREAD_RUNNING Options are ARDAC5 DOWNLOAD_STATUS_ PROCESS _IDLE 0 ARDAC5_DOWNLOAD_STATUS_ NO RESPONSE 1 ARDAC5_DOWNLOAD_STATUS_REQUESTING_BUS 2 ARDAC5_DOWNLOAD_STATUS_ POLLING 3 ARDAC5_DOWNLOAD_STATUS_TRANSFER_COMPLETE 4 Progress Indicates the progress in range 0 1000 Returns the status of the download thread One of the following codes DOWNLOAD_THREAD_STOPPED 0 DOWNLOAD_THREAD_RUNNING k CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 14 of 16 Milan Paylink Coin Note Download User Manual Issue 0 1 6 May 2008 05 06 DOS Command Line Application The DOS command line interacts with the AESW Driver program AESDriver should be running and communicating with PayLink before running the dos command Note The same dos application is used to download to SR5i Ardac Elite Lumina and Ardac5 See the SR5i Ardac Elite and Lumina section for more information For Ardac5 downloads run the command line with the following parameters PayLinkDownload f d5 v Where HH Name and path of definition file d5 Device is Ardac5 N Check the Ardac5 version If the filename is not supplied then is ignored and the installed Ardac5 version is reported If filename is supplied then the download only performed if the installed versi
5. Milan Paylink oin Note Download 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 Coin Note Download User Manual Issue 0 1 6 May 2008 05 06 Table of Contents c0Table otiCGontentS iia ollas 2 Revision HISTO conta a 3 INTO UCHON a A a tii 4 Purpose of Docus aecttunebasctevedageeebsaschbevbayccteebaechavedapehvvdsauervvebupeteerestiy 4 Intended AUdIENC Ensinas ia inai e an E di 4 Document Layouts vrein oeir iA AA 4 CCT alk D wnloadSinsisnariiana nini a e an ii a A E E NE ese dete 5 Coin Definition FilesS oooonnnnnnnonocincnnnononononocancnnno ned aaan aaa a ae iei aaia i aoda ranei a 5 Supplied Fil Sissid Siac
6. NATION_STATUS_NOT_RESPONDING TERMINATION_STATUS_DIALOGUE_ERROR TERMINATION_STATUS_FILE_READ_FAILED TERMINATION_STATUS_UNKNOWN_DEVICE TERMINATION_STATUS_DOWNLOAD_NOT_FINISHED OONDOOARWN O Progress Indicates the number of blocks transferred CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 9 of 16 Milan Paylink Coin Note Download User Manual Issue 0 1 6 May 2008 05 06 ProgressLimit The total number of blocks to transfer Returns the status of the download thread One of the following codes DOWNLOAD_THREAD_STOPPED 0 DOWNLOAD_THREAD_RUNNING DOS Command Line Application The DOS command line interacts with the AESW Driver program AESWDriver should be running and communicating with PayLink before running the dos command Note The same dos application is used to download firmware to Ardac5 See the Ardac5 Download API section for more information For SR5i Ardac Elite and Lumina downloads run the command line with the following parameters PayLinkDownload f d a Where HH Name and path of definition file de Device is Ardac Elite the default address of and Ardac Elite is 40 ds Device is SR5i the default address of an SR5i is 2 dl Device is Lumina the default address of a Lumina is 40 a ccTalk Address decimal For example the following command line downloads the note definitions to an Ardac Elite PayLinkDownload f c temp EUGB
7. on does not match v in the parameter list For example the following command line reads the version details from the Ardac5 PayLinkDownload v The following command line downloads the firmware and note definitions to an Ardac5 PayLinkDownload f c temp x3045 07 20 06 a07 d5 While the download is in progress the DOS program reports DownloadStatus and progress The options for DownloadStatus are defined in the Ardac5DownloadStatus section above NB The download status options are different for SR5i Ardac Elite and Lumina downloads See the SR5i Ardac Elite and Lumina section for more information CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 15 of 16 Milan Paylink Coin Note Download User Manual Issue 0 1 6 May 2008 05 06 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 16 of 16
8. rdvark Embedded Solutions Ltd Page 7 of 16 Milan Paylink Coin Note Download User Manual Issue 0 1 6 May 2008 05 06 StartDefinitionDownload unsigned short DLL StartDefinitionDownload char FullFileName unsigned short ComPortNumber unsigned short ccTalkAddress unsigned short Device This function serves to start a worker thread to download the provided data block to the SR5i Ardac Elite or Lumina unit Once the download has completed successfully the PayLink unit is reset Parameters FullFileName The path and file name of the note or coin definition file ComPortNumber Not used Set to 0 CcTalkAddress Specify at which address the target device is located Coin acceptors default to address 2 note acceptors default to address 40 Device Define the type of device that is being programmed The options are DEVICE_SR5 0 DEVICE_ELITE 1 DEVICE_LUMINA Returns One of the following codes START_DOWNLOAD_TRANSMISSION_STARTED START_DOWNLOAD_CANNOT_START_THREAD START_DOWNLOAD_CANNOT_START_UNKNOWN_DEVICE START_DOWNLOAD_THREAD_ALREADY_RUNNING WN 0 The function is non blocking and sets up a thread in the background to handle the definition file download CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 8 of 16 Milan Paylink Coin Note Download User Manual Issue 0 1 6 May 2008 05 06 DefinitionDownloadStatus unsigned
9. ros e a e a e e o nt el o bak oat 14 Reload co e eto lots Deol dE Li e ie EA 14 Ardac5DOWNlOadStatus ccccccccnonccccnncononononancnnnonononenannnnnnnn nono naar cnn cnn nono nn naar anna canon naaa anna cnn nani 14 eleet E EE e eLo cto deco rita oi o de e ti lr lcd de ele 14 PROTOS cdo eet ta cate le dr e e el lo o e ek E o e LE e ae 14 DOS Command Line ApplicatiON oooooonnnninnnicnnnnnnnncnnncccnnrccnn cnn cr 15 DisclalMer da e a let pe AE T e o a T 16 CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 2 of 16 Milan Paylink Coin Note Download User Manual Issue 0 1 6 May 2008 05 06 Revision History Version Date Author Description 0 0 Draft 4 Apr 08 A Tainsh Initial description document 0 1 6 May 08 D Bush Initial revisions CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 3 of 16 Milan Paylink Coin Note Download User Manual Issue 0 1 6 May 2008 05 06 Introduction Purpose of Document The document describes how to use DLLs provided by Aardvark that enable users of MCL peripherals to use the Milan Paylink connection to download new tables describing notes and coins Intended Audience The intended audience of this document is the software engineers who are already writing software on a PC that interfaces to a Milan Pa
10. s a family of notes for coins Money Controls supply individual coin definitions which can be stored individually into any of the 16 slots available in an SR5i The Aardvark download mechanism requires these individual coin definitions and their slot assignments to be combined into a single coin definition file which is then downloaded via PayLink to the SR5i on the ccTalk line This file is produced off line using the utility described in the next section Supplied Files The following files are required to build and run the user application File Name Description DownloadDLL h This header file describes the entry points to the C functions within the DLL Includes the constant definitions used to call and return status PayLinkDownload dll This file is the DLL itself PayLinkDownload lib This file describes the interface to the DLL in a way suitable for inclusion in a Microsoft Visual Studio project PayLinkDownloadBorland lib This files describes the interface to the DLL in a way suitable for inclusion in a Borland project Example The DLL has been linked into command line application to allow simple calling of the DLL without building your own application File Name Description PayLinkDownload exe An executable command line application CommandLine c The code for the command line that interfaces to the DLL CONFIDENTIAL Not to be disclosed without prior written permi
11. short DLL DefinitionDownloadStatus unsigned short DownloadStatus unsigned short TerminationStatus unsigned short Progress unsigned short ProgressLimit CT CT MS y This function provides a mechanism for the calling application to be able to monitor the progress of the worker thread Parameters DownloadStatus DownloadStatus returns the current status of the download Valid if the DefinitionDownloadStatus return value is DOWNLOAD _THREAD_RUNNING Options are DOWNLOAD_STATUS_PROCESS_IDLE 0 DOWNLOAD_STATUS_CHECKING_FILE 1 DOWNLOAD_STATUS_OPENING_INTERFACE 2 DOWNLOAD_STATUS_ENABLING_INTERFACE 3 DOWNLOAD_STATUS_SEARCHING 4 DOWNLOAD_STATUS_REQUESTING_BUS 5 DOWNLOAD_STATUS_POLLING 6 DOWNLOAD_STATUS_ERASING_COINS 7 DOWNLOAD_STATUS_STARTING_UPGRADE 8 DOWNLOAD_STATUS_TURNING_OFF_ENCRYPTION 9 DOWNLOAD_STATUS_TRANSFER_IN_PROGRESS 10 DOWNLOAD_STATUS_TRANSFER_COMPLETE 11 DOWNLOAD_STATUS_WAITING 12 DOWNLOAD_STATUS_RESETTING 13 DOWNLOAD_STATUS_RELEASE_BUS 14 DOWNLOAD_STATUS_FINAL_WAIT 15 DOWNLOAD_STATUS_RESET_PAYLINK 16 DOWNLOAD_STATUS_COMPLETE 17 TerminationStatus TerminationStatus is the reason the download stopped Valid if the DownloadStatus return value is DOWNLOAD_THREAD_STOPPED Options are TERMINATION_STATUS_TRANSMISSION_SUCCESS TERMINATION_STATUS_FILE_OPEN_FAILED TERMINATION_STATUS_FILE_INTERNALLY_INCONSISTENT TERMINATION_STATUS_OPEN_INTERFACE_FAILED TERMINATION_STATUS_DEVICE_SEARCH_FAILED TERMI
12. sion string is typically around 40 characters Returns One of the following codes EXTRACT_VERSION_DEVICE_FOUND EXTRACT_VERSION_OPEN_INTERFACE_FAILED EXTRACT_VERSION_DOWNLOAD_IN_PROGRESS EXTRACT_VERSION_INTERFACE_TIMEOUT ono CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 13 of 16 Milan Paylink Coin Note Download User Manual Issue 0 1 6 May 2008 05 06 StartArdac5Download int DLL StartArdac5Download char FileName This function serves to start a worker thread to download the firmware and note definition to the Ardac5 note acceptor Once the download has completed successfully the PayLink unit is reset Parameters FileName The path and file name of the note of firmware and note definition file This file should be a a07 file Returns One of the following codes START_ARDAC5_DOWNLOAD_STARTED START_ARDAC5_DOWNLOAD_INVALID_FILE START_ARDAC5_DOWNLOAD_CANNOT_OPEN_FILE START_ARDAC5_DOWNLOAD_NO_COMMS START_ARDAC5_DOWNLOAD_THREAD_ALREADY_RUNNING START_ARDAC5_DOWNLOAD_CANNOT_START_THREAD akWwWN OoO The function is non blocking and sets up a thread in the background to handle the file download Ardac5DownloadStatus int DLL Ardac5DownloadStatus int DownloadStatus int Progress This function provides a mechanism for the calling application to be able to monitor the progress of the worker thread Parameters
13. ssion from Aardvark Embedded Solutions Ltd Page 5 of 16 Milan Paylink Coin Note Download User Manual Issue 0 1 6 May 2008 05 06 DLL Operation The DLL is not intended to download individual bill or coin descriptions but rather complete files of currency information The following flowchart shows the intended use of the DLL ICO y Note Definition Download tandard Encryption seria number A SetEncryptionS erial No Number Yes NewBCDS erial 4 StartDefinitionDownload TransmissionStarted DefinitionDownloadStatus ThreadR unning 4 No y d End of Download gt CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 6 of 16 Milan Paylink Coin Note Download User Manual Issue 0 1 6 May 2008 05 06 SetEncryptionSerialNumber void DLL SetEncryptionSerialNumber int NewBCDSerial This function is used to set the encryption serial number of the Lumina or Ardac Elite note acceptor with which the DLL is to try to communicate The DLL needs to know the encryption serial number of the note acceptor in order to encode messages to it and decode messages from it correctly Parameters NewBCDSerial The new 6 digit serial number in Binary Coded Decimal Returns None CONFIDENTIAL Not to be disclosed without prior written permission from Aa
14. y not be up to date Please get the latest coin definitions from Money Controls Omit Tick the omit box Y Omit to prevent the coin file being included in the Coin Definition file This is the same as having a blank coin file name Write SR5 Coin Set Once you are happy with the coin files loaded click the Write SR5 Coin Set button You are prompted for the location to save the Coin Set File Clear Coins Click Clear Coins and confirm your action to clear all 16 coin file names Exit The Exit button saves the settings and exits the application CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 11 of 16 Milan Paylink Coin Note Download User Manual Issue 0 1 6 May 2008 05 06 Ardac 5 Downloads This section describes the API that is used to download firmware and note definitions from a PC via PayLink to a Ardac 5 note acceptor A separate section describes the downloads to a SR5i Ardac Elite and Lumina Normal PayLink operation will stop while downloading firmware and note definitions PayLink is reset at the end of the download Supplied Files The following files are required to build and run a user application File Name Description DownloadDLL h This header file describes the entry points to the C functions within the DLL Includes the constant definitions used to call and return status Ardac5Download dll This file is the DLL itself
15. ylink unit Document Layout There are three main sections to this document e One section describes the API that is used to download currency definitions from a PC via PayLink to Money Controls cctalk peripherals e One section describes the utility that produces coin definition files use by the SR5I download function from the individual coin definitions supplies by Money Controls e One section describes the API that is used to download currency definitions and firmware from a PC via PayLink to the Money Controls Ardac 5 CONFIDENTIAL Not to be disclosed without prior written permission from Aardvark Embedded Solutions Ltd Page 4 of 16 Milan Paylink Coin Note Download User Manual Issue 0 1 6 May 2008 05 06 ccTalk Downloads This section describes the API that is used to download currency definitions from a PC via PayLink to Money Controls peripherals Specifically this document serves to describe the API that is used to download either e aset of note definitions to a Lumina bill validator e aset of note definitions to an Ardac Elite acceptor e aset of coin definitions to a SR5i coin acceptor A separate section describes the download of firmware and note definitions to an Ardac 5 Normal PayLink operation will stop while downloading coin and note definitions PayLink is reset at the end of the download Coin Definition Files Unlike note acceptors where Money Controls supply a single file which describe
Download Pdf Manuals
Related Search