RF24

What's Changed

• Update clang format by @2bndy5 in https://github.com/nRF24/RF24/pull/940
• Bump actions/checkout from 3 to 4 by @dependabot in https://github.com/nRF24/RF24/pull/941
• GPIO changes (RPi5 support) by @TMRh20 in https://github.com/nRF24/RF24/pull/942
• Docs: Byte alignment/packing mismatches by @TMRh20 in https://github.com/nRF24/RF24/pull/945
• Update COMMON_ISSUES re: write() function by @TMRh20 in https://github.com/nRF24/RF24/pull/947
• Docs: testRPD by @TMRh20 in https://github.com/nRF24/RF24/pull/948
• Update MRAA timer functions by @TMRh20 in https://github.com/nRF24/RF24/pull/950
• Modify Main docs page by @TMRh20 in https://github.com/nRF24/RF24/pull/951
• Fix for SPIDEV & MRAA: delayMicroseconds() by @TMRh20 in https://github.com/nRF24/RF24/pull/952
• Add delay to manualAcknowledgements example by @TMRh20 in https://github.com/nRF24/RF24/pull/953
• Fix for pigpio delayMicroseconds by @TMRh20 in https://github.com/nRF24/RF24/pull/954
• Link to new (CMake) installer by default by @TMRh20 in https://github.com/nRF24/RF24/pull/957
• separate ISR handling from IRQ processing by @2bndy5 in https://github.com/nRF24/RF24/pull/956
• Promiscuous scanners by @2bndy5 in https://github.com/nRF24/RF24/pull/955
• Update SPIDEV driver for Character Device v2 ABI; cache FDs by @2bndy5 in https://github.com/nRF24/RF24/pull/959
• IRQ support using Linux kernel Character Device + Posix threads by @2bndy5 in https://github.com/nRF24/RF24/pull/961
• cache gpio chip detection when properly initialized by @2bndy5 in https://github.com/nRF24/RF24/pull/962
• use quotes for linux/gpio.h include by @2bndy5 in https://github.com/nRF24/RF24/pull/963
• Add link to RF24G library in docs by @TMRh20 in https://github.com/nRF24/RF24/pull/964
• revise MRAA driver's GPIO implementation by @2bndy5 in https://github.com/nRF24/RF24/pull/966
• update python wrapper/examples/doc by @2bndy5 in https://github.com/nRF24/RF24/pull/967
• wrap MRAA lib's Gpio::isr() for IRQ support by @2bndy5 in https://github.com/nRF24/RF24/pull/970
• Use BCM2835 lib's Edge Detection Status for IRQ support by @2bndy5 in https://github.com/nRF24/RF24/pull/969
• wrap wiringPiISRStop() in driver API by @2bndy5 in https://github.com/nRF24/RF24/pull/968
• disable auto-detect driver and default to SPIDEV by @2bndy5 in https://github.com/nRF24/RF24/pull/973

New Contributors

• @dependabot made their first contribution in https://github.com/nRF24/RF24/pull/941

Full Changelog: https://github.com/nRF24/RF24/compare/v1.4.8...v1.4.9

What's Changed

• Mention RPi Pico board's 3v regulator in Pico SDK doc by @2bndy5 in https://github.com/nRF24/RF24/pull/915
• fix #913 by @2bndy5 in https://github.com/nRF24/RF24/pull/914
• Update COMMON_ISSUES.md by @TMRh20 in https://github.com/nRF24/RF24/pull/918

Full Changelog: https://github.com/nRF24/RF24/compare/v1.4.7...v1.4.8

What's Changed

• Doc tweaks and reusable CI by @2bndy5 in https://github.com/nRF24/RF24/pull/887
• Reworked the utility/rp2 SPI class and removed static members by @TheGarkine in https://github.com/nRF24/RF24/pull/892
• solve #894 by @2bndy5 in https://github.com/nRF24/RF24/pull/895
• Update pico_sdk.md to reflect changes to SPI with user-specified pins by @matt-walker0 in https://github.com/nRF24/RF24/pull/900
• [OrangePi Zero] Linux chip enable conditional statement by @fertinator in https://github.com/nRF24/RF24/pull/904
• Alias gpio pin datatype by @2bndy5 in https://github.com/nRF24/RF24/pull/898

New Contributors

• @TheGarkine made their first contribution in https://github.com/nRF24/RF24/pull/892
• @fertinator made their first contribution in https://github.com/nRF24/RF24/pull/904

Full Changelog: https://github.com/nRF24/RF24/compare/v1.4.6...v1.4.7

What's Changed

• Fix Raspberry Pi company name (in docs) by @lurch in https://github.com/nRF24/RF24/pull/858
• make utilities/CMakeLists.txt respect RF24_NO_IRQ by @2bndy5 in https://github.com/nRF24/RF24/pull/859
• adjust writeFast docs by @2bndy5 in https://github.com/nRF24/RF24/pull/866
• add manual trigger to docs CI by @2bndy5 in https://github.com/nRF24/RF24/pull/868
• Fix pgm_read_ptr(): 'const void*' is not a pointer-to-object type by @bblanchon in https://github.com/nRF24/RF24/pull/864
• Fix pgm_read_byte/word() definitions by @2bndy5 in https://github.com/nRF24/RF24/pull/871
• add printf support to ESP32/8266 and arduino-pico cores by @2bndy5 in https://github.com/nRF24/RF24/pull/873

New Contributors

• @lurch made their first contribution in https://github.com/nRF24/RF24/pull/858
• @bblanchon made their first contribution in https://github.com/nRF24/RF24/pull/864

Full Changelog: https://github.com/nRF24/RF24/compare/v1.4.5...v1.4.6

• All single line loops and conditions use curly brackets
• Moved preprocessor directives about sprintf() to respective arch_configs

Full Changelog: https://github.com/nRF24/RF24/compare/v1.4.4...v1.4.5

• Fix data corruption issues #854

EDIT: This did not fix the mentioned issue as intended. Please use v1.4.5 instead

What's Changed

• fix recieved -> received typos by @prawnpie in https://github.com/nRF24/RF24/pull/817
• Updated common issues added issues and fixes by @matt-walker0 in https://github.com/nRF24/RF24/pull/820
• add support for sprintf by @dstroy0 in https://github.com/nRF24/RF24/pull/821
• add new feature encodeRadioDetails and optimize sprintfPrettyDetails by @dstroy0 in https://github.com/nRF24/RF24/pull/825
• PIGPIO support for IRQ feature (now that wiringPi is no longer shipped with RPi OS) @TMRh20 in https://github.com/nRF24/RF24/pull/819
• Update printf.h to include megaAVR by @Cobalt6700 in https://github.com/nRF24/RF24/pull/843
• various improvements to docs by @2bndy5 in https://github.com/nRF24/RF24/pull/844
• Clang format by @2bndy5 in https://github.com/nRF24/RF24/pull/824
• Add isFifo() methods by @2bndy5 in https://github.com/nRF24/RF24/pull/849
• add model variant info to printPrettyDetails() by @2bndy5 in https://github.com/nRF24/RF24/pull/850
• Update py examples by @2bndy5 in https://github.com/nRF24/RF24/pull/851

New Contributors

• @prawnpie made their first contribution in https://github.com/nRF24/RF24/pull/817
• @dstroy0 made their first contribution in https://github.com/nRF24/RF24/pull/821
• @Cobalt6700 made their first contribution in https://github.com/nRF24/RF24/pull/843

Full Changelog: https://github.com/nRF24/RF24/compare/v1.4.2...v1.4.3

• new Sphinx docs generation (currently hosted on https://rf24.rtfd.io)
• Update documentation
• RP2040 support
• CMake support
• Example touch-ups
• add new toggleAllPipes() function (as opposed to individually opening/closing pipes)
• add new function setRadiation() function (which combines setPALevel() and setDataRate() into 1 SPI transaction)
• add toggleAllPipes() and setRadiation() to python wrapper
• improved all CI workflows

Warning for installing from the packaged release assets (.deb or .rpm files below)

If you have previously installed the library from source code using the traditional ./configure; make; sudo make install, then you will need to uninstall it manually to avoid runtime conflicts.

sudo rm /usr/local/lib/librf24.*
sudo rm /usr/local/lib/librf24-bcm.so
sudo rm -r /usr/local/include/RF24

This is because the Linux package manager puts the newly installed library into a /usr/lib and /usr/include folders. Installing from source will put the lib in /usr/local/lib and /usr/local/include folders.

This release reverts the changes made to SoftSPI implementation in v1.4.0. Also has a slight adjustment of a code snippet in the docs. Thank you @bifferos

Overloaded begin()

• new overloaded begin(_SPI*) function for Arduino based platforms (but not Due, ATTiny, LittleWire, or SPI_UART) that allows the user to specify a non-default SPI bus object
  1. /docs/arduino.md has example snippets for
     • NodeMCU (using pins' on-board labels via macros from the ESP8266 Arduino core)
     • ESP32 (generic)
     • Teensy (generic) - though I don't think teensy users need to use the overloaded begin(_SPI*) (as demonstrated in example snippet)
  2. The SPIClass::begin() function must be called before calling RF24::begin() as warned in /docs/arduino.md page and the RF24::begin(_SPI*) function's docs (which also defers to the Arduino support page).
  3. A new macro RF24_SPI_PTR which is only defined when _SPI is used as a datatype (as opposed to the actual SPI object for a platform).
• new overloaded begin(_cepin, _cspin) to implement feature request from #539. This applies to all supported platforms. This implementation also provides an overloaded c'tor that accepts only the _spi_speed parameter (that still defaults to RF24_SPI_SPEED - so it could essentially be used as an empty c'tor). Note that begin() returns false if CE & CSN pins are never specified (either with c'tor or new overloaded begin(_cepin, _cspin)/begin(_SPI*, _cepin, _cspin) methods). This feature is extended to the python wrapper as well.
• new additionally overloaded begin(_SPI*, _cepin, _cspin) on Arduino based platforms (but not Due, ATTiny, LittleWire, or SPI_UART) to allow also specifying a SPI bus from feature request #743 when combined with feature request from #539

Patch updates

• fix releases for PlatformIO (a missing comma prevented v1.3.12 from showing in PlatformIO)
• abstract docs (main page and all "Related Pages" now live in the docs folder)
• added fix for mbed platform about printf.h from @TonioChingon in #739
• added fix for #414 to RF24_config.h concerning ARDUINO_ARCH_SAMD about internally using printf(). This fix is only appicable to the adafruit fork of the ArduinoCore-samd. Original ArduinoCore-samd does not use avr/pgmspace.h and doesn't declare printf() as accessible method from the Serial object(s).
• Removed useless /utility/Due/R24_arch_config.h file and fixed missing avr/pgmspace.h for Arduino Due (pgmspace was added back into the Due core in 2013).
• added Arduino Due to the ArduinoCLI workflow. Also introduced a new workflow that uses PlatformIO to test the examples on the Teensy platform (thus the new badge in the README).
• amended isValid() to check if private members ce_pin & csn_pin are 0xFFFF because it seems it wasn't updated when the c'tor parameters changed their datatype from uint8_t to uint16_t

• Fix millis() issues for Linux devices
• fixed inaccuracies in the new printPrettyDetails() (concerning "Primary Role" and "Auto-ACK" outputs)
• added C++ style functions to python wrapper instead of relying on python style attributes (concerns payloadSize and channel)
• setRetries() now properly clamps input values to valid range (not just truncate unused bits)
• addressed community concerns about backwards compatibility with begin() and enableAckPayload()
• added STM32 as a supported platform for PlatformIO

Docs changes

• fix link to littlewire website
• fix links to datasheets (links' text/src was backwards in only v1.3.11)
• main page now refers to this GitHub release page for list of changes
• explicitly indicate that ATTiny2313 is unsupported due to insufficient memory capacity
• added info about using PA/LNA modules to COMMON_ISSUES.md

• Note: stopListening() must be called before write()
• New examples
• Improvements to underlying functions
• New printPrettyDetails() function
• Many many changes, see https://github.com/nRF24/RF24/pull/691

Fix broken compilation for some devices due to recent changes

• Introduces change that mainly reduces the time required to call startListening(), powerUp(), and powerDown()
• Affects speed of switching from TX->RX. Users might consider starting updates of slower devices with this release to prevent missed packets when similar changes are introduced, affecting switching from RX->TX
• Clean up begin() function (reduce program size)

• Very important bug fix for startWrite() function. Affected entire RF24 communication stack in a
  number of ways.
• Unify Arduino and Linux constructor to both accept SPI Speed in Hz as optional note: Only works
  with Arduino devices that support SPI Transactions, otherwise a set clock divider is used
• The old way of setting SPI speeds using BCM2835 driver enums has been removed
• printDetails() function: Removed BCM2835 constants, display CE,CSN & SPI Speed on all Linux devices
  and SPI Speed on Arduino devices
• Cleanup Linux examples to reflect removal of BCM2835 SPI Speed constants from BCM driver and RF24
• Update to latest BCM2835 driver, separate millis() from BCM driver for easier future updates
• Fix bug with RPi millis() code
• Added Constant Carrier Wave support. startConstCarrier & stopConstCarrier functions and added new
  functionality to scanner example
• Modify setPALevel() function to allow setting of LNA gain via optional parameter
• Remove ancient files from RF24 examples
• Cleanup of warnings & errors

Arduino:
Fix problems with detection of SPI_HAS_TRANSACTION define affecting a number of platforms including Arduino Uno, ESP32, STM32 etc. Problems getting the driver working or working along with other SPI devices should be resolved with this update.

Linux:
Update Linux SPI drivers to support setting the SPI speed in HZ. RF24 radio(22,0,8000000); will configure a speed of 8Mhz or users can modify RF24_config.h #define RF24_SPI_SPEED to set a default for all devices.

Linux:
Support multiple instances of SPIDEV
Minor fixes/changes

Arduino:
Fix ESP32 progmem error/warning
Cleanup/Update some examples & printf usage
Revert compatibility changes for digitalWrite required due to the new API due to support being added for the 'old' methods
Minor bug fixes

• MegaAVR fixes
• Raspberry Pi 4 & 1 fixes
• Added function to get ARC
• Made RF24 return an exception when not ran as privileged user
• Other small improvements

• ESP 32 compatibility fixes
• Bug fixes and improvements