Merge pull request ondryaso#25 from LudwigKnuepfer/pr/irq

Add support for interrupt driven tag detection

Author: ondryaso

README.md

@@ -30,12 +30,14 @@ Connecting RC522 module to SPI is pretty easy. You can use [this neat website](h
 | SCK            | 2         | 23               | GPIO11, SCKL |
 | MOSI           | 3         | 19               | GPIO10, MOSI |
 | MISO           | 4         | 21               | GPIO9, MISO  |
+| IRQ            | 5         | 18               | GPIO24       |
 | GND            | 6         | 6, 9, 20, 25     | Ground       |
 | RST            | 7         | 22               | GPIO25       |
-| 3.3V           | 8         | 1                | 3V3          |
+| 3.3V           | 8         | 1,17             | 3V3          |
 
 You can also connect the SDA pin to CE1 (GPIO7, pin #26) and call the RFID constructor with *bus=0, device=1*
 and you can connect RST pin to any other free GPIO pin and call the constructor with *pin_rst=__BOARD numbering pin__*.
+Furthermore, the IRQ pin is configurable by passing *pin_irq=__BOARD numbering pin__*.
 
 __NOTE:__ For RPi A+/B+/2/3 with 40 pin connector, SPI1/2 is available on top of SPI0. Kernel 4.4.x or higher and *dtoverlay* configuration is required. For SPI1/2, *pin_ce=__BOARD numbering pin__* is required.
 
@@ -51,6 +53,7 @@ from pirc522 import RFID
 rdr = RFID()
 
 while True:
+  rdr.wait_for_tag()
   (error, tag_type) = rdr.request()
   if not error:
     print("Tag detected")
@@ -84,6 +87,9 @@ util = rdr.util()
 util.debug = True
 
 while True:
+    # Wait for tag
+    rdr.wait_for_tag()
+
     # Request tag
     (error, data) = rdr.request()
     if not error:
@@ -121,6 +127,4 @@ while True:
             util.dump()
             # We must stop crypto
             util.deauth()
-
-            time.sleep(1)
 ```

examples/KeyChange.py

@@ -20,6 +20,8 @@ def end_read(signal,frame):
 
 print("Starting")
 while run:
+    rdr.wait_for_tag()
+
     (error, data) = rdr.request()
     if not error:
         print("\nDetected: " + format(data, "02x"))

examples/Read.py

@@ -2,6 +2,7 @@
 
 import signal
 import time
+import sys
 
 from pirc522 import RFID
 
@@ -15,11 +16,14 @@ def end_read(signal,frame):
     print("\nCtrl+C captured, ending read.")
     run = False
     rdr.cleanup()
+    sys.exit()
 
 signal.signal(signal.SIGINT, end_read)
 
 print("Starting")
 while run:
+    rdr.wait_for_tag()
+
     (error, data) = rdr.request()
     if not error:
         print("\nDetected: " + format(data, "02x"))

examples/UtilExample.py

@@ -11,6 +11,9 @@
 util.debug = True
 
 while True:
+    # Wait for tag
+    rdr.wait_for_tag()
+
     # Request tag
     (error, data) = rdr.request()
     if not error:

pirc522/__init__.py

@@ -1,16 +1,16 @@
-import time
-import signal
+import threading
 
 import spidev
 import RPi.GPIO as GPIO
 
 
-__version__ = "2.0.0"
+__version__ = "2.1.0"
 
 
 class RFID(object):
     pin_rst = 22
     pin_ce = 0
+    pin_irq = 18
 
     mode_idle = 0x00
     mode_auth = 0x0E
@@ -40,21 +40,30 @@ class RFID(object):
     length = 16
 
     authed = False
+    irq = threading.Event()
 
-    def __init__(self, bus=0, device=0, speed=1000000, pin_rst=22, pin_ce=0):
+    def __init__(self, bus=0, device=0, speed=1000000, pin_rst=22,
+            pin_ce=0, pin_irq=18):
         self.pin_rst = pin_rst
         self.pin_ce = pin_ce
+        self.pin_irq = pin_irq
 
         self.spi = spidev.SpiDev()
         self.spi.open(bus, device)
         self.spi.max_speed_hz = speed
 
         GPIO.setmode(GPIO.BOARD)
         GPIO.setup(pin_rst, GPIO.OUT)
+        GPIO.setup(pin_irq, GPIO.IN, pull_up_down=GPIO.PUD_UP)
+        GPIO.add_event_detect(pin_irq, GPIO.FALLING,
+                callback=self.irq_callback)
         GPIO.output(pin_rst, 1)
         if pin_ce != 0:
             GPIO.setup(pin_ce, GPIO.OUT)
             GPIO.output(pin_ce, 1)
+        self.init()
+
+    def init(self):
         self.reset()
         self.dev_write(0x2A, 0x8D)
         self.dev_write(0x2B, 0x3E)
@@ -344,7 +353,27 @@ def write(self, block_address, data):
 
         return error
 
+    def irq_callback(self, pin):
+        self.irq.set()
+
+    def wait_for_tag(self):
+        # enable IRQ on detect
+        self.init()
+        self.irq.clear()
+        self.dev_write(0x04, 0x00)
+        self.dev_write(0x02, 0xA0)
+        # wait for it
+        waiting = True
+        while waiting:
+            self.dev_write(0x09, 0x26)
+            self.dev_write(0x01, 0x0C)
+            self.dev_write(0x0D, 0x87)
+            waiting = not self.irq.wait(0.1)
+        self.irq.clear()
+        self.init()
+
     def reset(self):
+        authed = False
         self.dev_write(0x01, self.mode_reset)
 
     def cleanup(self):