Skip to content

Commit

Permalink
Update readme to just point to the official docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TMRh20 authored Aug 7, 2020
1 parent 2d75981 commit f32e2b1
Showing 1 changed file with 2 additions and 106 deletions.
108 changes: 2 additions & 106 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,109 +2,5 @@

Please see the full documentation at http://tmrh20.github.io/RF24Network/


## Raspberry Pi - PreConfig

### Possible pre-configuration:
If SPI is not already enabled, load it on boot:

sudo raspi-config

A. Update the tool via the menu as required
B. Select Advanced and enable the SPI kernel module
C. Update other software and libraries:

sudo apt-get update
sudo apt-get upgrade

# RPi - RF24 Quick-Start
A. Make a directory to contain the RF24 and possibly RF24Network lib and enter it:

mkdir ~/rf24libs
cd ~/rf24libs

B. Clone the RF24 Repo

git clone https://github.com/tmrh20/RF24.git RF24

C. Change to the new RF24 directory

cd RF24

D. Build the library, and run an example file:

sudo make install
cd examples_RPi
make
sudo ./gettingstarted


# RPi - RF24Network Quick-Start

A. Enter the same directory that contains the RF24 library folder

cd ~/rf24libs

B. Clone the RF24Network Repo

git clone https://github.com/tmrh20/RF24Network.git RF24Network

C. Copy the RF24Network folder to the current directory, and delete the rest

cd RF24Network

D. Build the library

sudo make install
cd examples_RPi
make
sudo ./helloworld_rx OR sudo ./helloworld_tx


# Connection Info

Using pin 15/GPIO 22 for CE, pin 24/GPIO8 (CE0) for CSN

Can use either RPi CE0 or CE1 pins for radio CSN.
Choose any RPi output pin for radio CE pin.

**Constructor:**

RF24 radio(RPI_V2_GPIO_P1_15,BCM2835_SPI_CS0, BCM2835_SPI_SPEED_8MHZ);
or
RF24 radio(RPI_V2_GPIO_P1_15,BCM2835_SPI_CS1, BCM2835_SPI_SPEED_8MHZ);

RPi B+:
RF24 radio(RPI_BPLUS_GPIO_J8_15,RPI_BPLUS_GPIO_J8_24, BCM2835_SPI_SPEED_8MHZ);
or
RF24 radio(RPI_BPLUS_GPIO_J8_15,RPI_BPLUS_GPIO_J8_26, BCM2835_SPI_SPEED_8MHZ);

**Pins:**

| PIN | NRF24L01 | RPI | RPi -P1 Connector |
|-----|----------|------------|-------------------|
| 1 | GND | rpi-gnd | (25) |
| 2 | VCC | rpi-3v3 | (17) |
| 3 | CE | rpi-gpio22 | (15) |
| 4 | CSN | rpi-gpio8 | (24) |
| 5 | SCK | rpi-sckl | (23) |
| 6 | MOSI | rpi-mosi | (19) |
| 7 | MISO | rpi-miso | (21) |
| 8 | IRQ | - | - |


See http://www.airspayce.com/mikem/bcm2835/index.html for BCM2835 class documentation.
Note: The BCM library has been customized slightly to allow use of hardware CE pins not
in use for SPI, and to include a millis() function.

****************

Based on the arduino lib from J. Coliz <maniacbug@ymail.com>.
the library was berryfied by Purinda Gunasekara <purinda@gmail.com>.
then forked from github stanleyseow/RF24 to https://github.com/jscrane/RF24-rpi
Network lib also based on https://github.com/farconada/RF24Network

Currently optimized and aligned with Arduino fork of libraries by TMRh20:
https://github.com/tmrh20/RF24/RPi and https://github.com/tmrh20/RF24Network/RPi
Documentation: http://tmrh20.github.io
See http://tmrh20.github.io/RF24/index.html for general RF24 configuration and setup
See http://tmrh20.github.io/RF24/Linux.html and http://tmrh20.github.io/RF24/RPi.html for Linux/RPi related config/setup

0 comments on commit f32e2b1

Please sign in to comment.