Updated readme and h file for doxygen

See http://tmrh20.github.io/RF24/class_r_f24.html for the class
documenation.
This commit is contained in:
TMRh20
2014-03-19 19:13:26 -06:00
parent 1e2f41c3f8
commit 14187cd1a1
2 changed files with 165 additions and 63 deletions
+13 -11
View File
@@ -1,24 +1,26 @@
# Arduino driver for nRF24L01 2.4GHz Wireless Transceiver
# Optimized High Speed Arduino driver for nRF24L01 2.4GHz Wireless Transceiver
Note: March 2014, this fork was just published and is still undergoing fine tuning.
The attached documentation is close but does NOT match the library.
See http://TMRh20.blogspot.com for usage information and updates.
This readme will be updated once more is finalized.
Note: March 2014, this fork was just published and is still undergoing fine tuning.
Class documenation is now available at http://tmrh20.github.io/RF24/class_r_f24.html
See http://TMRh20.blogspot.com for an overview of the new functionality.
Design Goals: This library is designed to be...
* Maximally compliant with the intended operation of the chip
* As efficient in operation as possible
* More compliat with the manufacturer specified operation of the chip
* Utilize the capabilities of the radio to their full potential via Arduino
* More reliable and feature rich
* Easy for beginners to use
* Consumed with a public interface that's similiar to other Arduino standard libraries
* Built against the standard SPI library.
Please refer to:
* [Documentation Main Page](http://maniacbug.github.com/RF24)
* [RF24 Class Documentation](http://maniacbug.github.com/RF24/classRF24.html)
* [Source Code](https://github.com/maniacbug/RF24)
* [Downloads](https://github.com/maniacbug/RF24/archives/master)
* [Documentation Main Page](http://tmrh20.github.io/)
* [Class Reference]( http://tmrh20.github.io/RF24/class_r_f24.html)
* [Source Code](https://github.com/tmrh20/RF24)
* [Downloads](https://github.com/tmrh20/RF24/archives/master)
* [Chip Datasheet](http://www.nordicsemi.com/files/Product/data_sheet/nRF24L01_Product_Specification_v2_0.pdf)
This chip uses the SPI bus, plus two chip control pins. Remember that pin 10 must still remain an output, or