Merge branch 'miguelbalboa:master' into master

.github/dependabot.yml

@@ -0,0 +1,19 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "monthly"
+      timezone: "Europe/Berlin"
+      time: "05:00"
+    labels:
+      - "github-actions-dependencies"
+    groups:
+      github-actions:
+        patterns:
+          - "*"

.github/workflows/autoreview.yml

@@ -5,7 +5,7 @@ jobs:
   misspellcheck:
     runs-on: ubuntu-20.04
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Run misspell with reviewdog
       uses: reviewdog/action-misspell@v1
       #with:

.github/workflows/test.platformio.yml

@@ -31,20 +31,20 @@ jobs:
         #    example: AccessControl
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Cache pip
-      uses: actions/cache@v2
+      uses: actions/cache@v4
       with:
         path: ~/.cache/pip
         key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
         restore-keys: ${{ runner.os }}-pip-
     - name: Cache PlatformIO
-      uses: actions/cache@v2
+      uses: actions/cache@v4
       with:
         path: ~/.platformio
         key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
     - name: Install PlatformIO
       run: |
         python -m pip install --upgrade pip

README.rst

@@ -153,28 +153,29 @@ The following table shows the typical pin layout used:
 | SPI SCK   | SCK      | 13 / ICSP-3 | 52      | D13     | ICSP-3          | 15        | ICSP3   | SPI-3   |
 +-----------+----------+-------------+---------+---------+-----------------+-----------+---------+---------+
 
-+-----------+---------------+--------------------------+
-|           | ESP8266       | Teensy                   |
-|           +---------------+--------+--------+--------+
-|           | Wemos D1 mini | 2.0    | ++ 2.0 | 3.1    |
-+-----------+---------------+--------+--------+--------+
-| Signal    | Pin           | Pin    | Pin    | Pin    |
-+===========+===============+========+========+========+
-| RST/Reset | D3            | 7      | 4      | 9      |
-+-----------+---------------+--------+--------+--------+
-| SPI SS    | D8            | 0      | 20     | 10     |
-+-----------+---------------+--------+--------+--------+
-| SPI MOSI  | D7            | 2      | 22     | 11     |
-+-----------+---------------+--------+--------+--------+
-| SPI MISO  | D6            | 3      | 23     | 12     |
-+-----------+---------------+--------+--------+--------+
-| SPI SCK   | D5            | 1      | 21     | 13     |
-+-----------+---------------+--------+--------+--------+
++-----------+---------------+--------------------------+-------------+
+|           | ESP8266       | Teensy                   | 8F328P-U    |
+|           +---------------+--------+--------+--------+-------------+
+|           | Wemos D1 mini | 2.0    | ++ 2.0 | 3.1    | ALPHA       |
++-----------+---------------+--------+--------+--------+-------------+
+| Signal    | Pin           | Pin    | Pin    | Pin    | Pin [5]_    |
++===========+===============+========+========+========+=============+
+| RST/Reset | D3            | 7      | 4      | 9      | D9# [1]_    |
++-----------+---------------+--------+--------+--------+-------------+
+| SPI SS    | D8            | 0      | 20     | 10     | D10# [2]_   |
++-----------+---------------+--------+--------+--------+-------------+
+| SPI MOSI  | D7            | 2      | 22     | 11     | MOSI / D11# |
++-----------+---------------+--------+--------+--------+-------------+
+| SPI MISO  | D6            | 3      | 23     | 12     | MISO / D12# |
++-----------+---------------+--------+--------+--------+-------------+
+| SPI SCK   | D5            | 1      | 21     | 13     | SCK         |
++-----------+---------------+--------+--------+--------+-------------+
 
 .. [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. 
 .. [4] Source: `#111 <https://github.com/miguelbalboa/rfid/issues/111#issuecomment-420433658>`_ .
+.. [5] Pin names from the back (empty) side of the board were used as more definitive.
 
 Important: If your micro controller supports multiple SPI interfaces, the library only uses the **default (first) SPI** of the Arduino framework.
 

changes.txt

@@ -1,6 +1,9 @@
 -- Add changes to unreleased tag until we make a release.
 
-xxxxx , v1.4.11
+xxxxx , v1.4.12
+
+30 Dec 2023, v1.4.11
+- fix: documentation
 
 1 Nov 2021 , v1.4.10
 - fix: timeout on Non-AVR boards; feat: Use yield() in busy wait loops @greezybacon 

doc/PICCMemoryLayout.md

@@ -10,8 +10,8 @@ The **MIFARE Classic** chips and protocol is described in the datasheets:
   *  Mini: http://www.idcardmarket.com/download/mifare_S20_datasheet.pdf
 
 The **MIFARE Ultralight** chip and protocol is described in the datasheets:
-  *  Ultralight:   https://www.nxp.com/documents/data_sheet/MF0ICU1.pdf
-  *  Ultralight C: https://www.nxp.com/documents/short_data_sheet/MF0ICU2_SDS.pdf
+  *  Ultralight:   https://www.nxp.com/docs/en/data-sheet/MF0ICU1.pdf
+  *  Ultralight C: https://www.nxp.com/docs/en/data-sheet/MF0ICU2_SDS_32.pdf
 
 ## MIFARE Classic 1K (MF1S503x)
 

examples/ChangeUID/ChangeUID.ino

@@ -35,19 +35,12 @@ MFRC522 mfrc522(SS_PIN, RST_PIN);   // Create MFRC522 instance
 /* Set your new UID here! */
 #define NEW_UID {0xDE, 0xAD, 0xBE, 0xEF}
 
-MFRC522::MIFARE_Key key;
-
 void setup() {
   Serial.begin(9600);  // Initialize serial communications with the PC
   while (!Serial);     // Do nothing if no serial port is opened (added for Arduinos based on ATMEGA32U4)
   SPI.begin();         // Init SPI bus
   mfrc522.PCD_Init();  // Init MFRC522 card
   Serial.println(F("Warning: this example overwrites the UID of your UID changeable card, use with care!"));
-
-  // Prepare key - all keys are set to FFFFFFFFFFFFh at chip delivery from the factory.
-  for (byte i = 0; i < 6; i++) {
-    key.keyByte[i] = 0xFF;
-  }
 }
 
 // Setting the UID can be as simple as this:

examples/FixBrickedUID/FixBrickedUID.ino

@@ -32,19 +32,12 @@
 
 MFRC522 mfrc522(SS_PIN, RST_PIN);   // Create MFRC522 instance
 
-MFRC522::MIFARE_Key key;
-
 void setup() {
   Serial.begin(9600);  // Initialize serial communications with the PC
   while (!Serial);     // Do nothing if no serial port is opened (added for Arduinos based on ATMEGA32U4)
   SPI.begin();         // Init SPI bus
   mfrc522.PCD_Init();  // Init MFRC522 card
   Serial.println(F("Warning: this example clears your mifare UID, use with care!"));
-
-  // Prepare key - all keys are set to FFFFFFFFFFFFh at chip delivery from the factory.
-  for (byte i = 0; i < 6; i++) {
-    key.keyByte[i] = 0xFF;
-  }
 }
 
 void loop() {

examples/MinimalInterrupt/MinimalInterrupt.ino

@@ -37,8 +37,6 @@
 
 MFRC522 mfrc522(SS_PIN, RST_PIN);   // Create MFRC522 instance.
 
-MFRC522::MIFARE_Key key;
-
 volatile bool bNewInt = false;
 byte regVal = 0x7F;
 void activateRec(MFRC522 mfrc522);

examples/ReadNUID/ReadNUID.ino

@@ -38,8 +38,6 @@
 
 MFRC522 rfid(SS_PIN, RST_PIN); // Instance of the class
 
-MFRC522::MIFARE_Key key; 
-
 // Init array that will store new NUID 
 byte nuidPICC[4];
 
@@ -48,13 +46,7 @@ void setup() {
   SPI.begin(); // Init SPI bus
   rfid.PCD_Init(); // Init MFRC522 
 
-  for (byte i = 0; i < 6; i++) {
-    key.keyByte[i] = 0xFF;
-  }
-
   Serial.println(F("This code scan the MIFARE Classsic NUID."));
-  Serial.print(F("Using the following key:"));
-  printHex(key.keyByte, MFRC522::MF_KEY_SIZE);
 }
 
 void loop() {
@@ -123,7 +115,7 @@ void printHex(byte *buffer, byte bufferSize) {
  */
 void printDec(byte *buffer, byte bufferSize) {
   for (byte i = 0; i < bufferSize; i++) {
-    Serial.print(buffer[i] < 0x10 ? " 0" : " ");
+    Serial.print(' ');
     Serial.print(buffer[i], DEC);
   }
 }

library.json

@@ -1,6 +1,6 @@
 {
   "name": "MFRC522",
-  "version": "1.4.10",
+  "version": "1.4.11",
   "license": "Unlicense",
   "keywords": "rfid, spi",
   "description": "Arduino RFID Library for MFRC522 (SPI). Read/Write a RFID Card or Tag using the ISO/IEC 14443A/MIFARE interface.",

library.properties

@@ -1,5 +1,5 @@
 name=MFRC522
-version=1.4.10
+version=1.4.11
 author=GithubCommunity
 maintainer=GithubCommunity
 sentence=Arduino RFID Library for MFRC522 (SPI)