2.1.4 - Moved pylint from build.yml to .pre-commit-config.yml

To use in CircuitPython, simply install the Adafruit CircuitPython bundle.

To use in CPython, pip3 install adafruit-circuitpython-rfm9x.

Read the docs for info on how to use it.

2.1.3 - Fixed issue with Black and Pylint versions in the pre-commit config

To use in CircuitPython, simply install the Adafruit CircuitPython bundle.

To use in CPython, pip3 install adafruit-circuitpython-rfm9x.

Read the docs for info on how to use it.

Add SNR property

Adds snr and last_snr properties -- similar to rssi and last_rssi.

To use in CircuitPython, simply install the Adafruit CircuitPython bundle.

To use in CPython, pip3 install adafruit-circuitpython-rfm9x.

Read the docs for info on how to use it.

2.1.1 - Moved to pre-commit, added licensing info

pre-commit has been added to the GitHub Actions workflow in this repository. pre-commit allows you to run multiple checks, such as black and checking the REUSE licensing compliance, both locally and on GitHub Actions with one command.

You can run pre-commit locally with pre-commit run --all-files

To use in CircuitPython, simply install the Adafruit CircuitPython bundle.

To use in CPython, pip3 install adafruit-circuitpython-rfm9x.

Read the docs for info on how to use it.

Correct RSSI calculation -- implement errata

implement changes per the errata in https://semtech.my.salesforce.com/sfc/p/#E0000000JelG/a/2R000000HSPv/sqi9xX0gs6hgzl2LoPwCK0TS9GDPlMwsXmcNzJCMHjw

added a new kwarg "agc" which can be set to enable the automatic Gain Control - Default is False to disable so there is no change to existing behavior.
The only change to existing behavior is to set bit 7 of Register 0x31 per the errata. For all BW except 500K it is now set to 0.

To address some of the items in #51 several new attributes were added:
auto_agc -- set via agc kwarg or can be set manually after init
low_datarate_optimize - defaults to 0 can be set if desired
lna_boost_hf -- defaults to 0 (off) nay be set to 3 to enable
auto_ifon -- controls bit 7 of register 0x31 (used internally when setting BW)
detection_optimize - (use internally when setting SF)

To use in CircuitPython, simply install the Adafruit CircuitPython bundle.

To use in CPython, pip3 install adafruit-circuitpython-rfm9x.

Read the docs for info on how to use it.

2.0.4 - Remove old PyLint Directive

To use in CircuitPython, simply install the Adafruit CircuitPython bundle.

To use in CPython, pip3 install adafruit-circuitpython-rfm9x.

Read the docs for info on how to use it.

Revise RESET

The reset sequence has been revised to remove the need for internal Pull-Up resistors.
No changes to user code necessary.
This is consistent with the TinyLoRa,RFM69 and Arfduino Radiohead library implementations.
To keep the RST line High during normal use, Instead of switching to an input with a Pull-Up enabled, it is kept as an output and set High.

2.0.2 - Fixed discord invite link

To use in CircuitPython, simply install the Adafruit CircuitPython bundle.

To use in CPython, pip3 install adafruit-circuitpython-rfm9x.

Read the docs for info on how to use it.

2.0.1 - Reduced code size

To use in CircuitPython, simply install the Adafruit CircuitPython bundle.

To use in CPython, pip3 install adafruit-circuitpython-rfm9x.

Read the docs for info on how to use it.

Implement Reliable Datagram Mode

Implemented compatibility with the RadioHead library "Reliable DataGram" mode.
Received packets are "ACKed" and Transmitted packets wait for ACK response.

BREAKING CHANGES

There are "breaking changes" for anyone that had been setting the RadioHead headers directly.
There are now attributes for setting the header parameters and the rx_filter parameter for the receive function has been removed.

for send() the kwarg tx_header has been replaced by 4 individual kwargs: destination, node, identifier, flags

It is not normally necessary use the destination, node, identifier or flags awards when calling send()
They should be set during initialization using the attributes node and destination as in the examples.
The identifier and flags attributes are set automatically when using send_with_ack()
For a non-acked send() they may be set manually either via the attributes or kwargs

send() now returns a boolean status - if True, the send was completed, if False, the send timed out. Previously a Runtime error was thrown on the time out.

Notes

It has been difficult to make this work reliably. Packets will still be missed occasionally but now they will be reported. There are attributes that can be "tweaked" to help

rfm9x.ack_delay -- set a delay before the ACK packet is sent - this is necessary when the receive unit an MCU communication to a Raspberry Pi . The MCU can send it's ACK packet before the Raspberry Pi has resumed "listening". The default setting is "None" but setting it to .1 seconds may be necessary. The Arduino RadioHead library does not allow for this "ack_delay" and it it may be difficult to get this to work, especially with a Raspberry Pi.

rfm9x.retries -- set the number of ack retries

All of the existing examples will still execute without change.

There are examples for using this mode in rfm9x_node1_ack.py and rfm9x_node2_ack.py

other new examples
rfm9x_header.py -- receive packets and display the header and packet contents
rfm9x_node1.py -- uses adresses without ACK
rfm9x_node2.py -- companion to rfm9x_node1.py
rfm9x_rpi_simpletest.py - no LED and set pins for RaspBerry Pi
rfm9x_node1_bonnet.py -- similar to rfm9x_node1.py but for use with RPi and bonnet -- uses buttons to send packets

To use in CircuitPython, simply install the Adafruit CircuitPython bundle.

To use in CPython, pip3 install adafruit-circuitpython-rfm9x.

Read the docs for info on how to use it.