nanoFramework.Iot.Device.Mfrc522 1.2.869

Prefix Reserved
dotnet add package nanoFramework.Iot.Device.Mfrc522 --version 1.2.869
                    
NuGet\Install-Package nanoFramework.Iot.Device.Mfrc522 -Version 1.2.869
                    
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.869" />
                    
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.869" />
                    
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.869
                    
#r "nuget: nanoFramework.Iot.Device.Mfrc522, 1.2.869"
                    
#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.869
                    
Install nanoFramework.Iot.Device.Mfrc522 as a Cake Addin
#tool nuget:?package=nanoFramework.Iot.Device.Mfrc522&version=1.2.869
                    
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.869 158 14 days ago
1.2.864 148 14 days ago
1.2.852 159 a month ago
1.2.842 207 a month ago
1.2.838 93 a month ago
1.2.835 98 2 months ago
1.2.822 100 2 months ago
1.2.790 105 2 months ago
1.2.787 103 2 months ago
1.2.785 103 2 months ago
1.2.775 98 2 months ago
1.2.772 103 2 months ago
1.2.759 99 3 months ago
1.2.755 95 3 months ago
1.2.737 94 3 months ago
1.2.729 90 3 months ago
1.2.704 115 4 months ago
1.2.696 94 4 months ago
1.2.691 108 4 months ago
1.2.673 114 6 months ago
1.2.662 100 6 months ago
1.2.656 131 6 months ago
1.2.635 113 8 months ago
1.2.631 103 8 months ago
1.2.606 84 8 months ago
1.2.595 89 9 months ago
1.2.590 111 9 months ago
1.2.570 121 6/14/2024
1.2.560 129 5/29/2024
1.2.552 127 5/17/2024
1.2.548 122 5/15/2024
1.2.536 146 4/15/2024
1.2.486 160 2/2/2024
1.2.483 115 1/31/2024
1.2.479 119 1/27/2024
1.2.446 276 11/17/2023
1.2.436 148 11/10/2023
1.2.416 139 11/8/2023
1.2.329 242 5/26/2023
1.2.313 185 5/12/2023
1.2.298 180 5/5/2023
1.2.297 186 5/3/2023
1.2.253 318 2/22/2023
1.2.243 282 2/20/2023
1.2.215 356 1/6/2023
1.2.212 340 1/5/2023
1.2.205 320 12/30/2022
1.2.203 330 12/28/2022
1.2.161 389 11/15/2022
1.2.159 382 11/14/2022
1.2.155 384 11/6/2022
1.2.153 414 11/5/2022
1.2.141 448 10/25/2022
1.2.128 435 10/22/2022
1.2.122 488 10/12/2022
1.2.118 457 10/11/2022
1.2.117 437 10/10/2022
1.2.114 425 10/8/2022
1.2.95 468 9/22/2022
1.2.89 454 9/16/2022
1.2.87 519 9/15/2022
1.2.73 451 9/8/2022
1.2.40 462 8/6/2022
1.2.35 444 8/4/2022
1.2.5 494 7/13/2022
1.2.0 384 11/2/2022
1.1.141.41205 473 7/6/2022
1.1.116.8772 493 6/24/2022
1.1.113.2032 486 6/23/2022
1.1.111.5739 483 6/17/2022
1.1.109.32999 476 6/16/2022
1.1.99.36719 484 6/14/2022
1.1.97.17326 486 6/13/2022
1.1.92.53000 485 6/8/2022
1.1.67.25390 490 5/27/2022
1.1.48.19401 478 5/19/2022
1.1.38 508 5/4/2022
1.1.27 496 4/26/2022
1.1.20 489 4/21/2022
1.1.3 496 4/15/2022
1.1.1 496 4/14/2022
1.0.300 498 3/31/2022
1.0.278-preview.125 159 3/25/2022
1.0.278-preview.124 147 3/25/2022
1.0.278-preview.115 136 3/22/2022
1.0.278-preview.111 142 3/19/2022
1.0.278-preview.109 141 3/18/2022
1.0.278-preview.105 153 3/15/2022
1.0.278-preview.104 147 3/15/2022
1.0.278-preview.101 138 3/11/2022
1.0.278-preview.98 143 3/10/2022
1.0.278-preview.97 145 3/8/2022
1.0.278-preview.84 153 2/25/2022
1.0.278-preview.76 151 2/18/2022
1.0.278-preview.70 145 2/11/2022
1.0.278-preview.64 142 2/9/2022
1.0.278-preview.62 149 2/8/2022
1.0.278-preview.61 154 2/5/2022
1.0.278-preview.59 160 2/4/2022
1.0.278-preview.52 164 1/31/2022
1.0.278-preview.40 161 1/28/2022
1.0.278-preview.31 158 1/27/2022
1.0.278-preview.29 159 1/27/2022
1.0.278-preview.16 164 1/24/2022
1.0.278-preview.14 157 1/21/2022
1.0.278-preview.12 162 1/21/2022
1.0.278-preview.1 161 1/14/2022
1.0.272 196 1/10/2022
1.0.259 364 12/9/2021
1.0.221 196 10/19/2021
1.0.219 199 10/19/2021
1.0.218 228 10/18/2021
1.0.217 231 10/16/2021
1.0.209 218 10/12/2021
1.0.194 234 10/1/2021
1.0.193 200 9/30/2021
1.0.191 202 9/29/2021
1.0.146 206 7/22/2021
1.0.140 207 7/20/2021
1.0.138 228 7/18/2021