pcProx® Config Configuration Utility User Manual 99009010 G
Thank You! Congratulations on the purchase of your pcProx, AIR ID and/or Wiegand device(s). RF IDeas hopes you enjoy using the readers as much as we enjoyed creating and developing them. Configuration is easy, so you will be able to quickly take advantage of a more secure environment in your business, school, or organization. Please call our Sales department if you have any questions or are interested in our OEM and Independent Developer’s programs.
END-USER LICENSE AGREEMENT LICENSE AGREEMENT End-User License Agreement for RF IDeas™ SOFTWARE and HARDWARE - RF IDeas’ pcProx®, AIR ID® , Proximity Activated Readers, Software Developer’s Kit, and Proximity Reader DLLs, and Protocol(s).
nn upgrades, this EULA and, if applicable, the Certificate(s) of Authenticity), AND the recipient agrees to the terms of this EULA. If the PRODUCT is an upgrade, any transfer must include all prior versions of the PRODUCT. *Termination. Without prejudice to any other rights, RF IDeas may terminate this EULA if you fail to comply with the terms and conditions of this EULA. In such event, you must destroy all copies of the SOFTWARE PORTION OF THE PRODUCT and all of its component parts. 3. UPGRADES.
Contents 5 2 2 6 7 7 8 8 8 10 10 10 10 Chapter 1: The Basics Thank You! Wireless Identification Overview ID Card Reader System pcProx Output Formats pcProx Features pcProx Functions pcProx Connectors USB Readers & Wiegand Converters RS-232 Readers & Converters System Requirements Card Compatibility 11 11 11 Chapter 2: Getting Started Hardware Installation pcProx Software Installation 15 15 15 16 17 17 18 18 19 19 20 20 20 21 21 21 22 22 26 29 31 33 37 46 Chapter 3: Configuration pcProx Configuration
The Basics 1 Wireless Identification Overview pcProx® 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 out the workplace.
ID Card Reader System Output Formats 7 Chapter 1 The Basics
Features • • • • • • Read all data from proximity/contactless cards Read configuration Write configurations Software Developer’s Kit/API compatibility Output in decimal or hexadecimal User controls number of digits output Functions • • • • • Software Developer’s Kit (SDK) USB Software Developer’s Kit RS-232 USB Keyboard RS-232 Serial Virtual COM Connectors • • • • • • • • • 8 USB Keyboard USB Virtual COM Port RJ45 PS/2 DB-9 RS-232 Power Plug – 2.1 mm Power Plug – 2.
Connectors T CONNECTORS OUTPUT Card Types We Support View the list at www.RFIDeas.
USB Readers and Wiegand Converters The USB keystroke reader operates in two primary modes: • USB keyboard. It reads the card data and sends it as keystrokes as if the user typed the ID data on a keyboard. • Under the application programmer interface (API) defined in the pcProx SDK. When it reads card data, the active application receives the entire card data. RS-232 Readers and Converters The RS-232, Ethernet, or virtual COM port reader operates in two primary modes: 1. ASCII output device.
Getting Started 2 Hardware Installation Plug the connector into the workstation’s (or available on any peripheral) open RS-232, USB or Ethernet plug. Place the device next to the monitor, beside the workstation, or where appropriate. The workstation should detect new hardware for USB connections. Verify the workstation recognizes this connection using the ‘Device Manager’. Verify the correct COM port for RS-232 DB9 connections using the ‘Device Manager.
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 install the configuration software. Follow the prompts to install the configuration software.
Check pcProxConfig component to install utility and click next. Note: Use Control Panel a Add/Remove Programs to successfully remove the setup program if there is a problem with installation or if this is an upgrade. Reboot and then reinstall the program. Select a destination folder for the utility installation and then click next. Once the installation is complete, click finish to close the Setup Wizard.
Once the pcProxConfig utility is installed connect a device to the workstation. Verify the device is connected to the appropriate connector. It is best to configure one device at a time, plug each device in so you know which device is being configured. Now the device can be configured to output the card data in the appropriate format.
3 Configuration pcProxConfig Utility The pcProxConfig configuration utility allows for more delimiters to be added with the card data. Tool Bar The Tool Bar displays the following commands: Commands Click to: Connect Connect to reader of selected interface on connect tab. Disconnect Disconnect all devices Open Opens a specific configuration into the selected device. Save Save the configuration as a HWG+ file.
Connect Button Click Connect to search for available connected device.
Disconnect Button Click Disconnect to disconnect from available connected device. Open Button Click Open to load an ASCII .HWG+ file into the device.
Save Button The Save button will allow the user to save their current device data to an ASCII .HWG+ file for later use. Defaults Button Click Defaults to set the device’s flash configuration to factory default settings. The following message will appear for the user to agree or disagree.
Flash Button Click the Flash button to write the configuration into the device’s flash memory. About Button Click the About button to find software information and version number for the configuration utility.
File Menu The file menu lists the options for Opening .HWG files and Saving to .HWG files. It also includes the Exit command.
Navigation Menu The Navigation menu lists the same commands as seen on the utility tabs. (An explanation of each can be found in the tab sections of this manual). View Menu The View menu allows for the option to change certain visuals on the configuration window.
pcProx + This section allows for users to choose multiple configurations in the Configuration # drop down menu. The card type drop down menu allows for a selection of a card type for the configuration. Each configuration (if multiple) can have a separate card type. The High Priority checkbox sets the selected configuration as priority above any others. Note: For example, the High Priority checkbox can set priorities for corp 1000 cards or dual frequency cards.
USB (Universal Serial Bus) This selection will scan USB bus for readers., RS-232 and Virtual COM Ports This section scans for RS-232, physical COM port devices, virtual COM port devices, including USB, CDC and PCMCIA devices. It stops after the first USB device is found. The list holds only one serial device. Once RS-232 selection has been made, the lower and upper limits of the COM ports to scan need to be set. The default COM ports are set at 1 thru 8. The Default 1..
The drop-down menu bar will provide the list of devices found on the USB bus. Output Test Area This is the test area for the keystrokes entered by the reader. On serial devices this displays the unsolicited serial port data. The Auto GetID box can be checked for the utility to poll the reader for a card ID every 500ms and displays the result to the right of the box.
The Auto Focus box keeps the cursor in the test area box to capture the keystrokes output by the device. Note: When the Auto Focus box is checked, it is possible that the selection may conflict with the menus and drop downs, due to the fact that the cursor will attempt to move back into the test area. If this problem arises, simply uncheck the box. The Auto Clear box auto selects all text in the Output Test Area, so that new keystrokes output by the device will replace old text.
Data Format Tab Use this tab to configure the bits the device reads from the ID token. Wiegand to Keystroke Data Format Function 26 Description Strip leading parity bit count Set the device to strip leading parity bits from 0 to 15. Strip trailing parity bit count Set the device to strip trailing parity bits from 0 to 15.
Function Send FAC Check to send the Facility/Site (FAC) code. Send FAC as hexadecimal number Check to send this code in hexadecimal. This is set for KANTECH 10 proximity cards. 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. ID Field Bit Count Enter the bit count of ID portion.
Rarely Used Legacy Settings Function 28 Description Only Read Cards With This Bit Count No data is sent from the device unless the bit count is matched. The total bits received from the card must match this bit count, parity bits included. If checked and 26 is entered in the field, the device will only respond to 26 bit cards.
Delimiters Tab Use this tab to configure pre and post data 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. Note: Only 3 pre and post delimiters can be configured. If 3 pre-delimiters are set, no post delimiters can be set. The Scan Code output for the key selected displays above the list of keys.
Termination Keystroke (T) Select a character to display to signify the keystroke termination. Card Gone Delimiter (GN) Select two character to display once card data has finished keystroking and leaves the desired field.
Timing Tab Use this tab to configure the device’s card timing and USB keystroke timing. Card Read Timing Function 31 Description Card Data Hold Time Enter the time the card data remains valid in the device. The minimum value is 900. This is read in 50 msec increments. The default is 1,000. Continuous Read, Sends Data Upon Read If this is checked, the card data is repeatedly sent. Generally this check box is not checked.
USB Keyboard Timing Function 32 Description Key Press Time Enter the length of time the key is held down. The minimum value is 0. The maximum is 640. The default is 20. Key Release Time Enter the time delay between keystrokes. The minimum value is 0. The maximum is 640. The default is 20.
SDK Tab Use this tab to configure the Software Developer’s Kit (SDK) functions, as well as enable and disable keystroking. Software Developers Kit Function Disable Keystrokes for SDK (Halt Keyboard Send) Description Check to disable keystroking. When keystroking or unsolicited serial out is disabled, all card data must be read via the SDK functions. LED Function 33 Description Auto Select this to make the device set the LED color.
Logical Unit ID A user defined 16 bit Logic Unit ID to identify one device from another. Beeper Function Description Enable Beep on Card Read Check this to set the device to beep when a card is read. Beep Now Press to listen to the beep the reader will provide when in use. Long Beep(s) Check the box to configure a long beep of 375 msec.
Card ID Function GETID Click while scanning a card over the device. The ID displays under the button. This returns 64 bits maximum. GETID (32) Click while scanning a card over the device. The ID displays under the button. This returns 255 bits maximum. GetQueuedID Click to display the last card data read. This returns 255 bits maximum. Clear Lockout Check to clear the time remaining to allow the device to read the next card immediately.
GetQueuedID Data Display HH:MM:SS displays – 00:00:06 36 Chapter 3 Configuration
CHUID Tab This tab allows manipulation of all fields on the Federal Information Processing Standard (FIPS) 201, 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. Function Define Fields Click to select the number of source bits to define the fields. The correct type must be selected to allow for all card bits to be manipulated. Enable Check to enable the highlighted field.
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. Bits Enter the number of bits to add to the Start Bit to define the range of bits in the field. Digits This is the number of digits that will display in a selected field. Up Click to move the highlighted field up one position.
Get ID Click GetID and scan the card to display the output format of the FIPS 201 and proximity card and the interpretation display of the card data. Click GetID to define the fields to set up the device. In this example, The Agency data starts at bit 11, is 16 bits long, and is 5 digits. The location of the agency data is highlighted in the binary bit pattern. The Bit Range is 6 .. 25. The actual card data displays in blue below the binary bit pattern layout.
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.
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. Additional function keys display to configure more fields.
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. Click Clear to remove all preceding keystrokes as appropriate.
Each single keystroke entered to precede card data equals 1 byte of memory.
If any special character is selected with a keystroke, this equals 2 bytes of memory.
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. Select the appropriate field. Click the keyboard icon. Check Left Control. Check Left Alt. Click n. Click Insert. Click Flash to write this configuration to flash memory. Verify the active window is OpenOffice. Scan the card.
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 format • Click GetID and present the card to the reader • Define the fields to match the specific output • Configure any additional fields as appropriate • Flash the configuration to memory The Advanced button displays: • Start bit location • Number of bits for a specific field • Number of digits for the field • Location of the field within the 24
ASCII Command Protocol 4 ASCII 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. Note: USB devices that are virtual COM port do not need the baud rate set. The input is buffered by the device and executed when a carriage return (CR) or line feed line feed (LF) is typed.
Connect Serial Communications Program Open putty.exe. Click Connection a 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. Click Session. Note: Use Hyper Terminal instead of putty with the XP operating system.
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. Command Structure Commands are not case sensitive. Characters assigned to variables are case sensitive. · All commands begin with a prefix string followed by one or more token strings with a period delimiter character between multiple tokens.
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. An example of a function is to write the variable settings to flash memory using rfid:cfg.write CR. Certain functions that display a value or series of values display the string between curly braces for easy parsing.
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. · Values from 0x00 .. 0x1F and 0x7F..0xFF will be with a leading backslash lowercase x and the two digit upper case hex number. · The output of the variable displays between curly braces. For example: RF IDeas>rfid:out.
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 Summary rfid:cfg.read This function tells the device to read the flash memory to RAM. rfid:cfg.reset This function resets the flash memory to the factory settings. rfid:cfg.write This function tells the device to write the RAM to flash memory.
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. QID The rfid:qid function exists in four forms: • rfid:qid (Function) • rfid:qid.hold (Function) • rfid:qid.id (Function) • rfid:qid.id.hold (Function) Each quid function returns the same queued ID. The last 3 items control what is cleared after the function displays the output. The top line below is an example output string.
QID.id This reads the card data and also clears the age,overrun, and bit count after the values display. QID.id.hold This reads the card data and clears the ID variables and hold timer like both combined functions above. SDK Command Th rfid:op.sdk=False tells the device to display card data every time a card is scanned. If true, no card data displays. In the SDK mode, all keystroke or serial send data can be inhibited. The card data can be read using function rfid:qid.
These five variables work together to display leading and trailing (pre and post) card data delimiters. 1. rfid:chr.1=’\x00’ 2. rfid:chr.2=’\x00’ 3. rfid:chr.3=’\x00’ 4. rfid:chr.count.lead=0 5. 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. Count.lead identifies how many of the three characters (chr.1 .. chr.3) display before the card data. For example, if count.
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. rfid:disp.fac.strip=False This command separates the FAC from the card data when true so it can be independently formatted for display. If false, the FAC code is not separated from the card data. rfid:disp.id.
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 Description 0 OFF 1 RED 2 GREEN 3 AMBER 4..254 255 Reserved Controlled by the device Rfid.out.relay= True This command sets the output driver to ON (active low) when true. This is only available on OEM converter boards. rfid:time.
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. rfid:wieg.strip.lead.bits=1 This command strips 0 .. 15 bits from the most significant bits. rfid:wieg.strip.trail.bits=1 This command strips 0 .. 15 bits from the least significant bits.
Tips and Troubleshooting 5 Troubleshooting If the device is not working or 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. A valid proximity card causes the LED to turn green, provided the configuration is not set to only read certain bit lengths. 2. Only one COM port application can own the RS-232 port at a time. Make sure there is not another COM port application running.
Precautions Do not mount the device directly on a metal surface. This could interfere with the RF signal and the operation of the device. The device may not recognize valid cards in the presence of high RF fields. If current readings are erratic, take the following step: · Move the equipment from any known transmitters nearby. Contact Technical Support at 866.439.4884 for more information.
Appendix 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. The typical layout for this format is 24 bits of usable information as the first and last are parity bits to ensure data integrity. The 26 bit format consists of 255 possible facility codes.
Use the pcProx Device for Password Security Complex Passwords It is possible with certain limitations, to use the proximity token as a password for an application or operating system log on. The unique card bit-stream converted to either decimal or hexadecimal becomes the entire or a portion of the password. Enroll this card data to the password of the operating system application for the user.
Index Index I A AIR ID Playback 62, 64 ACP Error Codes 58 ASCII 6, 7, 10, 17, 18, 47 Assign Preceding Keystrokes Auto Clear 25 Auto Correct 20 Auto Focus 25 Auto GetID 24 ID Digits K 42 Key Press Time Key Release Time 32 32 L LED 33, 57, 59 Legacy Settings 28 Lock-Out Time 31 Logical Unit ID 34 B Beep 21 Beeper 34 Button Bar 15 About 15, 16 Connect 15, 16 Defaults 15, 18 Disconnect 15, 17 Flash 15, 19 Open 15, 17 Save 15, 18 M Manufacturer Card Compatibil
Other Products & Accessories Software Developer’s Kit Allows independent developer’s to use their application to read proximity access badge Read ID data of more than 1 billion cards in the field PVC Label Proximity Card Credit card size with paper release liner, 500 cards per box Complete selection of various manufacturers proximity cards, labels and key fobs.
RF IDeas Inc. © 2011 RF IDeas. All rights reserved. Specifications subject to change without notice. Windows, Macintosh, Solaris, Sun Ray and Linux are trademarks of their respective companies. All other trademarks, service marks and product or service names are property of their respective owners. Mention of third-party products is for informational purposes only and constitutes neither an endorsement nor a recommendation.
