diff --git a/README.rst b/README.rst index 9cede0e..517efe3 100644 --- a/README.rst +++ b/README.rst @@ -170,12 +170,14 @@ same version of CPython, CPU architecture, and C standard lib. - ``ARCH`` is the architecture type of the CPU. This corresponds to the compiler used. On Raspberry Pi OS (32 bit), this will be ``armv7l``. +.. _using-specific-driver: + Using a specific RF24 driver ---------------------------- -By default, this package is built using the RF24 driver SPIDEV. If you want to build the -package using a different RF24 driver (like ``RPi``, ``MRAA``, ``wiringPi``, etc), then -it is necessary to use an environment variable containing additional arguments for CMake: +By default, this package is built using the RF24 driver ``SPIDEV``. If you want to build the +package using a different RF24 driver (like ``RPi``, ``MRAA``, ``wiringPi``, or ``pigpio``), +then it is necessary to use an environment variable containing additional arguments for CMake: .. code-block:: bash diff --git a/docs/rf24_api.rst b/docs/rf24_api.rst index 458f4ff..4b3d467 100644 --- a/docs/rf24_api.rst +++ b/docs/rf24_api.rst @@ -5,6 +5,19 @@ RF24 API .. automodule:: pyrf24.rf24 + .. autoattribute:: pyrf24.rf24.RF24_DRIVER + + This `str` describes the backend driver used to build the pyrf24 package. + If installed from pypi, then this value should be ``"SPIDEV"``. + + All other drivers imply that the pyrf24 package was built from source + :ref:`using-specific-driver`. + + .. hint:: + + Use this attribute to determine programmatically which pin numbers to use. + Drivers like ``wiringPi`` and ``MRAA`` use their own pin numbering scheme. + Enum classes ------------