making the MFDs think™ YSoft SafeQ® USB Card Reader v2 Administrator’s Guide Version 1.
18.01.2011 © 2011 by Y Soft Corporation a.s. All rights to this document, domestic and international, are reserved by Y Soft Corporation a.s. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise) without prior written permission of Y Soft. Y Soft®, Y Soft SafeQ® and its logo are registered trademarks of Y Soft Corporation a.s.
18.01.2011 TABLE OF CONTENTS Table of Contents .................................................................................................................................................... 3 1 2 3 4 Introduction ................................................................................................................................................... 4 1.1 Purpose of document .................................................................................................................
18.01.2011 1 INTRODUCTION 1.1 PURPOSE OF DOCUMENT This documentation provides essential information on installation and configuration of YSoft SafeQ® USB Card Reader verison 2. 1.2 VALIDITY OF DOCUMENT This document applies to YSoft SafeQ® USB Card Reader v2. 1.3 GOALS AND OBJECTIVES The YSoft SafeQ® USB Card Reader v2 that could be simply connected to the multi-functional device and serves for user authentication using card. Card must be assigned to any user in the YSoft SafeQ system.
18.01.2011 1.6 PREREQUISITE KNOWLEDGE The person who installs USB Card Reader v2 must meet the following requirements: knowledge of the YSoft SafeQ system (installation / administration / attendance) knowledge of OS Win 2000, Win 2003 (installation / administration) Basic knowledge on previous version of YSoft SafeQ Terminal Embedded is required. 1.7 DISCLAIMER The user that makes changes or modifications not expressly approved by the party responsible for compliance (Y Soft Corporation a.s.
18.01.2011 2 OVERVIEW 2.1 SYSTEM OVERVIEW YSoft SafeQ® USB Card Reader has following characteristics: - 2.2 Connection and power supply of the card reader via the USB host interface. Exchange of card reader possible without MFP turning off (hot-plug) Compatibility with some MFD additions. HARDWARE COMPONENTS Picture 1 – YSoft SafeQ® USB v2 card reader – all variants 2.3 USB CARD READER SPECIFICATION Parameter Value Identification Using a card reader Voltage 5V DC Maximum current input 0.
18.01.2011 Working air humidity 20% to 85% without condensation Storage air humidity 8% to 85% without condensation Resistance to magnetic field no added resistance YSOFT SAFEQ USB CARD READER V2 – ADMINISTRATOR’S GUIDE V1.
18.01.2011 3 INSTALLATION Following chapter displays how to mount USB reader v2 to device. The configuration could be different from type of device or vendor type. Other thing is that reader can’t be mounted only to device, because it can work as card reader for SafeQ Client application or Recharging point for SafeQ Credit Application, so mounting should be different according to usage. 3.
18.01.2011 Picture 3 - Mounting kit on the device If holder is fixed to the machine, we can stick the reader to holder together by clipping the reader to the mounting kit. Picture 4 - Mounting part 2 Finally, connect the USB connector of the reader into a free USB slot. 3.2 UNMOUNTING OF THE READER MODULE YSOFT SAFEQ USB CARD READER V2 – ADMINISTRATOR’S GUIDE V1.
18.01.2011 Removing from the device can be handled by plastic “fork” from the step 3 or screw driver or similar tool. When reader is connected with holder to device, we have to remove reader from the mounting kit first. Use plastic “fork” or screw driver and push the reader part, with moving the reader upwards. Steps 1,2 and 3. Picture 5 - Removing procedure Reader should recover from the holder. Now we can unscrew the mounting kit from the device and disconnect the reader with following procedure.
18.01.2011 4 CONFIGURATION USB Card reader v2 can be configured only with software utility called “usbrdrtool”. The software runs in a system console. It is not a gui application, it is an application running in text mode. The usbrdrtool configuration tool is designed for USB readers v2 only! The usbrdrtool prerequisites: • Windows 2000 and higher • Linux kernel 2.4 or higher with glibc 2.3.2 or higher • Root access on Linux or possibility of sudo • usbfs support for libusb-0.
18.01.2011 4.2 CARD READER CONFIGURATION SCREEN When administrator selects the number of the reader from the reader list, the reader configuration screens will be shown with general information about reader and following steps for next administration: Picture 7 - Reader configuration screen Action 1 sets the USB reader configuration to defaults. This includes USB mode, reader protocol, debug mode and other parameters.
18.01.2011 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. Note: Please see Y Soft Card Readers Protocols.pdf for more details about card reader protocols. This*. pdf file is always attached to the zip file with released FW of the USB reader.
18.01.2011 USB serial – Optional mode This mode emulates operation of COM port and can be switched to mode 1 only. On Windows platform the installation of the USB reader in this mode requires usb2-reader.inf file. This file is distributed along with the usbrdrtool application and should be selected in the "new hardware" wizard after the USB reader plugging/reconfiguration. On Linux platform the driver for the serial port is installed automatically.
18.01.2011 Picture 9 - Reader protocol confirmation After selecting the appropriate number of protocol, you will be navigated to submenu page, when you need to save currently changed settings. Select “99” to save settings for changed reading protocol and confirm. Picture 10 - Saving of changes after protocol change YSOFT SAFEQ USB CARD READER V2 – ADMINISTRATOR’S GUIDE V1.
18.01.2011 4.4 CARD READER TESTING SCREEN Card testing screen menu can be started by number 100 from the main menu. See Picture 6 – Main menu. When testing window will appear you can test the reader by placing a card above the reader. Picture 11 - Test card window 1 Reader should display result from reading inside this window like example on the Picture 12 - Card testing result. Picture 12 - Card testing result Multiple card readers can be tested at once.
18.01.2011 4.5 CARD READER UPDATE FIRMWARE Update of firmware for USB card reader can be done by issuing the following command in the Windows command like (CMD) or on Linux OS: Windows: usbrdrtool.exe -u -i usb2-2.0.1.fw –k Picture 13 - FW update example Linux: sudo ./usbrdrtool -u -i usb2-2.0.1.fw -k '-k' option will cause the new firmware to be booted after successful update. Note: This command can be run form CMD windows or Linux, this is not a command inside the usbrdrtool. 4.
.01.2011 4.7 CARD READER SETTINGS FOR DOWNLOADEING THE LOG FILES For the configuration of USB card reader to downloading log files from the reader is possible to run following command in the Windows command like (CMD) or on Linux OS: Windows: usbrdrtool.exe -j -o USBLOG.TXT Picture 15 - Get log enabling Linux: sudo ./usbrdrtool -j -o USBLOG.TXT Note: Please note that logging must be enabled before using this function 4.
18.01.2011 In the Linux OS the usage is similar with command: Usage: ./usbrdrtool - ...
18.01.2011 5 INFORMATION BEEP CODES Here is the list of beep codes, which give the result on the behavior of USB reader v2. Legend: Long beep sound . Short beep sound ....-.--...-.---... -.-. .--. Card read error. Please try placing the card again or use the different card. Hardware configuration damaged cannot continue in booting. Update of firmware failed. Software configuration cannot be saved. Probably faulty onboard eeprom. Software configuration damaged, loading defaults.
18.01.2011 6 RELATIONSHIP WITH OTHER DOCUMENTS This section describes how this guide is related to other documentation: Nr. 1. Document Version Author Y Soft Card Readers Protocols.pdf 2. 3. 4. 5. 6. 7. YSOFT SAFEQ USB CARD READER V2 – ADMINISTRATOR’S GUIDE V1.
18.01.2011 7 VERSION HISTORY Document author/owner: Stanislav Záň Version Date Change Status Author 0.1 10/2010 Initial version Draft SZA 0.2 10/2010 Essential changes in chapters 3,4; Chapter 5 added Final SZA 0.3 10/2010 Essential changes in chapters 1,3,4, added screenshots Final SZA 0.4 10/2010 Essential changes in chapters 4 Final SZA 1.0 01/2011 Public version Final SZA 1.
