pyrfidhid

Python library to control Chinese USB HID 125Khz RFID Reader/Writer

Introduction

This library is the result of reverse-engineering the communication protocol of a Chinese USB 125Khz RFID Reader/Writer. A detailed document describing the whole procedure can be found at the wiki section of this project:

How to reverse engineer a USB HID RFID Reader/Writer

The library can be used to control the USB RFID device under Linux or MacOS, and it uses pyusb and libusb to communicate through the USB port.

Installation

You will need Python 2.7.x or greater, and pip. Just clone this repo, install the dependencies and run the setup.py script.

MacOS

$ brew install libusb
$ pip install pyusb --user
$ python setup.py install --user

Linux

$ sudo apt-get install libusb-1.0-0-dev
$ sudo pip install pyusb
$ sudo python setup.py install

Usage

The library should work with both Python 2.7.x and 3.x. After running the setup.py script you should be able to import and use the library within your project like this:

from rfidhid.core import RfidHid

try:
    # Try to open RFID device using default vid:pid (ffff:0035)
    rfid = RfidHid()
except Exception as e:
    print(e)
    exit()

payload_response = rfid.read_tag()
uid = payload_response.get_tag_uid()

rfid.beep()
print(uid)

The above script should try to connect to the device, read a Tag (if it is already close to the device), print the UID and beep.

For more complex read/write examples, please check out the examples folder.

You can also check the API documentation for a list of exported methods.

Final Notes

This is still in beta, and there are a couple of "to-do's":

Check if there are more commands available (I'm sure there must be), e.g. get device status, control beep duration and beeping times, control LEDs and RF, etc.
Support T5577 tags.
Support write protection.
Implement a console tool capable of reading, writing and cloning tags with the same ease as IDRW V3 tool.

nucatus/pyrfidhid