Commit 8a0f5ab5 authored by TMRh20's avatar TMRh20

Documentation and File Structure Changes

- Move all documentation out of github.com readmes and onto github.io
pages via source code/doxygen
- Update Transfer example (16-bit CRC)
- Update ATTiny example (pin configuration)
- Add readme files to clarify old/non-updated examples
- Add/Update documentation for various platforms
- Deleted old RPi folder under RF24/RPi/RPi
parent 9ddbe8b1
This diff is collapsed.
This diff is collapsed.
See https://github.com/TMRh20/RF24/blob/master/README.md
# RF24 Python Wrapper (by https://github.com/mz-fuzzy)
Installation:
1. Install the boost libraries:
sudo apt-get install libboost1.50-all
2. Build the library:
./setup.py build
3. Install the library:install:
./setup.py install
See https://github.com/TMRh20/RF24#connection-info for information on connecting your hardware
See the included example for usage information. ( https://github.com/TMRh20/RF24/tree/master/examples_RPi )
Running the Example:
1. Edit the pingpair_dyn.py example to configure the appropriate pins per the above documentation:
Note: Refer to http://www.airspayce.com/mikem/bcm2835/group__constants.html#ga63c029bd6500167152db4e57736d0939 for RPi version specific pin information
nano pingpair_dyn.py
2. Configure another device, Arduino or RPi with the pingpair_dyn example
3. Run the example
sudo ./pingpair_dyn.py
Python Wrapper for RF24
See http://tmrh20.github.io/RF24 for more information
See https://github.com/TMRh20/RF24/blob/master/README.md
Python Wrapper for RF24
See http://tmrh20.github.io/RF24 for more information
......@@ -42,7 +42,8 @@ void setup(void) {
radio.setDataRate(RF24_1MBPS);
radio.setAutoAck(1); // Ensure autoACK is enabled
radio.setRetries(2,15); // Optionally, increase the delay between retries & # of retries
radio.setCRCLength(RF24_CRC_8);
//radio.setCRCLength(RF24_CRC_8); Note: The original Transfer.ino example used 8-bit CRC which was found to result in data corruption over time.
radio.openWritingPipe(pipes[0]);
radio.openReadingPipe(1,pipes[1]);
......
Note: These examples may have not been maintained with library updates, and are provided as-is for reference purposes.
\ No newline at end of file
......@@ -31,8 +31,8 @@ version 2 as published by the Free Software Foundation.
+-\/-+ nRF24L01 CE, pin3 ------| //
PB5 1|o |8 Vcc --- nRF24L01 VCC, pin2 ------x----------x--|<|-- 5V
NC PB3 2| |7 PB2 --- nRF24L01 SCK, pin5 --|<|---x-[22k]--| LED
NC PB4 3| |6 PB1 --- nRF24L01 MOSI, pin7 1n4148 |
nRF24L01 GND, pin1 -x- GND 4| |5 PB0 --- nRF24L01 MISO, pin6 |
NC PB4 3| |6 PB1 --- nRF24L01 MOSI, pin6 1n4148 |
nRF24L01 GND, pin1 -x- GND 4| |5 PB0 --- nRF24L01 MISO, pin7 |
| +----+ |
|-----------------------------------------------||----x-- nRF24L01 CSN, pin4
10nF
......
Note: These examples were originally designed for RPi, but should work on any supported Linux platform, with the proper pin configuration.
See http://tmrh20.github.io/RF24 for more information
\ No newline at end of file
......@@ -62,7 +62,7 @@ int main(int argc, char** argv){
radio.setDataRate(RF24_1MBPS);
radio.setAutoAck(1); // Ensure autoACK is enabled
radio.setRetries(2,15); // Optionally, increase the delay between retries & # of retries
radio.setCRCLength(RF24_CRC_8);
radio.setCRCLength(RF24_CRC_16); //Note: The original Transfer.ino example used 8-bit CRC which was found to result in data corruption over time.
radio.printDetails();
/********* Role chooser ***********/
......
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