Skip to content

Commit

Permalink
Link to nfcpy in docs (#2238)
Browse files Browse the repository at this point in the history
* Link to nfcpy

* update doc for serial devices

* Change name

Co-authored-by: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com>

---------

Co-authored-by: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com>
  • Loading branch information
s-martin and AlvinSchiller committed Feb 5, 2024
1 parent 5c49108 commit b35013c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
3 changes: 2 additions & 1 deletion documentation/developers/rfid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
* [RDM6300 Reader](rdm6300.md)
* [MFRC522 SPI Reader](mfrc522_spi.md)
* [PN532 I2C Reader](pn532_i2c.md)
* [Generic Readers without HID (NFCpy)](generic_nfcpy.md)
* [Mock Reader](mock_reader.md)
* [Template Reader](template_reader.md)


2 changes: 1 addition & 1 deletion documentation/developers/rfid/generic_nfcpy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This module is based on the user space NFC reader library [nfcpy](https://nfcpy.
The link above also contains a list of [supported devices](https://nfcpy.readthedocs.io/en/latest/overview.html#supported-devices).

The goal of this module is to handle USB NFC devices, that don't have a HID-keyboard
driver, and thus cannot be used with the [genericusb](genericusb.md) module.
driver, and thus cannot be used with the [genericusb](genericusb.md) module. Also some serial devices are supported.

> [!NOTE]
> Since nfcpy is a user-space library, it is required to supress the kernel from loading its driver.
Expand Down

0 comments on commit b35013c

Please sign in to comment.