Skip to content

Commit

Permalink
Update readme (#43)
Browse files Browse the repository at this point in the history
  • Loading branch information
abobija authored Sep 8, 2024
1 parent 655987f commit d6f4f07
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# esp-idf-rc522

C library for interfacing ESP32 with MFRC522 RFID card reader.
[![Component Registry](https://components.espressif.com/components/abobija/rc522/badge.svg)](https://components.espressif.com/components/abobija/rc522)

C library for interfacing ESP32 with MFRC522 RFID card reader, packaged as ESP-IDF component.

> [!NOTE]
> Library currently just reads serial number of RFID tags, which is enough for most applications.
## How to use
Expand Down Expand Up @@ -82,7 +85,8 @@ rc522_config_t config = {

Let's say that spi bus `VSPI_HOST` has been already initialized, and rc522 needs to be attached to that bus. That can be accomplished with the next configuration. Property `.spi.bus_is_initialized` is required to be set to `true` in order to inform library to not initialize spi bus again.

> NOTE: Property `.spi.bus_is_initialized` will be deprecated in the future once when [this issue](https://github.com/espressif/esp-idf/issues/8745) is resolved.
> [!NOTE]
> Property `.spi.bus_is_initialized` will be deprecated in the future once when [this issue](https://github.com/espressif/esp-idf/issues/8745) is resolved.
```c
rc522_config_t config = {
Expand Down
2 changes: 1 addition & 1 deletion idf_component.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: "2.6.0"
version: "2.6.1"
description: "MFRC522 driver"
url: "https://github.com/abobija/esp-idf-rc522"
repository: "https://github.com/abobija/esp-idf-rc522.git"
Expand Down

0 comments on commit d6f4f07

Please sign in to comment.