Introduction
CircuitPython RFM69 packet radio module. This supports basic RadioHead-compatible sending and receiving of packets with RFM69 series radios (433/915Mhz).
Warning
This is NOT for LoRa radios!
Note
This is a ‘best effort’ at receiving data using pure Python code–there is not interrupt support so you might lose packets if they’re sent too quickly for the board to process them. You will have the most luck using this in simple low bandwidth scenarios like sending and receiving a 60 byte packet at a time–don’t try to receive many kilobytes of data at a time!
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-rfm69
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-rfm69
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-rfm69
Usage Example
See examples/rfm69_simpletest.py for a simple demo of the usage. Note: the default baudrate for the SPI is 2000000 (2MHz). 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)
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.
Table of Contents
Examples
API Reference
adafruit_rfm69
RFM69
RFM69.ack_delay
RFM69.ack_retries
RFM69.ack_wait
RFM69.bitrate
RFM69.destination
RFM69.encryption_key
RFM69.flags
RFM69.frequency_deviation
RFM69.frequency_mhz
RFM69.identifier
RFM69.idle()
RFM69.last_rssi
RFM69.listen()
RFM69.node
RFM69.operation_mode
RFM69.packet_sent()
RFM69.payload_ready()
RFM69.preamble_length
RFM69.receive()
RFM69.receive_timeout
RFM69.reset()
RFM69.rssi
RFM69.send()
RFM69.send_with_ack()
RFM69.set_boost()
RFM69.sleep()
RFM69.sync_word
RFM69.temperature
RFM69.transmit()
RFM69.tx_power
RFM69.xmit_timeout
check_timeout()
ticks_diff()
Related Products
- Adafruit RFM69HCW Transceiver Radio Breakout - 868 or 915 MHz - RadioFruit
- Adafruit RFM69HCW Transceiver Radio Breakout - 433 MHz - RadioFruit
- Adafruit Feather M0 RFM69HCW Packet Radio - 868 or 915 MHz - RadioFruit
- Adafruit Feather M0 RFM69HCW Packet Radio - 433 MHz - RadioFruit
- Adafruit Radio FeatherWing - RFM69HCW 900MHz - RadioFruit
- Adafruit Radio FeatherWing - RFM69HCW 433MHz - RadioFruit