Added new example to documentation

This commit is contained in:
maniacbug 2011-11-02 21:54:30 -07:00
parent 3a2d94b698
commit d4371639e6
2 changed files with 14 additions and 1 deletions

13
RF24.h
View File

@ -618,6 +618,19 @@ public:
/**@}*/ /**@}*/
}; };
/**
* @example GettingStarted.pde
*
* This is an example which corresponds to my "Getting Started" blog post
* for Getting Started with nRF24L01+ radios.
*
* 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
* with the serial monitor and sending a 'T'. 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 led_remote.pde * @example led_remote.pde
* *

View File

@ -60,7 +60,7 @@ void setup(void)
Serial.begin(57600); Serial.begin(57600);
printf_begin(); printf_begin();
printf("\n\rRF24/examples/pingpair/\n\r"); printf("\n\rRF24/examples/GettingStarted/\n\r");
printf("ROLE: %s\n\r",role_friendly_name[role]); printf("ROLE: %s\n\r",role_friendly_name[role]);
printf("*** PRESS 'T' to begin transmitting to the other node\n\r"); printf("*** PRESS 'T' to begin transmitting to the other node\n\r");