Published April 8, 2023 © CC BY-SA

DIY RFID Lock using RYRR10S module

Simple DIY Lock using RYRR10S RFID/NFC module

IntermediateFull instructions providedOver 2 days494

Things used in this project

Hardware components

Arduino UNO Wifi Rev.2

RYRR10S RFID/NFC Module

Adafruit RGB Backlight LCD - 16x2

4x4 Matrix Keypad Module

Buzzer

Seeed Studio Grove - 2-Channel SPDT Relay

MB102 Breadboard Power Supply Module

12V Solenoid Lock

Story

In our everyday life, everybody uses RFID Technology, most of the times without knowing it. RFID history dates back to the 1940s, It has vast range of applications, widely used in various industries/fields like Logistics, Supply Chain, Security/Access Control, Healthcare etc. and many more.

1 / 2 • RFID/NFC based Door Lock Systems

RFID stands for Radio-frequency identification. It uses electromagnetic fields to automatically identify and track tags attached to objects. An RFID system consists of a tiny radio transponder, a radio receiver and transmitter.

Every RFID system consists of three components:

a scanning antenna, a transceiver and a transponder.
When the scanning antenna and transceiver are combined, they are referred to as an RFID reader or interrogator.
The transponder is in the RFID tag itself.

In this article we are going create one common/typical prototype application used in Access control. Which is Locking system. We're going to make simple DIY project of RFID based Lock.

So, to implement this project's concept/prototype, we'll need RFID/NFC Module which can be easily interfaced with any MCU Board, like (Arduino/ESP32 etc.)

We'd like to extend our sincere gratitude to Reyax Technology for providing us their excellent hardware (RYRR10S Multiprotocol Fully Integrated 13.56MHz RFID & NFC Antenna Module) for making prototype implementation of this Project.

RYRR10S Multiprotocol Fully Integrated 13.56MHz RFID & NFC Antenna Module

The RYRR10S antenna module is a 13.56-MHz RFID and Near Field Communication (NFC) system.

It has following features

ST CR95HF NFC/RFID Engine.

CR95HF block diagram

Supports Near Field Communication (NFC) ISO/IEC 18092.
Completely Integrated Protocol Handling for ISO/IEC 15693, ISO/IEC 14443A, ISO/IEC 14443B
NXP MIFARE® Classic compatible
Designed with PCB integrated antenna.
UART / SPI Interface optional.

We have explained detailed review in following video. We have explicated in detail, unboxing, features, specification, Datasheets, Application Interface, AT commands configuration guide etc. You can go through for more information.

[Device Overview] Reyax RYRR10S RFID/NFC Module - I

DIY project - Two level RFID Lock -

Now, lets see one small DIY project using this RYRR10S RFID reader module. Which will be having, two levels or layers, of locking system. In which, user have to use valid RFID card to unlock the Lock. You can see below is the functional block diagram of the project. It consist of, RFID module and Keypad as an input.

Functional block diagram of the project

Detailed circuit diagram is given below in circuits and schematics, you can also get it from GitHub Repo of the project.

There will be Two levels or layers of authentication. One will be, of course, the RFID and other one will be Passcode. If both levels completed successfully, then and only then, lock will get unlock. So, in order to enter pass code, the matrix keypad will be used. Here, we will see, two different programs. Two different versions of this DIY project.

DIY project version 1 -

First version, will be simple and basic in which all the authorized users data. Means, their RFID’s and their respective passcodes are pre-programmed at the time of programming. User can not change it afterwards in application mode.

Flowchart I - for DIY Project version 1

RFID will be the first level of authentication and triggering point for this version of project. System will be continuously scanning for RFID card or tag to be placed on RYRR10S Reader
If suppose, user places his RFID card on the reader. System will detect it. read its UID. unique Identification code, specific to that card. And then, compare it with Authorized cards, available in the database, which we have saved into microcontroller, at the time of programming. If it is found that, card’s UID is Valid and authorized, then and only then, it will goes to next level. Other wise, it will display access denied, on the LCD screen and will go back to its home screen. Lock will remain locked.
In another case, suppose, If system finds RFID card's UID is valid and the authorized one. Then, it goes to next level or layer of authentication. Which is nothing but, the pass code method. Here, using 4x4 matrix keypad, user have to enter the correct pass code. This passcode will also be unique to each user. So, if user has Valid RFID and enters correct passcode, only then, Lock will get opened. Otherwise not.

DIY project version 2 -

In second version of this DIY project, We will use keypad as an HMI device to interact with the project. Means, using Keypad and LCD display, user can set up or configure the lock's "settings". Like adding or enrolling new user RFID. Then, we also can delete or reset all the data, by entering specific code using keypad.

Flowchart I - for DIY Project version 2

Here, in this version, like previous one, Both methods or layers of unlocking, will be used. But, the first stage will be the Entering the code, instead of RFID. Here, as we said earlier, We will use keypad, as an HMI device, to interact with the project. Means, using Keypad, and, LCD display, user can set up the Lock configuration. Like, adding, or, enrolling new user RFID. Then, we can also delete, or, reset all the data, by just entering specific code using keypad
There will be three main program flows. Like First, in which user enters his passcode to enter into second stage, which will be RFID. If he enters correct passcode, then he will be asked to place his RFID card on the Reader. And if that card also valid, and, authorized, only then, lock will get unlocked. Other two codes or program flows, will be for resetting the user data and adding enrolling new user. Here, UID of new user will be stored into EPROM memory of Arduino, hence, even though power goes off, all the user data will be stored safely.
User has to enter specific code, to enter into these modes. Reset and the Enroll modes. You can change these codes, and their digits or characters, in the main program.

Software and Programming -

RFID module RYRR10S is powered by ST's CR95HF 13.56-MHz multi-protocol contactless transceiver IC. There are three communication interfaces facility with a host Controller as shown in following diagram,

RYRR10S RFID reader module comes with UART breakout board, on which its UARTs pins Tx and Rx are taken out. Therefore this module an be configured via serial AT commands. Means, to use this module for RFID detection we need to,

Interface this RFID reader module with main MCU via serial/SPI interface

And then We have to send certain sequence of AT commands serially to RFID Reader for performing typical RFID operations like Reading RFID tag
All these command sequences are given in datasheet of RYRR10S as following,

You can check this Firmware quick start guide to know more about this command sequences and its response.
Documents like Datasheets of RYRR10S and CR95HF are shared in GitHub Repo of the project.
In Source code we have added brief comments for wherever these AT commands and its hex number arrays are used.

Demo

In following video you can see demo and detailed explanation of working of the DIY project

[DIY Project] Reyax RYRR10S RFID/NFC Module - II

Future Expansion Ideas -

Making this DIY project headless, An Access control system via Web UI. by replacing Arduino Uno, with NodeMCU ESP8266 or any other Wi-Fi capable MCU board. Then using Wi-Fi manager firmware we're planning to provide a facility to add/remove user data by accessing. Access Control system, just flash and everything can be configured via Web UI

Credits

Thank you Reyax Technology, for supporting this project with their amazing hardware. Furthermore we'd like to thanks to all the peoples, websites and entities who helped us (directly/indirectly) in this project.

Suggestions about Project design, Circuits, source code modifications, Optimization, Errors/Bugs findings and queries are most welcomed. Please feel free to comment or give feedback.

Code

// ---------------------------------- make2explore.com----------------------------------------------------//
// Project           - Reyax RFID Module RYRR10S Testing - DIY Project - Two Layer Lock System
// Created By        - blog@make2explore.com
// Version - 1.0     - RFID as a First layer
// Last Modified     - 18/11/2022 14:00:00 @admin
// Software          - C/C++, PlatformIO IDE, Visual Studio Code Editor, Libraries
// Hardware          - Arduino Uno, Reyax RFID RYRR10S Module,16x2 I2C LCD Display, 4x4 Matrix Keypad
//                   - 12 Volt solenoid Lock, Relay and LED's             
// Sensors Used      - RFID RYRR10S
// Source Repo       - github.com/make2explore
// -------------------------------------------------------------------------------------------------------//

// Include Libraries
#include <Arduino.h>
#include <LiquidCrystal_I2C.h>
#include <SoftwareSerial.h>
#include <Keypad.h>

// LCD setup : Set the LCD address to 0x3F for a 16 chars and 2 line display
LiquidCrystal_I2C lcd(0x3F, 16, 2);

// Software Serial
SoftwareSerial RFserial(2, 3); //RX, TX

// Variables for Serial data
uint8_t received_buf_pos=0;
uint8_t response_byte;
uint8_t data_len;
bool received_complete=false;
String tag_id = "";
char Byte_In_Hex[3];

// GPIO Pin definitions / allocations
uint8_t lockPin = A0;
uint8_t redLED = A1;
uint8_t greenLED = A2;
uint8_t blueLED = A3;
uint8_t buzzer = 13;

// KEYPAD settings and Mapping
const byte numRows= 4; //number of rows on the keypad
const byte numCols= 4; //number of columns on the keypad

char keymap[numRows][numCols]=
{
	{'1', '2', '3', 'A'},

	{'4', '5', '6', 'B'},

	{'7', '8', '9', 'C'},

	{'*', '0', '#', 'D'}
};

// Code that shows the the keypad connections to the arduino terminals
byte rowPins[numRows] = {4,5,6,7}; //Rows 0 to 3
byte colPins[numCols]= {8,9,10,11};  //Columns 0 to 3

// Initializes an instance of the Keypad class
Keypad myKeypad= Keypad(makeKeymap(keymap), rowPins, colPins, numRows, numCols);


// Serial Commands - Refer datasheets of ST CR95HF or RYRR10S for more details
uint8_t echo_command[1] = {0x55};
uint8_t initialise_cmd_iso14443_1[6] =  {0x09, 0x04, 0x68, 0x01, 0x07, 0x10};
uint8_t initialise_cmd_iso14443_2[6] =  {0x09, 0x04, 0x68, 0x01, 0x07, 0x00};
uint8_t initialise_cmd_iso14443_3[6] =  {0x02, 0x04, 0x02, 0x00, 0x02, 0x80};
uint8_t initialise_cmd_iso14443_4[6] =  {0x09, 0x04, 0x3A, 0x00, 0x58, 0x04};
uint8_t initialise_cmd_iso14443_5[6] =  {0x09, 0x04, 0x68, 0x01, 0x01, 0xD3};

uint8_t detect_cmd_iso14443_1[4] =  {0x04, 0x02, 0x26, 0x07};
uint8_t detect_cmd_iso14443_2[5] =  {0x04, 0x03, 0x93, 0x20, 0x08};

// Variable for storing Valid Users data
struct user{
  String name;
  String card;
  String code;
  int access;
};

// Manually add Valid Users data - Their names, RFID's, Pin/passcodes and Access Tokens
user validUsers[6] = {{"User1", "c92c4f8c", "*123456#", 1},
                      {"User2", "e92d4f8c", "*654321#", 1},
                      {"User3", "9944f8c", "*321654#", 0},
                      {"User4", "31203164", "*123654#", 1},
                      {"User5", "fecb375b", "*123654#", 1},
                      {"User6", "593a308c", "*654123#", 1}};

uint8_t Tag_Status;
String userName = ""; // saving users name in the String for displaying on LCD 

// Serial verbose for debugging
void show_serial_data(){
  while(RFserial.available()!=0)
  Serial.print(RFserial.read(), HEX);
  Serial.println("");
}

// Buzzer notifications functions
void shortBeep(){
	digitalWrite(buzzer, LOW);
	delay(200);
	digitalWrite(buzzer, HIGH);
}

void longBeep(){
	digitalWrite(buzzer, LOW);
	delay(500);
	digitalWrite(buzzer, HIGH);
}

void doubleBeep(){
	digitalWrite(buzzer, LOW);
	delay(100);
	digitalWrite(buzzer, HIGH);
	delay(100);
	digitalWrite(buzzer, LOW);
	delay(100);
	digitalWrite(buzzer, HIGH);
}

// Initialize the 16x2 LCD Display
void initLCD(){
	lcd.init();
	// Turn on the blacklight and print a message.
	lcd.backlight();
	lcd.print("Starting...");
	delay(1000);
  lcd.clear();
	lcd.setCursor(0,0);
	lcd.print("Initializing LCD");
	delay(2000);
	lcd.setCursor(0,1);
	lcd.print("Init LCD : OK");
	delay(1000);
}

// Initialize the RYRR10S RFID module with sequence of commands given in datasheet 
// to configure the RFID module as UID Reader
void initRFID(){
  lcd.clear();
	lcd.setCursor(0,0);
	lcd.print("Init RFID ...");

  Serial.println("Echo command: "); 
  RFserial.write(echo_command, 1);  
  delay(1000); 
  show_serial_data();
  delay(1000);
  Serial.println("Initialise commands: ");  
  RFserial.write(initialise_cmd_iso14443_1, 6);
  delay(1000); show_serial_data(); 
  RFserial.write(initialise_cmd_iso14443_2, 6);
  delay(1000); show_serial_data();
  RFserial.write(initialise_cmd_iso14443_3, 6);
  delay(1000); show_serial_data();
  RFserial.write(initialise_cmd_iso14443_4, 6);
  delay(1000); show_serial_data();
  RFserial.write(initialise_cmd_iso14443_5, 6); 
  delay(1000); show_serial_data();
  lcd.setCursor(0,1);
	lcd.print("RFID : OK");
  delay(2000);
}

// Setup GPIO Port and Pins
void initGPIO(){
	pinMode(lockPin, OUTPUT);
	digitalWrite(lockPin, HIGH);

	pinMode(redLED, OUTPUT);
	digitalWrite(redLED, LOW);
	pinMode(greenLED, OUTPUT);
	digitalWrite(greenLED, LOW);
  pinMode(blueLED, OUTPUT);
	digitalWrite(blueLED, LOW);

	pinMode(buzzer, OUTPUT);
	digitalWrite(buzzer, HIGH);
}


// Function which reads UID serially
void Read_Tag(){
  uint8_t received_char;
  while(RFserial.available()!=0){
    received_char = char (RFserial.read());
    if(received_buf_pos==0)response_byte = received_char; 
    else if (received_buf_pos==1)data_len = received_char; 
    else if (received_buf_pos>=2 and received_buf_pos<6) {
      sprintf(Byte_In_Hex,"%x", received_char);
      tag_id += Byte_In_Hex; //adding to a string
      }
    received_buf_pos++;
    if(received_buf_pos >= data_len){
      received_complete = true;
      }
    }
}

// Function which compares the code We type on keypad with predefined codes
int compareCODE(String a){
	//with the accessCode;
  for (int i=0;i<sizeof(validUsers)/sizeof(user); i++){
    if((validUsers[i].card==tag_id)){
      if(validUsers[i].code == a){
        return 1;
      }
      else return 0;
      }
  }
}


// Function for displaying Character * on the LCD to hide the code typed on KeyPad for security purpose
String takeCode(char x){
	char vec[10];
	vec[0]=x;
	lcd.setCursor(0,1);
	lcd.print('*');
	for(int i=1;i<8;i++){
		vec[i]=myKeypad.waitForKey(); 	//Waits for 8 keys to be pressed and after that
		lcd.print('*');					        //is taking the decision
	} 				
	vec[8]=NULL;
	String str(vec);
	return str;
}

// Setup
void setup() {  
  Serial.begin(9600);
  RFserial.begin(57600);
  initGPIO();
  doubleBeep();
  initLCD();
  doubleBeep();
  initRFID();
  longBeep();
}

// main
void loop() {  
  received_buf_pos = 0;
  received_complete = false;
  tag_id="";
  response_byte=0;
  
  Serial.println("Searching new card...");
  RFserial.write(detect_cmd_iso14443_1, 4);
  delay(800);
  Serial.println("Response:"); show_serial_data();
  
  RFserial.write(detect_cmd_iso14443_2, 5);
  delay(300);

  if(RFserial.available()) {
    Read_Tag();
  }

  if(response_byte == 0x80){
    Tag_Status=2;
    for (int i=0;i<sizeof(validUsers)/sizeof(user); i++){
      if(validUsers[i].card==tag_id) {
        Tag_Status=validUsers[i].access;
        userName = validUsers[i].name;
      }
    }
    shortBeep();
    digitalWrite(blueLED, HIGH);
    lcd.clear();
    lcd.setCursor(0,0);
    lcd.print("Tag Detected !!");
    Serial.print("Tag detected. Tag id: ");
    lcd.setCursor(0,1);
    lcd.print("ID : ");
    lcd.setCursor(5,1);
    lcd.print(tag_id);
    Serial.println(tag_id);    
    Serial.println("");
    delay(2000);
    digitalWrite(blueLED, LOW);
    if(Tag_Status == 1){
      digitalWrite(greenLED, HIGH);
      doubleBeep();
      digitalWrite(greenLED, LOW);
      lcd.clear();
      lcd.setCursor(0,0);
      lcd.print("Valid Tag");
      lcd.setCursor(0,1);
      lcd.print("Next Step : PIN");
      delay(2000);
      lcd.clear();
      lcd.setCursor(0,0);
      lcd.print("Enter Key : ");
      boolean key = 1;
      while(key){
        char c=myKeypad.getKey();
        if(c != NO_KEY){
          String codecurent=takeCode(c);
          int A=compareCODE(codecurent);
            if(A==0){
            //A is a variable that stores the current code
            longBeep();
            lcd.clear();
            lcd.setCursor(0,0);
            lcd.print("INVALID CODE");
            lcd.setCursor(0,1);
            lcd.print( "Access Denied" );
            delay(2000);
            key = 0;
            return;
          }
          if(A==1){
            doubleBeep();
            digitalWrite(redLED, LOW);
            digitalWrite(greenLED, HIGH);
            digitalWrite(lockPin, LOW);
            lcd.clear();
            lcd.setCursor(0,0);
            lcd.print( "VALID CODE " );
            lcd.setCursor(0,1);
            lcd.print( "Access Granted" ); //The door will be opened
            delay(5000);
            key = 0;
            return;
          }
        }
      }
    }
    if (Tag_Status == 0){
      longBeep();
      lcd.clear();
      lcd.setCursor(0,0);
      lcd.print("InValid Tag");
      lcd.setCursor(0,1);
      lcd.print("Access Denied");
      delay(1000);
    }
    if (Tag_Status == 2){
      longBeep();
      digitalWrite(blueLED, HIGH);
      lcd.clear();
      lcd.setCursor(0,0);
      lcd.print("Unknown Tag");
      lcd.setCursor(0,1);
      lcd.print("Access Denied");
      delay(1000);
    }
  }    
  else{
    digitalWrite(redLED, HIGH);
    digitalWrite(greenLED, LOW);
    digitalWrite(blueLED, LOW);
    digitalWrite(lockPin, HIGH);
    lcd.clear();
    lcd.setCursor(0,0);
    lcd.print("No RFID : Locked");
    lcd.setCursor(0,1);
    lcd.print("Place RFID Card");
    Serial.println("No tag detected.");
    Serial.println("");
    delay(2000);
  }
}

// ---------------------------------- make2explore.com----------------------------------------------------//

// ---------------------------------- make2explore.com ----------------------------------------------------//
// Project           - Reyax RFID Module RYRR10S Testing - DIY Project - Two Layer Lock System
// Created By        - blog@make2explore.com
// Version - 2.0     - KeyPad as a First layer, and HMI
// Last Modified     - 18/11/2022 14:00:00 @admin
// Software          - C/C++, PlatformIO IDE, Visual Studio Code Editor, Libraries
// Hardware          - Arduino Uno, Reyax RFID RYRR10S Module,16x2 I2C LCD Display, 4x4 Matrix Keypad
//                   - 12 Volt solenoid Lock, Relay and LED's             
// Sensors Used      - RFID RYRR10S
// Source Repo       - github.com/make2explore
// --------------------------------------------------------------------------------------------------------//

// Include Libraries
#include <Arduino.h>
#include <LiquidCrystal_I2C.h>
#include <SoftwareSerial.h>
#include <Keypad.h>
#include <EEPROM.h>

// GPIO Pin definitions / allocations
int lockPin = A0;
int resetButton = 12;
bool button_state = 1;

int redLED = A1;
int greenLED = A2;
int blueLED = A3;
int buzzer = 13;

// Variables for different parameters 
uint8_t state = 0;

// EEPROM Access Array variables
byte  COD[10];
byte  AUX[10];

// KeyPad HMI codes to Enter into access, Enroll and Reset Modes
// You can change these codes, but keep same number of characters
String accessCode = "*123456#";   // KeyPad Access code
String enrolCode = "*654321#";    // RFID Enroll Code
String resetCode = "*789789#";    // RESET RFID Code

// KEYPAD settings and Mapping
const byte numRows= 4; //number of rows on the keypad
const byte numCols= 4; //number of columns on the keypad

char keymap[numRows][numCols]=
{
	{'1', '2', '3', 'A'},

	{'4', '5', '6', 'B'},

	{'7', '8', '9', 'C'},

	{'*', '0', '#', 'D'}
};

// Code that shows the the keypad connections to the arduino terminals
byte rowPins[numRows] = {4,5,6,7}; //Rows 0 to 3
byte colPins[numCols]= {8,9,10,11};  //Columns 0 to 3

// Initializes an instance of the Keypad class
Keypad myKeypad= Keypad(makeKeymap(keymap), rowPins, colPins, numRows, numCols);

// LCD setup : Set the LCD address to 0x3F for a 16 chars and 2 line display
LiquidCrystal_I2C lcd(0x3F, 16, 2);

// Software Serial
SoftwareSerial RFserial(2, 3); //RX, TX

// Variables for Serial data 
uint8_t received_buf_pos=0;
uint8_t response_byte;
uint8_t data_len;
boolean received_complete=false;
String tag_id = "";
char Byte_In_Hex[3];

// Serial Commands - Refer datasheets of ST CR95HF or RYRR10S for more details
uint8_t echo_command[1] = {0x55};
uint8_t initialise_cmd_iso14443_1[6] =  {0x09, 0x04, 0x68, 0x01, 0x07, 0x10};
uint8_t initialise_cmd_iso14443_2[6] =  {0x09, 0x04, 0x68, 0x01, 0x07, 0x00};
uint8_t initialise_cmd_iso14443_3[6] =  {0x02, 0x04, 0x02, 0x00, 0x02, 0x80};
uint8_t initialise_cmd_iso14443_4[6] =  {0x09, 0x04, 0x3A, 0x00, 0x58, 0x04};
uint8_t initialise_cmd_iso14443_5[6] =  {0x09, 0x04, 0x68, 0x01, 0x01, 0xD3};

uint8_t detect_cmd_iso14443_1[4] =  {0x04, 0x02, 0x26, 0x07};
uint8_t detect_cmd_iso14443_2[5] =  {0x04, 0x03, 0x93, 0x20, 0x08};

// Serial verbose for debugging
void show_serial_data(){
	while(RFserial.available()!=0)
	Serial.print(RFserial.read(), HEX);
	Serial.println("");
}

// Buzzer notifications functions
void shortBeep(){
	digitalWrite(buzzer, LOW);
	delay(200);
	digitalWrite(buzzer, HIGH);
}

void longBeep(){
	digitalWrite(buzzer, LOW);
	delay(500);
	digitalWrite(buzzer, HIGH);
}

void doubleBeep(){
	digitalWrite(buzzer, LOW);
	delay(100);
	digitalWrite(buzzer, HIGH);
	delay(100);
	digitalWrite(buzzer, LOW);
	delay(100);
	digitalWrite(buzzer, HIGH);
}

// Initialize the 16x2 LCD Display
void initLCD(){
	lcd.init();
	// Turn on the blacklight and print a message.
	lcd.backlight();
	lcd.print("Hello There !!!");
	shortBeep();
	delay(2000);
	lcd.clear();
	lcd.setCursor(0,0);
	lcd.print("Greetings From");
	lcd.setCursor(0,1);
	lcd.print("make2explore !!");
	doubleBeep();
	delay(3000);

	lcd.clear();
	lcd.setCursor(0,0);
	lcd.print("Project : Reyax");
	lcd.setCursor(0,1);
	lcd.print("RYRR10S RFID");
	delay(3000);

	shortBeep();
	lcd.clear();
	lcd.setCursor(0,0);
	lcd.print("Starting...");
	delay(1000);
	lcd.setCursor(0,1);
	lcd.print("Initialize LCD");
	delay(1500);
	lcd.clear();
	lcd.setCursor(0,0);
	lcd.print("Initializing LCD");
	lcd.setCursor(0,1);
	delay(1500);
	lcd.print("Init LCD : OK");
	delay(2000);
	shortBeep();
}

// Initialize the RYRR10S RFID module with sequence of commands given in datasheet 
// to configure the RFID module as UID Reader
void initRFID(){
	lcd.clear();
	lcd.print("Initialize RFID");
	RFserial.begin(57600);

	RFserial.write(echo_command, 1);  
	delay(1000);
	RFserial.write(initialise_cmd_iso14443_1, 6);
	delay(1000); 
	RFserial.write(initialise_cmd_iso14443_2, 6);
	delay(1000);
	RFserial.write(initialise_cmd_iso14443_3, 6);
	delay(1000);
	RFserial.write(initialise_cmd_iso14443_4, 6);
	delay(1000);
	RFserial.write(initialise_cmd_iso14443_5, 6); 
	delay(1000);

	lcd.setCursor(0,1);
	lcd.print("Init RFID : OK");
	delay(1000);
}

// Function which reads UID serially
void Read_Tag(){
	uint8_t received_char;
	tag_id = "";
	uint8_t i = 0;
	while(RFserial.available()!=0){
		received_char = char (RFserial.read());
		if(received_buf_pos==0){
			response_byte = received_char;
		} 
		else if (received_buf_pos==1){
			data_len = received_char;
		} 
		else if (received_buf_pos>=2 and received_buf_pos<6) {
			COD[i] = received_char;
			sprintf(Byte_In_Hex,"%x", received_char);
			tag_id += Byte_In_Hex; //adding to a string
			i++;
		}
		received_buf_pos++;
		if(received_buf_pos >= data_len){
		received_complete = true;
		}
	}
}

// Setup GPIO Port and Pins
void initGPIO(){

	pinMode(lockPin, OUTPUT);
	digitalWrite(lockPin, HIGH);

	pinMode(redLED, OUTPUT);
	digitalWrite(redLED, LOW);
	pinMode(greenLED, OUTPUT);
	digitalWrite(greenLED, LOW);
	pinMode(blueLED, OUTPUT);
	digitalWrite(blueLED, LOW);

	pinMode(buzzer, OUTPUT);
	digitalWrite(buzzer, HIGH);

	pinMode(resetButton, INPUT_PULLUP);		
}

// (Optional) Function for displaying Tag value on LCD 
void Display_Tag(String Tag){
	lcd.clear();
	lcd.setCursor(0,0);
	lcd.print( "Tag Detected !!" );
	lcd.setCursor(0,1);
	lcd.print( "ID : " );
	lcd.setCursor(5,1);
	lcd.print(Tag);
	delay(2000);
}

// Function for Enrolling or registering new RFID Tag into EEPROM of Arduino
void enrolTag() {
	int c = 0;
	for(int i=1;i<=EEPROM.read(0);i++){
		//The UID cannot be stored on one variable, it was needed to be split
		switch(i%4){
			case 1 :{AUX[0]=EEPROM.read(i); break;}
			case 2 :{AUX[1]=EEPROM.read(i); break;}
			case 3 :{AUX[2]=EEPROM.read(i); break;}
			case 0 :{AUX[3]=EEPROM.read(i); break;}
		}

		if((i)%4==0){
			if( AUX[0]== COD[0] && AUX[1]==COD[1] && AUX[2]==COD[2] && AUX[3]==COD[3] ){
				//Verify if the code is in EEPROM
				lcd.clear();
				lcd.setCursor(0,0);
				lcd.print("CARD ALREADY IN");
				lcd.setCursor(0,1);
				lcd.print("SYSTEM");
				digitalWrite(blueLED,LOW); //The red blue will be on
				delay(2000);
				c=1;
				break;}
		}
	}

	if(c==0){
		int aux2=EEPROM.read(0);
		EEPROM.write(aux2+1,COD[0]);  //Writing code in EEPROM
		EEPROM.write(aux2+2,COD[1]);
		EEPROM.write(aux2+3,COD[2]);
		EEPROM.write(aux2+4,COD[3]);
		aux2=aux2+4; // Position for a new code
		EEPROM.write(0,0);
		EEPROM.write(0,aux2);
		lcd.clear();
		lcd.setCursor(0,0);
		lcd.print("CARD ENROLLED");
		lcd.setCursor(0,1);
		lcd.print("New User Added");
		longBeep();
		digitalWrite(blueLED,LOW); //The red blue will be off
		delay(2000);
	}
}

// Function for ValidateRFID saved code in EEPROM
boolean validateTag(){
	boolean c=false;
	for(int i=1;i<=EEPROM.read(0);i++){
		//Read the EEPROM
		switch(i%4){
			case 1 :{AUX[0]=EEPROM.read(i); break;}
			case 2 :{AUX[1]=EEPROM.read(i); break;}
			case 3 :{AUX[2]=EEPROM.read(i); break;}
			case 0 :{AUX[3]=EEPROM.read(i); break;}
		}

		if((i)%4==0){
			if( (AUX[0]==COD[0]) && (AUX[1]==COD[1]) && (AUX[2]==COD[2]) &&  (AUX[3]==COD[3]))
			c=true; //Verify if the code is in EEPROM and make flag=true;
		}
	}

	return c;  
}

// Function which compares the code We type on keypad with predefined codes
int compareCODE(String a){
	//with the accessCode;
	if(a.equals(accessCode)){
		return 1;
    }
    else if(a.equals(enrolCode)){
		return 2;
    }
    else if(a.equals(resetCode)){
		return 3;
    }
    else return 0;  
}

// Function for displaying Character * on the LCD to hide the code typed on KeyPad for security purpose
String takeCode(char x){
	char vec[10];
	vec[0]=x;
	lcd.setCursor(0,0);
	lcd.clear();
	lcd.print('*');
	for(int i=1;i<8;i++){
		vec[i]=myKeypad.waitForKey(); 	//Waits for 8 keys to be pressed and after that
		lcd.print('*');					//is taking the decision
	} 				
	vec[8]=NULL;
	String str(vec);
	return str;
}

// Function which checks for Reset Button is pressed or Not
bool monitorWipeButton(uint32_t interval){
	uint32_t now = (uint32_t)millis();
	while ((uint32_t)millis() - now < interval){
		// check on every half a second
		if (((uint32_t)millis() % 500) == 0){
			if (digitalRead(resetButton) != LOW)
			return false;
		}
	}

	return true;
}

// Function which process RESET RFID Record (DELETE all RFID records from EEPROM)
void clearRecord(){
    digitalWrite(blueLED, HIGH); // Red Led stays on to inform user we are going to wipe
	lcd.clear();
    lcd.setCursor(0, 0);
    lcd.print("Press RED Button");
	lcd.setCursor(0, 1);
	lcd.print("to Wipe old Data");
	delay(2000);
    lcd.clear();
    lcd.setCursor(0, 0);
    lcd.print("This will remove");
    lcd.setCursor(0, 1);
    lcd.print("all records");
    delay(2000);
    lcd.clear();
    lcd.setCursor(0, 0);
    lcd.print("You have 3 ");
    lcd.setCursor(0, 1);
    lcd.print("secs to Cancel");
    delay(2000);
    
    lcd.clear();
    lcd.setCursor(0, 0);
    lcd.print("Unpres to cancel");
    lcd.setCursor(0, 1);
    lcd.print("Counting: ");
    lcd.setCursor(10, 1);
    lcd.print("1");
    delay(2000);

    lcd.clear();
    lcd.setCursor(0, 0);
    lcd.print("Unpres to cancel");
    lcd.setCursor(0, 1);
    lcd.print("Counting: ");
    lcd.setCursor(10, 1);
    lcd.print("2");
    delay(1000);

    lcd.clear();
    lcd.setCursor(0, 0);
    lcd.print("Unpres to cancel");
    lcd.setCursor(0, 1);
    lcd.print("Counting: ");
    lcd.setCursor(10, 1);
    lcd.print("3");
    delay(1000);
    
    bool buttonState = monitorWipeButton(3000); // Give user enough time to cancel operation
    if (buttonState == true && digitalRead(resetButton) == LOW){
		lcd.print("Wiping EEPROM...");
		for (uint16_t x = 0; x < EEPROM.length(); x = x + 1){
			//Loop end of EEPROM address
			if (EEPROM.read(x) == 0){
				//If EEPROM address 0
				// do nothing, already clear, go to the next address in order to save time and reduce writes to EEPROM
			}
			else{
				EEPROM.write(x, 0);       // if not write 0 to clear, it takes 3.3mS
			}
		}

		longBeep();
		lcd.clear();
		lcd.setCursor(0, 0);
		lcd.print("Wiping Done !!");
		lcd.setCursor(0,1);
		lcd.print("User Data Reset");
		// visualize a successful wipe
		digitalWrite(blueLED, LOW);
		delay(200);
		digitalWrite(blueLED, HIGH);
		delay(200);
		digitalWrite(blueLED, LOW);
		delay(200);
		digitalWrite(blueLED, HIGH);
		delay(200);
		digitalWrite(blueLED, LOW);

    } else{
		lcd.clear();
		lcd.setCursor(0, 0);
		lcd.print("Wiping Cancelled"); // Show some feedback that the wipe button did not pressed for 10 seconds
		delay(2000);
		digitalWrite(blueLED, LOW);
      	// If button still be pressed, wipe EEPROM
	}
}

// Setup
void setup()
{
	Serial.begin(9600);
	initGPIO();
	initLCD();
	initRFID();
	

	lcd.clear();
	lcd.setCursor(0,0);
	lcd.print( "LOCKED !!!" );
	lcd.setCursor(0,1);
	lcd.print( "Enter Pass Code" );
	digitalWrite(redLED, HIGH);
	longBeep();
}

// main
void loop(){
	switch(state){
		case 0: {
			char c=myKeypad.getKey();
			if(c != NO_KEY){
				String codecurent=takeCode(c);
				int A=compareCODE(codecurent);
				if(A==0){
					//A is a variable that stores the current code
					longBeep();
					lcd.clear();
					lcd.setCursor(0,0);
					lcd.print("INVALID CODE");
					lcd.setCursor(0,1);
					lcd.print( "Access Denied" );
					delay(2000);
					lcd.clear();
					lcd.setCursor(0,0);
					lcd.print("LOCKED !!!");
					lcd.setCursor(0,1);
					lcd.print( "Enter Pass Code" );
					return;
				}

				if(A==1){
					doubleBeep();
					digitalWrite(greenLED,HIGH); //The blue led will be on
					delay(500);
					digitalWrite(greenLED,LOW); //The blue led will be on
					lcd.clear();
					lcd.setCursor(0,0);
					lcd.print( "VALID CODE " );
					lcd.setCursor(0,1);
					lcd.print( "Next Step : RFID" ); //The door will be opened
					delay(2000);
					state = 1;
					return;
				}

				if(A==2){
					//Serial.println("I am in 2");
					doubleBeep();
					lcd.clear();
					lcd.setCursor(0,0);
					lcd.print( "Process of New" );
					lcd.setCursor(0,1);
					lcd.print( "RFID Enrolling" );
					digitalWrite(blueLED,HIGH); //The blue led will be on
					delay(2000);
					state=2;
					return;
				}


				if(A==3){
					//Serial.println("I am in 3");
					doubleBeep();
					lcd.clear();
					lcd.setCursor(0,0);
					lcd.print( "Process of RESET" );
					lcd.setCursor(0,1);
					lcd.print( "RFID Records" );
					digitalWrite(A0,HIGH); //The blue led will be on
					delay(2000);
					state=3;
					return;
				}
			}
	}break;


	case 1:{
		lcd.clear();
		lcd.setCursor(0,0);
		lcd.print( "LOCKED" );
		lcd.setCursor(0,1);
		lcd.print( "Place RFID Card" );
		received_buf_pos = 0;
		received_complete = false;
		response_byte=0;

		RFserial.write(detect_cmd_iso14443_1, 4);
		delay(800);
		Serial.println("Response:"); show_serial_data();
		RFserial.write(detect_cmd_iso14443_2, 5);
		delay(300);
		if(RFserial.available()) {
			Read_Tag();
		}
		if(response_byte == 0x80){
			if(validateTag()){
				lcd.clear();
				lcd.setCursor(0,0);
				lcd.print( "VALID RFID CARD" ); //The door will be opened
				lcd.setCursor(0,1);
				lcd.print( "Access Granted" ); //The door will be opened
				digitalWrite(redLED, LOW);
				digitalWrite(greenLED, HIGH);
				digitalWrite(lockPin, LOW);
				longBeep();
				delay(5000);
				digitalWrite(redLED, HIGH);
				digitalWrite(greenLED, LOW);
				digitalWrite(lockPin, HIGH);
				state = 0;
				lcd.clear();
				lcd.setCursor(0,0);
				lcd.print( "LOCKED !!!" );
				lcd.setCursor(0,1);
				lcd.print( "Enter Pass Code" );
			}else{
				longBeep();
				lcd.clear();
				lcd.setCursor(0,0);
				lcd.print( "INVALID RFID Tag" ); //If the code was wrongblocked
				lcd.setCursor(0,1);
				lcd.print( "Access Denied" ); //The door will be opened
				delay(2000);
				state = 0;
				lcd.clear();
				lcd.setCursor(0,0);
				lcd.print( "LOCKED !!!" );
				lcd.setCursor(0,1);
				lcd.print( "Enter Pass Code" );
			}
		}
		else{
			doubleBeep();
			digitalWrite(redLED, HIGH);
			digitalWrite(greenLED, LOW);
			digitalWrite(blueLED, LOW);
			digitalWrite(lockPin, HIGH);
			lcd.clear();
			lcd.setCursor(0,0);
			lcd.print("No Tag Detected");
			lcd.setCursor(0,1);
			lcd.print("Place RFID Card");
			delay(2000);
		}
		return;
	}

	case 2:{
		lcd.clear();
		lcd.setCursor(0,0);
		lcd.print( "Enrol New Card" );
		lcd.setCursor(0,1);
		lcd.print( "Place RFID Card" );
		received_buf_pos = 0;
		received_complete = false;
		response_byte=0;
		RFserial.write(detect_cmd_iso14443_1, 4);
		delay(800);
		Serial.println("Response:"); show_serial_data();
		RFserial.write(detect_cmd_iso14443_2, 5);
		delay(300);
		if(RFserial.available()) {
			Read_Tag();
		}
		if(response_byte == 0x80){
			enrolTag();
			state=0;
			delay(2000);
			lcd.clear();
			lcd.setCursor(0,0);
			lcd.print( "LOCKED !!!" );
			lcd.setCursor(0,1);
			lcd.print( "Enter Pass Code" );  
		}
		else{
			doubleBeep();
			lcd.clear();
			lcd.setCursor(0,0);
			lcd.print("No Tag Detected");
			lcd.setCursor(0,1);
			lcd.print("Place RFID Card");
			delay(2000);
		}
		return;
	}

	case 3:{
		clearRecord();
		state=0;
		delay(2000);
		lcd.clear();
		lcd.setCursor(0,0);
		lcd.print( "LOCKED !!!" );
		lcd.setCursor(0,1);
		lcd.print( "Enter Pass Code" );   
	}
	break;

	}
}

// ---------------------------------- make2explore.com----------------------------------------------------//

Credits

make2explore

8 projects • 15 followers

Engineering Consultant, Tech Content Creator - #Electronics #EmbeddedSystems #IoT #AI #ML

DIY RFID Lock using RYRR10S module

Things used in this project

Hardware components

Story

DIY project - Two level RFID Lock -

DIY project version 1 -

DIY project version 2 -

Software and Programming -

Demo

Credits

Schematics

DIY RFID Lock

DIY RFID Lock

Code

DIY RFID Lock-V1

DIY RFID Lock-V2

DIY RFID Lock

Credits

make2explore

Comments

Embed the widget on your own site

DIY RFID Lock using RYRR10S module

DIY RFID Lock using RYRR10S module

Things used in this project

Hardware components

Story

DIY project - Two level RFID Lock -

DIY project version 1 -

DIY project version 2 -

Software and Programming -

Demo

Credits

Schematics

DIY RFID Lock

DIY RFID Lock

Code

DIY RFID Lock-V1

DIY RFID Lock-V2

DIY RFID Lock

Credits

make2explore

Comments

Related channels and tags