Merge branch 'upstream/master'

.travis.yml

@@ -14,6 +14,7 @@ env:
     - PLATFORMIO_CI_SRC=examples/firmware_check/firmware_check.ino
     - PLATFORMIO_CI_SRC=examples/FixBrickedUID/FixBrickedUID.ino
     - PLATFORMIO_CI_SRC=examples/MifareClassicValueBlock/MifareClassicValueBlock.ino
+    - PLATFORMIO_CI_SRC=examples/MinimalInterrupt/MinimalInterrupt.ino
     - PLATFORMIO_CI_SRC=examples/ReadAndWrite/ReadAndWrite.ino
     - PLATFORMIO_CI_SRC=examples/ReadUidMultiReader/ReadUidMultiReader.ino
     - PLATFORMIO_CI_SRC=examples/rfid_default_keys/rfid_default_keys.ino

changes.txt

@@ -1,3 +1,8 @@
+11 Feb 2016, v1.1.8
+- Added examples/MinimalInterrupt/MinimalInterrupt.ino example, Interrupt example @lmmeng
+- Added .gitignore file allows the project to be more easily used as a subproject. @BenWiederhake
+- Added Added Teensy 2.0 & Tensy++ 2.0 pinouts to README.rst @jkutianski
+
 16 Jan 2016, v1.1.7
 - README.rst Spelling and Grammar Tweak @cuthbertnibbles
 - Added examples/servo_motor/servo_motor.ino example, Arduino RFID Access Control with a Servo Motor @techied

examples/MinimalInterrupt/MinimalInterrupt.ino

@@ -0,0 +1,137 @@
+/**
+ * ----------------------------------------------------------------------------
+ * This is a MFRC522 library example; see https://github.com/miguelbalboa/rfid
+ * for further details and other examples.
+ * 
+ * NOTE: The library file MFRC522.h has a lot of useful info. Please read it.
+ * 
+ * Released into the public domain.
+ * ----------------------------------------------------------------------------
+ * Minimal example how to use the interrupts to read the UID of a MIFARE Classic PICC
+ * (= card/tag).
+ * 
+ * 
+ * Typical pin layout used:
+ * -----------------------------------------------------------------------------------------
+ *             MFRC522      Arduino       Arduino   Arduino    Arduino          Arduino
+ *             Reader/PCD   Uno           Mega      Nano v3    Leonardo/Micro   Pro Micro
+ * Signal      Pin          Pin           Pin       Pin        Pin              Pin
+ * -----------------------------------------------------------------------------------------
+ * RST/Reset   RST          9             5         D9         RESET/ICSP-5     RST
+ * SPI SS      SDA(SS)      10            53        D10        3                10
+ * IRQ         ?            ?             ?         ?          2                10
+ * SPI MOSI    MOSI         11 / ICSP-4   51        D11        ICSP-4           16
+ * SPI MISO    MISO         12 / ICSP-1   50        D12        ICSP-1           14
+ * SPI SCK     SCK          13 / ICSP-3   52        D13        ICSP-3           15
+ * 
+ */
+
+#include <SPI.h>
+#include <MFRC522.h>
+
+#define RST_PIN         9           // Configurable, see typical pin layout above
+#define SS_PIN          3           // Configurable, see typical pin layout above
+#define IRQ_PIN         2           
+
+MFRC522 mfrc522(SS_PIN, RST_PIN);   // Create MFRC522 instance.
+
+MFRC522::MIFARE_Key key;
+
+volatile boolean bNewInt = false;
+unsigned char regVal = 0x7F;
+void activateRec(MFRC522 mfrc522);
+void clearInt(MFRC522 mfrc522);
+
+/**
+ * Initialize.
+ */
+void setup() {
+    Serial.begin(115200); // 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
+
+    /* read and printout the MFRC522 version (valid values 0x91 & 0x92)*/
+    Serial.print("Ver: 0x");      
+    byte readReg = mfrc522.PCD_ReadRegister(mfrc522.VersionReg);
+    Serial.println(readReg, HEX);      
+
+     /* setup the IRQ pin*/ 
+    pinMode(IRQ_PIN, INPUT_PULLUP);
+   
+    /* 
+     *  Allow the ... irq to be propagated to the IRQ pin
+     *  For test purposes propagate the IdleIrq and loAlert
+     */
+    regVal = 0xA0; //rx irq
+    mfrc522.PCD_WriteRegister(mfrc522.ComIEnReg,regVal);
+    
+    bNewInt = false; //interrupt flag
+
+    /*Activate the interrupt*/
+    attachInterrupt(digitalPinToInterrupt(IRQ_PIN), readCard, FALLING);
+
+    Serial.println("End setup"); 
+
+    do{ //clear a spourious interrupt at start
+      ;
+    }while(!bNewInt);
+    bNewInt = false;
+}
+
+/**
+ * Main loop.
+ */
+void loop() {
+   
+   if(bNewInt){  //new read interrupt
+      bNewInt = false;
+      Serial.print("Interrupt. ");
+      mfrc522.PICC_ReadCardSerial(); //read the tag data
+      // Show some details of the PICC (that is: the tag/card)
+      Serial.print(F("Card UID:"));
+      dump_byte_array(mfrc522.uid.uidByte, mfrc522.uid.size);
+      Serial.println();
+     
+      clearInt(mfrc522);
+   }
+
+// The receiving block needs regular retriggering (tell the tag it should transmit??)
+// (mfrc522.PCD_WriteRegister(mfrc522.FIFODataReg,mfrc522.PICC_CMD_REQA);)
+   activateRec(mfrc522);
+   delay(100);
+} //loop()
+
+/**
+ * Helper routine to dump a byte array as hex values to Serial.
+ */
+void dump_byte_array(byte *buffer, byte bufferSize) {
+    for (byte i = 0; i < bufferSize; i++) {
+        Serial.print(buffer[i] < 0x10 ? " 0" : " ");
+        Serial.print(buffer[i], HEX);
+    }
+}
+/**
+ * MFRC522 interrupt serving routine
+ */
+void readCard(){
+   bNewInt = true;
+}
+
+/*
+ * The function sending to the MFRC522 the needed commands to activate the reception
+ */
+void activateRec(MFRC522 mfrc522){
+    mfrc522.PCD_WriteRegister(mfrc522.FIFODataReg,mfrc522.PICC_CMD_REQA);
+    mfrc522.PCD_WriteRegister(mfrc522.CommandReg,mfrc522.PCD_Transceive);  
+    mfrc522.PCD_WriteRegister(mfrc522.BitFramingReg, 0x87);    
+}
+
+/*
+ * The function to clear the pending interrupt bits after interrupt serving routine
+ */
+void clearInt(MFRC522 mfrc522){
+   mfrc522.PCD_WriteRegister(mfrc522.ComIrqReg,0x7F);
+}
+

library.json

@@ -7,7 +7,7 @@
     "type": "git",
     "url": "https://github.com/miguelbalboa/rfid.git"
   },
-  "version": "1.1.7",
+  "version": "1.1.8",
   "exclude": "doc",
   "frameworks": "arduino",
   "platforms": ["atmelavr", "ststm32", "teensy"]

library.properties

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