With wiegand converters; usb & rs-232 configuration software for use with pcprox proximity readers, wiegand to xxx converters, andair id enroll contactless smart card read-only readers (56 pages)
Page 1
, pcProx Plus , AIR ID ® ® ® Enroll Wiegand Converters Configuration Utility User Manual www.RFIDeas.com 99009010b...
Page 2
Plus, and AIR ID Enroll Configuration User Manual THANK YOU! Congratulations on the purchase of the pcProx, pcProx Plus, or AIR ID Enroll device. RF IDeas knows you will enjoy using the new device as much as we enjoyed creating and developing it! Configuration is easy so you will be able to quickly take advantage of a more secure environment in your business, school, or organization.
Page 3
"on line" or electronic documentation. By installing, copying or otherwise using the PRODUCT, you agree to be bound by the terms of this EULA. If you do not agree to the terms of this EULA, RF IDeas is unwilling to license the PRODUCT to you. In such event, you may not use or copy the SOFTWARE PORTION OF THE PRODUCT, and you should promptly contact the vendor you obtained this PRODUCT from for instructions on return of the unused product(s) for a refund.
Page 4
RF IDeas or from an authorized RF IDeas dealer. Should the RF IDeas products fail to be in good working order at any time during the one-year period, RF IDeas will, at its option, repair or replace the product at no additional charge, provided that the product has not been abused, misused, repaired or modified.
Plus, and AIR ID Enroll Configuration User Manual Table of Contents Wireless Identification Overview....................8 pcProx® Proximity Activated Identification..................8 ID Card Reader System......................9 pcProx Connectors.........................11 USB Readers and Wiegand Converters...................12 RS-232 Readers and Converters.....................12 Minimum System Requirements....................12 Manufacturer/Vendor Card Compatibility..................12 Hardware Installation......................13...
Page 6
Plus, and AIR ID Enroll Configuration User Manual Wiegand Tab............................46 Keys Tab............................47 SDK/Keystroke Mode........................47 Advanced (SDK Functions)......................48 Advanced USB Keyboard Timing....................49 Delimiters Tab...........................50 Pre-card String..........................50 Post-Card String..........................51 FAC/ID Delimiter...........................51 Card Removal Tab..........................51 Data Format Tab..........................53 Fixed Length ID / FAC Fields......................53 Send ID............................54...
Page 7
Plus, and AIR ID Enroll Configuration User Manual Mac OS X........................81 Connect Serial Communications Program..................82 Command Structure.........................83 Perform a Function......................84 Assign a Variable......................84 Query a Variable......................85 Help Command........................86 Variable Command...........................88 ACP Error Codes..........................92 201 – 245 Bit: FASC – N With Appended Expiration Date..............93 Index............................94...
Proximity Activated Identification Employers are more security conscious than ever. More buildings, machines, systems, and applications require identification information to gain access. RF IDeas devices allow the building access cards to be used as a digital identifier through the workplace.
Plus, and AIR ID Enroll Configuration User Manual ID Card Reader System Prox Card pcProx Card Reader pcProx Output Formats Keyboard Emulation Card Data ASCII Output Raw Card Data SDK/API Mode Raw Card Data Page 9 of 95...
Page 10
Plus, and AIR ID Enroll Configuration User Manual pcProx Features Read all data from proximity cards • Read configuration • Write configurations • Software Developer's Kit/API compatibility • Output in decimal or hexadecimal • User controls number of digits output •...
1. ASCII output device. In this mode the user card data is read and sent as a decimal or hexadecimal number in ASCII characters. 2. API defined in the pcProx SDK. The device attaches to a computer serial port. When it reads card data, the active application receives the entire card data.
Once the device is configured and written to its flash memory, these settings will not have to be configured again. pcProx Software Installation Install the pcProx installation program to the Desktop for quick access. This installer is digitally signed by RF IDeas to authenticate file integrity for your safety . Open the www.RFIDeas.com...
Page 14
Plus, and AIR ID Enroll Configuration User Manual Click Save in the Save As window to accept the default file name. The configuration software downloads to the appropriate location. Click Run in the Download Complete window to open the configuration software and begin configuring the device.
Page 15
Plus, and AIR ID Enroll Configuration User Manual Follow the prompts to install the configuration software. If you are installing an upgrade, click the Remove radio button to remove the old configuration software before installing the new files.
Page 16
Plus, and AIR ID Enroll Configuration User Manual If the pcProx utility is open and a device is not recognized or connected to the workstation, the following message displays: There are two utilities to configure the device. The following section describes the pcProx configuration utility just installed.
Plus, and AIR ID Enroll Configuration User Manual pcProx Configuration Utility Connect Tab Device Connect Connect the configuration utility to the device's internal storage to allow reading, modifying, and writing to the device. Note: Use the helpful information that displays when the cursor rests on a field or button.
Page 18
Plus, and AIR ID Enroll Configuration User Manual Function Description Device Found The radio button identifies the type of device found (USB or RS-232). The configuration program automatically checks for a USB device first. If it does not find one, it scans COM ports 1 to 8 for a serial port device.
Plus, and AIR ID Enroll Configuration User Manual Timing Tab Get/Set Internal Timing (in msec) Control the timing for the card data on the device here. You can regulate how quickly the next card data is read. The utility reads the current device configuration. Remember, the device is sending data as if it was typing on a keyboard.
Page 20
Plus, and AIR ID Enroll Configuration User Manual Function Description Send Data Upon Read If this is checked, the card data is repeatedly sent. Generally this check box is not checked. If left unchecked, the card data is only read once. Otherwise, the card data is continuously sent.
Plus, and AIR ID Enroll Configuration User Manual Set Keystroke Data Facility (FAC) & ID Codes Enter the FAC and Card ID data here. The top section is organized consistent with the way the card data is laid out on generic proximity cards.
Page 22
Plus, and AIR ID Enroll Configuration User Manual Function Description FAC Hex Check to send this code in hexadecimal. This is set for KANTECH 10 proximity cards. Send ID Code Check to send only the ID portion of the card data.
Plus, and AIR ID Enroll Configuration User Manual Force Data to Length The following figure displays these fields. Then Neither Send FAC code or Send ID code Both the FAC and ID bits are represented by one is checked...
Page 24
Plus, and AIR ID Enroll Configuration User Manual Note: The pre and post keystroke drop-down menu list displays the keyboard characters for all USB devices. The drop-down list displays ASCII characters for serial devices. Function Description Enable FAC/ID Character Check to use a separator character between the FAC and card data.
Plus, and AIR ID Enroll Configuration User Manual Advanced Tab Use this tab to control the advanced features of the device. Note: If Enables quiet mode for usage with the Software Developer's Kit is checked, only the Parity Bit fields are enabled on the Set Keystroke Data tab. If the SDK is being used, all keyboard/character related fields do not apply.
Page 26
Plus, and AIR ID Enroll Configuration User Manual Function Description Check to display a LED. Check to display a green LED. Green The following table further explains controlling the LED. Then SDK Controls LED is checked The LED is off.
Note: This section does not apply to the RS-232 readers since these are attached to individual COM ports. This field displays the number of readers connected to the workstation. Up to 16 different pcProx or AIR ID Enroll USB readers can be connected to the on their workstation at one time.
Plus, and AIR ID Enroll Configuration User Manual Software Developer Kit Mode Software developer’s kit (SDK) is a software application interface that assists software developers, authors and IT professionals to integrate card data to a physical device or database/software program.
Page 29
Plus, and AIR ID Enroll Configuration User Manual The following figure displays these fields. GET ID Use GET ID to determine the card format. Note: Present the card on the device and click GET ID at the same time for the results to display.
Plus, and AIR ID Enroll Configuration User Manual Characters Sent When Card is Removed The RS-232 device is capable is sending two ‘Card Gone’ characters whenever the card is removed. Use the pull-down character selector boxes to choose the desired ASCII characters. These characters will be sent once the data is valid for entry field has elapsed.
Page 31
Plus, and AIR ID Enroll Configuration User Manual Function Description Euro Key Pad Check to make the device compatible to Europe's AZERTY keyboard. The USB key codes for the numeric key pad instead of the top number row on the keyboard are enabled to overcome the AZERTY keyboard differences.
Page 32
AIR ID Enroll Configuration Utility window. Click the Read pcProx or AIR ID button if changes were made and you want to return to the configuration that was previously written to the device and abandon all changes made to the configuration.
Plus, and AIR ID Enroll Configuration User Manual Card Formats Tab About Bit Formats on Proximity Cards This tab defines the bit formats on proximity cards. Please go to www.RFIDeas.com and follow the Support Learning Center path for more details.
If there are readers that require several unique configurations, create each configuration file and save each with a .HWG file name extension to the RF IDeas folder. For example, a HWG file could identify a specific device configuration. Be aware that if the device is reading cards while you are configuring the device, the device might type the card data directly into the active document/window.
Page 36
Save all different device configurations to a .HWG file. If you are using different card types, the .HWG file can quickly display the specific configuration for each card type. Click Open to save the .HWG file in the RFIDeas/pcProx folder. The Open button in the Save As window saves the file.
Files\RF IDeas\pcProx folder to open a specific configuration file. There are also predefined files in this directory that are configurations for different card types. Click Open to display this configuration in the utility. Click Write to pcProx or AIR ID to save this configuration...
Page 38
Plus, and AIR ID Enroll Configuration User Manual pcProx Plus Configuration Utility Page 38 of 95...
Plus, and AIR ID Enroll Configuration User Manual pcProx Plus Configuration Utility Use the pcProx Plus to configure FIPS 201 CHUID or pcProx devices. The pcProx Plus utility allows for more delimiters to be added with the card data and offers the 'Bit Wizard' function to determine which bits are card ID and which are FAC.
Plus, and AIR ID Enroll Configuration User Manual Read Button Click Read to display the current device configuration. Factory Default Settings Button Click Factory to set the configuration back to the factory default. This automatically flashes the device and then reads back the default configuration.
Plus, and AIR ID Enroll Configuration User Manual Bit Wizard Button The Bit Wizard is discussed in detail in a later section below. Flash Button Click Flash to write the new configuration to the device's flash memory. A message displays in the lower left of the window while the configuration is saved to the device's flash memory.
Plus, and AIR ID Enroll Configuration User Manual File Menu The file menu lists the same commands as the Button Bar. It also includes the Exit command. Help Menu The Help menu lists the following commands: Commands Description Help Click to open the pcProx Plus User Manual.
Note: The device connected that displays in the lower right hand corner matches the device information on the Connect tab. If the device is an AIR ID FIPS 201 or pcProx Plus reader, the Delimiters, Card Removal, and Data Format tabs are not necessary. These functions are all configured on the Fields tab.
Plus, and AIR ID Enroll Configuration User Manual Function Description Auto Focus Check to automatically place the cursor in the test area to the right to see card data as it is read. Auto Clear Check to automatically clear the previous card data when the next card is presented to the device.
Plus, and AIR ID Enroll Configuration User Manual Wiegand Tab Use this tab to configure the bits the device reads from the ID token. Function Description Read only cards with this bit No data is sent from the device unless the bit count is matched.
Plus, and AIR ID Enroll Configuration User Manual Keys Tab Use this tab to configure the device's keyboard parameters and Software Developer's Kit (SDK) advanced features. SDK/Keystroke Mode Function Description Enable quiet mode for If using the SDK, check to stop the device from sending any card Software Developer's Kit data as keystrokes or ASCII characters.
Plus, and AIR ID Enroll Configuration User Manual Advanced (SDK Functions) Function Description GET ID(8) Click while scanning a card over the device. The ID displays under the button. This returns 64 bits maximum. GET ID(32) Click while scanning a card over the device. The ID displays under the button.
Plus, and AIR ID Enroll Configuration User Manual GetQueuedID Data Display HH:MM:SS displays – 00:00:09. Advanced USB Keyboard Timing Function Description Inter-key 'Press' Enter the length of time the key is held down. The minimum value is 4.
Plus, and AIR ID Enroll Configuration User Manual Delimiters Tab Use this tab to configure pre and post delimiters. A delimiter can also be set between the ID and FAC card data. Click the appropriate keyboard icon to select the pre and post delimiters. Click Insert.
Plus, and AIR ID Enroll Configuration User Manual Post-Card String Select from 0 to 4 characters to send after the card data is sent. These first three characters are shared between the pre and post string. FAC/ID Delimiter Select a character to display between the FAC and ID data.
Page 52
Plus, and AIR ID Enroll Configuration User Manual Click <NONE> to remove any characters. Page 52 of 95...
Plus, and AIR ID Enroll Configuration User Manual Data Format Tab Use the Data Format tab to set the length of the ID or FAC data, 64 bit math, and HEX numbers sent from the device. Note: When Fixed Length ID / FAC Fields, Send ID, and Send FAC are checked the other fields are enabled.
Plus, and AIR ID Enroll Configuration User Manual Send ID Function Description Send ID Check to send the ID portion of the card data from the device. Send ID as hex number Check to send the ID portion as a hexadecimal number.
Plus, and AIR ID Enroll Configuration User Manual Card / LED / Beep Tab Use the Card / LED / Beep tab to configure the pcProx, OEM board, LED and Beep. Card Function Description Card data valid for Enter the time the card data remains valid in the device.
Plus, and AIR ID Enroll Configuration User Manual OEM Boards Only Function Description Beeper on Check this to turn the device beeper on. Energize Relay Check this to activate the OEM board. Function Description LED Controlled by card reader Select this to make the device set the LED color.
Plus, and AIR ID Enroll Configuration User Manual Fields Tab This tab allows manipulation of all fields on the Federal Information Processing Standard (FIPS) 201, iCLASS, MIFARE or proximity cards. Use the red buttons to configure additional fields. The fields can be moved to change the order displayed in the binary bit pattern display.
Plus, and AIR ID Enroll Configuration User Manual Function Description Advanced Click to display the binary bit pattern. GetID Click to display the binary bit pattern captured from the card. Start Bit Enter a number to define the left most significant starting bit for the field.
Page 59
Plus, and AIR ID Enroll Configuration User Manual Note: The message that displays the number of bytes used and how much room for keystrokes above the Advanced button is determined by the device's flash memory. In this example the configuration is: “Keystrokes: 8 of 32 bytes used.
Plus, and AIR ID Enroll Configuration User Manual Get ID Click GetID and scan the card to display the output format of the FIPS 201, iCLASS, MIFARE and proximity card and the interpretation display of the card data. Click GetID to define the fields to set up the device.
Page 61
Plus, and AIR ID Enroll Configuration User Manual The Start Bit changes the actual location of the selected field on the binary bit pattern. Note: The '???' that display to the right of the Digits field indicate the BCD parity is incorrect. Verify the correct field is selected.
Page 62
Plus, and AIR ID Enroll Configuration User Manual Change Fields Configuration Click on the appropriate field button and uncheck Enable to remove field data from being displayed. In the example below, the Agency, Personal ID, and Expiration Date fields have been removed.
Page 63
Plus, and AIR ID Enroll Configuration User Manual Assign Preceding Keystrokes If Enable is checked for a field, specific keystrokes can be assigned to precede card data output. Note: The Scan Code output for the key selected displays above the list of keys.
Page 64
Plus, and AIR ID Enroll Configuration User Manual Each single keystroke entered to precede card data equals 1 byte of memory. Page 64 of 95...
Page 65
Plus, and AIR ID Enroll Configuration User Manual If any special character in the left column except for 'Left Shift' is selected with a keystroke, this equals 2 bytes of memory. Page 65 of 95...
Page 66
Plus, and AIR ID Enroll Configuration User Manual If all the keystrokes have been assigned to the fields, the following message displays: Depending on the active document/window, additional functionality can be assigned to a field. For example, if the card data is read in OpenOffice, the Note feature can also be assigned.
Plus, and AIR ID Enroll Configuration User Manual FIPS 201 Card Configuration In order to configure a FIPS 201 card: Click Advanced to display the card data in the binary bit pattern to determine bit length and •...
Plus, and AIR ID Enroll Configuration User Manual Bit Wizard (Advanced Feature) Use the Bit Wizard (Advanced Feature) to select from a list of data permutations to assign to a card. Input Data Click Read Card and scan the card over the device.
Plus, and AIR ID Enroll Configuration User Manual Below is the same card data displayed in binary format. Note: These fields can be edited. Permutation Generator Change the numbers in the following fields as appropriate. These results display when Generate is clicked.
Plus, and AIR ID Enroll Configuration User Manual These are the minimum left field and maximum right field combinations for these fields. Note: Click Defaults to return to the default factory settings. Filter Enter the appropriate filters in the Filter Partial Card ID or FAC field and click Enter.
Page 71
Plus, and AIR ID Enroll Configuration User Manual Click Apply Settings to copy the configuration to the dialog controls. The Bit Wizard closes. The following message displays: Click OK. Click FLASH to write the configuration to flash memory.
Plus, and AIR ID Enroll Configuration User Manual Troubleshooting If the device is not working the following error message displays: 1. Check to be sure the device is plugged into the USB or RS-232 port. When the workstation is on and no card is being read, the LED is red.
Plus, and AIR ID Enroll Configuration User Manual Appendices Standard 26 Bit Format Structure There are several bits constructed together that comprise data sent from the proximity card to the device. There are numerous bit formats and lengths for proximity cards. The most popular is a 26 bit card format.
Plus, and AIR ID Enroll Configuration User Manual Determine Card Format It is important to determine the card data format to locate the ID and FAC bits on the card. Cards use many different bit formats. It is necessary to determine any leading and trailing parity bits and exactly how the ID and FAC are configured.
Page 75
Plus, and AIR ID Enroll Configuration User Manual Configure the Set Keystroke Data tab as shown below: Function Description Leading Parity Send FAC Code check Send ID Code check ID Fixed to this Length Trailing Parity Page 75 of 95...
Page 76
Plus, and AIR ID Enroll Configuration User Manual Check Enable quiet mode for usage with Software Developers Kit on the Advanced tab. Click Write to pcProx or AIR ID. Present the card to the reader, when the LED is green click GET ID.
Page 77
Plus, and AIR ID Enroll Configuration User Manual The card data displays in the test area. Screen should look similar to the one below. Card data format in binary is typically: parity + FAC + ID + parity There can be leading or trailing zeros to many parity bits.
Since the proximity token has no read/write memory there is no way go change this or write alpha- numeric characters such as a user name to the proximity token. Some examples are shown below. Please see RF IDeas AIR ID Playback Starter Kit or call the Sales Department if this capability is needed.
Plus, and AIR ID Enroll Configuration User Manual Configuration Examples for the pcProx The pcProx device can be configured to enter a password, log on to a system or unlock a workstation. Change Password Configuration To use the reader as a password device, first change the password. This operation is performed differently for each operating system and application.
Plus, and AIR ID Enroll Configuration User Manual No Software Log On The Set Keystrokes Data tab configures the device to insert non-printable keystroke characters at the beginning, in the middle, and at the end of the card’s unique data.
Plus, and AIR ID Enroll Configuration User Manual ASCII Command Protocol Overview ASCII Command Protocol (ACP) allows the user to talk directly to the device without a DLL or special application. The serial Prox communicates using ASCII commands. Printable ASCII commands at 9600 baud, no parity 1 stop bit, and no echo, can be sent to the device.
Plus, and AIR ID Enroll Configuration User Manual Connect Serial Communications Program Open putty.exe. Click Connection Serial and set the Speed (baud) to 9600, Data bits to 8, Stop bits to 1, and Parity to None. Flow control is not needed as there is no software or hardware handshaking.
Highlight the appropriate session. Click Save. Click Apply. Putty opens. Type rfid:help and press Enter. The Help command output displays. The complete list of Help command output is found in this section of the pcProx and AIR ID Enroll Configuration User Manual.
Plus, and AIR ID Enroll Configuration User Manual Command structure falls into one of three groups: 1. Perform a function. 2. Assign a variable. 3. Query a variable. Perform a Function A function performs an operation that may or may not display any results. A function may not be queried.
Plus, and AIR ID Enroll Configuration User Manual Query a Variable Query a single variable to display its current value. • Booleans display as true or false. • Integers display as 0..255 with leading zero suppression. • Characters display as single quoted printable ASCII characters in the range 0x20..0x7E.
Plus, and AIR ID Enroll Configuration User Manual Help Command Help displays the commands followed by its data type and expected syntax. The table below displays the Help command output. The functions display in blue. HELP COMMAND OUTPUT rfid:disp.id.hex?|=True|False...
Page 87
Plus, and AIR ID Enroll Configuration User Manual rfid:dev.part This function displays the part number of the device rfid: var This function tells the device to display the variable command output. This is similar to a .HWG file.
Variable Command The var command displays all variables. The command output can be captured and played back into the device. There must be a delay of several milliseconds after each character or the pcProx serial input buffer overflows. VARIABLE COMMAND OUTPUT rfid:disp.id.hex=False...
Page 89
Plus, and AIR ID Enroll Configuration User Manual These five variables work together to display leading and trailing (pre and post) card data delimiters. rfid:chr.1='\x00' rfid:chr.2='\x00' rfid:chr.3='\x00' rfid:chr.count.lead=0 rfid:chr.count.trail=0 The first three commands identify the pre delimiter characters that can display. Three characters may be divided up as pre and/or post delimiters.
Page 90
Plus, and AIR ID Enroll Configuration User Manual rfid:disp.fac.hex=False This command sends the FAC code in hex when true. If false, the FAC code is sent in decimal. rfid:disp.fac.send=False This command sends the FAC code if true. If false, the FAC code does not display.
Page 91
Plus, and AIR ID Enroll Configuration User Manual rfid:out.led=255 This command sets the variable and also sets the output LED color in RAM. Use cf.write to write this change to flash memory to persist across power cycles. LED Value...
Plus, and AIR ID Enroll Configuration User Manual rfid:wieg.rev.bits=False This command does not reverse all bits. If true, the least significant bits are swapped with the most significant bits. rfid:wieg.rev.bytes=False This command does not reverse all the bytes in the id.bits size field. If true, all bytes are reversed.
Plus, and AIR ID Enroll Configuration User Manual 201 – 245 Bit: FASC – N With Appended Expiration Date This output format consists of the 200 bit FASC‐N followed by the expiration date. The expiration date is 8 BCD digits long (YYYYMMDD). A field separator is placed between the FASCN and the expiration date.
Need help?
Do you have a question about the pcProx and is the answer not in the manual?
Questions and answers