AcroComm Programming Manual 06-0285-001 Rev.
AcroComm Programming Manual March 5, 2001 - Section 2.2 Updated - Section 2.3 Updated - Appendix A updated with all new instructions… - Appendix B updated with the new formulas. - Section 1.5 updated according to the last ACROCOMM Version. - Sections 4 and 5 updated according to the new ADCT firmware version.
AcroComm Programming Manual License Agreement Important By using this software in executable form EXE or DLL’s and the Acroprint Data Collection Terminal (ADCT) utilizing ACROCOMM Firmware you accept the following terms of this License Agreement. If you do not agree with these terms, you should not use the software and promptly return it within 30 days. Ownership Acroprint retains the ownership of this copy of the enclosed software package.
AcroComm Programming Manual 4
AcroComm Programming Manual LICENSE AGREEMENT...................................................................................................................................3 1. ACROCOMM.EXE WINDOWS -.....................................................................................................9 1.1. 1.2. 1.3. 1.4. 1.5. 1.6. 1.7. 1.8. 1.9. 1.10. 1.11. 1.12. 1.13. 1.14. 1.15. 1.16. 1.17. 1.18. 1.19. 2. INSTALLING ACROCOMM ...........................................................................
AcroComm Programming Manual 6.2.5. 6.2.6. 6.2.7. 6.2.8. 6.2.9. 6.2.10. 6.2.11. 6.2.12. 6.2.13. 6.2.14. 6.2.15. 6.2.16. 6.2.17. 6.2.18. 6.2.19. 6.2.20. 6.2.21. 6.2.22. 6.2.23. 6.2.24. 6.2.25. 6.2.26. 6.2.27. 6.2.28. 6.2.29. 6.2.30. 6.2.31. 6.2.32. 6.2.33. 6.2.34. 6.2.35. 6.2.36. 6.2.37. 6.2.38. 6.2.39. 6.2.40. 6.2.41. 6.2.42. 6.2.43. 6.2.44. 6.2.45. 6.2.46. 6.2.47. 6.2.48. 6.2.49. 6.2.50. 6.2.51. 6.2.52. 6.2.53. 6.2.54. 6.2.55. 6.2.56. 6.2.57. 6.2.58. 6.2.59. 6.2.60. 6 AW ..................................
AcroComm Programming Manual 6.2.61. 6.2.62. 6.2.63. 6.2.64. 6.2.65. 7. UF..........................................................................................................................................47 XF ..........................................................................................................................................48 XN ..........................................................................................................................................48 XS.......
AcroComm Programming Manual 8
AcroComm Programming Manual 1. AcroComm.exe Windows The AcroComm program provides the Software Developer / System Integrator the necessary tools to integrate the data collection terminals with their application. AcroComm Windows Software provides the developer the GUI front end to easily customize, configure and program the Acroprint Data Collection Terminal.
AcroComm Programming Manual 1.2. AcroComm Main Menu The main menu provides an icon tool bar for polling/programming terminals, setting time, resolving transactions, setting terminal specifications, and clearing the screen. 1.3. Parameters Menu The parameters pull down provides control of transaction storage, source of instructions keyboard or PROGRAM.CLK file and communications setup. 1.4.
AcroComm Programming Manual The transaction information can be displayed in the AcroComm window or saved as a file. For example: DATA.DAT. 1.5. Source for Instructions The source of instruction can be entered one command at a time via the keyboard or from a text file. For example: PROGRAM.CLK. 1.6. Communications Setup The communications setup allows for the standard comm port 1 through 4 communications and shared comm port through a network.
AcroComm Programming Manual 1.7. Actions Menu The Actions Menu allows you to poll, program, obtain information, update time and date, reset transactions, dial and hang up modem terminals. 1.8. Select Select terminal from list provided in the communications setup.
AcroComm Programming Manual 1.9. Poll When selecting poll, the program will send the TRANSMIT instruction to the Current Selected Clock, the clock will transmit the transactions. The computer will read them and send them to the specified destination in Transactions Destination. 1.10. Program When selecting program, the program will read the instructions or configuration values from the specified Instructions Source File, it will verify them and send them to the currently selected Clock.
AcroComm Programming Manual 1.11. Information Terminal Information provides memory status parameters, such as transaction space available, and memory used by downloading tables, including access, lockout, validation, etc. 1.12. Update Time This parameter updates the terminal’s date and time with the PC’s date and time.
AcroComm Programming Manual 1.13. Reset Before this instruction is executed, the user must make sure that the transactions were successfully polled. This function tells the terminal to erase ALL transactions stored. The program will ask for confirmation before sending the instruction to initialize. 1.14. Modem Dial If you had selected “Communications via Modem” in Communications Setup, the following two fields will be available, “Modem Dial” and “Modem Hang Up.” Select Dial Mode and Phone Number to dial.
AcroComm Programming Manual 1.15. Modem Hang up This option allows the user to terminate the telephone connection and exit the program if desired. After ending communication, the main menu described at the beginning of this section will be displayed.
AcroComm Programming Manual 1.16. Clear Window The Clear Window command erases all text in the AcroComm display window. 1.17. Help Menu The Help Menu allows you to edit the program clock file and display version information.
AcroComm Programming Manual 1.18. Edit PROGRAM.CLK The PROGRAM.CLK file is a list of programming commands that are used to configure the Acroprint terminals. Refer to Appendix A for command details.
AcroComm Programming Manual 1.19. Help - About Version information.
AcroComm Programming Manual 2. Using ACROCOMM To better understand the use of the programs in this SYSTEM, we will select certain terms to identify each logical entity in it. The SYSTEM has two programs, one loaded into the Computer and the other into the Terminal (clock), and they will be identified as follows: · The PROGRAM is the code loaded into the COMPUTER, · The CLOCK is the code loaded into the CLOCK.
AcroComm Programming Manual 2.2. Configfile.ini ACROCOMM can only work with one type of configuration at a time. The instructions that make up the configuration file (configfile.ini) are the following: Instruction Description MODEM It indicates the connection will be made through a modem. BAUDS number It indicates the speed of transmission of data that it will use, where numbers must be one of the following: 1200, 2400, 9600. PORT number It indicates which port it will use.
AcroComm Programming Manual ;To indicate the use of a modem MODEM ;Using the serial port COM2 PORT2 ;It indicates it is a network R ;Clocks’ IDs #1 #2 ;ASCII numbers of characters 3 and 4 [51] [52] (“;” Denotes a Remark Statement) Note that the BAUDS are not included because it takes the default value of 9600. There is no limit to the number of clocks that can be connected on a network, but all clock (IDs) must be included in the configuration file to prevent a malfunction in communication.
AcroComm Programming Manual Ex.: Acrocomm @configfile.ini -S#ClockId Select Clock with ascii identification ascii(character’s ascii number). Ex.: Acrocomm @configfile.ini -S[91] -M{T}or{P}number Dial a modem with telephone number given in number. Select either {T} for Tone or {P} for Pulse dialing. Ex.: Acrocomm @configfile.ini -M {T or P} number -Adestination Poll transactions from clock and add to destination file. Ex.: Acrocomm @configfile.
AcroComm Programming Manual for the selected clock. It will look forward and discard all parameters until the next –S parameter and then it will continue executing the remaining parameters, if they exist. 2.3.2. Error Codes ACROCOMM feeds back the following error codes to the operating system: 0 1 2 3 4 5 6 8 9 10 11 13 24 Successful execution. Instruction not executed. Transmission cancelled. Communications error. Transmission aborted. Did not receive response. Connection unsuccessful.
AcroComm Programming Manual 3. Using The Excel/Visual Basic Macro Polling AcroComm command line operation can be easily incorporated into Excel/Visual Basic applications. This provides extremely fast turnkey solutions for customer applications. The example in Appendix E is an Excel 97/Visual Basic application that allows the user to poll transactions into an Excel spreadsheet. The application is configurable allowing the user to turn on/off columns not required, pair punches, subtotals, totals, etc.
AcroComm Programming Manual 4. Acroprint Terminal Configuration Each clock is capable of communicating through any of the two ports it has, one is the RS232 found in all clocks; the other is either the RS485 for networks or the internal modem. 4.1. Configuration Through Badge The program has several variables that are configurable through the Configuration Badge. These variables are: Date Time Port The terminal’s identification can be changed through the Configuration Badge.
AcroComm Programming Manual (FOR MODEM TERMINAL ONLY) Select option 1 for Modem Select the Modem baud rate 0 for 1200 and 1 for 2400 baud Select the Answer Window HHMMHHMM for starting and ending times (Time is in military format.
AcroComm Programming Manual 4.1.3. Configuring Procedure for Selecting the READERS: Swipe the Configuration Badge 000000000 (This badge is provided with each terminal.) (Select any combination 1234 to activate the readers. 1 for Internal Barcode, 2 for External Barcode, 3 for Internal Magnetic Stripe and 4 for Internal Proximity Reader.) Note, if 4 is selected then the External Barcode Reader will be disabled. Note, if you turned OFF all readers you will be unable to read the configuration badge.
AcroComm Programming Manual 5. About the CLOCKS The Acroprint Terminal CLOCK works as a data collection terminal. It receives the badge through any of the available sources. It validates it, and stores the transaction. 5.1. Badge Validation Criteria This type of clock uses extensive validation criteria: · The badge length is configured by the parameter BL. You can swipe any badge with an alphanumeric number in length equal or lesser than the number specified in the parameter BL.
AcroComm Programming Manual 5.1.2. Diagnostic Mode When the terminal is in idle mode, after having displayed the time and date on the display for the first time, press the sequence and the terminal will enter into a Diagnostic Mode that allows you to verify the accuracy of the terminal’s readers. Immediately, the terminal displays the following information: I-P-B-N-X-M-S 1-1-3 -1-1 -0-0 This indicates configuration of the terminal as follows: I: P: B: N: X: M: S: Terminal ID number.
AcroComm Programming Manual Messages, and there is a message for that badge that should be displayed for the executed function, it will display the message after soliciting the function. 5.1.4. Lockout The Lockout Assignment Table is loaded into the clock with the command PE, and the Lockout Definitions Table with the command PF. The profile control works as follows: 1) An employee executes a function defined to check the lockout table. 2) The program checks the Lockout Assignment Table.
AcroComm Programming Manual 4) The screen shows: ‘Date (DDMMYY):’, ‘120696’ to allow you to edit the date the swipe will have. 5) The screen shows: ‘Time (HHMM):’ ‘0800’ to allow you to edit the time the swipe will have. 6) After editing the time and date, the program will continue to execute as when a badge is swiped. It will ask for the function and will execute it. The transaction searches are only done to transactions for the current day, and it stops with the first transaction it finds.
AcroComm Programming Manual 6. Appendix A: Configuration Instructions Format 6.1.
AcroComm Programming Manual 6.2. Command List Formats The configuration instructions format that are allowed to be sent are listed below: 6.2.1. AC Access Table Entry Format: AC=FGGGGG F: GGG..: 1-first record, 0-subsequent Badge number, or ‘A’ to give access to all badges where An entry of AC=0 will erase the Access Table 6.2.2. AD Access Signal Length Format: AD=NNN NNN: Access Signal Length in tenths of second. This is also the signal duration when the external light box is in use.
AcroComm Programming Manual The access window is a period of time when the access signal will be continuously on. 6.2.6. AX Access Control Mode Format: AX=N where N: 6.2.7. can be 0-No access, 1-Automatic, 2-Permanent Access BC Badge Security Prefix Format: BC=XXXX... where XXXX... is the prefix that all badges must have. The instruction ‘BC=’ disables this validation criteria. 6.2.8.
AcroComm Programming Manual 6.2.11. BS Bell Schedule Record Format: BS=FSSSSSSSHHMMDD F: S: Flag to indicate initial entry (1) or subsequent (0); Day of the week this alarm will be active, from Sunday to Saturday (0 or N – Not Active, 1 or Y – Active) Hour and Minute the signal will be sent to the alarm Duration of signal in seconds where HHMM: DD: Each instruction, as described above, represents a record in the Alarm Table. It must be entered in ascending order by hour and minute.
AcroComm Programming Manual AA Bit 7: Reserved. Bit map (1 Byte) given in HEXADECIMAL format (2 characters) to indicate several actions with the transaction. Each bit means: Bit 0: Allow transaction. Bit 1 y 2: Reserved Bit 3: Allow only with Supervisor Badge. Bit 4: Save the transaction if allowed. The on line transaction feature uses its own communication program with the computer and is not compatible with the ACRCOMM.
AcroComm Programming Manual where NN..N: An alphanumeric field of 10 positions. This is the facility code that is recorded on the Proximity Cards to verify their authenticity. If a card does not match this code, it will be treated as an invalid badge. 6.2.19.
AcroComm Programming Manual When the biosensor is disabled, then the FIU will read anything that is placed on the FIU, even if it is not a live finger. 6.2.22. FT Fingerprint Reading Waiting Time Format FT=XXX Where X is the time in tenths of a second the terminal will wait for reading a fingerprint from the FIU when it is registering or validating a fingerprint. This time is counted after the badge is swiped. Default 30 (3 seconds). 6.2.23.
AcroComm Programming Manual 6.2.25. IB Invalid Badge Message Format: IB=XXXXXXXXXXXXXXXXXXXX where XXX… string up to 20 characters The default is “INVALID BADGE.” 6.2.26. II Invalid Source Message Format: II=XXXXXXXXXXXXXXXXXXXX where XXX… string up to 20 characters The default is “INVALID SOURCE.” 6.2.27. IP Message that will be constantly displayed on the first line of the clock’s screen as the company’s ID,: Format: IP=XXXXXXXXXXXXXXXXXXXX where XXX... string up to 20 characters.
AcroComm Programming Manual 6.2.31. LD Show additional message Format: LD=Y where Y: Y or N, 1 or 0. Indicates if an additional message will be displayed to validated entry. 6.2.32. LE Validation table entries Format: LE=LFNNN…MMMMMMMMMMMMMMMM where L: F: NN..: Table number from 0 to 3. 1 for first entry, 0 for subsequent. Data to add. The length is determined by the LL command if the data is only to be validated. If the badge is being validated, it should be added at the end of the data. MMM..
AcroComm Programming Manual 6.2.35. MA Modem Answer Window Format: MA=SSSSEEEE where SSSS: Start Answer Window (default 00:00) EEEE: End Answer Window (default 23:59) Indicates what time window of the day the terminal will answer the telephone 6.2.36. MD Ring Delay Format: MD=X where X: number of ring delays 1-9 One ring delay equals about 2.5 seconds (default 1) 6.2.37.
AcroComm Programming Manual where X: Is the time in tenths of a second the terminal will wait for a response from the host when a transaction is generated on the clock and sent to the host. If X = 0, then the on line transmission is disabled. Anytime OT is different than ‘0’ the terminal will be in online transmission mode even if the terminal is restarted. 6.2.40.
AcroComm Programming Manual An entry of PF=0 will erase the Profile Table. Each profile uses 40 bytes of memory, thus there must be enough memory allocated to store the profiles needed. 6.2.43. PL PIN Definition Format: PL=NN where NN: Any number between 0 and 30. When the value of NN is other than 0, the Personal Identification Number (PIN) will be automatically activated, and NN will be the length of the PIN. The default is 0 for no PIN required. 6.2.44.
AcroComm Programming Manual MMM..: A: S: B: T: 16 character message Allow check (Y-Yes, N-No) Allow supervisor access Emission bell (A-Accepted, R-Rejected, N-None) Displayed Message Time 6.2.47. RA Register Invalid Transactions Format: RA=F where F: Y or N, 1 or 0 An invalid transaction will cause an X character to appear on the function field.
AcroComm Programming Manual 6.2.51. SN Message that will be constantly displayed on the second line of the clock’s screen as the company’s ID,: Format: SN=XXXXXXXXXXXXXXXXXXXX where XXX... string up to 20 characters. The clock’s screen has two lines of 20 characters each. This string will be displayed on the second line. 6.2.52. SOT Start Online Transaction transmission mode Format: SOT This instruction sets the terminal in online transmission mode if OT is different than 0. (See OT for more details.
AcroComm Programming Manual 6.2.58. TD Terminal Mode Format: TD=NN where NN is the time in 1/50 of a second the terminal will wait between transactions when sending transactions in terminal mode. If the clock is set in terminal mode then 3 operations can be performed with a terminal client in the computer. These are: #[id]X1:Extracts the transaction header. #[id]X2:Extracts the transactions file #[id]X3:Clears the transaction memory in the terminal.
AcroComm Programming Manual 6.2.62. XF Access Off Message Format: XF=XXXXXXXXXXXXXXXXXXXX where XXX…up to 20Characters 6.2.63. XN Access On Message Format: XN=XXXXXXXXXXXXXXXXXXXX where XXX…up to 20Characters: 6.2.64. XS FIU Security # Format: XN=XXXXXXXXXX where XXXXXXXXXX is the security code assigned to individual FIU: 6.2.65. ZZ Terminal Locked Format: ZZ=F where F: Y or N, 1 or 0 When set to 1 or Y, the terminal rejects all transactions received.
AcroComm Programming Manual 7. Appendix B: Table Size Calculations 7.1. Formulas to Calculate Table Size This formula may be used to determine the values that will be sent to the clock in the instruction MP. 7.1.1. Fingerprint Table To calculate the size of the FIU table, use the following formula: Size of Table = (Badge Length + (2 X Fingerprints per employee)) X (Total number of Employees) 7.1.2.
AcroComm Programming Manual 7.2. Remaining Space for Transaction Storage Total Memory Available (114,000 Bytes) Access Table Size Profile Assignment Table Size Profile Definition Table Size Employee Messages Table Size Total of Level Validation Table Sizes Remaining Space for Transaction Storage To calculate the approximate number of transactions that can be stored in that space, let’s consider that the majority of transactions stored will be normal, that is Swipe & Go, In, Out.
AcroComm Programming Manual 8. Appendix C: Using the Keyboard to Edit Data To edit data, we use the CLOCK’s numeric keyboard’s alphanumeric capability, using the key. Each number has a triad of letters encoded. To enter a letter, the number into which that letter is encoded must be pressed, followed by pressing the key as many times as the position of the letter in that triad. The following table shows how to enter each letter of the alphabet, as well as some punctuation marks supported.
AcroComm Programming Manual the first position and the key is pressed, the edit process will be aborted. Press when finishing editing the data. Data editing also allows entries through a badge. When there is a badge entry with a length larger than the length allowed in the edit mode, a beep will sound and the entry will be rejected. Editing as data entry, has a wait period, determined in the company’s data configuration.
AcroComm Programming Manual 9. Appendix D: Transactions Output Format 9.1. Header Record Format Generally, there is only one header record at the beginning of the table, and it is internally generated when the table is empty. It has the following format: T#,YYYYMMDD where T#: Network Clock ID (1 byte) YYYYMMDD: Operations start date (Y=year, M=month, D=day) 9.2. Change Date Record Format This indicates the clock’s date change.
AcroComm Programming Manual where HHMMSS: S: Time of transaction Source of transaction (1-keyboard, 2-magnetic strip,3-bar code, 0-erased record) BBB..: Supervisor badge number, variable length F: Supervisor Function (@) YYYYMMDD: Date required for record HHMM: Time required for record from #3 through the end, the record is identical to the Normal Transaction Record, from that record’s #1 indicator through the end. 9.5. Terminal Memory Information ACROCOMM –S#1 –Hheader.
AcroComm Programming Manual 10. Appendix E: Sample Excel/Visual Basic Templates 10.1. Getting Started Terminal Connections Setup the Acroprint Terminal communications using the configuration badge, for either RS232 or RS485 communications, the Clock ID = 1 and the Baud rate = 9600. Connect the Acroprint Terminal to a standard RS232 or RS485 (converter required) PC serial port (COMM 1 required for Excel Macro Sample provided). Refer to the Acroprint Terminal hardware manual for port connection details.
AcroComm Programming Manual 10.4. Main Menu The main menu provides the means to poll, select data viewed, pair punches, totals and subtotals, append data to a standard excel sheet.
AcroComm Programming Manual 10.5. Commands · Poll Poll terminal transactions into Excel · Configure Configure program setup · Pair Punch Pair punches · Sub-Total Produce subtotal by employee · Total Produce Totals · Sort Sort by three fields · Print Setup Print spreadsheet info · Delete Data Delete all data · Hide Choose the columns to display · Top Adjust spreadsheet to top · Arrows Scroll up and down the spreadsheet 10.6.
AcroComm Programming Manual 10.7. Visual Basic Source Code The following is a Visual Basic Source used in the example POLL_CLK.5.3.4.XLS. The SHELLARG command is used to poll/program the Acroprint terminals. The DATALOG.DAT is a temporary file used to store previously polled data. The data is then stored in an Excel spreadsheet. The source code for this example may be copied, used/altered/modified and included in your own application.
AcroComm Programming Manual 11. Appendix F: ASCII CODE LIST Id’s 0-9 and A-Z can be programmed via the keypad of “ADCT” terminal. All other codes must be programmed via Acrocomm.exe command line. For example, to program “!” terminal ID, type T#=[33] from the command line and reboot the terminal. ASCII Code Character 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 to 57 58 59 60 61 62 63 64 65 to 90 91 92 93 94 95 96 97 to 122 123 124 125 126 ! “ # $ % & ' ( ) * + , .
AcroComm Programming Manual 12. Appendix G: Glossary 0 -9 - Functions available for specific purposes as defined by the user. Access Table – A list of valid badge numbers that have access control. ACROCOMM - A program that allows the user to communicate with the clock. Without this program, the clock cannot communicate with any entity. ACROCOMM: Command Line - The ACROCOMM program can be run from the DOS prompt with any tasks to be performed specified as parameters.
AcroComm Programming Manual WAIT number - An instruction indicating how long (in seconds) the program should wait for a response from the CLOCK after sending an order.
AcroComm Programming Manual 13. Index About the CLOCKS........................................ 29 AC .................................................................. 34 Access Control Mode ..................................... 35 Access Only Clock ......................................... 34 Access Signal Length...................................... 34 Access Table................................................... 49 Access Table Entry......................................... 34 Access Window .........
AcroComm Programming Manual PROGRAM .................................................... 20 Programming Function Instructions................ 38 PX............................................................. 44, 45 R .............................................................. 21, 23 RA .................................................................. 45 Register Invalid Transactions ......................... 45 Reinitialize the terminal.................................. 36 RST..........................
AcroComm Programming Manual 64
