🚀 NFC Reader/Writer Application

A powerful PySide6-based application for reading from and writing to various types of NFC tags with advanced features and a user-friendly interface.

Installation

Prerequisites

• Python 3.9 or higher
• NFC reader hardware (ACR122U, ACR1252U, etc.)

Quick Start

1. Clone the repository:

   git clone https://github.com/Nsfr750/NFC.git
   cd NFC
   

2. Create and activate a virtual environment:

   python -m venv venv
   .\venv\Scripts\activate  # Windows
   source venv/bin/activate  # Linux/Mac
   

3. Install dependencies:

   pip install -r requirements.txt
   

4. Run the application:

   python main.py
   

For detailed installation instructions, see PREREQUISITES.md.

Features

• Multi-tag Support: Comprehensive support for various NFC tag types including:
  • NTAG (NTAG213, NTAG215, NTAG216)
  • MIFARE Classic (1K, 4K)
  • MIFARE Ultralight
  • FeliCa (Sony)
  • ISO 14443 Type A/B cards

• Comprehensive Tag Support: View supported operations for all tag types

• NDEF Operations:
  • Read and write NDEF records
  • Create and manage multiple NDEF records
  • Support for various NDEF record types (Text, URI, Smart Poster, etc.)
  • Hex view for raw data inspection
• Tag Management:
  • Read tag information (UID, memory layout, capabilities)
  • Write data to tags with validation
  • Lock tags to prevent unauthorized writes
  • Format tags for NDEF usage
• User Interface:
  • Modern, responsive design with sphinx_rtd_theme
  • Light/Dark/System theme support
  • Real-time tag detection and status updates
  • Detailed tag information panel
  • Log viewer with filtering options
  • Comprehensive documentation in English and Italian
• Security Features:
  • 🔒 Password protection for sensitive operations
  • 🔑 Secure password hashing with PBKDF2
  • 🔄 Password change functionality
  • ⚙️ Toggle for enabling/disabling password protection
  • 🔐 Protected operations include Tag Tools, Database, and Cloner
• Advanced Features:
  • Tag emulation mode (experimental)
  • Batch operations for processing multiple tags
  • Custom command execution
  • Logging system with multiple verbosity levels
  • API documentation for developers
  • Troubleshooting guide for common issues
  • Contributing guidelines for open-source collaboration

🚀 Requirements

• Python 3.8 or higher
• Supported NFC Reader/Writer hardware:
  • ACR122U
  • PN532 (via USB/UART)
  • PC/SC compatible readers
• Windows 10/11 or Linux with PC/SC support
• Required Python packages (see requirements.txt)

📖 Documentation

Comprehensive documentation is available in both English and Italian, including:

• User Guide
• API Reference
• Troubleshooting Guide
• FAQ
• Contributing Guidelines

To build the documentation locally:

# Install documentation requirements
pip install -r requirements-docs.txt

# Build English documentation
cd docs/ENG
make html

# Build Italian documentation
cd ../ITA
make html

The documentation will be available in the _build/html directory of each language folder.

📦 Installation

1. Clone this repository:

   git clone https://github.com/Nsfr750/NFC.git
   cd NFC
   

2. Create and activate a virtual environment (recommended):

   # Windows
   python -m venv venv
   .\venv\Scripts\activate
   
   # Linux/macOS
   python3 -m venv venv
   source venv/bin/activate
   

3. Install the required packages:

   pip install -r requirements.txt
   

4. (Optional) Install PC/SC drivers if not already installed:
   • Windows: Install CCID drivers
   • Linux: Install pcscd and libpcsclite-dev packages

5. Run the application:

   python main.py
   

🚀 Usage

Basic Operations

1. Connect your NFC reader
   • The application will automatically detect supported devices
   • Connection status is shown in the status bar
2. Read a tag
   • Place an NFC tag near the reader
   • Tag information will be displayed in the main window
   • View detailed memory layout in the hex editor
3. Write to a tag
   • Navigate to the “Write” tab
   • Select the record type (Text, URI, etc.)
   • Enter your content and click “Write to Tag”
4. Lock a tag
   • Use the “Lock” button to prevent further writes
   • Some tags support permanent locking (be careful!)

🛠️ Advanced Features

• Tag Emulation: Emulate an NFC tag (experimental)
• Custom Commands: Send raw APDU commands to the tag
• Memory View: Inspect and edit raw tag memory
• Logging: View detailed operation logs with filtering options

⚙️ Settings

Access settings via Tools > Settings or press Ctrl+,:

• General:
  • Auto-connect on startup
  • Language selection
  • Check for updates
• NFC:
  • Reader timeout
  • Auto-read on tag detection
  • Beep on tag detection
• Interface:
  • Theme (Light/Dark/System)
  • Font size and family
  • Window behavior
• Advanced:
  • Logging level
  • Custom commands
  • Developer options

⌨️ Keyboard Shortcuts

🤝 Contributing

Contributions are welcome! Here’s how you can help:

1. Report bugs by opening an issue
2. Suggest new features or improvements
3. Submit pull requests
4. Improve documentation
5. Share your feedback and ideas

📝 License

This project is licensed under the GPL-3.0 License

👤 Author

• Nsfr750
  • Email: nsfr750@yandex.com
  • GitHub: @Nsfr750
  • Discord: Join our community

💖 Support

If you find this project useful, please consider supporting its development:

• Become a Patron
• Donate via PayPal

• Donate Monero:

  47Jc6MC47WJVFhiQFYwHyBNQP5BEsjUPG6tc8R37FwcTY8K5Y3LvFzveSXoGiaDQSxDrnCUBJ5WBj6Fgmsfix8VPD4w3gXF
  

📞 Contact

For support, feature requests, or questions, please open an issue on GitHub or join our Discord server.