Skip to main content

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

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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

Dependencies

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.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-rfm9x

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-rfm9x

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-rfm9x

Usage Example

Initialization of the RFM radio requires specifying a frequency appropriate to your radio hardware (i.e. 868-915 or 433 MHz) and specifying the pins used in your wiring from the controller board to the radio module.

This example code matches the wiring used in the LoRa and LoRaWAN Radio for Raspberry Pi project:

import digitalio
import board
import busio
import adafruit_rfm9x

RADIO_FREQ_MHZ = 915.0
CS = digitalio.DigitalInOut(board.CE1)
RESET = digitalio.DigitalInOut(board.D25)
spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
rfm9x = adafruit_rfm9x.RFM9x(spi, CS, RESET, RADIO_FREQ_MHZ)

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 with a more conservative baudrate
rfm9x = adafruit_rfm9x.RFM9x(spi, CS, RESET, RADIO_FREQ_MHZ, baudrate=1000000)

Optional controls exist to alter the signal bandwidth, coding rate, and spreading factor settings used by the radio to achieve better performance in different environments. By default, settings compatible with RadioHead Bw125Cr45Sf128 mode are used, which can be altered in the following manner (continued from the above example):

# Apply new modem config settings to the radio to improve its effective range
rfm9x.signal_bandwidth = 62500
rfm9x.coding_rate = 6
rfm9x.spreading_factor = 8
rfm9x.enable_crc = True

See examples/rfm9x_simpletest.py for an expanded demo of the usage.

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_rfm9x-2.2.20.tar.gz (36.1 kB view details)

Uploaded Source

Built Distribution

adafruit_circuitpython_rfm9x-2.2.20-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file adafruit_circuitpython_rfm9x-2.2.20.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_rfm9x-2.2.20.tar.gz
Algorithm Hash digest
SHA256 7b62d3537ce59e0044146766f5d136c4523ac9864c9518abcc2c4a1519729fc0
MD5 592c10025a587e843db7e76d9fe2acbe
BLAKE2b-256 725c59580824c8c24cbe8ba4bb7bee597f3d03491e34bb7274cba39b03d26c1e

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_rfm9x-2.2.20-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_rfm9x-2.2.20-py3-none-any.whl
Algorithm Hash digest
SHA256 438e7b4bd44b7d96bab3281e1f114e49ccf1622f41da23f4a98cb5c64581a035
MD5 42fc3be76843823d7ad4e23c9027ff1e
BLAKE2b-256 f9c6cba6b75ed732dcd9e30a60ad71202780991de0bffd54965801814bba4409

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page