https://github.com/felipegtralli/pn532
PN532 Component for ESP-IDF
https://github.com/felipegtralli/pn532
esp-idf esp32 pn532
Last synced: 4 months ago
JSON representation
PN532 Component for ESP-IDF
- Host: GitHub
- URL: https://github.com/felipegtralli/pn532
- Owner: felipegtralli
- Created: 2024-11-18T18:12:17.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-12T23:38:49.000Z (over 1 year ago)
- Last Synced: 2025-02-07T16:37:23.492Z (over 1 year ago)
- Topics: esp-idf, esp32, pn532
- Language: C
- Homepage:
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PN532 Component for ESP-IDF
This project provides an ESP-IDF library for interfacing with the PN532 NFC/RFID controller.
Note: Currently, this library only supports UART protocol. Support for I2C and SPI may be added in the future.
## How to Use
### Hardware
- **ESP32 Board**: Any ESP32-based development board.
- **PN532 NFC/RFID Controller**: Elechouse's PN532 Module V3 was used for testing and development.
### Connection Diagrams
Connect the PN532 module to the ESP32 board as follows:
#### For UART
| PN532 Pin | ESP32 Pin |
|-----------|-----------|
| VCC | 3.3V |
| GND | GND |
| TX | RX (GPIO) |
| RX | TX (GPIO) |
### Getting Started
1. Install ESP-IDF
Follow the ESP-IDF installation guide for your operating system.
2. Clone the Repository
```sh
git clone https://github.com/felipegtralli/pn532.git
```
3. Add PN532 as a Component
Include the PN532 library in your ESP-IDF project by placing it in the components directory or by linking it via an idf_component.yml.
4. Reconfigure
```sh
idf.py reconfigure
```
5. Build and Flash
```sh
idf.py build flash
```
## Testing Component
1. Connect Hardware
Ensure the ESP32 and PN532 are properly connected.
2. Run Example Code
Flash and monitor any example provided in the examples folder.
```sh
idf.py build flash monitor
```
## Contributing
1. Fork the repository.
2. Submit pull requests for bug fixes or feature additions.