Commit 8e8c1115 authored by cornet's avatar cornet

Cleanup readme syntax

parent dc9ccbff
# Optimized Raspberry Pi RF24 and RF24 Network Libraries
Optimized Raspberry Pi RF24 and RF24 Network Libraries
=============================================
General Documentation: http://tmrh20.github.io
Library functions are mostly the same.
See the included examples for RPi specific usage
##Raspberry Pi - PreConfig
## Raspberry Pi - PreConfig
### Possible pre-configuration:
If SPI is not already enabled, load it on boot:
####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
======================
# 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 rtemp
```
C. Copy the RPi library folder to the current directory, and delete the rest
```
mv rtemp/RPi/RF24 ./
rm -r rtemp
cd RF24
```
D. Build the library, and run an example file:
```
make
sudo make install
cd examples
make
sudo ./gettingstarted
```
RPi - RF24Network Quick-Start
=============================
# 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 ntemp
```
C. Copy the RF24Network folder to the current directory, and delete the rest
```
mv ntemp/RPi/RF24Network ./
rm -r ntemp
cd RF24Network
```
D. Build the library
```
sudo make
cd examples
sudo make
sudo ./helloworld_rx OR sudo ./helloworld_tx
```
Connection Info
===============
# Connection Info
Using pin 15/GPIO 22 for CE, pin 24/GPIO8 (CE0) for CSN
......@@ -80,11 +78,10 @@ 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);
```
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);
**Pins:**
......@@ -105,7 +102,6 @@ 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
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment