abstract related pages from header

convert _SPI calls to pointers where applicable

typo made BCM driver fail

overload begin() and amended docs about begin()

fix faulty #ifdef logic

doxygen v1.9.1 deprecated COLS_IN_ALPHA_INDEX tag

bump version to v1.4.0

exclude only RF24_LINUX

apply ptr treatment to Teensy, LittleWire, & Due

trigger ArduinoCLI action

doxygen action shouldn't create a docs folder

no need to specify output dir in doxygen action

make my life simpler: use new RF24_SPI_PTR macro

trigger ArduinoCLI action

forgot about c'tor; fix 2-space indent in begin()

abstract SPI::begin() from _init_pins()

adjust csn_pin before SPI.begin() on BCM driver

conforming whitespace

add printf.h fix from @TonioChingon in nRF24#739

rename atxmega.md & add link to supported product

add Due to ArduinoCLI action

fix teensy support; add PIO CI for teensy

[PIO CI] use quoted matrix entries

[PIO CI] use single quotes?

I hate YML

Gimme that badge

add MRAA to Linux CI action

typo

[Linux CI] MRAA install needs special permission

try with "sudo bash -c"

[Linux CI] MRAA not cross compiling (I think)

add example code snippets to Arduino support pg

doc typos

Due can't use SPI_PTR; delete ATXMEGA/readme.md
(use docs/atxmega.md instead)

fix nRF24#414; note need mbed example in arduino.md

fix printf() only for adafruit/ArduinoCore-SAMD

add msg about COMMON_ISSUES to README

add estimated mbed example to arduino.md

avr/pgmspace.h was added to Due core in 2013

oops, undo my testing change

remove useless Due config file nRF24#752

ammend support for SPI_UART in csn()

Confirm working 2nd SPI bus on esp8266 nRF24#648

fix indent

c-n-p artifact; more indent inconcsistencies

comment out theroretical example snippets

add pinout img from RF24Audio repo

doxygen sux at reading imgs

implement nRF24#539

my CnP skills are lacking

need to test py wrapper

[py_wrap] begin fails to compile

[py wrap] oops left the old begin still in there

[py wrap] use thin wrapper for begin_w/_pins

[pr wrap] try explicit begin(void)

boost.py docs suck

[py wrap] try using same name for begin(pin, pin)

[py wrap] c'tor overload is bad

[py wrap] "optional<>" template didn't take

[py wrap] unmatched parenthesis

advise that teensy doesn't need overloaded begin()

docs review

.github/workflows/build_arduino.yml

@@ -82,6 +82,7 @@ jobs:
  - "arduino:samd:tian"
  - "arduino:megaavr:uno2018"
  # - "arduino:megaavr:nano4809" # board not found
+ - "arduino:sam:arduino_due_x_dbg"
 
  steps:
  - name: Checkout
@@ -97,6 +98,7 @@ jobs:
  - examples/StreamingData
  - examples/MulticeiverDemo
  - examples/InterruptConfigure
+ # The following examples still exist for posterity
  # - examples/old_backups/GettingStarted_HandlingFailures
  # - examples/old_backups/pingpair_dyn
  # - examples/old_backups/pingpair_irq

.github/workflows/build_linux.yml

@@ -15,6 +15,7 @@ jobs:
  - "--soc=BCM2836 --driver=RPi"
  # - "--soc=BCM2835 --driver=wiringPi --extra-cflags=-I/usr/local/include"
  - "--driver=SPIDEV"
+ # - "--driver=MRAA"
 
  steps:
  - uses: actions/checkout@v1
@@ -24,14 +25,24 @@ jobs:
  sudo apt-get install binutils-arm-linux-gnueabi gcc-arm-linux-gnueabihf g++-arm-linux-gnueabihf
  arm-linux-gnueabihf-gcc -v
  arm-linux-gnueabihf-g++ -v
- python3 --version
  - name: provide WiringPi
  if: ${{ matrix.config-options == '--soc=BCM2835 --driver=wiringPi --extra-cflags=-I/usr/local/include' }}
  run: |
  git clone https://github.com/WiringPi/WiringPi
  cd WiringPi/wiringPi
  CC="arm-linux-gnueabihf-gcc -marm -mtune=arm1176jzf-s -mfpu=vfp -mfloat-abi=hard" V=1 make -j5
  sudo make install
+ - name: provide MRAA
+ if: ${{ matrix.config-options == '--driver=MRAA' }}
+ run: |
+ git clone https://github.com/intel-iot-devkit/mraa.git
+ cd mraa
+ mkdir build
+ cd build
+ cmake .. -DBUILDSWIGNODE=OFF
+ sudo make install
+ sudo bash -c 'echo "/usr/local/lib/arm-linux-gnueabihf" >> /etc/ld.so.conf'
+ sudo ldconfig
  - name: library configure
  run: ./configure ${{ matrix.config-options }}
  - name: library make
@@ -40,7 +51,7 @@ jobs:
  run: sudo make install
  - name: make linux examples
  # compiling examples for wiringPi is broken see nRF24#669 issue
- if: ${{ matrix.config-options != '--soc=BCM2835 --driver=wiringPi --extra-cflags=-I/usr/local/include' }}
+ # if: ${{ matrix.config-options != '--soc=BCM2835 --driver=wiringPi --extra-cflags=-I/usr/local/include' }}
  run: |
  cd examples_linux
  make

.github/workflows/build_platformIO.yml

@@ -0,0 +1,81 @@
+name: PlatformIO build
+
+on:
+ pull_request:
+ paths:
+ - ".github/workflows/build_platformIO.yml"
+ - "examples/**"
+ - "!examples/old_backups/recipes/pingpair_maple/**"
+
+ push:
+ paths:
+ - ".github/workflows/build_platformIO.yml"
+ - "examples/**"
+ - "!examples/old_backups/recipes/pingpair_maple/**"
+
+jobs:
+ check_formatting:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+ - name: Check code formatting
+ uses: per1234/artistic-style-action@main
+ with:
+ options-file-path: ./examples/examples_formatter.conf
+ name-patterns: |
+ - '*.ino'
+ - '*.cpp'
+ - '*.hpp'
+ - '*.h'
+ target-paths: |
+ - examples
+
+ build:
+ needs: check_formatting
+ runs-on: ubuntu-latest
+
+ strategy:
+ fail-fast: false
+
+ matrix:
+ example:
+ - "examples/GettingStarted/GettingStarted.ino"
+ - "examples/AcknowledgementPayloads/AcknowledgementPayloads.ino"
+ - "examples/ManualAcknowledgements/ManualAcknowledgements.ino"
+ - "examples/StreamingData/StreamingData.ino"
+ - "examples/MulticeiverDemo/MulticeiverDemo.ino"
+ - "examples/InterruptConfigure/InterruptConfigure.ino"
+ board:
+ - "teensy31"
+ - "teensy35"
+ - "teensy36"
+ - "teensy40"
+ - "teensy41"
+ - "teensylc"
+
+ steps:
+ - uses: actions/checkout@v2
+ - name: Cache pip
+ uses: actions/cache@v2
+ with:
+ path: ~/.cache/pip
+ key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+ restore-keys: |
+ ${{ runner.os }}-pip-
+ - name: Cache PlatformIO
+ uses: actions/cache@v2
+ with:
+ path: ~/.platformio
+ key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
+ - name: Set up Python
+ uses: actions/setup-python@v2
+ - name: Install PlatformIO
+ run: |
+ python -m pip install --upgrade pip
+ pip install --upgrade platformio
+ - name: Run PlatformIO
+ run: pio ci --lib="." --board=${{ matrix.board }}
+ env:
+ PLATFORMIO_CI_SRC: ${{ matrix.example }}

.github/workflows/doxygen.yml

@@ -28,10 +28,8 @@ jobs:
  uses: actions/checkout@v2
  - name: overwrite doxygen tags
  run: |
- mkdir docs
  touch doxygenAction
  echo "PROJECT_NUMBER = ${{ steps.latest_ver.outputs.release }}" >> doxygenAction
- echo "OUTPUT_DIRECTORY = ./docs" >> doxygenAction
  echo "@INCLUDE = doxygenAction" >> Doxyfile
  - name: build doxygen
  uses: mattnotmitt/doxygen-action@v1

.gitignore

@@ -3,7 +3,8 @@
 .*.swp
 *.orig
 .swp
-docs/
+docs/html/
+docs/xml/
 output/
 ojam/
 out/
@@ -32,4 +33,5 @@ examples_linux/**/*
 doxygenAction
 .vscode/
 *venv
+*env
 *.pyc

Doxyfile

@@ -825,7 +825,8 @@ WARN_LOGFILE =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT = ./ \
- ./utility/Template
+ ./utility/Template \
+ ./docs
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -967,7 +968,7 @@ EXAMPLE_RECURSIVE = YES
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH =
+IMAGE_PATH = images
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1023,7 +1024,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = ./docs/main_page.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
@@ -1151,13 +1152,6 @@ CLANG_DATABASE_PATH =
 
 ALPHABETICAL_INDEX = YES
 
-# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
-# which the alphabetical index list will be split.
-# Minimum value: 1, maximum value: 20, default value: 5.
-# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
-
-COLS_IN_ALPHA_INDEX = 10
-
 # In case all classes in a project start with a common prefix, all classes will
 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
 # can be used to specify a prefix (or a list of prefixes) that should be ignored
@@ -2207,7 +2201,7 @@ INCLUDE_FILE_PATTERNS =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED =
+PREDEFINED = DOXYGEN_FORCED
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The
@@ -2583,4 +2577,3 @@ GENERATE_LEGEND = YES
 # This tag requires that the tag HAVE_DOT is set to YES.
 
 DOT_CLEANUP = YES
-

README.md

@@ -1,6 +1,11 @@
 [![Arduino CLI build](https://github.com/nRF24/RF24/workflows/Arduino%20CLI%20build/badge.svg)](https://github.com/nRF24/RF24/actions?query=workflow%3A%22Arduino+CLI+build%22)
 [![Linux build](https://github.com/nRF24/RF24/workflows/Linux%20build/badge.svg)](https://github.com/nRF24/RF24/actions?query=workflow%3A%22Linux+build%22)
+[![PlatformIO build](https://github.com/nRF24/RF24/actions/workflows/build_platformIO.yml/badge.svg)](https://github.com/nRF24/RF24/actions/workflows/build_platformIO.yml)
 
 # See http://nRF24.github.io/RF24 for all documentation
 
-### Check our [contributing guidelines](CONTRIBUTING.md) before opening a pull request
+## Having problems?
+Please read our **[solutions to common problems](COMMON_ISSUES.md)**. If that doesn't help, then open an issue describing your problem with as much detail as possible.
+
+### Want to contribute?
+Awesome! However, please check our [contributing guidelines](CONTRIBUTING.md) before opening a pull request.