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 General Documentation: http://tmrh20.github.io
Library functions are mostly the same. Library functions are mostly the same.
See the included examples for RPi specific usage 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 sudo raspi-config
```
A. Update the tool via the menu as required A. Update the tool via the menu as required
B. Select Advanced and enable the SPI kernel module B. Select Advanced and enable the SPI kernel module
C. Update other software and libraries: C. Update other software and libraries:
```
sudo apt-get update sudo apt-get update
sudo apt-get upgrade 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: A. Make a directory to contain the RF24 and possibly RF24Network lib and enter it:
```
mkdir ~/rf24libs mkdir ~/rf24libs
cd ~/rf24libs cd ~/rf24libs
```
B. Clone the RF24 Repo B. Clone the RF24 Repo
```
git clone https://github.com/tmrh20/RF24.git rtemp git clone https://github.com/tmrh20/RF24.git rtemp
```
C. Copy the RPi library folder to the current directory, and delete the rest C. Copy the RPi library folder to the current directory, and delete the rest
```
mv rtemp/RPi/RF24 ./ mv rtemp/RPi/RF24 ./
rm -r rtemp rm -r rtemp
cd RF24 cd RF24
```
D. Build the library, and run an example file: D. Build the library, and run an example file:
```
make make
sudo make install sudo make install
cd examples cd examples
make make
sudo ./gettingstarted sudo ./gettingstarted
```
RPi - RF24Network Quick-Start
============================= # RPi - RF24Network Quick-Start
A. Enter the same directory that contains the RF24 library folder A. Enter the same directory that contains the RF24 library folder
```
cd ~/rf24libs cd ~/rf24libs
```
B. Clone the RF24Network Repo B. Clone the RF24Network Repo
```
git clone https://github.com/tmrh20/RF24Network.git ntemp git clone https://github.com/tmrh20/RF24Network.git ntemp
```
C. Copy the RF24Network folder to the current directory, and delete the rest C. Copy the RF24Network folder to the current directory, and delete the rest
```
mv ntemp/RPi/RF24Network ./ mv ntemp/RPi/RF24Network ./
rm -r ntemp rm -r ntemp
cd RF24Network cd RF24Network
```
D. Build the library D. Build the library
```
sudo make sudo make
cd examples cd examples
sudo make sudo make
sudo ./helloworld_rx OR sudo ./helloworld_tx sudo ./helloworld_rx OR sudo ./helloworld_tx
```
Connection Info
=============== # Connection Info
Using pin 15/GPIO 22 for CE, pin 24/GPIO8 (CE0) for CSN 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. ...@@ -80,11 +78,10 @@ Can use either RPi CE0 or CE1 pins for radio CSN.
Choose any RPi output pin for radio CE pin. Choose any RPi output pin for radio CE pin.
**Constructor:** **Constructor:**
```
RF24 radio(RPI_V2_GPIO_P1_15,BCM2835_SPI_CS0, BCM2835_SPI_SPEED_8MHZ); RF24 radio(RPI_V2_GPIO_P1_15,BCM2835_SPI_CS0, BCM2835_SPI_SPEED_8MHZ);
or or
RF24 radio(RPI_V2_GPIO_P1_15,BCM2835_SPI_CS1, BCM2835_SPI_SPEED_8MHZ); RF24 radio(RPI_V2_GPIO_P1_15,BCM2835_SPI_CS1, BCM2835_SPI_SPEED_8MHZ);
```
**Pins:** **Pins:**
...@@ -105,7 +102,6 @@ in use for SPI, and to include a millis() function. ...@@ -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>. Based on the arduino lib from J. Coliz <maniacbug@ymail.com>.
the library was berryfied by Purinda Gunasekara <purinda@gmail.com>. the library was berryfied by Purinda Gunasekara <purinda@gmail.com>.
then forked from github stanleyseow/RF24 to https://github.com/jscrane/RF24-rpi 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