From 55b034eeb20c5bc838b7dc5d433162b8180860b8 Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Wed, 30 Sep 2015 23:19:51 -0600 Subject: [PATCH 1/2] Rename arch folder to utility Rename arch folder for attempted compatibility with Arduino Library Manager --- Makefile | 2 +- Makefile.littlewire | 2 +- RF24.h | 16 ++++++++-------- RF24_config.h | 10 +++++----- library.properties | 9 +++++++++ {arch => utility}/ATTiny/RF24_arch_config.h | 0 {arch => utility}/ATTiny/spi.h | 0 {arch => utility}/BBB/RF24_arch_config.h | 0 {arch => utility}/BBB/compatibility.c | 0 {arch => utility}/BBB/compatibility.h | 0 {arch => utility}/BBB/gpio.cpp | 0 {arch => utility}/BBB/gpio.h | 0 {arch => utility}/BBB/includes.h | 0 {arch => utility}/BBB/spi.cpp | 0 {arch => utility}/BBB/spi.h | 0 {arch => utility}/Due/RF24_arch_config.h | 0 {arch => utility}/LittleWire/RF24_arch_config.h | 0 {arch => utility}/MRAA/RF24_arch_config.h | 0 {arch => utility}/MRAA/compatibility.c | 0 {arch => utility}/MRAA/compatibility.h | 0 {arch => utility}/MRAA/gpio.cpp | 0 {arch => utility}/MRAA/gpio.h | 0 {arch => utility}/MRAA/includes.h | 0 {arch => utility}/MRAA/spi.cpp | 0 {arch => utility}/MRAA/spi.h | 0 {arch => utility}/RPi/RF24_arch_config.h | 0 {arch => utility}/RPi/bcm2835.c | 0 {arch => utility}/RPi/bcm2835.h | 0 {arch => utility}/RPi/includes.h | 0 {arch => utility}/RPi/spi.cpp | 0 {arch => utility}/RPi/spi.h | 0 {arch => utility}/Teensy/RF24_arch_config.h | 0 {arch => utility}/Template/RF24_arch_config.h | 0 {arch => utility}/Template/compatibility.h | 0 {arch => utility}/Template/gpio.h | 0 {arch => utility}/Template/includes.h | 0 {arch => utility}/Template/spi.h | 0 37 files changed, 24 insertions(+), 15 deletions(-) create mode 100644 library.properties rename {arch => utility}/ATTiny/RF24_arch_config.h (100%) rename {arch => utility}/ATTiny/spi.h (100%) rename {arch => utility}/BBB/RF24_arch_config.h (100%) rename {arch => utility}/BBB/compatibility.c (100%) rename {arch => utility}/BBB/compatibility.h (100%) rename {arch => utility}/BBB/gpio.cpp (100%) rename {arch => utility}/BBB/gpio.h (100%) rename {arch => utility}/BBB/includes.h (100%) rename {arch => utility}/BBB/spi.cpp (100%) rename {arch => utility}/BBB/spi.h (100%) rename {arch => utility}/Due/RF24_arch_config.h (100%) rename {arch => utility}/LittleWire/RF24_arch_config.h (100%) rename {arch => utility}/MRAA/RF24_arch_config.h (100%) rename {arch => utility}/MRAA/compatibility.c (100%) rename {arch => utility}/MRAA/compatibility.h (100%) rename {arch => utility}/MRAA/gpio.cpp (100%) rename {arch => utility}/MRAA/gpio.h (100%) rename {arch => utility}/MRAA/includes.h (100%) rename {arch => utility}/MRAA/spi.cpp (100%) rename {arch => utility}/MRAA/spi.h (100%) rename {arch => utility}/RPi/RF24_arch_config.h (100%) rename {arch => utility}/RPi/bcm2835.c (100%) rename {arch => utility}/RPi/bcm2835.h (100%) rename {arch => utility}/RPi/includes.h (100%) rename {arch => utility}/RPi/spi.cpp (100%) rename {arch => utility}/RPi/spi.h (100%) rename {arch => utility}/Teensy/RF24_arch_config.h (100%) rename {arch => utility}/Template/RF24_arch_config.h (100%) rename {arch => utility}/Template/compatibility.h (100%) rename {arch => utility}/Template/gpio.h (100%) rename {arch => utility}/Template/includes.h (100%) rename {arch => utility}/Template/spi.h (100%) diff --git a/Makefile b/Makefile index 6c5ba8ca9..9b5e4d856 100644 --- a/Makefile +++ b/Makefile @@ -25,7 +25,7 @@ LIBNAME=$(LIB).so.1.0 HEADER_DIR=${PREFIX}/include/RF24 # The base location of support files for different devices -ARCH_DIR=arch +ARCH_DIR=utility # The default objects to compile OBJECTS=RF24.o spi.o diff --git a/Makefile.littlewire b/Makefile.littlewire index accaa685e..d6f25dce6 100644 --- a/Makefile.littlewire +++ b/Makefile.littlewire @@ -18,7 +18,7 @@ LIB=librf24 HEADER_DIR=${PREFIX}/include/RF24 LIB_DIR=$(PREFIX)/lib -DRIVER_DIR=arch/LittleWire +DRIVER_DIR=utility/LittleWire ifeq ($(shell uname), Linux) DYN_SUFFIX=so diff --git a/RF24.h b/RF24.h index c9afc46bb..d9a305200 100644 --- a/RF24.h +++ b/RF24.h @@ -18,7 +18,7 @@ #include "RF24_config.h" #if defined (RF24_LINUX) - #include "arch/includes.h" + #include "utility/includes.h" #elif LITTLEWIRE #include #elif defined SOFTSPI @@ -1333,7 +1333,7 @@ s * * * **March 2015**
* - Uses SPI transactions on Arduino - * - New layout for easier portability: Break out defines & includes for individual platforms to RF24/arch + * - New layout for easier portability: Break out defines & includes for individual platforms to RF24/utility * - MRAA support added ( Galileo, Edison, etc) * - BBB/Generic Linux support via spidev & MRAA * - Support for RPi 2 added @@ -1547,7 +1547,7 @@ s * * BeagleBone Black is supported via MRAA or SPIDEV. * * @note The SPIDEV option should work with most Linux systems supporting SPIDEV.
- * Users may need to edit the RF24/arch/BBB/spi.cpp file to configure the spi device. (Defaults: "/dev/spidev1.0"; or "/dev/spidev1.1"; ) + * Users may need to edit the RF24/utility/BBB/spi.cpp file to configure the spi device. (Defaults: "/dev/spidev1.0"; or "/dev/spidev1.1"; ) * *
* @section AutoInstall Automated Install @@ -1713,7 +1713,7 @@ s * * * Build using **spidev**: * - * 1. Edit the RF24/arch/BBB/spi.cpp file + * 1. Edit the RF24/utility/BBB/spi.cpp file * 2. Change the default device definition to @code this->device = "/dev/spidev0.0";; @endcode * 3. Run @code sudo make install -B RF24_SPIDEV=1 @endcode * 4. See the gettingstarted example for an example of pin configuration @@ -1829,13 +1829,13 @@ s * * @page Portability RF24 Portability * * The RF24 radio driver mainly utilizes the Arduino API for GPIO, SPI, and timing functions, which are easily replicated - * on various platforms.
Support files for these platforms are stored under RF24/arch, and can be modified to provide + * on various platforms.
Support files for these platforms are stored under RF24/utility, and can be modified to provide * the required functionality. * *
* @section Hardware_Templates Basic Hardware Template * - * **RF24/arch** + * **RF24/utility** * * The RF24 library now includes a basic hardware template to assist in porting to various platforms.
The following files can be included * to replicate standard Arduino functions as needed, allowing devices from ATTiny to Raspberry Pi to utilize the same core RF24 driver. @@ -1850,13 +1850,13 @@ s * * | your_custom_file.h | Provides access to custom drivers for spi,gpio, etc | * *
- * Examples are provided via the included hardware support templates in **RF24/arch**
+ * Examples are provided via the included hardware support templates in **RF24/utility**
* See the modules page for examples of class declarations * *
* @section Device_Detection Device Detection * - * 1. The main detection for Linux devices is done in the Makefile, with the includes.h from the proper hardware directory copied to RF24/arch/includes.h
+ * 1. The main detection for Linux devices is done in the Makefile, with the includes.h from the proper hardware directory copied to RF24/utility/includes.h
* 2. Secondary detection is completed in RF24_config.h, causing the include.h file to be included for all supported Linux devices
* 3. RF24.h contains the declaration for SPI and GPIO objects 'spi' and 'gpio' to be used for porting-in related functions. * diff --git a/RF24_config.h b/RF24_config.h index 95f95b804..9f36b153e 100644 --- a/RF24_config.h +++ b/RF24_config.h @@ -32,26 +32,26 @@ //Generic Linux/ARM and //http://iotdk.intel.com/docs/master/mraa/ #if ( defined (__linux) || defined (LINUX) ) && defined( __arm__ ) || defined(MRAA) // BeagleBone Black running GNU/Linux or any other ARM-based linux device - // The Makefile checks for bcm2835 (RPi) and copies the correct includes.h file to /arch/includes.h (Default is spidev config) + // The Makefile checks for bcm2835 (RPi) and copies the correct includes.h file to /utility/includes.h (Default is spidev config) // This behavior can be overridden by calling 'make RF24_SPIDEV=1' or 'make RF24_MRAA=1' // The includes.h file defines either RF24_RPi, MRAA or RF24_BBB and includes the correct RF24_arch_config.h file - #include "arch/includes.h" + #include "utility/includes.h" //ATTiny #elif defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) || defined(__AVR_ATtiny24__) || defined(__AVR_ATtiny44__) || defined(__AVR_ATtiny84__) #define RF24_TINY - #include "arch/ATTiny/RF24_arch_config.h" + #include "utility/ATTiny/RF24_arch_config.h" //LittleWire #elif defined(LITTLEWIRE) - #include "arch/LittleWire/RF24_arch_config.h" + #include "utility/LittleWire/RF24_arch_config.h" //Teensy #elif defined (TEENSYDUINO) - #include "arch/Teensy/RF24_arch_config.h" + #include "utility/Teensy/RF24_arch_config.h" //Everything else #else diff --git a/library.properties b/library.properties new file mode 100644 index 000000000..0918f621b --- /dev/null +++ b/library.properties @@ -0,0 +1,9 @@ +name=RF24 +version=1.02 +author=TMRh20 +maintainer=TMRh20 +sentence=A library for NRF24L01(+) communication. +paragraph=Optimized library for nRF24L01(+) that is simple to use for beginners, but yet offers a lot for advanced users. It also has a lot of good examples how to use the library. +category=Communication +url=http://tmrh20.github.io/RF24/ +architectures=avr diff --git a/arch/ATTiny/RF24_arch_config.h b/utility/ATTiny/RF24_arch_config.h similarity index 100% rename from arch/ATTiny/RF24_arch_config.h rename to utility/ATTiny/RF24_arch_config.h diff --git a/arch/ATTiny/spi.h b/utility/ATTiny/spi.h similarity index 100% rename from arch/ATTiny/spi.h rename to utility/ATTiny/spi.h diff --git a/arch/BBB/RF24_arch_config.h b/utility/BBB/RF24_arch_config.h similarity index 100% rename from arch/BBB/RF24_arch_config.h rename to utility/BBB/RF24_arch_config.h diff --git a/arch/BBB/compatibility.c b/utility/BBB/compatibility.c similarity index 100% rename from arch/BBB/compatibility.c rename to utility/BBB/compatibility.c diff --git a/arch/BBB/compatibility.h b/utility/BBB/compatibility.h similarity index 100% rename from arch/BBB/compatibility.h rename to utility/BBB/compatibility.h diff --git a/arch/BBB/gpio.cpp b/utility/BBB/gpio.cpp similarity index 100% rename from arch/BBB/gpio.cpp rename to utility/BBB/gpio.cpp diff --git a/arch/BBB/gpio.h b/utility/BBB/gpio.h similarity index 100% rename from arch/BBB/gpio.h rename to utility/BBB/gpio.h diff --git a/arch/BBB/includes.h b/utility/BBB/includes.h similarity index 100% rename from arch/BBB/includes.h rename to utility/BBB/includes.h diff --git a/arch/BBB/spi.cpp b/utility/BBB/spi.cpp similarity index 100% rename from arch/BBB/spi.cpp rename to utility/BBB/spi.cpp diff --git a/arch/BBB/spi.h b/utility/BBB/spi.h similarity index 100% rename from arch/BBB/spi.h rename to utility/BBB/spi.h diff --git a/arch/Due/RF24_arch_config.h b/utility/Due/RF24_arch_config.h similarity index 100% rename from arch/Due/RF24_arch_config.h rename to utility/Due/RF24_arch_config.h diff --git a/arch/LittleWire/RF24_arch_config.h b/utility/LittleWire/RF24_arch_config.h similarity index 100% rename from arch/LittleWire/RF24_arch_config.h rename to utility/LittleWire/RF24_arch_config.h diff --git a/arch/MRAA/RF24_arch_config.h b/utility/MRAA/RF24_arch_config.h similarity index 100% rename from arch/MRAA/RF24_arch_config.h rename to utility/MRAA/RF24_arch_config.h diff --git a/arch/MRAA/compatibility.c b/utility/MRAA/compatibility.c similarity index 100% rename from arch/MRAA/compatibility.c rename to utility/MRAA/compatibility.c diff --git a/arch/MRAA/compatibility.h b/utility/MRAA/compatibility.h similarity index 100% rename from arch/MRAA/compatibility.h rename to utility/MRAA/compatibility.h diff --git a/arch/MRAA/gpio.cpp b/utility/MRAA/gpio.cpp similarity index 100% rename from arch/MRAA/gpio.cpp rename to utility/MRAA/gpio.cpp diff --git a/arch/MRAA/gpio.h b/utility/MRAA/gpio.h similarity index 100% rename from arch/MRAA/gpio.h rename to utility/MRAA/gpio.h diff --git a/arch/MRAA/includes.h b/utility/MRAA/includes.h similarity index 100% rename from arch/MRAA/includes.h rename to utility/MRAA/includes.h diff --git a/arch/MRAA/spi.cpp b/utility/MRAA/spi.cpp similarity index 100% rename from arch/MRAA/spi.cpp rename to utility/MRAA/spi.cpp diff --git a/arch/MRAA/spi.h b/utility/MRAA/spi.h similarity index 100% rename from arch/MRAA/spi.h rename to utility/MRAA/spi.h diff --git a/arch/RPi/RF24_arch_config.h b/utility/RPi/RF24_arch_config.h similarity index 100% rename from arch/RPi/RF24_arch_config.h rename to utility/RPi/RF24_arch_config.h diff --git a/arch/RPi/bcm2835.c b/utility/RPi/bcm2835.c similarity index 100% rename from arch/RPi/bcm2835.c rename to utility/RPi/bcm2835.c diff --git a/arch/RPi/bcm2835.h b/utility/RPi/bcm2835.h similarity index 100% rename from arch/RPi/bcm2835.h rename to utility/RPi/bcm2835.h diff --git a/arch/RPi/includes.h b/utility/RPi/includes.h similarity index 100% rename from arch/RPi/includes.h rename to utility/RPi/includes.h diff --git a/arch/RPi/spi.cpp b/utility/RPi/spi.cpp similarity index 100% rename from arch/RPi/spi.cpp rename to utility/RPi/spi.cpp diff --git a/arch/RPi/spi.h b/utility/RPi/spi.h similarity index 100% rename from arch/RPi/spi.h rename to utility/RPi/spi.h diff --git a/arch/Teensy/RF24_arch_config.h b/utility/Teensy/RF24_arch_config.h similarity index 100% rename from arch/Teensy/RF24_arch_config.h rename to utility/Teensy/RF24_arch_config.h diff --git a/arch/Template/RF24_arch_config.h b/utility/Template/RF24_arch_config.h similarity index 100% rename from arch/Template/RF24_arch_config.h rename to utility/Template/RF24_arch_config.h diff --git a/arch/Template/compatibility.h b/utility/Template/compatibility.h similarity index 100% rename from arch/Template/compatibility.h rename to utility/Template/compatibility.h diff --git a/arch/Template/gpio.h b/utility/Template/gpio.h similarity index 100% rename from arch/Template/gpio.h rename to utility/Template/gpio.h diff --git a/arch/Template/includes.h b/utility/Template/includes.h similarity index 100% rename from arch/Template/includes.h rename to utility/Template/includes.h diff --git a/arch/Template/spi.h b/utility/Template/spi.h similarity index 100% rename from arch/Template/spi.h rename to utility/Template/spi.h From 517326e164feeb35e7e54440a8c4b71c042d3f14 Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Thu, 1 Oct 2015 00:32:04 -0600 Subject: [PATCH 2/2] Reverting library properties and releases --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 0918f621b..80d7aa8a3 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=RF24 -version=1.02 +version=1.0 author=TMRh20 maintainer=TMRh20 sentence=A library for NRF24L01(+) communication.