Merge branch 'master' of https://github.com/tueddy/rfid

.github/dependabot.yml

@@ -13,3 +13,7 @@ updates:
       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@v3
+    - 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@v3
+    - uses: actions/checkout@v4
     - name: Cache pip
-      uses: actions/cache@v3
+      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@v3
+      uses: actions/cache@v4
       with:
         path: ~/.platformio
         key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
     - name: Install PlatformIO
       run: |
         python -m pip install --upgrade pip

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 

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() {

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)