From 1859ca77d8db5f68771e15aa5061a292b372ef3f Mon Sep 17 00:00:00 2001 From: Thomas Franks Date: Tue, 21 Mar 2023 14:49:32 -0400 Subject: [PATCH] changes per comments --- adafruit_pn532/i2c.py | 51 ++++++++++++++++++++++-------------------- adafruit_pn532/spi.py | 16 +++++++------ adafruit_pn532/uart.py | 37 ++++++++++++++++-------------- docs/conf.py | 2 ++ 4 files changed, 58 insertions(+), 48 deletions(-) diff --git a/adafruit_pn532/i2c.py b/adafruit_pn532/i2c.py index 84d5b7d..ade7c18 100644 --- a/adafruit_pn532/i2c.py +++ b/adafruit_pn532/i2c.py @@ -50,40 +50,43 @@ class PN532_I2C(PN532): uses clock stretching. Optional IRQ pin (not used), resetp pin and debugging output. - :param busio.I2C i2c: The I2C bus the PN532 is connected to. + :param ~busio.I2C i2c: The I2C bus the PN532 is connected to. :param int address: The I2C device address. Defaults to :const:`0x24` - :param DigitalInOut reset: board pin the PN532 reset is connected to - :param DigitalInOut req: board pin the PN532 P32 is connected to - :param bool debug: if true print additional debug statements + :param digitalio.DigitalInOut reset: board pin the PN532 reset is connected to + :param digitalio.DigitalInOut req: board pin the PN532 P32 is connected to + :param bool debug: if True print additional debug statements. Defaults to False **Quickstart: Importing and using the device** - Here is an example of using the :class:`PN532_I2C` class. - First you will need to import the libraries to use the sensor - .. code-block:: python + Here is an example of using the :class:`PN532_I2C` class. + First you will need to import the libraries to use the sensor - import board - import busio - from digitalio import DigitalInOut - from adafruit_pn532.i2c import PN532_I2C + .. code-block:: python - Once this is done you can define your `board.I2C` object and define your object - .. code-block:: python + import board + import busio + from digitalio import DigitalInOut + from adafruit_pn532.i2c import PN532_I2C - i2c = busio.I2C(board.SCL, board.SDA) - reset_pin = DigitalInOut(board.D6) - # On Raspberry Pi, you must also connect a pin to P32 "H_Request" for hardware - # wakeup! this means we don't need to do the I2C clock-stretch thing - req_pin = DigitalInOut(board.D12) - pn532 = PN532_I2C(i2c, debug=False, reset=reset_pin, req=req_pin) - # Configure PN532 to communicate with MiFare cards - pn532.SAM_configuration() + Once this is done you can define your `board.I2C` object and define your object - Now you have access to the attributes and functions of the PN532 RFID/NFC shield or breakout + .. code-block:: python - .. code-block:: python + i2c = busio.I2C(board.SCL, board.SDA) + reset_pin = DigitalInOut(board.D6) + # On Raspberry Pi, you must also connect a pin to P32 "H_Request" for hardware + # wakeup! this means we don't need to do the I2C clock-stretch thing + req_pin = DigitalInOut(board.D12) + pn532 = PN532_I2C(i2c, debug=False, reset=reset_pin, req=req_pin) + # Configure PN532 to communicate with MiFare cards + pn532.SAM_configuration() - uid = pn532.read_passive_target(timeout=0.5) + Now you have access to the attributes and functions of the PN532 RFID/NFC + shield or breakout + + .. code-block:: python + + uid = pn532.read_passive_target(timeout=0.5) """ self.debug = debug diff --git a/adafruit_pn532/spi.py b/adafruit_pn532/spi.py index ad58fc1..18857b2 100644 --- a/adafruit_pn532/spi.py +++ b/adafruit_pn532/spi.py @@ -64,14 +64,14 @@ class PN532_SPI(PN532): """Create an instance of the PN532 class using SPI Optional IRQ pin (not used) - :param busio.SPI spi: The spi bus the PN532 is connected to. - :param DigitalInOut cs: board pin the PN532 chip select line is connected to - :param DigitalInOut irq: board pin the PN532 P32 is connected to - :param DigitalInOut reset: board pin the PN532 reset is connected to - :param bool debug: if true print additional debug statements + :param ~busio.SPI spi: The spi bus the PN532 is connected to. + :param digitalio.DigitalInOut cs: board pin the PN532 chip select line is connected to + :param digitalio.DigitalInOut irq: board pin the PN532 P32 is connected to + :param digitalio.DigitalInOut reset: board pin the PN532 reset is connected to + :param bool debug: if True print additional debug statements. Defaults to False **Quickstart: Importing and using the device** - Here is an example of using the :class:`PN532_I2C` class. + Here is an example of using the :class:`PN532_SPI` class. First you will need to import the libraries to use the sensor .. code-block:: python @@ -82,13 +82,15 @@ class PN532_SPI(PN532): from adafruit_pn532.spi import PN532_SPI Once this is done you can define your `busio.SPI` object and define your PN532 object + .. code-block:: python spi = busio.SPI(board.SCK, board.MOSI, board.MISO) cs_pin = DigitalInOut(board.D5) pn532 = PN532_SPI(spi, cs_pin, debug=False) - Now you have access to the attributes and functions of the PN532 RFID/NFC shield or breakout + Now you have access to the attributes and functions of the PN532 RFID/NFC + shield or breakout .. code-block:: python diff --git a/adafruit_pn532/uart.py b/adafruit_pn532/uart.py index 597b1c2..b99bf1c 100644 --- a/adafruit_pn532/uart.py +++ b/adafruit_pn532/uart.py @@ -38,32 +38,35 @@ class PN532_UART(PN532): """Create an instance of the PN532 class using Serial connection. Optional reset pin and debugging output. - :param busio.UART i2c: The I2C bus the PN532 is connected to. - :param DigitalInOut reset: board pin the PN532 reset is connected to - :param bool debug: if true print additional debug statements + :param ~busio.UART uart: The uart object the PN532 is connected to. + :param digitalio.DigitalInOut reset: board pin the PN532 reset is connected to + :param bool debug: if True print additional debug statements. Defaults to False **Quickstart: Importing and using the device** - Here is an example of using the :class:`PN532_I2C` class. - First you will need to import the libraries to use the sensor - .. code-block:: python + Here is an example of using the :class:`PN532_I2C` class. + First you will need to import the libraries to use the sensor - import board - import busio - from digitalio import DigitalInOut - from adafruit_pn532.uart import PN532_UART + .. code-block:: python - Once this is done you can define your `busio.UART` object and define your PN532 object - .. code-block:: python + import board + import busio + from digitalio import DigitalInOut + from adafruit_pn532.uart import PN532_UART - uart = busio.UART(board.TX, board.RX, baudrate=115200, timeout=0.1) - pn532 = PN532_UART(uart, debug=False) + Once this is done you can define your `busio.UART` object and define your PN532 object - Now you have access to the attributes and functions of the PN532 RFID/NFC shield or breakout + .. code-block:: python - .. code-block:: python + uart = busio.UART(board.TX, board.RX, baudrate=115200, timeout=0.1) + pn532 = PN532_UART(uart, debug=False) - uid = pn532.read_passive_target(timeout=0.5) + Now you have access to the attributes and functions of the PN532 RFID/NFC + shield or breakout + + .. code-block:: python + + uid = pn532.read_passive_target(timeout=0.5) """ self.debug = debug diff --git a/docs/conf.py b/docs/conf.py index 1d78ab7..4651af0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -39,6 +39,8 @@ intersphinx_mapping = { "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), } +autoclass_content = "both" + # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"]