CircuitPython module for the RFM95/6/7/8 LoRa wireless 433/915mhz packet radios.
Branch: master
Clone or download
siddacious Merge pull request #16 from brentru/improve-example
Example - show packet is received using the LED
Latest commit 0075f7a Dec 31, 2018
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs PyPi setup. Aug 7, 2018
examples pylint Dec 31, 2018
.gitignore PyPi setup. Aug 7, 2018
.pylintrc ignore the board module imports in .pylintrc Aug 25, 2018
.readthedocs.yml Initial commit. Mar 2, 2018
.travis.yml PyPi setup. Aug 7, 2018 updated CoC Aug 1, 2018
LICENSE Initial commit. Mar 2, 2018
README.rst change '' to '' Dec 21, 2018 fix possible bad packet handling Dec 30, 2018
requirements.txt PyPi setup. Aug 7, 2018 PyPi setup. Aug 7, 2018



Documentation Status Discord Build Status

CircuitPython module for the RFM95/6/7/8 LoRa 433/915mhz radio modules.


This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Example

See examples/ for a demo of the usage. Note: the default baudrate for the SPI is 50000000 (5MHz). The maximum setting is 10Mhz but transmission errors have been observed expecially when using breakout boards. For breakout boards or other configurations where the boards are separated, it may be necessary to reduce the baudrate for reliable data transmission. The baud rate may be specified as an keyword parameter when initializing the board. To set it to 1000000 use :

# Initialze RFM radio
rfm9x = adafruit_rfm9x.RFM9x(spi, CS, RESET, RADIO_FREQ_MHZ,baudrate=1000000)


Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

Zip release files

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-rfm9x --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.