nanoFramework.Iot.Device.Mfrc522 1.2.883

Prefix Reserved
dotnet add package nanoFramework.Iot.Device.Mfrc522 --version 1.2.883
                    
NuGet\Install-Package nanoFramework.Iot.Device.Mfrc522 -Version 1.2.883
                    
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.883" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="nanoFramework.Iot.Device.Mfrc522" Version="1.2.883" />
                    
Directory.Packages.props
<PackageReference Include="nanoFramework.Iot.Device.Mfrc522" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add nanoFramework.Iot.Device.Mfrc522 --version 1.2.883
                    
#r "nuget: nanoFramework.Iot.Device.Mfrc522, 1.2.883"
                    
#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.
#addin nuget:?package=nanoFramework.Iot.Device.Mfrc522&version=1.2.883
                    
Install nanoFramework.Iot.Device.Mfrc522 as a Cake Addin
#tool nuget:?package=nanoFramework.Iot.Device.Mfrc522&version=1.2.883
                    
Install nanoFramework.Iot.Device.Mfrc522 as a Cake Tool

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.883 163 4/28/2025
1.2.880 157 4/24/2025
1.2.869 183 4/2/2025
1.2.864 165 4/2/2025
1.2.852 175 3/11/2025
1.2.842 222 3/5/2025
1.2.838 108 3/3/2025
1.2.835 113 2/27/2025
1.2.822 118 2/26/2025
1.2.790 120 2/5/2025
1.2.787 119 2/4/2025
1.2.785 118 2/4/2025
1.2.775 113 2/4/2025
1.2.772 118 2/4/2025
1.2.759 116 1/31/2025
1.2.755 109 1/31/2025
1.2.737 107 1/13/2025
1.2.729 103 1/8/2025
1.2.704 127 12/18/2024
1.2.696 106 12/16/2024
1.2.691 122 12/11/2024
1.2.673 126 10/23/2024
1.2.662 112 10/11/2024
1.2.656 145 10/3/2024
1.2.635 125 8/30/2024
1.2.631 117 8/28/2024
1.2.606 96 8/2/2024
1.2.595 101 7/24/2024
1.2.590 123 7/17/2024
1.2.570 133 6/14/2024
1.2.560 142 5/29/2024
1.2.552 140 5/17/2024
1.2.548 134 5/15/2024
1.2.536 157 4/15/2024
1.2.486 171 2/2/2024
1.2.483 126 1/31/2024
1.2.479 130 1/27/2024
1.2.446 281 11/17/2023
1.2.436 152 11/10/2023
1.2.416 148 11/8/2023
1.2.329 252 5/26/2023
1.2.313 197 5/12/2023
1.2.298 192 5/5/2023
1.2.297 199 5/3/2023
1.2.253 331 2/22/2023
1.2.243 293 2/20/2023
1.2.215 369 1/6/2023
1.2.212 352 1/5/2023
1.2.205 331 12/30/2022
1.2.203 342 12/28/2022
1.2.161 400 11/15/2022
1.2.159 393 11/14/2022
1.2.155 395 11/6/2022
1.2.153 427 11/5/2022
1.2.141 460 10/25/2022
1.2.128 446 10/22/2022
1.2.122 500 10/12/2022
1.2.118 468 10/11/2022
1.2.117 448 10/10/2022
1.2.114 437 10/8/2022
1.2.95 480 9/22/2022
1.2.89 466 9/16/2022
1.2.87 532 9/15/2022
1.2.73 462 9/8/2022
1.2.40 474 8/6/2022
1.2.35 457 8/4/2022
1.2.5 507 7/13/2022
1.2.0 395 11/2/2022
1.1.141.41205 487 7/6/2022
1.1.116.8772 506 6/24/2022
1.1.113.2032 500 6/23/2022
1.1.111.5739 497 6/17/2022
1.1.109.32999 489 6/16/2022
1.1.99.36719 497 6/14/2022
1.1.97.17326 500 6/13/2022
1.1.92.53000 498 6/8/2022
1.1.67.25390 503 5/27/2022
1.1.48.19401 491 5/19/2022
1.1.38 522 5/4/2022
1.1.27 510 4/26/2022
1.1.20 504 4/21/2022
1.1.3 511 4/15/2022
1.1.1 511 4/14/2022
1.0.300 514 3/31/2022
1.0.278-preview.125 175 3/25/2022
1.0.278-preview.124 161 3/25/2022
1.0.278-preview.115 152 3/22/2022
1.0.278-preview.111 157 3/19/2022
1.0.278-preview.109 157 3/18/2022
1.0.278-preview.105 168 3/15/2022
1.0.278-preview.104 162 3/15/2022
1.0.278-preview.101 153 3/11/2022
1.0.278-preview.98 158 3/10/2022
1.0.278-preview.97 160 3/8/2022
1.0.278-preview.84 169 2/25/2022
1.0.278-preview.76 167 2/18/2022
1.0.278-preview.70 161 2/11/2022
1.0.278-preview.64 158 2/9/2022
1.0.278-preview.62 165 2/8/2022
1.0.278-preview.61 171 2/5/2022
1.0.278-preview.59 176 2/4/2022
1.0.278-preview.52 182 1/31/2022
1.0.278-preview.40 178 1/28/2022
1.0.278-preview.31 175 1/27/2022
1.0.278-preview.29 176 1/27/2022
1.0.278-preview.16 180 1/24/2022
1.0.278-preview.14 173 1/21/2022
1.0.278-preview.12 178 1/21/2022
1.0.278-preview.1 178 1/14/2022
1.0.272 213 1/10/2022
1.0.259 381 12/9/2021
1.0.221 213 10/19/2021
1.0.219 216 10/19/2021
1.0.218 245 10/18/2021
1.0.217 248 10/16/2021
1.0.209 236 10/12/2021
1.0.194 252 10/1/2021
1.0.193 218 9/30/2021
1.0.191 219 9/29/2021
1.0.146 223 7/22/2021
1.0.140 225 7/20/2021
1.0.138 245 7/18/2021