Documentation update. 1.0 fully supported, Maple works, more examples…

…, links and pictures for proejcts

Doxyfile

@@ -800,7 +800,7 @@ HTML_FOOTER            =
 # the style sheet file to the HTML output directory, so don't put your own
 # stylesheet in the HTML output directory as well, or it will be erased!
 
-HTML_STYLESHEET        =
+HTML_STYLESHEET        = doxygen-custom.css
 
 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
 # page will contain the date and time when the page was generated. Setting

FAQ

@@ -7,39 +7,35 @@
  *
  * @ref range
  *
+ * @ref issues
+ *
  * @ref tests
  *
  * @section starting Where do I start?
  *
- * Start with the pingpair example.  Follow the instructions in the comments
- * of that sketch.
+ * See my blog post: 
+ * <a href="http://maniacbug.wordpress.com/2011/11/02/getting-started-rf24/">Getting Started with nRF24L01+ on Arduino</a>
  *
  * @section hardware Where can I buy some hardware?
  *
- * I've been using modules from mdfly.com.
- *
- * Mostly these units as the workhorse of the system:
- *
- * @li 2.4Ghz Wireless nRF24L01 Transceiver Module $6.95
- * http://www.mdfly.com/index.php?main_page=product_info&cPath=8_52&products_id=82
- *
- * And then also experimenting with these for greater range
- *
- * @li nRF24L01 2.4GHz Transceiver Module w/ Power Amplifier $12.95
- * http://www.mdfly.com/index.php?main_page=product_info&cPath=8_52&products_id=394
- * @li 2.4GHz Transceiver Module w/ Power Amplifier $19.95
- * http://www.mdfly.com/index.php?main_page=product_info&cPath=8_52&products_id=583
- *
- * However, I also noticed that iTeadStudio has nRF24L01+ units for $4!
+ * @li iTeadStudio sells the basic <a href="http://iteadstudio.com/store/index.php?main_page=product_info&cPath=7&products_id=53">2.4G Wireless nRF24L01+ Module</a> for $4.  Such a deal!
+ * @li MDfly.com sells the same unit, <a href="http://www.mdfly.com/index.php?main_page=product_info&cPath=8_52&products_id=81">2.4Ghz Wireless nRF24L01+ Transceiver Module</a> for $6.95, but it ships from the US so it gets there a lot faster.  Great place to get a few units and get started quickly.
+ * @li MDfly.com also has the <a href="http://www.mdfly.com/index.php?main_page=product_info&cPath=8_52&products_id=433">nRF24L01 2.4GHz Transceiver Module w/ Power Amplifier</a> for $13.95, which increases range dramatically and uses a chip antenna
+ * @li MDfly.com also has the <a href="http://www.mdfly.com/index.php?main_page=product_info&cPath=8_52&products_id=583">2.4GHz Transceiver Module w/ Power Amplifier</a> with an external antenna for $19.95
  *
  * @section range What is the range of these units?
  *
- * Here are some results from measurements I have taken.  I recommend that everyone
- * take their own measurements in their particular circumstances.
+ * Here are some results from measurements I have taken, using the basic $4 iTeadStudio units.  
+ * I recommend that everyone take their own measurements in their particular circumstances.
  *
  * @li non-plus unit, 2MBps (worst case), 41+ ft line of sight indoors, immediate dropoff with any deviation from LOS.  (41 ft is as far as I can go in my house without turning a corner)
  * @li Plus unit, 250kbps (best case), 46 ft around two corners indoors, 49 ft around one corner.  More importantly, at 250k, packet loss is almost negligible through almost all of that range.
  * @li Both units at 1MBps, plus unit gets about 10% range improvement over non-plus in almost all situations.
+ * 
+ * @section issues What should I do if I find a problem?
+ *
+ * Please <a href="https://github.com/maniacbug/RF24/issues/new">open an issue</a> on github if you find any problems using it with any version of Arduino or Maple.
+ * 
  *  
  * @section tests Why are the examples in the 'tests' directory failing?
  *

RF24.h

@@ -620,8 +620,8 @@ class RF24
 /**
  * @example GettingStarted.pde
  *
- * This is an example which corresponds to my "Getting Started" blog post
- * for Getting Started with nRF24L01+ radios. 
+ * This is an example which corresponds to my "Getting Started" blog post:
+ * <a style="text-align:center" href="http://maniacbug.wordpress.com/2011/11/02/getting-started-rf24/">Getting Started with nRF24L01+ on Arduino</a>. 
  *
  * It is an example of how to use the RF24 class.  Write this sketch to two 
  * different nodes.  Put one of the nodes into 'transmit' mode by connecting 
@@ -649,6 +649,21 @@ class RF24
  * The ping node can then see how long the whole cycle took.
  */
 
+/**
+ * @example pingpair_maple.pde 
+ *
+ * This is an example of how to use the RF24 class on the Maple.  For a more
+ * detailed explanation, see my blog post:
+ * <a href="http://maniacbug.wordpress.com/2011/12/14/nrf24l01-running-on-maple-3/">nRF24L01+ Running on Maple</a>
+ *
+ * It will communicate well to an Arduino-based unit as well, so it's not for only Maple-to-Maple communication.
+ * 
+ * Write this sketch to two different nodes,
+ * connect the role_pin to ground on one.  The ping node sends the current time to the pong node,
+ * which responds by sending the value back.  The ping node can then see how long the whole cycle
+ * took.
+ */
+
 /**
  * @example starping.pde
  *
@@ -703,15 +718,26 @@ class RF24
 /**
  * @mainpage Driver for nRF24L01(+) 2.4GHz Wireless Transceiver
  *
- * Design Goals: This library is designed to be...
+ * @section Goals Design Goals
+ * 
+ * This library is designed to be...
  * @li Maximally compliant with the intended operation of the chip
  * @li Easy for beginners to use
  * @li Consumed with a public interface that's similiar to other Arduino standard libraries
  *
- * NOW COMPATIBLE WITH ARDUINO 1.0 - Please use the 
- * <a href="https://github.com/maniacbug/RF24/tree/arduino-1.0">'arduino-1.0' branch</a>
- * for use with Arduino 1.0.  This will be merged into master when Arduino 1.0 is released.
+ * @section News News
+ * 
+ * NOW COMPATIBLE WITH ARDUINO 1.0 - The 'master' branch and all examples work with both Arduino 1.0 and earlier versions.  
+ * Please <a href="https://github.com/maniacbug/RF24/issues/new">open an issue</a> if you find any problems using it with any version of Arduino.
+ *
+ * NOW COMPATIBLE WITH MAPLE - RF24 has been tested with the 
+ * <a href="http://leaflabs.com/store/#Maple-Native">Maple Native</a>, 
+ * and should work with any Maple board.  See the pingpair_maple example.
+ * Note that only the pingpair_maple example has been tested on Maple, although
+ * the others can certainly be adapted.
  *
+ * @section Useful Useful References
+ * 
  * Please refer to:
  *
  * @li <a href="http://maniacbug.github.com/RF24/">Documentation Main Page</a>
@@ -726,6 +752,23 @@ class RF24
  * @section More More Information
  *
  * @subpage FAQ
+ *
+ * @section Projects Projects
+ *
+ * Stuff I have built with RF24
+ *
+ *
+ * <img src="http://farm7.staticflickr.com/6044/6307669179_a8d19298a6_m.jpg" width="240" height="160" alt="RF24 Getting Started - Finished Product">
+ *
+ * <a style="text-align:center" href="http://maniacbug.wordpress.com/2011/11/02/getting-started-rf24/">Getting Started with nRF24L01+ on Arduino</a> 
+ *
+ * <img src="http://farm7.staticflickr.com/6097/6224308836_b9b3b421a3_m.jpg" width="240" height="160" alt="RF Duinode V3 (2V4)">
+ *
+ * <a href="http://maniacbug.wordpress.com/2011/10/19/sensor-node/">Low-Power Wireless Sensor Node</a>
+ *
+ * <img src="http://farm8.staticflickr.com/7012/6489477865_b56edb629b_m.jpg" width="240" height="161" alt="nRF24L01+ connected to Leaf Labs Maple Native">
+ *
+ * <a href="http://maniacbug.wordpress.com/2011/12/14/nrf24l01-running-on-maple-3/">nRF24L01+ Running on Maple</a>
  */
 
 #endif // __RF24_H__