✎ libsc_reader_kit [wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== What is LibSC Reader Kit ======

[[https://www.javacardos.com/store/libsc-reader-kit.php|LibSC Card Reader Module Development Kit]] developed by [[https://www.javacardos.com/about/|JavaCardOS Technologies]] is based on Arduino MFRC522-1.2.0 library source code. It has been further encapsulated and its functions has also been enhanced as well, which makes it much closer to a universal card reader's function. 

Combined with the card provided by JavaCardOS, you can directly send control commands from PC to communicate with the reader and then read/write the card infomation.It expands the new command control channel while retaining the original printout function, which greatly facilitates the 14443 communication protocol learning  process.

The entire suite of hardware is carefully chosen, tested and integrated by JavaCardOS, and can be also used as a cost-effective business solution. In addition, each component of this kit can be individually purchased in batches, please feel free to contact [[mailto:javacardos@gmail.com|JavaCardOS]].


===== List of Components =====

- arduino core board\\ 
- MFRC522 antenna board\\ 
- Dupont wire * 7\\ 
- USB cable * 1\\ 
- MIFARE 1k card(Please note that this is not the cloneable card, if you need MIFARE clone 1k card, please click [[https://www.javacardos.com/store/mifare-clone-1k.php|here]]

{{:lrk_kits.png?400|}}

 
LibSC Reader Kit pro includes a Mifare Clone 1K and a CPU card. You can send APDU commands via LibSC Reader.If you need enhanced version of the suite, please click [[https://www.javacardos.com/store/libsc-reader-kit-pro.php|here]]


===== Architecture =====

{{:architecture.png?400|}}\\ 
The content in the dotted box is the software code implementation on PC, such as all the scripts and LibSC API implementation.All these codes will be executed on PC.There are also two arrows,which indicate *PORT A* and *PORT B*. The *PORT A* is connected with USB cable.Although we just see an USB cable ,essentially,the USB device is virtual as a serial device to access to the computer.The *PORT B* indicates the dupont wires, which connnect arduino core board and MFRC522.The firmware code is downloaded to core board via USB, so you will see that the source code of this kit is divided to two directories, that is [[https://www.javacardos.com/javacardforum/viewtopic.php?f=19&t=1352|Client]](PC-side code) and [[https://www.javacardos.com/javacardforum/viewtopic.php?f=19&t=1352|Firmware]]( firmware code that will be downloaded to arduino core board).

===== Download Source Code =====

[[https://www.javacardos.com/javacardforum/viewtopic.php?f=19&t=1352|JavaCardOS]]\\ 
[[https://github.com/JavaCardOS/LibSC-Reader-Kit?ws=github&prj=LibSC_Reader_Kit|Github]]\\  
[[https://sourceforge.net/projects/LibSC-Reader-Kit/?ws=sourceforge&prj=LibSC_Reader_Kit|sourceforge]]\\ 

===== Quick Start =====

1.Install arduino [[https://drive.google.com/open?id=0BzXJhN5FPrE5TEJZTUNMdkhGblE|development environment]].  \\ 
2.Install serial device driver. Please download the cooresponding driver according to your platform and requirement. \\  
[[https://drive.google.com/open?id=0BzXJhN5FPrE5aE1JWTJKRk5aQlU|windows]]\\ 
[[https://drive.google.com/open?id=0BzXJhN5FPrE5MDlkTUhXRTFzZ2s|linux]]\\ 
[[https://drive.google.com/open?id=0BzXJhN5FPrE5Y3lKR25lZGs1S00|mac]]\\ 
3.Please refer to connect each component.\\ 
{{:lrk_arduino-uno-r3-with-rfid-rc522.png?400|}}\\ 
4.Install [[https://drive.google.com/file/d/0BzXJhN5FPrE5Zkd4V3pySVN4X0k/view?usp=sharing?ws=github&prj=LibSC_Reader_Kit|MFRC522 library]]\\ 
5.Add LibSC Reader implementation [[https://www.javacardos.com/javacardforum/viewtopic.php?f=19&t=1352|firmware code]] to MFRC522 library installation directory.\\  
6.Download firmware code to arduino hardware.\\  
7.Install pyserial . 'pip install pyserial'\\ 
8.Run LibSC Reader [[https://www.javacardos.com/javacardforum/viewtopic.php?f=19&t=1352|client code]] to confirm whether the smart card reader can work.\\ 


===== Install Arduino Development Environment =====

Support arduino 1.6,1.7,1.8 or above. If you have any question, please post it in the [[https://www.javacardos.com/javacardforum/|forum]].  

Double-click arduino-1.8.0-windows.exe, click "I Agree"  and then continue the following installation step.\\ 
{{:lrk_arduino-install-1.png?400|}}\\ 
{{:lrk_arduino-install-2.png?400|}}\\ 
{{:lrk_arduino-install-3.png?400|}}\\ 
{{:lrk_arduino-install-4.png?400|}}\\ 
Click "close" to finish the installation.
  
===== Install Serial Device Driver(windows) =====

If using ch340 series chip as the USB virtual serial chip of the current arduino board sold in our online store, it also needs a additional driver installation process. Then you are able to communicate with arduino core board via USB cable.  

==== Driver Installation Steps ====

1.Download [[https://drive.google.com/file/d/0BzXJhN5FPrE5UmhUN1d1a1o5VDg/view?usp=sharing|CH341SER.zip]], and decompress.\\  
2.Insert the device.\\ 
3.Specify where the driver is located.\\ 

==== Install Driver Manually(Exception Handling) ====

If the driver can not be recognized or encountering error during the installation process, you can follow the steps below to manually install the driver.Open the device manager and select "Other devices" or "Ports".
If device driver is not installed properly, just as the following figure shows.\\   
{{:0050_Unknow_Device.png?300|}}\\   

Please select "Update Driver Software".\\ 
{{:0100_Update_Drv.png?300|}}\\ 

In the new pop-up dialog box, select "Browse my computer for driver software".\\ 
{{:0200_Sel_Drv_Path.png?400|}}\\  

The entered path should be the driver decompression path.\\ 
{{:0300_Spec_Path.png?400|}}\\  

After the installation is completed, the below dialog box will pop-up. \\ 
{{:0400_Inst_Finish.png?400|}}\\ 

If the driver works normally, you will see this device in the device manager, as shown below.\\ 
{{:0500_Drv_Ok.png?300|}}\\ 

===== Connect components =====

Please refer to the following picture to complete the connection.  

{{:Arduino-Uno-r3-with-RFID-RC522.png?400|}}\\ 
Note:  \\ 
SDA------------------------Digital 10\\ 
SCK------------------------Digital 13\\ 
MOSI----------------------Digital 11\\ 
MISO----------------------Digital 12\\ 
IRQ------------------------unconnected\\ 
GND-----------------------GND\\ 
RST------------------------Digital 9\\ 
3.3V------------------------3.3V (DO NOT CONNECT TO 5V) 

You can also refer to [[https://javacardos.com/tools/index.html?app=jcide&adurl=https://create.arduino.cc/projecthub/Aritro/security-access-using-rfid-reader-f7c746|this article]] from Arduino official website.
If you want to view the real pictures of wire connection ,please refer to the following picture.\\ 
{{:LRK_mifare.png?500|}}

===== Install MFRC522 Library =====
  
<html>Decompress MFRC522-1.2.0.zip and copy the content to 'X:\***\Arduino\libraries'</html>

<html>`e.g. D:\Program Files (x86)\Arduino\libraries` </html>

===== Add LibSC Reader Implemention Code =====

<html>Copy all the content of src\Firmware to 'X:\***\Arduino\libraries\MFRC522' </html>\\ 

<html>`e.g. D:\Program Files (x86)\Arduino\libraries\MFRC522`</html>


===== Download Firmware to Arduino Hareware =====

1.Open 'D:\Program Files (x86)\Arduino\libraries\MFRC522\examples\LibSC_RF_ReaderEx\LibSC_RF_ReaderEx.ino'\\ 
2.Compile and download, click Verify and Upload button.{{LRK_verify_upload.png}}\\ 

note:If failed to compile or upload, you can switch the port(the coresponding port mentioned above) by the arduino development environment menu *tools->port*. 

===== Install pyserial =====

Please install python and pip before installing pyserial.
Enter the command below in the console to install pyserial, then you can communicate with  arduino core board via serial port.  \\ 
 
  `pip install pyserial`

===== Run LibSC Reader =====
 
==== How to place the card ==== 

The shape of antenna board(MFRC522) is a little small,so when the card antenna is bigger than it, the placement angle has an effect on the stability of the connection. Please refert o the pictures shown below to properly place the card. \\ 
  
Mifare Card\\ 
{{:lrk_mifare.png?400|}}\\ 

CPU Card  \\ 
{{:Lrk_cpu.jpg?400|}}\\ 

===== Test Card =====

Click arduino menu *Tools->Port "COMXX" * to check COM port information. \\  
{{:port_num.png?400|}}\\ 

===== Console mode verification =====

Open the console, switch to the directory src/client and execute the below command \\ 

  `LibSC_Client.py com12`\\ 
  
"com12" is the port number assigned by the system.The port number will be different on different computers. \\  
If the card placed on the card reader module is MIFARE card, you will get the logs similar as the following. \\  
[[https://github.com/JavaCardOS/LibSC-Reader-Kit/blob/master/log/mifare.log|MIFARE test log]]  \\ 
If the card placed on the card reader module is CPU card, you will get the logs similar as the following.  \\ 
[[https://github.com/JavaCardOS/LibSC-Reader-Kit/blob/master/log/cpucard.log|CPU card test log]] \\  
  
===== Clone a MIFARE card by LibSC_tools =====

  LibSC_tools is a GUI program, which is developed based on wxPython.You can implement some basic operations on MIFARE card or MIFARE CLONE card via this program.
 

  Please install [wxPython3.0-win64-3.0.2.0-py27.exe](https://drive.google.com/drive/folders/0BzXJhN5FPrE5QWU5UURVWHdqajA) in advance before using the program. And also remember to select the installation version according to your own system.
  
===== Start program =====

Put the card,which is to be copied, to the effective position of 
MFRC522 antenna. Start program and execute "LibSC_Tools.py" in the console.Then enter COM port and MIFARE sector password.\\ 
{{:dlg_setting.png?400|}}\\ 
After selecting the corresponding port, click "OK" to jump to program main interface. In the new dialogbox, you can see the current card type according to the item "Card Type" and it will also shows whether the card is cloneable.\\  
{{:main_ui.png?400|}}\\ 
Currently we only provide  *Read Card* function and *CopyUID* function. The *Write Card* function is not available. You can modify the source code (./src) according to your own requirement.\\ 

Note: The *Write Card* function can cause the card irremediable defect. Please look through  the content of chapter Password and Permission in MIFARE manual.\\  

== Copy UID  ==

Click "CopyUID" to copy the UID of the current connected card. Then the following dialogbox will display and the program will be back to the state that no cards are connected.At this time, you can change the card that supports CLONE function.\\   
{{:dlg_CopyUID.png?400|}}\\ 

== Write UID ==

After "CopyUID" operation ,the button's label "CopyUID" will be changed to "WriteUID" automatically,click  "WriteUID" to write the copied UID to the target card.
If the target card can not support CLONE function, the following dialogbox will display.\\ 
{{:dlg_not_clone.png?400|}}\\ 
If the target card support CLONE function, the pop-up dialog box will  let you confirm the "WriteUID" operation.\\  
{{:WriteUID.png?400|}}\\ 


===== Discussion =====

If you have any problem on LibSC Reader Module Development Kit, please feel free to post them in our forum. [[https://javacardos.com/javacardforum/viewforum.php?f=44|JavaCardOS DISCUSSION]]

===== TODO =====

Verify the below atforms:

arduino mega256\\ 

arduino mini\\ 

arduino micro\\
User Tools

Site Tools

Page Tools
