Scribd
Upload
9 views

Reader Tool

Uploaded by

anamardelycerdanabanto
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
9 views

Reader Tool

Uploaded by

anamardelycerdanabanto
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 5

Y Soft USB Reader v2 configuration tool (usbrdrtool) datasheet

The usbrdrtool configuration tool is designed for USB readers v2 only! On v1 readers the setting can be only
done via DIP-switches that are located on the bottom of the reader.

• Purpose
• Prerequisites
• Description
° Main program screen
° Reader configuration screen
° Card testing screen
• Command line parameters
° (-u) Update of firmware
° (-w) Update of service firmware
° (-m) Send of card reader configuration
° (-j) Download of log
° (-v) Extended debug mode

Purpose

• Show information about connected USB readers.


• Set basic parameters of each reader such as USB reader class type, reader protocol, debug mode etc.
• Card testing for verifying correct reader functionality and reading distance.
• Display of card type during testing (with readers where applicable)
• Update of USB reader normal firmware.
• Update of USB reader service firmware.
• Sending of card reader configuration - card reading customizations.
• Download log from USB reader for debugging purposes.

Prerequisites

• Windows 2000 and higher


• Linux kernel 2.6.32 or higher with libc6 2.11 or higher
• Root access on Linux or possibility of sudo or ability to install udev rules
• usbfs support and libusb-1.0 library on Linux
• usbrdrtool.exe (WIN32) or usbrdtool (Linux) executable binaries

Description
The program runs in a system console. It is not a gui application, it is an application running in text mode. The
program requires "root" privileges under Linux or a special udev rule can be used to allow regular users to write
to the USB device.

Main program screen


When the program is run without any command line parameter the following screen is shown:

1| Page Y Soft Corporation


YSoft USB card reader configuration utility ver. 1.14, PARTNERS release
List of available readers:
----------------------------------------------------------------------------
0) USB reader v2 (usb keyboard class), Ser.no.: MBSNE30211004DE
----------------------------------------------------------------------------
99) Exit application 100) Test mode 101) Refresh reader list
Enter number:

User may select reader number (0-98) to be configured or run card reader test mode by typing 100.

Reader configuration screen


USB card reader configuration screen (reader number from the main menu):

USB Reader information:


Usb reader : USB reader v2 (usb keyboard class)
Serial no. : MBSNA242130037E
Firmware ver. : 2.0.0usb
Servicefw ver.: 1.0.2svcusb
Servicefw stat: OK
USB op. mode : USB keyboard
Reader type : 12
Reader proto : 0
Debug mode : no log
Sound : Enabled
Hardware information:
HW version : 2.1.3
Serial number : MBSNA242130037E
Manuf. date : Fri Jun 18 09:26:43 2010
Card reader information:
LibReader ver.: 1.2.1
Reader count : 1
Reader partno : B-033
Reader descr. : HID iClass
Reader auto : YES
Reader proto. : Wiegand all bits auto
Reader featur.: 00000600
Reader info : (null)
Embedded reader information:
PCB ver.(type): 3.4.2 (0)
Features : 00000000
Serial no. : SQRD951342003DE
Partnumber : B-033
Manf. date : Mon Dec 14 15:28:18 2009
Reader SW ver.: Not applicable
Req lib ver. : Not applicable
Select action:
1) set config to defaults
2) set USB mode
3) set card reader protocol
4) set debug mode
5) set sound mode

2| Page Y Soft Corporation


99) save config and exit
100) exit without saving
Enter number:

Action 1 sets the USB reader configuration to defaults. This includes USB mode, reader protocol, debug mode
and other parameters. This option does not format data that are stored on USB reader internal filesystem.

Action 2 sets USB mode. Default is USB keyboard as it is the most commonly used. However for KM embedded
card readers or standard serial card readers a different USB mode can be used.

Action 3 sets card reader protocol. For some card readers it is necessary to enable support for another card
types. Default card reader protocol is 0 which means that the reader default protocol will be used. If invalid card
reader protocol is selected then the default protocol will be used. Please see Y Soft Card Readers Protocols.pdf
for more details about card reader protocols.

Action 4 enables debugging in case something goes wrong with the reader (for example hangup or reboot or
anything similar). Please note that debugging enabled causes wear-out of the internal flash so enable it
only in cases when it is necessary!

Action 5 enables or disables sound on the USB reader. Please note that there is no visual identification of
successful card reading so users in some cases cannot guess what may be wrong if the card reader
makes no sound

Action 99 returns user to the previous menu. If any changes are made, the card reader is rebooted and the
changes are applied.

Action 100 returns user to the previous menu. If any changes in settings are made they are discarded and
original settings remain.

Card testing screen


Card testing screen (100 from the main menu):

Card testing:
----------------------------------------------------------------------------
MBSNA242130037E, usb KBD, B-049 Legic Advant v2, Legic UIN
CARD: 'none'
MBSNA242130036E, usb SER., B-033 HID iClass, Wiegand all bits auto
CARD (tmout): 'none'
----------------------------------------------------------------------------
(CTRL+C to exit)

Multiple card readers can be tested at once. The screen automatically recognizes disconnected and newly
connected readers so it may be used for mass-production card reader testing.

If the connected reader supports card presence detection then the card number and type is visible only when the
card is placed at the card reader (first reader above).

If the connected reader does not support card presence detection, a "tmout" is displayed next to CARD (second
reader above). The card number will be automatically erased after a couple of seconds of inactivity. This feature
is intended to make sure that the reader works properly and card numbers are read correctly every time a card
is placed.

3| Page Y Soft Corporation


Please note that displaying the correct card type depends on card reader used and card reader protocol set.
Before using usbrdrtool as a tool for customer card testing please consult USB card reader testing guidelines!
With some card readers and improper reader protocol setting a wrong chip identification may occur!

It is also possible to start the card testing screen directly by specifying -t command line option to the usbrdrtool
application.

Command line parameters


When the program is run with -h parameter, the following help screen is shown:

YSoft USB card reader configuration utility ver. 1.14


Usage: usbrdrtool -<parameter> <value> ...
Parameters:
-i input file (otherwise stdin)
-o output file (otherwise stdout)
-l list all configurable readers
-r select reader number to configure, if not specified then first reader will be
used
-s select serial number of reader to configure
-k reset the usb device after successful operation
-u update standard firmware (file on stdin or input file)
-w update service firmware (file on stdin or input file)
-m send card reader configuration (file on stdin or input file)
-j get log (data on stdout or output file)
-h this help screen
-v verbose operation
-t start card testing mode
Examples of use:
Update of normal firmware:
usbrdrtool -u -i usb2-2.0.0.fw -k
Update of service firmware:
usbrdrtool -l -i usb2_service_1.0.3.fw -k
Download of log (when logging enabled):
usbrdrtool -j

(-u) Update of firmware


Update of firmware can be done by issuing the following command on Linux:

sudo ./usbrdrtool -u -i usb2-2.0.1.fw -k

or on Windows:

usbrdrtool.exe -u -i usb2-2.0.1.fw -k

'-k' option will cause the new firmware to be booted after successful update.

(-w) Update of service firmware

4| Page Y Soft Corporation


Update of service firmware can be done by issuing the following command on Linux:

sudo ./usbrdrtool -w -i usb2_service-1.0.1.fw -k

or on Windows:

usbrdrtool.exe -w -i usb2_service-1.0.1.fw -k

(-m) Send of card reader configuration


Send of card reader configuration can be done by issuing the following command on Linux:

sudo ./usbrdrtool -m -i card_config.out

or on Windows:

usbrdrtool.exe -m -i card_config.out

The USB reader will be automatically rebooted if needed.

(-j) Download of log

sudo ./usbrdrtool -j -o USBLOG.TXT

or on Windows:

usbrdrtool.exe -j -o USBLOG.TXT

Please note that logging must be enabled before using this function

(-v) Extended debug mode


By specifying '-v' (errors only) or '-v -v' (debug) on command line an extended debug mode is enabled. This may
provide developers with important information in case anything during usbrdrtool operation fails.

5| Page Y Soft Corporation

You might also like