2bndy5 / pyrf24 Goto Github PK

This is the official home of the python wrappers for the RF24 stack. It is meant for Linux-based SoC boards like the Raspberry Pi.

The nRF24L01's CE and IRQ pins can be connected to other GPIO pins on the SoC. The MISO, MOSI, SCK are limited to the corresponding counterparts on the SoC's SPI bus. The CSN pin is limited to the chosen SPI bus's "Chip Select" options (Also labeled as "CE" pins on many Raspberry Pi pinout diagrams). The following table shows the default pins used in all the examples for this package.

The IRQ pin is not typically connected, and it is only used in the interrupt_configure example.

To build this python package locally, you need to have boost.python installed.

sudo apt install libboost-python-dev

Make sure that the following dependencies are also installed (sometimes the OS comes with these included). Notice that RPi.GPIO (for python) is used to manage the GPIO pins on the Raspberry Pi.

sudo apt install python3-dev python3-setuptools python3-rpi.gpio

Before submitting contributions, you should make sure that any documentation changes builds successfully. This can be done locally.

This package's documentation is built with the python package Sphinx and the readthedocs theme for sphinx.

pip3 install Sphinx sphinx-rtd-theme

To build the documentation locally:

cd docs
sphinx-build -E -W . _build

The docs/_build folder should now contain the html files that would be hosted on deployment. Direct your internet browser to the html files in this folder to make sure your changes have been rendered correctly.