pcProx® Plus, pcProx® Enroll & Wiegand Converter Configuration Utility User Manual 99009010 Rev A.
Thank You! Congratulations on the purchase of your pcProx® Enroll, pcProx® Plus, 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.
Glossary Of Terms ASCII: The American Standard Code for Information Interchange codes represent text in computers, communications equipment, and other devices that use text. Contactless: The high frequency 13.56 MHz smart card technology. FAC: Facility Access Code OEM: The proximity card and badge reader available in self-contained electronic modules for easy system integration. pcProx Contactless: The registered RF IDeas brand name given to all 13.56 MHz contactless card reader products.
Contents 4 2 Thank You! 45 45 46 47 50 54 58 3 Glossary Of Terms 5 5 6 6 7 8 8 8 9 9 10 11 11 11 12 12 Chapter 1: The Basics Wireless Identification Overview ID Card Reader System pcProx Output Formats Credential Form Factors 59 Card Compatibility 59 Reader Configuration Purposes 60 pcProx Plus & Non-Plus Reader Differences 63 63 Chapter 2:Hardware 63 What’s In Your Part Number? Interface (Connectors) 66 USB Readers and Wiegand Converters RS-232 Readers and Converters 67 Minimum System Requirements
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 throughout the workplace.
ID Card Reader System Output Formats 6 Chapter 1 The Basics
Credential Form Factors Credentials are inactive electronic devices that rely on readers to supply the required power for start-up and communication. The credential itself, consists of antennas that produce proximity or contactless frequencies. Proximity and contactless smart card technology cards allow users to effortlessly manage multiple applications through a single credential. Data: The data on access cards are a string of binary numbers set with a fixed configuration and length.
Manufacturer/Vendor Card Compatibility Please go to www.RFIDeas.com for specific device part numbers associated to card types. Reader Configuration Purposes The method of encoding data on a card and transmitting data to the reader differs accordingly to each technology involved. The reader itself is not aware of the makeup of the card data format or access privileges for the cardholder. This information is only accessible through the configuration process of the reader utilizing the supplied software.
2 Hardware What’s In Your Part Number? All RF IDeas reader part numbers follow a distinct system of categorization to allow for an ease of differentiation between products. Below is the basic part number scheme. RDR - Reader Type Frequency 6 3 8 1 A K U Housing Color Card Type Model Housing Version Interface Reader Type: The reader type distinguishes between standard reader, OEM, converter, mag-stripe, or a kit.
Interface (Connectors) T CONNECTORS OUTPUT 10 Chapter 2 Hardware
USB Readers and Wiegand Converters The pcProx USB keystroke device 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. Note: The pcProx ExpressCard operates as a USB reader.
Reader Set-Up Basics 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 Device Manager’. Verify the correct COM port for RS-232 DB9 connections using ‘Device Manager.
Software 3 pcProx Configuration Utility The pcProx Configuration Utility provides users with the ability to configure their pcProx Enroll, pcProx Plus, or Wiegand devices to meet their needs. Through the configuration process, desired credential data output and access privileges for cardholders can be established.
Menu Tool Bar The Menu Tool Bar contains all the basic configuration options for the utility. File The file menu lists the options for Opening .Hwg and Saving .Hwg files. Open .Hwg /.Hwg+ File: Opens either a .Hwg or .Hwg+ file. A .Hwg or .Hwg+ file contains all the configuration settings for the reader. The utility comes with sample .Hwg/.Hwg+ files. Save to .Hwg+ File: Saves the configuration settings to the reader. What is a .Hwg/.Hwg+ file? There are two kinds of configuration files. There is a .
(Connect--Cont.) Connect to USB: Connects to current specified reader through USB Connect to Serial: Connects to current specified reader through serial Connect to Ethernet TCP/IP: Connects to current specified reader through ethernet TCP/IP Why use the Connect to feature? The connect to feature allows the utility to connect to a device through the specified port upon selection. This is especially helpful when users are switching out and changing devices with different connections.
(Device Menu--Cont.) pcProx Plus - 2 Configuration Reader: Read Active: Reads the current configuration. Active settings are what allow the device to function. Write Active: Writes the current configuration to active settings. Note: For more information on the Write Active option, see the Write Settings/Write Active portion of the Icon Toolbar section on page 21 of this manual. Note: Device Menu options are altered when a two configuration device (pcProx Plus) is connected to the utility.
(View Menu--Cont.) Show Text Under Toolbar Icons: Provides option to display or remove text under icons in the Icon Toolbar (For more information on the Icon Toolbar, see the Icon Toolbar section on page 19 of this manual). Show Pop-Up Warning Dialogues: Gives option for user to display or remove warning pop-up dialogue boxes. For example, if the Show Pop-Up Warning Dialogues option is selected, then a warning dialogue box, as seen below, will display on your screen.
Help Menu The help menu provides options for which users can seek out additional assistance using the utility and/or device. Read User Manual: Opens the pdf user manual that is bundled in the download with the configuration utility. Note: The user manual can also be found in the directory folder in which the configuration utility was installed. www.RFIDeas.com: This operation will open a new window to the RF IDeas website.
Icon Tool Bar The Icon Tool Bar contains the three most general configuration controls for the utility. These controls are also found in the Menu Toolbar under Connect (for connect and disconnect) and Device (for write settings and write active). Connect Clicking the Connect icon button commands the utility to search for a device through all available port connections.
(Connect-Cont.) If an attempt to connect to a device is made and the utility does not detect a device through any of the available interface connections, a “no devices found” message will display in the utility’s status bar area.
Disconnect Clicking the disconnect icon button commands the utility to disconnect from all devices connected through any and all available port connections. Once the utility disconnects from all available device connections, the Device List pull-down menu and device model number are cleared from the Standard Configuration Area and the Output Test Area will turn from green to gray. Additionally, the status bar will display a “Disconnected” message.
pcProx Plus Configuration This section is only available to configure selections when a two configuration device (pcProx Plus) is connected to the utility. Note: When a single configuration device is connected to the utility, the pcProx Plus Configuration area is grayed out (as seen below) and selections within this area are not possible. The pcProx Plus Configuration area allows for users to set-up two different configurations for their device. The configurations could be either one 125 kHz and one 13.
Standard Configuration This Standard Configuration area provides all the options and details necessary to configure a connected device. Connect Tab The connect tab offers the various ways a device can connect to the configuration utility. The different selections allow the user to choose the connection type for the specific logical protocol of their reader. Note: Only one connection type at a time will be shown. USB: Make this selection if the connected device has a USB logical protocol.
(Connect Tab--Cont.) Ethernet (Local IP 10.10.10.65): Connects to an Ethernet reader at the given IP address and open a TCP/IP on the given port. The first, second, third, and fourth byte of the TCP/IP address need to be entered for the interface to connect to the reader. The IP port number will also be required. Port Option: Allows for changing the port location. Xport port location needs to match this number Note: Ports below 1024 are for system use only.
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 500msec and displays the results directly under the checkbox, as seen below. The Auto Focus box keeps the cursor in the test area box to capture the keystrokes output by the device.
Status Bar The status bar (below the Test Area) displays various messages to alert the user of what the utility is doing, as well as connections and disconnections between the utility a device. Data Format Tab This tab provides users the ability to format how the data on a card will be keystroked out by the utility. The above diagram illustrates the various characters that can be displayed upon a card detection by a connected device.
Wiegand to Keystroke Data Format Strip Leading and Trailing Bit Count: By altering the numbers in the leading and trailing bit count, users have the option to strip and discard bits from the card data. The leading and trailing bit counts can be set to range from 0 to 15. Send FAC: (Facility Access Code) Allows for option to display the FAC code Send FAC as Hexadecimal Number: Will send FAC as a hex number. The default is set to output as a decimal.
(Data Format Tab--Cont.) FAC Extended Precision Math On: Interprets the FAC data from a card to allow for the proper amount of bits to provide appropriate info. ID Extended Precision Math On: Interprets the ID data from a card to allow for the proper amount of bits to provide appropriate info.
(Delimiters Tab--Cont.) Post Data Delimiters (XYZ): Select from 0 to 3 characters to keystroke to the end of the card data. These characters are shared with the pre string of characters. Termination Keystroke (T): Adds a keystroke to the end of the card data to signify the end of the card data. Card Gone Delimiters (GN): Adds a keystroke to the end of the card data when the card is removed. Delimeter Keyboard The Delimter Keyboard is used to select user defined delimeters (keys).
Timing Tab Use this tab to configure the device’s card timing and USB keystroke timing. Card Data Hold Time: This option allows for users to determine in msec’s how long they need to wait before the device is able to read the next card in line (which is also how long the LED will remain green after a card read). The timing options can range from 50 to 9950 min/max (50msec increments only) and the default is set to 1000. Note: This is how long the data is available for the SDK user.
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 The LED section allows users to control the LED light actions on the device to provide users info regarding the card data.
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. By default the beep is set to a short beep of 125 msec.
Card ID Function Description 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 34 Chapter 3 Software
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 35 Description 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, Persona liD, and Expiration Date fields have been removed. Additional function keys display to configure more fields. lr Define Fields / [1] Enable 11 Keystrokes below precede ca rd data <-E=NTE= - ------- ----- . I Credentiil Num. I IB ] K eys. [ Credential Series ] [I!Credentiil Issue] I Org.
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 equals1 byte of memory. Connect I Data format Define fields., Delm i iters ] Tming SDK Enable CHU D c_----------------------, Key strokesdelimiters below precede card data System Code credential...,, I OedenbaiSeries I Keystrokes: 4 of 26 by tes used.Room for 14 keystrokes. I/Qedenllal!ssue I Display mode Personal ID I 0 Dedmal 0 Hex @ BCD +parity Digits to display 0 I · Advanced I o-g. Category I OroarlzaOOnal ID Petson}Org.
If any special character is selected with a keystroke, this equals 2 bytes of memory. Connect Data format Delimiters r ll'l'ling SDK I Oefne fields.. - - '" ==-e CHUID c_----------------------, K_eY'_t_roke _d_ eli_mit_e" _b_ e_w_p_re_<_ ede [BliJ SvstemCode Credential Nun. Credential series IJCredential Issue Personai.ID Org.CateQOf"y Oroar!zational ID Person}Qrg.10 Keysb"okes: 4 of 26bytesused.Room fur 14keystrokes.
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 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. rfid:beep.now ‡ rfid:cfg ‡ rfid:cfg.card.hipri ‡ rfid:cfg.card.list (Function) ‡ rfid:cfg.card.type rfid:cfg.read (Funtion) rfid:cfg.reset (Function) rfid:cfg.write (Function) rfid:chr.1 rfid:chr.2 rfid:chr.3 rfid:chr.count.lead rfid:chr.count.trail rfid:chr.eol rfid:chr.fac rfid:chr.gone.1 rfid:chr.gone.2 rfid:cmd.echo rfid:cmd.
Command rfid:cfg Data Type INT (‡ pcProx Plus only) rfid:cfg.card.hipri BOOL R, W, R/W Definition R/W The pcProx Plus reader has multiple configurations. Each configuration has the settings associated with a card type. When a configuration is changed, all other related settings reflect that configuration number. R/W (‡ pcProx Plus only) rfid:cfg.card.list Function (‡ pcProx Plus only) rfid:cfg.card.
Command rfid:chr.count.trail Data Type R, W, R/W Definition INT R/W Verify or Set the trailing character count (0 to 3) u rfid:chr.eol CHAR R/W Verify or set end of line termination character ( A - Z, 0 - 9, a - z or ASCII \0x00 ….\0x0D) rfid:chr.fac CHAR R/W Verify or set separating character between the facility code and ID data( A - Z, 0 - 9, a - z or ASCII \0x00 ….\0x0D) Ex: 123 ; 456789 rfid:chr.gone.1 CHAR R/W 1st character sent when card is removed ( A - Z, 0 - 9, a - z or ASCII \0x00 ….\0x0D) rfid:
Command rfid:qid Data Type Function R, W, R/W Definition Reads current queued ID data EXAMPLE Output String: {0x1000,2,0x0000,80;0x000000801DD1910 B2F04} ---Note the use of commas and semicolons-- FORMAT of Output String: {AGE,OVERRUN,LOCKOUT,BITCOUNT;ID} AGE (New: Age (in hex) of last card read as a multiple of 48ms. Value stops at 0xFFFF. Use qid.id function to clear the age counter. As shown: the card was read 4,096 (0x1000 hex) x .048 = 196.608 seconds ago or 3 minutes and 16 seconds.
rfid:wieg.qual.bits INT R/W rfid:wieg.rev.bits BOOL R/W rfid:wieg.rev.bytes BOOL R/W rfid:wieg.strip.lead.bits INT R/W rfid:wieg.strip.trail.
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:cmd.prompt=True This command displays the prompt when true. If false, the prompt does not display. This value can be written to flash memory using cfg.write. It defaults to true on cfg.reset. rfid:dev.luid=0x1234 This command sets the logical unit ID. A user-defined 2 byte value to identify this unit. rfid:disp.64bit=False This command uses 64 bit math to computer 64 bit decimal digits. This should always be kept on. If true, it uses 64 bit math. rfid:disp.fac.
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 Reserved 255 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.hold=20 This command sets how long in 48ms ticks the data is held for the active ID.
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.
Frequently Asked Questions What types of credentials will your desktop and OEM products work with? Our products work with virtually all 125 kHz proximity and 13.56 MHz contactless cards in the industry today. The charts below can assist you in determining what RF IDeas products will work with your particular credential. You can reference the RDR part number on our website to get the name of the particular product or you can simply email us at sales@RFIDeas.com with the number and we will contact you.
i.e. FAC, ID or CSN using the pcProx Enroll Configuration Utility for USB and RS-232 readers. You can download our configuration program free of charge by cutting and pasting this path into you web browser http://www.rfideas.com/Software/pcProxConfig.exe. Once downloaded please review the User’s Manual for configuration instructions. If you have any questions please contact RF IDeas technical support.
control multi functional printers and much more. Contact our sales office at 1-866-439-4884 Toll Free to find out more. Can I use your product for tracking meeting registration and training attendance? Yes. Our products can be used to track training attendance and meeting registration. Contact our sales office at 1-866-439-4884 Toll Free to find out more on how our products can be used for meeting registration, training attendance and many other applications.
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. Before You Call Technical Support Please make sure you’ve identified your reader model and credential type being used.
END-USER LICENSE AGREEMENT LICENSE AGREEMENT End-User License Agreement for RF IDeas™ SOFTWARE and HARDWARE - RF IDeas’ pcProx®, Proximity Activated Readers, Software Developer’s Kit, and Proximity Reader DLLs, and Protocol(s).
` 4. OEM COPYRIGHT. All title and copyrights in and to the PRODUCT (including but not limited to images, photographs, animations, video, audio, music, text and “applets,” incorporated into the PRODUCT), the accompanying printed materials, and any copies of the SOFTWARE PORTION OF THE PRODUCT, are owned by RF IDeas or its suppliers. The PRODUCT and SOFTWARE PORTION OF THE PRODUCT is protected by copyright laws and international treaty provisions.
Index Index A K ACP 45, 58 ASCII 3, 5, 11, 45.
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.
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 Proximity Cards, Labels, Key Fobs Complete selection of various manufacturers proximity cards, labels and key fobs.
RF IDeas Inc. © 2013 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.
