miguelbalboa / rfid

Arduino RFID Library for MFRC522
The Unlicense
2.74k stars 1.43k forks source link

Remove example AccessControl.ino #568

Closed Rotzbua closed 3 years ago

Rotzbua commented 3 years ago

tl;dr: example has bug -> confuses people -> move to wiki

Background

The example was added in 2016 and in terms of complexity and scope it was more of an example project than a simple use case for the library.

Problem

Unfortunately, some problems have been revealed which have not been fixed yet. It seems that there are two opposing bugs, which means that if you fix one bug, the other bug will reappear. Therefore, previous bug fixes were not sufficient.

Assessment

I think that there is a fundamental problem which can only be solved by a complete rework.

Solution

Since an example that does not work as expected confuses new users rather than benefits them, the code is removed from the repository and added to the wiki.

Reference

403 #567

Rotzbua commented 3 years ago

Available in the wiki: https://github.com/miguelbalboa/rfid/wiki/%5BExample%5D-AccessControl