Home

Awesome

ESP RFID - Access Control with ESP8266, RC522 PN532 Wiegand RDM6300

Chat at https://gitter.im/esp-rfid/Lobby Backers on Open Collective Sponsors on Open Collective

Access Control system using a cheap MFRC522, PN532 RFID, RDM6300 readers or Wiegand RFID readers and Espressif's ESP8266 Microcontroller.

Showcase GifBoard

Features

For Users

For Tinkerers

Official Hardware

Get more information and see accessory options from Tindie Store

What are others saying about esp-rfid?
“Hi, nice project.” – @Rotzbua
“Your app works like a charm” – @tueddy
“Just stumbled upon this project while planning to do something similar. Very beautifully done!” – @LifeP
“Hello, I've come across your project and first of all… wow - thanks to all contributors for your hard work!” – @byt3w4rri0r
“Brilliant work.” – @danbicks
“This is an impressive project.” – @appi1
“I'd like to thank every single contributor for creating this epic project.” – @TheCellMc
“Congratulations for your awesome work! This project is absolutely brilliant.” – @quikote

Getting Started

This project still in its development phase. New features (and also bugs) are introduced often and some functions may become deprecated. Please feel free to comment or give feedback.

What You Will Need

Hardware

Software

Using Compiled Binaries

Download compiled binaries from GitHub Releases page https://github.com/esprfid/esp-rfid/releases

On Windows you can use "flash.bat", it will ask you which COM port that ESP is connected and then flashes it. You can use any flashing tool and do the flashing manually. The flashing process itself has been described at numerous places on Internet.

Building With PlatformIO

The build environment is based on PlatformIO. Follow the instructions found here: http://platformio.org/#!/get-started for installing it but skip the platform init step as this has already been done, modified and it is included in this repository. In summary:

sudo pip install -U pip setuptools
sudo pip install -U platformio
git clone https://github.com/esprfid/esp-rfid.git
cd esp-rfid
platformio run

When you run platformio run for the first time, it will download the toolchains and all necessary libraries automatically.

Useful commands:

The resulting (built) image(s) can be found in the directory /bin created during the build process.

How to modify the project

If you want to modify the code, you can read more info in the CONTRIBUTING file.

Pin Layout

The following table shows the typical pin layout used for connecting readers hardware to ESP:

ESP8266NodeMcu/WeMosWiegandPN532MFRC522RDM6300
GPIO-16D0SS (Wemos D1)SDA/SS
GPIO-15D8SDA/SS
GPIO-13D7D0MOSIMOSI
GPIO-12D6D1MISOMISO
GPIO-14D5SCKSCK
GPIO-04D2TX
GPIO-05D1SS

For Wiegand based readers, you can configure D0 and D1 pins via settings page. By default, D0 is GPIO-4 and D1 is GPIO-5

Steps

MQTT

You can integrate ESP-RFID with other systems using MQTT. Read the additional documentation for all the details.

Known Issues

Time

We are syncing time from a NTP Server (in Client -aka infrastructure- Mode). This will require ESP to have an Internet connection. Additionally your ESP can also work without Internet connection (Access Point -aka Ad-Hoc- Mode), without giving up functionality. This will require you to sync time manually. ESP can store and hold time for you approximately 51 days without major issues, device time can drift from actual time depending on usage, temperature, etc. so you have to login to settings page and sync it in a timely fashion. Timezones are supported with automatic switch to and from daylight saving time.

Security

We assume ESP-RFID project -as a whole- does not offer strong security. There are PICCs available that their UID (Unique Identification Numbers) can be set manually (Currently esp-rfid relies only UID to identify its users). Also there may be a bug in the code that may result free access to your belongings. And also, like every other network connected device esp-rfid is vulnerable to many attacks including Man-in-the-middle, Brute-force, etc.

This is a simple, hobby grade project, do not use it where strong security is needed.

What can be done to increase security? (by you and by us)

Scalability

Since we are limited on both flash and ram size things may get ugly at some point in the future. You can find out some test results below.

Tests

1) How many RFID Tag can be handled?

Restore some randomly generated user data on File System worth:

Total 122,880 Bytes

At least 1000 unique User (RFID Tag) can be handled, the test were performed on WeMos D1 mini.

Additional testing is needed:

Community

Chat at https://gitter.im/esp-rfid/Lobby Join community chat on Gitter

Projects that are based on esp-rfid

Acknowledgements

See ChangeLog

Donations

OC

Developing fully open, extensively tested embedded software is hard and time consuming work. Please consider making donations to support developers behind this beautiful software.

Donations transparently processed by Open Collective and expenses are being made public by OC's open ledger.

Contributors

This project exists thanks to all the people who contribute. <a href="https://github.com/esprfid/esp-rfid/graphs/contributors"><img src="https://opencollective.com/esp-rfid/contributors.svg?width=890&button=false" /></a>

License

The code parts written by ESP-RFID project's authors are licensed under MIT License, 3rd party libraries that are used by this project are licensed under different license schemes, please check them out as well.