Torsten Stauder
5 years ago
13 changed files with 4364 additions and 0 deletions
-
17Hardware-Plaforms/ESP32-A1S-Audiokit/lib/MFRC522/Makefile
-
296Hardware-Plaforms/ESP32-A1S-Audiokit/lib/MFRC522/README.rst
-
24Hardware-Plaforms/ESP32-A1S-Audiokit/lib/MFRC522/UNLICENSE
-
140Hardware-Plaforms/ESP32-A1S-Audiokit/lib/MFRC522/changes.txt
-
219Hardware-Plaforms/ESP32-A1S-Audiokit/lib/MFRC522/keywords.txt
-
14Hardware-Plaforms/ESP32-A1S-Audiokit/lib/MFRC522/library.json
-
9Hardware-Plaforms/ESP32-A1S-Audiokit/lib/MFRC522/library.properties
-
1899Hardware-Plaforms/ESP32-A1S-Audiokit/lib/MFRC522/src/MFRC522.cpp
-
434Hardware-Plaforms/ESP32-A1S-Audiokit/lib/MFRC522/src/MFRC522.h
-
1160Hardware-Plaforms/ESP32-A1S-Audiokit/lib/MFRC522/src/MFRC522Extended.cpp
-
120Hardware-Plaforms/ESP32-A1S-Audiokit/lib/MFRC522/src/MFRC522Extended.h
-
20Hardware-Plaforms/ESP32-A1S-Audiokit/lib/MFRC522/src/deprecated.h
-
12Hardware-Plaforms/ESP32-A1S-Audiokit/lib/MFRC522/src/require_cpp11.h
@ -0,0 +1,17 @@ |
|||||
|
# Makefile for MFRC522 library
|
||||
|
#
|
||||
|
|
||||
|
all: package |
||||
|
|
||||
|
help: |
||||
|
@echo "Please use \`make <target>' where <target> is one of" |
||||
|
@echo " clean to clean the project (e.g. remove process files)" |
||||
|
@echo " package to package the library (into a zip file)" |
||||
|
|
||||
|
clean: |
||||
|
rm ./MFRC522.zip |
||||
|
@echo |
||||
|
@echo "Clean finished." |
||||
|
|
||||
|
package: |
||||
|
zip -o ./MFRC522.zip ./MFRC522.h ./MFRC522.cpp |
||||
@ -0,0 +1,296 @@ |
|||||
|
MFRC522 |
||||
|
======= |
||||
|
|
||||
|
.. image:: https://travis-ci.org/miguelbalboa/rfid.svg?branch=master |
||||
|
:target: https://travis-ci.org/miguelbalboa/rfid |
||||
|
.. image:: https://img.shields.io/badge/C%2B%2B-11-brightgreen.svg |
||||
|
:target: `compatible ide`_ |
||||
|
.. image:: https://img.shields.io/github/release/miguelbalboa/rfid.svg?colorB=green |
||||
|
:target: https://github.com/miguelbalboa/rfid/releases |
||||
|
.. image:: https://img.shields.io/badge/ArduinoIDE-%3E%3D1.6.10-lightgrey.svg |
||||
|
:target: `compatible ide`_ |
||||
|
|
||||
|
Arduino library for MFRC522 and other RFID RC522 based modules. |
||||
|
|
||||
|
Read and write different types of Radio-Frequency IDentification (RFID) cards |
||||
|
on your Arduino using a RC522 based reader connected via the Serial Peripheral |
||||
|
Interface (SPI) interface. |
||||
|
|
||||
|
|
||||
|
.. _development: |
||||
|
Development |
||||
|
---------- |
||||
|
**The development by owner miguelbalboa has ended**. Further development will be done by community. This library is still maintained by miguelbalboa, so make pull request if you like some new features or fixes. Support/issues should be solved by community. |
||||
|
|
||||
|
|
||||
|
.. _what works and not: |
||||
|
What works and not? |
||||
|
---------- |
||||
|
|
||||
|
* **Works** |
||||
|
|
||||
|
#. Communication (Crypto1) with MIFARE Classic (1k, 4k, Mini). |
||||
|
#. Communication (Crypto1) with MIFARE Classic compatible PICCs. |
||||
|
#. Firmware self check of MFRC522. |
||||
|
#. Set the UID, write to sector 0, and unbrick Chinese UID changeable MIFARE cards. |
||||
|
|
||||
|
* **Partial** |
||||
|
|
||||
|
#. Communication with MIFARE Ultralight. |
||||
|
#. Other PICCs (Ntag216). |
||||
|
#. More than 2 modules, require a multiplexer `#191 <https://github.com/miguelbalboa/rfid/issues/191#issuecomment-242631153>`_. |
||||
|
|
||||
|
* **Works not** |
||||
|
|
||||
|
#. MIFARE DESFire, MIFARE DESFire EV1/EV2, not supported by software. |
||||
|
#. Communication with 3DES or AES, not supported by software. |
||||
|
#. Peer-to-peer (ISO/IEC 18092), not `supported by hardware`_. |
||||
|
#. Communication with smart phone, not `supported by hardware`_. |
||||
|
#. Card emulation, not `supported by hardware`_. |
||||
|
#. Use of IRQ pin. But there is a proof-of-concept example. |
||||
|
#. With Arduino Yun see `#111 <https://github.com/miguelbalboa/rfid/issues/111>`_, not supported by software. |
||||
|
#. With Intel Galileo (Gen2) see `#310 <https://github.com/miguelbalboa/rfid/issues/310>`__, not supported by software. |
||||
|
#. Power reduction modes `#269 <https://github.com/miguelbalboa/rfid/issues/269>`_, not supported by software. |
||||
|
#. I2C instead of SPI `#240 <https://github.com/miguelbalboa/rfid/issues/240>`_, not supported by software. |
||||
|
#. UART instead of SPI `#281 <https://github.com/miguelbalboa/rfid/issues/281>`_, not supported by software. |
||||
|
|
||||
|
* **Need more?** |
||||
|
|
||||
|
#. If software: code it and make a pull request. |
||||
|
#. If hardware: buy a more expensive like PN532 (supports NFC and many more, but costs about $15). |
||||
|
|
||||
|
|
||||
|
.. _compatible ide: |
||||
|
Compatible IDE |
||||
|
---------- |
||||
|
This library works with Arduino IDE 1.6, older versions are **not supported** and will cause compile errors. The built-in library manager is supported. |
||||
|
|
||||
|
If you use your own compiler, you have to enable ``c++11``-support. |
||||
|
|
||||
|
|
||||
|
.. _compatible boards: |
||||
|
Compatible boards |
||||
|
---------- |
||||
|
|
||||
|
**!!!Only for advanced user!!!** |
||||
|
|
||||
|
This library is compatible to Teensy and ESP8266, if you use board plugin of the Arduino IDE. Not all examples are available for every board. You also have to change pins, see `pin layout`_. |
||||
|
|
||||
|
Some user made some patches/suggestions/ports for other boards: |
||||
|
|
||||
|
* Linux: https://github.com/miguelbalboa/rfid/pull/216 |
||||
|
* chipKIT: https://github.com/miguelbalboa/rfid/pull/230 |
||||
|
* ESP8266 (native): https://github.com/miguelbalboa/rfid/pull/235 |
||||
|
* ESP8266 nonos sdk: https://github.com/mmmmar/esp8266-mfrc522 |
||||
|
* LPCOPen (in C): https://github.com/miguelbalboa/rfid/pull/258 |
||||
|
|
||||
|
Note that the main target/support of library is still Arduino. |
||||
|
|
||||
|
.. _support issue: |
||||
|
Support/issue |
||||
|
---------- |
||||
|
1. First checkout `what works and not`_ and `troubleshooting`_ . |
||||
|
|
||||
|
2. It seems to be a hardware issue or you need support to program your project? |
||||
|
Please ask in the official `Arduino forum`_, there you would get a much faster answer then on github. |
||||
|
|
||||
|
3. It seems to be a software issue? |
||||
|
Open an issue on github. |
||||
|
|
||||
|
|
||||
|
.. _code style: |
||||
|
Code style |
||||
|
---------- |
||||
|
|
||||
|
Please use ``fixed integers``, see `stdint.h`_. Why? This library is compatible to different boards which use different architectures (16bit vs 32bit). So unfixed ``int`` has different sizes on different environments and may cause unpredictable behaviour. |
||||
|
|
||||
|
|
||||
|
.. _pin layout: |
||||
|
Pin Layout |
||||
|
---------- |
||||
|
|
||||
|
The following table shows the typical pin layout used: |
||||
|
|
||||
|
+-----------+----------+---------------------------------------------------------------+--------------------------+ |
||||
|
| | PCD | Arduino | Teensy | |
||||
|
| +----------+-------------+---------+---------+-----------------+-----------+--------+--------+--------+ |
||||
|
| | MFRC522 | Uno / 101 | Mega | Nano v3 |Leonardo / Micro | Pro Micro | 2.0 | ++ 2.0 | 3.1 | |
||||
|
+-----------+----------+-------------+---------+---------+-----------------+-----------+--------+--------+--------+ |
||||
|
| Signal | Pin | Pin | Pin | Pin | Pin | Pin | Pin | Pin | Pin | |
||||
|
+===========+==========+=============+=========+=========+=================+===========+========+========+========+ |
||||
|
| RST/Reset | RST | 9 [1]_ | 5 [1]_ | D9 | RESET / ICSP-5 | RST | 7 | 4 | 9 | |
||||
|
+-----------+----------+-------------+---------+---------+-----------------+-----------+--------+--------+--------+ |
||||
|
| SPI SS | SDA [3]_ | 10 [2]_ | 53 [2]_ | D10 | 10 | 10 | 0 | 20 | 10 | |
||||
|
+-----------+----------+-------------+---------+---------+-----------------+-----------+--------+--------+--------+ |
||||
|
| SPI MOSI | MOSI | 11 / ICSP-4 | 51 | D11 | ICSP-4 | 16 | 2 | 22 | 11 | |
||||
|
+-----------+----------+-------------+---------+---------+-----------------+-----------+--------+--------+--------+ |
||||
|
| SPI MISO | MISO | 12 / ICSP-1 | 50 | D12 | ICSP-1 | 14 | 3 | 23 | 12 | |
||||
|
+-----------+----------+-------------+---------+---------+-----------------+-----------+--------+--------+--------+ |
||||
|
| SPI SCK | SCK | 13 / ICSP-3 | 52 | D13 | ICSP-3 | 15 | 1 | 21 | 13 | |
||||
|
+-----------+----------+-------------+---------+---------+-----------------+-----------+--------+--------+--------+ |
||||
|
|
||||
|
.. [1] Configurable, typically defined as RST_PIN in sketch/program. |
||||
|
.. [2] Configurable, typically defined as SS_PIN in sketch/program. |
||||
|
.. [3] The SDA pin might be labeled SS on some/older MFRC522 boards. |
||||
|
|
||||
|
|
||||
|
.. _hardware: |
||||
|
Hardware |
||||
|
-------- |
||||
|
|
||||
|
There are three hardware components involved: |
||||
|
|
||||
|
1. **Micro Controller**: |
||||
|
|
||||
|
* An `Arduino`_ or compatible executing the Sketch using this library. |
||||
|
|
||||
|
* Prices vary from USD 7 for clones, to USD 75 for "starter kits" (which |
||||
|
might be a good choice if this is your first exposure to Arduino; |
||||
|
check if such kit already includes the Arduino, Reader, and some Tags). |
||||
|
|
||||
|
2. **Proximity Coupling Device (PCD)**: |
||||
|
|
||||
|
* The PCD is the actual RFID **Reader** based on `NXP MFRC522`_ Contactless |
||||
|
Reader Integrated Circuit). |
||||
|
|
||||
|
* Readers can be found on `eBay`_ for around USD 5: search for *"rc522"*. |
||||
|
|
||||
|
* You can also find them at several web stores, they are often included in |
||||
|
*"starter kits"*; so check your favourite electronics provider as well. |
||||
|
|
||||
|
3. **Proximity Integrated Circuit Card (PICC)**: |
||||
|
|
||||
|
* The PICC is the RFID **Card** or **Tag** using the `ISO/IEC 14443A`_ |
||||
|
interface, for example Mifare or NTAG203. |
||||
|
|
||||
|
* One or two might be included with the Reader or *"starter kit"* already. |
||||
|
|
||||
|
|
||||
|
.. _protocol: |
||||
|
Protocols |
||||
|
--------- |
||||
|
|
||||
|
1. The micro controller and the reader use SPI for communication. |
||||
|
|
||||
|
* The protocol is described in the `NXP MFRC522`_ datasheet. |
||||
|
|
||||
|
* See the `Pin Layout`_ section for details on connecting the pins. |
||||
|
|
||||
|
2. The reader and the tags communicate using a 13.56 MHz electromagnetic field. |
||||
|
|
||||
|
* The protocol is defined in ISO/IEC 14443-3:2011 Part 3 Type A. |
||||
|
|
||||
|
* Details are found in chapter 6 *"Type A – Initialization and anticollision"*. |
||||
|
|
||||
|
* See http://wg8.de/wg8n1496_17n3613_Ballot_FCD14443-3.pdf for a free version |
||||
|
of the final draft (which might be outdated in some areas). |
||||
|
|
||||
|
* The reader does not support ISO/IEC 14443-3 Type B. |
||||
|
|
||||
|
|
||||
|
.. _security: |
||||
|
Security |
||||
|
------- |
||||
|
This library only supports crypto1-encrypted communication. Crypto1 has been known as `broken`_ for a few years, so it does NOT offer ANY security, it is virtually unencrypted communication. **Do not use it for any security related applications!** |
||||
|
|
||||
|
This library does not offer 3DES or AES authentication used by cards like the Mifare DESFire, it may be possible to be implemented because the datasheet says there is support. We hope for pull requests :). |
||||
|
|
||||
|
|
||||
|
.. _troubleshooting: |
||||
|
Troubleshooting |
||||
|
------- |
||||
|
|
||||
|
* **I don't get input from reader** or **WARNING: Communication failure, is the MFRC522 properly connected?** |
||||
|
|
||||
|
#. Check your connection, see `Pin Layout`_ . |
||||
|
#. Check voltage. Most breakouts work with 3.3V. |
||||
|
#. SPI only works with 3.3V, most breakouts seem 5V tollerant, but try a level shifter. |
||||
|
#. SPI do not like long connections. Try shorter connections. |
||||
|
#. SPI do not like prototyping boards. Maybe try a soldered connections. |
||||
|
#. According to reports #101, #126 and #131, there may be a problem with the soldering on the MFRC522 breakout. You could fix this on your own. |
||||
|
|
||||
|
|
||||
|
* **Sometimes I get timeouts** or **sometimes tag/card does not work.** |
||||
|
|
||||
|
#. Try other side of the antenna. |
||||
|
#. Try to decrease distance between MFRC522. |
||||
|
#. Increase antenna gain per firmware: ``mfrc522.PCD_SetAntennaGain(mfrc522.RxGain_max);`` |
||||
|
#. Use better power supply. |
||||
|
#. Hardware may be corrupted, most products are from china and sometimes the quality is really poor. Contact your seller. |
||||
|
|
||||
|
|
||||
|
* **My tag/card doesn't work.** |
||||
|
|
||||
|
#. Distance between antenna and token too large (>1cm). |
||||
|
#. You got the wrong type PICC. Is it really 13.56 MHz? Is it really a Mifare Type A? |
||||
|
#. NFC tokens are not supported. Some may work. |
||||
|
#. Animal RFID tags are not supported. They use a different frequency (125 kHz). |
||||
|
#. Hardware may be corrupted, most products are from china and sometimes the quality is really poor. Contact your seller. |
||||
|
#. Newer versions of Mifare cards like DESFire/Ultralight maybe not work according to missing authentification, see `security`_ or different `protocol`_. |
||||
|
#. Some boards bought from chinese manufactures do not use the best components and this can affect the detection of different types of tag/card. In some of these boards, the L1 and L2 inductors do not have a high enough current so the signal generated is not enough to get Ultralight C and NTAG203 tags to work, replacing those with same inductance (2.2uH) but higher operating current inductors should make things work smoothly. Also, in some of those boards the harmonic and matching circuit needs to be tuned, for this replace C4 and C5 with 33pf capacitors and you are all set. (Source: `Mikro Elektronika`_) |
||||
|
|
||||
|
* **My mobile phone doesn't recognize the MFRC522** or **my MFRC522 can't read data from other MFRC522** |
||||
|
|
||||
|
#. Card simmulation is not supported. |
||||
|
#. Communication with mobile phones is not supported. |
||||
|
#. Peer to peer communication is not supported. |
||||
|
|
||||
|
|
||||
|
* **I need more features.** |
||||
|
|
||||
|
#. If software: code it and make a pull request. |
||||
|
#. If hardware: buy a more expensive like PN532 (supports NFC and many more, but costs about $15) |
||||
|
|
||||
|
|
||||
|
.. _license: |
||||
|
License |
||||
|
------- |
||||
|
This is free and unencumbered software released into the public domain. |
||||
|
|
||||
|
Anyone is free to copy, modify, publish, use, compile, sell, or |
||||
|
distribute this software, either in source code form or as a compiled |
||||
|
binary, for any purpose, commercial or non-commercial, and by any |
||||
|
means. |
||||
|
|
||||
|
In jurisdictions that recognize copyright laws, the author or authors |
||||
|
of this software dedicate any and all copyright interest in the |
||||
|
software to the public domain. We make this dedication for the benefit |
||||
|
of the public at large and to the detriment of our heirs and |
||||
|
successors. We intend this dedication to be an overt act of |
||||
|
relinquishment in perpetuity of all present and future rights to this |
||||
|
software under copyright law. |
||||
|
|
||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
||||
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
||||
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
||||
|
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR |
||||
|
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
||||
|
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
||||
|
OTHER DEALINGS IN THE SOFTWARE. |
||||
|
|
||||
|
For more information, please refer to https://unlicense.org/ |
||||
|
|
||||
|
|
||||
|
History |
||||
|
------- |
||||
|
|
||||
|
The MFRC522 library was first created in Jan 2012 by Miguel Balboa (from |
||||
|
http://circuitito.com) based on code by Dr. Leong (from http://B2CQSHOP.com) |
||||
|
for *"Arduino RFID module Kit 13.56 Mhz with Tags SPI W and R By COOQRobot"*. |
||||
|
|
||||
|
It was translated into English and rewritten/refactored in the fall of 2013 |
||||
|
by Søren Thing Andersen (from http://access.thing.dk). |
||||
|
|
||||
|
It has been extended with functionality to alter sector 0 on Chinese UID changeable MIFARE card in Oct 2014 by Tom Clement (from http://tomclement.nl). |
||||
|
|
||||
|
|
||||
|
.. _arduino: https://arduino.cc/ |
||||
|
.. _ebay: https://www.ebay.com/ |
||||
|
.. _iso/iec 14443a: https://en.wikipedia.org/wiki/ISO/IEC_14443 |
||||
|
.. _iso/iec 14443-3\:2011 part 3: |
||||
|
.. _nxp mfrc522: https://www.nxp.com/documents/data_sheet/MFRC522.pdf |
||||
|
.. _broken: https://eprint.iacr.org/2008/166 |
||||
|
.. _supported by hardware: https://web.archive.org/web/20151210045625/http://www.nxp.com/documents/leaflet/939775017564.pdf |
||||
|
.. _Arduino forum: https://forum.arduino.cc |
||||
|
.. _stdint.h: https://en.wikibooks.org/wiki/C_Programming/C_Reference/stdint.h |
||||
|
.. _Mikro Elektronika: https://forum.mikroe.com/viewtopic.php?f=147&t=64203 |
||||
@ -0,0 +1,24 @@ |
|||||
|
This is free and unencumbered software released into the public domain. |
||||
|
|
||||
|
Anyone is free to copy, modify, publish, use, compile, sell, or |
||||
|
distribute this software, either in source code form or as a compiled |
||||
|
binary, for any purpose, commercial or non-commercial, and by any |
||||
|
means. |
||||
|
|
||||
|
In jurisdictions that recognize copyright laws, the author or authors |
||||
|
of this software dedicate any and all copyright interest in the |
||||
|
software to the public domain. We make this dedication for the benefit |
||||
|
of the public at large and to the detriment of our heirs and |
||||
|
successors. We intend this dedication to be an overt act of |
||||
|
relinquishment in perpetuity of all present and future rights to this |
||||
|
software under copyright law. |
||||
|
|
||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
||||
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
||||
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
||||
|
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR |
||||
|
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
||||
|
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
||||
|
OTHER DEALINGS IN THE SOFTWARE. |
||||
|
|
||||
|
For more information, please refer to <http://unlicense.org/> |
||||
@ -0,0 +1,140 @@ |
|||||
|
-- Add changes to unreleased tag until we make a release. |
||||
|
|
||||
|
13 Apr 2018, v1.4.0 |
||||
|
- Replaced UINT8_MAX by UNUSED_PIN @Rotzbua |
||||
|
- Fixed hang PCD_Init() on non-arduino boards @heziegl |
||||
|
- deprecate MIFARE_SetAccessBits @Rotzbua |
||||
|
- IMPORTANT: v1.4.X will be last version under license "unlicense" |
||||
|
|
||||
|
22 Mar 2017, v1.3.6 |
||||
|
- Added deprecate and compiler warnings @Rotzbua |
||||
|
|
||||
|
8 Apr 2017, v1.3.5 |
||||
|
- Updated "AccessControl.ino", bugs fixed and alterate Wipe button polling method without using other library @beyondszine reviewed by @omersiar |
||||
|
- Updated README notice about port for esp8266 @mmmmar |
||||
|
|
||||
|
7 Apr 2017, v1.3.4 |
||||
|
- Added new example "rfid_read_personal_data.ino" @ryand1011 |
||||
|
- Updated example "rfid_write_personal_data.ino" code style to Arduino IDE @Rotzbua |
||||
|
- Removed (temp.) Teensy from travis build script because fails @Rotzbua |
||||
|
|
||||
|
26 Mar 2017, v1.3.3 |
||||
|
- Fixed bugs in MFRC522Extended, now should work with Desfire.h from JPG-Consulting @Rotzbua |
||||
|
- Fixed UINT8_MAX error @Rotzbua |
||||
|
|
||||
|
15 Mar 2017, v1.3.2 |
||||
|
- Added ESP8266 to library.properties |
||||
|
|
||||
|
15 Mar 2017, v1.3.1 |
||||
|
- Fixed compiler warning in MFRC522Extended @Rotzbua |
||||
|
- Removed unused function @Rotzbua |
||||
|
|
||||
|
13 Mar 2017, v1.3.0 |
||||
|
- Warning: Source has moved to folder src! |
||||
|
- Added addtional class to support ISO/IEC 14443-4 PICCs @JPG-Consulting |
||||
|
- Added RATS (Request for Answer To Select) @JPG-Consulting |
||||
|
- More information see https://github.com/miguelbalboa/rfid/pull/271 @JPG-Consulting |
||||
|
|
||||
|
13 Mar 2017, v1.2.1 |
||||
|
- Removed need for reset pin #275 @tkoester |
||||
|
- Added SPI speed option + Various minor changes #276 @tuyethoa08041997 |
||||
|
- Updated documentation, travis build script and small code change @Rotzbua |
||||
|
|
||||
|
3 Jan 2017, v1.2.0 |
||||
|
- Warning: This version introduce usage of stdint.h, usage of not well defined int types are abandoned. |
||||
|
Interface has changed: e.g. long -> int32_t |
||||
|
@Rotzbua |
||||
|
- Removed problematic example examples/servo_motor/servo_motor.ino @omersiar |
||||
|
- Added examples/AccessControl/AccessControl.ino @omersiar |
||||
|
- Fixed minor issues reported in #211 @omersiar |
||||
|
- Added bad components hint to README @danielcbit |
||||
|
- Fixed selftest @surr |
||||
|
- Fixed auth problem with long UIDs @surr |
||||
|
|
||||
|
26 Aug 2016, v1.1.9 |
||||
|
- Warning: Only Arduino IDE version 1.6 is supported, please update your IDE to 1.6 to use this Library. |
||||
|
- Added ESP8266 platform support @Rotzbua |
||||
|
- Changed README.rst content to show more info @Rotzbua |
||||
|
- Minor Changes to examples/ReadUidMultiReader/ReadUidMultiReader.ino example @Rotzbua |
||||
|
|
||||
|
11 Feb 2016, v1.1.8 |
||||
|
- Added examples/MinimalInterrupt/MinimalInterrupt.ino example, Interrupt example @lmmeng |
||||
|
- Added .gitignore file allows the project to be more easily used as a subproject. @BenWiederhake |
||||
|
- Added Added Teensy 2.0 & Tensy++ 2.0 pinouts to README.rst @jkutianski |
||||
|
|
||||
|
16 Jan 2016, v1.1.7 |
||||
|
- README.rst Spelling and Grammar Tweak @cuthbertnibbles |
||||
|
- Added examples/servo_motor/servo_motor.ino example, Arduino RFID Access Control with a Servo Motor @techied |
||||
|
- Added examples/RFID-Cloner/RFID-Cloner.ino Copy from rfid cards with standard authentication @stefanblommaert |
||||
|
- Fix compile error at examples/RFID-Cloner/RFID-Cloner.ino, using MFRC522:::PICC_Type, @Rotzbua |
||||
|
|
||||
|
06 Jan 2016, v1.1.6 |
||||
|
- Fixed compilation error for examples/ReadNUID/ReadNUID.ino example. @Rotzbua |
||||
|
|
||||
|
04 Jan 2016, v1.1.5 |
||||
|
- Use settings functions on SPI libraries, setSPIConfig was deleted, now the library use SPI.beginTransaction() and SPI.endTransaction() @sophiekovalevsky |
||||
|
- Added examples/ReadNUID/ReadNUID.ino example, showing how to read new NUID from a PICC to serial. @sophiekovalevsky |
||||
|
|
||||
|
03 Jan 2016, v1.1.4 |
||||
|
- Added Authentication with Ntag 213,215,216 returns the pACK MFRC522::PCD_NTAG216_AUTH @Gargantuanman |
||||
|
- Starting to use versions http://semver.org/ |
||||
|
- Continuous Integration @ivankravets |
||||
|
- functions return MFRC522::StatusCode and MFRC522::PICC_Type instead of generic byte @rotzbua |
||||
|
- removed int-values of MFRC522::StatusCode and MFRC522::PICC_Type @rotzbua |
||||
|
|
||||
|
05 Dec 2015 |
||||
|
- recognize infineon cards correctly @mayatforest |
||||
|
- added multi reader support, see example @lmmeng |
||||
|
|
||||
|
10 Nov 2014 |
||||
|
- Updated the changelog. |
||||
|
- Added makefile. |
||||
|
|
||||
|
24 Oct 2014 |
||||
|
- Added PlatformIO-based manifest file. |
||||
|
|
||||
|
17 Jul 2014 |
||||
|
- Written documentation for the library. |
||||
|
- Added rfid_default_keys example. |
||||
|
|
||||
|
11 Jun 2014 |
||||
|
- Updated example: ReadAndWrite. |
||||
|
|
||||
|
14 Apr 2014 |
||||
|
- Updated examples: DumpInfo, MifareClassicValueBlock, and ReadAndWrite. |
||||
|
|
||||
|
12 Feb 2014 |
||||
|
- Fixed resetPowerDownPin initial state. |
||||
|
|
||||
|
29 Jan 2014 |
||||
|
- Fixed chipSelectPin initial state. |
||||
|
|
||||
|
30 Nov 2013 |
||||
|
- Examples put in their own folders. |
||||
|
- Updated the keywords.txt file. |
||||
|
|
||||
|
12 Nov 2013 |
||||
|
- Updated examples: DumpInfo, MifareClassicValueBlock, and ReadAndWrite. |
||||
|
|
||||
|
20 Oct 2013 |
||||
|
- All constants, functions and parameters are now commented in English. |
||||
|
- Code refactored, most function names have changed. |
||||
|
- Support ISO-14443-3 anti collission and 4/7/10 byte UIDs (cascade levels). |
||||
|
- Added functions for MIFARE Classic Decrement/Increment/Restore/Transfer |
||||
|
and MIFARE Ultralight Write. |
||||
|
- New examples written. |
||||
|
|
||||
|
19 Oct 2013 |
||||
|
- Renamed library from RFID to MFRC522 (RFID seemed to generic). |
||||
|
- Register names changed to comply with datasheet. |
||||
|
- Global defines moved into class. |
||||
|
|
||||
|
24 Sep 2013 |
||||
|
- Turn off encryption when tag is halted. |
||||
|
|
||||
|
27 Jan 2013 |
||||
|
- Added README and small TODO list. |
||||
|
- Added example to show Serial on LCD display. |
||||
|
|
||||
|
09 Sep 2012 |
||||
|
- Initial commit to GitHub. |
||||
@ -0,0 +1,219 @@ |
|||||
|
####################################### |
||||
|
# Syntax Coloring Map for library MFRC522 |
||||
|
####################################### |
||||
|
|
||||
|
####################################### |
||||
|
# KEYWORD1 Classes, datatypes, and C++ keywords |
||||
|
####################################### |
||||
|
MFRC522 KEYWORD1 |
||||
|
MFRC522Extended KEYWORD1 |
||||
|
PCD_Register KEYWORD1 |
||||
|
PCD_Command KEYWORD1 |
||||
|
PCD_RxGain KEYWORD1 |
||||
|
PICC_Command KEYWORD1 |
||||
|
MIFARE_Misc KEYWORD1 |
||||
|
PICC_Type KEYWORD1 |
||||
|
StatusCode KEYWORD1 |
||||
|
TagBitRates KEYWORD1 |
||||
|
Uid KEYWORD1 |
||||
|
CardInfo KEYWORD1 |
||||
|
MIFARE_Key KEYWORD1 |
||||
|
PcbBlock KEYWORD1 |
||||
|
|
||||
|
####################################### |
||||
|
# KEYWORD2 Methods and functions |
||||
|
####################################### |
||||
|
|
||||
|
# Basic interface functions for communicating with the MFRC522 |
||||
|
PCD_WriteRegister KEYWORD2 |
||||
|
PCD_WriteRegister KEYWORD2 |
||||
|
PCD_ReadRegister KEYWORD2 |
||||
|
PCD_ReadRegister KEYWORD2 |
||||
|
setBitMask KEYWORD2 |
||||
|
PCD_SetRegisterBitMask KEYWORD2 |
||||
|
PCD_ClearRegisterBitMask KEYWORD2 |
||||
|
PCD_CalculateCRC KEYWORD2 |
||||
|
|
||||
|
# Functions for manipulating the MFRC522 |
||||
|
PCD_Init KEYWORD2 |
||||
|
PCD_Reset KEYWORD2 |
||||
|
PCD_AntennaOn KEYWORD2 |
||||
|
PCD_AntennaOff KEYWORD2 |
||||
|
PCD_GetAntennaGain KEYWORD2 |
||||
|
PCD_SetAntennaGain KEYWORD2 |
||||
|
PCD_PerformSelfTest KEYWORD2 |
||||
|
|
||||
|
# Functions for communicating with PICCs |
||||
|
PCD_TransceiveData KEYWORD2 |
||||
|
PCD_CommunicateWithPICC KEYWORD2 |
||||
|
PICC_RequestA KEYWORD2 |
||||
|
PICC_WakeupA KEYWORD2 |
||||
|
PICC_REQA_or_WUPA KEYWORD2 |
||||
|
PICC_Select KEYWORD2 |
||||
|
PICC_HaltA KEYWORD2 |
||||
|
PICC_RATS KEYWORD2 |
||||
|
PICC_PPS KEYWORD2 |
||||
|
|
||||
|
# Functions for communicating with ISO/IEC 14433-4 cards |
||||
|
TCL_Transceive KEYWORD2 |
||||
|
TCL_TransceiveRBlock KEYWORD2 |
||||
|
TCL_Deselect KEYWORD2 |
||||
|
|
||||
|
# Functions for communicating with MIFARE PICCs |
||||
|
PCD_Authenticate KEYWORD2 |
||||
|
PCD_StopCrypto1 KEYWORD2 |
||||
|
MIFARE_Read KEYWORD2 |
||||
|
MIFARE_Write KEYWORD2 |
||||
|
MIFARE_Increment KEYWORD2 |
||||
|
MIFARE_Ultralight_Write KEYWORD2 |
||||
|
MIFARE_GetValue KEYWORD2 |
||||
|
MIFARE_SetValue KEYWORD2 |
||||
|
PCD_NTAG216_AUTH KEYWORD2 |
||||
|
|
||||
|
# Support functions |
||||
|
PCD_MIFARE_Transceive KEYWORD2 |
||||
|
GetStatusCodeName KEYWORD2 |
||||
|
PICC_GetType KEYWORD2 |
||||
|
PICC_GetTypeName KEYWORD2 |
||||
|
|
||||
|
# Support functions for debuging |
||||
|
PCD_DumpVersionToSerial KEYWORD2 |
||||
|
PICC_DumpToSerial KEYWORD2 |
||||
|
PICC_DumpDetailsToSerial KEYWORD2 |
||||
|
PICC_DumpMifareClassicToSerial KEYWORD2 |
||||
|
PICC_DumpMifareClassicSectorToSerial KEYWORD2 |
||||
|
PICC_DumpMifareUltralightToSerial KEYWORD2 |
||||
|
PICC_DumpISO14443_4 KEYWORD2 |
||||
|
|
||||
|
# Advanced functions for MIFARE |
||||
|
MIFARE_SetAccessBits KEYWORD2 |
||||
|
MIFARE_OpenUidBackdoor KEYWORD2 |
||||
|
MIFARE_SetUid KEYWORD2 |
||||
|
MIFARE_UnbrickUidSector KEYWORD2 |
||||
|
|
||||
|
# Convenience functions - does not add extra functionality |
||||
|
PICC_IsNewCardPresent KEYWORD2 |
||||
|
PICC_ReadCardSerial KEYWORD2 |
||||
|
|
||||
|
####################################### |
||||
|
# KEYWORD3 setup and loop functions, as well as the Serial keywords |
||||
|
####################################### |
||||
|
|
||||
|
####################################### |
||||
|
LITERAL1 Constants |
||||
|
####################################### |
||||
|
CommandReg LITERAL1 |
||||
|
ComIEnReg LITERAL1 |
||||
|
DivIEnReg LITERAL1 |
||||
|
ComIrqReg LITERAL1 |
||||
|
DivIrqReg LITERAL1 |
||||
|
ErrorReg LITERAL1 |
||||
|
Status1Reg LITERAL1 |
||||
|
Status2Reg LITERAL1 |
||||
|
FIFODataReg LITERAL1 |
||||
|
FIFOLevelReg LITERAL1 |
||||
|
WaterLevelReg LITERAL1 |
||||
|
ControlReg LITERAL1 |
||||
|
BitFramingReg LITERAL1 |
||||
|
CollReg LITERAL1 |
||||
|
ModeReg LITERAL1 |
||||
|
TxModeReg LITERAL1 |
||||
|
RxModeReg LITERAL1 |
||||
|
TxControlReg LITERAL1 |
||||
|
TxASKReg LITERAL1 |
||||
|
TxSelReg LITERAL1 |
||||
|
RxSelReg LITERAL1 |
||||
|
RxThresholdReg LITERAL1 |
||||
|
DemodReg LITERAL1 |
||||
|
MfTxReg LITERAL1 |
||||
|
MfRxReg LITERAL1 |
||||
|
SerialSpeedReg LITERAL1 |
||||
|
CRCResultRegH LITERAL1 |
||||
|
CRCResultRegL LITERAL1 |
||||
|
ModWidthReg LITERAL1 |
||||
|
RFCfgReg LITERAL1 |
||||
|
GsNReg LITERAL1 |
||||
|
CWGsPReg LITERAL1 |
||||
|
ModGsPReg LITERAL1 |
||||
|
TModeReg LITERAL1 |
||||
|
TPrescalerReg LITERAL1 |
||||
|
TReloadRegH LITERAL1 |
||||
|
TReloadRegL LITERAL1 |
||||
|
TCounterValueRegH LITERAL1 |
||||
|
TCounterValueRegL LITERAL1 |
||||
|
TestSel1Reg LITERAL1 |
||||
|
TestSel2Reg LITERAL1 |
||||
|
TestPinEnReg LITERAL1 |
||||
|
TestPinValueReg LITERAL1 |
||||
|
TestBusReg LITERAL1 |
||||
|
AutoTestReg LITERAL1 |
||||
|
VersionReg LITERAL1 |
||||
|
AnalogTestReg LITERAL1 |
||||
|
TestDAC1Reg LITERAL1 |
||||
|
TestDAC2Reg LITERAL1 |
||||
|
TestADCReg LITERAL1 |
||||
|
PCD_Idle LITERAL1 |
||||
|
PCD_Mem LITERAL1 |
||||
|
PCD_GenerateRandomID LITERAL1 |
||||
|
PCD_CalcCRC LITERAL1 |
||||
|
PCD_Transmit LITERAL1 |
||||
|
PCD_NoCmdChange LITERAL1 |
||||
|
PCD_Receive LITERAL1 |
||||
|
PCD_Transceive LITERAL1 |
||||
|
PCD_MFAuthent LITERAL1 |
||||
|
PCD_SoftReset LITERAL1 |
||||
|
RxGain_18dB LITERAL1 |
||||
|
RxGain_23dB LITERAL1 |
||||
|
RxGain_18dB_2 LITERAL1 |
||||
|
RxGain_23dB_2 LITERAL1 |
||||
|
RxGain_33dB LITERAL1 |
||||
|
RxGain_38dB LITERAL1 |
||||
|
RxGain_43dB LITERAL1 |
||||
|
RxGain_48dB LITERAL1 |
||||
|
RxGain_min LITERAL1 |
||||
|
RxGain_avg LITERAL1 |
||||
|
RxGain_max LITERAL1 |
||||
|
PICC_CMD_REQA LITERAL1 |
||||
|
PICC_CMD_WUPA LITERAL1 |
||||
|
PICC_CMD_CT LITERAL1 |
||||
|
PICC_CMD_SEL_CL1 LITERAL1 |
||||
|
PICC_CMD_SEL_CL2 LITERAL1 |
||||
|
PICC_CMD_SEL_CL3 LITERAL1 |
||||
|
PICC_CMD_HLTA LITERAL1 |
||||
|
PICC_CMD_RATS LITERAL1 |
||||
|
PICC_CMD_MF_AUTH_KEY_A LITERAL1 |
||||
|
PICC_CMD_MF_AUTH_KEY_B LITERAL1 |
||||
|
PICC_CMD_MF_READ LITERAL1 |
||||
|
PICC_CMD_MF_WRITE LITERAL1 |
||||
|
PICC_CMD_MF_DECREMENT LITERAL1 |
||||
|
PICC_CMD_MF_INCREMENT LITERAL1 |
||||
|
PICC_CMD_MF_RESTORE LITERAL1 |
||||
|
PICC_CMD_MF_TRANSFER LITERAL1 |
||||
|
PICC_CMD_UL_WRITE LITERAL1 |
||||
|
MF_ACK LITERAL1 |
||||
|
MF_KEY_SIZE LITERAL1 |
||||
|
PICC_TYPE_UNKNOWN LITERAL1 |
||||
|
PICC_TYPE_ISO_14443_4 LITERAL1 |
||||
|
PICC_TYPE_ISO_18092 LITERAL1 |
||||
|
PICC_TYPE_MIFARE_MINI LITERAL1 |
||||
|
PICC_TYPE_MIFARE_1K LITERAL1 |
||||
|
PICC_TYPE_MIFARE_4K LITERAL1 |
||||
|
PICC_TYPE_MIFARE_UL LITERAL1 |
||||
|
PICC_TYPE_MIFARE_PLUS LITERAL1 |
||||
|
PICC_TYPE_MIFARE_DESFIRE LITERAL1 |
||||
|
PICC_TYPE_TNP3XXX LITERAL1 |
||||
|
PICC_TYPE_NOT_COMPLETE LITERAL1 |
||||
|
STATUS_OK LITERAL1 |
||||
|
STATUS_ERROR LITERAL1 |
||||
|
STATUS_COLLISION LITERAL1 |
||||
|
STATUS_TIMEOUT LITERAL1 |
||||
|
STATUS_NO_ROOM LITERAL1 |
||||
|
STATUS_INTERNAL_ERROR LITERAL1 |
||||
|
STATUS_INVALID LITERAL1 |
||||
|
STATUS_CRC_WRONG LITERAL1 |
||||
|
STATUS_MIFARE_NACK LITERAL1 |
||||
|
FIFO_SIZE LITERAL1 |
||||
|
BITRATE_106KBITS LITERAL1 |
||||
|
BITRATE_212KBITS LITERAL1 |
||||
|
BITRATE_424KBITS LITERAL1 |
||||
|
BITRATE_848KBITS LITERAL1 |
||||
@ -0,0 +1,14 @@ |
|||||
|
{ |
||||
|
"name": "MFRC522", |
||||
|
"keywords": "rfid, spi", |
||||
|
"description": "Read a card using a MFRC522 reader on your SPI interface", |
||||
|
"repository": |
||||
|
{ |
||||
|
"type": "git", |
||||
|
"url": "https://github.com/miguelbalboa/rfid.git" |
||||
|
}, |
||||
|
"version": "1.4.0", |
||||
|
"exclude": "doc", |
||||
|
"frameworks": "arduino", |
||||
|
"platforms": ["atmelavr", "ststm32", "teensy", "espressif8266"] |
||||
|
} |
||||
@ -0,0 +1,9 @@ |
|||||
|
name=MFRC522 |
||||
|
version=1.4.0 |
||||
|
author=GithubCommunity |
||||
|
maintainer=miguelbalboa |
||||
|
sentence=Arduino RFID Library for MFRC522 (SPI) |
||||
|
paragraph=Read/Write a RFID Card or Tag using the ISO/IEC 14443A/MIFARE interface. |
||||
|
category=Communication |
||||
|
url=https://github.com/miguelbalboa/rfid |
||||
|
architectures=avr,STM32F1,teensy,esp8266 |
||||
1899
Hardware-Plaforms/ESP32-A1S-Audiokit/lib/MFRC522/src/MFRC522.cpp
File diff suppressed because it is too large
View File
File diff suppressed because it is too large
View File
@ -0,0 +1,434 @@ |
|||||
|
/** |
||||
|
* MFRC522.h - Library to use ARDUINO RFID MODULE KIT 13.56 MHZ WITH TAGS SPI W AND R BY COOQROBOT. |
||||
|
* Based on code Dr.Leong ( WWW.B2CQSHOP.COM ) |
||||
|
* Created by Miguel Balboa (circuitito.com), Jan, 2012. |
||||
|
* Rewritten by Søren Thing Andersen (access.thing.dk), fall of 2013 (Translation to English, refactored, comments, anti collision, cascade levels.) |
||||
|
* Extended by Tom Clement with functionality to write to sector 0 of UID changeable Mifare cards. |
||||
|
* Released into the public domain. |
||||
|
* |
||||
|
* Please read this file for an overview and then MFRC522.cpp for comments on the specific functions. |
||||
|
* Search for "mf-rc522" on ebay.com to purchase the MF-RC522 board. |
||||
|
* |
||||
|
* There are three hardware components involved: |
||||
|
* 1) The micro controller: An Arduino |
||||
|
* 2) The PCD (short for Proximity Coupling Device): NXP MFRC522 Contactless Reader IC |
||||
|
* 3) The PICC (short for Proximity Integrated Circuit Card): A card or tag using the ISO 14443A interface, eg Mifare or NTAG203. |
||||
|
* |
||||
|
* The microcontroller and card reader uses SPI for communication. |
||||
|
* The protocol is described in the MFRC522 datasheet: http://www.nxp.com/documents/data_sheet/MFRC522.pdf |
||||
|
* |
||||
|
* The card reader and the tags communicate using a 13.56MHz electromagnetic field. |
||||
|
* The protocol is defined in ISO/IEC 14443-3 Identification cards -- Contactless integrated circuit cards -- Proximity cards -- Part 3: Initialization and anticollision". |
||||
|
* A free version of the final draft can be found at http://wg8.de/wg8n1496_17n3613_Ballot_FCD14443-3.pdf |
||||
|
* Details are found in chapter 6, Type A – Initialization and anticollision. |
||||
|
* |
||||
|
* If only the PICC UID is wanted, the above documents has all the needed information. |
||||
|
* To read and write from MIFARE PICCs, the MIFARE protocol is used after the PICC has been selected. |
||||
|
* The MIFARE Classic chips and protocol is described in the datasheets: |
||||
|
* 1K: http://www.mouser.com/ds/2/302/MF1S503x-89574.pdf |
||||
|
* 4K: http://datasheet.octopart.com/MF1S7035DA4,118-NXP-Semiconductors-datasheet-11046188.pdf |
||||
|
* Mini: http://www.idcardmarket.com/download/mifare_S20_datasheet.pdf |
||||
|
* The MIFARE Ultralight chip and protocol is described in the datasheets: |
||||
|
* Ultralight: http://www.nxp.com/documents/data_sheet/MF0ICU1.pdf |
||||
|
* Ultralight C: http://www.nxp.com/documents/short_data_sheet/MF0ICU2_SDS.pdf |
||||
|
* |
||||
|
* MIFARE Classic 1K (MF1S503x): |
||||
|
* Has 16 sectors * 4 blocks/sector * 16 bytes/block = 1024 bytes. |
||||
|
* The blocks are numbered 0-63. |
||||
|
* Block 3 in each sector is the Sector Trailer. See http://www.mouser.com/ds/2/302/MF1S503x-89574.pdf sections 8.6 and 8.7: |
||||
|
* Bytes 0-5: Key A |
||||
|
* Bytes 6-8: Access Bits |
||||
|
* Bytes 9: User data |
||||
|
* Bytes 10-15: Key B (or user data) |
||||
|
* Block 0 is read-only manufacturer data. |
||||
|
* To access a block, an authentication using a key from the block's sector must be performed first. |
||||
|
* Example: To read from block 10, first authenticate using a key from sector 3 (blocks 8-11). |
||||
|
* All keys are set to FFFFFFFFFFFFh at chip delivery. |
||||
|
* Warning: Please read section 8.7 "Memory Access". It includes this text: if the PICC detects a format violation the whole sector is irreversibly blocked. |
||||
|
* To use a block in "value block" mode (for Increment/Decrement operations) you need to change the sector trailer. Use PICC_SetAccessBits() to calculate the bit patterns. |
||||
|
* MIFARE Classic 4K (MF1S703x): |
||||
|
* Has (32 sectors * 4 blocks/sector + 8 sectors * 16 blocks/sector) * 16 bytes/block = 4096 bytes. |
||||
|
* The blocks are numbered 0-255. |
||||
|
* The last block in each sector is the Sector Trailer like above. |
||||
|
* MIFARE Classic Mini (MF1 IC S20): |
||||
|
* Has 5 sectors * 4 blocks/sector * 16 bytes/block = 320 bytes. |
||||
|
* The blocks are numbered 0-19. |
||||
|
* The last block in each sector is the Sector Trailer like above. |
||||
|
* |
||||
|
* MIFARE Ultralight (MF0ICU1): |
||||
|
* Has 16 pages of 4 bytes = 64 bytes. |
||||
|
* Pages 0 + 1 is used for the 7-byte UID. |
||||
|
* Page 2 contains the last check digit for the UID, one byte manufacturer internal data, and the lock bytes (see http://www.nxp.com/documents/data_sheet/MF0ICU1.pdf section 8.5.2) |
||||
|
* Page 3 is OTP, One Time Programmable bits. Once set to 1 they cannot revert to 0. |
||||
|
* Pages 4-15 are read/write unless blocked by the lock bytes in page 2. |
||||
|
* MIFARE Ultralight C (MF0ICU2): |
||||
|
* Has 48 pages of 4 bytes = 192 bytes. |
||||
|
* Pages 0 + 1 is used for the 7-byte UID. |
||||
|
* Page 2 contains the last check digit for the UID, one byte manufacturer internal data, and the lock bytes (see http://www.nxp.com/documents/data_sheet/MF0ICU1.pdf section 8.5.2) |
||||
|
* Page 3 is OTP, One Time Programmable bits. Once set to 1 they cannot revert to 0. |
||||
|
* Pages 4-39 are read/write unless blocked by the lock bytes in page 2. |
||||
|
* Page 40 Lock bytes |
||||
|
* Page 41 16 bit one way counter |
||||
|
* Pages 42-43 Authentication configuration |
||||
|
* Pages 44-47 Authentication key |
||||
|
*/ |
||||
|
#ifndef MFRC522_h |
||||
|
#define MFRC522_h |
||||
|
|
||||
|
#include "require_cpp11.h" |
||||
|
#include "deprecated.h" |
||||
|
// Enable integer limits |
||||
|
#define __STDC_LIMIT_MACROS |
||||
|
#include <stdint.h> |
||||
|
#include <Arduino.h> |
||||
|
#include <SPI.h> |
||||
|
|
||||
|
#define MFRC522_SPICLOCK SPI_CLOCK_DIV4 // MFRC522 accept upto 10MHz |
||||
|
|
||||
|
// Firmware data for self-test |
||||
|
// Reference values based on firmware version |
||||
|
// Hint: if needed, you can remove unused self-test data to save flash memory |
||||
|
// |
||||
|
// Version 0.0 (0x90) |
||||
|
// Philips Semiconductors; Preliminary Specification Revision 2.0 - 01 August 2005; 16.1 self-test |
||||
|
const byte MFRC522_firmware_referenceV0_0[] PROGMEM = { |
||||
|
0x00, 0x87, 0x98, 0x0f, 0x49, 0xFF, 0x07, 0x19, |
||||
|
0xBF, 0x22, 0x30, 0x49, 0x59, 0x63, 0xAD, 0xCA, |
||||
|
0x7F, 0xE3, 0x4E, 0x03, 0x5C, 0x4E, 0x49, 0x50, |
||||
|
0x47, 0x9A, 0x37, 0x61, 0xE7, 0xE2, 0xC6, 0x2E, |
||||
|
0x75, 0x5A, 0xED, 0x04, 0x3D, 0x02, 0x4B, 0x78, |
||||
|
0x32, 0xFF, 0x58, 0x3B, 0x7C, 0xE9, 0x00, 0x94, |
||||
|
0xB4, 0x4A, 0x59, 0x5B, 0xFD, 0xC9, 0x29, 0xDF, |
||||
|
0x35, 0x96, 0x98, 0x9E, 0x4F, 0x30, 0x32, 0x8D |
||||
|
}; |
||||
|
// Version 1.0 (0x91) |
||||
|
// NXP Semiconductors; Rev. 3.8 - 17 September 2014; 16.1.1 self-test |
||||
|
const byte MFRC522_firmware_referenceV1_0[] PROGMEM = { |
||||
|
0x00, 0xC6, 0x37, 0xD5, 0x32, 0xB7, 0x57, 0x5C, |
||||
|
0xC2, 0xD8, 0x7C, 0x4D, 0xD9, 0x70, 0xC7, 0x73, |
||||
|
0x10, 0xE6, 0xD2, 0xAA, 0x5E, 0xA1, 0x3E, 0x5A, |
||||
|
0x14, 0xAF, 0x30, 0x61, 0xC9, 0x70, 0xDB, 0x2E, |
||||
|
0x64, 0x22, 0x72, 0xB5, 0xBD, 0x65, 0xF4, 0xEC, |
||||
|
0x22, 0xBC, 0xD3, 0x72, 0x35, 0xCD, 0xAA, 0x41, |
||||
|
0x1F, 0xA7, 0xF3, 0x53, 0x14, 0xDE, 0x7E, 0x02, |
||||
|
0xD9, 0x0F, 0xB5, 0x5E, 0x25, 0x1D, 0x29, 0x79 |
||||
|
}; |
||||
|
// Version 2.0 (0x92) |
||||
|
// NXP Semiconductors; Rev. 3.8 - 17 September 2014; 16.1.1 self-test |
||||
|
const byte MFRC522_firmware_referenceV2_0[] PROGMEM = { |
||||
|
0x00, 0xEB, 0x66, 0xBA, 0x57, 0xBF, 0x23, 0x95, |
||||
|
0xD0, 0xE3, 0x0D, 0x3D, 0x27, 0x89, 0x5C, 0xDE, |
||||
|
0x9D, 0x3B, 0xA7, 0x00, 0x21, 0x5B, 0x89, 0x82, |
||||
|
0x51, 0x3A, 0xEB, 0x02, 0x0C, 0xA5, 0x00, 0x49, |
||||
|
0x7C, 0x84, 0x4D, 0xB3, 0xCC, 0xD2, 0x1B, 0x81, |
||||
|
0x5D, 0x48, 0x76, 0xD5, 0x71, 0x61, 0x21, 0xA9, |
||||
|
0x86, 0x96, 0x83, 0x38, 0xCF, 0x9D, 0x5B, 0x6D, |
||||
|
0xDC, 0x15, 0xBA, 0x3E, 0x7D, 0x95, 0x3B, 0x2F |
||||
|
}; |
||||
|
// Clone |
||||
|
// Fudan Semiconductor FM17522 (0x88) |
||||
|
const byte FM17522_firmware_reference[] PROGMEM = { |
||||
|
0x00, 0xD6, 0x78, 0x8C, 0xE2, 0xAA, 0x0C, 0x18, |
||||
|
0x2A, 0xB8, 0x7A, 0x7F, 0xD3, 0x6A, 0xCF, 0x0B, |
||||
|
0xB1, 0x37, 0x63, 0x4B, 0x69, 0xAE, 0x91, 0xC7, |
||||
|
0xC3, 0x97, 0xAE, 0x77, 0xF4, 0x37, 0xD7, 0x9B, |
||||
|
0x7C, 0xF5, 0x3C, 0x11, 0x8F, 0x15, 0xC3, 0xD7, |
||||
|
0xC1, 0x5B, 0x00, 0x2A, 0xD0, 0x75, 0xDE, 0x9E, |
||||
|
0x51, 0x64, 0xAB, 0x3E, 0xE9, 0x15, 0xB5, 0xAB, |
||||
|
0x56, 0x9A, 0x98, 0x82, 0x26, 0xEA, 0x2A, 0x62 |
||||
|
}; |
||||
|
|
||||
|
class MFRC522 { |
||||
|
public: |
||||
|
// Size of the MFRC522 FIFO |
||||
|
static const byte FIFO_SIZE = 64; // The FIFO is 64 bytes. |
||||
|
// Default value for unused pin |
||||
|
static constexpr uint8_t UNUSED_PIN = UINT8_MAX; |
||||
|
|
||||
|
// MFRC522 registers. Described in chapter 9 of the datasheet. |
||||
|
// When using SPI all addresses are shifted one bit left in the "SPI address byte" (section 8.1.2.3) |
||||
|
enum PCD_Register : byte { |
||||
|
// Page 0: Command and status |
||||
|
// 0x00 // reserved for future use |
||||
|
CommandReg = 0x01 << 1, // starts and stops command execution |
||||
|
ComIEnReg = 0x02 << 1, // enable and disable interrupt request control bits |
||||
|
DivIEnReg = 0x03 << 1, // enable and disable interrupt request control bits |
||||
|
ComIrqReg = 0x04 << 1, // interrupt request bits |
||||
|
DivIrqReg = 0x05 << 1, // interrupt request bits |
||||
|
ErrorReg = 0x06 << 1, // error bits showing the error status of the last command executed |
||||
|
Status1Reg = 0x07 << 1, // communication status bits |
||||
|
Status2Reg = 0x08 << 1, // receiver and transmitter status bits |
||||
|
FIFODataReg = 0x09 << 1, // input and output of 64 byte FIFO buffer |
||||
|
FIFOLevelReg = 0x0A << 1, // number of bytes stored in the FIFO buffer |
||||
|
WaterLevelReg = 0x0B << 1, // level for FIFO underflow and overflow warning |
||||
|
ControlReg = 0x0C << 1, // miscellaneous control registers |
||||
|
BitFramingReg = 0x0D << 1, // adjustments for bit-oriented frames |
||||
|
CollReg = 0x0E << 1, // bit position of the first bit-collision detected on the RF interface |
||||
|
// 0x0F // reserved for future use |
||||
|
Powerdown = 0x02, |
||||
|
// Page 1: Command |
||||
|
// 0x10 // reserved for future use |
||||
|
ModeReg = 0x11 << 1, // defines general modes for transmitting and receiving |
||||
|
TxModeReg = 0x12 << 1, // defines transmission data rate and framing |
||||
|
RxModeReg = 0x13 << 1, // defines reception data rate and framing |
||||
|
TxControlReg = 0x14 << 1, // controls the logical behavior of the antenna driver pins TX1 and TX2 |
||||
|
TxASKReg = 0x15 << 1, // controls the setting of the transmission modulation |
||||
|
TxSelReg = 0x16 << 1, // selects the internal sources for the antenna driver |
||||
|
RxSelReg = 0x17 << 1, // selects internal receiver settings |
||||
|
RxThresholdReg = 0x18 << 1, // selects thresholds for the bit decoder |
||||
|
DemodReg = 0x19 << 1, // defines demodulator settings |
||||
|
// 0x1A // reserved for future use |
||||
|
// 0x1B // reserved for future use |
||||
|
MfTxReg = 0x1C << 1, // controls some MIFARE communication transmit parameters |
||||
|
MfRxReg = 0x1D << 1, // controls some MIFARE communication receive parameters |
||||
|
// 0x1E // reserved for future use |
||||
|
SerialSpeedReg = 0x1F << 1, // selects the speed of the serial UART interface |
||||
|
|
||||
|
// Page 2: Configuration |
||||
|
// 0x20 // reserved for future use |
||||
|
CRCResultRegH = 0x21 << 1, // shows the MSB and LSB values of the CRC calculation |
||||
|
CRCResultRegL = 0x22 << 1, |
||||
|
// 0x23 // reserved for future use |
||||
|
ModWidthReg = 0x24 << 1, // controls the ModWidth setting? |
||||
|
// 0x25 // reserved for future use |
||||
|
RFCfgReg = 0x26 << 1, // configures the receiver gain |
||||
|
GsNReg = 0x27 << 1, // selects the conductance of the antenna driver pins TX1 and TX2 for modulation |
||||
|
CWGsPReg = 0x28 << 1, // defines the conductance of the p-driver output during periods of no modulation |
||||
|
ModGsPReg = 0x29 << 1, // defines the conductance of the p-driver output during periods of modulation |
||||
|
TModeReg = 0x2A << 1, // defines settings for the internal timer |
||||
|
TPrescalerReg = 0x2B << 1, // the lower 8 bits of the TPrescaler value. The 4 high bits are in TModeReg. |
||||
|
TReloadRegH = 0x2C << 1, // defines the 16-bit timer reload value |
||||
|
TReloadRegL = 0x2D << 1, |
||||
|
TCounterValueRegH = 0x2E << 1, // shows the 16-bit timer value |
||||
|
TCounterValueRegL = 0x2F << 1, |
||||
|
|
||||
|
// Page 3: Test Registers |
||||
|
// 0x30 // reserved for future use |
||||
|
TestSel1Reg = 0x31 << 1, // general test signal configuration |
||||
|
TestSel2Reg = 0x32 << 1, // general test signal configuration |
||||
|
TestPinEnReg = 0x33 << 1, // enables pin output driver on pins D1 to D7 |
||||
|
TestPinValueReg = 0x34 << 1, // defines the values for D1 to D7 when it is used as an I/O bus |
||||
|
TestBusReg = 0x35 << 1, // shows the status of the internal test bus |
||||
|
AutoTestReg = 0x36 << 1, // controls the digital self-test |
||||
|
VersionReg = 0x37 << 1, // shows the software version |
||||
|
AnalogTestReg = 0x38 << 1, // controls the pins AUX1 and AUX2 |
||||
|
TestDAC1Reg = 0x39 << 1, // defines the test value for TestDAC1 |
||||
|
TestDAC2Reg = 0x3A << 1, // defines the test value for TestDAC2 |
||||
|
TestADCReg = 0x3B << 1 // shows the value of ADC I and Q channels |
||||
|
// 0x3C // reserved for production tests |
||||
|
// 0x3D // reserved for production tests |
||||
|
// 0x3E // reserved for production tests |
||||
|
// 0x3F // reserved for production tests |
||||
|
}; |
||||
|
|
||||
|
// MFRC522 commands. Described in chapter 10 of the datasheet. |
||||
|
enum PCD_Command : byte { |
||||
|
PCD_Idle = 0x00, // no action, cancels current command execution |
||||
|
PCD_Mem = 0x01, // stores 25 bytes into the internal buffer |
||||
|
PCD_GenerateRandomID = 0x02, // generates a 10-byte random ID number |
||||
|
PCD_CalcCRC = 0x03, // activates the CRC coprocessor or performs a self-test |
||||
|
PCD_Transmit = 0x04, // transmits data from the FIFO buffer |
||||
|
PCD_NoCmdChange = 0x07, // no command change, can be used to modify the CommandReg register bits without affecting the command, for example, the PowerDown bit |
||||
|
PCD_Receive = 0x08, // activates the receiver circuits |
||||
|
PCD_Transceive = 0x0C, // transmits data from FIFO buffer to antenna and automatically activates the receiver after transmission |
||||
|
PCD_MFAuthent = 0x0E, // performs the MIFARE standard authentication as a reader |
||||
|
PCD_SoftReset = 0x0F // resets the MFRC522 |
||||
|
}; |
||||
|
|
||||
|
// MFRC522 RxGain[2:0] masks, defines the receiver's signal voltage gain factor (on the PCD). |
||||
|
// Described in 9.3.3.6 / table 98 of the datasheet at http://www.nxp.com/documents/data_sheet/MFRC522.pdf |
||||
|
enum PCD_RxGain : byte { |
||||
|
RxGain_18dB = 0x00 << 4, // 000b - 18 dB, minimum |
||||
|
RxGain_23dB = 0x01 << 4, // 001b - 23 dB |
||||
|
RxGain_18dB_2 = 0x02 << 4, // 010b - 18 dB, it seems 010b is a duplicate for 000b |
||||
|
RxGain_23dB_2 = 0x03 << 4, // 011b - 23 dB, it seems 011b is a duplicate for 001b |
||||
|
RxGain_33dB = 0x04 << 4, // 100b - 33 dB, average, and typical default |
||||
|
RxGain_38dB = 0x05 << 4, // 101b - 38 dB |
||||
|
RxGain_43dB = 0x06 << 4, // 110b - 43 dB |
||||
|
RxGain_48dB = 0x07 << 4, // 111b - 48 dB, maximum |
||||
|
RxGain_min = 0x00 << 4, // 000b - 18 dB, minimum, convenience for RxGain_18dB |
||||
|
RxGain_avg = 0x04 << 4, // 100b - 33 dB, average, convenience for RxGain_33dB |
||||
|
RxGain_max = 0x07 << 4 // 111b - 48 dB, maximum, convenience for RxGain_48dB |
||||
|
}; |
||||
|
|
||||
|
// Commands sent to the PICC. |
||||
|
enum PICC_Command : byte { |
||||
|
// The commands used by the PCD to manage communication with several PICCs (ISO 14443-3, Type A, section 6.4) |
||||
|
PICC_CMD_REQA = 0x26, // REQuest command, Type A. Invites PICCs in state IDLE to go to READY and prepare for anticollision or selection. 7 bit frame. |
||||
|
PICC_CMD_WUPA = 0x52, // Wake-UP command, Type A. Invites PICCs in state IDLE and HALT to go to READY(*) and prepare for anticollision or selection. 7 bit frame. |
||||
|
PICC_CMD_CT = 0x88, // Cascade Tag. Not really a command, but used during anti collision. |
||||
|
PICC_CMD_SEL_CL1 = 0x93, // Anti collision/Select, Cascade Level 1 |
||||
|
PICC_CMD_SEL_CL2 = 0x95, // Anti collision/Select, Cascade Level 2 |
||||
|
PICC_CMD_SEL_CL3 = 0x97, // Anti collision/Select, Cascade Level 3 |
||||
|
PICC_CMD_HLTA = 0x50, // HaLT command, Type A. Instructs an ACTIVE PICC to go to state HALT. |
||||
|
PICC_CMD_RATS = 0xE0, // Request command for Answer To Reset. |
||||
|
// The commands used for MIFARE Classic (from http://www.mouser.com/ds/2/302/MF1S503x-89574.pdf, Section 9) |
||||
|
// Use PCD_MFAuthent to authenticate access to a sector, then use these commands to read/write/modify the blocks on the sector. |
||||
|
// The read/write commands can also be used for MIFARE Ultralight. |
||||
|
PICC_CMD_MF_AUTH_KEY_A = 0x60, // Perform authentication with Key A |
||||
|
PICC_CMD_MF_AUTH_KEY_B = 0x61, // Perform authentication with Key B |
||||
|
PICC_CMD_MF_READ = 0x30, // Reads one 16 byte block from the authenticated sector of the PICC. Also used for MIFARE Ultralight. |
||||
|
PICC_CMD_MF_WRITE = 0xA0, // Writes one 16 byte block to the authenticated sector of the PICC. Called "COMPATIBILITY WRITE" for MIFARE Ultralight. |
||||
|
PICC_CMD_MF_DECREMENT = 0xC0, // Decrements the contents of a block and stores the result in the internal data register. |
||||
|
PICC_CMD_MF_INCREMENT = 0xC1, // Increments the contents of a block and stores the result in the internal data register. |
||||
|
PICC_CMD_MF_RESTORE = 0xC2, // Reads the contents of a block into the internal data register. |
||||
|
PICC_CMD_MF_TRANSFER = 0xB0, // Writes the contents of the internal data register to a block. |
||||
|
// The commands used for MIFARE Ultralight (from http://www.nxp.com/documents/data_sheet/MF0ICU1.pdf, Section 8.6) |
||||
|
// The PICC_CMD_MF_READ and PICC_CMD_MF_WRITE can also be used for MIFARE Ultralight. |
||||
|
PICC_CMD_UL_WRITE = 0xA2 // Writes one 4 byte page to the PICC. |
||||
|
}; |
||||
|
|
||||
|
// MIFARE constants that does not fit anywhere else |
||||
|
enum MIFARE_Misc { |
||||
|
MF_ACK = 0xA, // The MIFARE Classic uses a 4 bit ACK/NAK. Any other value than 0xA is NAK. |
||||
|
MF_KEY_SIZE = 6 // A Mifare Crypto1 key is 6 bytes. |
||||
|
}; |
||||
|
|
||||
|
// PICC types we can detect. Remember to update PICC_GetTypeName() if you add more. |
||||
|
// last value set to 0xff, then compiler uses less ram, it seems some optimisations are triggered |
||||
|
enum PICC_Type : byte { |
||||
|
PICC_TYPE_UNKNOWN , |
||||
|
PICC_TYPE_ISO_14443_4 , // PICC compliant with ISO/IEC 14443-4 |
||||
|
PICC_TYPE_ISO_18092 , // PICC compliant with ISO/IEC 18092 (NFC) |
||||
|
PICC_TYPE_MIFARE_MINI , // MIFARE Classic protocol, 320 bytes |
||||
|
PICC_TYPE_MIFARE_1K , // MIFARE Classic protocol, 1KB |
||||
|
PICC_TYPE_MIFARE_4K , // MIFARE Classic protocol, 4KB |
||||
|
PICC_TYPE_MIFARE_UL , // MIFARE Ultralight or Ultralight C |
||||
|
PICC_TYPE_MIFARE_PLUS , // MIFARE Plus |
||||
|
PICC_TYPE_MIFARE_DESFIRE, // MIFARE DESFire |
||||
|
PICC_TYPE_TNP3XXX , // Only mentioned in NXP AN 10833 MIFARE Type Identification Procedure |
||||
|
PICC_TYPE_NOT_COMPLETE = 0xff // SAK indicates UID is not complete. |
||||
|
}; |
||||
|
|
||||
|
// Return codes from the functions in this class. Remember to update GetStatusCodeName() if you add more. |
||||
|
// last value set to 0xff, then compiler uses less ram, it seems some optimisations are triggered |
||||
|
enum StatusCode : byte { |
||||
|
STATUS_OK , // Success |
||||
|
STATUS_ERROR , // Error in communication |
||||
|
STATUS_COLLISION , // Collission detected |
||||
|
STATUS_TIMEOUT , // Timeout in communication. |
||||
|
STATUS_NO_ROOM , // A buffer is not big enough. |
||||
|
STATUS_INTERNAL_ERROR , // Internal error in the code. Should not happen ;-) |
||||
|
STATUS_INVALID , // Invalid argument. |
||||
|
STATUS_CRC_WRONG , // The CRC_A does not match |
||||
|
STATUS_MIFARE_NACK = 0xff // A MIFARE PICC responded with NAK. |
||||
|
}; |
||||
|
|
||||
|
// A struct used for passing the UID of a PICC. |
||||
|
typedef struct { |
||||
|
byte size; // Number of bytes in the UID. 4, 7 or 10. |
||||
|
byte uidByte[10]; |
||||
|
byte sak; // The SAK (Select acknowledge) byte returned from the PICC after successful selection. |
||||
|
} Uid; |
||||
|
|
||||
|
// A struct used for passing a MIFARE Crypto1 key |
||||
|
typedef struct { |
||||
|
byte keyByte[MF_KEY_SIZE]; |
||||
|
} MIFARE_Key; |
||||
|
|
||||
|
// Member variables |
||||
|
Uid uid; // Used by PICC_ReadCardSerial(). |
||||
|
|
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
// Functions for setting up the Arduino |
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
MFRC522(); |
||||
|
DEPRECATED_MSG("use MFRC522(byte chipSelectPin, byte resetPowerDownPin)") |
||||
|
MFRC522(byte resetPowerDownPin); |
||||
|
MFRC522(byte chipSelectPin, byte resetPowerDownPin); |
||||
|
|
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
// Basic interface functions for communicating with the MFRC522 |
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
void PCD_WriteRegister(PCD_Register reg, byte value); |
||||
|
void PCD_WriteRegister(PCD_Register reg, byte count, byte *values); |
||||
|
byte PCD_ReadRegister(PCD_Register reg); |
||||
|
void PCD_ReadRegister(PCD_Register reg, byte count, byte *values, byte rxAlign = 0); |
||||
|
void PCD_SetRegisterBitMask(PCD_Register reg, byte mask); |
||||
|
void PCD_ClearRegisterBitMask(PCD_Register reg, byte mask); |
||||
|
StatusCode PCD_CalculateCRC(byte *data, byte length, byte *result); |
||||
|
|
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
// Functions for manipulating the MFRC522 |
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
void PCD_Init(); |
||||
|
DEPRECATED_MSG("use PCD_Init(byte chipSelectPin, byte resetPowerDownPin)") |
||||
|
void PCD_Init(byte resetPowerDownPin); |
||||
|
void PCD_Init(byte chipSelectPin, byte resetPowerDownPin); |
||||
|
void PCD_Reset(); |
||||
|
void PCD_AntennaOn(); |
||||
|
void PCD_AntennaOff(); |
||||
|
byte PCD_GetAntennaGain(); |
||||
|
void PCD_SetAntennaGain(byte mask); |
||||
|
bool PCD_PerformSelfTest(); |
||||
|
|
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
// Functions for communicating with PICCs |
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
StatusCode PCD_TransceiveData(byte *sendData, byte sendLen, byte *backData, byte *backLen, byte *validBits = NULL, byte rxAlign = 0, bool checkCRC = false); |
||||
|
StatusCode PCD_CommunicateWithPICC(byte command, byte waitIRq, byte *sendData, byte sendLen, byte *backData = NULL, byte *backLen = NULL, byte *validBits = NULL, byte rxAlign = 0, bool checkCRC = false); |
||||
|
StatusCode PICC_RequestA(byte *bufferATQA, byte *bufferSize); |
||||
|
StatusCode PICC_WakeupA(byte *bufferATQA, byte *bufferSize); |
||||
|
StatusCode PICC_REQA_or_WUPA(byte command, byte *bufferATQA, byte *bufferSize); |
||||
|
virtual StatusCode PICC_Select(Uid *uid, byte validBits = 0); |
||||
|
StatusCode PICC_HaltA(); |
||||
|
|
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
// Functions for communicating with MIFARE PICCs |
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
StatusCode PCD_Authenticate(byte command, byte blockAddr, MIFARE_Key *key, Uid *uid); |
||||
|
void PCD_StopCrypto1(); |
||||
|
StatusCode MIFARE_Read(byte blockAddr, byte *buffer, byte *bufferSize); |
||||
|
StatusCode MIFARE_Write(byte blockAddr, byte *buffer, byte bufferSize); |
||||
|
StatusCode MIFARE_Ultralight_Write(byte page, byte *buffer, byte bufferSize); |
||||
|
StatusCode MIFARE_Decrement(byte blockAddr, int32_t delta); |
||||
|
StatusCode MIFARE_Increment(byte blockAddr, int32_t delta); |
||||
|
StatusCode MIFARE_Restore(byte blockAddr); |
||||
|
StatusCode MIFARE_Transfer(byte blockAddr); |
||||
|
StatusCode MIFARE_GetValue(byte blockAddr, int32_t *value); |
||||
|
StatusCode MIFARE_SetValue(byte blockAddr, int32_t value); |
||||
|
StatusCode PCD_NTAG216_AUTH(byte *passWord, byte pACK[]); |
||||
|
|
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
// Support functions |
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
StatusCode PCD_MIFARE_Transceive(byte *sendData, byte sendLen, bool acceptTimeout = false); |
||||
|
// old function used too much memory, now name moved to flash; if you need char, copy from flash to memory |
||||
|
//const char *GetStatusCodeName(byte code); |
||||
|
static const __FlashStringHelper *GetStatusCodeName(StatusCode code); |
||||
|
static PICC_Type PICC_GetType(byte sak); |
||||
|
// old function used too much memory, now name moved to flash; if you need char, copy from flash to memory |
||||
|
//const char *PICC_GetTypeName(byte type); |
||||
|
static const __FlashStringHelper *PICC_GetTypeName(PICC_Type type); |
||||
|
|
||||
|
// Support functions for debuging |
||||
|
void PCD_DumpVersionToSerial(); |
||||
|
void PICC_DumpToSerial(Uid *uid); |
||||
|
void PICC_DumpDetailsToSerial(Uid *uid); |
||||
|
void PICC_DumpMifareClassicToSerial(Uid *uid, PICC_Type piccType, MIFARE_Key *key); |
||||
|
void PICC_DumpMifareClassicSectorToSerial(Uid *uid, MIFARE_Key *key, byte sector); |
||||
|
void PICC_DumpMifareUltralightToSerial(); |
||||
|
|
||||
|
// Advanced functions for MIFARE |
||||
|
DEPRECATED_MSG("name will change in next version") |
||||
|
void MIFARE_SetAccessBits(byte *accessBitBuffer, byte g0, byte g1, byte g2, byte g3); |
||||
|
DEPRECATED_MSG("will move to extra class in next version") |
||||
|
bool MIFARE_OpenUidBackdoor(bool logErrors); |
||||
|
DEPRECATED_MSG("will move to extra class in next version") |
||||
|
bool MIFARE_SetUid(byte *newUid, byte uidSize, bool logErrors); |
||||
|
DEPRECATED_MSG("will move to extra class in next version") |
||||
|
bool MIFARE_UnbrickUidSector(bool logErrors); |
||||
|
|
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
// Convenience functions - does not add extra functionality |
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
virtual bool PICC_IsNewCardPresent(); |
||||
|
virtual bool PICC_ReadCardSerial(); |
||||
|
|
||||
|
protected: |
||||
|
byte _chipSelectPin; // Arduino pin connected to MFRC522's SPI slave select input (Pin 24, NSS, active low) |
||||
|
byte _resetPowerDownPin; // Arduino pin connected to MFRC522's reset and power down input (Pin 6, NRSTPD, active low) |
||||
|
StatusCode MIFARE_TwoStepHelper(byte command, byte blockAddr, int32_t data); |
||||
|
}; |
||||
|
|
||||
|
#endif |
||||
1160
Hardware-Plaforms/ESP32-A1S-Audiokit/lib/MFRC522/src/MFRC522Extended.cpp
File diff suppressed because it is too large
View File
File diff suppressed because it is too large
View File
@ -0,0 +1,120 @@ |
|||||
|
/** |
||||
|
* Library extends MFRC522.h to support RATS for ISO-14443-4 PICC. |
||||
|
* RATS - Request for Answer To Select. |
||||
|
* @author JPG-Consulting |
||||
|
*/ |
||||
|
#ifndef MFRC522Extended_h |
||||
|
#define MFRC522Extended_h |
||||
|
|
||||
|
#include <Arduino.h> |
||||
|
#include "MFRC522.h" |
||||
|
|
||||
|
class MFRC522Extended : public MFRC522 { |
||||
|
|
||||
|
public: |
||||
|
// ISO/IEC 14443-4 bit rates |
||||
|
enum TagBitRates : byte { |
||||
|
BITRATE_106KBITS = 0x00, |
||||
|
BITRATE_212KBITS = 0x01, |
||||
|
BITRATE_424KBITS = 0x02, |
||||
|
BITRATE_848KBITS = 0x03 |
||||
|
}; |
||||
|
|
||||
|
// Structure to store ISO/IEC 14443-4 ATS |
||||
|
typedef struct { |
||||
|
byte size; |
||||
|
byte fsc; // Frame size for proximity card |
||||
|
|
||||
|
struct { |
||||
|
bool transmitted; |
||||
|
bool sameD; // Only the same D for both directions supported |
||||
|
TagBitRates ds; // Send D |
||||
|
TagBitRates dr; // Receive D |
||||
|
} ta1; |
||||
|
|
||||
|
struct { |
||||
|
bool transmitted; |
||||
|
byte fwi; // Frame waiting time integer |
||||
|
byte sfgi; // Start-up frame guard time integer |
||||
|
} tb1; |
||||
|
|
||||
|
struct { |
||||
|
bool transmitted; |
||||
|
bool supportsCID; |
||||
|
bool supportsNAD; |
||||
|
} tc1; |
||||
|
|
||||
|
// Raw data from ATS |
||||
|
byte data[FIFO_SIZE - 2]; // ATS cannot be bigger than FSD - 2 bytes (CRC), according to ISO 14443-4 5.2.2 |
||||
|
} Ats; |
||||
|
|
||||
|
// A struct used for passing the PICC information |
||||
|
typedef struct { |
||||
|
uint16_t atqa; |
||||
|
Uid uid; |
||||
|
Ats ats; |
||||
|
|
||||
|
// For Block PCB |
||||
|
bool blockNumber; |
||||
|
} TagInfo; |
||||
|
|
||||
|
// A struct used for passing PCB Block |
||||
|
typedef struct { |
||||
|
struct { |
||||
|
byte pcb; |
||||
|
byte cid; |
||||
|
byte nad; |
||||
|
} prologue; |
||||
|
struct { |
||||
|
byte size; |
||||
|
byte *data; |
||||
|
} inf; |
||||
|
} PcbBlock; |
||||
|
|
||||
|
// Member variables |
||||
|
TagInfo tag; |
||||
|
|
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
// Contructors |
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
MFRC522Extended() : MFRC522() {}; |
||||
|
MFRC522Extended(uint8_t rst) : MFRC522(rst) {}; |
||||
|
MFRC522Extended(uint8_t ss, uint8_t rst) : MFRC522(ss, rst) {}; |
||||
|
|
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
// Functions for communicating with PICCs |
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
StatusCode PICC_Select(Uid *uid, byte validBits = 0) override; // overrride |
||||
|
StatusCode PICC_RequestATS(Ats *ats); |
||||
|
StatusCode PICC_PPS(); // PPS command without bitrate parameter |
||||
|
StatusCode PICC_PPS(TagBitRates sendBitRate, TagBitRates receiveBitRate); // Different D values |
||||
|
|
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
// Functions for communicating with ISO/IEC 14433-4 cards |
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
StatusCode TCL_Transceive(PcbBlock *send, PcbBlock *back); |
||||
|
StatusCode TCL_Transceive(TagInfo * tag, byte *sendData, byte sendLen, byte *backData = NULL, byte *backLen = NULL); |
||||
|
StatusCode TCL_TransceiveRBlock(TagInfo *tag, bool ack, byte *backData = NULL, byte *backLen = NULL); |
||||
|
StatusCode TCL_Deselect(TagInfo *tag); |
||||
|
|
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
// Support functions |
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
static PICC_Type PICC_GetType(TagInfo *tag); |
||||
|
using MFRC522::PICC_GetType;// // make old PICC_GetType(byte sak) available, otherwise would be hidden by PICC_GetType(TagInfo *tag) |
||||
|
|
||||
|
// Support functions for debuging |
||||
|
void PICC_DumpToSerial(TagInfo *tag); |
||||
|
using MFRC522::PICC_DumpToSerial; // make old PICC_DumpToSerial(Uid *uid) available, otherwise would be hidden by PICC_DumpToSerial(TagInfo *tag) |
||||
|
void PICC_DumpDetailsToSerial(TagInfo *tag); |
||||
|
using MFRC522::PICC_DumpDetailsToSerial; // make old PICC_DumpDetailsToSerial(Uid *uid) available, otherwise would be hidden by PICC_DumpDetailsToSerial(TagInfo *tag) |
||||
|
void PICC_DumpISO14443_4(TagInfo *tag); |
||||
|
|
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
// Convenience functions - does not add extra functionality |
||||
|
///////////////////////////////////////////////////////////////////////////////////// |
||||
|
bool PICC_IsNewCardPresent() override; // overrride |
||||
|
bool PICC_ReadCardSerial() override; // overrride |
||||
|
}; |
||||
|
|
||||
|
#endif |
||||
@ -0,0 +1,20 @@ |
|||||
|
/** |
||||
|
* Copyright (c) 2016 by Ludwig Grill (www.rotzbua.de) |
||||
|
* Simple deprecated workaround for Arduino IDE |
||||
|
* IDE 1.6.8 use gcc 4.8 which do not support c++14 [[deprecated]] |
||||
|
* Later versions should support c++14, then use c++14 syntax |
||||
|
*/ |
||||
|
#ifndef DEPRECATED_H |
||||
|
#define DEPRECATED_H |
||||
|
|
||||
|
#ifdef __has_cpp_attribute |
||||
|
#if __has_cpp_attribute(deprecated) |
||||
|
#define DEPRECATED [[deprecated]] |
||||
|
#define DEPRECATED_MSG(msg) [[deprecated(msg)]] |
||||
|
#endif // __has_cpp_attribute(deprecated) |
||||
|
#else |
||||
|
#define DEPRECATED __attribute__((deprecated)) |
||||
|
#define DEPRECATED_MSG(msg) __attribute__((deprecated(msg))) |
||||
|
#endif // __has_cpp_attribute |
||||
|
|
||||
|
#endif // DEPRECATED_H |
||||
@ -0,0 +1,12 @@ |
|||||
|
/** |
||||
|
* Copyright (c) 2016 by Ludwig Grill (www.rotzbua.de) |
||||
|
* Throws error if c++11 is not supported |
||||
|
*/ |
||||
|
#ifndef REQUIRE_CPP11_H |
||||
|
#define REQUIRE_CPP11_H |
||||
|
|
||||
|
#if __cplusplus < 201103L |
||||
|
#error "This library needs at least a C++11 compliant compiler, maybe compiler argument for C++11 support is missing or if you use Arduino IDE upgrade to version >=1.6.6" |
||||
|
#endif |
||||
|
|
||||
|
#endif // REQUIRE_CPP11_H |
||||
Write
Preview
Loading…
Cancel
Save
Reference in new issue