nanoFramework.Iot.Device.Mfrc522 1.2.691

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package nanoFramework.Iot.Device.Mfrc522 --version 1.2.691                
NuGet\Install-Package nanoFramework.Iot.Device.Mfrc522 -Version 1.2.691                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="nanoFramework.Iot.Device.Mfrc522" Version="1.2.691" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add nanoFramework.Iot.Device.Mfrc522 --version 1.2.691                
#r "nuget: nanoFramework.Iot.Device.Mfrc522, 1.2.691"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install nanoFramework.Iot.Device.Mfrc522 as a Cake Addin
#addin nuget:?package=nanoFramework.Iot.Device.Mfrc522&version=1.2.691

// Install nanoFramework.Iot.Device.Mfrc522 as a Cake Tool
#tool nuget:?package=nanoFramework.Iot.Device.Mfrc522&version=1.2.691                

MFRC522 - RFID reader

MFRC522 is a very cheap RFID/NFC reader for Iso 14443 Type A cards. Part of those cars are the Mifare and Ultralight family. This reader implement the proprietary Mifare cryptography protocol and can be used transparently.

Documentation

Usage

MFRC522 supports SPI, I2C and UART (Serial Port). You can create the reader with any of those protocols.

Note: most of the popular boards you'll buy are SPI only. This documentation will focus on SPI. You have in the samples more information on how to setup I2C and UART.

GpioController gpioController = new GpioController();
// adjust the GPIO used for the hard reset
int pinReset = 21;

// Default on ESP32:
// GPIO23 = MOSI; GPIO25 = MISO; GPIO19 = Clock

// Uncomment for SPI
SpiConnectionSettings connection = new(1, 22);
// Here you can use as well MfRc522.MaximumSpiClockFrequency which is 10_000_000
// Anything lower will work as well
connection.ClockFrequency = 5_000_000;
SpiDevice spi = SpiDevice.Create(connection);
MfRc522 mfrc522 = new(spi, pinReset, gpioController, false);

The code will create an instance of MFRC522 and will use the pin GPIO21 as the hardware rest pin and will create an GpioController automatically from the default driver. Check the detailed [samples] for more elements. More detailed examples shows how to use other type or cards.

You can get the version using the Version property.

Debug.WriteLine($"Version: {mfrc522.Version}, version should be 1 or 2. Some clones may appear with version 0");

Keep in mind that having a version which is 0.0 doesn't necessary means that your reader is not working properly, if you bought a cheap copy of an original MFRC522, the internal version may not be recognized.

MFRC522 only supports ISO 14443 Type A. You can pull a card like this:

bool res;
Data106kbpsTypeA card;
do
{
    res = mfrc522.ListenToCardIso14443TypeA(out card, TimeSpan.FromSeconds(2));
    Thread.Sleep(res ? 0 : 200);
}
while (!res);

As soon as a card will be detected, it will get out a Data106kbpsTypeA class which is a card. You will have the Unique Identifier from the card as well as the rest of the elements to help identifying it.

You can then create a Mifare card and fo operation on it:

var mifare = new MifareCard(mfrc522, 0);
mifare.SerialNumber = card.NfcId;
mifare.Capacity = MifareCardCapacity.Mifare1K;
mifare.KeyA = MifareCard.DefaultKeyA;
mifare.KeyB = MifareCard.DefaultKeyB;

mifare.BlockNumber = 0;
mifare.Command = MifareCardCommand.AuthenticationB;
ret = mifare.RunMifareCardCommand();
if (ret < 0)
{
    mifare.ReselectCard();
    Debug.WriteLine($"Error reading bloc: {mifare.BlockNumber}");
}
else
{
    mifare.Command = MifareCardCommand.Read16Bytes;
    ret = mifare.RunMifareCardCommand();
    if (ret >= 0)
    {
        if (mifare.Data is object)
        {
            Debug.WriteLine($"Bloc: {mifare.BlockNumber}, Data: {BitConverter.ToString(mifare.Data)}");
        }
    }
    else
    {
        mifare.ReselectCard();
        Debug.WriteLine($"Error reading bloc: {mifare.BlockNumber}");
    }
}

Important: you have to do the ReselectCard() operation every time you have a failure in reading or authentication. By default the card will stop responding. This behavior is wanted by design to make is longer to brute force the authentication mechanism. The samples shows a way how to find a key from known keys for NDEF scenarios for example. Note that the sample is not fully optimize, it is to help understanding what as the mechanism behind.

Other notes

  • The SPI implementation has been deeply tested.
  • The I2C and UART has been barely tested due to lack of hardware support. So please open issues if you have any issue.
  • When using I2C, the address can be setup using the hardware pin, it's the reason why there is no default address.
  • If you are using UART, it is more than strongly recommended to use as high as possible serial baud transfer.
Product Compatible and additional computed target framework versions.
.NET Framework net is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.704 80 12/18/2024
1.2.696 69 12/16/2024
1.2.691 87 12/11/2024
1.2.673 98 10/23/2024
1.2.662 88 10/11/2024
1.2.656 109 10/3/2024
1.2.635 100 8/30/2024
1.2.631 91 8/28/2024
1.2.606 73 8/2/2024
1.2.595 78 7/24/2024
1.2.590 101 7/17/2024
1.2.570 109 6/14/2024
1.2.560 116 5/29/2024
1.2.552 116 5/17/2024
1.2.548 113 5/15/2024
1.2.536 134 4/15/2024
1.2.486 150 2/2/2024
1.2.483 105 1/31/2024
1.2.479 109 1/27/2024
1.2.446 270 11/17/2023
1.2.436 141 11/10/2023
1.2.416 130 11/8/2023
1.2.329 236 5/26/2023
1.2.313 176 5/12/2023
1.2.298 166 5/5/2023
1.2.297 176 5/3/2023
1.2.253 308 2/22/2023
1.2.243 272 2/20/2023
1.2.215 344 1/6/2023
1.2.212 328 1/5/2023
1.2.205 308 12/30/2022
1.2.203 318 12/28/2022
1.2.161 376 11/15/2022
1.2.159 369 11/14/2022
1.2.155 369 11/6/2022
1.2.153 401 11/5/2022
1.2.141 434 10/25/2022
1.2.128 420 10/22/2022
1.2.122 473 10/12/2022
1.2.118 443 10/11/2022
1.2.117 423 10/10/2022
1.2.114 411 10/8/2022
1.2.95 453 9/22/2022
1.2.89 439 9/16/2022
1.2.87 504 9/15/2022
1.2.73 435 9/8/2022
1.2.40 446 8/6/2022
1.2.35 428 8/4/2022
1.2.5 479 7/13/2022
1.2.0 371 11/2/2022
1.1.141.41205 457 7/6/2022
1.1.116.8772 478 6/24/2022
1.1.113.2032 471 6/23/2022
1.1.111.5739 467 6/17/2022
1.1.109.32999 460 6/16/2022
1.1.99.36719 469 6/14/2022
1.1.97.17326 470 6/13/2022
1.1.92.53000 469 6/8/2022
1.1.67.25390 474 5/27/2022
1.1.48.19401 461 5/19/2022
1.1.38 491 5/4/2022
1.1.27 479 4/26/2022
1.1.20 471 4/21/2022
1.1.3 478 4/15/2022
1.1.1 477 4/14/2022
1.0.300 479 3/31/2022
1.0.278-preview.125 142 3/25/2022
1.0.278-preview.124 129 3/25/2022
1.0.278-preview.115 117 3/22/2022
1.0.278-preview.111 124 3/19/2022
1.0.278-preview.109 123 3/18/2022
1.0.278-preview.105 135 3/15/2022
1.0.278-preview.104 129 3/15/2022
1.0.278-preview.101 121 3/11/2022
1.0.278-preview.98 126 3/10/2022
1.0.278-preview.97 129 3/8/2022
1.0.278-preview.84 135 2/25/2022
1.0.278-preview.76 129 2/18/2022
1.0.278-preview.70 125 2/11/2022
1.0.278-preview.64 122 2/9/2022
1.0.278-preview.62 129 2/8/2022
1.0.278-preview.61 137 2/5/2022
1.0.278-preview.59 143 2/4/2022
1.0.278-preview.52 147 1/31/2022
1.0.278-preview.40 144 1/28/2022
1.0.278-preview.31 141 1/27/2022
1.0.278-preview.29 143 1/27/2022
1.0.278-preview.16 147 1/24/2022
1.0.278-preview.14 140 1/21/2022
1.0.278-preview.12 145 1/21/2022
1.0.278-preview.1 144 1/14/2022
1.0.272 178 1/10/2022
1.0.259 347 12/9/2021
1.0.221 176 10/19/2021
1.0.219 181 10/19/2021
1.0.218 210 10/18/2021
1.0.217 211 10/16/2021
1.0.209 200 10/12/2021
1.0.194 216 10/1/2021
1.0.193 182 9/30/2021
1.0.191 183 9/29/2021
1.0.146 189 7/22/2021
1.0.140 190 7/20/2021
1.0.138 210 7/18/2021