Skip to content

Commit 55b034e

Browse files
committed
Rename arch folder to utility
Rename arch folder for attempted compatibility with Arduino Library Manager
1 parent 869a2c2 commit 55b034e

37 files changed

+24
-15
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ LIBNAME=$(LIB).so.1.0
2525
HEADER_DIR=${PREFIX}/include/RF24
2626

2727
# The base location of support files for different devices
28-
ARCH_DIR=arch
28+
ARCH_DIR=utility
2929

3030
# The default objects to compile
3131
OBJECTS=RF24.o spi.o

Makefile.littlewire

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ LIB=librf24
1818

1919
HEADER_DIR=${PREFIX}/include/RF24
2020
LIB_DIR=$(PREFIX)/lib
21-
DRIVER_DIR=arch/LittleWire
21+
DRIVER_DIR=utility/LittleWire
2222

2323
ifeq ($(shell uname), Linux)
2424
DYN_SUFFIX=so

RF24.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
#include "RF24_config.h"
1919

2020
#if defined (RF24_LINUX)
21-
#include "arch/includes.h"
21+
#include "utility/includes.h"
2222
#elif LITTLEWIRE
2323
#include <LittleWireSPI/LittleWireSPI.h>
2424
#elif defined SOFTSPI
@@ -1333,7 +1333,7 @@ s *
13331333
*
13341334
* **March 2015**<br>
13351335
* - Uses SPI transactions on Arduino
1336-
* - New layout for <a href="Portability.html">easier portability:</a> Break out defines & includes for individual platforms to RF24/arch
1336+
* - New layout for <a href="Portability.html">easier portability:</a> Break out defines & includes for individual platforms to RF24/utility
13371337
* - <a href="MRAA.html">MRAA</a> support added ( Galileo, Edison, etc)
13381338
* - <a href="BBB.html">BBB/Generic Linux </a> support via spidev & MRAA
13391339
* - Support for RPi 2 added
@@ -1547,7 +1547,7 @@ s *
15471547
* BeagleBone Black is supported via MRAA or SPIDEV.
15481548
*
15491549
* @note The SPIDEV option should work with most Linux systems supporting SPIDEV. <br>
1550-
* 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"; )
1550+
* 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"; )
15511551
*
15521552
* <br>
15531553
* @section AutoInstall Automated Install
@@ -1713,7 +1713,7 @@ s *
17131713
*
17141714
* Build using **spidev**:
17151715
*
1716-
* 1. Edit the RF24/arch/BBB/spi.cpp file
1716+
* 1. Edit the RF24/utility/BBB/spi.cpp file
17171717
* 2. Change the default device definition to @code this->device = "/dev/spidev0.0";; @endcode
17181718
* 3. Run @code sudo make install -B RF24_SPIDEV=1 @endcode
17191719
* 4. See the gettingstarted example for an example of pin configuration
@@ -1829,13 +1829,13 @@ s *
18291829
* @page Portability RF24 Portability
18301830
*
18311831
* The RF24 radio driver mainly utilizes the <a href="http://arduino.cc/en/reference/homePage">Arduino API</a> for GPIO, SPI, and timing functions, which are easily replicated
1832-
* on various platforms. <br>Support files for these platforms are stored under RF24/arch, and can be modified to provide
1832+
* on various platforms. <br>Support files for these platforms are stored under RF24/utility, and can be modified to provide
18331833
* the required functionality.
18341834
*
18351835
* <br>
18361836
* @section Hardware_Templates Basic Hardware Template
18371837
*
1838-
* **RF24/arch**
1838+
* **RF24/utility**
18391839
*
18401840
* The RF24 library now includes a basic hardware template to assist in porting to various platforms. <br> The following files can be included
18411841
* 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 *
18501850
* | your_custom_file.h | Provides access to custom drivers for spi,gpio, etc |
18511851
*
18521852
* <br>
1853-
* Examples are provided via the included hardware support templates in **RF24/arch** <br>
1853+
* Examples are provided via the included hardware support templates in **RF24/utility** <br>
18541854
* See the <a href="modules.html">modules</a> page for examples of class declarations
18551855
*
18561856
*<br>
18571857
* @section Device_Detection Device Detection
18581858
*
1859-
* 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 <br>
1859+
* 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 <br>
18601860
* 2. Secondary detection is completed in RF24_config.h, causing the include.h file to be included for all supported Linux devices <br>
18611861
* 3. RF24.h contains the declaration for SPI and GPIO objects 'spi' and 'gpio' to be used for porting-in related functions.
18621862
*

RF24_config.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,26 +32,26 @@
3232
//Generic Linux/ARM and //http://iotdk.intel.com/docs/master/mraa/
3333
#if ( defined (__linux) || defined (LINUX) ) && defined( __arm__ ) || defined(MRAA) // BeagleBone Black running GNU/Linux or any other ARM-based linux device
3434

35-
// The Makefile checks for bcm2835 (RPi) and copies the correct includes.h file to /arch/includes.h (Default is spidev config)
35+
// The Makefile checks for bcm2835 (RPi) and copies the correct includes.h file to /utility/includes.h (Default is spidev config)
3636
// This behavior can be overridden by calling 'make RF24_SPIDEV=1' or 'make RF24_MRAA=1'
3737
// The includes.h file defines either RF24_RPi, MRAA or RF24_BBB and includes the correct RF24_arch_config.h file
38-
#include "arch/includes.h"
38+
#include "utility/includes.h"
3939

4040
//ATTiny
4141
#elif defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) || defined(__AVR_ATtiny24__) || defined(__AVR_ATtiny44__) || defined(__AVR_ATtiny84__)
4242

4343
#define RF24_TINY
44-
#include "arch/ATTiny/RF24_arch_config.h"
44+
#include "utility/ATTiny/RF24_arch_config.h"
4545

4646
//LittleWire
4747
#elif defined(LITTLEWIRE)
4848

49-
#include "arch/LittleWire/RF24_arch_config.h"
49+
#include "utility/LittleWire/RF24_arch_config.h"
5050

5151
//Teensy
5252
#elif defined (TEENSYDUINO)
5353

54-
#include "arch/Teensy/RF24_arch_config.h"
54+
#include "utility/Teensy/RF24_arch_config.h"
5555
//Everything else
5656
#else
5757

library.properties

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name=RF24
2+
version=1.02
3+
author=TMRh20
4+
maintainer=TMRh20
5+
sentence=A library for NRF24L01(+) communication.
6+
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.
7+
category=Communication
8+
url=http://tmrh20.github.io/RF24/
9+
architectures=avr
File renamed without changes.

0 commit comments

Comments
 (0)